padrino-gen 0.11.3 → 0.11.4

data/lib/padrino-gen/generators/runner.rb

@@ -3,19 +3,19 @@ require 'fileutils'
 module Padrino
   module Generators
     ##
-    # Responsible for executing plugin and template instructions including common actions for modifying a project or application.
+    # Responsible for executing plugin and template instructions including
+    # common actions for modifying a project or application.
     #
     module Runner
 
-      # Generates project scaffold based on a given template file
+      # Generates project scaffold based on a given template file.
       #
       # @param [Hash] options
-      #   Options to use to generate the project
+      #   Options to use to generate the project.
       #
       # @example
       #   project :test => :shoulda, :orm => :activerecord, :renderer => "haml"
       #
-      # @api public
       def project(options={})
         components = options.sort_by { |k, v| k.to_s }.map { |component, value| "--#{component}=#{value}" }
         params = [name, *components].push("-r=#{destination_root("../")}")
@@ -23,19 +23,19 @@ module Padrino
         Padrino.bin_gen(*params.unshift("project"))
       end
 
-      # Executes generator command for specified type with given arguments
+      ##
+      # Executes generator command for specified type with given arguments.
       #
       # @param [Symbol] type
-      #   Type of component module
+      #   Type of component module.
       # @param [String] arguments
-      #   Arguments to send to component generator
+      #   Arguments to send to component generator.
       #
       # @example
       #   generate :model, "post title:string body:text"
       #   generate :controller, "posts get:index get:new post:new"
       #   generate :migration, "AddEmailToUser email:string"
       #
-      # @api public
       def generate(type, arguments="")
         params = arguments.split(" ").push("-r=#{destination_root}")
         params.push("--app=#{@_app_name}") if @_app_name
@@ -43,25 +43,26 @@ module Padrino
         Padrino.bin_gen(*params.unshift(type))
       end
 
-      # Executes rake command with given arguments
+      ##
+      # Executes rake command with given arguments.
       #
       # @param [String] command
-      #   Rake tasks to execute
+      #   Rake tasks to execute.
       #
       # @example
       #   rake "custom task1 task2"
       #
-      # @api public
       def rake(command)
         Padrino.bin("rake", command, "-c=#{destination_root}")
       end
 
+      ##
       # Executes App generator. Accepts an optional block allowing generation inside subapp.
       #
       # @param [Symbol] name
-      #   name of (sub)application to generate
+      #   Name of (sub)application to generate.
       # @param [Proc] block
-      #   commands to execute in context of (sub)appliation directory
+      #   Commands to execute in context of (sub)appliation directory.
       #
       # @example
       #   app :name
@@ -69,7 +70,6 @@ module Padrino
       #    generate :model, "posts title:string" # generate a model inside of subapp
       #   end
       #
-      # @api public
       def app(name, &block)
         say "=> Executing: padrino-gen app #{name} -r=#{destination_root}", :magenta
         Padrino.bin_gen(:app, name.to_s, "-r=#{destination_root}")
@@ -80,19 +80,19 @@ module Padrino
         end
       end
 
-      # Executes git commmands in project
+      ##
+      # Executes git commmands in project.
       #
       # @param [Symbol] action
-      #   Git command to execute
+      #   Git command to execute.
       # @param [String] arguments
-      #   Arguments to invoke on git command
+      #   Arguments to invoke on git command.
       #
       # @example
       #   git :init
       #   git :add, "."
       #   git :commit, "hello world"
       #
-      # @api public
       def git(*args)
         FileUtils.cd(destination_root) do
           cmd = "git %s" % args.join(' ')
@@ -103,13 +103,14 @@ module Padrino
 
       private
 
+      ##
       # Resolves the path to the plugin template
-      # given the project_name and the template_file
+      # given the project_name and the template_file.
       #
       # @param [Symbol] kind
-      #   Context of template file to run, i.e :plugin, :template
+      #   Context of template file to run, i.e :plugin, :template.
       # @param [String] template_file
-      #   Path to template file
+      #   Path to template file.
       #
       # @example
       #   execute_runner(:plugin, 'path/to/local/file')
@@ -117,7 +118,6 @@ module Padrino
       #   execute_runner(:template, 'sampleblog')
       #   execute_runner(:template, 'https://gist.github.com/357045')
       #
-      # @api private
       def execute_runner(kind, template_file)
         # Determine resolved template path
         template_file = template_file.to_s
@@ -134,6 +134,6 @@ module Padrino
           end
         self.apply(template_path) rescue say("The template at #{template_path} could not be found!", :red)
       end
-    end # Runner
-  end # Generators
-end # Padrino
+    end
+  end
+end

data/lib/padrino-gen/padrino-tasks/activerecord.rb

@@ -60,7 +60,7 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
         end
       rescue
         case config[:adapter]
-        when 'mysql', 'mysql2', 'jdbcmysql'
+        when 'mysql', 'mysql2', 'em_mysql2', 'jdbcmysql'
           @charset   = ENV['CHARSET']   || 'utf8'
           @collation = ENV['COLLATION'] || 'utf8_unicode_ci'
           creation_options = {:charset => (config[:charset] || @charset), :collation => (config[:collation] || @collation)}
@@ -189,7 +189,7 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
     task :charset => :environment do
       config = ActiveRecord::Base.configurations[Padrino.env || :development]
       case config[:adapter]
-      when 'mysql', 'mysql2', 'jdbcmysql'
+      when 'mysql', 'mysql2', 'em_mysql2', 'jdbcmysql'
         ActiveRecord::Base.establish_connection(config)
         puts ActiveRecord::Base.connection.charset
       when 'postgresql'
@@ -204,7 +204,7 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
     task :collation => :environment do
       config = ActiveRecord::Base.configurations[Padrino.env || :development]
       case config[:adapter]
-      when 'mysql', 'mysql2', 'jdbcmysql'
+      when 'mysql', 'mysql2', 'em_mysql2', 'jdbcmysql'
         ActiveRecord::Base.establish_connection(config)
         puts ActiveRecord::Base.connection.collation
       else
@@ -261,7 +261,7 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
       task :dump => :environment do
         abcs = ActiveRecord::Base.configurations
         case abcs[Padrino.env][:adapter]
-        when "mysql", "mysql2", "oci", "oracle", 'jdbcmysql'
+        when "mysql", "mysql2", 'em_mysql2', "oci", "oracle", 'jdbcmysql'
           ActiveRecord::Base.establish_connection(abcs[Padrino.env])
           File.open("#{Padrino.root}/db/#{Padrino.env}_structure.sql", "w+") { |f| f << ActiveRecord::Base.connection.structure_dump }
         when "postgresql"
@@ -299,29 +299,28 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
       models = Dir["#{Padrino.root}/{app,}/models/**/*.rb"].map { |m| File.basename(m, ".rb") }
 
       models.each do |m|
-        # Get the model class
+        # Get the model class.
         klass = m.camelize.constantize
 
-        # Avoid non ActiveRecord models
+        # Avoid non ActiveRecord models.
         next unless klass.ancestors.include?(ActiveRecord::Base)
 
-        # Init the processing
+        # Init the processing.
         print "Processing #{m.humanize}: "
         FileUtils.mkdir_p("#{Padrino.root}/app/locale/models/#{m}")
-        langs = Array(I18n.locale) # for now we use only one
+        langs = Array(I18n.locale)
 
-        # Create models for it and en locales
+        # Create models for it and en locales.
         langs.each do |lang|
           filename   = "#{Padrino.root}/app/locale/models/#{m}/#{lang}.yml"
           columns    = klass.columns.map(&:name)
-          # If the lang file already exist we need to check it
+          # If the lang file already exist we need to check it.
           if File.exist?(filename)
             locale = File.open(filename).read
             columns.each do |c|
               locale += "\n        #{c}: #{klass.human_attribute_name(c)}" unless locale.include?("#{c}:")
             end
             print "Lang #{lang.to_s.upcase} already exist ... "; $stdout.flush
-            # Do some ere
           else
             locale     = "#{lang}:" + "\n" +
                          "  models:" + "\n" +
@@ -340,7 +339,7 @@ if PadrinoTasks.load?(:activerecord, defined?(ActiveRecord))
 
   def drop_database(config)
     case config[:adapter]
-    when 'mysql', 'mysql2', 'jdbcmysql'
+    when 'mysql', 'mysql2', 'em_mysql2', 'jdbcmysql'
       ActiveRecord::Base.establish_connection(config)
       ActiveRecord::Base.connection.drop_database config[:database]
     when /^sqlite/

data/lib/padrino-gen/padrino-tasks/datamapper.rb

@@ -1,13 +1,13 @@
 if PadrinoTasks.load?(:datamapper, defined?(DataMapper))
   namespace :dm do
     namespace :auto do
-      desc "Perform automigration (reset your db data)"
+      desc "Perform auto migration (reset your db data)"
       task :migrate => :environment do
         ::DataMapper.repository.auto_migrate!
         puts "<= dm:auto:migrate executed"
       end
 
-      desc "Perform non destructive automigration"
+      desc "Perform non destructive auto migration"
       task :upgrade => :environment do
         ::DataMapper.repository.auto_upgrade!
         puts "<= dm:auto:upgrade executed"
