no_moss 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 2a94157ef3e84ee08073dc7a69e717ded2cf561a95250560e5eaa2af93a0c31853e734bd5f3260f9c3ff2d848c62ee41da503985f9af01b4cb7e1c04746bbd4f
+  data.tar.gz: 8b6d9415f9819134c6ed5843a24c5f20d42df4dfff2ff8fa25e1395c1b496c5e4bbd2d15d57c4d24d4d6cc65fb9dd8686e51cb29b18344839c0da7d1a06de67d
+SHA1: 
+  metadata.gz: 5531f31dbcf225ffb0004e7ab8187f72b6ae4ab4
+  data.tar.gz: 36e6b2c48291330c1ad32cbba3b3a38ecffd3b3f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.8.7

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 livingsocial
+
+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,87 @@
+# no\_moss
+
+Provides a means of defining object role APIs that should be consistent
+between test subjects (objects under test) and test doubles (AKA mock
+objects).
+
+A role provides data that can be used to verify that a test subject
+implements the role API. A role also provides a wrapper around a
+test double that prevents unsupported interactions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "no_moss"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install no_moss
+
+## Usage
+
+### Basic
+
+Define a Role API using the NoMoss.define\_role method as follows:
+
+    PersonRole = NoMoss.define_role do
+      implements :id, :name, :email
+    end
+
+Identify any of a role API's methods not implemented by an object
+(usually for unit testing purposes) using the role's
+unimplemented\_methods\_of method as follows:
+
+    PersonRole.unimplemented_methods_of(object)
+
+Define a Role-restricted proxy to a test subject (object under
+test) or a test double (AKA mock object) as follows:
+
+    PersonRole.restrict(test_double)
+
+### Rspec
+
+Enable no\_moss rspec matchers by adding the following to your
+spec\_helper file:
+
+    require 'no_moss/rspec/matchers'
+
+... or for no\_moss rspec matchers and shared examples, ...
+
+    require 'no_moss/rspec/all'
+
+To verify that an object under test implements a role API...
+
+    it "acts like a person" do
+      expect( someobject ).to play_role( RoleAPIs::Person )
+    end
+
+To use a shared example to verify that the current subject implements
+a role API...
+
+    subject{ Fruit }
+    include_examples "plays the role of", RoleAPIs::FruitRepository
+
+To enforce the role API for an object under test...
+
+    subject{ FruitRepository.restrict(Fruit) }
+
+To enforce the role API for a test double (AKA mock object) being used
+as a dependency...
+
+    let(:fruit_repository){ double(:fruit_repository) }
+    subject{ Farm.new(
+      :fruit_repository => RoleAPIs::FruitRepository.restrict(fruit_repository)
+    ) }
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/no_moss/role_api.rb

@@ -0,0 +1,52 @@
+require 'forwardable'
+
+module NoMoss
+  class RoleApi < Module
+    def api_methods
+      _api_methods.dup
+    end
+
+    def methods_missing_from(object)
+      _api_methods - object.methods.map(&:to_sym)
+    end
+
+    def restrict(object)
+      proxy_class.new(object)
+    end
+
+    private
+
+    def implements(*args)
+      _api_methods.concat args
+    end
+
+    def _api_methods
+      @api_methods ||= []
+    end
+
+    class AbstractProxy
+      extend Forwardable
+
+      def initialize(object)
+        @object = object
+      end
+
+      def method_missing(name, *args, &b)
+        super
+      rescue NoMethodError
+        raise \
+          NoMoss::NoRoleApiMethodError, \
+          "#{name} method not included in the API of this role."
+      end
+    end
+
+    def proxy_class
+      @proxy_class ||= begin
+        klass = Class.new(AbstractProxy)
+        klass.def_delegators :@object, *api_methods
+        const_set :Proxy, klass
+        klass
+      end
+    end
+  end
+end

data/lib/no_moss/rspec/all.rb

@@ -0,0 +1,2 @@
+require 'no_moss/rspec/matchers'
+require 'no_moss/rspec/shared_examples'

data/lib/no_moss/rspec/matchers.rb

@@ -0,0 +1,14 @@
+RSpec::Matchers.define :play_role do |role|
+  match do |actual|
+    @methods_missing = role.methods_missing_from(actual)
+    @methods_missing == []
+  end
+
+  failure_message_for_should do |actual|
+    <<-EOF
+expected #{actual.inspect}
+to play the role of #{role},
+but it is missing the following method(s): #{@methods_missing.join(', ')}
+    EOF
+  end
+end

data/lib/no_moss/rspec/shared_examples.rb

@@ -0,0 +1,5 @@
+shared_examples "plays the role of" do |role|
+  it "plays the role of #{role}" do
+    expect(subject).to play_role(role)
+  end
+end

data/lib/no_moss/version.rb

@@ -0,0 +1,3 @@
+module NoMoss
+  VERSION = "0.6.0"
+end

data/lib/no_moss.rb

@@ -0,0 +1,12 @@
+require "no_moss/version"
+require "no_moss/role_api"
+
+module NoMoss
+  class NoRoleApiMethodError < NoMethodError ; end
+
+  def self.define_role(&b)
+    role = RoleApi.new
+    role.module_eval(&b)
+    role
+  end
+end

