padrino-gen 0.10.7 → 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a6a1654d8ee352072e435cb364d88153983be16
+  data.tar.gz: 42ca8996ee141fa779627859b7d95e454d5ef3b9
+SHA512:
+  metadata.gz: 1ac55f683cba6782dc31abcb5e8732f45ced510600415b0ee2d0681b32cdfcd703526ff2136651bb2d70192db37dd47a02ebfa3624a956766b33fbcae27e2ff3
+  data.tar.gz: 95d1e97c9a31b4d25290305f6fc45ca8ca14afe03e20949a14eecd203100fbdd1d3952238fea09a71d9e28f3637ed59641f0cda8e508c97d2fbecb7699fc716a

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

@@ -11,12 +11,12 @@ module Padrino
         base.extend(ClassMethods)
       end
 
-      # Performs the necessary generator for a given component choice
+      # Performs the necessary generator for a given component choice.
       #
       # @param [Symbol] component
-      #   The type of component module
+      #   The type of component module.
       # @param [String] choice
-      #   The name of the component module choice
+      #   The name of the component module choice.
       #
       # @example
       #   execute_component_setup(:mock, 'rr')
@@ -29,19 +29,19 @@ module Padrino
         send("setup_#{component}") if respond_to?("setup_#{component}")
       end
 
-      # Returns the related module for a given component and option
+      # Returns the related module for a given component and option.
       #
       # @param [String] choice
-      #   The name of the component module
+      #   The name of the component module.
       # @param [Symbol] component
-      #   The type of the component module
+      #   The type of the component module.
       #
       # @example
       #   generator_module_for('rr', :mock)
       #
       # @api private
       def apply_component_for(choice, component)
-        # I need to override Thor#apply because for unknow reason :verobse => false break tasks.
+        # I need to override Thor#apply because for unknow reason :verbose => false break tasks.
         path = File.expand_path(File.dirname(__FILE__) + "/components/#{component.to_s.pluralize}/#{choice}.rb")
         say_status :apply, "#{component.to_s.pluralize}/#{choice}"
         shell.padding += 1
@@ -49,13 +49,13 @@ module Padrino
         shell.padding -= 1
       end
 
-      # Includes the component module for the given component and choice
-      # Determines the choice using .components file
+      # Includes the component module for the given component and choice.
+      # It determines the choice using .components file.
       #
       # @param [Symbol] component
-      #   The type of component module
+      #   The type of component module.
       # @param [String] choice
-      #   The name of the component module
+      #   The name of the component module.
       #
       # @example
       #   include_component_module_for(:mock)
@@ -68,12 +68,12 @@ module Padrino
         apply_component_for(choice, component)
       end
 
-      # Returns the component choice stored within the .component file of an application
+      # Returns the component choice stored within the .component file of an application.
       #
       # @param [Symbol] component
-      #   The type of component module
+      #   The type of component module.
       #
-      # @return [String] Name of the component module
+      # @return [String] Name of the component module.
       #
       # @example
       #   fetch_component_choice(:mock)
@@ -83,14 +83,14 @@ module Padrino
         retrieve_component_config(destination_root('.components'))[component]
       end
 
-      # Set the component choice aeleopteryxnd store it in the .component file of the application
+      # Set the component choice in the .component file of the application.
       #
       # @param [Symbol] key
-      #   The type of component module
+      #   The type of component module.
       # @param [Symbol] value
-      #   The name of the component module
+      #   The name of the component module.
       #
-      # @return [Symbol] the name of the component module
+      # @return [Symbol] The name of the component module.
       #
       # @example
       #   store_component_choice(:renderer, :haml)
@@ -104,12 +104,12 @@ module Padrino
         value
       end
 
-      # Loads the component config back into a hash
+      # Loads the component config back into a hash.
       #
       # @param [String] target
-      #   Path to component config file
+      #   Path to component config file.
       #
