railties 3.2.22.5 → 4.0.0.beta1

data/lib/rails/generators/rails/migration/migration_generator.rb

@@ -1,8 +1,8 @@
 module Rails
   module Generators
-    class MigrationGenerator < NamedBase #metagenerator
-      argument :attributes, :type => :array, :default => [], :banner => "field[:type][:index] field[:type][:index]"
-      hook_for :orm, :required => true
+    class MigrationGenerator < NamedBase # :nodoc:
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+      hook_for :orm, required: true
     end
   end
 end

data/lib/rails/generators/rails/model/USAGE

@@ -19,15 +19,64 @@ Description:
     then the generator will create a module with a table_name_prefix method
     to prefix the model's table name with the module name (e.g. admin_account)
 
+Available field types:
+
+    Just after the field name you can specify a type like text or boolean.
+    It will generate the column with the associated SQL type. For instance:
+
+        `rails generate model post title:string body:text`
+
+    will generate a title column with a varchar type and a body column with a text
+    type. You can use the following types:
+
+        integer
+        primary_key
+        decimal
+        float
+        boolean
+        binary
+        string
+        text
+        date
+        time
+        datetime
+        timestamp
+
+    You can also consider `references` as a kind of type. For instance, if you run:
+
+        `rails generate model photo title:string album:references`
+
+    It will generate an album_id column. You should generate this kind of fields when
+    you will use a `belongs_to` association for instance. `references` also support
+    the polymorphism, you could enable the polymorphism like this:
+
+        `rails generate model product supplier:references{polymorphic}`
+
+    You can also specify some options just after the field type. You can use the
+    following options:
+
+        limit        Set the maximum size of the field giving a number between curly braces
+        default      Set a default value for the field
+        precision    Defines the precision for the decimal fields
+        scale        Defines the scale for the decimal fields
+        uniq         Defines the field values as unique
+        index        Will add an index on the field
+
+    Examples:
+
+        `rails generate model user pseudo:string{30}`
+        `rails generate model user pseudo:string:uniq`
+
+
 Examples:
     `rails generate model account`
 
         For ActiveRecord and TestUnit it creates:
 
             Model:      app/models/account.rb
-            Test:       test/unit/account_test.rb
+            Test:       test/models/account_test.rb
             Fixtures:   test/fixtures/accounts.yml
-            Migration:  db/migrate/XXX_add_accounts.rb
+            Migration:  db/migrate/XXX_create_accounts.rb
 
     `rails generate model post title:string body:text published:boolean`
 
@@ -39,7 +88,7 @@ Examples:
 
             Module:     app/models/admin.rb
             Model:      app/models/admin/account.rb
-            Test:       test/unit/admin/account_test.rb
+            Test:       test/models/admin/account_test.rb
             Fixtures:   test/fixtures/admin/accounts.yml
-            Migration:  db/migrate/XXX_add_admin_accounts.rb
+            Migration:  db/migrate/XXX_create_admin_accounts.rb
 

data/lib/rails/generators/rails/model/model_generator.rb

@@ -1,8 +1,8 @@
 module Rails
   module Generators
-    class ModelGenerator < NamedBase #metagenerator
-      argument :attributes, :type => :array, :default => [], :banner => "field[:type][:index] field[:type][:index]"
-      hook_for :orm, :required => true
+    class ModelGenerator < NamedBase # :nodoc:
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+      hook_for :orm, required: true
     end
   end
 end

data/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb

@@ -3,6 +3,13 @@ require "rails/generators/rails/app/app_generator"
 require 'date'
 
 module Rails
+  # The plugin builder allows you to override elements of the plugin
+  # generator without being forced to reverse the operations of the default
+  # generator.
+  #
+  # This allows you to override entire operations, like the creation of the
+  # Gemfile, README, or JavaScript files, without needing to know exactly
+  # what those operations do so you can create another template action.
   class PluginBuilder
     def rakefile
       template "Rakefile"
