grape-entity-matchers 0.0.1

data/.gitignore

@@ -0,0 +1,38 @@
+## MAC OS
+.DS_Store
+.com.apple.timemachine.supported
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## REDCAR
+.redcar
+
+## VIM
+*.swp
+*.swo
+
+## RUBYMINE
+.idea
+
+## PROJECT::GENERAL
+coverage
+doc
+pkg
+.rvmrc
+.bundle
+.yardoc/*
+dist
+Gemfile.lock
+tmp
+
+## Rubinius
+.rbx
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
+  - ree
+

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/CHANGELOG.markdown

@@ -0,0 +1,8 @@
+Next Release
+============
+* Your contribution here.
+
+0.1.0 (01/11/2013)
+==================
+
+* Initial Release

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+  gem 'json'
+  gem 'rspec'
+  gem 'rack-test', "~> 0.6.2", :require => "rack/test"
+  gem 'github-markup'
+end

data/Guardfile

@@ -0,0 +1,15 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/shared_versioning_examples.rb$}) { |m| "spec/" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Mark Madsen, and AGiLE ANiMAL INC.
+
+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.markdown

@@ -0,0 +1,56 @@
+# Grape::Entity::Matchers
+
+[![Build Status](https://travis-ci.org/agileanimal/grape-entity-matchers.png?branch=master)](https://travis-ci.org/agileanimal/grape-entity-matchers)
+
+## Introduction
+
+This gem provides shoulda-style matchers for Rspec to [GrapeEntity](https://github.com/agileanimal/grape-entity).
+
+## Using the Matchers
+
+Here are some examples of the matchers in use:
+
+``` ruby
+it { should represent(:date_of_birth).as(:brithday) }
+it { should_not represent(:name).as(:brithday) }
+it { should_not represent(:date_of_birth) }
+    
+it { should represent(:secret).when( :authorized? => true ) }
+it { should_not represent(:secret).when( :authorized? => false ) }
+    
+it { should represent(:super_dooper_secret).as(:top_secret).when( :authorized? => true ) }
+it { should_not represent(:super_dooper_secret).as(:top_secret).when( :authorized? => false ) }
+
+it { should represent(:dog).using(PetEntity) }
+it { should represent(:cat).as(:kitty).using(PetEntity) }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape-entity-matchers', :group => :test
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-entity-matchers
+
+## 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
+
+## License
+
+MIT License. See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2013 Mark Madsen, and AGiLE ANiMAL INC.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec
+task :default => :spec
+
+#
+# TODO: setup a place for documentation and then get this going again.
+#
+# begin
+#   require 'yard'
+#   DOC_FILES = ['lib/**/*.rb', 'README.markdown']
+#   
+#   YARD::Rake::YardocTask.new(:doc) do |t|
+#     t.files   = DOC_FILES
+#   end
+#   
+#   namespace :doc do
+#     YARD::Rake::YardocTask.new(:pages) do |t|
+#       t.files   = DOC_FILES
+#       t.options = ['-o', '../grape.doc']
+#     end
+#     
+#     namespace :pages do
+#       desc 'Generate and publish YARD docs to GitHub pages.'
+#       task :publish => ['doc:pages'] do
+#         Dir.chdir(File.dirname(__FILE__) + '/../grape.doc') do
+#           system("git add .")
+#           system("git add -u")
+#           system("git commit -m 'Generating docs for version #{version}.'")
+#           system("git push origin gh-pages")
+#         end
+#       end
+#     end
+#   end
+# rescue LoadError
+#   puts "You need to install YARD."
+# end

data/grape-entity-matchers.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "grape_entity_matchers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "grape-entity-matchers"
+  s.version     = GrapeEntityMatchers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mark Madsen"]
+  s.email       = ["mark@agileanimal.com"]
+  s.homepage    = "https://github.com/agileanimal/grape-entity-matchers"
+  s.summary     = %q{Shoulda-like matchers for Grape Entity.}
+  s.description = %q{Shoulda-like matchers for Grape Entity.}
+  s.license     = "MIT"
+
+  s.rubyforge_project = "grape-entity-matchers"
+
+  s.add_runtime_dependency 'grape-entity', '>= 0.2.0'
+  s.add_runtime_dependency 'rspec', '~> 2.9'
+
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'maruku'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bundler'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/grape-entity-matchers.rb

@@ -0,0 +1 @@
+require 'grape_entity_matchers'

data/lib/grape_entity_matchers.rb

@@ -0,0 +1,3 @@
+require 'grape_entity_matchers/version'
+require 'grape_entity_matchers/represent_matcher'
+require 'grape_entity_matchers/rspec_integration'

data/lib/grape_entity_matchers/represent_matcher.rb