@@ -61,7 +61,7 @@ if PadrinoTasks.load?(:datamapper, defined?(DataMapper))
         DataMapper.setup(DataMapper.repository.name, config)
       else
         # require 'padrino-gen/padrino-tasks/sql-helpers'
-        Padrino::Generators::SqlHelpers.create_db(config[:adapter], user, password, host, database, charset, collation) 
+        Padrino::Generators::SqlHelpers.create_db(config[:adapter], user, password, host, database, charset, collation)
       end
       puts "<= dm:create executed"
     end

data/lib/padrino-gen/padrino-tasks/mongoid.rb

@@ -1,5 +1,5 @@
 if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
-  require 'mongoid' # eagerly load mongoid for version check
+  require 'mongoid'
 
   namespace :mi do
 
@@ -76,7 +76,7 @@ if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
             documents << klass
           end
         rescue => e
-          # Just for non-mongoid objects that dont have the embedded
+          # Just for non-mongoid objects that don't have the embedded
           # attribute at the class level.
         end
       end
@@ -86,7 +86,7 @@ if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
 
     desc 'Create the indexes defined on your mongoid models'
     task :create_indexes => :environment do
-      get_mongoid_models.each { |model| model.create_indexes }
+      get_mongoid_models.each(&:create_indexes)
     end
 
     def convert_ids(obj)
@@ -114,14 +114,14 @@ if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
       collection_names.each do |collection_name|
         puts "Converting #{collection_name} to use ObjectIDs"
 
-        # get old collection
+        # Get old collection.
         collection = mongoid_collection(collection_name)
 
-        # get new collection (a clean one)
+        # Get new collection (a clean one).
         mongoid_collection("#{collection_name}_new").drop
         new_collection = mongoid_new_collection(collection, "#{collection_name}_new")
 
-        # convert collection documents
+        # Convert collection documents.
         enum_mongoid_documents(collection) do |doc|
           new_doc = convert_ids(doc)
           new_collection.insert(new_doc, :safe => true)
@@ -130,12 +130,12 @@ if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
         puts "Done! Converted collection is in #{new_collection.name}\n\n"
       end
 
-      # no errors. great! now rename _new to collection_name
+      # No errors. great! now rename _new to collection_name.
       collection_names.each do |collection_name|
         collection = mongoid_collection(collection_name)
         new_collection = mongoid_new_collection(collection, "#{collection_name}_new")
 
-        # swap collection to _old
+        # Swap collection to _old.
         puts "Moving #{collection.name} to #{collection_name}_old"
         mongoid_new_collection(collection, "#{collection_name}_old").drop
 
@@ -146,7 +146,7 @@ if PadrinoTasks.load?(:mongoid, defined?(Mongoid))
           puts "reason: #{e.message}\n\n"
         end
 
-        # swap _new to collection
+        # Swap _new to collection.
         puts "Moving #{new_collection.name} to #{collection_name}\n\n"
 
         begin

data/lib/padrino-gen/padrino-tasks/mongomapper.rb

@@ -2,7 +2,7 @@ if defined?(MongoMapper)
   begin
     require 'i18n'
   rescue LoadError
-    # only do this for I18n check later
+    # Only do this for I18n check later.
   end
 
   namespace :mm do
@@ -16,15 +16,15 @@ if defined?(MongoMapper)
       models = Dir["#{Padrino.root}/{app,}/models/**/*.rb"].map { |m| File.basename(m, ".rb") }
 
       models.each do |m|
-        # Get the model class
+        # Get the model class.
         klass = m.camelize.constantize
 
         # Init the processing
         print "Processing #{m.humanize}: "
         FileUtils.mkdir_p("#{Padrino.root}/app/locale/models/#{m}")
-        langs = Array(I18n.locale) # for now we use only one
+        langs = Array(I18n.locale)
 
-        # Create models for it and en locales
+        # Create models for it and en locales.
         langs.each do |lang|
           filename   = "#{Padrino.root}/app/locale/models/#{m}/#{lang}.yml"
           columns    = klass.keys.values.map(&:name).reject { |name| name =~ /id/i }
@@ -35,7 +35,6 @@ if defined?(MongoMapper)
               locale += "\n        #{c}: #{c.humanize}" unless locale.include?("#{c}:")
             end
             print "Lang #{lang.to_s.upcase} already exist ... "; $stdout.flush
-            # Do some ere
           else
             locale     = "#{lang}:" + "\n" +
                          "  models:" + "\n" +

data/lib/padrino-gen/padrino-tasks/sequel.rb

@@ -1,7 +1,6 @@
 if PadrinoTasks.load?(:sequel, defined?(Sequel))
   namespace :sq do
     namespace :migrate do
