rachinations 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49ee8fa5ba3a2fd67f645d651f16675e2a93d723
-  data.tar.gz: be88690c64ece75e4d1af590dec1a06837bd914c
+  metadata.gz: b207a47240a7f2ac500c459b3ebf5a3eebbbee31
+  data.tar.gz: a2c6097eeb47737aab5f9b19f0f93221101911e5
 SHA512:
-  metadata.gz: 0159177f5cd1b84731efa5057767eb6317aabd9dd6f082d61d2dfc1d0a62989e3c8900e0595adf84d2d5c7e7371ee6e7e3c5e53d73e1aaa369776c542245b342
-  data.tar.gz: 243693a7ceff066b8649510c3cc7655ab49a1ac633a82633472726a7e050c7ec5bdba5a0eab08610052ef05ade0516d1a07987f7224ef465e8ea108f5ec82611
+  metadata.gz: 3742c0dde3133a7776eaf8b7d08f134d7355806012f3f974952b46c0d32da999b4573eb75ca1aebfa7cbb7e29267d4ed9705935ed85cf9938793108139a5bc83
+  data.tar.gz: 2b90e71c41aad90e5858b9682d84be9a9ace1d7b45569d1956a1b3e512df16c33a3dee7b86e199a09b4c2f59a49f606ad685ddd36fa588e5802ed726f18752af

data/Gemfile

@@ -1,19 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rachinations.gemspec
-gemspec
-
-
-# ruby '2.1.1'
-#
-# gem 'rake'
-# gem 'activesupport','3.0.0'
-# gem 'i18n'
-# gem 'minitest'
-# gem 'minitest-reporters'
-# gem 'rspec'
-# gem 'cucumber'
-# gem 'coveralls', require: false
-
-
-
+gemspec

data/Gemfile.lock

@@ -4,6 +4,7 @@ PATH
     rachinations (0.0.3)
       activesupport (= 3.0.0)
       i18n (= 0.6.11)
+      weighted_distribution
 
 GEM
   remote: https://rubygems.org/
@@ -65,6 +66,7 @@ GEM
       tins (~> 1.0)
     thor (0.19.1)
     tins (1.3.0)
+    weighted_distribution (1.0.0)
 
 PLATFORMS
   ruby

data/lib/rachinations/domain/diagrams/diagram.rb

@@ -8,13 +8,14 @@ class Diagram
 
   attr_accessor :name, :max_iterations, :nodes, :edges
 
-  def initialize(name)
+  def initialize(name='Anonymous diagram')
     @nodes = NodeCollection.new
     @edges = EdgeCollection.new
     @name = name
     @max_iterations = 999
   end
 
+
   def get_node(name)
 
     nodes.each do |node|
@@ -26,12 +27,36 @@ class Diagram
     raise RuntimeError, "Node with name='#{name}' not found."
   end
 
+  def get_edge(name)
+    edges.each do |edge|
+      if edge.name == name
+        return edge
+      end
+    end
+
+    raise RuntimeError, "Edge with name='#{name}' not found."
+  end
+
   def add_node!(node_klass, params)
 
     params.store(:diagram, self)
 
+    #if there's a condition, return it, otherwise return default condition
+    condition = params.delete(:condition) { lambda { true } }
+
+    #similarly, if nodes are supposed to be triggered by another node
+    triggered_by = params.delete(:triggered_by) { nil }
+
     node = node_klass.new(params)
 
+    node.attach_condition &condition
+
+    if !triggered_by.nil?
+      # ask the current class (diagram) to evaluate what node it is
+      triggerer = self.send(triggered_by.to_sym)
+      triggerer.attach_trigger(node)
+    end
+
     nodes.push(node)
 
     self
@@ -43,8 +68,8 @@ class Diagram
     params.store(:diagram, self)
 
     #we need to send the actual nodes, not their names