@@ -0,0 +1,102 @@
+require 'rspec/mocks'
+
+module GrapeEntityMatchers
+  module RepresentMatcher
+    def represent(representable)
+      RepresentMatcher.new(representable)
+    end
+      
+    class RepresentMatcher
+      def initialize(representable)
+        @expected_representable = representable
+        RSpec::Mocks::setup(self)
+      end
+
+      def matches?(subject)
+        @subject = subject
+
+        check_methods && verify_exposure && check_value
+      end
+      
+      def as(representation)
+        @actual_representation = representation
+        self
+      end
+      
+      def when(conditions)
+        @conditions = conditions
+        self
+      end
+      
+      def using(other_entity)
+        @other_entity = other_entity
+        self
+      end
+
+      def failure_message
+        # why did it fail???
+        # 3 options, exposure, object not called, value not returned.
+        # TODO: fix this
+        #"Expected #{@expected_representable} to be called on mock, but it wasn't: #{@subject.exposures[@expected_representable]}"
+        message = ""
+        message << "#{@subject} didn't expose #{@expected_representable} as expected: #{@subject.exposures[@expected_representable]}" unless verify_exposure
+        message << "#{@subject} didn't call the method #{@actual_representation || @expected_representable} to get #{@expected_representable} from the test class.\n" unless check_methods
+        message << "#{@subject} return the correct value for #{@expected_representable}." unless check_value
+      end
+
+      def negative_failure_message
+        message = ""
+        message << "Didn't expect #{@subject} to expose #{@expected_representable} correctly: #{@subject.exposures[@expected_representable]}" if verify_exposure
+        message << "Didn't expect #{@subject} to call #{@actual_representation || @expected_representable} to get #{@expected_representable} from the test class.\n" if check_methods
+        message << "Didn't expect #{@subject} to return the correct value for #{@expected_representable}." if check_value
+      end
+
+      def description
+        "Ensures that #{@subject} properly obtains the value of #{@expected_representable} from a mock class."
+      end
+      
+      private
+      
+      def check_methods
+        representee = mock("RepresetedObject")
+        representee.should_receive(@expected_representable).and_return(:value)       
+        representee.should_receive(@conditions.keys.first).and_return(@conditions.values.first) unless @conditions.nil?
+        
+        @serialized_hash = @subject.represent(representee).serializable_hash
+          
+        begin
+          RSpec::Mocks::verify  # run mock verifications
+          methods_called = true
+        rescue RSpec::Mocks::MockExpectationError => e
+          # here one can use #{e} to construct an error message
+          methods_called = false
+        end
+        
+        methods_called
+      end
+      
+      def verify_exposure
+        hash = {}
+        hash[:using] = @other_entity unless @other_entity.nil?
+        hash[:as] = @actual_representation unless @actual_representation.nil?
+
+        if @conditions.nil?
+          @subject.exposures[@expected_representable] == hash
+        else
+          exposures = @subject.exposures[@expected_representable].dup
+          exposures.delete(:if) != nil && exposures == hash
+        end
+      end
+      
+      def check_value
+        if @other_entity
+          # we aren't setting a value here, so it's going to be empty
+          @serialized_hash[@actual_representation || @expected_representable] == {}
+        else
+          @serialized_hash[@actual_representation || @expected_representable] == :value
+        end
+      end
+      
+    end
+  end
+end

data/lib/grape_entity_matchers/rspec_integration.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  require 'grape_entity_matchers/represent_matcher'
+  config.include GrapeEntityMatchers::RepresentMatcher
+end

data/lib/grape_entity_matchers/version.rb

@@ -0,0 +1,3 @@
+module GrapeEntityMatchers
+  VERSION = '0.0.1'
+end

data/spec/grape_entity_matchers/represent_matcher_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'grape_entity'
+
+describe GrapeEntityMatchers do
+  before(:all) do
+    class PetEntity < Grape::Entity
+      expose :name, :age
+    end
+    class Person
+      include Grape::Entity::DSL
+      entity :name, :age do
+        expose :date_of_birth, :as => :brithday
+        expose :cat, :as => :cat, :using => PetEntity
+        expose :dog, :using => PetEntity
+        expose :secret, :if => lambda{ |person, options| person.authorized? }
+        expose :super_dooper_secret, :as => :top_secret, :if => lambda{ |person, options| person.authorized? }
+      end
+    end
+  end
+
+  context 'matchers' do
+    subject(:entity){ Person::Entity }
+
+    # TODO: move the tests to this format to shadow the thoughtbot tests.
+    # it { should represent(:name) }
+    it "should ensure the representation includes the specified property" do
+      entity.should represent :name
+    end
+    
+    
+    
+    it { should represent(:date_of_birth).as(:brithday) }
+    
+    it { should_not represent(:t_shirt_size) }
+    it { should_not represent(:t_shirt_size).as(:brithday) }
+    it { should_not represent(:name).as(:brithday) }
+    it { should_not represent(:date_of_birth) }
+    
+    it { should represent(:secret).when( :authorized? => true ) }
+    it { should_not represent(:secret).when( :authorized? => false ) }
+    
+    it { should represent(:super_dooper_secret).as(:top_secret).when( :authorized? => true ) }
+    it { should_not represent(:super_dooper_secret).as(:top_secret).when( :authorized? => false ) }
+    it { should_not represent(:super_dooper_secret).when( :authorized? => true ) }
+    
+    it { should represent(:dog).using(PetEntity) }
+    it { should represent(:cat).as(:cat).using(PetEntity) }
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'support'))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :test
+
+require 'pry'

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: grape-entity-matchers
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: grape-entity
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: maruku
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: yard
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shoulda-like matchers for Grape Entity.
+email:
+- mark@agileanimal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- CHANGELOG.markdown
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- grape-entity-matchers.gemspec
+- lib/grape-entity-matchers.rb
+- lib/grape_entity_matchers.rb
+- lib/grape_entity_matchers/represent_matcher.rb
+- lib/grape_entity_matchers/rspec_integration.rb
+- lib/grape_entity_matchers/version.rb
+- spec/grape_entity_matchers/represent_matcher_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/agileanimal/grape-entity-matchers
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3869361771623991090
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3869361771623991090
+      version: '0'
+requirements: []
+rubyforge_project: grape-entity-matchers
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Shoulda-like matchers for Grape Entity.
+test_files:
+- spec/grape_entity_matchers/represent_matcher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: