event_sourced_record 0.0.1

data/lib/generators/event_sourced_record/templates/calculator.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < EventSourcedRecord::Calculator
+  events :<%= event_name.pluralize %>
+
+  def advance_creation(event)
+
+  end
+end

data/lib/generators/event_sourced_record/templates/event_model.rb

@@ -0,0 +1,13 @@
+<% module_namespacing do -%>
+class <%= event_class_name %> < ActiveRecord::Base
+  include EventSourcedRecord::Event
+
+  event_type :creation do
+    # attributes :user_id
+    #
+    # validates :user_id, presence: true
+  end
+end
+<% end -%>
+
+

data/lib/generators/event_sourced_record/templates/observer.rb

@@ -0,0 +1,8 @@
+class <%= class_name %> < ActiveRecord::Observer
+  observe :<%= event_name %>
+
+  def after_create(event)
+    <%= calculator_class_name %>.new(event).run.save!
+  end
+end
+

data/lib/generators/event_sourced_record/templates/projection_model.rb

@@ -0,0 +1,15 @@
+<% module_namespacing do -%>
+class <%= projection_class_name %> < <%= projection_parent_class_name.classify %>
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %><%= ', polymorphic: true' if attribute.polymorphic? %>
+<% end -%>
+  has_many :<%= file_name %>_events
+<% if attributes.any?(&:password_digest?) -%>
+  has_secure_password
+<% end -%>
+
+  validates :uuid, uniqueness: true
+end
+<% end -%>
+
+

data/lib/generators/rspec/service_generator.rb

@@ -0,0 +1,15 @@
+require 'generators/rspec'
+
+module Rspec
+  module Generators # :nodoc:
+    class ServiceGenerator < Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+      check_class_collision suffix: "ServiceTest"
+
+      def create_service_files
+        template 'service_spec.rb', File.join('spec/services', class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end
+

data/lib/generators/rspec/templates/service_spec.rb

@@ -0,0 +1,6 @@
+<% module_namespacing do -%>
+RSpec.describe <%= class_name %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end
+<% end -%>
+

data/lib/generators/test_unit/service_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/test_unit'
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class ServiceGenerator < Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+      check_class_collision suffix: "ServiceTest"
+
+      def create_service_files
+        template 'service_test.rb', File.join('test/services', class_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end
+

data/lib/generators/test_unit/templates/service_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
+<% end -%>

data/test/event_sourced_record/calculator_test.rb

@@ -0,0 +1,111 @@
+require 'test_helper'
+
+class EventSourcedRecord::CalculatorTest < MiniTest::Unit::TestCase
+  def setup
+    @event = SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 12345
+    )
+    assert @event.subscription_uuid
+  end
+  
+  def test_run_when_the_sourced_record_doesnt_exist
+    calculator = SubscriptionCalculator.new(@event.subscription_uuid)
+    subscription = calculator.run
+    assert_equal(1, subscription.bottles_per_shipment)
+    assert_equal(6, subscription.bottles_left)
+    assert_equal(@event.subscription_uuid, subscription.uuid)
+    assert !subscription.persisted? 
+  end
+
+  def test_run_when_the_sourced_record_already_exists
+    subscription = Subscription.create!(uuid: @event.subscription_uuid)
+    calculator = SubscriptionCalculator.new(@event.subscription_uuid)
+    subscription_prime = calculator.run
+    assert_equal(1, subscription_prime.bottles_per_shipment)
+    assert_equal(6, subscription_prime.bottles_left)
+    assert_equal(@event.subscription_uuid, subscription.uuid)
+    assert_equal(subscription.id, subscription_prime.id)
+  end
+
+  def test_run_and_save_when_the_sourced_record_doesnt_exist
+    calculator = SubscriptionCalculator.new(@event.subscription_uuid)
+    subscription = calculator.run.tap(&:save!)
+    assert_equal(1, subscription.bottles_per_shipment)
+    assert_equal(6, subscription.bottles_left)
+    assert_equal(@event.subscription_uuid, subscription.uuid)
+    assert subscription.persisted? 
+  end
+
+  def test_run_and_save_when_the_sourced_record_already_exists
+    subscription = Subscription.create!(uuid: @event.subscription_uuid)
+    subscription_count = Subscription.count
+    calculator = SubscriptionCalculator.new(@event.subscription_uuid)
+    subscription_prime = calculator.run.tap(&:save!)
+    assert_equal(subscription_count, Subscription.count)
+    assert_equal(1, subscription_prime.bottles_per_shipment)
+    assert_equal(6, subscription_prime.bottles_left)
+    assert_equal(@event.subscription_uuid, subscription.uuid)
+    assert_equal(subscription.id, subscription_prime.id)
+  end
+
+  def test_run_with_a_different_event_class
+    event = SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 99999
+    )
+    subscription = SubscriptionCalculator.new(event.subscription_uuid).run.tap(&:save!)
+    assert_equal(6, subscription.bottles_left)
+    Shipment.create!(subscription_id: subscription.id, num_bottles: 3)
+    SubscriptionCalculator.new(event.subscription_uuid).run.tap(&:save!)
+    subscription.reload
+    assert_equal(3, subscription.bottles_left)
+  end
+
+  def test_initialize_by_projection_or_id_or_event_or_associated_event
+    event = SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 99999
+    )
+    subscription = SubscriptionCalculator.new(event).run.tap(&:save!)
+    shipment = Shipment.create!(
+      subscription_id: subscription.id, num_bottles: 3
+    )
+    lookups = [subscription, subscription.id, event, shipment]
+    lookups.each do |lookup|
+      calculator = SubscriptionCalculator.new(lookup)
+      assert_equal(
+        subscription, calculator.run,
+        "Can't find subscription with lookup #{lookup.inspect}"
+      )
+    end
+  end
+
+  def test_run_modifies_a_different_instance
+    event = SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 99999
+    )
+    subscription = SubscriptionCalculator.new(event).run.tap(&:save!)
+    subscription.bottles_left = 999
+    SubscriptionCalculator.new(subscription).run
+    assert_equal(999, subscription.bottles_left)
+  end
+
+  def test_last_event_time
+    event = SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 99999,
+      created_at: Time.utc(2015,1,1)
+    )
+    subscription = SubscriptionCalculator.new(event).run.tap(&:save!)
+    Shipment.create!(
+      subscription_id: subscription.id, num_bottles: 3, 
+      created_at: Time.utc(2015,1,4,12)
+    )
+    calculator = SubscriptionCalculator.new(subscription)
+    result1 = calculator.run(last_event_time: Date.new(2015,1,1))
+    assert_equal(6, result1.bottles_left)
+    result2 = calculator.run(last_event_time: Time.utc(2015,1,4))
+    assert_equal(6, result2.bottles_left)
+    result3 = calculator.run(last_event_time: Time.utc(2015,1,5))
+    assert_equal(3, result3.bottles_left)
+    result4 = calculator.run(last_event_time: Date.new(2015,1,5))
+    assert_equal(3, result4.bottles_left)
+  end
+end

