bound 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55ee3700c0f6aff1e212a4b05a2d1c7eab87b9f7
-  data.tar.gz: 2a50137771a1b061051f14c46dd7b1ec8cd3ec95
+  metadata.gz: 40eb13fe1d57fd0d42c0d0fc5c91348173071cb2
+  data.tar.gz: 61658fd50d9bf0dd3790b75bca0588e80863ca4f
 SHA512:
-  metadata.gz: aa4817e8a7046bb2d5e56da17a466968061497b036109057037e8f747c32332b25b4f247a3e0202ada60dc4555d78a92561adec5564b88c63294977da5f50f62
-  data.tar.gz: 804361979bd44ff9a1a42cb18e08300ae6169a518f9b3e5f2be387b7f1a9169f80356386afb800bb44c692f9a55e7cb36e9199be45add2dae642a9d1384cdff6
+  metadata.gz: 86f3b026b006ff92b6652cd3e37df15206bcb304150c4d9c3c0fee70809b02a65fce814f67dc92f40e4df87ef93e351b182420e38d968e8c8cac27e8fbe8b9c5
+  data.tar.gz: ebc0035cc9f636a9af6f798a3cb70ab0420834f73b8212b2f42d74b640217a6ebb5385b7e3e98830c42f6cbe0282757f2839e55a44d0c55b4d0167437177afd7

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
   - 1.9.3
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx
   - 1.8.7
   - ree

data/README.md

@@ -2,7 +2,19 @@
 
 [![Build Status](https://travis-ci.org/neopoly/bound.png)](https://travis-ci.org/neopoly/bound) [![Gem Version](https://badge.fury.io/rb/bound.png)](http://badge.fury.io/rb/bound) [![Code Climate](https://codeclimate.com/github/neopoly/bound.png)](https://codeclimate.com/github/neopoly/bound)
 
-TODO: Write a gem description
+**In short:** The mission: Bring the notion of interfaces to ruby.
+
+**More detailed:** When you build separated or distributed architectures in ruby,
+you probably encountered the problem of stale mocks or wrongly mocked interfaces
+of specific services at the boundaries of the different domains.
+
+To tackle this problem, we use `Bound`. Instead of providing just a list of
+arguments to a poor little boundary method, it will just accept an argument, its
+request, to speak in more technical terms. By implementing the request and
+response objects through `Bound`, you get validated interfaces and more explicit
+and self documenting code for free.
+
+See **Usage** below for more details with a concrete example.
 
 ## Installation
 
@@ -20,7 +32,90 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Consider the folowing scenario:
+
+A generic domain which is responsible for administration and management of user
+registrations:
+
+```ruby
+module UserDesk
+end
+```
+
+It will somehow provide access to a registration service which gives you the
+possibility to create new user accounts:
+
+```ruby
+class UserDesk::RegistrationService
+  def register_account(email, password)
+    ensure_validity!(email)
+    user_uid = do_things_on_a_magical_repository(email, password)
+
+    user_uid
+  end
+
+  private
+  # ...
+end
+```
+
+Since the scope of this service can (and will) be very large, it will be painful
+to provide consistency around the different other domains, which get an instance
+of the registration service injected. Especially order changes in a larger
+argument list or added optional arguments could lead to false passing tests and
+therefor probably runtime bugs.
+
+By utilizing `Bound`, you could implement this service like following:
+
+```ruby
+class UserDesk::RegistrationService
+  Registration = Bound.required(
+    :email,
+    :password
+  )
+
+  SuccessfulRegistration = Bound.required(:user_uid)
+
+  def register_account(registration)
+    ensure_validity!(registration.email)
+    user_uid = do_things_on_a_magical_repository(
+      registration.email,
+      registration.password
+    )
+
+    SuccessfulRegistration.new(:user_uid => user_uid)
+  end
+
+  private
+  # ...
+end
+```
+
+The consumer would now instanciate the boundary class instead of just
+passing arbitrary arguments to the service:
+
+```ruby
+registration = UserDesk::RegistrationService::Registration.new(
+  :email => params[:email],
+  :password => params[:password]
+)
+
+result = registration_service.register_account(registration)
+
+do_stuff_with(result.user_uid)
+```
+
+Side note: the `Registration` bound here would also accept any `Object`, which provides the
+methods `email` and `password`.
+
+Bound would also loudly fail, if one of the required arguments is omitted or a
+unknown argument is provided. (Specific additional features like nested and
+optional arguments can be seen in the specs).
+
+By concretinzing the boundaries, the overall structure of your architecture will
+become more rigid and solid. The mocking part on the consumer-side would only
+occur for the actual `register_account` call, which is fairly trivial now from
+the perspective of boundaries (known object in, known object out).
 
 ## Contributing
 

data/lib/bound.rb

@@ -241,6 +241,14 @@ class Bound
       attribute
     end
 
+    def ==(other)
+      return false unless other
+
+      get_attributes.all? do |attribute|
+        attribute.value == other.public_send(attribute.name)
+      end
+    end
+
     private
 
     def validate!

data/lib/bound/version.rb

@@ -1,3 +1,3 @@
 class Bound
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/bound_spec.rb

@@ -63,6 +63,32 @@ describe Bound do
     assert_includes user.get_attributes.map(&:name), :age
   end
 
+  describe 'equality' do
+    let(:user) { User.new(hash) }
+
+    it 'is given if all the attributes are same' do
+      reference_user = User.new(hash)
+
+      assert_equal user, reference_user
+    end
+
+    it 'is not given if attributes differ' do
+      reference_user = User.new(hash.merge(:name => 'DIFF'))
+
+      refute_equal user, reference_user
+    end
+
+    it 'is given for other objects with same signature' do
+      reference_user = Struct.new(:name, :age).new(user.name, user.age)
+
+      assert_equal user, reference_user
+    end
+
+    it 'is not given for nil' do
+      refute_equal user, nil
+    end
+  end
+
   describe 'wrong initialization' do
     it 'fails if new is not called with symbols' do
       assert_raises ArgumentError do
@@ -221,6 +247,20 @@ describe Bound do
       end
     end
 
+    describe 'equality' do
+      let(:user) { BloggingUser.new(hash) }
+      it 'is given if the nested attributes are equal' do
+        assert_equal BloggingUser.new(hash), user
+      end
+
+      it 'is not given if nested attributes differ' do
+        second_hash = Marshal.load(Marshal.dump hash)
+        second_hash[:posts][0][:title] = 'DIFFERENT'
+
+        refute_equal BloggingUser.new(second_hash), user
+      end
+    end
+
     it 'fails if posts is no array' do
       hash[:posts] = {:title => 'broken'}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bound
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jakob Holderbaum
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.7
 - !ruby/object:Gem::Dependency
   name: simplecov
   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'
 description: 
@@ -75,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,17 +99,17 @@ 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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Implements a nice helper for fast boundary definitions