padrino-gen 0.10.2 → 0.10.3

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

@@ -23,17 +23,17 @@ class <%= @app_name %> < Padrino::Application
   ##
   # 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)
-  # set :show_exceptions, true  # Shows a stack trace in browser (default for development)
-  # set :logging, true          # Logging in STDOUT for development and file for production (default only for development)
-  # set :public, "foo/bar"      # Location for static assets (default root/public)
-  # set :reload, false          # Reload application files (default in development)
-  # set :default_builder, "foo" # Set a custom form builder (default 'StandardFormBuilder')
-  # set :locale_path, "bar"     # Set path for I18n translations (default your_app/locales)
-  # disable :sessions           # Disabled sessions by default (enable if needed)
-  # disable :flash              # Disables rack-flash (enabled by default if Rack::Flash is defined)
-  # layout  :my_layout          # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
+  # 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)
+  # set :show_exceptions, true    # Shows a stack trace in browser (default for development)
+  # set :logging, true            # Logging in STDOUT for development and file for production (default only for development)
+  # set :public_folder, "foo/bar" # Location for static assets (default root/public)
+  # set :reload, false            # Reload application files (default in development)
+  # set :default_builder, "foo"   # Set a custom form builder (default 'StandardFormBuilder')
+  # set :locale_path, "bar"       # Set path for I18n translations (default your_app/locales)
+  # disable :sessions             # Disabled sessions by default (enable if needed)
+  # disable :flash                # Disables sinatra-flash (enabled by default if Sinatra::Flash is defined)
+  # layout  :my_layout            # Layout can be in views/layouts/foo.ext or views/foo.ext (default :application)
   #
 
   ##

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

@@ -26,6 +26,8 @@ module Padrino
       require_arguments!
 
       # Copies over the Padrino base admin application
+      #
+      # @api private
       def create_app
         self.destination_root = options[:root]
         @app_name = name.gsub(/\W/, "_").underscore.camelize
@@ -36,15 +38,14 @@ module Padrino
           append_file destination_root("config/apps.rb"),  "\nPadrino.mount(\"#{@app_name}\").to(\"/#{@app_name.downcase}\")"
 
           return if self.behavior == :revoke
-          say (<<-TEXT).gsub(/ {10}/,'')
-
-          =================================================================
-          Your #{@app_name} application has been installed.
-          This application has been mounted to /#{@app_name.downcase}
-          You can configure a different path by editing 'config/apps.rb'
-          =================================================================
-
-          TEXT
+          say
+          say "="*65, :green
+          say "Your #{@app_name} application has been installed."
+          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"
+          say "="*65, :green
+          say
         else
           say "You are not at the root of a Padrino application! (config/boot.rb not found)"
         end

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

@@ -15,6 +15,8 @@ module Padrino
 
       # 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"
@@ -35,6 +37,7 @@ module Padrino
         end
       end
 
+      # @api private
       def setup
         Padrino::Generators.load_components!
 

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

@@ -4,15 +4,30 @@ module Padrino
       module Actions
         # For orm database components
         # Generates the model migration file created when generating a new model
-        # options => { :base => "....text...", :up => "..text...",
-        #             :down => "..text...", column_format => "t.column :#{field}, :#{kind}" }
+        #
+        # @param [String] filename
+        #   File name of model migration
+        # @param [String] name
+        #   Name of model
+        # @param [Array<String>] columns
+        #   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}" }
+        # @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)
           else
             return if migration_exist?(filename)
             model_name = name.to_s.pluralize
-            field_tuples = fields.map { |value| value.split(":") }
+            field_tuples = columns.map { |value| value.split(":") }
             field_tuples.map! { |field, kind| kind =~ /datetime/i ? [field, 'DateTime'] : [field, kind] } # fix datetime
             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])
@@ -27,9 +42,25 @@ module Padrino
 
         # For orm database components
         # Generates a standalone migration file based on the given options and columns
-        # options => { :base "...text...", :change_format => "...text...",
-        #              :add => proc { |field, kind| "add_column :#{table_name}, :#{field}, :#{kind}" },
-        #              :remove => proc { |field, kind| "remove_column :#{table_name}, :#{field}" }
+        #
+        # @param [String] filename
+        #   File name of model migration
+        # @param [String] name
+        #   Name of model
+        # @param [Array<String>] columns
+        #   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}" }
+        # @example
+        #   output_migration_file(migration_name, name, columns,
+        #     :base => AR_MIGRATION, :change_format => AR_CHANGE_MG,
+        #     :add => Proc.new { |field, kind| "t.#{kind.underscore.gsub(/_/, '')} :#{field}" },
+        #     :remove => Proc.new { |field, kind| "t.remove :#{field}" }
+        #   )
+        #
+        # @api private
         def output_migration_file(filename, name, columns, options={})
           if behavior == :revoke
             remove_migration(name)