-      # @return [Hash] Loaded YAML file
+      # @return [Hash] Loaded YAML file.
       #
       # @example
       #   retrieve_component_config(...)
@@ -120,15 +120,15 @@ module Padrino
         YAML.load_file(target)
       end
 
-      # Prompts the user if necessary until a valid choice is returned for the component
+      # Prompts the user if necessary until a valid choice is returned for the component.
       #
       # @param [Symbol] component
-      #   The type of component module
+      #   The type of component module.
       #
       # @return [String] Name of component if valid, otherwise ask for valid choice.
       #
       # @example
-      #   resolve_valid_choice(:mock) => 'rr'
+      #   resolve_valid_choice(:mock)
       #
       # @api private
       def resolve_valid_choice(component)
@@ -141,31 +141,31 @@ module Padrino
         choice
       end
 
-      # Returns true if the option passed is a valid choice for component
+      # Returns true if the option passed is a valid choice for component.
       #
       # @param [Symbol] component
-      #   The type of component module
+      #   The type of component module.
       # @param [String] choice
-      #   The name of the component module
+      #   The name of the component module.
       #
       # @return [Boolean] Boolean of whether the choice is valid.
       #
       # @example
-      #   valid_choice?(:mock, 'rr') => true
+      #   valid_choice?(:mock, 'rr')
       #
       # @api public
       def valid_choice?(component, choice)
         choice.present? && self.class.available_choices_for(component).include?(choice.to_sym)
       end
 
-      # Creates a component_config file at the destination containing all component options
-      # Content is a yamlized version of a hash containing component name mapping to chosen value
+      # Creates a component_config file at the destination containing all component options.
+      # Content is a YAMLized version of a hash containing component name mapping to chosen value.
       #
       # @param [String] destination
       #   The file path to store the component config.
       #
       # @example
-      #   store_component_config '/foo/bar'
+      #   store_component_config('/foo/bar')
       #
       # @api private
       def store_component_config(destination)
@@ -185,26 +185,21 @@ module Padrino
       # @return [String] The full path
       #
       # @example
-      #   destination_root 'config/boot.rb'
+      #   destination_root('config/boot.rb')
       #
       # @api public
       def destination_root(*paths)
         File.expand_path(File.join(@destination_stack.last, paths))
       end
 
-      # Returns true if inside a Padrino application
-      #
-      # @return [Boolean] Boolean if in app root
-      #
-      # @example
-      #   in_app_root? => true
+      # Returns true if inside a Padrino application.
       #
       # @api public
       def in_app_root?
         File.exist?(destination_root('config/boot.rb'))
       end
 
-      # Returns the field with an unacceptable name(for symbol) else returns nil
+      # Returns the field with an unacceptable name(for symbol) else returns nil.
       #
       # @param [Array<String>] fields
       #   Field names for generators
@@ -220,16 +215,57 @@ module Padrino
         results.empty? ? nil : results
       end
 
-      # Returns the app_name for the application at root
+      # Apply default field types.
+      #
+      # @param [Array<String>] fields
+      #   Field names for generators
+      #
+      # @return [Array<String>] fields with default types
+      #
+      # @api semipublic
+      def apply_default_fields(fields)
+        fields.map! { |field| field =~ /:/ ? field : "#{field}:string" }
+      end
+
+      # Returns the namespace for the project.
       #
       # @param [String] app
-      #   folder name of application
+      #   folder name of application.
       #
-      # @return [String] class name for application
+      # @return [String] namespace for application.
       #
       # @example
