padrino-gen 0.11.3 → 0.11.4

data/lib/padrino-gen/generators/components/orms/minirecord.rb

@@ -11,7 +11,7 @@ ActiveRecord::Base.configurations[:test] = {
 !DB_TEST!
 }
 
-# Setup our logger
+# Setup our logger.
 ActiveRecord::Base.logger = logger
 
 # Raise exception on mass assignment protection for Active Record models.
@@ -30,7 +30,7 @@ ActiveRecord::Base.store_full_sti_class = true
 # Use ISO 8601 format for JSON serialized times and dates.
 ActiveSupport.use_standard_json_time_format = true
 
-# Don't escape HTML entities in JSON, leave that for the #json_escape helper
+# Don't escape HTML entities in JSON, leave that for the json_escape helper
 # if you're including raw JSON in an HTML page.
 ActiveSupport.escape_html_entities_in_json = false
 

data/lib/padrino-gen/generators/components/orms/mongoid.rb

@@ -1,5 +1,5 @@
 MONGOID = (<<-MONGO) unless defined?(MONGOID)
-# Connection.new takes host, port
+# Connection.new takes host and port
 host = 'localhost'
 port = Mongo::Connection::DEFAULT_PORT
 
@@ -11,7 +11,7 @@ end
 
 Mongoid.database = Mongo::Connection.new(host, port).db(database_name)
 
-# You can also configure Mongoid this way
+# You can also configure Mongoid this way:
 # Mongoid.configure do |config|
 #   name = @settings["database"]
 #   host = @settings["host"]
@@ -22,11 +22,11 @@ Mongoid.database = Mongo::Connection.new(host, port).db(database_name)
 #   ]
 # end
 #
-# More installation and setup notes are on http://mongoid.org/
+# More installation and setup notes are on http://mongoid.org/.
 MONGO
 
 MONGOID3 = (<<-MONGO) unless defined?(MONGOID3)
-# Connection.new takes host, port
+# Connection.new takes host and port.
 
 host = 'localhost'
 port = 27017
@@ -37,7 +37,7 @@ database_name = case Padrino.env
   when :test        then '!NAME!_test'
 end
 
-# Use MONGO_URI if it's set as an environmental variable
+# Use MONGO_URI if it's set as an environmental variable.
 Mongoid::Config.sessions =
   if ENV['MONGO_URI']
     {default: {uri: ENV['MONGO_URI'] }}
@@ -47,7 +47,7 @@ Mongoid::Config.sessions =
 
 # If you want to use a YML file for config, use this instead:
 #
-#   Mongoid.load!(File.join(Padrino.root, 'config', 'database.yml'), Padrino.env)
+#   Mongoid.load!(File.join(Padrino.root, 'config', 'database.yml'), Padrino.env)
 #
 # And add a config/database.yml file like this:
 #   development:
@@ -55,7 +55,7 @@ Mongoid::Config.sessions =
 #       default:
 #         database: !NAME!_development
 #         hosts:
-#           - localhost:27017 
+#           - localhost:27017
 #   production:
 #     sessions:
 #       default:

data/lib/padrino-gen/generators/components/orms/ohm.rb

@@ -1,7 +1,7 @@
 OHM = (<<-OHM) unless defined?(OHM)
-# Ohm does not have the concept of namespaces
+# Ohm does not have the concept of namespaces.
 # This means that you will not be able to have
-# a distinct test,development or production database
+# a distinct test, development, or production database.
 #
 # You can, however, run multiple redis servers on the same host
 # and point to them based on the environment:
@@ -14,7 +14,7 @@ OHM = (<<-OHM) unless defined?(OHM)
 
 # Alternatively, you can try specifying a difference :db
 # which, outside of confirmation, appears to provide distinct
-# namespaces from testing
+# namespaces from testing:
 # case Padrino.env
 #  when :development then Ohm.connect(:db => 0)
 #  when :production then Ohm.connect(:db => 1)

data/lib/padrino-gen/generators/components/stylesheets/compass.rb

@@ -1,7 +1,7 @@
 COMPASS_INIT = <<-COMPASS unless defined?(COMPASS_INIT)
 # Enables support for Compass, a stylesheet authoring framework based on SASS.
 # See http://compass-style.org/ for more details.
