rachinations 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d453a7d9164b1dd29813252604b256fc8219f3c
-  data.tar.gz: 4ac7305c010e2b43d2488bceaab5aecf30f2db72
+  metadata.gz: 2d592dfefebc0ebf34afbfdf48a8dae98cae4943
+  data.tar.gz: f941250a99df6971c9e36b13a3b46edd8dd1615c
 SHA512:
-  metadata.gz: 79580ad9cd32113ee03fb3ca7dbe6d6a64cd3de6f40eb98823a8a4337931c34634046f7515071b67c38c82fc66cdbd7cbf29d2e1ed4a66f7c5ffef13ec719354
-  data.tar.gz: e565c119969a4c534adf4b7c6843d9cea5e5e5ef5548438e58152c40c6418f1118cb862b128ec6924fa19e39d05ed4da1186a3fdbc9fa0c3aa17a38750e7f97b
+  metadata.gz: b3f7d29e20cef453c105a4239b24a57fd9cdafac36935551a4eed02cc47cec18dbf552e2823474fe491c8713da914ffc10865b71a60b8c944034f797da74b7e9
+  data.tar.gz: e4c0f8b8090a1d88a0058a2d8499522143f80008621b4e36971515ea09a0eaafab04219b0f4f32582595c5aab96318b4c774c2d459f18437672a55e2a174a89f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rachinations (0.0.7)
+    rachinations (0.0.8)
       activesupport (= 3.0.0)
       fraction (= 0.3.2)
       i18n (= 0.6.11)

data/README.md

