metacosm 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c77a542532dce2178b3a6e3c879924724ab83eab
-  data.tar.gz: 1df7e65cbec1a351789896f8814340c7d0b2ba6f
+  metadata.gz: 052e0d6b334fd7502342b5facd9cc6925a466df1
+  data.tar.gz: e00f5d01027be65e8f91ff04c8b48665d664eeea
 SHA512:
-  metadata.gz: f526c542c046c94a6768a32e9cdd4b4003fe1809dd124978919d781bb6d1f2c17127b34a6c6dda5900f2e6b01127aaef1a6d8b0dc9edbb58aee399502048bc4b
-  data.tar.gz: efec11ddcc904437cabe20fee6c4f385ff2d197d2d46e648b6853930945ac47582a119de6d89ce47b698e0b06f2036942b0f4f99a0b6ba3148ed181240fb0ac8
+  metadata.gz: 4087a92a6eee8aa00cfb280ac6dd2cdba64bdef2b1fda60e29ae5c31d26ebff3a9b2a66c8bcd3c21e3bd5f4b7214c6c3ef2b2007ef897c36ff3710b5cfff5dd2
+  data.tar.gz: b008d3c6409925ad9f1d601079dd2805b42fd5709b0245a512e1c183d194f8a8032d5407a465592f909e19359512c2734006efbcd26b3953d5f9a65db7fc8f21

data/README.md

@@ -50,16 +50,16 @@ A Fizzbuzz implementation contrived enough to show off many of the features of t
   
     protected
     def fizz
-      FizzEvent.create(value: @counter, counter_id: @id)
+      FizzEvent.create
     end
   
     def buzz
-      BuzzEvent.create(value: @counter, counter_id: @id)
+      BuzzEvent.create
     end
   
     def counter_incremented
       CounterIncrementedEvent.create(
-        value: @counter, 
+        value: @counter,
         counter_id: @id
       )
     end
@@ -73,13 +73,14 @@ A Fizzbuzz implementation contrived enough to show off many of the features of t
     end
   end
   
-  class IncrementCounterCommand < Struct.new(:increment, :counter_id)
+  class IncrementCounterCommand < Command
+    attr_accessor :increment, :counter_id
   end
   
   class IncrementCounterCommandHandler
-    def handle(command)
-      counter = Counter.find_by(command.counter_id)
-      counter.increment!(command.increment)
+    def handle(increment:,counter_id:)
+      counter = Counter.find(counter_id)
+      counter.increment!(increment)
     end
   end
   
@@ -97,61 +98,89 @@ A Fizzbuzz implementation contrived enough to show off many of the features of t
   
     def update_counter_view(counter_id, value)
       counter_view = CounterView.where(counter_id: counter_id).first_or_create
-      counter_view.value = value
+      counter_view.update value: value
     end
   
     private
     def fizz_buzz!(counter_id, n)
-      fire(FizzCommand.new(counter_id, n)) if fizz?(n)
-      fire(BuzzCommand.new(counter_id, n)) if buzz?(n)
+      fire(FizzCommand.create(counter_id: counter_id)) if fizz?(n)
+      fire(BuzzCommand.create(counter_id: counter_id)) if buzz?(n)
     end
   
     def fizz?(n); n % 3 == 0 end
     def buzz?(n); n % 5 == 0 end
   end
   
-  class FizzCommand < Struct.new(:counter_id, :value); end
+  class FizzCommand < Command
+    attr_accessor :counter_id
+  end
+  
   class FizzCommandHandler
-    def handle(command)
-      counter = Counter.find_by(command.counter_id)
+    def handle(counter_id:)
+      counter = Counter.find(counter_id)
       counter.fizz!
     end
   end
   
-  class BuzzCommand < Struct.new(:counter_id, :value); end
+  class BuzzCommand < Command
+    attr_accessor :counter_id
+  end
+  
   class BuzzCommandHandler
-    def handle(command)
-      counter = Counter.find_by(command.counter_id)
+    def handle(counter_id:)
+      counter = Counter.find(counter_id)
       counter.buzz!
     end
   end
   
   class FizzEvent < Event
