rubocop-rspec 1.0.rc1 → 1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49fdb4caa58a78596796faa90d973ac516dffa1f
-  data.tar.gz: 10a46ce312058c7611a916851dcb40c0b49205f2
+  metadata.gz: 08dd700b50fb2adf8683db8ed5868dede6ada896
+  data.tar.gz: d75cd3f9367ebfe7e35df2e7ec641b8d66ea4d68
 SHA512:
-  metadata.gz: 3e27e4fb551f7c7354f3cda21bf1f3236e1f205bb1dbc69d2f30a21fb8b635bafbfac8555eb4723b5d33e437385b311d1fcb23019ec4dc439198f7752b5ae090
-  data.tar.gz: 778915e1974fae1b074d478e3a90bc9323fd199becbb17ff88d36c6f703df0e6fc48a9873381d26e28fae7f631ffa3f5bf7432afd335a7f4e55c6ba38a3b86fb
+  metadata.gz: 5d930412aa5d760bb7d4ca719ceae3dae07239c92eb795e4057b9e1200962c92f9595c88dec06516b2f3aa337bc6781b9a962c58a19f0fa5eeb1bba89c10ae07
+  data.tar.gz: 74d79a149588115a0845bd5a8e0414bada5c4320a60a057f5fa04def3f31821aeb386af521aeb90f1437355b1cb1a2f0fc41078a88b043485282ad9e3834f2b6

data/CHANGELOG.md

@@ -1,22 +1,20 @@
 # Change log
 
+## 1.0.rc2
+
+* Gem is no longer 20MB (sorry!). ([@nevir][])
+* `RspecFileName` cop allows for method specs to organized into directories by class and type. ([@nevir][])
+
 ## 1.0.rc1
 
-* Update code to work with rubocop >= 0.19 ([@geniou][])
-* Split `UnitSpecNaming` cop into `RSpecDescribeClass`,
-  `RSpecDescribeMethod` and `RSpecFileName` and enabled them all by
-  default. ([@geniou][])
-* Add `RSpecExampleWording` cop to prevent to use of should at the
-  beginning of the spec description. ([@geniou][])
+* Update code to work with rubocop `>= 0.19`. ([@geniou][])
+* Split `UnitSpecNaming` cop into `RSpecDescribeClass`, `RSpecDescribeMethod` and `RSpecFileName` and enabled them all by default. ([@geniou][])
+* Add `RSpecExampleWording` cop to prevent to use of should at the beginning of the spec description. ([@geniou][])
 * Fix `RSpecFileName` cop for non-class specs. ([@geniou][])
-* Adapt `RSpecFileName` cop to commen naming convention and skip spec
-  with multiple top level describes. ([@geniou][])
-* Add `RSpecMultipleDescribes` cop to check for multiple top level
-  describes. ([@geniou][])
-* Add `RSpecDescribedClass` to promote the use of `described_class`.
-  ([@geniou][])
-* Add `RSpecInstanceVariable` cop to check for the usage of instance
-  variables. ([@geniou][])
+* Adapt `RSpecFileName` cop to commen naming convention and skip spec with multiple top level describes. ([@geniou][])
+* Add `RSpecMultipleDescribes` cop to check for multiple top level describes. ([@geniou][])
+* Add `RSpecDescribedClass` to promote the use of `described_class`. ([@geniou][])
+* Add `RSpecInstanceVariable` cop to check for the usage of instance variables. ([@geniou][])
 
 <!-- Contributors -->
 

data/README.md

@@ -33,7 +33,8 @@ The Cops
 --------
 
 **WARNING: Cop names are under flux and will likely change in the near future.**
