padrino-gen 0.11.3 → 0.11.4

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

@@ -2,19 +2,16 @@ module Padrino
   module Generators
 
     ##
-    # Responsible for applications within a Padrino project. Creates and mounts the application and gives the user related information.
+    # Responsible for applications within a Padrino project. Creates and mounts
+    # the application and gives the user related information.
     #
     class App < Thor::Group
 
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:app, self)
 
-      # Define the source template root
       def self.source_root; File.expand_path(File.dirname(__FILE__)); end
-      # Defines the banner for this CLI generator
-      def self.banner; "padrino-gen project [name]"; end
+      def self.banner; "padrino-gen app [name]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
 
@@ -25,35 +22,36 @@ module Padrino
       class_option :tiny,      :desc => 'Generate tiny app skeleton',             :aliases => '-i', :default => false, :type => :boolean
       class_option :namespace, :desc => 'The name space of your padrino project', :aliases => '-n', :default => '',    :type => :string
 
-      # Show help if no argv given
+      # Show help if no ARGV given
       require_arguments!
 
-      # Copies over the Padrino base admin application
+      ##
+      # Copies over the Padrino base admin application.
       #
-      # @api private
       def create_app
         self.destination_root = options[:root]
         @app_folder = name.gsub(/\W/, '_').underscore
-        @app_name   = name.gsub(/\W/, '_').underscore.camelize
+        @app_name   = @app_folder.camelize
         if in_app_root?
           @project_name = options[:namespace].underscore.camelize
           @project_name = fetch_project_name(@app_folder) if @project_name.empty?
+          lowercase_app_folder = @app_folder.downcase
           self.behavior = :revoke if options[:destroy]
-          app_skeleton(@app_folder.downcase, options[:tiny])
-          empty_directory destination_root("public/#{@app_folder.downcase}")
-          append_file destination_root('config/apps.rb'), "\nPadrino.mount('#{@project_name}::#{@app_name}', :app_file => Padrino.root('#{@app_folder.downcase}/app.rb')).to('/#{@app_folder.downcase}')"
+          app_skeleton(lowercase_app_folder, options[:tiny])
+          empty_directory destination_root("public/#{lowercase_app_folder}")
+          append_file destination_root('config/apps.rb'), "\nPadrino.mount('#{@project_name}::#{@app_name}', :app_file => Padrino.root('#{lowercase_app_folder}/app.rb')).to('/#{lowercase_app_folder}')"
 
           return if self.behavior == :revoke
           say
           say '=' * 65, :green
           say "Your #{@app_name} application has been installed."
-          say '='*65, :green
+          say '=' * 65, :green
           say "This application has been mounted to /#{@app_name.downcase}"
           say "You can configure a different path by editing 'config/apps.rb'"
         else
           say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
         end
       end
-    end # App
-  end # Generators
-end # Padrino
+    end
+  end
+end

data/lib/padrino-gen/generators/app/app.rb.tt

@@ -7,7 +7,7 @@ module <%= @project_name %>
     enable :sessions
 
     ##
-    # Caching support
+    # Caching support.
     #
     # register Padrino::Cache
     # enable :caching
@@ -22,7 +22,7 @@ module <%= @project_name %>
     #
 
     ##
-    # Application configuration options
+    # Application configuration options.
     #
     # set :raise_errors, true       # Raise exceptions (will stop application) (default for test)
     # set :dump_errors, true        # Exception backtraces are written to STDERR (default for production/development)

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

@@ -3,21 +3,20 @@ require 'thor/group'
 module Padrino
   module Generators
     ##
-    # This class bootstrap +config/boot+ and perform +Padrino::Generators.load_components!+ for handle
-    # 3rd party generators
+    # This class bootstrap +config/boot+ and perform
+    # +Padrino::Generators.load_components!+ for handle 3rd party generators.
     #
     class Cli < Thor::Group
 
-      # Include related modules
       include Thor::Actions
 
       class_option :root, :desc => "The root destination", :aliases => '-r', :default => ".", :type => :string
       class_option :help, :type => :boolean, :desc => "Show help usage"
 
-      # We need to TRY to load boot because some of our app dependencies maybe have
+      ##
+      # We need to try to load boot because some of our app dependencies maybe have
       # custom generators, so is necessary know who are.
       #