@@ -56,6 +87,8 @@ module Padrino
 
         # For migration files
         # 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
@@ -63,12 +96,24 @@ module Padrino
         end
 
         # Return true if the migration already exist
+        #
+        # @param [String] filename
+        #   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
+        #
+        # @param [String] name
+        #   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}/
@@ -81,8 +126,17 @@ module Padrino
 
         # For testing components
         # Injects the test class text into the test_config file for setting up the test gen
-        # insert_test_suite_setup('...CLASS_NAME...')
-        # => inject_into_file("test/test_config.rb", TEST.gsub(/CLASS_NAME/, @app_name), :after => "set :environment, :test")
+        #
+        # @param [String] suite_text
+        #   Class name for test suite
+        # @param [Hash] options
+        #   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/, @app_name))
@@ -90,8 +144,17 @@ module Padrino
 
         # For mocking components
         # Injects the mock library include into the test class in test_config for setting up mock gen
-        # insert_mock_library_include('Mocha::API')
-        # => inject_into_file("test/test_config.rb", "  include Mocha::API\n", :after => /class.*?\n/)
+        #
+        # @param [String] library_name
+        #   name of mocking library
+        # @param [Hash] options
+        #   Additional options to pass into injection
+        #
+        # @example
+        #   insert_mock_library_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]))
@@ -100,13 +163,25 @@ module Padrino
         end
 
         # Returns space characters of given count
-        # indent_spaces(2)
+        #
+        # @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
+        #
+        # @param [Array<String>] fields
+        #   Array of controller actions and route name
+        #
+        # @example
+        #   controller_actions "get:index", "post:test"o
+        #
+        # @api private
         def controller_actions(fields)
           field_tuples = fields.map { |value| value.split(":") }
           action_declarations = field_tuples.map do |request, name|

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

@@ -5,7 +5,9 @@ def setup_mock
       inject_into_file 'spec/spec_helper.rb', "  conf.mock_with :rr\n", :after => "RSpec.configure do |conf|\n"
     when 'riot'
       inject_into_file "test/test_config.rb","require 'riot/rr'\n", :after => "\"/../config/boot\")\n"
-    else
+    when 'minitest'
+      insert_mocking_include "RR::Adapters::MiniTest", :path => "test/test_config.rb"
+    else # default include
       insert_mocking_include "RR::Adapters::RRMethods", :path => "test/test_config.rb"
   end
 end

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

@@ -29,7 +29,7 @@ MONGO
 def setup_orm
   require_dependencies 'bson_ext', :require => 'mongo'
   require_dependencies 'mongoid'