-# Store Compass/SASS files (by default) within 'app/stylesheets'
+# Store Compass/SASS files (by default) within 'app/stylesheets'.
 
 module CompassInitializer
   def self.registered(app)

data/lib/padrino-gen/generators/components/stylesheets/compass/partials/_base.scss

@@ -1,10 +1,12 @@
-// Here is where you can define your constants for your application and to configure the blueprint framework.
-// Feel free to delete these if you want keep the defaults:
+// Here is where you can define your constants for your application and to
+// configure the blueprint framework. Feel free to delete these if you want
+// keep the defaults:
 
 $blueprint-grid-columns: 24;
 $blueprint-container-size: 950px;
 $blueprint-grid-margin: 10px;
 
 // Use this to calculate the width based on the total width.
-// Or you can set !blueprint_grid_width to a fixed value and unset !blueprint_container_size -- it will be calculated for you.
+// Or you can set !blueprint_grid_width to a fixed value and
+// unset !blueprint_container_size -- it will be calculated for you.
 $blueprint-grid-width: ($blueprint-container-size + $blueprint-grid-margin) / $blueprint-grid-columns - $blueprint-grid-margin;

data/lib/padrino-gen/generators/components/stylesheets/less.rb

@@ -1,6 +1,6 @@
 LESS_INIT = <<-LESS unless defined?(LESS_INIT)
     # Enables support for Less template reloading for rack.
-    # Store Less files by default within 'app/stylesheets/'
+    # Store Less files by default within 'app/stylesheets/'.
     # See http://github.com/kelredd/rack-less for more details.
     require 'rack/less'
     # optional - use as necessary

data/lib/padrino-gen/generators/components/stylesheets/sass.rb

@@ -1,7 +1,7 @@
 SASS_INIT = <<-SASS unless defined?(SASS_INIT)
     # Enables support for SASS template reloading in rack applications.
     # See http://nex-3.com/posts/88-sass-supports-rack for more details.
-    # Store SASS files (by default) within 'app/stylesheets'
+    # Store SASS files (by default) within 'app/stylesheets'.
     require 'sass/plugin/rack'
     Sass::Plugin.options[:template_location] = Padrino.root("app/stylesheets")
     Sass::Plugin.options[:css_location] = Padrino.root("public/stylesheets")

data/lib/padrino-gen/generators/components/stylesheets/scss.rb

@@ -1,7 +1,7 @@
 SCSS_INIT = <<-SCSS unless defined?(SCSS_INIT)
     # Enables support for SCSS template reloading in rack applications.
     # See http://nex-3.com/posts/88-sass-supports-rack for more details.
-    # Store SCSS files (by default) within 'app/stylesheets'
+    # Store SCSS files (by default) within 'app/stylesheets'.
     require 'sass/plugin/rack'
     Sass::Plugin.options[:syntax] = :scss
     Sass::Plugin.options[:template_location] = Padrino.root("app/stylesheets")

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

@@ -5,15 +5,11 @@ module Padrino
     #
     class Controller < Thor::Group
 
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:controller, 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 controller [name]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Components::Actions
@@ -30,12 +26,12 @@ module Padrino
       class_option :parent,    :desc => 'The parent of the controller',           :aliases => '-p', :default => '',     :type => :string
       class_option :provides,  :desc => 'the formats provided by the controller', :aliases => '-f', :default => '',     :type => :string
 
-      # Show help if no argv given
+      # Show help if no ARGV given
       require_arguments!
 
+      ##
       # Execute controller generation
       #
-      # @api private
       def create_controller
         self.destination_root = options[:root]
         if in_app_root?
@@ -47,7 +43,7 @@ module Padrino
           @actions      = controller_actions(fields)
           @controller   = name.to_s.underscore
           @layout       = options[:layout] if options[:layout] && !options[:layout].empty?
-          
+
           block_opts = []
           block_opts << ":parent => :#{options[:parent]}" if options[:parent] && !options[:parent].empty?
           block_opts << ":provides => [#{options[:provides]}]" if options[:provides] && !options[:provides].empty?