-    from = get_node(params.fetch(:from))
-    to = get_node(params.fetch(:to))
+    from = get_node(params.delete(:from))
+    to = get_node(params.delete(:to))
 
     params.store(:from, from)
     params.store(:to, to)
@@ -78,7 +103,7 @@ class Diagram
 
     i=1
 
-    #if given condition block turned false, it's time to stop
+    # if given condition block turned false, it's time to stop
     while yield i do
 
       break unless sanity_check? i
@@ -106,7 +131,7 @@ class Diagram
   def resource_count(klass=nil)
     total=0
     @nodes.each do |n|
-      total+=n.resource_count(klass)
+      total+=n.resource_count(type: klass)
     end
     total
   end
@@ -128,7 +153,7 @@ class Diagram
 
   def run_first_round!
 
-    enabled_nodes.select { |n| n.automatic? || n.start? }.shuffle.each { |n| n.trigger! }
+    enabled_nodes.select { |node| node.automatic? || node.start? }.shuffle.each { |node| node.trigger! }
 
     commit_nodes!
 
@@ -136,7 +161,7 @@ class Diagram
 
   def run_round!
 
-    enabled_nodes.select { |n| n.automatic? }.shuffle.each { |node| node.trigger! }
+    enabled_nodes.select { |node| node.automatic? }.shuffle.each { |node| node.trigger! }
 
     commit_nodes!
 
@@ -144,26 +169,33 @@ class Diagram
 
   def commit_nodes!
     #only after all nodes have run do we update the actual resources and changes, to be used in the next round.
-    nodes.shuffle.each { |n| n.commit! }
+    nodes.shuffle.each { |node| node.commit! }
+
   end
 
   def enabled_nodes
-    nodes.select{|n| n.enabled? }
+    nodes.select { |node| node.enabled? }
+
   end
 
   #template method
-  def before_round(node_no) end
+  def before_round(node_no)
+  end
 
   #template method
-  def after_round(node_no) end
+  def after_round(node_no)
+  end
 
   #template method
-  def before_run; end
+  def before_run;
+  end
 
   #template method
-  def after_run; end
+  def after_run;
+  end
 
   #template method
-  def sanity_check_message; end
+  def sanity_check_message;
+  end
 
 end

data/lib/rachinations/domain/edges/edge.rb

@@ -1,24 +1,31 @@
 require_relative '../strategies/valid_types'
 require_relative '../../domain/exceptions/no_elements_found'
+require_relative '../../../../lib/rachinations/domain/modules/common/hash_init'
+require_relative '../../../../lib/rachinations/domain/modules/common/refiners/number_modifiers'
 
 class Edge
+  include HashInit
+  using NumberModifiers
+
 
   attr_reader :from, :to, :name, :label, :types
 
 
   def initialize(hsh)
 
-    @name = hsh.fetch(:name)
+    check_options!(hsh)
+
+    params = set_defaults(hsh)
+
+    @name = params.fetch(:name, 'anonymous')
 
-    @from = hsh.fetch(:from)
+    @from = params.fetch(:from)
 
-    @to = hsh.fetch(:to)
+    @to = params.fetch(:to)
 
-    #setting default values if needed.
-    hsh = defaults.merge hsh
+    @label = params.fetch(:label)
 
-    @label = hsh.fetch(:label)
-    @types = hsh.fetch(:types)
+    @types = params.fetch(:types)
 
   end
 
@@ -31,12 +38,12 @@ class Edge
   #
   # @return [Boolean] true in case a ping! on this Edge
   #  would return true. False otherwise.
-  def test_ping?(require_all=false)
+  def test_ping?(require_all:false)
     return false if from.disabled? || to.disabled?
 
     condition = strategy.condition
 
-    available_resources = from.resource_count(&condition)
+    available_resources = from.resource_count(expr: condition)
 
     if available_resources == 0
       false
@@ -45,17 +52,19 @@ class Edge
     elsif available_resources < label && require_all
       false
     else
