truenames 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jason Morrison
+
+MIT License
+
+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/README.md

@@ -0,0 +1,49 @@
+# Truenames
+
+Improve test failure output by introspecting variable names.
+
+Sometimes this is hard to read:
+
+```
+  1) User when looked up with a GitHub OAuth callback hash updates with the most recent information
+     Failure/Error: expect(lookup_user).to eq(existing_user)
+
+       expected: #<User id: 684, uid: 74387, oauth_token: "oldtoken", nickname: "oldnick", email: "old@email.com", name: "Old Name", created_at: "2012-10-13 06:26:11", updated_at: "2012-10-13 06:26:11">
+            got: #<User id: 685, uid: 12345, oauth_token: "token-abc123", nickname: "jasonm", email: "jason@example.com", name: "Jason Morrison", created_at: "2012-10-13 06:26:11", updated_at: "2012-10-13 06:26:11">
+```
+
+and something like this might be easier:
+
+```
+  1) User when looked up with a GitHub OAuth callback hash updates with the most recent information
+     Failure/Error: expect(lookup_user).to eq(existing_user)
+
+       expected: lookup_user
+            got: unrelated_user
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'truenames'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install truenames
+
+## Usage
+
+For RSpec usage, add `require 'truenames/rspec'` to `spec/spec_helper.rb`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/truenames.rb

@@ -0,0 +1,6 @@
+require 'truenames/version'
+require 'rspec-expectations'
+require "truenames/matchers/expr_eq"
+
+module Truenames
+end

data/lib/truenames/matchers/expr_eq.rb

@@ -0,0 +1,71 @@
+require 'rspec/matchers/built_in/eq'
+require 'binding_of_caller'
+
+module Truenames
+  module Matchers
+    def expr_eq(other)
+      Truenames::Matchers::ExprEq.new(other)
+    end
+
+    class ExprEq < RSpec::Matchers::BuiltIn::Eq
+      def initialize(expected = nil)
+        @expected = expected
+
+        # One to escape this binding, one to escape the Truenames::Matchers#expr_eq wrapper method
+        @binding = binding.of_caller(2)
+      end
+
+      def name
+        "eq"
+      end
+
+      def failure_message_for_should
+        "\nexpected: #{expected.inspect}#{inspect_references_for(expected)}\n" +
+          "     got: #{actual.inspect}#{inspect_references_for(actual)}\n\n(compared using ==)\n"
+      end
+
+      private
+
+      def inspect_references_for(value)
+        references = reference_names_for(value)
+
+        if references.empty?
+          ''
+        else
+          " (#{references})"
+        end
+      end
+
+      def reference_names_for(value)
+        if value.is_a?(Array)
+          "[" + value.map { |each_value| [reference_names_for(each_value)].flatten.first }.join(', ') + "]"
+        else
+          (matching_locals(value) + matching_ivars(value)).join(' or ')
+        end
+      end
+
+      def matching_locals(value)
+        binding_locals.select { |local| useful_match?(@binding.eval(local.to_s), value) }
+      end
+
+      def matching_ivars(value)
+        binding_ivars.select { |ivar| useful_match?(@binding.eval(ivar.to_s), value) }
+      end
+
+      def useful_match?(candidate, value)
+        # exclude the matcher itself
+        return false if candidate.is_a?(RSpec::Matchers::BuiltIn::Eq)
+
+        candidate == value
+      end
+
+      def binding_locals
+        @binding.eval("local_variables")
+      end
+
+      def binding_ivars
+        @binding.eval("instance_variables")
+      end
+    end
+  end
+end

data/lib/truenames/rspec.rb

@@ -0,0 +1,3 @@
+module RSpec::Matchers
+  include Truenames::Matchers
+end

data/lib/truenames/version.rb

@@ -0,0 +1,3 @@
+module Truenames
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'truenames'
+require 'truenames/rspec'

data/spec/truenames/matchers/expr_eq_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Truenames::Matchers::ExprEq do
+  it "matches when actual == expected" do
+    1.should expr_eq(1)
+  end
+
+  it "does not match when actual != expected" do
+    1.should_not expr_eq(2)
+  end
+
+  it "compares by sending == to actual (not expected)" do
+    called = false
+    actual = Class.new do
+      define_method :== do |other|
+        called = true
+      end
+    end.new
+
+    actual.should expr_eq :anything # to trigger the matches? method
+    called.should be_true
+  end
+
+  it "describes itself" do
+    matcher = expr_eq(1)
+    matcher.matches?(1)
+    matcher.description.should eq "eq 1"
+  end
+
+  it "provides message, expected and actual on #failure_message" do
+    matcher = expr_eq("1")
+    matcher.matches?(1)
+    matcher.failure_message_for_should.should eq "\nexpected: \"1\"\n     got: 1\n\n(compared using ==)\n"
+  end
+
+  it "provides message, expected and actual on #negative_failure_message" do
+    matcher = expr_eq(1)
+    matcher.matches?(1)
+    matcher.failure_message_for_should_not.should eq "\nexpected: value != 1\n     got: 1\n\n(compared using ==)\n"
+  end
+
+  it "provides local variable reference when available" do
+    abc = 123
+    bcd = 234
+
+    matcher = expr_eq(abc)
+    matcher.matches?(bcd)
+    matcher.failure_message_for_should.should eq "\nexpected: 123 (abc)\n     got: 234 (bcd)\n\n(compared using ==)\n"
+  end
+
+  it "provides multiple local variable references when they exist" do
+    zab = 123
+    abc = 123
+    bcd = 234
+    cde = 234
+
+    matcher = expr_eq(abc)
+    matcher.matches?(bcd)
+    matcher.failure_message_for_should.should eq "\nexpected: 123 (zab or abc)\n     got: 234 (bcd or cde)\n\n(compared using ==)\n"
+  end
+
+  it "provides instance variable reference when available" do
+    @abc = 123
+    @bcd = 234
+
+    matcher = expr_eq(@abc)
+    matcher.matches?(@bcd)
+    matcher.failure_message_for_should.should eq "\nexpected: 123 (@abc)\n     got: 234 (@bcd)\n\n(compared using ==)\n"
+  end
+
+  it "provides local variable references inside arrays" do
+    a = 1
+    b = 2
+    c = 3
+    d = 4
+    e = 5
+
+    matcher = expr_eq([a,b,c])
+    matcher.matches?([c,d,e])
+    matcher.failure_message_for_should.should eq "\nexpected: [1, 2, 3] ([a, b, c])\n     got: [3, 4, 5] ([c, d, e])\n\n(compared using ==)\n"
+  end
+
+  it "displays ambiguous matches inside arrays " do
+    z = 1
+    a = 1
+    b = 2
+    c = 3
+    d = 4
+    e = 5
+    f = 5
+
+    matcher = expr_eq([a,b,c])
+    matcher.matches?([c,d,e])
+    matcher.failure_message_for_should.should eq "\nexpected: [1, 2, 3] ([z or a, b, c])\n     got: [3, 4, 5] ([c, d, e or f])\n\n(compared using ==)\n"
+  end
+end

data/truenames.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'truenames/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "truenames"
+  gem.version       = Truenames::VERSION
+  gem.authors       = ["Jason Morrison"]
+  gem.email         = ["jason.p.morrison@gmail.com"]
+  gem.description   = %q{Improve test failure output by introspecting variable names.}
+  gem.summary       = %q{Use local variables and expressions to give more information about assertion failures.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'binding_of_caller'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: truenames
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: binding_of_caller
+  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'
+description: Improve test failure output by introspecting variable names.
+email:
+- jason.p.morrison@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/truenames.rb
+- lib/truenames/matchers/expr_eq.rb
+- lib/truenames/rspec.rb
+- lib/truenames/version.rb
+- spec/spec_helper.rb
+- spec/truenames/matchers/expr_eq_spec.rb
+- truenames.gemspec
+homepage: ''
+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.24
+signing_key: 
+specification_version: 3
+summary: Use local variables and expressions to give more information about assertion
+  failures.
+test_files:
+- spec/spec_helper.rb
+- spec/truenames/matchers/expr_eq_spec.rb
+has_rdoc: