should_not 0.0.1 → 0.7.0

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/mark-rushakoff/should_not.png?branch=master)](https://travis-ci.org/mark-rushakoff/should_not)
 [![Code Climate](https://codeclimate.com/github/mark-rushakoff/should_not.png)](https://codeclimate.com/github/mark-rushakoff/should_not)
+[![Gem Version](https://badge.fury.io/rb/should_not.png)](http://badge.fury.io/rb/should_not)
 
 You `should_not` start your specs with the string `"should"`.
 Use this gem to enforce that rule.

data/Rakefile

@@ -4,15 +4,33 @@ require 'stringio'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => [:spec, :integration]
 
+desc 'Run specs against RSpec'
 task :rspec do
   require 'rspec/core'
   err = StringIO.new
   out = StringIO.new
   RSpec::Core::Runner.run([integration_file('rspec')], err, out)
 
-  assert_contains!(out.string, '6 examples, 2 failures')
+  assert_contains!(out.string, '8 examples, 2 failures')
+  puts "RSpec integration spec passed"
+end
+
+desc 'Run specs against MiniTest'
+task :minitest do
+  require 'rbconfig'
+  ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+  output = `#{ruby} #{integration_file('minitest')}`
+
+  assert_contains!(output, '6 tests')
+  assert_contains!(output, '2 failures')
+  puts "MiniTest integration spec passed"
+end
+
+desc 'Run all integration specs'
+task :integration => [:rspec, :minitest] do
+  puts "All integration specs passed!"
 end
 
 INTEGRATION_DIR = File.expand_path(File.join(File.dirname(__FILE__), 'integration'))

data/integration/minitest.rb

@@ -0,0 +1,32 @@
+require 'should_not/minitest'
+require 'minitest/autorun'
+
+describe MiniTest do
+  it 'should fail when the string starts with should' do
+    1.must_equal 1
+  end
+
+  it 'can pass a normal test' do
+    1.must_equal 1
+  end
+
+  it 'passes when "should" is in the middle of the description' do
+    1.must_equal 1
+  end
+
+  describe 'a nested context' do
+    it 'should also fail when the string starts with should' do
+      1.must_equal 1
+    end
+
+    it 'can also pass a normal test' do
+      1.must_equal 1
+    end
+  end
+
+  describe 'another nested context with should in the string' do
+    it 'can pass yet another normal test' do
+      1.must_equal 1
+    end
+  end
+end

data/integration/rspec.rb

@@ -26,4 +26,14 @@ describe RSpec do
       1.should == 1
     end
   end
+
+  describe 'another nested context', :should => true do
+    it 'can pass yet another normal test' do
+      1.should == 1
+    end
+
+    it 'should not care if a spec starts with should' do
+      1.should == 1
+    end
+  end
 end

data/lib/should_not/constants.rb

@@ -0,0 +1,6 @@
+module ShouldNot
+  STARTS_WITH_SHOULD = /\Ashould(?:n't)?\s/i.freeze
+  FAILURE_MESSAGE = "You should_not start an example with should!".freeze
+
+  MINITEST_DESCRIPTION_PREFIX = /\Atest_\d+_/.freeze
+end

data/lib/should_not/minitest.rb

@@ -0,0 +1,7 @@
+require 'minitest/spec'
+require 'should_not/constants'
+
+MiniTest::Spec.before do |spec|
+  name = spec.__name__.to_s.gsub(ShouldNot::MINITEST_DESCRIPTION_PREFIX, '')
+  flunk(ShouldNot::FAILURE_MESSAGE) if name.match(ShouldNot::STARTS_WITH_SHOULD)
+end

data/lib/should_not/rspec.rb

@@ -1,11 +1,11 @@
 require 'rspec/core'
+require 'should_not/constants'
 
 RSpec.configure do |config|
-  STARTS_WITH_SHOULD = /\Ashould\s/.freeze
   config.before(:each) do
     next if example.metadata[:should] == true
     # Not sure that last is correct here -- is the array ever larger than one element?
     description = example.metadata[:description_args].last.to_s
-    fail("You should_not start an example with should!") if description.match(STARTS_WITH_SHOULD)
+    fail(ShouldNot::FAILURE_MESSAGE) if description.match(ShouldNot::STARTS_WITH_SHOULD)
   end
 end

data/lib/should_not/version.rb

@@ -1,3 +1,3 @@
 module ShouldNot
-  VERSION = "0.0.1"
+  VERSION = "0.7.0"
 end

data/should_not.gemspec

@@ -8,17 +8,25 @@ Gem::Specification.new do |spec|
   spec.version       = ShouldNot::VERSION
   spec.authors       = ["Mark Rushakoff"]
   spec.email         = ["mark.rushakoff@gmail.com"]
-  spec.description   = %q{You should_not start your specs with the string "should".}
+  spec.description   = <<-DESC
+  You should_not start your specs with the string "should".
+  If every spec starts with "should", then it's redundant everywhere.
+
+  Instead, write in an active tone:
+  `it "should ignore nil elements"` - BAD
+  `it "ignores nil elements"` - GOOD
+  DESC
   spec.summary       = %q{Fail specs that start with should.}
   spec.homepage      = "https://github.com/mark-rushakoff/should_not"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|integration)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "rspec"
 end

data/spec/should_not_spec.rb

@@ -1,8 +1,53 @@
 require 'spec_helper'
 require 'should_not'
+require 'should_not/rspec'
 
 describe ShouldNot do
-  it 'should have a version number' do
+  it 'has a version number' do
     ShouldNot::VERSION.should_not be_nil
   end
+
+  describe 'constants' do
+    describe 'STARTS_WITH_SHOULD' do
+      subject { ShouldNot::STARTS_WITH_SHOULD }
+
+      it 'matches the whole word "should" at the beginning of the string' do
+        'should foo bar'.should match(subject)
+      end
+
+      it 'matches when "should" is capitalized' do
+        'Should foo bar'.should match(subject)
+      end
+
+      it 'does not match the word "should" in the middle of a string' do
+        'foo should bar'.should_not match(subject)
+      end
+
+      it "matches shouldn't at the beggining" do
+        "shouldn't foo bar".should match(subject)
+      end
+
+      it "does not match shouldn't in the middle" do
+        "foo shouldn't bar".should_not match(subject)
+      end
+
+      it 'does not other words starting with should' do
+        'shoulders are nice to have'.should_not match(subject)
+        'shoulda is a helpful library for testing Rails'.should_not match(subject)
+      end
+    end
+    describe 'MINITEST_DESCRIPTION_PREFIX' do
+      subject { ShouldNot::MINITEST_DESCRIPTION_PREFIX }
+
+      it 'matches the irrelevant part of the test method name' do
+        stripped = 'test_0000_foo bar'.gsub(subject, '')
+        stripped.should == 'foo bar'
+      end
+
+      it 'handles when there are more than 10k tests' do
+        stripped = 'test_12345_foo bar'.gsub(subject, '')
+        stripped.should == 'foo bar'
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: should_not
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +75,10 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: You should_not start your specs with the string "should".
+description: ! "  You should_not start your specs with the string \"should\".\n  If
+  every spec starts with \"should\", then it's redundant everywhere.\n\n  Instead,
+  write in an active tone:\n  `it \"should ignore nil elements\"` - BAD\n  `it \"ignores
+  nil elements\"` - GOOD\n"
 email:
 - mark.rushakoff@gmail.com
 executables: []
@@ -73,8 +92,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- integration/minitest.rb
 - integration/rspec.rb
 - lib/should_not.rb
+- lib/should_not/constants.rb
+- lib/should_not/minitest.rb
 - lib/should_not/rspec.rb
 - lib/should_not/version.rb
 - should_not.gemspec
@@ -95,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3807308310444875557
+      hash: -3511363848172378781
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3807308310444875557
+      hash: -3511363848172378781
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -112,5 +134,7 @@ signing_key:
 specification_version: 3
 summary: Fail specs that start with should.
 test_files:
+- integration/minitest.rb
+- integration/rspec.rb
 - spec/should_not_spec.rb
 - spec/spec_helper.rb