-      # @api private
       def load_boot
         begin
           ENV['PADRINO_LOG_LEVEL'] ||= 'test'
@@ -38,8 +37,9 @@ module Padrino
         end
       end
 
+      ##
       # Loads the components available for all generators.
-      # @private
+      #
       def setup
         Padrino::Generators.load_components!
 
@@ -53,6 +53,6 @@ module Padrino
           puts "Please specify generator to use (#{Padrino::Generators.mappings.keys.join(", ")})"
         end
       end
-    end # Cli
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+module Padrino
+  module Generators
+
+    ##
+    # Responsible for add components within a Padrino project.
+    #
+    class Component < Thor::Group
+
+      Padrino::Generators.add_generator(:component, self)
+
+      def self.source_root; File.expand_path(File.dirname(__FILE__)); end
+      def self.banner; "padrino-gen component [options]"; end
+
+      include Thor::Actions
+      include Padrino::Generators::Actions
+      include Padrino::Generators::Components::Actions
+
+      desc "Description:\n\n\tpadrino-gen component add components into a Padrino project"
+
+      class_option :root,    :desc => 'The root destination',                                             :aliases => '-r', :default => '.',    :type => :string
+      class_option :adapter, :desc => 'SQL adapter for ORM (sqlite, mysql, mysql2, mysql-gem, postgres)', :aliases => '-a', :default => 'sqlite',    :type => :string
+
+      defines_component_options :default => false
+
+      ##
+      # For each component, retrieve a valid choice and then execute the associated generator.
+      #
+      def setup_components
+        self.destination_root = options[:root]
+        if in_app_root?
+          @_components = options.dup.slice(*self.class.component_types)
+          if @_components.values.delete_if(&:blank?).empty?
+            self.class.start(["-h"])
+            say
+            say "Current Selected Components:"
+            list = []
+            self.class.component_types.each do |comp|
+              list << [comp, fetch_component_choice(comp)]
+            end
+            print_table(list, :indent => 2)
+            exit
+          end
+
+          self.class.component_types.each do |comp|
+            next if @_components[comp].blank?
+
+            choice = @_components[comp] = resolve_valid_choice(comp)
+            existing = fetch_component_choice(comp)
+            if existing != 'none' && existing != choice
+              next unless yes?("Switch #{comp} to '#{choice}' from '#{existing}' ?[yes/no]:")
+            end
+            @project_name = fetch_component_choice(:namespace)
+            execute_component_setup(comp, choice)
+            store_component_choice(comp, choice)
+          end
+        else
+          say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
+        end
+      end
+    end
+  end
+end

data/lib/padrino-gen/generators/components/actions.rb

@@ -2,25 +2,25 @@ module Padrino
   module Generators
     module Components
       module Actions
-        # For orm database components
-        # Generates the model migration file created when generating a new model
+        ##
+        # Generates the model migration file created when generating a new model.
         #
         # @param [String] filename
-        #   File name of model migration
+        #   File name of model migration.
         # @param [String] name
-        #   Name of model
+        #   Name of model.
         # @param [Array<String>] columns
-        #   Array of column names and property type
+        #   Array of column names and property type.
         # @param [Hash] options
-        #   Additional migration options, e.g { :base => "....text...", :up => "..text...",
-        #                                       :down => "..text...", column_format => "t.column :#{field}, :#{kind}" }
+        #   Additional migration options, e.g
+        #   { :base => "....text...", :up => "..text...",
+        #     :down => "..text...", column_format => "t.column :#{field}, :#{kind}" }
         # @example
         #   output_model_migration("AddPerson", "person", ["name:string", "age:integer"],
         #     :base => AR_MIGRATION,
         #     :column_format => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
         #     :up => AR_MODEL_UP_MG, :down => AR_MODEL_DOWN_MG)
         #
-        # @api private
         def output_model_migration(filename, name, columns, options={})
           if behavior == :revoke
             remove_migration(filename)
@@ -28,7 +28,7 @@ module Padrino
             return if migration_exist?(filename)
             model_name = name.to_s.pluralize
             field_tuples = columns.map { |value| value.split(":") }