@@ -10,15 +17,15 @@ module Rails
 
     def app
       if mountable?
-        directory "app"
-        empty_directory_with_gitkeep "app/assets/images/#{name}"
+        directory 'app'
+        empty_directory_with_keep_file "app/assets/images/#{name}"
       elsif full?
-        empty_directory_with_gitkeep "app/models"
-        empty_directory_with_gitkeep "app/controllers"
-        empty_directory_with_gitkeep "app/views"
-        empty_directory_with_gitkeep "app/helpers"
-        empty_directory_with_gitkeep "app/mailers"
-        empty_directory_with_gitkeep "app/assets/images/#{name}"
+        empty_directory_with_keep_file 'app/models'
+        empty_directory_with_keep_file 'app/controllers'
+        empty_directory_with_keep_file 'app/views'
+        empty_directory_with_keep_file 'app/helpers'
+        empty_directory_with_keep_file 'app/mailers'
+        empty_directory_with_keep_file "app/assets/images/#{name}"
       end
     end
 
@@ -46,13 +53,11 @@ module Rails
       template "lib/%name%.rb"
       template "lib/tasks/%name%_tasks.rake"
       template "lib/%name%/version.rb"
-      if full?
-        template "lib/%name%/engine.rb"
-      end
+      template "lib/%name%/engine.rb" if engine?
     end
 
     def config
-      template "config/routes.rb" if full?
+      template "config/routes.rb" if engine?
     end
 
     def test
@@ -61,9 +66,9 @@ module Rails
       append_file "Rakefile", <<-EOF
 #{rakefile_test_tasks}
 
-task :default => :test
+task default: :test
       EOF
-      if full?
+      if engine?
         template "test/integration/navigation_test.rb"
       end
     end
@@ -82,10 +87,10 @@ task :default => :test
     end
 
     def test_dummy_config
-      template "rails/boot.rb", "#{dummy_path}/config/boot.rb", :force => true
-      template "rails/application.rb", "#{dummy_path}/config/application.rb", :force => true
+      template "rails/boot.rb", "#{dummy_path}/config/boot.rb", force: true
+      template "rails/application.rb", "#{dummy_path}/config/application.rb", force: true
       if mountable?
-        template "rails/routes.rb", "#{dummy_path}/config/routes.rb", :force => true
+        template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
       end
     end
 
@@ -110,7 +115,7 @@ task :default => :test
         copy_file "#{app_templates_dir}/app/assets/stylesheets/application.css",
                   "app/assets/stylesheets/#{name}/application.css"
       elsif full?
-        empty_directory_with_gitkeep "app/assets/stylesheets/#{name}"
+        empty_directory_with_keep_file "app/assets/stylesheets/#{name}"
       end
     end
 
@@ -121,40 +126,54 @@ task :default => :test
         template "#{app_templates_dir}/app/assets/javascripts/application.js.tt",
                   "app/assets/javascripts/#{name}/application.js"
       elsif full?
-        empty_directory_with_gitkeep "app/assets/javascripts/#{name}"
+        empty_directory_with_keep_file "app/assets/javascripts/#{name}"
       end
     end
 
-    def script(force = false)
-      return unless full?
+    def bin(force = false)
+      return unless engine?
 
-      directory "script", :force => force do |content|
+      directory "bin", force: force do |content|
         "#{shebang}\n" + content
       end
-      chmod "script", 0755, :verbose => false
+      chmod "bin", 0755, verbose: false
+    end
+
+    def gemfile_entry
+      return unless inside_application?
+
+      gemfile_in_app_path = File.join(rails_app_path, "Gemfile")
+      if File.exist? gemfile_in_app_path
+        entry = "gem '#{name}', path: '#{relative_path}'"
+        append_file gemfile_in_app_path, entry
+      end
     end
   end
 
   module Generators
