fabrik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 128e5fa1f485e41afa0d92c2c788695b034b91fa
+  data.tar.gz: abb9712fdd16527795762b1237bc05078f75a971
+SHA512:
+  metadata.gz: 1e92bd02555a20d05f792fed914829ac10a342abafd4878ccaacab0a7141d3b07f35b7aa2c84e9c84837b7fc9340d2852266935cb58369e740aac54750d06e04
+  data.tar.gz: de15a22c2c5854a31a132723f36c9e2355c87f4193312b211dff79f6bfde4803c7d297dd425a00b764e04ba23afb488161a9a4afbcb178487f0f61ea07c9452a

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Joe Corcoran
+
+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,98 @@
+# Fabrik
+
+[![Build Status](https://travis-ci.org/joecorcoran/fabrik.svg?branch=master)](https://travis-ci.org/joecorcoran/fabrik)
+
+Traits for Ruby 2, as described in [Traits: A Mechanism for
+Fine-grained Reuse][paper] by Ducasse, Nierstrasz, Schärli, Wuyts and Black.
+
+## Usage
+
+A class becomes a trait when it extends `Fabrik::Trait`.
+
+```ruby
+class Tiger
+  extend Fabrik::Trait
+end
+```
+
+Traits provide methods within a `provides` block.
+
+```ruby
+class Panthera
+  extend Fabrik::Trait
+
+  provides do
+    def roar; :roar! end
+  end
+end
+```
+
+```ruby
+class Tiger
+  extend Fabrik::Trait
+
+  provides do
+    def mother; :tigress end
+    def father; :tiger end
+  end
+end
+```
+
+```ruby
+class Lion
+  extend Fabrik::Trait
+
+  provides do
+    def mother; :lioness end
+    def father; :lion end
+  end
+end
+```
+
+A class uses traits by extending `Fabrik::Composer` and composing the traits.
+
+```ruby
+class Tigon
+  extend Fabrik::Composer
+  compose Panthera, Tiger, Lion
+end
+```
+
+```ruby
+tigon = Tigon.new
+tigon.roar    # => :roar!
+tigon.mother  # => raises ConflictingMethods error
+```
+
+Conflicting methods must be resolved, by exclusion or aliasing during
+composition, or by overriding in the composing class.
+
+```ruby
+class Tigon
+  extend Fabrik::Composer
+  compose Panthera,
+          Tiger.methods(exclude: :mother),
+          Lion.methods(exclude: :father)
+end
+```
+
+```ruby
+tigon = Tigon.new
+tigon.roar    # => :roar!
+tigon.mother  # => :lioness
+tigon.father  # => :tiger
+```
+
+View the specs for further examples, including composable traits and traits
+that provide methods from shared modules.
+
+## Credits
+
+Built by [Joe Corcoran][me].
+
+## License
+
+MIT.
+
+[paper]: http://scg.unibe.ch/archive/papers/Duca06bTOPLASTraits.pdf
+[me]: https://corcoran.io

data/lib/fabrik/composer.rb

@@ -0,0 +1,17 @@
+require 'fabrik/resolver'
+
+module Fabrik
+  module Composer
+
+    def compose(*method_maps)
+      method_maps.map! { |m| Hash === m ? m : m.methods }
+      resolved_method_map = Resolver.new(method_maps).resolved_method_map
+      resolved_method_map.each do |name, method|
+        unless self.instance_methods(false).include?(name)
+          self.send(:define_method, name, method)
+        end
+      end
+    end
+
+  end
+end

data/lib/fabrik/dictionary.rb

@@ -0,0 +1,43 @@
+require 'set'
+
+module Fabrik
+  class Dictionary
+
+    def initialize
+      @pairs = Set.new
+    end
+
+    def add(pair)
+      @pairs.add(pair)
+    end
+
+    def method_map(opts = {})
+      exclude = Array(opts[:exclude])
+      aliases = opts.fetch(:aliases, {})
+
+      methods = Hash[
+        @pairs.map do |pair|
+          mod, name = pair
+          [name, mod.instance_method(name)]
+        end
+      ]
+      methods = apply_exclusions(methods, exclude)
+      methods = apply_aliases(methods, aliases)
+    end
+
+    def apply_exclusions(methods, exclusions)
+      methods.select do |name, _|
+        !exclusions.include?(name)
+      end
+    end
+
+    def apply_aliases(methods, aliases)
+      Hash[
+        methods.map do |name, _|
+          [(aliases.include?(name) ? aliases[name] : name), _]
+        end
+      ]
+    end
+
+  end
+end

data/lib/fabrik/errors.rb

@@ -0,0 +1,3 @@
+module Fabrik
+  class ConflictingMethods < NotImplementedError; end
+end

data/lib/fabrik/resolver.rb

@@ -0,0 +1,36 @@
+require 'fabrik/errors'
+
+module Fabrik
+  class Resolver
+    attr_reader :conflicts
+
+    def initialize(method_maps)
+      @method_maps = method_maps
+      @conflicts   = {}
+    end
+
+    def resolved_method_map
+      @method_maps.reduce({}) do |result, method_map|
+        result.merge!(method_map) do |name, m1, m2|
+          m1 == m2 ? m1 : conflict_method(name, m1, m2)
+        end
+      end
+    end
+
+    def conflict_method(name, m1, m2)
+      resolver, @conflicts[name] = self, [m1, m2]
+      own.send(:define_method, name) do
+        m1, m2 = resolver.conflicts[name]
+        raise ConflictingMethods.new(
+          "#{m1.owner} and #{m2.owner} both provide methods named :#{name}"
+        )
+      end
+      own.instance_method(name)
+    end
+
+    def own
+      @own ||= Module.new
+    end
+
+  end
+end

data/lib/fabrik/trait.rb

@@ -0,0 +1,36 @@
+require 'fabrik/composer'
+require 'fabrik/dictionary'
+require 'forwardable'
+
+module Fabrik
+  module Trait
+    include Composer
+
+    extend Forwardable
+    def_delegators :own, :instance_methods, :send
+
+    def methods(opts = {})
+      provides_from(own, *own.instance_methods)
+      dictionary.method_map(opts)
+    end
+
+    def provides(&own_definition)
+      own.module_eval(&own_definition)
+    end
+
+    def provides_from(mod, *names)
+      names.each do |name|
+        dictionary.add([mod, name])
+      end
+    end
+
+    def own
+      @own ||= Module.new
+    end
+
+    def dictionary
+      @dictionary ||= Dictionary.new
+    end
+    
+  end
+end

data/lib/fabrik/version.rb

@@ -0,0 +1,3 @@
+module Fabrik
+  VERSION = '0.1.0'
+end

data/lib/fabrik.rb

@@ -0,0 +1,5 @@
+require 'fabrik/composer'
+require 'fabrik/trait'
+require 'fabrik/version'
+
+module Fabrik; end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: fabrik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Corcoran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Traits for Ruby 2, as described in the paper "Traits: A Mechanism for
+  Fine-grained Reuse" by Ducasse, Nierstrasz, Schärli, Wuyts and Black.
+email:
+- joecorcoran@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/fabrik.rb
+- lib/fabrik/composer.rb
+- lib/fabrik/dictionary.rb
+- lib/fabrik/errors.rb
+- lib/fabrik/resolver.rb
+- lib/fabrik/trait.rb
+- lib/fabrik/version.rb
+homepage: http://github.com/joecorcoran/fabrik
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Traits for Ruby 2
+test_files: []