rspec-rails 3.5.0 → 4.0.0

data/lib/generators/rspec/channel/channel_generator.rb

@@ -0,0 +1,12 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class ChannelGenerator < Base
+      def create_channel_spec
+        template 'channel_spec.rb.erb', File.join('spec/channels', class_path, "#{file_name}_channel_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/{observer/templates/observer_spec.rb → channel/templates/channel_spec.rb.erb}

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %>Observer, <%= type_metatag(:observer) %> do
+RSpec.describe <%= class_name %>Channel, <%= type_metatag(:channel) %> do
   pending "add some examples to (or delete) #{__FILE__}"
 end
 <% end -%>

data/lib/generators/rspec/controller/controller_generator.rb

@@ -4,11 +4,20 @@ module Rspec
   module Generators
     # @private
     class ControllerGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "action action"
+      argument :actions, type: :array, default: [], banner: "action action"
 
-      class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :controller_specs, :type => :boolean, :default => true
-      class_option :view_specs,       :type => :boolean, :default => true
+      class_option :template_engine,  desc: "Template engine to generate view files"
+      class_option :request_specs,    type: :boolean, default: true, desc: "Generate request specs"
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :view_specs,       type: :boolean, default: true, desc: "Generate view specs"
+      class_option :routing_specs,    type: :boolean, default: false, desc: "Generate routing specs"
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        template 'request_spec.rb',
+                 File.join('spec/requests', class_path, "#{file_name}_request_spec.rb")
+      end
 
       def generate_controller_spec
         return unless options[:controller_specs]
@@ -29,6 +38,14 @@ module Rspec
                    File.join("spec", "views", file_path, "#{@action}.html.#{options[:template_engine]}_spec.rb")
         end
       end
+
+      def generate_routing_spec
+        return if actions.empty?
+        return unless options[:routing_specs]
+
+        template 'routing_spec.rb',
+                 File.join('spec/routing', class_path, "#{file_name}_routing_spec.rb")
+      end
     end
   end
 end

data/lib/generators/rspec/controller/templates/request_spec.rb

@@ -0,0 +1,14 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
+<% namespaced_path = regular_class_path.join('/') %>
+<% for action in actions -%>
+  describe "GET /<%= action %>" do
+    it "returns http success" do
+      get "<%= "/#{namespaced_path}" if namespaced_path != '' %>/<%= file_name %>/<%= action %>"
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+<% end -%>
+end

data/lib/generators/rspec/controller/templates/routing_spec.rb

@@ -0,0 +1,13 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe '<%= class_name %>Controller', <%= type_metatag(:routing) %> do
+  describe 'routing' do
+<% for action in actions -%>
+    it 'routes to #<%= action %>' do
+      expect(get: "/<%= class_name.underscore %>/<%= action %>").to route_to("<%= class_name.underscore %>#<%= action  %>")
+    end
+<% end -%>
+  end
+end
+<% end -%>

data/lib/generators/rspec/feature/feature_generator.rb

@@ -4,8 +4,8 @@ module Rspec
   module Generators
     # @private
     class FeatureGenerator < Base
-      class_option :feature_specs, :type => :boolean, :default => true,  :desc => "Generate feature specs"
-      class_option :singularize,   :type => :boolean, :default => false, :desc => "Singularize the generated feature"
+      class_option :feature_specs, type: :boolean, default: true,  desc: "Generate feature specs"
+      class_option :singularize,   type: :boolean, default: false, desc: "Singularize the generated feature"
 
       def generate_feature_spec
         return unless options[:feature_specs]
@@ -19,9 +19,9 @@ module Rspec
 
       def filename
         if options[:singularize]
-          "#{table_name.singularize}_spec.rb"
+          "#{file_name.singularize}_spec.rb"
         else
-          "#{table_name}_spec.rb"
+          "#{file_name}_spec.rb"
         end
       end
     end

data/lib/generators/rspec/generator/generator_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class GeneratorGenerator < Base
+      class_option :generator_specs, type: :boolean, default: true,  desc: "Generate generator specs"
+
+      def generate_generator_spec
+        return unless options[:generator_specs]
+
+        template template_name, File.join('spec/generator', class_path, filename)
+      end
+
+      def template_name
+        'generator_spec.rb'
+      end
+
+      def filename
+        "#{table_name}_generator_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/rspec/generator/templates/generator_spec.rb

@@ -0,0 +1,6 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:generator) %> do
+
+  pending "add some scenarios (or delete) #{__FILE__}"
+end