-    class PluginNewGenerator < AppBase
+    class PluginNewGenerator < AppBase # :nodoc:
       add_shared_options_for "plugin"
 
       alias_method :plugin_path, :app_path
 
-      class_option :dummy_path,   :type => :string, :default => "test/dummy",
-                                  :desc => "Create dummy application at given path"
+      class_option :dummy_path,   type: :string, default: "test/dummy",
+                                  desc: "Create dummy application at given path"
+
+      class_option :full,         type: :boolean, default: false,
+                                  desc: "Generate a rails engine with bundled Rails application for testing"
 
-      class_option :full,         :type => :boolean, :default => false,
-                                  :desc => "Generate rails engine with integration tests"
+      class_option :mountable,    type: :boolean, default: false,
+                                  desc: "Generate mountable isolated application"
 
-      class_option :mountable,    :type => :boolean, :default => false,
-                                  :desc => "Generate mountable isolated application"
+      class_option :skip_gemspec, type: :boolean, default: false,
+                                  desc: "Skip gemspec file"
 
-      class_option :skip_gemspec, :type => :boolean, :default => false,
-                                  :desc => "Skip gemspec file"
+      class_option :skip_gemfile_entry, type: :boolean, default: false,
+                                        desc: "If creating plugin in application's directory " +
+                                                 "skip adding entry to Gemfile"
 
       def initialize(*args)
-        raise Error, "Options should be given after the plugin name. For details run: rails plugin --help" if args[0].blank?
+        raise Error, "Options should be given after the plugin name. For details run: rails plugin new --help" if args[0].blank?
 
         @dummy_path = nil
         super
@@ -195,8 +214,8 @@ task :default => :test
         build(:images)
       end
 
-      def create_script_files
-        build(:script)
+      def create_bin_files
+        build(:bin)
       end
 
       def create_test_files
@@ -208,6 +227,10 @@ task :default => :test
         create_dummy_app
       end
 
+      def update_gemfile
+        build(:gemfile_entry) unless options[:skip_gemfile_entry]
+      end
+
       def finish_template
         build(:leftovers)
       end
@@ -241,13 +264,17 @@ task :default => :test
           store_application_definition!
           build(:test_dummy_config)
           build(:test_dummy_clean)
-          # ensure that script/rails has proper dummy_path
-          build(:script, true)
+          # ensure that bin/rails has proper dummy_path
+          build(:bin, true)
         end
       end
 
+      def engine?
+        full? || mountable?
+      end
+
       def full?
-        options[:full] || options[:mountable]
+        options[:full]
       end
 
       def mountable?
@@ -271,7 +298,9 @@ task :default => :test
       end
 
       def valid_const?
-        if camelized =~ /^\d/
+        if original_name =~ /[^0-9a-zA-Z_]+/
+          raise Error, "Invalid plugin name #{original_name}. Please give a name which use only alphabetic or numeric or \"_\" characters."
+        elsif camelized =~ /^\d/
           raise Error, "Invalid plugin name #{original_name}. Please give a name which does not start with numbers."
         elsif RESERVED_NAMES.include?(name)
           raise Error, "Invalid plugin name #{original_name}. Please give a name which does not match one of the reserved rails words."
@@ -317,6 +346,19 @@ end
       def mute(&block)
         shell.mute(&block)
       end
