minitest-english 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjQxNTA3MTk3ZDE3NjM0MDU0Njk0MDExOTJjYjJhOWQyODJiNmY2Nw==
+    ODEwNzEwZTI2NGVhMTk3MGIxYzI2NTIzZTQxYzA5OGIxY2VlY2Q5NQ==
   data.tar.gz: !binary |-
-    ZWVjMGMwOTIyNjI4MWE0NDQxMjRmZjE0ZWE0NzUzMjRjYmVjZGQzZg==
+    MmMwMjg3NWM5YzJjNTZlZDNiNTI4Mzg2YTg4ZDVlYTk5NzBkODZlYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    Mjg0NTYyNWJhNzljNTZkYjZiOTFhZjE1N2VlZmViMzI5OTQxOWI4YTU1YTk5
-    YjRmMjE5Y2NhNTZmMGUzNmU4ZDI2NzFkMTZmZjBlYTVmM2JiOTFmZjNjZDI1
-    MmVkMjlhZmFhMTEyYzdiNmE5YzdiYTdkMzk5Y2M1YmIzN2Q4ZTY=
+    Yzk1MmUyYmUzY2UyMmU4OWU2MzY1MmU1NTRkZTVjNGM4YjViYzY5NGU0OTU0
+    MzkwYmFmMTRhOWRkN2UyZDFlYWQ2NTljZjM2MzMzM2M4NGNiNjM3ZDAwNDJi
+    MjFjNmJlOTk2ZDQ1Y2NkODY2ZjYyMDIzMzVlYjdhMjRiYzY4YzE=
   data.tar.gz: !binary |-
-    ZGEwZTA4NzY4M2ZkZTQ1ZDk1MjE4YmY5ODcyYzZlNmI4YWMyMjk5OGY4YjM2
-    NmI3ZDM0NzA3MGM0NWQ2N2I0Y2MwYzUxODM3YWI4MWY4YTNkMGMyOWZmNWMw
-    ZTMxN2U2NDRjZGE3OGViMzc1ZDJhYTAxYWNmMzFlNjA5ODhkZWM=
+    YmJjMGY5NjllYmQwZmZmNTY1MWNhZWZiNjdjZmUyNTMwZjlmNzQ2YjFmOWVl
+    MDRiMDU1OTBmZDU3OTUxODAxZmI4NzNkNWU5ZDA4MjgwNGIzMDk1ZmI5MzBh
+    OTNjOTY4MjM3NTBjMjE2OGI4OWM4N2JjZGJhOGJjMGJmODhlNTA=

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - "2.0.0"
+  - "1.9.3"

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in minitest-english.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
-# minitest-english
+# minitest-english [![Gem Version](https://badge.fury.io/rb/minitest-english.png)](https://rubygems.org/gems/minitest-english) [![Build Status](https://travis-ci.org/DomKM/minitest-english.png?branch=master)](https://travis-ci.org/DomKM/minitest-english)
 