data/lib/generators/rspec/helper/helper_generator.rb

@@ -4,7 +4,7 @@ module Rspec
   module Generators
     # @private
     class HelperGenerator < Base
-      class_option :helper_specs, :type => :boolean, :default => true
+      class_option :helper_specs, type: :boolean, default: true
 
       def generate_helper_spec
         return unless options[:helper_specs]

data/lib/generators/rspec/install/install_generator.rb

@@ -32,8 +32,8 @@ DESC
 
       def generate_rspec_init(tmpdir)
         initializer = ::RSpec::Core::ProjectInitializer.new(
-          :destination => tmpdir,
-          :report_stream => StringIO.new
+          destination: tmpdir,
+          report_stream: StringIO.new
         )
         initializer.run
 
@@ -47,7 +47,7 @@ DESC
         gsub_file spec_helper_path,
                   'rspec --init',
                   'rails generate rspec:install',
-                  :verbose => false
+                  verbose: false
       end
 
       def remove_warnings_configuration(spec_helper_path)
@@ -56,7 +56,7 @@ DESC
         gsub_file spec_helper_path,
                   /#{empty_line}(#{comment_line})+\s+config\.warnings = true\n/,
                   '',
-                  :verbose => false
+                  verbose: false
       end
     end
   end

data/lib/generators/rspec/install/templates/spec/rails_helper.rb

@@ -1,9 +1,9 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+require File.expand_path('../config/environment', __dir__)
 # Prevent database truncation if the environment is production
 abort("The Rails environment is running in production mode!") if Rails.env.production?
-require 'spec_helper'
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
@@ -20,18 +20,17 @@ require 'rspec/rails'
 # directory. Alternatively, in the individual `*_spec.rb` files, manually
 # require only the support files necessary.
 #
-# Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
-
-<% if RSpec::Rails::FeatureCheck.can_maintain_test_schema? -%>
-# Checks for pending migration and applies them before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.maintain_test_schema!
-
-<% elsif RSpec::Rails::FeatureCheck.can_check_pending_migrations? -%>
-# Checks for pending migrations before tests are run.
-# If you are not using ActiveRecord, you can remove this line.
-ActiveRecord::Migration.check_pending!
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
 
+<% if RSpec::Rails::FeatureCheck.has_active_record_migration? -%>
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
 <% end -%>
 RSpec.configure do |config|
 <% if RSpec::Rails::FeatureCheck.has_active_record? -%>
@@ -43,6 +42,20 @@ RSpec.configure do |config|
   # instead of true.
   config.use_transactional_fixtures = true
 
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+<% else -%>
+  # Remove this line to enable support for ActiveRecord
+  config.use_active_record = false
+
+  # If you enable ActiveRecord support you should unncomment these lines,
+  # note if you'd prefer not to run each example within a transaction, you
+  # should set use_transactional_fixtures to false.
+  #
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # config.use_transactional_fixtures = true
+
 <% end -%>
   # RSpec Rails can automatically mix in different behaviours to your tests
   # based on their file location, for example enabling you to call `get` and
@@ -51,7 +64,7 @@ RSpec.configure do |config|
   # You can disable this behaviour by removing the line below, and instead
   # explicitly tag your specs with their type, e.g.:
   #
-  #     RSpec.describe UsersController, :type => :controller do
+  #     RSpec.describe UsersController, type: :controller do
   #       # ...
   #     end
   #

data/lib/generators/rspec/integration/integration_generator.rb