data/test/event_sourced_record/event_test.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+
+class EventSourcedRecord::EventTest < MiniTest::Unit::TestCase
+  def test_creation_auto_generates_uuid
+    event = SubscriptionEvent.creation.new
+    assert event.subscription_uuid
+  end
+
+  def test_creation_data_assignment
+    event = SubscriptionEvent.creation.new(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 999
+    )
+    assert_equal(999, event.data['user_id'])
+    assert_equal(999, event.user_id)
+  end
+
+  def test_creation_accessors_on_reload
+    event = SubscriptionEvent.creation.new(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 999
+    )
+    event.save!
+    event_prime = SubscriptionEvent.find(event.id)
+    assert_equal(999, event_prime.user_id)
+  end
+
+  def test_creation_reserved_attributes
+    event = SubscriptionEvent.creation.new(
+      subscription_uuid: 'asdf'
+    )
+    assert_equal('asdf', event.subscription_uuid)
+    assert_nil event.data['subscription_uuid']
+  end
+
+  def test_creation_dont_accept_random_attribute
+    assert_raises(ActiveRecord::UnknownAttributeError) do 
+      SubscriptionEvent.creation.new(foo: 'bar')
+    end
+    assert_raises(ActiveRecord::UnknownAttributeError) do 
+      SubscriptionEvent.change_settings.new(user_id: 123)
+    end
+  end
+
+  def test_creation_validation_errors
+    event = SubscriptionEvent.creation.new
+    assert !event.valid?
+    assert event.errors[:bottles_per_shipment].include?("can't be blank")
+    assert event.errors[:bottles_per_shipment].include?('is not a number')
+    assert event.errors[:bottles_purchased].include?("can't be blank")
+    assert event.errors[:bottles_purchased].include?('is not a number')
+    assert event.errors[:user_id].include?("can't be blank")
+  end
+
+  def test_creation_valid
+    event = SubscriptionEvent.creation.new(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 999
+    )
+    assert_equal(6, event.bottles_purchased)
+    assert event.valid?
+  end
+
+  def test_creation_create
+    events_before = SubscriptionEvent.count
+    SubscriptionEvent.creation.create!(
+      bottles_per_shipment: 1, bottles_purchased: 6, user_id: 999
+    )
+    assert_equal(events_before + 1, SubscriptionEvent.count)
+  end
+
+  def test_creation_settable_attributes
+    event = SubscriptionEvent.creation.new
+    event.bottles_per_shipment = 1
+    assert_equal(1, event.bottles_per_shipment)
+  end
+
+  def test_change_settings_validation_errors
+    event = SubscriptionEvent.change_settings.new
+    assert !event.valid?
+    assert event.errors[:bottles_per_shipment].include?('is not a number')
+  end
+
+  def test_change_settings_valid
+    event = SubscriptionEvent.change_settings.new(:bottles_per_shipment => 2)
+    assert event.valid?
+  end
+
+  def test_new_without_scope
+    event = SubscriptionEvent.new(
+      event_type: 'creation', bottles_per_shipment: 1, bottles_purchased: 6, 
+      user_id: 999
+    )
+    assert event.valid?
+  end
+
+  def test_event_type_required
+    event = SubscriptionEvent.new
+    assert !event.valid?
+    assert event.errors[:event_type].include?("can't be blank")
+  end
+
+  def test_event_type_inclusion
+    event = SubscriptionEvent.new(event_type: 'wrong')
+    assert !event.valid?
+    assert event.errors[:event_type].include?("is not a valid event type")
+  end
+
+  def test_event_type_unsettable
+    event = SubscriptionEvent.creation.new
+    assert_raises(EventSourcedRecord::Event::EventTypeImmutableError) do
+      event.event_type = 'change_settings'
+    end
+  end
+end