-      # only some resources are able to pass but it's not require_all
+      # only some resources are able to pass but it's not require_all,
+      # so the ping takes place
       true
     end
 
   end
 
-  # the code is the code but sometimes it helps to specify what action
+  # the code is the same but sometimes it helps to specify what action
   # we are talking about so as to make code more understandable
   alias_method :test_pull?, :test_ping?
   alias_method :test_push?, :test_ping?
 
+
   def supports?(type)
     types.empty? || types.include?(type)
   end
@@ -107,15 +116,14 @@ class Edge
   #
   # @raise [RuntimeError] in case the receiving node or this Edge
   #  won't accept the resource sent.
-  # @param res the resource to send.
+  # @param res [Token] the resource to send.
   def push!(res)
-    raise RuntimeError.new "This Edge does not support type: #{res.type}" unless supports?(res.type)
+    raise RuntimeError, "This Edge does not support type: #{res.type}" unless supports?(res.type)
 
     begin
-      to.put_resource!(res,self)
-    rescue => e
-      # just to make it clear that it bubbles
-      raise RuntimeError.new(e.message+" => "+'Push failed')
+      to.put_resource!(res, self)
+    rescue UnsupportedTypeError
+      raise RuntimeError, "unsupported type"
     end
   end
 
@@ -126,10 +134,12 @@ class Edge
   #  should send.
   # @raise [RuntimeError] in case the other node could provide no resources
   #  that satisfy this condition block.
-  # @return a resource that satisfies the given block.
-  def pull!(&blk)
+  # @return [Token,nil] a Resource that satisfies the given block or nil,
+  #  if the pull was not performed for some reason (e.g. it's probabilistic)
+  def pull!(blk)
+
     begin
-      res=from.take_resource!(&blk)
+      res=from.take_resource!(blk)
     rescue => e
       # just to make it clear that it bubbles
       raise RuntimeError.new("Pull failed")
@@ -156,4 +166,8 @@ class Edge
     }
   end
 
+  def options
+    [:name,:label,:types,:from,:to,:diagram]
+  end
+
 end

data/lib/rachinations/domain/modules/common/hash_init.rb

@@ -33,8 +33,9 @@ module HashInit
     hsh.each_pair do |key, value|
 
       if !options.include_option?(key) && aliases_for(key).none?{|ali| options.include_option?(ali) }
-        raise BadOptions.new "Unknown option in parameter hash: :#{key} "
+        raise BadOptions.new "Class #{self.class}: unknown option in constructor: :#{key} (using HashInit)"
       end
+
     end
 
     #make sure all required ones are there

data/lib/rachinations/domain/modules/common/invariant.rb

@@ -9,8 +9,8 @@ module Invariant
 
 
 
-  def invariant &block
-    raise AssertionError unless yield
+  def invariant(message=nil,&block)
+    raise AssertionError.new(message) unless yield
   end
 
   alias_method :inv, :invariant

data/lib/rachinations/domain/modules/common/refiners/number_modifiers.rb

@@ -0,0 +1,22 @@
+module NumberModifiers
+
+
+  # allow user to modify Numbers in order to express
+  # percentages ( 12.percent ) and also fractions, for
+  # example.
+  refine Fixnum do
+
+    def /(other)
+      fdiv(other)
+    end
+
+    #   # but Fixnums are frozen by default so they can't change state.
+    #   # so that i can know whether the user has explicitly called #percent
+    #   # i would like to add an instance variable to this number
+    def percent
+      fdiv(100)
+    end
+
+  end
+
+end

data/lib/rachinations/domain/nodes/converter.rb

@@ -41,7 +41,7 @@ class Converter < ResourcefulNode
 
     if all?
 
-      if incoming_edges.all? { |edge| edge.test_pull?(true) } && outgoing_edges.all? { |edge| edge.test_push?(true) }
+      if incoming_edges.all? { |edge| edge.test_pull?(require_all: true) } && outgoing_edges.all? { |edge| edge.test_push?(require_all:true) }
         pull_all!
         push_all!
       else
