Added 'rails plugin new' generator which generates gem plugin skeleton.

This command is based on enginex gem by José Valim. It generates gem structure
and ads dummy application into test/dummy. This can be used to start developing
any kind of extension for rails 3.

1 files changed, 225 insertions, 0 deletions

diff --git a/railties/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb b/railties/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb
new file mode 100644
index 0000000000..239115c07d
--- /dev/null
+++ b/railties/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb
@@ -0,0 +1,225 @@
+require "rails/generators/rails/app/app_generator"
+
+module Rails
+  class PluginBuilder
+    def rakefile
+      template "Rakefile"
+    end
+
+    def readme
+      copy_file "README.rdoc"
+    end
+
+    def gemfile
+      template "Gemfile"
+    end
+
+    def license
+      template "MIT-LICENSE"
+    end
+
+    def gemspec
+      template "%name%.gemspec"
+    end
+
+    def gitignore
+      copy_file "gitignore", ".gitignore"
+    end
+
+    def lib
+      directory "lib"
+    end
+
+    def test
+      directory "test"
+    end
+
+    def test_dummy
+      invoke Rails::Generators::AppGenerator,
+        [ File.expand_path(dummy_path, destination_root) ]
+    end
+
+    def test_dummy_config
+      store_application_definition!
+      template "rails/boot.rb", "#{dummy_path}/config/boot.rb", :force => true
+      template "rails/application.rb", "#{dummy_path}/config/application.rb", :force => true
+    end
+
+    def test_dummy_clean
+      inside dummy_path do
+        remove_file ".gitignore"
+        remove_file "db/seeds.rb"
+        remove_file "doc"
+        remove_file "Gemfile"
+        remove_file "lib/tasks"
+        remove_file "public/images/rails.png"
+        remove_file "public/index.html"
+        remove_file "public/robots.txt"
+        remove_file "README"
+        remove_file "test"
+        remove_file "vendor"
+      end
+    end
+
+    def script
+      directory "script" do |content|
+        "#{shebang}\n" + content
+      end
+      chmod "script", 0755, :verbose => false
+    end
+  end
+
+  module Generators
+    class PluginNewGenerator < Base
+      attr_accessor :rails_template
+
+      add_shebang_option!
+
+      argument :plugin_path,            :type => :string
+
+      class_option :builder,            :type => :string, :aliases => "-b",
+                                        :desc => "Path to a plugin builder (can be a filesystem path or URL)"
+
+      class_option :skip_gemfile,       :type => :boolean, :default => false,
+                                        :desc => "Don't create a Gemfile"
+
+      class_option :skip_git,           :type => :boolean, :aliases => "-G", :default => false,
+                                        :desc => "Skip Git ignores and keeps"
+
+      class_option :help,               :type => :boolean, :aliases => "-h", :group => :rails,
+                                        :desc => "Show this help message and quit"
+
+      def self.say_step(message)
+        @step = (@step || 0) + 1
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def step_#{@step}
+            #{"puts" if @step > 1}
+            say_status "STEP #{@step}", #{message.inspect}
+          end
+        METHOD
+      end
+
+      def initialize(*args)
+        raise Error, "Options should be given after plugin name. For details run: rails plugin --help" if args[0].blank?
+
+        @original_wd = Dir.pwd
+
+        super
+      end
+
+      say_step "Creating gem skeleton"
+
+      def create_root
+        self.destination_root = File.expand_path(plugin_path, destination_root)
+        valid_plugin_const?
+
+        empty_directory '.'
+        FileUtils.cd(destination_root) unless options[:pretend]
+      end
+
+      def create_root_files
+        build(:readme)
+        build(:rakefile)
+        build(:gemspec)
+        build(:license)
+        build(:gitignore) unless options[:skip_git]
+        build(:gemfile)   unless options[:skip_gemfile]
+      end
+
+      def create_config_files
+        build(:config)
+      end
+
+      def create_lib_files
+        build(:lib)
+      end
+
+      def create_script_files
+        build(:script)
+      end
+
+      def create_test_files
+        build(:test) unless options[:skip_test_unit]
+      end
+
+      say_step "Vendoring Rails application at test/dummy"
+
+      def create_test_dummy_files
+        build(:test_dummy)
+      end
+
+      say_step "Configuring Rails application"
+
+      def change_config_files
+        build(:test_dummy_config)
+      end
+
+      say_step "Removing unneeded files"
+
+      def remove_uneeded_rails_files
+        build(:test_dummy_clean)
+      end
+
+    protected
+
+      def self.banner
+        "rails plugin new #{self.arguments.map(&:usage).join(' ')} [options]"
+      end
+
+      def builder
+        @builder ||= begin
+          if path = options[:builder]
+            if URI(path).is_a?(URI::HTTP)
+              contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
+            else
+              contents = open(File.expand_path(path, @original_wd)) {|io| io.read }
+            end
+
+            prok = eval("proc { #{contents} }", TOPLEVEL_BINDING, path, 1)
+            instance_eval(&prok)
+          end
+
+          builder_class = defined?(::PluginBuilder) ? ::PluginBuilder : Rails::PluginBuilder
+          builder_class.send(:include, ActionMethods)
+          builder_class.new(self)
+        end
+      end
+
+      def build(meth, *args)
+        builder.send(meth, *args) if builder.respond_to?(meth)
+      end
+
+      def name
+        @name ||= File.basename(destination_root)
+      end
+
+      def camelized
+        @camelized ||= name.gsub(/\W/, '_').squeeze('_').camelize
+      end
+
+      def valid_plugin_const?
+        if camelized =~ /^\d/
+          raise Error, "Invalid plugin name #{name}. Please give a name which does not start with numbers."
+        elsif RESERVED_NAMES.include?(name)
+          raise Error, "Invalid plugin name #{name}. Please give a name which does not match one of the reserved rails words."
+        elsif Object.const_defined?(camelized)
+          raise Error, "Invalid plugin name #{name}, constant #{camelized} is already in use. Please choose another application name."
+        end
+      end
+
+      def dummy_path
+        "test/dummy"
+      end
+
+      def application_definition
+        @application_definition ||= begin
+          unless options[:pretend]
+            contents = File.read(File.expand_path("#{dummy_path}/config/application.rb", destination_root))
+            contents[(contents.index("module Dummy"))..-1]
+          end
+        end
+      end
+      alias :store_application_definition! :application_definition
+    end
+  end
+end