-      #   fetch_app_name 'subapp'
-      #   #=> SubApp
+      #   fetch_project_name
+      #
+       # @api public
+      def fetch_project_name(app='app')
+        app_path = destination_root(app, 'app.rb')
+        @project_name = fetch_component_choice(:namespace) if @project_name.empty?
+        @project_name ||= begin
+          say "Autodetecting project namespace using folder name.", :red
+          say ""
+          detected_namespace = File.basename(destination_root('.')).gsub(/\W/, '_').camelize
+          say(<<-WARNING, :red)
+From v0.11.0 on, applications should have a `namespace` setting
+in their .components file. Please include a line like the following
+in your .components file:
+WARNING
+          say "\t:namespace: #{detected_namespace}", :yellow
+          say ""
+
+          detected_namespace
+        end
+      end
+
+      # Returns the app_name for the application at root.
+      #
+      # @param [String] app
+      #   folder name of application.
+      #
+      # @return [String] class name for application.
+      #
+      # @example
+      #   fetch_app_name('subapp')
       #
       # @api public
       def fetch_app_name(app='app')
@@ -237,17 +273,17 @@ module Padrino
         @app_name ||= File.read(app_path).scan(/class\s(.*?)\s</).flatten[0]
       end
 
-      # Adds all the specified gems into the Gemfile for bundler
+      # Adds all the specified gems into the Gemfile for bundler.
       #
       # @param [Array<String>] gem_names
-      #   Splat of gems to require in gemfile
+      #   Splat of gems to require in Gemfile.
       # @param [Hash] options
-      #   The options to pass to gem in gemfile
+      #   The options to pass to gem in Gemfile.
       #
       # @example
-      #   require_dependencies 'active_record'
-      #   require_dependencies 'mocha', 'bacon', :group => 'test'
-      #   require_dependencies 'json', :version => ">=1.2.3"
+      #   require_dependencies('active_record')
+      #   require_dependencies('mocha', 'bacon', :group => 'test')
+      #   require_dependencies('json', :version => ">=1.2.3")
       #
       # @api public
       def require_dependencies(*gem_names)
@@ -255,12 +291,12 @@ module Padrino
         gem_names.reverse.each { |lib| insert_into_gemfile(lib, options) }
       end
 
-      # Inserts a required gem into the Gemfile to add the bundler dependency
+      # Inserts a required gem into the Gemfile to add the bundler dependency.
       #
       # @param [String] name
-      #   Name of gem to insert into Gemfile
+      #   Name of gem to insert into Gemfile.
       # @param [Hash] options
-      #   Options to generate into Gemfile for gem
+      #   Options to generate into Gemfile for gem.
       #
       # @example
       #   insert_into_gemfile(name)
@@ -270,20 +306,20 @@ module Padrino
       # @api public
       def insert_into_gemfile(name, options={})
         after_pattern = options[:group] ? "#{options[:group].to_s.capitalize} requirements\n" : "Component requirements\n"
-        version = options.delete(:version)
-        gem_options   = options.map { |k, v| "#{k.inspect} => #{v.inspect}" }.join(", ")
-        write_option = gem_options.present? ? ", #{gem_options}" : ""
-        write_version = version.present? ? ", #{version.inspect}" : ""
-        include_text  = "gem '#{name}'"<< write_version << write_option << "\n"
+        version       = options.delete(:version)
+        gem_options   = options.map { |k, v| ":#{k} => '#{v.to_s}'" }.join(", ")
+        write_option  = gem_options.present? ? ", #{gem_options}" : ''
+        write_version = version.present? ? ", '#{version.to_s}'" : ''
+        include_text  = "gem '#{name}'" << write_version << write_option << "\n"
         inject_into_file('Gemfile', include_text, :after => after_pattern)
       end
 
-      # Inserts an hook before or after load in our boot.rb
+      # Inserts an hook before or after load in our boot.rb.
       #
       # @param [String] include_text
-      #   Text to include into hooks in boot.rb
+      #   Text to include into hooks in boot.rb.
       # @param [Symbol] where
-      #   method hook to call from Padrino, i.e :after_load, :before_load
+      #   method hook to call from Padrino, i.e :after_load, :before_load.
       #
       # @example
       #   insert_hook("DataMapper.finalize", :after_load)