-    attr_accessor :value, :counter_id
   end
   
   class FizzEventListener < EventListener
-    def receive(event)
+    def receive
       puts "fizz"
     end
   end
   
   class BuzzEvent < Event
-    attr_accessor :value, :counter_id
   end
   
   class BuzzEventListener < EventListener
-    def receive(event)
+    def receive
       puts "buzz"
     end
   end
+````
+
+  Given all this prelude we can run a fizzbuzz "simulation":
+
+````ruby
+  sim = Simulation.current
+  counter_model = Counter.create
+  counter_view = CounterView.find_by(counter_id: counter_model.id)
   
-  class CounterValueQuery
-    def execute(counter_id:)
-      counter = CounterView.find_by(counter_id: counter_id)
-      counter.value
-    end
-  end
+  counter_view.value # => 0
+
+  increment_counter_command = IncrementCounterCommand.create(
+    increment: 1, counter_id: counter_model.id
+  )
+  
+  sim.apply(increment_counter_command)
+
+  counter_view.value # => 1
+
+  100.times { sim.apply(increment_counter_command) }
+
+  sim.events.take(10)
+  # => [CounterCreatedEvent (id: 1, counter_id: 1),
+  #  CounterIncrementedEvent (id: 1, value: 1, counter_id: 1),
+  #  CounterIncrementedEvent (id: 2, value: 2, counter_id: 1),
+  #  CounterIncrementedEvent (id: 3, value: 3, counter_id: 1),
+  #  FizzEvent (id: 1),
+  #  CounterIncrementedEvent (id: 4, value: 4, counter_id: 1),
+  #  CounterIncrementedEvent (id: 5, value: 5, counter_id: 1),
+  #  BuzzEvent (id: 1),
+  #  CounterIncrementedEvent (id: 6, value: 6, counter_id: 1)]
 ````
 
 ## Requirements

data/gemspec.yml

@@ -6,8 +6,8 @@ authors: Joseph Weissman
 email: jweissman1986@gmail.com
 homepage: https://rubygems.org/gems/metacosm
 dependencies:
-  passive_record: ~> 0.2
-  frappuccino: ~> 0.3  
+  passive_record: ~> 0.3
+  frappuccino: ~> 0.3
 development_dependencies:
   bundler: ~> 1.10
   codeclimate-test-reporter: ~> 0.1

data/lib/metacosm.rb

@@ -6,16 +6,9 @@ module Metacosm
   class Model
     include PassiveRecord
     after_create :register_observer, :emit_creation_event
+    after_update :emit_updation_event
 
-    def update(attrs={})
-      attrs.each do |k,v|
-        send("#{k}=",v)
-      end
-
-      emit(updation_event(attrs)) if updated_event_class
-    end
-
-    protected
+    private
     def register_observer
       Simulation.current.watch(self)
     end
@@ -24,6 +17,10 @@ module Metacosm
       emit(creation_event) if created_event_class
     end
 
+    def emit_updation_event
+      emit(updation_event) if updated_event_class
+    end
+
     def attributes_with_external_id
       attrs = to_h
       if attrs.key?(:id)
@@ -34,7 +31,7 @@ module Metacosm
     end
 
     # trim down extenralized attrs for evt
-    def attributes_for_event(klass, additional_attrs={})
+    def attributes_for_event(klass)
       # assume evts attrs are attr_accessible?
       keys_to_keep = klass.instance_methods.find_all do |method|
         method != :== &&
@@ -43,8 +40,7 @@ module Metacosm
       end
 
       attributes_with_external_id.
-        delete_if {|k,v| !keys_to_keep.include?(k) }.
-        merge(additional_attrs)
+        delete_if {|k,v| !keys_to_keep.include?(k) }
     end
 
     def assemble_event(klass, addl_attrs={})
@@ -52,7 +48,11 @@ module Metacosm
     end
 
     def creation_event
-      assemble_event(created_event_class)
+      assemble_event created_event_class
+    end
+
+    def updation_event
+      assemble_event updated_event_class
     end
 
     def created_event_class