data/no_moss.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'no_moss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "no_moss"
+  spec.version       = NoMoss::VERSION
+  spec.authors       = ["Steve Jorgensen"]
+  spec.email         = ["steve.jorgensen@livingsocial.com"]
+  spec.description   = "Keep test subjects and doubles in sync to avoid false positives"
+  spec.summary       = <<-EOS
+Provides a means of defining object role APIs that should be consistent
+between test subjects (objects under test) and test doubles (AKA mock
+objects).
+A role provides data that can be used to verify that a test subject
+implements the role API. A role also provides a wrapper around a
+test double that prevents unsupported interactions.
+  EOS
+  spec.homepage      = "http://code.livingsocial.net/sjorgensen"
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/no_moss/role_api_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe NoMoss::RoleApi do
+  let(:missile_role) {
+    described_class.new.tap{ |r|
+      r.module_eval do ; implements :target, :launch, :explode ; end
+    }
+  }
+
+  describe '.api_methods' do
+    it "returns an array of the API methods of the role" do
+      expect( missile_role.api_methods.sort_by(&:to_s) ).to eq([:explode, :launch, :target])
+    end
+  end
+
+  describe '.methods_missing_from' do
+    let(:object_class) { Class.new.tap { |c|
+      object_methods.each do |m| ; c.send(:define_method, m) { } ; end
+    } }
+    let(:object) { object_class.new }
+
+    describe "given an object that implements all the API methods" do
+      let(:object_methods) { [:arm, :target, :launch, :explode] }
+
+      it "returns an empty array" do
+        expect( missile_role.methods_missing_from(object) ).to eq([])
+      end
+    end
+
+    describe "given an object that doesn't implement all the API methods" do
+      let(:object_methods) { [:arm, :launch] }
+
+      it "returns an array of unimplemented method names" do
+        expect( missile_role.methods_missing_from(object) ).to eq([:target, :explode])
+      end
+    end
+  end
+
+  describe ".restrict" do
+    describe "returned object" do
+      subject { missile_role.restrict(underlying_obj) }
+      let(:underlying_obj) { double(:underlying_obj) }
+
+      it "delegates API method calls to the underlying object, including blocks" do
+        expect(underlying_obj).to receive(:target).with(:earth).and_yield :something
+        yielded = nil
+        subject.target :earth do |v| ; yielded = v ; end
+        expect( yielded ).to eq(:something)
+      end
+
+      it "does not delegate non-API calls" do
+        allow(underlying_obj).to receive(:foo)
+        expect( lambda{ subject.foo } ).to raise_exception(NoMoss::NoRoleApiMethodError)
+      end
+    end
+  end
+end

data/spec/no_moss/rspec_helpers_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+require 'no_moss/rspec/all'
+
+module Agriculture
+  module Roles
+    Cattle = NoMoss.define_role do
+      implements :moo, :low
+      implements :grunt
+    end
+  end
+  
+  module Animals
+    class Yak
+      def moo   ; "Mooooooooo" ; end
+      def low   ; "Mooooooooo" ; end
+      def grunt ; "hmph"       ; end
+    end
+
+    class Cat
+      def meow ; "Meow"      ; end
+      def purr ; "Purrrrr"   ; end
+      def claw ; "*scratch*" ; end
+      def destroy_furniture
+        meow; purr; claw
+      end
+    end
+  end
+end
+
+
+describe 'RSpec helpers' do
+  let(:yak)    { Agriculture::Animals::Yak.new }
+  let(:cat)    { Agriculture::Animals::Cat.new }
+
+  describe "custom matcher" do
+    it 'should know when an object plays a role' do
+      expect(yak).to play_role(Agriculture::Roles::Cattle)
+    end
+
+    it 'should know when an object does not play a role' do
+      expect(cat).to_not play_role(Agriculture::Roles::Cattle)
+    end
+  end
+
+  describe "shared examples" do
+    describe Agriculture::Animals::Yak do
+      include_examples "plays the role of", Agriculture::Roles::Cattle
+    end
+  end
+end

data/spec/no_moss_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe NoMoss do
+  it 'should have a version number' do
+    NoMoss::VERSION.should_not be_nil
+  end
+
+  describe '.define_role' do
+    it "defines a role that implements specific methods" do
+      role = NoMoss.define_role do
+        implements :foo, :bar
+        implements :baz
+      end
+
+      expect( role.api_methods.sort_by(&:to_s) ).to eq([:bar, :baz, :foo])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'no_moss'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: no_moss
+version: !ruby/object:Gem::Version 
+  version: 0.6.0
+platform: ruby
+authors: 
+- Steve Jorgensen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: bundler
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rake
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  requirement: *id004
+  prerelease: false
+description: Keep test subjects and doubles in sync to avoid false positives
+email: 
+- steve.jorgensen@livingsocial.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/no_moss.rb
+- lib/no_moss/role_api.rb
+- lib/no_moss/rspec/all.rb
+- lib/no_moss/rspec/matchers.rb
+- lib/no_moss/rspec/shared_examples.rb
+- lib/no_moss/version.rb
+- no_moss.gemspec
+- spec/no_moss/role_api_spec.rb
+- spec/no_moss/rspec_helpers_spec.rb
+- spec/no_moss_spec.rb
+- spec/spec_helper.rb
+homepage: http://code.livingsocial.net/sjorgensen
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.13
+signing_key: 
+specification_version: 4
+summary: Provides a means of defining object role APIs that should be consistent between test subjects (objects under test) and test doubles (AKA mock objects). A role provides data that can be used to verify that a test subject implements the role API. A role also provides a wrapper around a test double that prevents unsupported interactions.
+test_files: 
+- spec/no_moss/role_api_spec.rb
+- spec/no_moss/rspec_helpers_spec.rb
+- spec/no_moss_spec.rb
+- spec/spec_helper.rb