-We're hoping to [introduce namespaces](bbatsov/rubocop#1097) into the mix.
+We're hoping to
+[introduce namespaces](https://github.com/bbatsov/rubocop/issues/1097) into the mix.
 
 All cops are located under [`lib/rubocop/cop`](lib/rubocop/cop), and contain
 examples/documentation.

data/lib/rubocop/cop/rspec_file_name.rb

@@ -3,11 +3,11 @@
 module Rubocop
   module Cop
     # Checks the path of the spec file and enforces that it reflects the
-    # described class/module.
+    # described class/module and its optionally called out method.
     #
     # @example
-    #   class/method_spec.rb
-    #   class_spec.rb
+    #   my_class/method_spec.rb  # describe MyClass, '#method'
+    #   my_class_spec.rb         # describe MyClass
     class RSpecFileName < Cop
       include RSpec::TopLevelDescribe
 
@@ -19,24 +19,19 @@ module Rubocop
         object = const_name(args.first)
         return unless object
 
-        glob_matcher = matcher(object, args[1])
-        return if source_filename =~ regexp_from_glob(glob_matcher)
+        path_matcher = matcher(object, args[1])
+        return if source_filename =~ regexp_from_glob(path_matcher)
 
-        add_offense(node, :expression, format(MESSAGE, glob_matcher))
+        add_offense(node, :expression, format(MESSAGE, path_matcher))
       end
 
       private
 
       def matcher(object, method)
-        method_string = method ? method.children.first.gsub(/\W+/, '') : nil
-        path = [File.join(path_parts(object)), method_string].compact.join('_')
-        "#{path}*_spec.rb"
-      end
+        path = File.join(object.split('::').map { |p| camel_to_underscore(p) })
+        path += '*' + method.children.first.gsub(/\W+/, '') if method
 
-      def path_parts(object)
-        object.split('::').map do |part|
-          camel_to_underscore(part)
-        end
+        "#{path}*_spec.rb"
       end
 
       def source_filename
@@ -45,7 +40,7 @@ module Rubocop
 
       def camel_to_underscore(string)
         string.dup.tap do |result|
-          result.gsub!(/([^A-Z])([A-Z]+)/,       '\\1_\\2')
+          result.gsub!(/([^A-Z])([A-Z]+)/,          '\\1_\\2')
           result.gsub!(/([A-Z]{2,})([A-Z][^A-Z]+)/, '\\1_\\2')
           result.downcase!
         end

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module Rubocop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.0.rc1'
+      STRING = '1.0.rc2'
     end
   end
 end

data/rubocop-rspec.gemspec

@@ -20,7 +20,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.2'
 
   spec.require_paths = ['lib']
-  spec.files = Dir['**/*']
+  spec.files = Dir[
+    '{lib,spec}/**/*',
+    '*.md',
+    '*.gemspec',
+    'Gemfile',
+    'Rakefile'
+  ]
   spec.test_files = spec.files.grep(/^spec\//)
   spec.extra_rdoc_files = ['MIT-LICENSE.md', 'README.md']
 

data/spec/project_spec.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'RuboCop Project' do # rubocop:disable RSpecDescribeClass
+  describe 'default configuration file' do
+    let(:cop_names) do
+      Dir.glob(File.join(File.dirname(__FILE__), '..', 'lib', 'rubocop', 'cop',
+                         '*.rb'))
+        .map do |file|
+          File.basename(file, '.rb')
+          .gsub(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+          .gsub('Rspec', 'RSpec')
+        end
+    end
+
+    subject(:default_config) do
+      Rubocop::ConfigLoader.load_file('config/default.yml')
+    end
+
+    it 'has configuration for all cops' do
+      expect(default_config.keys.sort).to eq((cop_names).sort)
+    end
+
+    it 'has a nicely formatted description for all cops' do
+      cop_names.each do |name|
+        description = default_config[name]['Description']
+        expect(description).not_to be_nil
+        expect(description).not_to include("\n")
+      end
+    end
+  end
+
+  describe 'changelog' do
+    subject(:changelog) do
+      path = File.join(File.dirname(__FILE__), '..', 'CHANGELOG.md')
+      File.read(path)
+    end
+
+    it 'has link definitions for all implicit links' do
+      implicit_link_names = changelog.scan(/\[([^\]]+)\]\[\]/).flatten.uniq
+      implicit_link_names.each do |name|
+        expect(changelog).to include("[#{name}]: http")
+      end
+    end
+
+    describe 'entry' do
+      subject(:entries) { lines.grep(/^\*/).map(&:chomp) }
+      let(:lines) { changelog.each_line }
+
+      it 'has a whitespace between the * and the body' do
+        entries.each do |entry|
+          expect(entry).to match(/^\* \S/)
+        end
+      end
+
+      it 'has a link to the contributors at the end' do
+        entries.each do |entry|
+          expect(entry).to match(/\(\[@\S+\]\[\](?:, \[@\S+\]\[\])*\)$/)
+        end
+      end
+
+      describe 'link to related issue on github' do
+        let(:issues) do
+          entries.map do |entry|
+            entry.match(/\[(?<number>[#\d]+)\]\((?<url>[^\)]+)\)/)
+          end.compact
+        end
+
+        it 'has an issue number prefixed with #' do
+          issues.each do |issue|
+            expect(issue[:number]).to match(/^#\d+$/)
+          end
+        end
+
+        it 'has a valid URL' do
+          issues.each do |issue|
+            number = issue[:number].gsub(/\D/, '')
+            pattern = %r{^https://github\.com/[/]+/[/]+/(?:issues|pull)/#{number}$} # rubocop:disable LineLength
+            expect(issue[:url]).to match(pattern)
+          end
+        end
+
+        it 'has a colon and a whitespace at the end' do
+          entries_including_issue_link = entries.select do |entry|
+            entry.match(/^\*\s*\[/)
+          end
+
+          entries_including_issue_link.each do |entry|
+            expect(entry).to include('): ')
+          end
+        end
+      end
+
+      describe 'body' do
+        let(:bodies) do
+          entries.map do |entry|
+            entry
+              .sub(/^\*\s*(?:\[.+?\):\s*)?/, '')
+              .sub(/\s*\([^\)]+\)$/, '')
+          end
+        end
+
+        it 'does not start with a lower case' do
+          bodies.each do |body|
+            expect(body).not_to match(/^[a-z]/)
+          end
+        end
+
+        it 'ends with a punctuation' do
+          bodies.each do |body|
+            expect(body).to match(/[\.\!]$/)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rubocop/cop/rspec_file_name_spec.rb

@@ -12,7 +12,7 @@ describe Rubocop::Cop::RSpecFileName do
     expect(cop.offenses.size).to eq(1)
     expect(cop.offenses.map(&:line).sort).to eq([1])
     expect(cop.messages)
-      .to eq(['Spec path should end with `my_class_foo*_spec.rb`'])
+      .to eq(['Spec path should end with `my_class*foo*_spec.rb`'])
   end
 
   it 'checks the path' do
@@ -22,7 +22,7 @@ describe Rubocop::Cop::RSpecFileName do
     expect(cop.offenses.size).to eq(1)
     expect(cop.offenses.map(&:line).sort).to eq([1])
     expect(cop.messages)
-      .to eq(['Spec path should end with `my_class_foo*_spec.rb`'])
+      .to eq(['Spec path should end with `my_class*foo*_spec.rb`'])
   end
 
   it 'checks class spec paths' do
@@ -38,7 +38,7 @@ describe Rubocop::Cop::RSpecFileName do
   it 'skips specs that do not describe a class / method' do
     inspect_source(cop,
                    ["describe 'Test something' do; end"],
-                   'some/class_spec.rb')
+                   'some/class/spec.rb')
     expect(cop.offenses).to be_empty
   end
 
@@ -46,7 +46,7 @@ describe Rubocop::Cop::RSpecFileName do
     inspect_source(cop,
                    ["describe MyClass, 'do_this' do; end",
                     "describe MyClass, 'do_that' do; end"],
-                   'some/class_spec.rb')
+                   'some/class/spec.rb')
     expect(cop.offenses).to be_empty
   end
 
@@ -81,42 +81,63 @@ describe Rubocop::Cop::RSpecFileName do
   it 'checks instance methods' do
     inspect_source(cop,
                    ["describe Some::Class, '#inst' do; end"],
-                   'some/class_inst_spec.rb')
+                   'some/class/inst_spec.rb')
     expect(cop.offenses).to be_empty
   end
 
-  it 'checks methods' do
+  it 'checks class methods' do
     inspect_source(cop,
-                   ["describe Some::Class, 'inst' do; end"],
+                   ["describe Some::Class, '.inst' do; end"],
+                   'some/class/inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows flat hierarchies for instance methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, '#inst' do; end"],
                    'some/class_inst_spec.rb')
     expect(cop.offenses).to be_empty
   end
 
-  it 'checks class methods' do
+  it 'allows flat hierarchies for class methods' do
     inspect_source(cop,
                    ["describe Some::Class, '.inst' do; end"],
                    'some/class_inst_spec.rb')
     expect(cop.offenses).to be_empty
   end
 
+  it 'allows subdirs for instance methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, '#inst' do; end"],
+                   'some/class/instance_methods/inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
+  it 'allows subdirs for class methods' do
+    inspect_source(cop,
+                   ["describe Some::Class, '.inst' do; end"],
+                   'some/class/class_methods/inst_spec.rb')
+    expect(cop.offenses).to be_empty
+  end
+
   it 'ignores non-alphanumeric characters' do
     inspect_source(cop,
                    ["describe Some::Class, '#pred?' do; end"],
-                   'some/class_pred_spec.rb')
+                   'some/class/pred_spec.rb')
     expect(cop.offenses).to be_empty
   end
 
   it 'allows flexibility with predicates' do
     inspect_source(cop,
                    ["describe Some::Class, '#thing?' do; end"],
-                   'some/class_thing_predicate_spec.rb')
+                   'some/class/thing_predicate_spec.rb')
     expect(cop.offenses).to be_empty
   end
 
   it 'allows flexibility with operators' do
     inspect_source(cop,
                    ["describe MyClass, '#<=>' do; end"],
-                   'my_class_spaceship_operator_spec.rb')
+                   'my_class/spaceship_operator_spec.rb')
     expect(cop.offenses).to be_empty
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.0.rc1
+  version: 1.0.rc2
 platform: ruby
 authors:
 - Ian MacLeod
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -43,35 +43,6 @@ extra_rdoc_files:
 - MIT-LICENSE.md
 - README.md
 files:
-- CHANGELOG.md
-- config/default.yml
-- coverage/assets/0.8.0/application.css
-- coverage/assets/0.8.0/application.js
-- coverage/assets/0.8.0/colorbox/border.png
-- coverage/assets/0.8.0/colorbox/controls.png
-- coverage/assets/0.8.0/colorbox/loading.gif
-- coverage/assets/0.8.0/colorbox/loading_background.png
-- coverage/assets/0.8.0/favicon_green.png
-- coverage/assets/0.8.0/favicon_red.png
-- coverage/assets/0.8.0/favicon_yellow.png
-- coverage/assets/0.8.0/loading.gif
-- coverage/assets/0.8.0/magnify.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
-- coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
-- coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png
-- coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png
-- coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png
-- coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
-- coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
-- coverage/index.html
-- Gemfile
-- Gemfile.lock
 - lib/rubocop/cop/rspec_describe_class.rb
 - lib/rubocop/cop/rspec_describe_method.rb
 - lib/rubocop/cop/rspec_described_class.rb
@@ -83,15 +54,7 @@ files:
 - lib/rubocop/rspec/top_level_describe.rb
 - lib/rubocop/rspec/version.rb
 - lib/rubocop-rspec.rb
-- MIT-LICENSE.md
-- pkg/rubocop-rspec-0.1.0.gem
-- pkg/rubocop-rspec-0.17.0.gem
-- pkg/rubocop-rspec-0.18.0.gem
-- pkg/rubocop-rspec-0.18.1.gem
-- pkg/rubocop-rspec-1.0.rc1.gem
-- Rakefile
-- README.md
-- rubocop-rspec.gemspec
+- spec/project_spec.rb
 - spec/rubocop/cop/rspec_describe_class_spec.rb
 - spec/rubocop/cop/rspec_describe_method_spec.rb
 - spec/rubocop/cop/rspec_described_class_spec.rb
@@ -100,6 +63,12 @@ files:
 - spec/rubocop/cop/rspec_instance_variable_spec.rb
 - spec/rubocop/cop/rspec_multiple_describes_spec.rb
 - spec/spec_helper.rb
+- CHANGELOG.md
+- MIT-LICENSE.md
+- README.md
+- rubocop-rspec.gemspec
+- Gemfile
+- Rakefile
 homepage: http://github.com/nevir/rubocop-rspec
 licenses:
 - MIT
@@ -125,6 +94,7 @@ signing_key:
 specification_version: 4
 summary: Code style checking for RSpec files
 test_files:
+- spec/project_spec.rb
 - spec/rubocop/cop/rspec_describe_class_spec.rb
 - spec/rubocop/cop/rspec_describe_method_spec.rb
 - spec/rubocop/cop/rspec_described_class_spec.rb