@@ -60,10 +60,6 @@ module Metacosm
       Object.const_get(created_event_name) rescue nil
     end
 
-    def updation_event(changed_attrs={})
-      assemble_event(updated_event_class, changed_attrs)
-    end
-
     def updated_event_class
       updated_event_name = self.class.name + "UpdatedEvent"
       Object.const_get(updated_event_name) rescue nil

data/lib/metacosm/support/test_harness.rb

@@ -0,0 +1,104 @@
+module Metacosm
+  module TestHarness
+    class GivenWhenThen < Struct.new(:given_events,:when_command,:then_event_class)
+      include RSpec::Matchers
+
+      def when(*commands)
+        @when_commands ||= []
+        commands.each do |command|
+          @when_commands.push command
+        end
+        self
+      end
+
+      def expect_events(evts)
+        @then_events = evts
+        verify!
+        self
+      end
+
+      def expect_query(query, to_find:)
+        @query = query
+        @expected_query_results = to_find
+        verify!
+        self
+      end
+
+      protected
+
+      def verify!
+        clean_slate!
+        receive_events!
+        fire_commands!
+
+        validate_events!
+        validate_query!
+
+        self
+      end
+
+      private
+
+      def clean_slate!
+        PassiveRecord.drop_all
+        Simulation.current.clear!
+        self
+      end
+
+      def receive_events!
+        unless self.given_events.nil?
+          self.given_events.each do |evt| 
+            sim.receive(evt, record: false)
+          end
+        end
+        self
+      end
+
+      def fire_commands!
+        unless @when_commands.nil?
+          @when_commands.each do |cmd|
+            sim.apply(cmd)
+          end
+        end
+        self
+      end
+
+      def validate_events!
+        if @then_event_class
+          expect(@then_event_class).to eq(sim.events.last.class) 
+        end
+
+        if @then_events
+          expect(@then_events).to match_array(sim.events) 
+        end
+
+        if @then_event_attrs
+          @then_event_attrs.each do |k,v|
+            expect(sim.events.last.send(k)).to eq(v)
+          end
+        end
+
+        self
+      end
+
+      def validate_query!
+        if @query
+          expect(@query.execute).to eq(@expected_query_results)
+        end
+        self
+      end
+
+      def sim
+        @sim ||= Simulation.current
+      end
+    end
+
+    def given_no_activity
+      GivenWhenThen.new
+    end
+
+    def given_events(events)
+      GivenWhenThen.new(events)
+    end
+  end
+end

data/lib/metacosm/version.rb

@@ -1,4 +1,4 @@
 module Metacosm
   # metacosm version
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/metacosm_spec.rb

@@ -12,6 +12,37 @@ describe "a simple simulation (fizzbuzz)" do
       )
     end
 
+    it 'should run the linearized test for the README' do
+      sim = Simulation.current
+      counter_model = Counter.create
+      counter_view = CounterView.find_by(counter_id: counter_model.id)
+      
+      expect(counter_view.value).to eq(0) # => 0
+
+      increment_counter_command = IncrementCounterCommand.create(
+        increment: 1, counter_id: counter_model.id
+      )
+
+      sim.apply(increment_counter_command)
+
+      # model is updated which triggers view changes
+      expect(counter_view.value).to eq(1) # => 1
+
+      100.times { sim.apply(increment_counter_command) }
+
+      expect(sim.events.take(10).map(&:class)).to eq(
+       [CounterCreatedEvent,
+        CounterCreatedEvent,
+        CounterIncrementedEvent,
+        CounterIncrementedEvent,
+        CounterIncrementedEvent,
+        FizzEvent,
+        CounterIncrementedEvent,
+        CounterIncrementedEvent,
+        BuzzEvent,
+        CounterIncrementedEvent])
+    end 
+
     context "one command once" do
       before { simulation.apply(increment_counter) }
 

data/spec/spec_helper.rb

@@ -4,117 +4,13 @@ require 'rspec/its'
 require 'pry'
 require 'ostruct'
 require 'metacosm'