data/test/generators/calculator_generator_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class EventSourcedRecord::CalculatorGeneratorTest < Rails::Generators::TestCase
+  destination 'tmp/calculator_generator_test'
+  setup :prepare_destination
+  tests EventSourcedRecord::CalculatorGenerator
+
+  setup do
+    @generate_calls = Hash.new { |h,k| h[k] = [] }
+    EventSourcedRecord::CalculatorGenerator.any_instance.stubs(:generate).with { |name, arg_string|
+      @generate_calls[name] << arg_string
+    }
+    run_generator %w(subscription_calculator)
+  end
+
+  test "creates a calculator" do
+    assert_file("app/services/subscription_calculator.rb") do |contents|
+      assert_match(
+        /class SubscriptionCalculator < EventSourcedRecord::Calculator/,
+        contents
+      )
+      assert_match(/def advance_creation\(event\)/, contents)
+    end
+  end
+end

data/test/generators/event_generator_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class EventSourcedRecord::EventGeneratorTest < Rails::Generators::TestCase
+  destination 'tmp/event_generator_test'
+  setup :prepare_destination
+  tests EventSourcedRecord::EventGenerator
+
+  setup do
+    @generate_calls = Hash.new { |h,k| h[k] = [] }
+    EventSourcedRecord::EventGenerator.any_instance.stubs(:generate).with { |name, arg_string|
+      @generate_calls[name] << arg_string
+    }
+    run_generator %w(
+      subscription_event
+      subscription_uuid:string:index
+      event_type:string
+      data:text
+      created_at:datetime
+    )
+  end
+
+  test "creates a migration for the event class" do
+    assert @generate_calls['migration'].include?(
+      "create_subscription_events subscription_uuid:string:index event_type:string data:text created_at:datetime"
+    )
+  end
+
+  test "creates a model for the event class" do
+    assert_file("app/models/subscription_event.rb") do |contents|
+      assert_match(/class SubscriptionEvent < ActiveRecord::Base/, contents)
+      assert_match(/include EventSourcedRecord::Event/, contents)
+      assert_match(/event_type :creation do/, contents)
+    end
+  end
+end

data/test/generators/event_sourced_record_generator_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class EventSourcedRecord::EventSourcedRecordGeneratorTest < Rails::Generators::TestCase
+  destination 'tmp/event_sourced_record_generator_test'
+  setup :prepare_destination
+  tests EventSourcedRecord::EventSourcedRecordGenerator
+
+  setup do
+    @generate_calls = Hash.new { |h,k| h[k] = [] }
+    EventSourcedRecord::EventSourcedRecordGenerator.any_instance.stubs(:generate).with { |name, arg_string|
+      @generate_calls[name] << arg_string
+    }
+    run_generator %w(
+      ShampooSubscription
+      user_id:integer
+      bottles_per_shipment:integer
+      bottles_left:integer
+    )
+  end
+
+  test "calls the event generator" do
+    assert @generate_calls['event_sourced_record:event'].include?(
+      "shampoo_subscription_event shampoo_subscription_uuid:string:index event_type:string data:text created_at:datetime"
+    )
+  end
+
+  test "calls the projection generator" do
+    assert @generate_calls['event_sourced_record:projection'].include?(
+      "shampoo_subscription user_id:integer bottles_per_shipment:integer bottles_left:integer"
+    )
+  end
+
+  test "calls the calculator generator" do
+    assert @generate_calls['event_sourced_record:calculator'].include?(
+      "shampoo_subscription_calculator"
+    )
+  end
+end

