contractinator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6819282048b246f1669f428baf93e442f7f62c0d
+  data.tar.gz: 61035a0c2b2e8c43359e764785fafe35abe5cce2
+SHA512:
+  metadata.gz: f59a4e87e2db2ecc854a53a6bdf302d6eb9b80b077bc185e51c84d327dae47d2a01e89119ccc054968af77633d9ce99ee96a1be9bfb27591bdb70d66e7c5c8c2
+  data.tar.gz: 656e0a85e26ddeed7306e5dc8bf529b4bd2561a884ab063919f8a8ee4ee0fa388678f4a99d73761bb985f5a23e0f698c1af22d8a70427e67405cb6edec6b97a1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rake_tasks~

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pair@pivotal.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 pivotal
+
+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,41 @@
+# Contractinator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/contractinator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contractinator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contractinator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/contractinator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "contractinator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/contractinator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contractinator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contractinator"
+  spec.version       = Contractinator::VERSION
+  spec.authors       = ["pivotal"]
+  spec.email         = ["pair@pivotal.io"]
+
+  spec.summary       = %q{Contractinator is a tool for contract-driven development!}
+  spec.homepage      = "http://github.com/ehrenmurdick/contractinator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/contractinator/contract.rb

@@ -0,0 +1,58 @@
+module Contractinator
+  module Contract
+    extend self
+
+    @created = {}
+    @fulfilled = {}
+
+    def require(argument)
+      @created[argument] = caller.find do |str|
+        str =~ /_spec\.rb/
+      end
+    end
+
+    def fulfill(argument)
+      @fulfilled[argument] = caller.find do |str|
+        str =~ /_spec\.rb/
+      end
+    end
+
+    def created_set
+      Set.new(@created.keys)
+    end
+
+    def fulfilled_set
+      Set.new(@fulfilled.keys)
+    end
+
+    def unmatched_created
+      unmatched_keys.intersection(created_set)
+    end
+
+    def unmatched_fulfilled
+      unmatched_keys.intersection(fulfilled_set)
+    end
+
+    def unmatched_keys
+      created_set ^ fulfilled_set
+    end
+
+    def validate
+      unmatched_keys.empty?
+    end
+
+    def messages
+      messages = []
+      unmatched_created.map do |item|
+        messages << "unfulfilled contract '#{item}'"
+        messages << "   at #{@created[item]}"
+      end
+
+      unmatched_fulfilled.map do |item|
+        messages << "excess fulfillment '#{item}'"
+        messages << "   at #{@fulfilled[item]}"
+      end
+      messages
+    end
+  end
+end

data/lib/contractinator/contract_helpers.rb

@@ -0,0 +1,171 @@
+module Contractinator
+  module ContractHelpers
+    def fmt_dbl(dbl)
+      dbl.contract_inspect
+    end
+
+    def stipulate(dbl)
+      ContractAdapter.new(dbl, self)
+    end
+
+    def inject_contract(controller, name, dbl)
+      dbl_name = fmt_dbl(dbl).to_s.classify
+      Contractinator::Contract.require(
+        "#{controller.controller_name}_controller.#{name} injected #{dbl_name}"
+      )
+      controller.send("#{name}=", dbl)
+    end
+
+    def assign_contract(where, name, object)
+      Contractinator::Contract.require("#{where} assign @#{name}")
+      assign(name, object)
+    end
+
+    def flash_contract(where, key, value)
+      Contractinator::Contract.require("#{where} flash[#{key.inspect}]")
+      flash[key] = value
+    end
+
+    def render_contract(who)
+      Contractinator::Contract.require("#{who} render template")
+      render
+    end
+
+    def agree(obj, method, *args)
+      FulfillmentAdapter.new(self, obj, method, args)
+    end
+
+    def fulfill(*args, &block)
+      Contractinator::Contract.fulfill(*args, &block)
+      RSpec::Matchers.define "fulfill_#{args.first}" do
+        match { true }
+        description do
+          "fulfill #{args.first.inspect}"
+        end
+      end
+      expect(true).to send("fulfill_#{args.first}")
+    end
+    alias_method :fulfills, :fulfill
+
+    def xfulfills(*args, &block)
+      # noop
+    end
+
+    module Shared
+      def contract_message_signature(dbl, msg, args, value)
+        if args.try(:any?)
+          "#{fmt_dbl dbl}.#{msg}(#{fmt_args args}) -> #{fmt_args value}"
+        else
+          "#{fmt_dbl dbl}.#{msg} -> #{fmt_args value}"
+        end
+      end
+
+      def fmt_dbl(*args)
+        @context.fmt_dbl(*args)
+      end
+
+      def fmt_args(args)
+        args.map do |x|
+          fmt_dbl(x)
+        end.join(',  ')
+      end
+
+      def customization(matcher, named)
+        matcher.
+          instance_variable_get('@recorded_customizations').
+          find do |x|
+            x.instance_variable_get('@method_name').to_s == named.to_s
+          end.try(:instance_variable_get, '@args')
+      end
+    end
+
+    class FulfillmentAdapter
+      include Shared
+
+      def initialize(context, object, method, args)
+        @object = object
+        @context = context
+        @method = method
+        @args = args
+      end
+
+      def will(matcher)
+        @context.expect(@object.send(@method, *@args)).to(matcher)
+        if matcher.is_a?(RSpec::Matchers::BuiltIn::BeAKindOf)
+          stand_in = @context.double(matcher.expected.instance_contract_inspect)
+        else
+          stand_in = matcher.expected
+        end
+        @context.fulfills(
+          contract_message_signature(@object, @method, @args, [stand_in])
+        )
+      end
+    end
+
+    class ContractAdapter
+      include Shared
+
+      def initialize(object, context)
+        @object = object
+        @context = context
+      end
+
+      def must(matcher)
+        @matcher = matcher
+
+        if matcher.is_a?(RSpec::Rails::Matchers::RoutingMatchers::RouteToMatcher)
+          contract_route_to_matcher
+        else
+          contract_receive_matcher
+        end
+      end
+
+      private
+
+      def contract_route_to_matcher
+        @expected = @matcher.instance_variable_get('@expected').with_indifferent_access
+        create_route_contract
+        create_route_expectation
+      end
+
+      def contract_receive_matcher
+        @message      = @matcher.instance_variable_get('@message')
+        @arguments    = customization(@matcher, :with)
+        @return_value = customization(@matcher, :and_return)
+
+        create_contract
+        create_expectation
+      end
+
+      def create_route_contract
+        method     = @object.keys.first
+        controller = @expected[:controller]
+        action     = @expected[:action]
+
+        params = @expected.except(:controller, :action)
+        if params.keys.any?
+          Contractinator::Contract.require("#{method} #{controller}##{action} #{params}")
+        else
+          Contractinator::Contract.require("#{method} #{controller}##{action}")
+        end
+      end
+
+      def create_route_expectation
+        @context.expect(@object).to @context.route_to(@expected)
+      end
+
+      def create_contract
+        args  = @arguments
+        dbl   = @object
+        msg   = @message
+        value = @return_value
+
+        Contractinator::Contract.require(contract_message_signature(dbl, msg, args, value))
+      end
+
+      def create_expectation
+        @context.expect(@object).to @matcher.at_least(:once)
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/array.rb