@@ -189,8 +189,182 @@ All you need to do is write your diagram in a file whose name ends in `.rb` and
  end
  ```
 
-### Full DSL specification
- **TODO**
+## Full DSL specification
+
+### Diagram creation
+
+**Supported options**
+
+- `name`
+ - Optional
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `mode`
+ - Optional
+ - Supported values: `:default`, `:silent` and `:verbose`
+ - Default value: `:default`
+
+**Examples**
+ - TODO
+  
+
+### Pools, Sources and Sinks
+
+**Supported options**
+
+- `name`
+ - Optional
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `initial_value`
+ - Optional
+ - Type: NATURAL
+ - Default value: `0`
+ - *Note*: Only applicable to Pools.
+
+- `mode`
+ - Optional
+ - Supported values: `:push_any`, `:pull_any`, `:push_all` and `:pull_all`
+ - Default value: `:push_any` for Sources, `:pull_any` for Pools and Sinks.
+
+- `activation`
+ - Optional
+ - Supported values: `:passive`, `:automatic` and `:start`
+ - Default value: `:automatic` for Sources, `:passive` for Pools and Sinks.
+
+- `condition`
+ - Optional
+ - Type: EXPRESSION
+ - Default value: `expr{ true }` (always evaluates to `true`)
+
+- `triggers`
+ - Optional
+ - Type: IDENTIFIER
+ - Default: `Nil`
+ - *Note*: If present, it must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+
+- `triggered_by`
+ - Optional
+ - Type: IDENTIFIER
+ - Default: `Nil`
+ - *Note*: If present, it must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+
+**Examples**
+ - TODO
+
+### Gates
+
+**Supported options**
+
+- `name`
+ - Optional
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `mode`
+ - Optional
+ - Supported values: `:probabilistic` and `:deterministic`
+ - Default value: `:deterministic`
+
+- `activation`
+ - Optional
+ - Supported values: `:passive`, `:automatic` and `:start`
+ - Default value: `:passive`
+
+- `condition`
+ - Optional
+ - Type: EXPRESSION
+ - Default value: `expr{ true }` (always evaluates to `true`)
+
+- `triggers`
+ - Optional
+ - Type: IDENTIFIER
+ - Default: `Nil`
+ - *Note*: If present, it must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+
+- `triggered_by`
+ - Optional
+ - Type: IDENTIFIER
+ - Default: `Nil`
+ - *Note*: If present, it must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+
+**Examples**
+ - TODO
+
+### Converters
+
+**Supported options**
+
+- `name`
+ - Optional
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `mode`
+ - Optional
+ - Supported values: `:push_any`, `:pull_any`, `:push_all` and `:pull_all`
+ - Default value: `:push_all`
+
+- `activation`
+ - Optional
+ - Supported values: `:passive`, `:automatic` and `:start`
+ - Default value: `:passive` 
+
+
+**Examples**
+ - TODO
+
+### Edges
+
+**Supported options**
+
+- `name`
+ - Optional
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `from`
+ - Required
+ - Type: IDENTIFIER
+ - *Note*: It must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+
+- `to`
+ - Required
+ - Type: IDENTIFIER
+ - *Note*: It must be the name of a Diagram element that already exists or that will be added until the end of Diagram definition.
+ 
+- `label`
+ - Optional
+ - Type: POSITIVE REAL
+ - Default value: `1`
+ 
+**Examples**
+ - TODO
+
+### Stop conditions
+
+**Supported options**
+
+- `name`
+ - Optional if this is the only stop condition in the whole Diagram. Required otherwise.
+ - Type: IDENTIFIER
+ - Default value: `Nil`
+ - *Note*: If present, this option must be the first one given.
+
+- `condition`
+ - Required
+ - Type: EXPRESSION
+
+**Examples**
+ - TODO
+
 
 
 

data/lib/rachinations.rb

@@ -13,6 +13,8 @@ require 'rachinations/extras/fifo'
 
 require 'rachinations/domain/diagrams/diagram'
 require 'rachinations/domain/diagrams/verbose_diagram'
+require 'rachinations/domain/diagrams/default_diagram'
+require 'rachinations/domain/diagrams/silent_diagram'
 require 'rachinations/domain/diagrams/non_deterministic_diagram'
 require 'rachinations/dsl/diagram_shorthand_methods'
 require 'rachinations/dsl/bootstrap'

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

@@ -0,0 +1,5 @@
+require 'rachinations/domain/modules/diagrams/default'
+
+class DefaultDiagram < Diagram
+  include ::Default
+end

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

@@ -0,0 +1,7 @@
+require 'rachinations/domain/modules/diagrams/silent'
+
+class SilentDiagram < Diagram
+
+  include ::Silent
+
+end

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

@@ -1,5 +1,3 @@
-# require 'fraction'
-
 module NumberModifiers
 
   # allow user to modify Numbers in order to express

data/lib/rachinations/domain/modules/diagrams/default.rb

@@ -0,0 +1,49 @@
+module Default
+
+  @time = nil
+  @last_round = 0
+
+  def before_run
+
+    @time = Time.now
+
+    print "\n\033[1;32m===== INITIAL STATE =====\e[00m\n\n"
+
+    puts self
+  end
+
+  def after_run
+
+    total_time = ( Time.now - @time )
+
+    total_rounds = @last_round
+
+    print "\033[1;32m====== FINAL STATE ======\e[00m\n\n"
+
+    puts self
+
+    print "\033[1;31m========== END ==========\e[00m\n\n"
+
+    print "Diagram '#{name}' ran for #{total_rounds} rounds.\n"
+
+    if total_time < 1.0
+      print "Total time elapsed: #{(total_time*1000).to_i} milliseconds.\n"
+    else
+      print "Total time elapsed: #{total_time.to_i} seconds.\n"
+    end
+
+
+  end
+
+  def before_round(round_no)
+  end
+
+  def after_round (round_no)
+    @last_round = round_no
+  end
+
+  def sanity_check_message
+    print "\033[1;31m= SAFEGUARD CONDITION REACHED - ABORTING EXECUTION =\e[00m\n\n"
+  end
+
+end

data/lib/rachinations/domain/modules/diagrams/silent.rb

@@ -0,0 +1,18 @@
+module Silent
+
+  def before_run
+  end
+
+  def after_run
+  end
+
+  def before_round(round_no)
+  end
+
+  def after_round (round_no)
+  end
+
+  def sanity_check_message
+  end
+
+end

data/lib/rachinations/domain/modules/diagrams/verbose.rb

@@ -1,18 +1,38 @@
 module Verbose
 
+  @time = nil
+  @last_round = 0
 
   def before_run
+
+    @time = Time.now
+
     print "\n\033[1;32m===== INITIAL STATE =====\e[00m\n\n"
 
     puts self
   end
 
   def after_run
+
+    total_time = ( Time.now - @time )
+
+    total_rounds = @last_round
+
     print "\033[1;32m====== FINAL STATE ======\e[00m\n\n"
 
     puts self
 
     print "\033[1;31m========== END ==========\e[00m\n\n"
+
+    print "Diagram '#{name}' ran for #{total_rounds} rounds.\n"
+
+    if total_time < 1.0
+      print "Total time elapsed: #{(total_time*1000).to_i} milliseconds."
+    else
+      print "Total time elapsed: #{total_time.to_i} seconds."
+    end
+
+
   end
 
   def before_round(round_no)
@@ -20,6 +40,7 @@ module Verbose
   end
 
   def after_round (round_no)
+    @last_round = round_no
     puts self
   end
 

data/lib/rachinations/dsl/bootstrap.rb

@@ -13,8 +13,10 @@ module DSL
       raise BadDSL, "Unknown diagram mode: #{mode.to_s}" unless supported_modes.include? mode
 
       # right now silent and default are the same thing
-      if mode == :default || mode == :silent
-        dia= Diagram.new(Parser.validate_name!(name))
+      if mode == :default
+        dia= DefaultDiagram.new(Parser.validate_name!(name))
+      elsif mode == :silent
+        dia = SilentDiagram.new(Parser.validate_name!(name))
       elsif mode == :verbose || mode == 'verbose'
         dia = VerboseDiagram.new(Parser.validate_name!(name))
       end

data/lib/rachinations/version.rb

@@ -1,3 +1,3 @@
 module Rachinations
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/testing/spec/gate_spec.rb

@@ -184,7 +184,7 @@ describe 'Diagrams with gates' do
 
     it 'probabilistic gates send resources in a non-deterministic way' do
 
-      no_of_turns = 100
+      no_of_turns = 800
 
       d = Diagram.new
 
@@ -204,9 +204,9 @@ describe 'Diagrams with gates' do
       d.run! no_of_turns
 
       # have to deal with probabilities here
-      expect(d.get_node('p1').resource_count).to be_within(10).of(50)
-      expect(d.get_node('p2').resource_count).to be_within(10).of(25)
-      expect(d.get_node('p3').resource_count).to be_within(10).of(25)
+      expect(d.get_node('p1').resource_count).to be_within(50).of(400)
+      expect(d.get_node('p2').resource_count).to be_within(50).of(200)
+      expect(d.get_node('p3').resource_count).to be_within(50).of(200)
 
       # this should work in  most cases
       expect(d.get_node('p2').resource_count).not_to eq(d.get_node('p3').resource_count)

data/testing/spec/release1/dsl_spec.rb

@@ -319,12 +319,12 @@ describe Diagram do
         pool 'p1'
         pool 'p2'
         pool 'p3'
-        sink 's2', :automatic, condition: expr{ p2.resource_count > 30 }
+        sink 's2', :automatic, condition: expr { p2.resource_count > 30 }
         edge from: 's1', to: 'g1'
         edge from: 'g1', to: 'p1'
-        edge 2,from:'g1', to:'p2'
-        edge from:'g1', to:'p3'
-        edge from:'p3', to:'s2'
+        edge 2, from: 'g1', to: 'p2'
+        edge from: 'g1', to: 'p3'
+        edge from: 'p3', to: 's2'
 
       end
 
@@ -362,6 +362,42 @@ describe Diagram do
 
     end
 
+    it 'diagram output modes' do
+      # making sure it doesn't just terminate and print nothing!
+
+      expect {
+
+        d=diagram 'a_diagram', mode: :default do
+          source 's'
+          edge from: 's', to: 'p'
+          pool 'p'
+        end
+        d.run 100
+      }.to output(/total\stime\selapsed/i).to_stdout
+
+
+      expect {
+
+        d=diagram 'a_diagram', mode: :silent do
+          source 's'
+          edge from: 's', to: 'p'
+          pool 'p'
+        end
+        d.run 100
+      }.to output("").to_stdout
+
+      expect {
+
+        d=diagram 'a_diagram', mode: :verbose do
+          source 's'
+          edge from: 's', to: 'p'
+          pool 'p'
+        end
+        d.run 20
+      }.to output(/round/i).to_stdout # in search of a better regex...
+
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rachinations
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Felipe Almeida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,8 +169,10 @@ files:
 - README.md
 - Rakefile
 - lib/rachinations.rb
+- lib/rachinations/domain/diagrams/default_diagram.rb
 - lib/rachinations/domain/diagrams/diagram.rb
 - lib/rachinations/domain/diagrams/non_deterministic_diagram.rb
+- lib/rachinations/domain/diagrams/silent_diagram.rb
 - lib/rachinations/domain/diagrams/verbose_diagram.rb
 - lib/rachinations/domain/edge_collection.rb
 - lib/rachinations/domain/edges/edge.rb
@@ -185,6 +187,8 @@ files:
 - lib/rachinations/domain/modules/common/refiners/number_modifiers.rb
 - lib/rachinations/domain/modules/common/refiners/proc_convenience_methods.rb
 - lib/rachinations/domain/modules/common/schedulable_tasks.rb
+- lib/rachinations/domain/modules/diagrams/default.rb
+- lib/rachinations/domain/modules/diagrams/silent.rb
 - lib/rachinations/domain/modules/diagrams/verbose.rb
 - lib/rachinations/domain/node_collection.rb
 - lib/rachinations/domain/nodes/converter.rb