@@ -63,6 +59,6 @@ module Padrino
           say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
         end
       end
-    end # Controller
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -5,15 +5,11 @@ module Padrino
     #
     class Mailer < Thor::Group
 
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:mailer, 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 mailer [name]'; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Components::Actions
@@ -27,12 +23,12 @@ module Padrino
       class_option :destroy,                                                      :aliases => '-d', :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!
 
-      # Execute mailer generation
+      ##
+      # Execute mailer generation.
       #
-      # @api private
       def create_mailer
         self.destination_root = options[:root]
         if in_app_root?
@@ -42,7 +38,7 @@ module Padrino
           @project_name    = options[:namespace].underscore.camelize
           @project_name    = fetch_project_name(app) if @project_name.empty?
           @app_name        = fetch_app_name(app)
-          @actions         = actions.map{|a| a.to_sym}
+          @actions         = actions.map(&:to_sym)
           @short_name      = name.to_s.gsub(/_mailer/i, '').underscore.downcase
           @mailer_basename = @short_name.underscore
           template "templates/mailer.rb.tt", destination_root(app, 'mailers', "#{@mailer_basename}.rb")
@@ -51,6 +47,6 @@ module Padrino
           say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
         end
       end
-    end # Mailer
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -4,16 +4,11 @@ module Padrino
     # Responsible for generating migration files for the appropriate ORM component.
     #
     class Migration < Thor::Group
-
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:migration, 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 migration [name] [fields]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Components::Actions
@@ -25,7 +20,7 @@ module Padrino
       class_option :root, :desc => 'The root destination', :aliases => '-r', :default => '.', :type => :string
       class_option :destroy, :aliases => '-d', :default => false, :type => :boolean
 
-      # Show help if no argv given
+      # Show help if no ARGV given.
       require_arguments!
 
       # Creates the migration file within a Padrino project.
@@ -43,6 +38,6 @@ module Padrino
           say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
         end
       end
-    end # Migration
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -1,19 +1,14 @@
 module Padrino
   module Generators
     ##
-    # Responsible for generating new models for the specified ORM component within a project or application.
+    # Responsible for generating new models for the specified ORM component.
     #
     class Model < Thor::Group
-
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:model, 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 model [name] [fields]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Components::Actions
@@ -27,12 +22,11 @@ module Padrino
       class_option :destroy, :aliases => '-d', :default => false, :type => :boolean
       class_option :skip_migration, :aliases => '-s', :default => false, :type => :boolean
 
-      # Show help if no argv given
+      # Show help if no ARGV given.
       require_arguments!
 
-      # Execute the model generation
+      # Execute the model generation.
       #
-      # @api private
       def create_model
         self.destination_root = options[:root]
         if in_app_root?
@@ -58,6 +52,6 @@ module Padrino
           say 'You are not at the root of a Padrino application! (config/boot.rb not found)'
         end
       end
-    end # Model
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -7,17 +7,13 @@ module Padrino
     # Responsible for executing plugins instructions within a Padrino project.
     #
     class Plugin < Thor::Group
-      # Defines the default URL for official padrino recipe plugins
+      # Defines the default URL for official padrino recipe plugins.
       PLUGIN_URL = 'https://github.com/padrino/padrino-recipes/tree/master/plugins'
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:plugin, self)
 
-      # Define the source plugin root
       def self.source_root; File.expand_path(File.dirname(__FILE__)); end
-      # Defines the banner for this CLI generator
       def self.banner; "padrino-gen plugin [plugin_identifier] [options]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Runner
@@ -29,14 +25,15 @@ module Padrino
       class_option :root, :desc => "The root destination", :aliases => '-r', :default => ".",   :type => :string
       class_option :list, :desc => "list available plugins", :aliases => '-l', :default => false, :type => :boolean
       class_option :destroy, :aliases => '-d', :default => false, :type => :boolean
-      # Show help if no argv given
+
+      # Show help if no ARGV given.
       require_arguments!
 
-      # Create the Padrino Plugin
+      ##
+      # Create the Padrino Plugin.
       #
-      # @api private
       def setup_plugin
