object_protocol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 22d8c5fa9114c23a89499e798c017b41402b0f10f45ffc53236db31222035e0c
+  data.tar.gz: e076ce8bd8b02a476f723b7cfe188ca66f6901e2d0e123b0a3210ddbd276c50c
+SHA512:
+  metadata.gz: 7df2d672dff3d0467c2ef90e0adda6196d2d255638b7f73f1d15cb5dbe7e18459851f0305d8975abee91348453fa4e29f56f059e213d1e2f2ad3f76c9f6cd753
+  data.tar.gz: fcc960d6e186b61093cf4ff2ea6487257e0ce813cc77af1ce3aff2c075af850e10e40bd4da9856cf7a5a8f7862c53cd6b247290d48ad8772c599f51fc9aeedf7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require object_protocol

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## ROADMAP
+
+* in_order
+* in_any_order
+* doesnt_send (and figure out how it relates to ordering steps)
+* add diffs to failure message
+* add color to failure message diffs
+* make failure message diff colors configurable via env vars for acessibility
+
+## RELEASE 0.1.0
+
+* FEATURE: ObjectProtocols can be instantiated and used in tests
+* FEATURE: We provide a `be_satisfied_by` matcher as a convenience in tests. It's failure messages are really helpful.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at choffman@optoro.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in object_protocol.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    object_protocol (0.1.0)
+      binding_of_caller
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    debug_inspector (0.0.3)
+    diff-lcs (1.3)
+    git (1.4.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    structured_changelog (0.10.0)
+      git
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  object_protocol!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  structured_changelog
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,39 @@
+# ObjectProtocol
+
+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/object_protocol`. 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 'object_protocol'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_protocol
+
+## 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/yarmiganosca/object_protocol. 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.
+
+## Code of Conduct
+
+Everyone interacting in the ObjectProtocol project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yarmiganosca/object_protocol/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "object_protocol"
+
+# 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(__FILE__)

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/lib/object_protocol/execution.rb

@@ -0,0 +1,102 @@
+require 'binding_of_caller'
+
+require 'object_protocol/sent_message'
+
+class ObjectProtocol
+  class Execution
+    attr_reader :participants
+
+    def initialize(*participants, &blk)
+      raise(ArgumentError, "#{self.class.name} requires a block") unless block_given?
+
+      @participants = participants
+      @blk          = blk
+    end
+
+    def call(protocol)
+      begin
+        $object_protocol_spying_enabled = false
+        participants.each(&method(:start_spying_on_public_methods_on))
+        # we guard inside the methods with a global so that we don't start spying
+        # while we're still redefining all the public methods on the participant
+        $object_protocol_spying_enabled = true
+        protocol.instance_exec(&blk)
+      ensure
+        $object_protocol_spying_enabled = false
+        participants.each(&method(:stop_spying_on_public_methods_on))
+      end
+    end
+
+    def messages; @messages ||= []; end
+
+    private
+
+    attr_reader :blk
+
+    def start_spying_on_public_methods_on(participant)
+      execution         = self
+      methods_to_spy_on = participant.methods - %i(object_id __send__) # to avoid warnings
+
+      participant.instance_exec {
+        @methods_by_name ||= {}
+      }
+
+      participant_object_ids = self.participants.map(&:object_id)
+
+      methods_to_spy_on.each do |method_name|
+        method = participant.method(method_name)
+
+        participant.instance_variable_get(:@methods_by_name)[method_name] = method
+
+        method_body = proc do |*args, &blk|
+          if $object_protocol_spying_enabled
+            sender_object_id = binding.of_caller(1).eval("object_id")
+
+            # if we try participants.include?(sender), we end up with a lot more
+            # recorded messages because of equality checking
+            if participant_object_ids.include?(sender_object_id)
+              sender    = ObjectSpace._id2ref(sender_object_id)
+              arguments = if block_given?
+                            [args, blk]
+                          else
+                            args
+                          end
+
+              sent_message = SentMessage.new(
+                sender:   sender,
+                receiver: self,
+                name:     method_name,
+              )
+
+              sent_message.with(arguments) if arguments.any?
+
+              execution.messages << sent_message
+            end
+          end
+
+          method.call(*args, &blk)
+        end
+
+        participant.instance_eval("undef #{method_name}")
+
+        if method_name == :define_singleton_method
+          method.call(method_name, &method_body)
+        else
+          participant.define_singleton_method(method_name, &method_body)
+        end
+      end
+    end
+
+    def stop_spying_on_public_methods_on(participant)
+      participant.instance_variable_get(:@methods_by_name).each do |method_name, method|
+        participant.instance_eval("undef #{method_name}")
+
+        if method_name == :define_singleton_method # define_singleton_method has just been undefined
+          method.call(method_name, &method)
+        else
+          participant.define_singleton_method(method_name, &method)
+        end
+      end
+    end
+  end
+end

data/lib/object_protocol/rspec.rb

@@ -0,0 +1,40 @@
+require 'object_protocol'
+
+require 'rspec/core'
+require 'rspec/expectations'
+
+class SatisfactionAttemptVerifier
+  def initialize(&blk)
+    @blk = blk
+  end
+
+  def matches?(protocol)
+    @protocol = protocol
+    @attempt  = ObjectProtocol::SatisfactionAttempt.new(protocol, &blk)
+
+    attempt.to_bool
+  end
+
+  def failure_message
+    [
+      "expected",
+      protocol.to_rspec_matcher_failure_message_lines.map(&"  ".method(:+)).flatten,
+      "to be satisfied by",
+      attempt.to_rspec_matcher_failure_message_lines.map(&"  ".method(:+)).flatten,
+    ].join("\n")
+  end
+
+  private
+
+  attr_reader :blk, :protocol, :attempt
+end
+
+module ObjectProtocol::RSpecMatchers
+  def be_satisfied_by(&blk)
+    SatisfactionAttemptVerifier.new(&blk)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ObjectProtocol::RSpecMatchers
+end

data/lib/object_protocol/satisfaction_attempt.rb

@@ -0,0 +1,55 @@
+require 'object_protocol/execution'
+require 'object_protocol/satisfiable_step'
+
+class ObjectProtocol
+  class SatisfactionAttempt
+    def initialize(protocol, &blk)
+      @protocol = protocol
+      @blk      = blk
+    end
+
+    def to_bool
+      execution.call(protocol)
+
+      unsatisfied_steps = protocol.steps.map do |step|
+        SatisfiableStep.new(protocol: protocol, step: step)
+      end
+
+      execution.messages.each do |sent_message|
+        next_step = unsatisfied_steps.first
+
+        next_step.attempt_to_apply_sent_message(sent_message)
+
+        if next_step.satisfied?
+          unsatisfied_steps.shift
+        end
+      end
+
+      unsatisfied_steps.empty?
+    end
+
+    def to_rspec_matcher_failure_message_lines
+      return ["<empty execution>"] if execution.messages.empty?
+
+      execution.messages.map do |sent_message|
+        fragment_base = "#{protocol.name_of_participant(sent_message.sender)}"\
+          ".sent(:#{sent_message.name})"\
+          ".to(#{protocol.name_of_participant(sent_message.receiver)})"
+
+        if sent_message.arguments_passed?
+          "#{fragment_base}.with(#{sent_message.arguments})"
+        else
+          fragment_base
+        end
+      end
+    end
+
+    private
+
+    attr_reader :protocol, :blk
+
+    def execution
+      @execution ||= Execution.new(*protocol.participants, &blk)
+    end
+  end
+end

data/lib/object_protocol/satisfiable_step.rb

@@ -0,0 +1,43 @@
+require 'forwardable'
+
+class ObjectProtocol
+  class SatisfiableStep
+    extend Forwardable
+
+    delegate %i(sender receiver message arguments arguments_specified?) => :@step
+
+    def initialize(protocol:, step:)
+      @protocol = protocol
+      @step     = step
+
+      @satisfied = false
+    end
+
+    def attempt_to_apply_sent_message(sent_message)
+      return if satisfied?
+      return false unless is_sent_message_applicable?(sent_message)
+
+      @satisfied = true
+    end
+
+    def is_sent_message_applicable?(sent_message)
+      return false unless protocol.participant_by_name(sender.name) == sent_message.sender
+      return false unless protocol.participant_by_name(receiver.name) == sent_message.receiver
+      return false unless message == sent_message.name
+
+      if arguments_specified?
+        return false unless arguments == sent_message.arguments
+      end
+
+      true
+    end
+
+    def satisfied?
+      !!@satisfied
+    end
+
+    private
+
+    attr_reader :protocol
+  end
+end

data/lib/object_protocol/sent_message.rb

@@ -0,0 +1,40 @@
+class ObjectProtocol
+  class SentMessage
+    attr_reader :sender, :receiver, :name, :arguments
+
+    def initialize(sender:, receiver:, name:)
+      @sender   = sender
+      @receiver = receiver
+      @name     = name
+
+      @arguments_passed = false
+    end
+
+    def arguments_passed?
+      !!@arguments_passed
+    end
+
+    def with(arguments)
+      @arguments = arguments
+
+      @arguments_passed = true
+
+      self
+    end
+
+    def inspect
+      "<#{self.class.name}[#{sender.class.name}, :#{name}, #{receiver.class.name}]>"
+    end
+
+    def ==(other)
+      other.respond_to?(:sender) &&
+        sender == other.sender &&
+        other.respond_to?(:receiver) &&
+        receiver == other.receiver &&
+        other.respond_to?(:name) &&
+        name == other.name &&
+        other.respond_to?(:arguments) &&
+        arguments == other.arguments
+    end
+  end
+end

data/lib/object_protocol/stand_in.rb

@@ -0,0 +1,22 @@
+require 'object_protocol/step'
+
+class ObjectProtocol
+  class StandIn
+    attr_reader :name
+
+    def initialize(protocol:, name:)
+      @protocol = protocol
+      @name     = name
+    end
+
+    def sends(message)
+      Step.new(sender: self, message: message).tap do |step|
+        protocol.steps << step
+      end
+    end
+
+    private
+
+    attr_reader :protocol
+  end
+end

data/lib/object_protocol/step.rb

@@ -0,0 +1,55 @@
+class ObjectProtocol
+  class Step
+    attr_reader :sender, :message, :receiver, :arguments
+
+    def initialize(sender:, message:)
+      @sender  = sender
+      @message = message
+
+      @arguments_specified = false
+    end
+
+    def to(receiver)
+      @receiver = receiver
+
+      self
+    end
+
+    def with(*arguments)
+      @arguments = arguments
+
+      @arguments_specified = true
+
+      self
+    end
+
+    def inspect
+      "<Step[#{sender.name}, :#{message}, #{receiver.name}]>"
+    end
+
+    def to_rspec_matcher_failure_message_line
+      fragment_base = "#{sender.name}.sends(:#{message}).to(#{receiver.name})"
+
+      if arguments_specified?
+        "#{fragment_base}.with(#{arguments})"
+      else
+        fragment_base
+      end
+    end
+
+    def ==(other)
+      other.respond_to?(:sender) &&
+        sender == other.sender &&
+        other.respond_to?(:receiver) &&
+        receiver == other.receiver &&
+        other.respond_to?(:message) &&
+        message == other.message &&
+        other.respond_to?(:arguments) &&
+        arguments == other.arguments
+    end
+
+    def arguments_specified?
+      @arguments_specified
+    end
+  end
+end

data/lib/object_protocol/version.rb

@@ -0,0 +1,3 @@
+class ObjectProtocol
+  VERSION = "0.1.0"
+end

data/lib/object_protocol.rb

@@ -0,0 +1,68 @@
+require "object_protocol/version"
+require 'object_protocol/stand_in'
+require 'object_protocol/satisfaction_attempt'
+
+class ObjectProtocol
+  attr_reader :participants_by_name
+
+  def initialize(*participant_names, &protocol)
+    participant_names.each(&method(:define_stand_in))
+    instance_exec(&protocol)
+    participant_names.each(&method(:undefine_stand_in))
+  end
+
+  def bind(**participants_by_name)
+    @participants_by_name = participants_by_name
+
+    @participants_by_name.each(&method(:define_participant))
+
+    self
+  end
+
+  def satisfied_by?(&blk)
+    SatisfactionAttempt.new(self, &blk).to_bool
+  end
+
+  def steps
+    @steps ||= []
+  end
+
+  def participant_by_name(name)
+    participants_by_name[name]
+  end
+
+  def name_of_participant(participant)
+    participants_by_name.invert[participant]
+  end
+
+  def participants
+    participants_by_name.values
+  end
+
+  def to_rspec_matcher_failure_message_lines
+    steps.map(&:to_rspec_matcher_failure_message_line)
+  end
+
+  private
+
+  def define_participant(name, participant)
+    instance_variable_set("@#{name}_participant", participant)
+
+    define_singleton_method(name) do
+      instance_variable_get("@#{name}_participant")
+    end
+  end
+
+  def define_stand_in(name)
+    instance_variable_set("@#{name}_stand_in", StandIn.new(protocol: self, name: name))
+
+    define_singleton_method(name) do
+      instance_variable_get("@#{name}_stand_in")
+    end
+  end
+
+  def undefine_stand_in(name)
+    instance_eval("undef :#{name}")
+    remove_instance_variable("@#{name}_stand_in")
+  end
+end

data/object_protocol.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "object_protocol/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "object_protocol"
+  spec.version       = ObjectProtocol::VERSION
+  spec.authors       = ["Chris Hoffman"]
+  spec.email         = ["yarmiganosca@gmail.com"]
+
+  spec.summary       = "Write object protocols instead of message expectations."
+  spec.description   = "Write object protocols instead of message expectations."
+  spec.homepage      = "https://www.github.com/yarmiganosca/object_protocol"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "structured_changelog"
+
+  spec.add_dependency "binding_of_caller"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: object_protocol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hoffman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: structured_changelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Write object protocols instead of message expectations.
+email:
+- yarmiganosca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/object_protocol.rb
+- lib/object_protocol/execution.rb
+- lib/object_protocol/rspec.rb
+- lib/object_protocol/satisfaction_attempt.rb
+- lib/object_protocol/satisfiable_step.rb
+- lib/object_protocol/sent_message.rb
+- lib/object_protocol/stand_in.rb
+- lib/object_protocol/step.rb
+- lib/object_protocol/version.rb
+- object_protocol.gemspec
+homepage: https://www.github.com/yarmiganosca/object_protocol
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Write object protocols instead of message expectations.
+test_files: []