@@ -7,15 +7,15 @@ module Rspec
       # Add a deprecation for this class, before rspec-rails 4, to use the
       # `RequestGenerator` instead
       class_option :request_specs,
-                   :type => :boolean,
-                   :default => true,
-                   :desc => "Generate request specs"
+                   type: :boolean,
+                   default: true,
+                   desc: "Generate request specs"
 
       def generate_request_spec
         return unless options[:request_specs]
 
         template 'request_spec.rb',
-                 File.join('spec/requests', class_path, "#{table_name}_spec.rb")
+                 File.join('spec/requests', "#{name.underscore.pluralize}_spec.rb")
       end
     end
   end

data/lib/generators/rspec/integration/templates/request_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_helper'
 
 RSpec.describe "<%= class_name.pluralize %>", <%= type_metatag(:request) %> do
-  describe "GET /<%= table_name %>" do
+  describe "GET /<%= name.underscore.pluralize %>" do
     it "works! (now write some real specs)" do
       get <%= index_helper %>_path
       expect(response).to have_http_status(200)

data/lib/generators/rspec/mailbox/mailbox_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators
+    # @private
+    class MailboxGenerator < Base
+      def create_mailbox_spec
+        template('mailbox_spec.rb.erb',
+                 File.join('spec/mailboxes', class_path, "#{file_name}_mailbox_spec.rb")
+        )
+      end
+    end
+  end
+end

data/lib/generators/rspec/mailbox/templates/mailbox_spec.rb.erb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %>Mailbox, <%= type_metatag(:mailbox) %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>

data/lib/generators/rspec/mailer/mailer_generator.rb

@@ -5,7 +5,7 @@ module Rspec
   module Generators
     # @private
     class MailerGenerator < Base
-      argument :actions, :type => :array, :default => [], :banner => "method method"
+      argument :actions, type: :array, default: [], banner: "method method"
 
       def generate_mailer_spec
         template "mailer_spec.rb", File.join('spec/mailers', class_path, "#{file_name}_spec.rb")
@@ -20,6 +20,7 @@ module Rspec
 
       def generate_preview_files
         return unless RSpec::Rails::FeatureCheck.has_action_mailer_preview?
+
         template "preview.rb", File.join("spec/mailers/previews", class_path, "#{file_name}_preview.rb")
       end
     end

data/lib/generators/rspec/mailer/templates/mailer_spec.rb

@@ -1,10 +1,10 @@
 require "rails_helper"
 
 <% module_namespacing do -%>
-RSpec.describe <%= class_name %><%= Rails.version.to_f >= 5.0 ? "Mailer" : "" %>, <%= type_metatag(:mailer) %> do
+RSpec.describe <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>, <%= type_metatag(:mailer) %> do
 <% for action in actions -%>
   describe "<%= action %>" do
-    let(:mail) { <%= class_name %><%= Rails.version.to_f >= 5.0 ? "Mailer" : "" %>.<%= action %> }
+    let(:mail) { <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>.<%= action %> }
 
     it "renders the headers" do
       expect(mail.subject).to eq(<%= action.to_s.humanize.inspect %>)

data/lib/generators/rspec/mailer/templates/preview.rb

@@ -5,7 +5,7 @@ class <%= class_name %>Preview < ActionMailer::Preview
 
   # Preview this email at http://localhost:3000/rails/mailers/<%= file_path %>/<%= action %>
   def <%= action %>
-    <%= class_name %><%= Rails.version.to_f >= 5.0 ? "Mailer" : "" %>.<%= action %>
+    <%= Rails.version.to_f >= 5.0 ? class_name.sub(/(Mailer)?$/, 'Mailer') : class_name %>.<%= action %>
   end
 <% end -%>
 

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

@@ -5,10 +5,10 @@ module Rspec
     # @private
     class ModelGenerator < Base
       argument :attributes,