-            field_tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] } # fix datetime
+            field_tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] }
             column_declarations = field_tuples.map(&options[:column_format]).join("\n      ")
             contents = options[:base].dup.gsub(/\s{4}!UP!\n/m, options[:up]).gsub(/!DOWN!\n/m, options[:down])
             contents = contents.gsub(/!NAME!/, model_name.underscore.camelize).gsub(/!TABLE!/, model_name.underscore)
@@ -40,19 +40,20 @@ module Padrino
           end
         end
 
-        # For orm database components
-        # Generates a standalone migration file based on the given options and columns
+        ##
+        # Generates a standalone migration file based on the given options and columns.
         #
         # @param [String] filename
-        #   File name of model migration
+        #   File name of model migration.
         # @param [String] name
-        #   Name of model
+        #   Name of model.
         # @param [Array<String>] columns
-        #   Array of column names and property type
+        #   Array of column names and property type.
         # @param [Hash] options
-        #   Additional migration options, e.g { :base "...text...", :change_format => "...text...",
-        #                                       :add => proc { |field, kind| "add_column :#{table_name}, :#{field}, :#{kind}" },
-        #                                       :remove => proc { |field, kind| "remove_column :#{table_name}, :#{field}" }
+        #   Additional migration options, e.g
+        #     { :base "...text...", :change_format => "...text...",
+        #       :add => proc { |field, kind| "add_column :#{table_name}, :#{field}, :#{kind}" },
+        #       :remove => proc { |field, kind| "remove_column :#{table_name}, :#{field}" }
         # @example
         #   output_migration_file(migration_name, name, columns,
         #     :base => AR_MIGRATION, :change_format => AR_CHANGE_MG,
@@ -60,7 +61,6 @@ module Padrino
         #     :remove => Proc.new { |field, kind| "t.remove :#{field}" }
         #   )
         #
-        # @api private
         def output_migration_file(filename, name, columns, options={})
           if behavior == :revoke
             remove_migration(name)
@@ -70,7 +70,7 @@ module Padrino
             migration_scan = filename.underscore.camelize.scan(/(Add|Remove)(?:.*?)(?:To|From)(.*?)$/).flatten
             direction, table_name = migration_scan[0].downcase, migration_scan[1].downcase.pluralize if migration_scan.any?
             tuples = direction ? columns.map { |value| value.split(":") } : []
-            tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] } # fix datetime
+            tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] }
             add_columns    = tuples.map(&options[:add]).join("\n    ")
             remove_columns = tuples.map(&options[:remove]).join("\n    ")
             forward_text = change_format.gsub(/!TABLE!/, table_name).gsub(/!COLUMNS!/, add_columns) if tuples.any?
@@ -85,21 +85,18 @@ module Padrino
           end
         end
 
-        # For migration files
-        # returns the number of the latest(most current) migration file
+        ##
+        # Returns the number of the latest(most current) migration file.
         #
-        # @api private
         def return_last_migration_number
           Dir[destination_root('db/migrate/*.rb')].map { |f|
             File.basename(f).match(/^(\d+)/)[0].to_i
           }.max.to_i || 0
         end
 
-        # For migration files
-        # returns the number of the migration that is being created
-        # returna timestamp instead if :migration_format: in .components is "timestamp"
+        ##
+        # Returns timestamp instead if :migration_format: in .components is "timestamp"
         #
-        # @api private
         def current_migration_number
           if fetch_component_choice(:migration_format).to_s == 'timestamp'
             Time.now.utc.strftime("%Y%m%d%H%M%S")
@@ -108,25 +105,22 @@ module Padrino
           end.to_s
         end
 
-        # Return true if the migration already exist
+        ##
+        # Return true if the migration already exist.
         #
         # @param [String] filename
-        #   File name of the migration file
+        #   File name of the migration file.
         #
-        # @param [Boolean] Boolean if file exists
-        #
-        # @api private
         def migration_exist?(filename)
           Dir[destination_root("db/migrate/*_#{filename.underscore}.rb")].size > 0
         end
 
-        # For the removal of migration files
-        # removes the migration file based on the migration name
+        ##
+        # Removes the migration file based on the migration name.
         #
         # @param [String] name
-        #   File name of the migration
+        #   File name of the migration.
         #
-        # @api private
         def remove_migration(name)
           migration_path =  Dir[destination_root('db/migrate/*.rb')].find do |f|
             File.basename(f) =~ /#{name.to_s.underscore}/