+
+      def rails_app_path
+        APP_PATH.sub("/config/application", "") if defined?(APP_PATH)
+      end
+
+      def inside_application?
+        rails_app_path && app_path =~ /^#{rails_app_path}/
+      end
+
+      def relative_path
+        return unless inside_application?
+        app_path.sub(/^#{rails_app_path}\//, '')
+      end
     end
   end
 end

data/lib/rails/generators/rails/plugin_new/templates/%name%.gemspec

@@ -13,13 +13,13 @@ Gem::Specification.new do |s|
   s.summary     = "TODO: Summary of <%= camelized %>."
   s.description = "TODO: Description of <%= camelized %>."
 
-  s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
+  s.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
 <% unless options.skip_test_unit? -%>
   s.test_files = Dir["test/**/*"]
 <% end -%>
 
   <%= '# ' if options.dev? || options.edge? -%>s.add_dependency "rails", "~> <%= Rails::VERSION::STRING %>"
-<% if full? && !options[:skip_javascript] -%>
+<% if engine? && !options[:skip_javascript] -%>
   # s.add_dependency "<%= "#{options[:javascript]}-rails" %>"
 <% end -%>
 <% unless options[:skip_active_record] -%>

data/lib/rails/generators/rails/plugin_new/templates/Gemfile

@@ -1,17 +1,32 @@
 source "https://rubygems.org"
 
+<% if options[:skip_gemspec] -%>
+<%= '# ' if options.dev? || options.edge? -%>gem "rails", "~> <%= Rails::VERSION::STRING %>"
+<% if engine? && !options[:skip_javascript] -%>
+# gem "<%= "#{options[:javascript]}-rails" %>"
+<% end -%>
+<% else -%>
 # Declare your gem's dependencies in <%= name %>.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.
 gemspec
+<% end -%>
 
+<% unless options[:javascript] == 'jquery' -%>
 # jquery-rails is used by the dummy application
 gem "jquery-rails"
 
+<% end -%>
+<% if options[:skip_gemspec] -%>
+group :development do
+  gem "<%= gem_for_database %>"
+end
+<% else -%>
 # Declare any dependencies that are still in development here instead of in
 # your gemspec. These might include edge Rails or gems from your path or
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
+<% end -%>
 
 <% if options.dev? || options.edge? -%>
 # Your gem is dependent on dev or edge Rails. Once you can lock this
@@ -20,4 +35,4 @@ gem "jquery-rails"
 
 <% end -%>
 # To use debugger
-# <%= ruby_debugger_gemfile_entry %>
+# gem 'debugger'

data/lib/rails/generators/rails/plugin_new/templates/Rakefile

@@ -1,16 +1,10 @@
-#!/usr/bin/env rake
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
+
+require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -20,7 +14,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-<% if full? && !options[:skip_active_record] && with_dummy_app? -%>
+<% if engine? && !options[:skip_active_record] && with_dummy_app? -%>
 APP_RAKEFILE = File.expand_path("../<%= dummy_path -%>/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 <% end %>

data/lib/rails/generators/rails/plugin_new/templates/app/controllers/%name%/application_controller.rb.tt

@@ -1,5 +1,4 @@
 module <%= camelized %>
   class ApplicationController < ActionController::Base
-    protect_from_forgery :with => :exception
   end
 end

data/lib/rails/generators/rails/plugin_new/templates/app/views/layouts/%name%/application.html.erb.tt

@@ -2,7 +2,7 @@
 <html>
 <head>
   <title><%= camelized %></title>
-  <%%= stylesheet_link_tag    "<%= name %>/application", :media => "all" %>
+  <%%= stylesheet_link_tag    "<%= name %>/application", media: "all" %>
   <%%= javascript_include_tag "<%= name %>/application" %>
   <%%= csrf_meta_tags %>
 </head>

data/lib/rails/generators/rails/plugin_new/templates/gitignore

@@ -1,7 +1,10 @@
 .bundle/
 log/*.log
 pkg/
+<% unless options[:skip_test_unit] && options[:dummy_path] == 'test/dummy' -%>
 <%= dummy_path %>/db/*.sqlite3
+<%= dummy_path %>/db/*.sqlite3-journal
 <%= dummy_path %>/log/*.log
 <%= dummy_path %>/tmp/
 <%= dummy_path %>/.sass-cache
+<% end -%>

data/lib/rails/generators/rails/plugin_new/templates/lib/%name%.rb

@@ -1,4 +1,4 @@
-<% if full? -%>
+<% if engine? -%>
 require "<%= name %>/engine"
 
 <% end -%>