-               :type => :array,
-               :default => [],
-               :banner => "field:type field:type"
-      class_option :fixture, :type => :boolean
+               type: :array,
+               default: [],
+               banner: "field:type field:type"
+      class_option :fixture, type: :boolean
 
       def create_model_spec
         template_file = File.join(
@@ -23,7 +23,8 @@ module Rspec
 
       def create_fixture_file
         return unless missing_fixture_replacement?
-        template 'fixtures.yml', File.join('spec/fixtures', "#{table_name}.yml")
+
+        template 'fixtures.yml', File.join('spec/fixtures', class_path, "#{(pluralize_table_names? ? plural_file_name : file_name)}.yml")
       end
 
     private

data/lib/generators/rspec/model/templates/fixtures.yml

@@ -1,4 +1,4 @@
-# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
 
 <% unless attributes.empty? -%>
 one:

data/lib/generators/rspec/request/request_generator.rb

@@ -4,7 +4,7 @@ module Rspec
   module Generators
     # @private
     class RequestGenerator < IntegrationGenerator
-      source_paths << File.expand_path("../../integration/templates", __FILE__)
+      source_paths << File.expand_path('../integration/templates', __dir__)
     end
   end
 end

data/lib/generators/rspec/scaffold/scaffold_generator.rb

@@ -6,30 +6,47 @@ module Rspec
     # @private
     class ScaffoldGenerator < Base
       include ::Rails::Generators::ResourceHelpers
-      source_paths << File.expand_path("../../helper/templates", __FILE__)
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
-
-      class_option :orm, :desc => "ORM used to generate the controller"
-      class_option :template_engine, :desc => "Template engine to generate view files"
-      class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
-
-      class_option :controller_specs, :type => :boolean, :default => true,  :desc => "Generate controller specs"
-      class_option :view_specs,       :type => :boolean, :default => true,  :desc => "Generate view specs"
-      class_option :helper_specs,     :type => :boolean, :default => true,  :desc => "Generate helper specs"
-      class_option :routing_specs,    :type => :boolean, :default => true,  :desc => "Generate routing specs"
+      source_paths << File.expand_path('../helper/templates', __dir__)
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      class_option :orm, desc: "ORM used to generate the controller"
+      class_option :template_engine, desc: "Template engine to generate view files"
+      class_option :singleton, type: :boolean, desc: "Supply to create a singleton controller"
+      class_option :api, type: :boolean, desc: "Skip specs unnecessary for API-only apps"
+
+      class_option :controller_specs, type: :boolean, default: false, desc: "Generate controller specs"
+      class_option :request_specs,    type: :boolean, default: true,  desc: "Generate request specs"
+      class_option :view_specs,       type: :boolean, default: true,  desc: "Generate view specs"
+      class_option :helper_specs,     type: :boolean, default: true,  desc: "Generate helper specs"
+      class_option :routing_specs,    type: :boolean, default: true,  desc: "Generate routing specs"
+
+      def initialize(*args, &blk)
+        @generator_args = args.first
+        super(*args, &blk)
+      end
 
       def generate_controller_spec
         return unless options[:controller_specs]
 
-        template_file = File.join(
-          'spec/controllers',
-          controller_class_path,
-          "#{controller_file_name}_controller_spec.rb"
-        )
-        template 'controller_spec.rb', template_file
+        if options[:api]
+          template 'api_controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        else
+          template 'controller_spec.rb', template_file(folder: 'controllers', suffix: '_controller')
+        end
+      end
+
+      def generate_request_spec
+        return unless options[:request_specs]
+
+        if options[:api]
+          template 'api_request_spec.rb', template_file(folder: 'requests')
+        else
+          template 'request_spec.rb', template_file(folder: 'requests')
+        end
       end
 
       def generate_view_specs
+        return if options[:api]
         return unless options[:view_specs] && options[:template_engine]
 
         copy_view :edit
@@ -49,97 +66,42 @@ module Rspec
         template 'routing_spec.rb', template_file
       end
 
-      hook_for :integration_tool, :as => :integration
-
     protected
 
+      attr_reader :generator_args
+
       def copy_view(view)
         template "#{view}_spec.rb",
                  File.join("spec/views", controller_file_path, "#{view}.html.#{options[:template_engine]}_spec.rb")
       end
 
-      def formatted_hash(hash)
-        formatted = hash.inspect
-        formatted.gsub!("{", "{ ")
-        formatted.gsub!("}", " }")
-        formatted.gsub!("=>", " => ")
-        formatted
-      end
-
       # support for namespaced-resources
       def ns_file_name
-        ns_parts.empty? ? file_name : "#{ns_parts[0].underscore}_#{ns_parts[1].singularize.underscore}"
+        return file_name if ns_parts.empty?
+
+        "#{ns_prefix.map(&:underscore).join('/')}_#{ns_suffix.singularize.underscore}"
       end
 
       # support for namespaced-resources
       def ns_table_name
-        ns_parts.empty? ? table_name : "#{ns_parts[0].underscore}/#{ns_parts[1].tableize}"
+        return table_name if ns_parts.empty?
+
+        "#{ns_prefix.map(&:underscore).join('/')}/#{ns_suffix.tableize}"
       end
 
       def ns_parts
         @ns_parts ||= begin
-                        matches = ARGV[0].to_s.match(/\A(\w+)(?:\/|::)(\w+)/)
-                        matches ? [matches[1], matches[2]] : []
+                        parts = generator_args[0].split(/\/|::/)
+                        parts.size > 1 ? parts : []
                       end
       end
 
-      # Returns the name of the mock. For example, if the file name is user,
-      # it returns mock_user.
-      #
-      # If a hash is given, it uses the hash key as the ORM method and the
-      # value as response. So, for ActiveRecord and file name "User":
-      #
-      #   mock_file_name(:save => true)
-      #   #=> mock_user(:save => true)
-      #
-      # If another ORM is being used and another method instead of save is
-      # called, it will be the one used.
-      #
-      def mock_file_name(hash = nil)
-        if hash
-          method, and_return = hash.to_a.first
-          method = orm_instance.send(method).split('.').last.gsub(/\(.*?\)/, '')
-          "mock_#{ns_file_name}(:#{method} => #{and_return})"
-        else
-          "mock_#{ns_file_name}"
-        end
-      end
-
-      # Receives the ORM chain and convert to expects. For ActiveRecord:
-      #
-      #   should! orm_class.find(User, "37")
-      #   #=> User.should_receive(:find).with(37)
-      #
-      # For Datamapper:
-      #
-      #   should! orm_class.find(User, "37")
-      #   #=> User.should_receive(:get).with(37)
-      #
-      def should_receive(chain)
-        stub_or_should_chain(:should_receive, chain)
+      def ns_prefix
+        @ns_prefix ||= ns_parts[0..-2]
       end
 
-      # Receives the ORM chain and convert to stub. For ActiveRecord:
-      #
-      #   stub orm_class.find(User, "37")
-      #   #=> User.stub(:find).with(37)
-      #
-      # For Datamapper:
-      #
-      #   stub orm_class.find(User, "37")
-      #   #=> User.stub(:get).with(37)
-      #
-      def stub(chain)
-        stub_or_should_chain(:stub, chain)
-      end
-
-      def stub_or_should_chain(mode, chain)
-        receiver, method = chain.split(".")
-        method.gsub!(/\((.*?)\)/, '')
-
-        response = "#{receiver}.#{mode}(:#{method})"
-        response << ".with(#{$1})" unless $1.blank?
-        response
+      def ns_suffix
+        @ns_suffix ||= ns_parts[-1]
       end
 
       def value_for(attribute)
@@ -158,6 +120,10 @@ module Rspec
         end
       end
 
+      def template_file(folder:, suffix: '')
+        File.join('spec', folder, controller_class_path, "#{controller_file_name}#{suffix}_spec.rb")
+      end
+
       def banner
         self.class.banner
       end