@@ -137,37 +131,35 @@ module Padrino
           end
         end
 
-        # For testing components
-        # Injects the test class text into the test_config file for setting up the test gen
+        ##
+        # Injects the test class text into the test_config file for setting up the test gen.
         #
         # @param [String] suite_text
-        #   Class name for test suite
+        #   Class name for test suite.
         # @param [Hash] options
-        #   Additional options to pass into injection
+        #   Additional options to pass into injection.
         #
         # @example
         #   insert_test_suite_setup('...CLASS_NAME...')
         #   => inject_into_file("test/test_config.rb", TEST.gsub(/CLASS_NAME/, @app_name), :after => "set :environment, :test")
         #
-        # @api private
         def insert_test_suite_setup(suite_text, options={})
           options.reverse_merge!(:path => "test/test_config.rb")
           create_file(options[:path], suite_text.gsub(/CLASS_NAME/, "#{@project_name}::#{@app_name}"))
         end
 
-        # For mocking components
-        # Injects the mock library include into the test class in test_config for setting up mock gen
+        ##
+        # Injects the mock library include into the test class in test_config
+        # for setting up mock gen
         #
         # @param [String] library_name
-        #   name of mocking library
+        #   Name of mocking library.
         # @param [Hash] options
-        #   Additional options to pass into injection
         #
         # @example
-        #   insert_mock_library_include('Mocha::API')
+        #   insert_mocking_include('Mocha::API'):
         #   => inject_into_file("test/test_config.rb", "  include Mocha::API\n", :after => /class.*?\n/)
         #
-        # @api private
         def insert_mocking_include(library_name, options={})
           options.reverse_merge!(:indent => 2, :after => /class.*?\n/, :path => "test/test_config.rb")
           return unless File.exist?(destination_root(options[:path]))
@@ -175,26 +167,25 @@ module Padrino
           inject_into_file(options[:path], include_text, :after => options[:after])
         end
 
-        # Returns space characters of given count
+        ##
+        # Returns space characters of given count.
         #
         # @example
         #   indent_spaces(2)
         #
-        # @api private
         def indent_spaces(count)
           ' ' * count
         end
 
-        # For Controller action generation
-        # Takes in fields for routes in the form of get:index post:test delete:yada and such
+        ##
+        # Takes in fields for routes in the form of get:index post:test delete:yada.
         #
         # @param [Array<String>] fields
-        #   Array of controller actions and route name
+        #   Array of controller actions and route name.
         #
         # @example
-        #   controller_actions "get:index", "post:test"o
+        #   controller_actions("get:index", "post:test")
         #
-        # @api private
         def controller_actions(fields)
           field_tuples = fields.map { |value| value.split(":") }
           action_declarations = field_tuples.map do |request, name|
@@ -202,7 +193,7 @@ module Padrino
           end
           action_declarations.join("\n").gsub(/^/, " " * 2).gsub(/^\s*$/, "")
         end
-      end # Actions
-    end # Components
-  end # Generators
-end # Padrino
+      end
+    end
+  end
+end

data/lib/padrino-gen/generators/components/mocks/mocha.rb

@@ -1,9 +1,10 @@
 def setup_mock
-  require_dependencies 'mocha', :group => 'test'
+  require_dependencies 'mocha', :group => 'test', :require => false
   case options[:test].to_s
     when 'rspec'
       inject_into_file 'spec/spec_helper.rb', "  conf.mock_with :mocha\n", :after => "RSpec.configure do |conf|\n"
     else
+      inject_into_file 'test/test_config.rb', "require 'mocha/api'", :after => "require File.expand_path(File.dirname(__FILE__) + \"/../config/boot\")\n"
       insert_mocking_include "Mocha::API"
   end
 end

data/lib/padrino-gen/generators/components/mocks/rr.rb

@@ -7,7 +7,7 @@ def setup_mock
       inject_into_file "test/test_config.rb","require 'riot/rr'\n", :after => "\"/../config/boot\")\n"
     when 'minitest'
       insert_mocking_include "RR::Adapters::MiniTest", :path => "test/test_config.rb"
-    else # default include
+    else
       insert_mocking_include "RR::Adapters::TestUnit", :path => "test/test_config.rb"
   end
 end