minitest-spec-expect 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,164 @@
+# minitest-spec-expect
+Expect syntax for [minitest](http://docs.seattlerb.org/minitest/index.html). Made out of love for
+both rspec2's expect syntax and minitest's lightweight feel.
+## Install
+In your Gemfile:
+```ruby
+gem 'minitest-spec-expect'
+```
+or from the command line:
+```
+$ gem install minitest-spec-expect
+```
+## Usage
+Wrap the object under test in an `expect()` object. Then call a minitest expectation on it,
+substituting `must` and `wont` with `to` and `to_not`.
+
+For example:
+```ruby
+describe Integer do
+  describe '#+' do
+    it 'adds numbers correctly' do
+      expect(1 + 1).to_equal 2
+    end
+
+    it 'does not add numbers incorrectly' do
+      expect(1 + 1).to_not_equal 3
+    end
+  end
+end
+```
+That's equivalent to:
+```ruby
+describe Integer do
+  describe '#+' do
+    it 'adds numbers correctly' do
+      (1 + 1).must_equal 2
+    end
+
+    it 'does not add numbers incorrectly' do
+      (1 + 1).wont_equal 3
+    end
+  end
+end
+```
+## API
+Please see the minitest [expectation](http://docs.seattlerb.org/minitest/Minitest/Expectations.html)
+and [assertion](http://docs.seattlerb.org/minitest/Minitest/Assertions.html) docs for more details
+on implementations for the `must` and `wont` methods transposed to `to` and `to_not` methods transposed
+here.
+### `#*be`
+```ruby
+expect(1).to_be :<, 2
+expect(1).to_not_be :>, 2
+```
+### `#*be_close_to/#*be_within_delta`
+```ruby
+expect(Math::PI).to_be_close_to 22.0/7.0, 0.01
+expect(Math::PI).to_be_within_delta 22.0/7.0, 0.01
+expect(Math::PI).to_not_be_close_to 22.0/6.0, 0.01
+expect(Math::PI).to_not_be_within_delta 22.0/6.0, 0.01
+```
+### `#*be_empty`
+```ruby
+expect([]).to_be_empty
+expect({awwyeah: :minitest}).to_not_be_empty
+```
+### `#*be_instance_of`
+```ruby
+expect([]).to_be_instance_of Array
+expect([]).to_not_be_instance_of Hash
+```
+### `#*be_kind_of`
+```ruby
+expect([]).to_be_kind_of Enumerable
+expect([]).to_not_be_kind_of NilClass
+```
+### `#*be_nil`
+```ruby
+expect(nil).to_be_nil
+expect(:something).to_not_be_nil
+```
+### `#*be_same_as`
+```ruby
+expect(obj = Object.new).to_be_same_as obj
+an_object = Object.new
+expect(Object.new).to_not_be_same_as an_object
+```
+### `#to_be_silent`
+(`#must_be_silent` availble with Minitest 5.0)
+```ruby
+expect(->{''}).to_be_silent
+```
+### `#*be_within_epsilon`
+```ruby
+expect(4).to_be_within_epsilon 3.5, 0.15
+expect(4).to_not_be_within_epsilon 3.5, 0.11
+```
+### `#*equal`
+```ruby
+expect('4d3d3d3d').to_equal '4d3d3d3d'
+expect('4d3d3d3d').to_not_equal 'tayne'
+```
+### `#*include`
+```ruby
+expect(['tim', 'eric']).to_include 'eric'
+expect(['tim', 'eric']).to_not_include 'brule'
+```
+### `#*match`
+```ruby
+expect(/(fart)*/).to_match 'fartfartfartfart'
+expect(/fart/).to_not_match 'barf'
+```
+### `#to_output`
+(`#must_output` availble with Minitest 5.0)
+```ruby
+expect(->{ puts 'barf' }).to_output "barf\n"
+```
+### `#to_raise`
+```ruby
+expect(->{ raise RuntimeError }).to_raise RuntimeError
+```
+### `#*respond_to`
+```ruby
+expect(Object.new).to_respond_to :must_respond_to
+expect(Object.new).to_not_respond_to :fart_factory
+```
+### `#*throw`
+```ruby
+expect(->{ throw StandardError }).to_throw StandardError
+```
+## Contribute
+1. Fork the repo.
+2. Create a branch.
+3. Make sure specs are green (`$ rake test`)
+3. Open a pull request.
+
+##### A note on the current specs
+The specs at `spec/integration_spec.rb` test a couple of minitest expectations that aren't included
+in previous minitest versions to 5.0. To install the newest minitest, do `$ sudo gem install
+minitest`. Because of the way Ruby installs and loads its native libraries, `sudo` before
+`gem install` is necessary, unfortunately.
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2013 Dave Jachimiak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+desc 'run the tests'
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/integration_spec.rb'
+end

data/lib/minitest/spec/expect.rb

@@ -0,0 +1,23 @@
+module Kernel
+  def expect object
+    Minitest::Spec::Expect.new object
+  end
+end
+
+module Minitest
+  class Spec
+    class Expect
+      require 'minitest/spec/expect_syntax'
+
+      OBJECT = 'object'
+
+      attr_reader OBJECT.to_sym
+
+      def initialize object
+        @object = object
+      end
+
+      Minitest::Spec::ExpectSyntax.new(self).set_expectations
+    end
+  end
+end

data/lib/minitest/spec/expect/version.rb

@@ -0,0 +1,7 @@
+module Minitest
+  class Spec
+    class Expect
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/minitest/spec/expect_syntax.rb

@@ -0,0 +1,57 @@
+require 'minitest/spec'
+
+module Minitest
+  class Spec
+    class ExpectSyntax
+      TRANSPOSITIONS = {'must' => 'to', 'wont' => 'to_not'}
+      INTERESTING_AUXILIARY_VERB_REGEXES = [/must/, /wont/]
+
+      attr_reader :expect_class
+
+      def initialize expect_class
+        @expect_class = expect_class
+      end
+
+      def set_expectations
+        spec_expectation_names.each do |spec_expectation_name|
+          set_expectation spec_expectation_name
+        end
+      end
+
+      private
+
+      def spec_expectation_names
+        Object.instance_methods.select { |method_name| expectation? method_name }
+      end
+
+      def expectation? method_name
+        !!INTERESTING_AUXILIARY_VERB_REGEXES.detect do |regex|
+          method_name.to_s.match regex
+        end
+      end
+
+      def set_expectation expectation_name
+        expect_class.class_eval <<-EOM
+          #{expect_method expectation_name }
+        EOM
+      end
+
+      def expect_method expectation_name
+        """
+          def #{expect_method_name expectation_name } *args
+            #{expect_class::OBJECT}.#{expectation_name} *args
+          end
+        """
+      end
+
+      def expect_method_name expectation_name
+        TRANSPOSITIONS.inject('') do |memo, transposition|
+          string = memo.empty? ? expectation_name.to_s : memo
+
+          string.gsub transposition.first, transposition.last
+        end
+      end
+    end
+  end
+end
+

data/minitest-spec-expect.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'minitest/spec/expect/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'minitest-spec-expect'
+  s.description   = 'Expect syntax for minitest specs.'
+  s.summary       = 'Use the expect syntax with transposed minitest expectations.'
+  s.authors       = ['Dave Jachimiak']
+  s.email         = 'dave.jachimiak@gmail.com'
+  s.homepage      = 'http://github.com/davejachimiak/minitest-expect'
+  s.version       = Minitest::Spec::Expect::VERSION
+  s.files         = `git ls-files`.split("\n").reject do |file_name|
+    /\.gem$/.match file_name
+  end
+  s.test_files    = `git ls-files -- spec`.split("\n")
+  s.require_paths = ['lib']
+end

data/spec/integration_spec.rb

@@ -0,0 +1,122 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'minitest/spec/expect'
+require 'minitest/autorun'
+
+describe 'expect syntax' do
+  it 'supports must_be as to_be' do
+    expect(1).to_be :<, 2
+  end
+
+  it 'supports wont_be as to_not_be' do
+    expect(1).to_not_be :>, 2
+  end
+
+  it 'supports must_be_close_to as to_be_close_to (within_delta)' do
+    expect(Math::PI).to_be_close_to 22.0/7.0, 0.01
+    expect(Math::PI).to_be_within_delta 22.0/7.0, 0.01
+  end
+
+  it 'supports wont_be_close_to as to_not_be_close_to (within_delta)' do
+    expect(Math::PI).to_not_be_close_to 22.0/6.0, 0.01
+    expect(Math::PI).to_not_be_within_delta 22.0/6.0, 0.01
+  end
+
+  it 'supports must_be_empty as to_be_empty' do
+    expect([]).to_be_empty
+  end
+
+  it 'supports wont_be_empty as to_not_be_empty' do
+    expect({awwyeah: :minitest}).to_not_be_empty
+  end
+
+  it 'supports must_be_instance_of as to_be_instance_of' do
+    expect([]).to_be_instance_of Array
+  end
+
+  it 'supports wont_be_instance_of as to_not_be_instance_of' do
+    expect([]).to_not_be_instance_of Hash
+  end
+
+  it 'supports must_be_kind_of as to_be_kind_of' do
+    expect([]).to_be_kind_of Enumerable
+  end
+
+  it 'supports wont_be_kind_of as to_not_be_kind_of' do
+    expect([]).to_not_be_kind_of NilClass
+  end
+
+  it 'supports must_be_nil as to_be_nil' do
+    expect(nil).to_be_nil
+  end
+
+  it 'supports wont_be_nil as to_not_be_nil' do
+    expect(:something).to_not_be_nil
+  end
+
+  it 'supports must_be_same_as as to_be_same_as' do
+    expect(obj = Object.new).to_be_same_as obj
+  end
+
+  it 'supports wont_be_same_as as to_not_be_same_as' do
+    object_one = Object.new
+
+    expect(Object.new).to_not_be_same_as object_one
+  end
+
+  it 'supports must_be_silent as to_be_silent' do
+    expect(->{''}).to_be_silent
+  end
+
+  it 'supports must_be_within_epsilon as to_be_within_epsilon' do
+    expect(4).to_be_within_epsilon 3.5, 0.15
+  end
+
+  it 'supports wont_be_within_epsilon as to_not_be_within_epsilon' do
+    expect(4).to_not_be_within_epsilon 3.5, 0.11
+  end
+
+  it 'supports must_equal as to_equal' do
+    expect('4d3d3d3d').to_equal '4d3d3d3d'
+  end
+
+  it 'supports wont_equal as to_not_equal' do
+    expect('4d3d3d3d').to_not_equal 'tayne'
+  end
+
+  it 'supports must_include as to_include' do
+    expect(['tim', 'eric']).to_include 'eric'
+  end
+
+  it 'supports wont_include as to_not_include' do
+    expect(['tim', 'eric']).to_not_include 'brule'
+  end
+
+  it 'supports must_match as to_match' do
+    expect(/(fart)*/).to_match 'fartfartfartfart'
+  end
+
+  it 'supports wont_match as to_not_match' do
+    expect(/fart/).to_not_match 'barf'
+  end
+
+  it 'supports must_output as to_output' do
+    expect(->{ puts 'barf' }).to_output "barf\n"
+  end
+
+  it 'supports must_raise as to_raise' do
+    expect(->{ raise RuntimeError }).to_raise RuntimeError
+  end
+
+  it 'supports must_respond_to as to_respond_to' do
+    expect(Object.new).to_respond_to :must_respond_to
+  end
+
+  it 'supports wont_respond_to as to_not_respond_to' do
+    expect(Object.new).to_not_respond_to :fart_factory
+  end
+
+  it 'supports must_throw as to_throw' do
+    expect(->{ throw StandardError }).to_throw StandardError
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: minitest-spec-expect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dave Jachimiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-16 00:00:00.000000000 Z
+dependencies: []
+description: Expect syntax for minitest specs.
+email: dave.jachimiak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- lib/minitest/spec/expect.rb
+- lib/minitest/spec/expect/version.rb
+- lib/minitest/spec/expect_syntax.rb
+- minitest-spec-expect.gemspec
+- spec/integration_spec.rb
+homepage: http://github.com/davejachimiak/minitest-expect
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Use the expect syntax with transposed minitest expectations.
+test_files:
+- spec/integration_spec.rb