greedy-dci 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af0618dbc065577434a26c6f9d7de53d7bedc7ee
+  data.tar.gz: 265129f6201d8bb82876bb11f9ebd77b303857a1
+SHA512:
+  metadata.gz: 2def0e4909bdac5170b8d12cd77680859dd30e6c36872afc2184a6d2a6cda1501eb1d0f48618cf8bf39cae50953c5b2f8fff085feb83182c94e734afece9dfbe
+  data.tar.gz: b6a388520724432c9525f77b8c08bbaa8a969a15c7ce253921ea7b4b5e4783e2db272929079cbe10da6a52d53a10c0668f8168958a43a28086112868f4bcb387

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.0
+
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in greedy-dci.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ritchie Paul Buitre
+
+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,106 @@
+# Greedy::DCI
+
+A Toolkit for rapid prototyping of interactors, use cases and service objects, using the DCI paradigm.
+This implementation consumes excessive resources (hence the name) and is **not recommended for production use**.
+
+## What is DCI?
+
+DCI (Data, context and interaction) is a new Role-Based Paradigm for specifying collaborating objects.
+Trygve Reenskaug is the originator best known for formulating the MVC (model–view–controller) pattern.
+
+You can read more about DCI at the following links:
+
+* http://dci.github.io/
+* http://dci-in-ruby.info/
+* http://fulloo.info/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greedy-dci'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greedy-dci
+
+## Usage
+
+```ruby
+require 'greedy-dci'
+
+# Data
+
+Purchase = Struct.new(:toy, :buyer)
+Deliver = Struct.new(:toy, :recipient, :purchase, :status)
+
+# Behaviors
+
+module Buyer
+  def buy(toy)
+    Purchase.new toy, self
+  end
+end
+
+module Recipient
+  def receive(purchased)
+    Deliver.new purchased.toy, self, purchased, :pending
+  end
+end
+
+# Contexts
+
+PurchaseToy = Greedy.context { |purchaser|
+                                using purchaser.as Buyer
+                                using purchaser.as Recipient
+
+                                def call(toy)
+                                  purchased = purchaser.buy toy
+                                  purchaser.receive purchased
+                                end
+                              }
+
+
+GiftToy = Greedy.context { |gifter, giftee|
+                            using gifter.as Buyer
+                            using giftee.as Recipient
+
+                            def call(toy)
+                              gift = gifter.buy toy
+                              giftee.receive gift
+                            end
+                          }
+
+# Interactions
+
+finn_purchase_toy = PurchaseToy[purchaser: 'Finn']
+finn_purchase_toy.call 'Rusty sword'
+finn_purchase_toy.('Armor of Zeldron')
+finn_purchase_toy['The Enchiridion']
+
+['Card Wars', 'Ice Ninja Manual', 'Bacon'].each &GiftToy[gifter: 'Jake', giftee: 'Finn']
+```
+
+[View more examples](https://github.com/RichOrElse/greedy-dci/tree/master/examples)
+
+## 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.
+
+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/RichOrElse/greedy-dci.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "greedy/dci"
+
+# 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/examples/dijkstra/data.rb

@@ -0,0 +1,223 @@
+# Source: http://fulloo.info/Examples/RubyExamples/Dijkstra/DijkstraListing.html
+
+def infinity
+  2**(0.size * 8 -2) -1
+end
+
+#
+# Consider street corners on a Manhattan grid. We want to find the
+# minimal path from the most northeast city to the most
+# southeast city. Use Dijstra's algorithm
+#
+
+# Data classes
+
+Edge = Struct.new :from, :to
+
+class Node
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def eql?(another_node)
+    # Nodes are == equal if they have the same name. This is explicitly
+    # defined here to call out the importance of the difference between
+    # object equality and identity
+    name == another_node.name
+  end
+
+  def ==(another_node)
+    # Equality used in the Map algorithms is object identity
+    super
+  end
+end
+
+#
+# --- Geometry is the interface to the data class that has all
+# --- the information about the map. This is kind of silly in Ruby
+#
+
+# In the domain model we have a general model of streets and avenues. The notions of
+# an east and south neighbor are not part of the domain model, but are germane to
+# the Dijkstra problem. Though they evaluate to the same thing we use different
+# names to reflect these two different (mental) models of Manhattan streets.
+class ManhattanGeometry
+  def east_neighbor_of(a) end
+  def south_neighbor_of(a) end
+  def root; end
+  def destination; end
+  def nodes; @nodes end
+end
+
+class ManhattanGeometry1 < ManhattanGeometry
+  def initialize
+    super
+
+    @nodes, @distances = [], {}
+
+    names = %w(a b c d a b g h i)
+
+    3.times do |i|
+      3.times do |j|
+        @nodes << Node.new(names[(i*3)+j])
+      end
+    end
+
+    # Aliases to help set up the grid. Grid is of Manhattan form:
+    #
+    #    a - 2 - b - 3 - c
+    #    |       |       |
+    #    1       2       1
+    #    |       |       |
+    #    d - 1 - e - 1 - f
+    #    |               |
+    #    2               4
+    #    |               |
+    #    g - 1 - h - 2 - i
+    #
+
+    %w(a b c d e f g h i).each_with_index do |name, index|
+      instance_variable_set :"@#{name}", @nodes[index]
+    end
+
+    9.times do |i|
+      9.times do |j|
+        @distances[Edge.new(@nodes[i], @nodes[j])] = infinity
+      end
+    end
+
+    @distances[Edge.new(@a, @b)] = 2
+    @distances[Edge.new(@b, @c)] = 3
+    @distances[Edge.new(@c, @f)] = 1
+    @distances[Edge.new(@f, @i)] = 4
+    @distances[Edge.new(@b, @e)] = 2
+    @distances[Edge.new(@e, @f)] = 1
+    @distances[Edge.new(@a, @d)] = 1
+    @distances[Edge.new(@d, @g)] = 2
+    @distances[Edge.new(@g, @h)] = 1
+    @distances[Edge.new(@h, @i)] = 2
+    @distances[Edge.new(@d, @e)] = 1
+    @distances.freeze
+
+    @next_down_the_street_from = {}
+    @next_down_the_street_from[@a] = @b
+    @next_down_the_street_from[@b] = @c
+    @next_down_the_street_from[@d] = @e
+    @next_down_the_street_from[@e] = @f
+    @next_down_the_street_from[@g] = @h
+    @next_down_the_street_from[@h] = @i
+    @next_down_the_street_from.freeze
+
+    @next_along_the_avenue_from = Hash.new
+    @next_along_the_avenue_from[@a] = @d
+    @next_along_the_avenue_from[@b] = @e
+    @next_along_the_avenue_from[@c] = @f
+    @next_along_the_avenue_from[@d] = @g
+    @next_along_the_avenue_from[@f] = @i
+    @next_along_the_avenue_from.freeze
+  end
+
+  def east_neighbor_of(a)
+    @next_down_the_street_from[a]
+  end
+
+  def south_neighbor_of(a)
+    @next_along_the_avenue_from[a]
+  end
+
+  def root; @a end
+  def destination; @i end
+end
+
+class ManhattanGeometry2 < ManhattanGeometry
+  def initialize
+    super
+
+    @nodes = %w(a b c d a b g h i j k).map { |name| Node.new name }
+
+    # Aliases to help set up the grid. Grid is of Manhattan form:
+    #
+    #    a - 2 - b - 3 - c - 1 - j
+    #    |       |       |       |
+    #    1       2       1       |
+    #    |       |       |       |
+    #    d - 1 - e - 1 - f       1
+    #    |               |       |
+    #    2               4       |
+    #    |               |       |
+    #    g - 1 - h - 2 - i - 2 - k
+
+    @a = @nodes[0]
+    @b = @nodes[1]
+    @c = @nodes[2]
+    @d = @nodes[3]
+    @e = @nodes[4]
+    @f = @nodes[5]
+    @g = @nodes[6]
+    @h = @nodes[7]
+    @i = @nodes[8]
+    @j = @nodes[9]
+    @k = @nodes[10]
+
+    @distances = {}
+    @nodes.each do |i|
+      @nodes.each do |j|
+        @distances[Edge.new(i, j)] = infinity
+      end
+    end
+
+    @distances[Edge.new(@a, @b)] = 2
+    @distances[Edge.new(@b, @c)] = 3
+    @distances[Edge.new(@c, @f)] = 1
+    @distances[Edge.new(@f, @i)] = 4
+    @distances[Edge.new(@b, @e)] = 2
+    @distances[Edge.new(@e, @f)] = 1
+    @distances[Edge.new(@a, @d)] = 1
+    @distances[Edge.new(@d, @g)] = 2
+    @distances[Edge.new(@g, @h)] = 1
+    @distances[Edge.new(@h, @i)] = 2
+    @distances[Edge.new(@d, @e)] = 1
+    @distances[Edge.new(@c, @j)] = 1
+    @distances[Edge.new(@j, @k)] = 1
+    @distances[Edge.new(@i, @k)] = 2
+    @distances.freeze
+
+    @next_down_the_street_from = {}
+    @next_down_the_street_from[@a] = @b
+    @next_down_the_street_from[@b] = @c
+    @next_down_the_street_from[@c] = @j
+    @next_down_the_street_from[@d] = @e
+    @next_down_the_street_from[@e] = @f
+    @next_down_the_street_from[@g] = @h
+    @next_down_the_street_from[@h] = @i
+    @next_down_the_street_from[@i] = @k
+    @next_down_the_street_from.freeze
+
+    @next_along_the_avenue_from = {}
+    @next_along_the_avenue_from[@a] = @d
+    @next_along_the_avenue_from[@b] = @e
+    @next_along_the_avenue_from[@c] = @f
+    @next_along_the_avenue_from[@d] = @g
+    @next_along_the_avenue_from[@f] = @i
+    @next_along_the_avenue_from[@j] = @k
+    @next_along_the_avenue_from.freeze
+  end
+
+  def east_neighbor_of(a)
+    @next_down_the_street_from[a]
+  end
+
+  def south_neighbor_of(a)
+    @next_along_the_avenue_from[a]
+  end
+
+  def root
+    @a
+  end
+
+  def destination
+    @k
+  end
+end

data/examples/dijkstra.rb

@@ -0,0 +1,68 @@
+require_relative 'dijkstra/data'
+# See https://github.com/RichOrElse/greedy-dci/blob/master/test/dijkstra_test.rb
+
+# Behaviors
+
+module Map
+  def distance_between(a, b)
+    @distances[Edge.new(a, b)]
+  end
+
+  def distance_of(path)
+    Distance[within: self].of(path)
+  end
+end
+
+module CurrentIntersection
+  def neighbors(nearest:)
+    east_neighbor = nearest.east_neighbor_of(self)
+    south_neighbor = nearest.south_neighbor_of(self)
+    [south_neighbor, east_neighbor].compact
+  end
+end
+
+module DestinationNode
+  def shortest_path(from:, within:)
+    return [self] if equal? from
+    Shortest[from: from, to: self, map: within].path
+  end
+end
+
+# Contexts
+
+extend Greedy::DCI
+
+Distance = context do |within|
+  using within.as Map
+
+  def between(a, b)
+    within.distance_between(a, b)
+  end
+
+  def of(path)
+    path.reverse.each_cons(2).inject(0) { |total, pair| total + between(*pair) }
+  end
+end
+
+Shortest = context do |from, to, map|
+  using from.as CurrentIntersection
+  using to.as DestinationNode
+  using map.as Map
+
+  def distance
+    map.distance_of path
+  end
+
+  def path
+    _shortest_path + [from]
+  end
+
+  private
+
+  def _shortest_path
+    from.
+      neighbors(nearest: map).
+      map { |neighbor| to.shortest_path from: neighbor, within: map }.
+      min_by { |path| map.distance_of path }
+  end
+end

data/examples/toy_shop.rb

@@ -0,0 +1,52 @@
+require 'greedy-dci'
+
+# Data
+
+Purchase = Struct.new(:toy, :buyer)
+Deliver = Struct.new(:toy, :recipient, :purchase, :status)
+
+# Behaviors
+
+module Buyer
+  def buy(toy)
+    Purchase.new toy, self
+  end
+end
+
+module Recipient
+  def receive(purchased)
+    Deliver.new purchased.toy, self, purchased, :pending
+  end
+end
+
+# Contexts
+
+PurchaseToy = Greedy.context { |purchaser|
+                                using purchaser.as Buyer
+                                using purchaser.as Recipient
+
+                                def call(toy)
+                                  purchased = purchaser.buy toy
+                                  purchaser.receive purchased
+                                end
+                              }
+
+
+GiftToy = Greedy.context { |gifter, giftee|
+                            using gifter.as Buyer
+                            using giftee.as Recipient
+
+                            def call(toy)
+                              gift = gifter.buy toy
+                              giftee.receive gift
+                            end
+                          }
+
+# Interactions
+
+finn_purchase_toy = PurchaseToy[purchaser: 'Finn']
+finn_purchase_toy.call 'Rusty sword'
+finn_purchase_toy.('Armor of Zeldron')
+finn_purchase_toy['The Enchiridion']
+
+['Card Wars', 'Ice Ninja Manual', 'Bacon'].each &GiftToy[gifter: 'Jake', giftee: 'Finn']

data/greedy-dci.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'greedy/dci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "greedy-dci"
+  spec.version       = Greedy::DCI::VERSION
+  spec.authors       = ["Ritchie Paul Buitre"]
+  spec.email         = ["ritchie@richorelse.com"]
+
+  spec.summary       = "A very tiny DCI (Data, context and interaction) toolkit with true ruby implementation without the boiler plate."
+  spec.description   = "Toolkit for rapid prototyping of interactors, use cases and service objects. Using DCI (Data, context and interaction) the new programming paradigm from the inventor of the MVC pattern. This implementation consumes excessive memory (hence the name) and is not recommended for production."
+  spec.homepage      = "https://github.com/RichOrElse/greedy-dci/"
+  spec.license       = "MIT"
+
+  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.required_ruby_version = ">= 2.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/greedy/dci/role.rb

@@ -0,0 +1,18 @@
+module Greedy
+  module DCI
+    class Role
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def as(responsibility)
+        type = @obj.singleton_class
+        Module.new { refine(type) { prepend responsibility } }
+      end
+
+      def self.to_proc
+        method(:new).to_proc
+      end
+    end
+  end
+end

data/lib/greedy/dci/version.rb

@@ -0,0 +1,5 @@
+module Greedy
+  module DCI
+    VERSION = "1.0.0"
+  end
+end

data/lib/greedy/dci.rb

@@ -0,0 +1,16 @@
+require "greedy/dci/version"
+require "greedy/dci/role"
+
+module Greedy
+  module DCI
+    def context(&block)
+      roles = block.parameters.map &:last
+      -> **where do
+        actors = where.values_at(*roles)
+        Struct.new(*roles) { class_exec(*actors.map(&Role), &block) }.new *actors
+      end
+    end
+  end
+
+  extend DCI
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: greedy-dci
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ritchie Paul Buitre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Toolkit for rapid prototyping of interactors, use cases and service objects.
+  Using DCI (Data, context and interaction) the new programming paradigm from the
+  inventor of the MVC pattern. This implementation consumes excessive memory (hence
+  the name) and is not recommended for production.
+email:
+- ritchie@richorelse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/dijkstra.rb
+- examples/dijkstra/data.rb
+- examples/toy_shop.rb
+- greedy-dci.gemspec
+- lib/greedy/dci.rb
+- lib/greedy/dci/role.rb
+- lib/greedy/dci/version.rb
+homepage: https://github.com/RichOrElse/greedy-dci/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A very tiny DCI (Data, context and interaction) toolkit with true ruby implementation
+  without the boiler plate.
+test_files: []