@@ -53,7 +53,7 @@ class Converter < ResourcefulNode
       pull_any!
 
       if in_conditions_met?
-        if outgoing_edges.all? { |edge| edge.test_push?(true) }
+        if outgoing_edges.all? { |edge| edge.test_push?(require_all: true) }
           push_all!
           clear_stored_resources!
         end # converters are always push_all
@@ -94,7 +94,7 @@ class Converter < ResourcefulNode
     #TODO use argument (edge) on the call to super and make sure tests still pass
     # that way it's clearer that it is being passed on to super
     super
-    resources_contributed.store(edge, Fifo.new)
+    resources_contributed.store(edge, Extras::Fifo.new)
     self
   end
 
@@ -153,7 +153,7 @@ class Converter < ResourcefulNode
 
       edge.label.times do
         begin
-          res = edge.pull!(&blk)
+          res = edge.pull!(blk)
         rescue RuntimeError => ex
           # Let's try another Edge, perhaps?
           break
@@ -183,7 +183,7 @@ class Converter < ResourcefulNode
 
       edge.label.times do
         begin
-          res = edge.pull!(&blk)
+          res = edge.pull!(blk)
           res=nil # we do not store the results
         rescue RuntimeError => ex
           raise RuntimeError.new "One edge failed to pull; the whole operation failed."

data/lib/rachinations/domain/nodes/gate.rb

@@ -1,6 +1,83 @@
 require_relative '../../domain/nodes/node'
 require_relative '../../domain/nodes/resourceless_node'
 
+require 'weighted_distribution'
+
 class Gate < ResourcelessNode
 
+
+  def initialize(hsh={})
+    check_options!(hsh)
+    params = set_defaults(hsh)
+
+    @diagram = params[:diagram]
+    @name = params[:name]
+    @activation = params[:activation]
+    @mode = params[:mode]
+    @types = get_types(given_types: params[:types])
+
+    super(hsh)
+  end
+
+  def put_resource!(res,edge)
+
+    inv("Edges must be either all defaults or all probabilities") { outgoing_edges.all?{|e| e.label == 1 } || outgoing_edges.all?{|e| e.label.class == Float} }
+    inv("If probabilities given, their sum must not exceed 1"){ outgoing_edges.reduce(0){|acc,el| acc + el.label } <= 1 || !outgoing_edges.all?{|e| e.label.class == Float}  }
+
+    maybe_edge = pick_one(outgoing_edges)
+
+    if(maybe_edge.nil?)
+      # do nothing - resource has 'vanished' - happens every other day
+    else
+      maybe_edge.push!(res)
+    end
+
+  end
+
+  def to_s
+    "Gate '#{@name}'\n\n"
+  end
+
+  private
+
+  def pick_one(edges)
+
+    if(edges.all?{|e| e.label == 1})
+      #edges is probably an enumerable but only arrays can be sample()'d
+      edges.to_a.sample
+    elsif(edges.all?{|e| e.label.class == Float})
+      #{edge=>weight} is the shape required by WeightedRandomizer
+      weights = edges.reduce(Hash.new){|acc,el| acc[el] = el.label; acc }
+
+      sum = edges.reduce(0){|acc,el|acc + el.label }
+
+      remaining = 1.0 - sum
+
+      #resource 'vanishes'
+      weights[nil] = remaining
+
+      edge_distribution = WeightedDistribution.new(weights)
+      edge_distribution.sample
+    else
+      raise RuntimeError.new('Invalid setup')
+    end
+
+  end
+
+  def options
+    [:name, :diagram, :activation, :mode, :types]
+  end
+
+  def aliases
+    {}
+  end
+
+  def defaults
+    {
+        activation: :passive,
+        mode: :push_any,
+        types: []
+    }
+  end
+
 end

data/lib/rachinations/domain/nodes/node.rb

@@ -6,17 +6,36 @@ class Node
   include Invariant
   include HashInit
 