+require 'metacosm/support/test_harness'
 
 include Metacosm
 
 require 'support/fizz_buzz'
 require 'support/village'
 
-class GivenWhenThen < Struct.new(:given_events,:when_command,:then_event_class)
-  include RSpec::Matchers
-
-  def when(*commands)
-    @when_commands ||= []
-    commands.each do |command|
-      @when_commands.push command
-    end
-    self
-  end
-
-  def expect_events(evts)
-    @then_events = evts
-    verify!
-    self
-  end
-
-  def expect_query(query, to_find:)
-    @query = query
-    @expected_query_results = to_find
-    verify!
-    self
-  end
-
-  protected
-
-  def verify!
-    clean_slate!
-    receive_events!
-    fire_commands!
-
-    validate_events!
-    validate_query!
-
-    self
-  end
-
-  private
-
-  def clean_slate!
-    PassiveRecord.drop_all
-    Simulation.current.clear!
-    self
-  end
-
-  def receive_events!
-    unless self.given_events.nil?
-      self.given_events.each do |evt| 
-        sim.receive(evt, record: false)
-      end
-    end
-    self
-  end
-
-  def fire_commands!
-    unless @when_commands.nil?
-      @when_commands.each do |cmd|
-        sim.apply(cmd)
-      end
-    end
-    self
-  end
-
-  def validate_events!
-    if @then_event_class
-      expect(@then_event_class).to eq(sim.events.last.class) 
-    end
-
-    if @then_events
-      expect(@then_events).to match_array(sim.events) 
-    end
-
-    if @then_event_attrs
-      @then_event_attrs.each do |k,v|
-        expect(sim.events.last.send(k)).to eq(v)
-      end
-    end
-
-    self
-  end
-
-  def validate_query!
-    if @query
-      expect(@query.execute).to eq(@expected_query_results)
-    end
-    self
-  end
-
-  def sim
-    @sim ||= Simulation.current
-  end
-end
-
-module Metacosm
-  module SpecHelpers
-    def given_no_activity
-      GivenWhenThen.new
-    end
-
-    def given_events(events)
-      GivenWhenThen.new(events)
-    end
-  end
-end
-
 RSpec.configure do |c|
-  c.include Metacosm::SpecHelpers
+  c.include Metacosm::TestHarness
 end

data/spec/support/fizz_buzz.rb

@@ -36,9 +36,15 @@ end
 
 class CounterView < View
   attr_accessor :value, :counter_id
-  def update_value(new_value)
-    @value = new_value
-    self
+end
+
+class CounterCreatedEvent < Event
+  attr_accessor :counter_id #, :value
+end
+
+class CounterCreatedEventListener < EventListener
+  def receive(counter_id:)
+    CounterView.create(counter_id: counter_id, value: 0)
   end
 end
 
@@ -67,7 +73,7 @@ class CounterIncrementedEventListener < EventListener
 
   def update_counter_view(counter_id, value)
     counter_view = CounterView.where(counter_id: counter_id).first_or_create
-    counter_view.value = value
+    counter_view.update value: value
   end
 
   private
@@ -102,8 +108,7 @@ class BuzzCommandHandler
   end
 end
 
-class FizzEvent < Event
-end
+class FizzEvent < Event; end
 
 class FizzEventListener < EventListener
   def receive
@@ -111,8 +116,7 @@ class FizzEventListener < EventListener
   end
 end
 
-class BuzzEvent < Event
-end
+class BuzzEvent < Event; end
 
 class BuzzEventListener < EventListener
   def receive

data/spec/support/village.rb

@@ -80,7 +80,6 @@ class VillageUpdatedEventListener < EventListener
   end
 end
 
-
 class CreatePersonCommand < Command
   attr_accessor :world_id, :village_id, :person_id, :person_name
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metacosm
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Joseph Weissman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: passive_record
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: frappuccino
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +162,7 @@ files:
 - features/step_definitions/metacosm_steps.rb
 - gemspec.yml
 - lib/metacosm.rb
+- lib/metacosm/support/test_harness.rb
 - lib/metacosm/version.rb
 - metacosm.gemspec
 - schema.png