@@ -0,0 +1,10 @@
+module Contractinator
+  module CoreExtensions
+    module Array
+      def contract_inspect
+        values = map(&:contract_inspect).join(', ')
+        "[#{values}]"
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/class.rb

@@ -0,0 +1,17 @@
+module Contractinator
+  module CoreExtensions
+    module Class
+      def contract_inspect
+        class_contract_inspect
+      end
+
+      def class_contract_inspect
+        to_s
+      end
+
+      def instance_contract_inspect
+        to_s.underscore
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/hash.rb

@@ -0,0 +1,12 @@
+module Contractinator
+  module CoreExtensions
+    module Hash
+      def contract_inspect
+        values = map do |key, value|
+          "#{key.contract_inspect}=>#{value.contract_inspect}"
+        end.join(', ')
+        "{#{values}}"
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/object.rb

@@ -0,0 +1,17 @@
+module Contractinator
+  module CoreExtensions
+    module Object
+      def contract_inspect
+        instance_contract_inspect
+      end
+
+      def class_contract_inspect
+        self.class.to_s
+      end
+
+      def instance_contract_inspect
+        self.class.to_s.underscore
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/string.rb

@@ -0,0 +1,9 @@
+module Contractinator
+  module CoreExtensions
+    module String
+      def contract_inspect
+        '""'
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions/symbol.rb

@@ -0,0 +1,9 @@
+module Contractinator
+  module CoreExtensions
+    module Symbol
+      def contract_inspect
+        inspect
+      end
+    end
+  end
+end

data/lib/contractinator/core_extensions.rb

@@ -0,0 +1,16 @@
+require_relative 'core_extensions/array'
+require_relative 'core_extensions/class'
+require_relative 'core_extensions/hash'
+require_relative 'core_extensions/object'
+require_relative 'core_extensions/symbol'
+require_relative 'core_extensions/string'
+
+module Contractinator
+  ::Object.include(CoreExtensions::Object)
+
+  ::Array.include(CoreExtensions::Array)
+  ::Class.include(CoreExtensions::Class)
+  ::Hash.include(CoreExtensions::Hash)
+  ::String.include(CoreExtensions::String)
+  ::Symbol.include(CoreExtensions::Symbol)
+end

data/lib/contractinator/rspec_extensions/double.rb

@@ -0,0 +1,9 @@
+module Contractinator
+  module RSpecExtensions
+    module Double
+      def contract_inspect
+        @name.to_s
+      end
+    end
+  end
+end

data/lib/contractinator/rspec_extensions.rb

@@ -0,0 +1,5 @@
+require_relative 'rspec_extensions/double'
+
+module Contractinator
+  ::RSpec::Mocks::Double.include(RSpecExtensions::Double)
+end

data/lib/contractinator/version.rb

@@ -0,0 +1,3 @@
+module Contractinator
+  VERSION = "0.1.0"
+end

data/lib/contractinator.rb

@@ -0,0 +1,8 @@
+require "contractinator/version"
+require "contractinator/contract"
+require "contractinator/contract_helpers"
+require "contractinator/core_extensions"
+require "contractinator/rspec_extensions"
+
+module Contractinator
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: contractinator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pivotal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- pair@pivotal.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contractinator.gemspec
+- lib/contractinator.rb
+- lib/contractinator/contract.rb
+- lib/contractinator/contract_helpers.rb
+- lib/contractinator/core_extensions.rb
+- lib/contractinator/core_extensions/array.rb
+- lib/contractinator/core_extensions/class.rb
+- lib/contractinator/core_extensions/hash.rb
+- lib/contractinator/core_extensions/object.rb
+- lib/contractinator/core_extensions/string.rb
+- lib/contractinator/core_extensions/symbol.rb
+- lib/contractinator/rspec_extensions.rb
+- lib/contractinator/rspec_extensions/double.rb
+- lib/contractinator/version.rb
+homepage: http://github.com/ehrenmurdick/contractinator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Contractinator is a tool for contract-driven development!
+test_files: []