-
       desc "Perform automigration (reset your db data)"
       task :auto => :environment do
         ::Sequel.extension :migration
@@ -50,7 +49,7 @@ if PadrinoTasks.load?(:sequel, defined?(Sequel))
         ::Sequel.sqlite(database)
       else
         require 'padrino-gen/padrino-tasks/sql-helpers'
-        Padrino::Generators::SqlHelpers.create_db(config[:adapter], user, password, host, database, charset, collation) 
+        Padrino::Generators::SqlHelpers.create_db(config[:adapter], user, password, host, database, charset, collation)
       end
       puts "<= sq:create executed"
     end

data/test/helper.rb

@@ -97,7 +97,7 @@ class MiniTest::Spec
   # expects_initializer :test, "# Example"
   def expects_initializer(name, body,options={})
     #options.reverse_merge!(:root => "/tmp/sample_project")
-    path = File.join(options[:root],'lib',"#{name}_init.rb")
+    path = File.join(options[:root],'lib',"#{name}_initializer.rb")
     instance = mock
     instance.expects(:invoke!).at_least_once
     include_text = "    register #{name.to_s.camelize}Initializer\n"

data/test/test_component_generator.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+describe "ComponentGenerator" do
+  def setup
+    @apptmp = "#{Dir.tmpdir}/padrino-tests/#{UUID.new.generate}"
+    `mkdir -p #{@apptmp}`
+  end
+
+  def teardown
+    `rm -rf #{@apptmp}`
+  end
+
+  context 'the controller generator' do
+    should "fail outside app root" do
+      out, err = capture_io { generate(:component, 'demo', "-r=#{@apptmp}") }
+      assert_match(/not at the root/, out)
+    end
+  end
+
+
+  context "add components" do
+    should "properly generate default" do
+      capture_io { generate(:project, 'sample_project', "--root=#{@apptmp}") }
+      out, err = capture_io { generate(:component, '--orm=activerecord', "-r=#{@apptmp}/sample_project") }
+      assert_match(/applying.*?activerecord.*?orm/, out)
+      assert_match_in_file(/gem 'activerecord', '>= 3.1', :require => 'active_record'/, "#{@apptmp}/sample_project/Gemfile")
+      assert_match_in_file(/gem 'sqlite3'/, "#{@apptmp}/sample_project/Gemfile")
+      assert_no_match(/Switch renderer to/, out)
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'activerecord', components_chosen[:orm]
+    end
+
+    should "properly generate with adapter" do
+      capture_io { generate(:project, 'sample_project', "--root=#{@apptmp}") }
+      out, err = capture_io { generate(:component, '--orm=sequel', '--adapter=postgres', "-r=#{@apptmp}/sample_project") }
+      assert_match_in_file(/gem 'pg'/, "#{@apptmp}/sample_project/Gemfile")
+      assert_no_match(/Switch renderer to/, out)
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'sequel', components_chosen[:orm]
+    end
+  end
+
+
+  context "specified of same the component" do
+    should "does not change" do
+      capture_io { generate(:project, 'sample_project', '--script=jquery', "--root=#{@apptmp}") }
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'jquery', components_chosen[:script]
+      out, err = capture_io { generate(:component, '--script=jquery', "-r=#{@apptmp}/sample_project") }
+      assert_match(/applying.*?jquery.*?script/, out)
+      assert_no_match(/Switch renderer to/, out)
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'jquery', components_chosen[:script]
+    end
+  end
+
+
+  context "component changes" do
+    should "when allow changes, will be applied" do
+      capture_io { generate(:project, 'sample_project', '-renderer=slim', "--root=#{@apptmp}") }
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'slim', components_chosen[:renderer]
+      $stdin.stub(:gets, 'yes') do
+        out, err = capture_io { generate(:component, '--renderer=haml', "-r=#{@apptmp}/sample_project") }
+        assert_match(/applying.*?haml.*?renderer/, out)
+        assert_match(/Switch renderer to/, out)
+        components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+        assert_equal 'haml', components_chosen[:renderer]
+      end
+    end
+    should "when deny changes, will not be applied" do
+      capture_io { generate(:project, 'sample_project', '-renderer=slim', "--root=#{@apptmp}") }
+      components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+      assert_equal 'slim', components_chosen[:renderer]
+      $stdin.stub(:gets, 'no') do
+        out, err = capture_io { generate(:component, '--renderer=haml', "-r=#{@apptmp}/sample_project") }
+        assert_no_match(/applying.*?haml.*?renderer/, out)
+        assert_match(/Switch renderer to/, out)
+        components_chosen = YAML.load_file("#{@apptmp}/sample_project/.components")
+        assert_equal 'slim', components_chosen[:renderer]
+      end
+    end
+  end
+
+end