@@ -293,10 +329,10 @@ module Padrino
         inject_into_file('config/boot.rb', "  #{include_text}\n", :after => "Padrino.#{where} do\n")
       end
 
-      # Inserts a middlware inside app.rb
+      # Inserts a middleware inside app.rb.
       #
       # @param [String] include_text
-      #   Text to include into hooks in boot.rb
+      #   Text to include into hooks in boot.rb.
       #
       # @example
       #   insert_middleware(ActiveRecord::ConnectionAdapters::ConnectionManagement)
@@ -304,23 +340,24 @@ module Padrino
       # @api public
       def insert_middleware(include_text, app=nil)
         name = app || (options[:name].present? ? @app_name.downcase : 'app')
-        inject_into_file("#{name}/app.rb", "  use #{include_text}\n", :after => "Padrino::Application\n")
+        inject_into_file("#{name}/app.rb", "    use #{include_text}\n", :after => "Padrino::Application\n")
       end
 
-      # Registers and Creates Initializer.
+      # Registers and creates initializer.
       #
       # @param [Symbol] name
-      #   Name of the initializer
+      #   Name of the initializer.
       # @param [String] data
-      #   Text to generate into the initializer file
+      #   Text to generate into the initializer file.
       #
       # @example
-      #   initializer :test, "some stuff here" # generates 'lib/test_init.rb'
+      #   initializer(:test, "some stuff here")
+      #   #=> generates 'lib/test_init.rb'
       #
       # @api public
       def initializer(name, data=nil)
         @_init_name, @_init_data = name, data
-        register = data.present? ? "  register #{name.to_s.underscore.camelize}Initializer\n" : "  register #{name}\n"
+        register = data.present? ? "    register #{name.to_s.underscore.camelize}Initializer\n" : "    register #{name}\n"
         inject_into_file destination_root("/app/app.rb"), register, :after => "Padrino::Application\n"
         template "templates/initializer.rb.tt", destination_root("/lib/#{name}_init.rb") if data.present?
       end
@@ -331,7 +368,7 @@ module Padrino
       #   name of library from padrino-contrib
       #
       # @example
-      #   require_contrib 'auto_locale'
+      #   require_contrib('auto_locale')
       #
       # @api public
       def require_contrib(contrib)
@@ -340,36 +377,36 @@ module Padrino
         inject_into_file destination_root("/config/boot.rb"), contrib, :before => "\nPadrino.load!"
       end
 
-      # Return true if our project has test component
+      # Return true if our project has test component.
       #
       # @api public
       def test?
         fetch_component_choice(:test).to_s != 'none'
       end
 
-      # Return true if we have a tiny skeleton
+      # Return true if we have a tiny skeleton.
       #
       # @api public
       def tiny?
-        File.exist?(destination_root("app/controllers.rb"))
+        File.exist?(destination_root('app/controllers.rb'))
       end
 
-      # Run the bundler
+      # Run the bundler.
       #
       # @api semipublic
       def run_bundler
-        say "Bundling application dependencies using bundler...", :yellow
+        say 'Bundling application dependencies using bundler...', :yellow
         in_root { run 'bundle install' }
       end
 
       # Ask something to the user and receives a response.
       #
       # @param [String] statement
-      #   String of statement to display for input
+      #   String of statement to display for input.
       # @param [String] default
-      #   Default value for input
+      #   Default value for input.
       # @param [String] color
-      #   Name of color to display input
+      #   Name of color to display input.
       #auto_locale
       # @return [String] Input value
       #
@@ -385,10 +422,10 @@ module Padrino
         result.blank? ? default : result
       end
 
-      # Raise SystemExit if the app is inexistent
+      # Raise SystemExit if the app does not exist.
       #
       # @param [String] app
-      #   Directoy name of application
+      #   Directory name of application.
       #
       # @example
       #   check_app_existence 'app'
@@ -401,16 +438,16 @@ module Padrino
           say "Unable to locate '#{app.underscore.camelize}' application        "
           say "================================================================="
           say