-  attr_reader :name,:types
+  attr_reader :name, :types
 
+  # Tries to figure out this Node's types based upon what's passed as
+  # parameters. If types were given then just set those as this Node
+  # types. If initial_values were given then try to work out the types
+  # from those.
+  #
+  # @param initial_value [Hash,Fixnum] initial values for this  node
+  # @param given_types [Array] provided types
+  # @return [Array] the computed types for this node
+  def get_types(initial_value: 0, given_types: [])
+    inv { !self.instance_variable_defined?(:@types) }
+
+    actual_types = given_types
+
+    if initial_value.is_a?(Fixnum) && given_types.empty?
+      # nothing to do
+    elsif initial_value == 0 && !given_types.empty?
+      # nothing to do
+    elsif initial_value.is_a?(Hash)
+      initial_value.each_key { |type| actual_types.push(type) }
+    else
+      raise ArgumentError.new
+    end
 
-  def attach_condition(condition)
-    conditions.push(condition)
-  end
+    actual_types.uniq
 
-  def conditions
-    @conditions ||= Array.new
   end
 
+
   def edges
     if @edges.is_a? Array
       @edges
@@ -27,11 +46,11 @@ class Node
   end
 
   def incoming_edges
-    edges.select{|e| e.to == self}
+    edges.select { |e| e.to == self }
   end
 
   def outgoing_edges
-    edges.select{|e| e.from == self}
+    edges.select { |e| e.from == self }
   end
 
   def attach_edge(edge)
@@ -64,46 +83,60 @@ class Node
     types.empty?
   end
 
-  def attach_trigger(trig)
-    triggers.push(trig+[true])
+  def attach_condition(&blk)
+    conditions.push(blk)
   end
 
-  def triggers
-    @triggers ||= Array.new
+  def conditions
+    @conditions = @conditions || Array.new
+    @conditions
   end
 
-  def clear_triggers
-    triggers.each do |t|
-      t[2]=true
-    end
+
+  def attach_trigger(target_node)
+    triggers.push(target_node)
+  end
+
+  def triggers
+    @triggers = @triggers || Array.new
+    @triggers
   end
 
+  # def clear_triggers
+  #   triggers.each do |t|
+  #     t[2]=true
+  #   end
+  # end
+
+  # Call trigger! on each node stored in self.triggers
+  #
   def fire_triggers!
-    triggers.each do |n|
-      if (n[0].is_a? Proc) && n[2]
-        if n[0].call
-          n[2]=false
-          n[1].trigger!
-        end
-      elsif n[0] && n[2]
-        n[2]=false
-        n[1].trigger!
-      end
+    triggers.each do |node|
+      node.trigger!
+      # if (n[0].is_a? Proc) && n[2]
+      #   if n[0].call
+      #     n[2]=false
+      #     n[1].trigger!
+      #   end
+      # elsif n[0] && n[2]
+      #   n[2]=false
+      #   n[1].trigger!
+      # end
     end
   end
 
   def enabled?
-    res=true
-    conditions.each do |cond|
-      if cond.is_a? Proc
-        res=res && cond.call
-      elsif cond === false
+    status=true
+    conditions.each do |condition|
+      if condition.is_a? Proc
+        status = (status && condition.call)
+      elsif condition === false
         return false
-      elsif cond === true
+      elsif condition === true
         # do nothing
       end
     end
-    res
+    status
   end
 
   def disabled?
@@ -111,8 +144,8 @@ class Node
   end
 
   def commit!
-    clear_triggers
-    self
+    # clear_triggers
+    #self
   end
 
   def pull?
@@ -159,7 +192,7 @@ class Node
   # fire triggers.
   #
   # @raise [RuntimeError] in case this node won't take the resource
-  def put_resource!(res,edge=nil)
+  def put_resource!(res, edge=nil)
     raise NotImplementedError, "Please update class #{self.class} to respond to: :#{__callee__}"
   end