data/test/generators/observer_generator_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class EventSourcedRecord::ObserverGeneratorTest < Rails::Generators::TestCase
+  Destination = 'tmp/observer_generator_test'
+  destination Destination
+  setup :prepare_destination
+  tests EventSourcedRecord::ObserverGenerator
+
+  setup do
+    config_path = File.join(Destination, 'config')
+    FileUtils.mkdir(config_path)
+    FileUtils.cp("test/generators/templates/application.rb", config_path)
+    run_generator %w(subscription_event_observer)
+  end
+
+  test "creates a file for the observer" do
+    assert_file("app/observers/subscription_event_observer.rb")
+  end
+end

data/test/generators/projection_generator_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class EventSourcedRecord::ProjectionGeneratorTest < Rails::Generators::TestCase
+  destination 'tmp/projection_generator_test'
+  setup :prepare_destination
+  tests EventSourcedRecord::ProjectionGenerator
+
+  setup do
+    @generate_calls = Hash.new { |h,k| h[k] = [] }
+    EventSourcedRecord::ProjectionGenerator.any_instance.stubs(:generate).with { |name, arg_string|
+      @generate_calls[name] << arg_string
+    }
+    run_generator %w(
+      subscription
+      user_id:integer
+      bottles_per_shipment:integer
+      bottles_left:integer
+    )
+  end
+
+  test "creates a migration for the projection class" do
+    assert(
+      @generate_calls['migration'].include?(
+        "create_subscriptions user_id:integer bottles_per_shipment:integer bottles_left:integer uuid:string:uniq"
+      ),
+      @generate_calls.inspect
+    )
+  end
+
+  test "creates a model for the projection class" do
+    assert_file("app/models/subscription.rb") do |contents|
+      assert_match(/class Subscription < ActiveRecord::Base/, contents)
+      assert_match(/validates :uuid, uniqueness: true/, contents)
+    end
+  end
+end

data/test/generators/templates/application.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module ShampooExpress
+  class Application < Rails::Application
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,82 @@
+require 'rails'
+require 'rails/test_help'
+require 'rails/generators/test_case'
+require 'pry'
+require 'mocha/test_unit'
+$: << 'lib'
+require 'event_sourced_record'
+require 'generators/event_sourced_record/event_sourced_record_generator'
+require 'generators/event_sourced_record/calculator_generator'
+require 'generators/event_sourced_record/event_generator'
+require 'generators/event_sourced_record/observer_generator'
+require 'generators/event_sourced_record/projection_generator'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3', :database => 'tmp/test.sqlite3'
+)
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    create_table "shipments", force: true do |t|
+      t.integer  "subscription_id"
+      t.integer  "num_bottles"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+
+    create_table 'subscription_events', :force => true do |t|
+      t.string   "subscription_uuid"
+      t.string   "event_type"
+      t.text     "data"
+      t.datetime "created_at"
+    end
+
+    create_table "subscriptions", force: true do |t|
+      t.integer "user_id"
+      t.integer "bottles_per_shipment"
+      t.integer "bottles_left"
+      t.string  "uuid"
+    end
+  end
+end
+
+class Shipment < ActiveRecord::Base
+end
+
+class SubscriptionEvent < ActiveRecord::Base
+  include EventSourcedRecord::Event
+
+  event_type :creation do
+    attributes :bottles_per_shipment, :bottles_purchased, :user_id
+
+    validates :bottles_per_shipment, presence: true, numericality: true
+    validates :bottles_purchased, presence: true, numericality: true
+    validates :user_id, presence: true
+  end
+
+  event_type :change_settings do
+    attributes :bottles_per_shipment
+
+    validates :bottles_per_shipment, numericality: true
+  end
+end
+
+class Subscription < ActiveRecord::Base
+  has_many :subscription_events
+
+  validates :uuid, uniqueness: true
+end
+
+class SubscriptionCalculator < EventSourcedRecord::Calculator
+  events :subscription_events, :shipments
+
+  def advance_creation(event)
+    @subscription.bottles_per_shipment = event.bottles_per_shipment
+    @subscription.bottles_left = event.bottles_purchased
+  end
+
+  def advance_shipment(shipment)
+    @subscription.bottles_left -= shipment.num_bottles
+  end
+end