wrapper_based 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8250109a727470549a4a5ad7eeeb2b83deb22ded
-  data.tar.gz: aad939be5697e39f97d8adfcb2978ef723702516
+  metadata.gz: a512a58ee3c31a5d96debe8d835854faa1b05d1d
+  data.tar.gz: 0cb617aec6443efcb7972c5d015d43d4533f2918
 SHA512:
-  metadata.gz: 71ec411aaa5a9ebaeab67749f5adcc66e1b2921cbb58e22ce3a49385e4d8173a8502f3582c6187af6a3829cfda489ff81eb734ce5d55e6b559409d287a80d72e
-  data.tar.gz: 183610fab65d79dee5b6c08f8f1bc849718fb1241478d9937bff0fe283d3ebd429fdbb1d493122bd2c52109703d6c1dd6152cb301a33b2f602be07b748beb8eb
+  metadata.gz: 70e62a920819ba82bd6396b3849258e83177a8b99ba3b4d74548f71af68b4714012926e2cc904d101860da8b5dc982b2c2bd7c3bf24b9e0ae4ca3d6b6da192ce
+  data.tar.gz: 318f1a9ab51099e22f5e4234161ccd24931aba3067f24eedcc1ed6b593ea6b6b4e7843fe3f270379a0191322b9d622bcb37b3b8f56aa097aae623ce10c6b75e4

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/wrapper_based.svg)](https://badge.fury.io/rb/wrapper_based)
 [![Build Status](https://travis-ci.org/RichOrElse/wrapper-based.svg?branch=master)](https://travis-ci.org/RichOrElse/wrapper-based)
 
-Wrapper Based DCI implementation in Ruby.
+Wrapper Based DCI framework for OOP done right.
 
 ## Installation
 
@@ -17,17 +17,6 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install wrapper_based
-
-Require DCI in your gems or save in your rails app as app/config/dci.rb:
-
-
-```ruby
-require 'wrapper_based/dci'
-```
-
 ## Usage
 
 [Dijkstra data](https://github.com/RichOrElse/wrapper-based/blob/master/examples/dijkstra/data.rb) | 
@@ -35,65 +24,44 @@ require 'wrapper_based/dci'
 Djikstra example:
 
 ```ruby
-require_relative 'dijkstra/data'
-
-module CurrentIntersection
-  def neighbors(manhattan:)
-    east_neighbor = manhattan.east_neighbor_of(self)
-    south_neighbor = manhattan.south_neighbor_of(self)
-    [south_neighbor, east_neighbor].compact # excludes nil neighbors
-  end
-end
-
 module DestinationNode
-  def shortest_path(from:, within:)
-    return [self] if equal? from
-    FindShortest[to: self, from: from, city: within].path
+  def shortest_path_from(neighbor, find_shortest)
+    return [self] if equal? neighbor
+    find_shortest.path(from: neighbor)
   end
 end
 
-module Map
+Map = DCI::Module.new do |mod| using mod
   def distance_between(a, b)
     @distances[Edge.new(a, b)]
   end
 
   def distance_of(path)
-    GetDistance[within: self].of(path)
-  end
-end
-
-class GetDistance < DCI::Context(:within)
-  within.as Map
-
-  def between(from, to)
-    within.distance_between(from, to)
+    path.each_cons(2).inject(0) { |total, (to, from)| total + distance_between(from, to) }
   end
 
-  def of(path)
-    path.reverse.each_cons(2).inject(0) { |total_distance, pair| total_distance + between(*pair) }
+  def neighbors(near:)
+    [south_neighbor_of(near), east_neighbor_of(near)].compact # excludes nil neighbors
   end
 end
 
-class FindShortest < DCI::Context(:from, :to, :city)
-  from.as CurrentIntersection
-  to.as DestinationNode
-  city.as Map
+class FindShortest < DCI::Context(:from, to: DestinationNode, city: Map)
+  def initialize(city:, from: city.root, to: city.destination) super end
 
   def distance
     city.distance_of path
   end
 
-  def path
-    shortest_path_from_city_neighbors << @from
+  def path(from: @from)
+    shortest_neighbor_path(from) << from
   end
 
   private
 
-  def shortest_path_from_city_neighbors
-    from.
-      neighbors(manhattan: @city).
-      map { |neighbor| to.shortest_path from: neighbor, within: @city }.
-      min_by { |path| city.distance_of path }
+  def shortest_neighbor_path(current)
+    city.neighbors(near: current).
+      map { |neighbor| to.shortest_path_from(neighbor, self) }.
+      min_by { |neighbor_path| city.distance_of neighbor_path }
   end
 end
 ```
@@ -102,7 +70,7 @@ end
 
 ## Context methods
 
-### to_proc
+### context#to_proc
 
 Returns call method as a Proc.
 
@@ -118,6 +86,48 @@ Square brackets are alias for call method.
 TransferMoney[from: source_account, to: destination_account][amount: 100]
 ```
 
+### context#rebind(**params)
+Assigns object to role.
+
+```ruby
+add_member = Evaluate.new(to: 'Justice League')
+['Batman', Superman', 'Wonder Woman'].each do |founder|
+  add_member.rebind(member: founder).(recruit: 'Supergirl')
+end
+```
+
+## Context class methods
+
+### klass#call(**params)
+
+A shortcut for instantiating the context by passing the collaborators and then executing the context call method.
+
+```ruby
+Funds::TransferMoney.(from: @account1, to: @account2, amount: 50)
+```
+
+Which is equivalent to:
+
+```ruby
+Funds::TransferMoney.new(from: @account1, to: @account2, amount: 50).call
+```
+
+## DCI::Module
+
+Extention module for supporting procedural code. Define a block with the 'new' method and pass the 'mod' parameter to 'using' keyword.
+
+```ruby
+AwesomeSinging = TypeWrapper::Module.new do |mod| using mod
+  def sing
+    "#{name} sings #{song}"
+  end
+
+  def song
+    "Everything is AWESOME!!!"
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/dijkstra.rb

@@ -1,62 +1,43 @@
 require_relative 'dijkstra/data'
 # See https://github.com/RichOrElse/wrapper-based/blob/master/test/dijkstra_test.rb
 
-module CurrentIntersection
-  def neighbors(manhattan:)
-    east_neighbor = manhattan.east_neighbor_of(self)
-    south_neighbor = manhattan.south_neighbor_of(self)
-    [south_neighbor, east_neighbor].compact # excludes nil neighbors
-  end
-end
-
 module DestinationNode
-  def shortest_path(from:, within:)
-    return [self] if equal? from
-    FindShortest[to: self, from: from, city: within].path
+  def shortest_path_from(neighbor, find_shortest)
+    return [self] if equal? neighbor
+    find_shortest.path(from: neighbor)
   end
 end
 
-module Map
+Map = DCI::Module.new do |mod| using mod
   def distance_between(a, b)
     @distances[Edge.new(a, b)]
   end
 
   def distance_of(path)
-    GetDistance[within: self].of(path)
-  end
-end
-
-class GetDistance < DCI::Context(:within)
-  within.as Map
-
-  def between(from, to)
-    within.distance_between(from, to)
+    path.each_cons(2).inject(0) { |total, (to, from)| total + distance_between(from, to) }
   end
 
-  def of(path)
-    path.reverse.each_cons(2).inject(0) { |total_distance, pair| total_distance + between(*pair) }
+  def neighbors(near:)
+    [south_neighbor_of(near), east_neighbor_of(near)].compact # excludes nil neighbors
   end
 end
 
-class FindShortest < DCI::Context(:from, :to, :city)
-  from.as CurrentIntersection
-  to.as DestinationNode
-  city.as Map
+class FindShortest < DCI::Context(:from, to: DestinationNode, city: Map)
+  def initialize(city:, from: city.root, to: city.destination) super end
 
   def distance
     city.distance_of path
   end
 
-  def path
-    shortest_path_from_city_neighbors << @from
+  def path(from: @from)
+    shortest_neighbor_path(from) << from
   end
 
   private
 
-  def shortest_path_from_city_neighbors
-    from.
-      neighbors(manhattan: @city).
-      map { |neighbor| to.shortest_path from: neighbor, within: @city }.
-      min_by { |path| city.distance_of path }
+  def shortest_neighbor_path(current)
+    city.neighbors(near: current).
+      map { |neighbor| to.shortest_path_from(neighbor, self) }.
+      min_by { |neighbor_path| city.distance_of neighbor_path }
   end
 end

data/examples/money_transfer.rb

@@ -1,5 +1,3 @@
-LogTransaction = Struct.new(:transaction_type, :amount, :account_number)
-
 module Funds
   Insufficient = Class.new(StandardError)
 
@@ -16,33 +14,41 @@ module Funds
     end
   end
 
-  class TransferMoney < DCI::Context(:from, :to)
-    from.as SourceAccount
-    to.as DestinationAccount
+  module Logging
+    def log(transfer_type, amount, account, at: Time.now)
+      self << [transfer_type, account.number, amount, at]
+    end
+  end
+
+  class TransferMoney < DCI::Context(:amount, from: SourceAccount, to: DestinationAccount, events: Logging)
+    def initialize(amount: 0, events: [], **accounts)
+      super
+    end
 
     def withdraw(amount)
       from.decrease_balance_by(amount)
-      LogTransaction["Withdraw", amount, from.number]
+      events.log "Withdrew", amount, from
     end
 
     def deposit(amount)
       to.increase_balance_by(amount)
-      LogTransaction["Deposit", amount, to.number]
+      events.log "Deposited", amount, to
     end
 
-    def accounts
-      [@from, @to]
+    def transfer(amount)
+      withdraw(amount)
+      deposit(amount)
     end
 
-    def call(amount:)
-      transaction_logs = [withdraw(amount), deposit(amount)]
-      [:success, { logs: transaction_logs }, accounts]
+    def call(amount: @amount)
+      transfer(amount)
+      return :success, { log: @events }, accounts
     rescue Funds::Insufficient => error
-      [:failure, { message: error.message }, accounts]
+      return :failure, { message: error.message }, accounts
     end
-  end
 
-  def self.transfer(**where)
-    TransferMoney[**where]
+    def accounts
+      [@from, @to]
+    end
   end
 end

data/lib/wrapper_based/context/casting.rb

@@ -2,12 +2,12 @@ require 'set'
 
 module WrapperBased
   class Context::Casting
-    attr_reader :name, :dci
+    attr_reader :name
 
-    def initialize(name, dci)
+    def initialize(name, wrappers)
       @name = name.to_sym
       @casting = Set.new
-      @dci = dci
+      @wrappers = wrappers
     end
 
     def as(extention)
@@ -15,8 +15,12 @@ module WrapperBased
       self
     end
 
+    def wrapper_for(*args)
+      @wrappers[args]
+    end
+
     def cast_type(type)
-      @dci.wrapper_for type, *@casting
+      wrapper_for type, *@casting
     end
 
     def typecast(actor)

data/lib/wrapper_based/context/producer.rb

@@ -0,0 +1,21 @@
+module WrapperBased
+  class Context
+    class Producer
+      def initialize(wrapper_for)
+        @wrapper_cache = Hash.new do |cache, type_casting|
+          cache[type_casting] = wrapper_for[*type_casting]
+        end
+      end
+
+      def produce(*supporting, **leading, &script)
+        wrappers = @wrapper_cache
+        roles = supporting.map(&:to_sym) | leading.keys
+        Class.new(Context) do
+          roles.each { |role| add_role role, Casting.new(role, wrappers) }
+          leading.each_pair { |role, trait| send(role).as trait }
+          class_eval(&script) unless script.nil?
+        end
+      end # produce method
+    end # Producer class
+  end # Context class
+end # WrapperBased module

data/lib/wrapper_based/context/type_casting.rb

@@ -2,6 +2,12 @@ require 'delegate'
 
 module WrapperBased
   module Context::TypeCasting
+    refine Object do
+      def as_role_played_by(actor)
+        actor
+      end
+    end
+
     refine NilClass do
       def as_role_played_by(actor)
         yield
@@ -10,7 +16,7 @@ module WrapperBased
 
     refine Delegator do
       def as_role_played_by(actor)
-        return replace_role_player_with(actor) if role_type_same_as?(actor)
+        return replace_role_player_with(actor) if actor.instance_of?(role_type)
         yield
       end
 
@@ -19,9 +25,9 @@ module WrapperBased
         self
       end
 
-      def role_type_same_as?(actor)
-        actor.instance_of?(__getobj__.class)
+      def role_type
+        __getobj__.class
       end
-    end
-  end
+    end # Delegator refinement
+  end # TypeCasting module
 end

data/lib/wrapper_based/context.rb

@@ -1,8 +1,13 @@
 module WrapperBased
   class Context
     def initialize(**where)
-      @casting_director = CastingDirector.new(self.class)
-      where.each { |role, player| send :"#{role}=", player }
+      @_casting_director_ = CastingDirector.new(self.class)
+      rebind where
+    end
+
+    def rebind(**where)
+      where.each { |role, player| public_send :"#{role}=", player }
+      self
     end
 
     def to_proc
@@ -18,41 +23,38 @@ module WrapperBased
     class << self
       alias_method :[], :new
 
+      def call(**where)
+        new(where).call
+      end
+
       def cast_as(role, actor)
         send(role).typecast(actor)
       end
 
       protected
 
-      def add_role(role, dci)
+      def add_role(role, casting)
         add_reader_for(role)
         add_writer_for(role)
-        add_to_class_cast_for role, Casting.new(role, dci)
+        add_role_to_class role, casting
       end
 
       def add_reader_for(role)
         define_method(role) do
-          @casting_director.fetch(role) { raise UnassignedRole, "Role '#{role}' is missing.", caller }
+          @_casting_director_.fetch(role) { raise UnassignedRole, "Role '#{role}' is missing.", caller }
         end
       end
 
       def add_writer_for(role)
         role_player = :"@#{role}"
-
         define_method(:"#{role}=") do |actor|
           instance_variable_set(role_player, actor)
-          @casting_director.cast_as role, actor
+          @_casting_director_.cast_as role, actor
         end
       end
 
-      def add_to_class_cast_for(role, casting)
-        role_casting = :"@@#{role}"
-
-        singleton_class.class_eval do
-          define_method(role) { class_variable_get role_casting }
-        end
-
-        class_variable_set role_casting, casting
+      def add_role_to_class(role, casting)
+        define_singleton_method(role) { casting }
       end
     end # class methods
   end # Context class

data/lib/wrapper_based/dci.rb

@@ -1,4 +1,11 @@
-require "wrapper_based"
 require "type_wrapper"
 
-DCI = WrapperBased::Context::Builder.new(TypeWrapper)
+module DCI
+  Module = Class.new(TypeWrapper::Module)
+
+  @@context_producer = WrapperBased::Context::Producer.new(TypeWrapper)
+
+  def self.Context(*args, &block)
+    @@context_producer.produce(*args, &block)
+  end
+end

data/lib/wrapper_based/roles.rb

@@ -0,0 +1,64 @@
+module WrapperBased
+  class Roles < Module
+    Unassigned = Class.new(StandardError)
+
+    def initialize(wrappers, *roles, **where, &block)
+      @casting_agent = (where.keys | roles.map(&:to_sym)).inject {|cast, role| cast[role] = Casting.new(role, wrappers) }
+      @casting_agent.keys.each { |role| add_role role }
+      where.each_pair {|role, trait| @casting[role].as trait }
+      define_casting_director(@casting_agent)
+      include InstanceMethods
+    end
+
+    def cast_as role, actor
+
+    end
+
+    def defing_casting_director(casting_agent)
+      define_method(:_casting_director_) { @_casting_director ||= CastingDirector.new(casting_agent) }
+    end
+
+    def cast_as(role, actor)
+      @casting[role].typecast actor
+    end
+
+    def add_role(role)
+      add_reader_for(role)
+      add_writer_for(role)
+    end
+
+    def add_reader_for(role)
+      define_method(role) do
+        _casting_director_.fetch(role) { raise Roles::Unassigned, "Role '#{role}' is missing.", caller }
+      end
+    end
+
+    def add_writer_for(role)
+      role_player = :"@#{role}"
+      define_method(:"#{role}=") do |actor|
+        instance_variable_set(role_player, actor)
+        _casting_director_.cast_as role, actor
+      end
+    end
+
+    def add_role_to_class(role, casting)
+      define_singleton_method(role) { casting }
+    end
+
+    def define_casting_director
+      roles = self
+    end
+
+    def included(base)
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      def rebind(**where, &block)
+        where.each { |role, player| public_send :"#{role}=", player }
+        instance_eval &block if block_given?
+        self
+      end
+    end
+  end
+end

data/lib/wrapper_based/version.rb

@@ -1,3 +1,3 @@
 module WrapperBased
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/wrapper_based.rb

@@ -1,9 +1,10 @@
 require "wrapper_based/version"
 require "wrapper_based/context"
-require "wrapper_based/context/builder"
+require "wrapper_based/context/producer"
 require "wrapper_based/context/casting"
 require "wrapper_based/context/type_casting"
 require "wrapper_based/context/casting_director"
+require "wrapper_based/dci"
 
 module WrapperBased
 end

data/wrapper_based.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ritchie Paul Buitre"]
   spec.email         = ["ritchie@richorelse.com"]
 
-  spec.summary       = "Wrapper Based DCI implementation in Ruby."
+  spec.summary       = "Wrapper Based DCI framework for OOP done right."
   spec.homepage      = "https://github.com/RichOrElse/wrapper-based/"
   spec.license       = "MIT"
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.1.0"
 
-  spec.add_runtime_dependency "type_wrapper", "~> 1.0"
+  spec.add_runtime_dependency "type_wrapper", "~> 1.2"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapper_based
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ritchie Paul Buitre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: type_wrapper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,18 +81,18 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- examples/benchmark.rb
 - examples/dijkstra.rb
 - examples/dijkstra/data.rb
 - examples/money_transfer.rb
 - examples/toy_shop.rb
 - lib/wrapper_based.rb
 - lib/wrapper_based/context.rb
-- lib/wrapper_based/context/builder.rb
 - lib/wrapper_based/context/casting.rb
 - lib/wrapper_based/context/casting_director.rb
+- lib/wrapper_based/context/producer.rb
 - lib/wrapper_based/context/type_casting.rb
 - lib/wrapper_based/dci.rb
+- lib/wrapper_based/roles.rb
 - lib/wrapper_based/version.rb
 - wrapper_based.gemspec
 homepage: https://github.com/RichOrElse/wrapper-based/
@@ -118,5 +118,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Wrapper Based DCI implementation in Ruby.
+summary: Wrapper Based DCI framework for OOP done right.
 test_files: []

data/examples/benchmark.rb

@@ -1,27 +0,0 @@
-# Derived from https://tonyarcieri.com/dci-in-ruby-is-completely-broken
-require 'rubygems'
-require 'benchmark/ips'
-require 'wrapper_based'
-
-class ExampleClass
-  def foo; 42; end
-end
-
-module ExampleMixin
-  def foo; 43; end
-end
-
-wrapper = WrapperBased::FORWARDING[ExampleClass, ExampleMixin]
-
-Benchmark.ips do |bm|
-  bm.report("without dci") { ExampleClass.new.foo }
-  bm.report("with wrapper") do
-    wrapper.new(ExampleClass.new).foo
-  end
-  bm.report("with extend") do
-    obj = ExampleClass.new
-    obj.extend(ExampleMixin)
-    obj.foo
-  end
-  bm.compare!
-end

data/lib/wrapper_based/context/builder.rb

@@ -1,20 +0,0 @@
-module WrapperBased
-  class Context::Builder < Module
-    def initialize(wrapper_for)
-      class_variable_set :@@wrapper_for,
-        Hash.new { |cache, type_casting| cache[type_casting] = wrapper_for[*type_casting] }
-    end
-
-    def wrapper_for(*type_casting)
-      class_variable_get(:@@wrapper_for)[type_casting]
-    end
-
-    def Context(*roles, &block)
-      dci = self
-      Class.new(WrapperBased::Context) do
-        roles.each { |role| add_role role, dci }
-        class_eval(&block) unless block.nil?
-      end
-    end
-  end # Context::Builder class
-end # WrapperBased module