-MiniTest is an awesome testing framework. It's small, fast, and has very little magic.
+[MiniTest](https://github.com/seattlerb/minitest) is an awesome testing framework. It's small, fast, and has very little magic.
 
 > There are two hard things in Computer Science: cache invalidation and naming things.
 > — Phil Karlton
@@ -11,7 +11,7 @@ Unfortunately, MiniTest fails at the latter.
 
 ## What?
 
-`minitest-english` augments MiniTest's assertion and expectation naming with semantically symmetric aliases.
+`minitest-english` provides a simple interface for defining aliases in MiniTest assertions, expectations, and other modules/classes. It also optionally augments MiniTest's default assertion and expectation naming with semantically symmetric aliases.
 
 ## Why?
  
@@ -45,11 +45,11 @@ __"Must" is present tense but "wont" (contraction of "will not") is future tense
 
 ## How?
 
-`minitest-english` aliases all `refute` assertions with `deny` assertions and all `wont` expectations with `must_not` expectations.
+`minitest-english` provides an interface for watching and aliasing methods in MiniTest::Assertions, MiniTest::Expectations, and other modules. Once a module/class and aliasing rule is registered with `MiniTest::English`, all current and future methods in the module/class that match the rule will be aliased according to that rule.
 
-It's simple and does not use `method_missing` or any other inefficient techniques.
+`minitest-english` also _optionally_ aliases all `refute` assertions with `deny` assertions and all `wont` expectations with `must_not` expectations.
 
-_You know it's a tiny gem when you spend longer writing the readme than the code._
+It's simple and does not use `method_missing` or any other inefficient techniques.
 
 
 ## Installation
@@ -65,18 +65,65 @@ And then execute:
 Require it in your test_helper or spec_helper:
 
     require 'minitest/english'
+    
+To alias all `refute*` assertions to `deny*` assertions:
+
+    require 'minitest/english/deny'
+
+To alias all `wont*` expectations to `must_not*` expectations:
+
+    require 'minitest/english/must_not'
 
 ## Usage
 
+### Registering assertions and expectations
+
+The basic format is:
+
+    MiniTest::English.register_assertion/expectation, matcher_string, replacement_string
+    
+Let's register an expectation:
+
+```ruby
+MiniTest::English.register_expectation "wont*", "must_not*"
+```
+    
+That will alias all expectations that begin with `wont` to ones that begin with `must_not`. `register_assertion` works the same way.
+
+### Advanced registrations
+
+`MiniTest::English`'s `register_assertion` and `register_expectation` methods are just sugar that transform their input and send it to `MinTest::English.register`. 
+
+`MiniTest::English.register` takes a module/class, a regex that matches undesirable methods and captures the desirable parts of those methods, and a block that receives the captures and returns a symbol/string of the new method name.
+These two methods produce the same result:
+
+```ruby
+MiniTest::English.register_expectation "wont*", "must_not*"
+```
+
+```ruby
+MiniTest::English.register MiniTest::Expectations, /\Awont(.*)\z/ do |captures|
+  :"must_not#{captures[0]}"
+end
+```
+
+`MiniTest::English.register` is provided as a more flexible but verbose interface to deal with other classes/modules and other edge cases.
+
+### deny & must_not
+
+##### minitest/english/deny
 Write your negative assertions with `deny`.
 ```ruby
+require 'minitest/english/deny'
 refute_equal "English", "Do you speak it?"
 # refute* becomes deny*
 deny_equal "English", "Do you speak it?"
 ```
 
+##### minitest/english/must_not
 Write your negative expectations with `must_not`.
 ```ruby
+require 'minitest/english/must_not
 "Do you speak it?".wont_equal "English"
 # wont* becomes must_not*
 "Do you speak it?".must_not_equal "English"

data/lib/minitest/english.rb

@@ -1,2 +1,86 @@
-require 'minitest/english/assertions'
-require 'minitest/english/expectations'
+require 'minitest/unit'
+require 'minitest/spec'
+
+module MiniTest
+  module English
+    class << self
+
+      def register_assertion(matcher, replacement)
+        matcher, block = parse!(matcher, replacement)
+        register MiniTest::Assertions, matcher, &block
+      end
+
+      def register_expectation(matcher, replacement)
+        matcher, block = parse!(matcher, replacement)
+        register MiniTest::Expectations, matcher, &block
+      end
+
+      def register(mod, matcher, &block)
+        validate! mod, matcher, &block
+        REGISTRATIONS[mod][matcher] = block
+        watch mod
+        scan  mod
+        true
+      end
+
+      private
+
+      REGISTRATIONS = Hash.new { |hash, key| hash[key] = {} }
+
+      def scan(mod, method = nil)
+        if method
+          REGISTRATIONS[mod].each do |regex, block|
+            next unless match = regex.match(method)
+            mod.module_exec(match, block) do
+             alias_method block.(match.captures), match.to_s
+            end
+          end
+        else
+          mod.instance_methods.each do |method|
+            scan mod, method
+          end
+        end
+      end
+
+      # If only Ruby 1.9 had Module#prepend...
+      # Instead, we have to use this ugly thing. 
+      def watch(mod)
+        return if mod.respond_to? :minitest_english_method_added
+        class << mod
+          alias_method :minitest_english_method_added, :method_added
+          def method_added(method)
+            MiniTest::English.send :scan, self, method
+            minitest_english_method_added method
+          end
+        end
+      end
+
+      def parse!(matcher, replacement)
+        unless matcher.count('*') == replacement.count('*')
+          raise ArgumentError.new "Expected matching number of wildcards; got #{matcher}, #{replacement}"
+        end
+        [
+          /\A#{matcher.gsub('*','(.*)')}\z/,
+          proc do |captures|
+            captures.each_with_object(replacement.dup) do |cap, str|
+              str.sub! '*', cap
+            end
+          end
+        ]
+      end
+
+      def validate!(mod, matcher, &block)
+        unless mod.is_a? Module or mod.is_a? Class
+          raise ArgumentError.new "Expected Module or Class; received: #{mod.class}"
+        end
+        unless matcher.is_a? Regexp
+          raise ArgumentError.new "Expected Regex; received: #{matcher.class}"
+        end
+        unless block_given?
+          raise ArgumentError.new 'Expected a block to be passed'
+        end
+      end
+
+    end
+  end
+end

data/lib/minitest/english/deny.rb

@@ -0,0 +1,3 @@
+require 'minitest/english'
+
+MiniTest::English.register_assertion 'refute*', 'deny*'

data/lib/minitest/english/must_not.rb

@@ -0,0 +1,3 @@
+require 'minitest/english'
+
+MiniTest::English.register_expectation 'wont*', 'must_not*'

data/minitest-english.gemspec

@@ -2,17 +2,23 @@
 
 Gem::Specification.new do |gem|
   gem.name       = 'minitest-english'
-  gem.version    = '0.0.1'
+  gem.version    = '0.1.0'
   gem.author     = 'Dom Kiva-Meyer'
   gem.summary    = 'Minitest + the English language'
   gem.homepage   = 'http://github.com/domkm/minitest-english'
   gem.license    = 'MIT'
 
   gem.files      = `git ls-files`.split($/)
-  gem.test_files = gem.files.grep(%r{^(test|spec)/})
+  gem.test_files = gem.files.grep(%r(^test/))
 
+  gem.add_development_dependency 'bond'
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'm'
   gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'pry-awesome_print'
+  gem.add_development_dependency 'pry-coolline'
+  gem.add_development_dependency 'pry-debugger'
+  gem.add_development_dependency 'pry-rescue'
+  gem.add_development_dependency 'pry-stack_explorer'
   gem.add_development_dependency 'rake'
 end

data/test/{assertions_test.rb → assertion_deny_test.rb}

@@ -1,8 +1,9 @@
 require 'test_helper'
+require 'minitest/english/deny'
 
 describe MiniTest::Assertions do
-  MiniTest::Assertions.instance_methods.each do |method|
-    next unless match = /^refute(.*)/.match(method)
+  MiniTest::Assertions.instance_methods.each do |method|    
+    next unless match = /\Arefute(.*)/.match(method)   
     it "aliases #{method} to deny#{match[1]}" do
       assert_equal MiniTest::Assertions.instance_method(method),
                    MiniTest::Assertions.instance_method("deny#{match[1]}")

data/test/{expectations_test.rb → expectation_must_not_test.rb}

@@ -1,8 +1,9 @@
 require 'test_helper'
+require 'minitest/english/must_not'
 
 describe MiniTest::Expectations do
   MiniTest::Expectations.instance_methods.each do |method|
-    next unless match = /^wont(.*)/.match(method)
+    next unless match = /\Awont(.*)/.match(method)
     it "aliases #{method} to must_not#{match[1]}" do
       assert_equal MiniTest::Expectations.instance_method(method),
                    MiniTest::Expectations.instance_method("must_not#{match[1]}")

data/test/registration_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+describe MiniTest::English do
+
+  before do
+    @module = Module.new { def pre_reg; end }
+    @block = proc { |captures| "post#{captures.last}"}
+  end
+
+  describe 'before registration' do
+    it 'does not create aliases' do
+      @module.method_defined?(:post_reg).must_equal false
+    end
+  end
+
+  describe 'after registration' do
+    before do
+      MiniTest::English.register @module, /\Apre(.*)\z/, &@block
+    end
+    it 'creates aliases upon registration' do
+      @module.method_defined?(:post_reg).must_equal true
+    end
+    it 'creates aliases upon method addition' do
+      @module.module_exec { def pre_add; end }
+      @module.method_defined?(:post_add).must_equal true
+    end
+  end
+
+  describe 'invalid registration' do
+    describe 'imbalanced wildcards' do
+      it 'raises ArgumentError' do
+        assert_raises(ArgumentError) do
+          MiniTest::English.register_assertion 'foo*', '*bar*'
+        end
+      end
+    end
+    describe 'invalid module/class' do
+      it 'raises ArgumentError' do
+        assert_raises(ArgumentError) do
+          MiniTest::English.register :foo, /\Apre(.*)\z/, &@block
+        end
+      end
+    end
+    describe 'invalid regex' do
+      it 'raises ArgumentError' do
+        assert_raises(ArgumentError) do
+          MiniTest::English.register @module, :not_a_regex, &@block
+        end
+      end
+    end
+    describe 'invalid block' do
+      it 'raises ArgumentError' do
+        assert_raises(ArgumentError) do
+          MiniTest::English.register @module, /\Apre(.*)\z/
+        end
+      end
+    end
+  end
+
+  describe 'custom block' do
+    it 'passes regex captures and assigns method alias' do
+      MiniTest::English.register @module, /(.*)reg(.*)/ do |captures|
+        :"#{captures.first}foo"
+      end
+      @module.method_defined?(:pre_foo).must_equal true
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -1,2 +1,11 @@
 require 'minitest/autorun'
 require 'minitest/english'
+
+unless ENV['CI']
+  require 'bond'
+  require 'pry-awesome_print'
+  require 'pry-coolline'
+  require 'pry-debugger'
+  require 'pry-rescue/minitest'
+  require 'pry-stack_explorer'
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: minitest-english
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dom Kiva-Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bond
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,76 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,18 +158,19 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/minitest-english.rb
 - lib/minitest/english.rb
-- lib/minitest/english/assertions.rb
-- lib/minitest/english/expectations.rb
+- lib/minitest/english/deny.rb
+- lib/minitest/english/must_not.rb
 - minitest-english.gemspec
 - pulp_fiction.gif
-- test/assertions_test.rb
-- test/expectations_test.rb
+- test/assertion_deny_test.rb
+- test/expectation_must_not_test.rb
+- test/registration_test.rb
 - test/test_helper.rb
 homepage: http://github.com/domkm/minitest-english
 licenses:
@@ -112,6 +197,7 @@ signing_key:
 specification_version: 4
 summary: Minitest + the English language
 test_files:
-- test/assertions_test.rb
-- test/expectations_test.rb
+- test/assertion_deny_test.rb
+- test/expectation_must_not_test.rb
+- test/registration_test.rb
 - test/test_helper.rb

data/lib/minitest-english.rb

@@ -1 +0,0 @@
-require 'minitest/english'

data/lib/minitest/english/assertions.rb

@@ -1,8 +0,0 @@
-require 'minitest/unit'
-
-module MiniTest::Assertions
-	instance_methods.each do |method|
-		next unless match = /^refute(.*)/.match(method)
-		alias_method "deny#{match[1]}", method
-	end
-end

data/lib/minitest/english/expectations.rb

@@ -1,8 +0,0 @@
-require 'minitest/spec'
-
-module MiniTest::Expectations
-	instance_methods.each do |method|
-	  next unless match = /^wont(.*)/.match(method)
-	  alias_method "must_not#{match[1]}", method
-	end
-end