-        if options[:list] || plugin_file.nil? # list method ran here
+        if options[:list] || plugin_file.nil?
           list_plugins
         else # executing the plugin instructions
           self.destination_root = options[:root]
@@ -65,6 +62,6 @@ module Padrino
           say plugins.map { |plugin| "  - #{plugin}" }.join("\n")
         end
       end
-    end # Plugins
-  end # Generators
-end # Padrino
+    end
+  end
+end

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

@@ -7,16 +7,11 @@ module Padrino
     # Responsible for generating new Padrino projects based on the specified project components.
     #
     class Project < Thor::Group
-
-      # Add this generator to our padrino-gen
       Padrino::Generators.add_generator(:project, 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] [options]"; end
 
-      # Include related modules
       include Thor::Actions
       include Padrino::Generators::Actions
       include Padrino::Generators::Runner
@@ -36,20 +31,15 @@ module Padrino
       class_option :gem,              :desc => 'Generate project as a gem',                                        :aliases => '-g', :default => false,       :type => :boolean
       class_option :migration_format, :desc => 'Filename format for migrations (number, timestamp)',                                 :default => 'number',    :type => :string
 
-      # Definitions for the available customizable components
-      component_option :orm,        'database engine',    :aliases => '-d', :choices => [:activerecord, :minirecord, :datamapper, :mongomapper, :mongoid, :sequel, :couchrest, :ohm, :mongomatic, :ripple], :default => :none
-      component_option :test,       'testing framework',  :aliases => '-t', :choices => [:rspec, :shoulda, :cucumber, :bacon, :testspec, :riot, :minitest], :default => :none
-      component_option :mock,       'mocking library',    :aliases => '-m', :choices => [:mocha, :rr], :default => :none
-      component_option :script,     'javascript library', :aliases => '-s', :choices => [:jquery, :prototype, :rightjs, :mootools, :extcore, :dojo], :default => :none
-      component_option :renderer,   'template engine',    :aliases => '-e', :choices => [:haml, :erb, :liquid, :slim], :default => :slim
-      component_option :stylesheet, 'stylesheet engine',  :aliases => '-c', :choices => [:less, :sass, :compass, :scss], :default => :none
+      # Definitions for the available customizable components.
+      defines_component_options
 
-      # Show help if no argv given
+      # Show help if no ARGV given.
       require_arguments!
 
-      # Copies over the Padrino base application App
+      ##
+      # Copies over the Padrino base application app.
       #
-      # @api private
       def setup_project
         valid_constant? name
         app = (options[:app] || "App")
@@ -78,9 +68,9 @@ module Padrino
         end
       end
 
-      # For each component, retrieve a valid choice and then execute the associated generator
+      ##
+      # For each component, retrieve a valid choice and then execute the associated generator.
       #
-      # @api private
       def setup_components
         return if options[:template]
         @_components = options.dup.slice(*self.class.component_types)
@@ -93,18 +83,18 @@ module Padrino
         store_component_choice(:migration_format, options[:migration_format])
       end
 
-      # Bundle all required components using bundler and Gemfile
+      ##
+      # Bundle all required components using bundler and Gemfile.
       #
-      # @api private
       def bundle_dependencies
         if options[:bundle]
           run_bundler
         end
       end
 
-      # Finish message
+      ##
+      # Finish message.
       #
-      # @api private
       def finish_message
         say
         say '=' * 65, :green
@@ -116,21 +106,21 @@ module Padrino
         say
       end
 
-      # Returns the git author name config or a fill-in value
+      ##
+      # Returns the git author name config or a fill-in value.
       #
-      # @api private
       def git_author_name
         git_author_name = `git config user.name`.chomp rescue ''
         git_author_name.empty? ? "TODO: Write your name" : git_author_name
       end
 
-      # Returns the git author email config or a fill-in value
+      ##
+      # Returns the git author email config or a fill-in value.
       #
-      # @api private
       def git_author_email
         git_author_email = `git config user.email`.chomp rescue ''
         git_author_email.empty? ? "TODO: Write your email address" : git_author_email
       end
-    end # Project
-  end # Generators
-end # Padrino
+    end
+  end
+end