-  require_dependencies('SystemTimer', :require => 'system_timer') if RUBY_VERSION =~ /1\.8/
+  require_dependencies('SystemTimer', :require => 'system_timer') if RUBY_VERSION =~ /1\.8/ && (!defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby')
   create_file("config/database.rb", MONGOID.gsub(/!NAME!/, @app_name.underscore))
 end
 

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

@@ -11,7 +11,7 @@ MONGO
 def setup_orm
   require_dependencies 'bson_ext', :require => 'mongo'
   require_dependencies 'mongo_mapper'
-  require_dependencies('SystemTimer', :require => 'system_timer') if RUBY_VERSION =~ /1\.8/
+  require_dependencies('SystemTimer', :require => 'system_timer') if RUBY_VERSION =~ /1\.8/ && (!defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby')
   create_file("config/database.rb", MONGO.gsub(/!NAME!/, @app_name.underscore))
 end
 

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

@@ -35,7 +35,7 @@ class !NAME! < Mongomatic::Base
   # String datatypes
 
 
-  # Examples
+  # Examples:
   # def validate
   #   expectations do
   #     be_present self['name'], "Name cannot be blank"

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

@@ -16,7 +16,7 @@ app.use Rack::Less,
 LESS
 
 def setup_stylesheet
-  require_dependencies 'less', 'rack-less'
+  require_dependencies 'rack-less'
   initializer :less, LESS_INIT
   empty_directory destination_root('/app/stylesheets')
 end

data/lib/padrino-gen/generators/components/tests/minitest.rb

@@ -0,0 +1,78 @@
+MINITEST_SETUP = (<<-TEST).gsub(/^ {10}/, '') unless defined?(MINITEST_SETUP)
+PADRINO_ENV = 'test' unless defined?(PADRINO_ENV)
+require File.expand_path('../../config/boot, __FILE__)
+
+class MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    ##
+    # You can handle all padrino applications using instead:
+    #   Padrino.application
+    CLASS_NAME.tap { |app|  }
+  end
+end
+TEST
+
+MINITEST_RAKE = (<<-TEST).gsub(/^ {10}/, '') unless defined?(MINITEST_RAKE)
+require 'rake/testtask'
+
+test_tasks = Dir['test/*/'].map { |d| File.basename(d) }
+
+test_tasks.each do |folder|
+  Rake::TestTask.new("test:\#{folder}") do |test|
+    test.pattern = "test/\#{folder}/**/*_test.rb"
+    test.verbose = true
+  end
+end
+
+desc "Run application test suite"
+task 'test' => test_tasks.map { |f| "test:\#{f}" }
+TEST
+
+MINITEST_CONTROLLER_TEST = (<<-TEST).gsub(/^ {10}/, '') unless defined?(MINITEST_CONTROLLER_TEST)
+require File.expand_path(File.dirname(__FILE__) + '/../../test_config.rb')
+
+describe "!NAME!Controller" do
+  before do
+    get '/'
+  end
+
+  it "should return hello world text" do
+    assert_equal "Hello World", last_response.body
+  end
+end
+TEST
+
+MINITEST_MODEL_TEST = (<<-TEST).gsub(/^ {10}/, '') unless defined?(MINITEST_MODEL_TEST)
+require File.expand_path(File.dirname(__FILE__) + '!PATH!/test_config.rb')
+
+describe "!NAME! Model" do
+  it 'can construct a new instance' do
+    @!DNAME! = !NAME!.new
+    refute_nil @!DNAME!
+  end
+end
+TEST
+
+def setup_test
+  require_dependencies 'rack-test', :require => 'rack/test', :group => 'test'
+  require_dependencies 'minitest', :version => "~>2.6.0", :require => 'minitest/autorun', :group => 'test'
+  insert_test_suite_setup MINITEST_SETUP
+  create_file destination_root("test/test.rake"), MINITEST_RAKE
+end
+
+# Generates a controller test given the controllers name
+def generate_controller_test(name)
+  minitest_contents = MINITEST_CONTROLLER_TEST.gsub(/!NAME!/, name.to_s.camelize)
+  controller_test_path = File.join('test',options[:app],'controllers',"#{name.to_s.underscore}_controller_test.rb")
+  create_file destination_root(controller_test_path), minitest_contents, :skip => true
+end
+
+def generate_model_test(name)
+  minitest_contents = MINITEST_MODEL_TEST.gsub(/!NAME!/, name.to_s.camelize).gsub(/!DNAME!/, name.to_s.underscore)
+  path = options[:app] == '.' ? '/..' : '/../..'
+  minitest_contents.gsub!(/!PATH!/,path)
+  model_test_path = File.join('test',options[:app],'models',"#{name.to_s.underscore}_test.rb")
+  create_file destination_root(model_test_path), minitest_contents, :skip => true
+end

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

@@ -26,6 +26,9 @@ module Padrino
       # 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?

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

@@ -26,6 +26,9 @@ module Padrino
       # Show help if no argv given
       require_arguments!
 
+      # Execute mailer generation
+      #
+      # @api private
       def create_mailer
         self.destination_root = options[:root]
         if in_app_root?

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

@@ -27,6 +27,9 @@ module Padrino
       # Show help if no argv given
       require_arguments!
 
+      # Execute the model generation
+      #
+      # @api private
       def create_model
         self.destination_root = options[:root]
         if in_app_root?

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

@@ -28,6 +28,8 @@ module Padrino
       require_arguments!
 
       # Create the Padrino Plugin
+      #
+      # @api private
       def setup_plugin
         if options[:list] # list method ran here
           plugins = {}

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

@@ -32,7 +32,7 @@ module Padrino
 
       # Definitions for the available customizable components
       component_option :orm,        "database engine",    :aliases => '-d', :choices => [:activerecord, :datamapper, :mongomapper, :mongoid, :sequel, :couchrest, :ohm, :mongomatic, :ripple], :default => :none
-      component_option :test,       "testing framework",  :aliases => '-t', :choices => [:rspec, :shoulda, :cucumber, :bacon, :testspec, :riot], :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 => :haml
@@ -42,6 +42,8 @@ module Padrino
       require_arguments!
 
       # Copies over the Padrino base application App
+      #
+      # @api private
       def setup_project
         valid_constant?(options[:app] || name)
         @app_name = (options[:app] || name).gsub(/\W/, "_").underscore.camelize
@@ -61,6 +63,8 @@ module Padrino
       end
 
       # 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)
@@ -72,6 +76,8 @@ module Padrino
       end
 
       # Bundle all required components using bundler and Gemfile
+      #
+      # @api private
       def bundle_dependencies
         if options[:bundle]
           run_bundler
@@ -79,13 +85,15 @@ module Padrino
       end
 
       # Finish message
+      #
+      # @api private
       def finish_message
         say
         say "="*65, :green
         say "#{name} is ready for development!", :green
         say "="*65, :green
-        say "$ cd #{options[:root]}/#{name}", :bold
-        say "$ bundle install", :bold unless options[:bundle]
+        say "$ cd #{options[:root]}/#{name}"
+        say "$ bundle install" unless options[:bundle]
         say "="*65, :green
         say
       end