accord 0.1.0 → 0.1.1

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Rafael Cabral Coutinho
+
+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.rst

@@ -0,0 +1,88 @@
+Accord - object interfaces and adaptation for Ruby
+==================================================
+
+Accord is a gem providing basic object interface and adaptation support for
+Ruby.  An interface represents a protocol or contract (an API), and this gem
+allows you to label your objects/classes/modules as being compliant with a
+given API by declaring them as implementing/providing interfaces.  Thus, one
+would call this an implementation of `Design by Contract
+<http://en.wikipedia.org/wiki/Design_by_contract>`_ in Ruby.
+
+Object adaptation is also supported.  Given an object which claims to provide
+some API, and in a specific point of the code another API is needed, Accord
+will allow adapting from the object API to the desired one (provided that an
+*adapter* which can adapt the APIs is known by Accord).
+
+This gem was largely inspired by the Python package ``zope.interface``,
+maintained by the `Zope Toolkit Project <http://docs.zope.org/zopetoolkit/>`_.
+``zope.interface`` source `can be found here
+<https://github.com/zopefoundation/zope.interface>`_.
+
+Disclaimer: this is not used in any real world project yet. The API is still
+changing (and will, while this gem is not in the 1.0 version).  Not ready for
+prime time.
+
+
+Basic usage
+-----------
+
+Declare some interfaces::
+
+  Labelled = Accord::Interface(:Labelled) do
+    responds_to :label
+  end
+  PersonAPI = Accord::Interface(:PersonAPI)
+
+Implement them::
+
+  class Person
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+  end
+
+  class PersonLabel
+    def initialize(person)
+      @person = person
+    end
+    def label
+      @person.name
+    end
+  end
+
+Declare that your classes are implementations of the interfaces::
+
+  Accord::Declarations.implements(Person, PersonAPI)
+  Accord::Declarations.implements(PersonLabel, Labelled)
+
+Tell Accord that people can have labels (that is, they can be adapted to
+`Labelled`)::
+
+  Accord.default_adapter_registry.register([PersonAPI], Labelled) do |person|
+    PersonLabel.new(person)
+  end
+
+Now, in a piece of code which needs a label::
+
+  def show(object)
+    Labelled.adapt!(object).label
+  end
+
+When a person is given to `#show`, its name will be used to provide a label::
+
+  person = Person.new('John')
+  show(person) #=> 'John'
+
+By registering more adapters, `#show` can be reused to show the labels of
+other types of objects, without changing its source.  `#show` doesn't rely on
+receiving a person, but depends only on an interface.  Also, everything could
+have been added in the application after the `Person` class (as if that class
+were legacy code), without modifying its source.  Or `Person` could be a class
+in a third party library.
+
+
+License
+-------
+
+This gem is MIT-licensed.  See LICENSE.txt in the root of this repository.

data/lib/accord/version.rb

@@ -1,3 +1,3 @@
 module Accord
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accord
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,8 @@ files:
 - .rvmrc
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
+- README.rst
 - accord.gemspec
 - lib/accord.rb
 - lib/accord/adapter_registry.rb