-          # raise SystemExit
+          raise SystemExit
         end
       end
 
-      # Generates standard and tiny applications within a project
+      # Generates standard and tiny applications within a project.
       #
       # @param [String] app
-      #   name of application
+      #   Name of application.
       # @param [Boolean] tiny
-      #   Boolean to generate a tiny structure
+      #   Boolean to generate a tiny structure.
       #
       # @example
       #   app_skeleton 'some_app'
@@ -418,12 +455,12 @@ module Padrino
       #
       # @api private
       def app_skeleton(app, tiny=false)
-        directory("app/", destination_root(app))
+        directory('app/', destination_root(app))
         if tiny # generate tiny structure
-          template "templates/controller.rb.tt", destination_root(app, "controllers.rb")
-          template "templates/helper.rb.tt", destination_root(app, "helpers.rb")
+          template 'templates/controller.rb.tt', destination_root(app, 'controllers.rb')
+          template 'templates/helper.rb.tt', destination_root(app, 'helpers.rb')
           @short_name = 'notifier'
-          template "templates/mailer.rb.tt", destination_root(app, "mailers.rb")
+          template 'templates/mailer.rb.tt', destination_root(app, 'mailers.rb')
         else # generate standard folders
           empty_directory destination_root(app, 'controllers')
           empty_directory destination_root(app, 'helpers')
@@ -432,12 +469,12 @@ module Padrino
         end
       end
 
-      # Ensure that project name is valid, else raise an NameError
+      # Ensure that project name is valid, else raise an NameError.
       #
       # @param [String] name
       #   name of project
       #
-      # @return [Exception] Exception with error messsage if not valid
+      # @return [Exception] Exception with error message if not valid.
       #
       # @example
       #   valid_constant '1235Stuff'
@@ -454,15 +491,15 @@ module Padrino
 
       # Class methods for Thor generators to support the generators and component choices.
       module ClassMethods
-        # Defines a class option to allow a component to be chosen and add to component type list
-        # Also builds the available_choices hash of which component choices are supported
+        # Defines a class option to allow a component to be chosen and add to component type list.
+        # Also builds the available_choices hash of which component choices are supported.
         #
         # @param [Symbol] name
-        #   Name of component
+        #   Name of component.
         # @param [String] caption
-        #   Description of the component
+        #   Description of the component.
         # @param [Hash] options
-        #   Additional parameters for component choice
+        #   Additional parameters for component choice.
         #
         # @example
         #   component_option :test, "Testing framework", :aliases => '-t', :choices => [:bacon, :shoulda]
@@ -475,33 +512,33 @@ module Padrino
           class_option name, :default => options[:default] || options[:choices].first, :aliases => options[:aliases], :desc => description
         end
 
-        # Tell padrino that for this Thor::Group it is a necessary task to run
+        # Tell Padrino that for this Thor::Group it is a necessary task to run.
         #
         # @api private
         def require_arguments!
           @require_arguments = true
         end
 
-        # Return true if we need an arguments for our Thor::Group
+        # Return true if we need an arguments for our Thor::Group.
         #
         # @api private
         def require_arguments?
           @require_arguments
         end
 
-        # Returns the compiled list of component types which can be specified
+        # Returns the compiled list of component types which can be specified.
         #
         # @api private
         def component_types
           @component_types
         end
 
-        # Returns the list of available choices for the given component (including none)
+        # Returns the list of available choices for the given component (including none).
         #
         # @param [Symbol] component
-        #   The type of the component module
+        #   The type of the component module.
         #
-        # @return [Array<Symbol>] Array of component choices
+        # @return [Array<Symbol>] Array of component choices.
         #
         # @example
         #   available_choices_for :test
@@ -511,7 +548,7 @@ module Padrino
         def available_choices_for(component)
           @available_choices[component] + [:none]
         end
-      end
+      end # ClassMethods
     end # Actions
   end # Generators
 end # Padrino