jouba 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a0e68b0a8935c5a7b34943bae5e8fa8c978f3d
-  data.tar.gz: b09485abe09d0965c75fb8f5dfdc33ac05a23b87
+  metadata.gz: 15d2afcf883fa6ef14ca062a882155bc9b86b63d
+  data.tar.gz: a3c5d35b6e894ec126a532ee4c66e99c08630c83
 SHA512:
-  metadata.gz: 9a6681a756a9d6d08d6087891c6d93a53102656e3d9ca61c393e089702dfd89e7229ecc167371e8a58de067874cd518f33e46ed29cd1b58a849f25b0f1c10c5d
-  data.tar.gz: 7909d8679c12b9ffaee9778a96b59fa61116d2708501ed2659bff4f3f34e6d6c9b5e1b6f50090ff36c849f936b307b3ea4932d0ce61971a586464bb7335a7459
+  metadata.gz: e68608356450234636279deced5b95ed888ea798e2e5e1de6fc8e80d0568e64fad53f01470e4575a15a2c3c811e2ade46cbf24bec5767c6541549a7ffc9a2c6a
+  data.tar.gz: e78325ceaf57706cb4ba9f97eead6fa09f17aae35283aea62ea1d4fbd0781748abaf06d0c10136db30d63c8a19198ef44a3b7a87ecb5ca8ea6b912cd8fcc195f

data/Gemfile

@@ -1,7 +1,8 @@
 source "http://rubygems.org"
 
-gem 'hashie', '~> 3.3'
-gem 'wisper', '~>1.3'
+gem 'hashie', '~> 3.4.0'
+gem 'wisper', '~>1.6.0'
+gem 'locality-uuid'
 
 group :development do
   gem 'pry', '~> 0'

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     addressable (2.3.6)
     ast (2.0.0)
+    atomic (1.1.99)
     builder (3.2.2)
     coderay (1.1.0)
     descendants_tracker (0.0.4)
@@ -20,7 +21,7 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.2)
+    hashie (3.4.0)
     highline (1.6.21)
     jeweler (2.0.1)
       builder
@@ -33,6 +34,11 @@ GEM
       rdoc
     json (1.8.1)
     jwt (1.2.0)
+    locality-uuid (1.0.0)
+      atomic
+      macaddr
+    macaddr (1.7.1)
+      systemu (~> 2.6.2)
     method_source (0.8.2)
     mini_portile (0.6.1)
     multi_json (1.10.1)
@@ -80,19 +86,21 @@ GEM
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.5.0)
+    systemu (2.6.4)
     thread_safe (0.3.4)
-    wisper (1.3.0)
+    wisper (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
-  hashie (~> 3.3)
+  hashie (~> 3.4.0)
   jeweler (~> 2.0)
+  locality-uuid
   pry (~> 0)
   rdoc (~> 3.12)
   rspec (~> 2.14)
   rubocop (~> 0.23)
   simplecov (~> 0)
-  wisper (~> 1.3)
+  wisper (~> 1.6.0)

data/README.md

@@ -0,0 +1,113 @@
+# jouba
+
+
+```ruby
+  class Customer < Hashie::Dash
+    include Jouba::Aggregate.new(prefix: :on)
+    property :uuid
+    property :name
+
+    def self.create(attributes)
+      Customer.new(uuid: SecureRandom.uuid).tap do |customer|
+        customer.create(attributes.merge(uuid: customer.uuid))
+      end
+    end
+
+    def create(attributes)
+      emit(:created, attributes)
+    end
+
+  private
+
+    def on_created(attributes)
+      update_attributes!(attributes)
+    end
+  end
+
+  class Admin
+    include Jouba::Aggregate.new(prefix: :on) # include Wisper and Anima
+
+    def self.create(attributes)
+      Admin.new(uuid: SecureRandom.uuid).tap do |admin|
+        admin.create(attributes.merge(uuid: customer.uuid))
+      end
+    end
+
+    def create(attributes)
+      emit(:created, attributes)
+    end
+
+  private
+
+    def on_created(attributes)
+      update_attributes!(attributes)
+    end
+  end
+
+
+  Jouba.emit('us.computer1.cpu', :idle, {value: 50})
+  Jouba.stream('us.computer1.cpu').since(1.month.ago).where({value: ->(v) { v >= 20 }})
+
+  Jouba.config.Cache = Jouba::Cache::Memory.new
+  require 'jouba/aggregate'
+  customer_params = { fname: 'foo', lname: 'bar' }
+
+  c = Customer.create(customer_params, true)
+  c.fname # => "foo"
+  c.uuid # => 123
+  c.to_key # => "Customer.123"
+
+  d = Customer.find(c.uuid)
+
+```
+
+```ruby
+  class Store < AR
+    set_table_name :events
+
+    scope :since, -> (time) { where('timestamp >= ?', time) }
+
+    def self.stream(key, params={})
+      where(params).where(key: key)
+    end
+
+    def self.track(key, serialized_event)
+      create serialized_event
+    end
+  end
+
+  Jouba.config.Store = Store
+
+  class UserRepository < AR
+    set_table_name :users
+    # must have a key column
+
+    def on_created(attributes)
+      self.create(attributes)
+    end
+    alias :on_created
+  end
+
+  Wisper.subscribe(UserRepository.new, scope: :Customer)
+```
+
+
+
+## Todo
+- write a how to in english :)
+
+## Contributing to jouba
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 gregory. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/jouba.gemspec

@@ -2,21 +2,21 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: jouba 0.1.0 ruby lib
+# stub: jouba 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jouba"
-  s.version = "0.1.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["gregory"]
-  s.date = "2015-01-02"
+  s.date = "2015-02-03"
   s.description = "Jouba is a tool set for event sourcing: aggregate root, entities and storage"
   s.email = "greg2502@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -25,18 +25,22 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "jouba.gemspec",
     "lib/jouba.rb",
     "lib/jouba/aggregate.rb",
+    "lib/jouba/cache.rb",
     "lib/jouba/event.rb",
-    "lib/jouba/exceptions.rb",
-    "lib/jouba/stores.rb",
+    "lib/jouba/key.rb",
+    "lib/jouba/store.rb",
     "lib/jouba/version.rb",
+    "spec/integration/customer_spec.rb",
     "spec/lib/jouba/aggregate_spec.rb",
+    "spec/lib/jouba/cache_spec.rb",
     "spec/lib/jouba/event_spec.rb",
+    "spec/lib/jouba/key_spec.rb",
     "spec/lib/jouba_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -49,8 +53,9 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<hashie>, ["~> 3.3"])
-      s.add_runtime_dependency(%q<wisper>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<hashie>, ["~> 3.4.0"])
+      s.add_runtime_dependency(%q<wisper>, ["~> 1.6.0"])
+      s.add_runtime_dependency(%q<locality-uuid>, [">= 0"])
       s.add_development_dependency(%q<pry>, ["~> 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.14"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
@@ -59,8 +64,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, ["~> 0"])
       s.add_development_dependency(%q<rubocop>, ["~> 0.23"])
     else
-      s.add_dependency(%q<hashie>, ["~> 3.3"])
-      s.add_dependency(%q<wisper>, ["~> 1.3"])
+      s.add_dependency(%q<hashie>, ["~> 3.4.0"])
+      s.add_dependency(%q<wisper>, ["~> 1.6.0"])
+      s.add_dependency(%q<locality-uuid>, [">= 0"])
       s.add_dependency(%q<pry>, ["~> 0"])
       s.add_dependency(%q<rspec>, ["~> 2.14"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -70,8 +76,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rubocop>, ["~> 0.23"])
     end
   else
-    s.add_dependency(%q<hashie>, ["~> 3.3"])
-    s.add_dependency(%q<wisper>, ["~> 1.3"])
+    s.add_dependency(%q<hashie>, ["~> 3.4.0"])
+    s.add_dependency(%q<wisper>, ["~> 1.6.0"])
+    s.add_dependency(%q<locality-uuid>, [">= 0"])
     s.add_dependency(%q<pry>, ["~> 0"])
     s.add_dependency(%q<rspec>, ["~> 2.14"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/lib/jouba.rb

@@ -1,64 +1,38 @@
+require 'pry'
+require 'forwardable'
 require 'hashie'
-require 'wisper'
+require 'locality-uuid'
 
 require 'jouba/version'
-require 'jouba/exceptions'
+require 'jouba/key'
 require 'jouba/event'
-require 'jouba/aggregate'
-require 'jouba/stores'
+require 'jouba/store'
+require 'jouba/cache'
 
 module Jouba
   module_function
 
-  def adapters_map
-    @adapters_map ||= Hashie::Mash.new do |_, k|
-      fail("Unknown adapter #{k}, valids are: #{@adapters_map.keys.join(' ')}")
-    end
-  end
-
-  def alias_store(alias_name, target)
-    stores[alias_name] = stores[target]
-  end
+  DEFAULTS = {
+    Event: Jouba::Event,
+    Key:   Jouba::Key,
+    Cache: Cache::Null.new,
+    Store: Jouba::EventStore.new
+  }
 
-  def commit(aggregate, event)
-    yield if stores[:events].append_events(aggregate, event)
+  class<<self
+    extend Forwardable
+    def_delegators :config, :Key, :Event, :Cache, :Store
   end
 
   def config
-    @config ||= Hashie::Mash.new { |_, k| fail("Unknown key #{k}, please use configure to set it up") }
-  end
-
-  def find(aggregate_class, aggregate_id)
-    stores[:events].find(aggregate_class, aggregate_id)
-  end
-
-  def locked?(key)
-    stores[:lock].locked?(key)
-  end
-
-  def register_adapter(key, klass)
-    adapters_map[key] = klass
+    @config ||= Hashie::Mash.new { |h, k| h[k] = DEFAULTS[k] }
   end
 
-  def register_store(name)
-    yield(config.stores!.send("#{name}!"))
-    store_config = config.stores[name]
-    adapter = adapters_map[store_config.adapter]
-    stores[name] = adapter.new(store_config)
+  def emit(key , name , data)
+    config.Event.new(key: key, name: name, data: data).track
   end
 
-  def stores
-    @stores ||= Hashie::Mash.new { |_, k| fail("Unknown store #{k}, valids are: #{@stores.keys.join(' ')}") }
-  end
-
-  def with_lock(key)
-    fail(LockException, "#{key} has been locked") if Jouba.locked?(key)
-
-    begin
-      stores[:lock].lock!(key)
-      yield
-    ensure
-      stores[:lock].unlock!(key)
-    end
+  def stream(key, params = {})
+    config.Event.stream(key, params)
   end
 end

data/lib/jouba/aggregate.rb

@@ -1,64 +1,76 @@
-module Jouba
-  module Aggregate
-    attr_reader :uuid
+require 'jouba'
+require 'jouba/cache'
+require 'wisper'
 
-    include Wisper::Publisher
+module Jouba
+  class Aggregate < Module
+    attr_reader :options
 
-    def self.included(target_class)
-      target_class.extend ClassMethods
+    def initialize(options = {})
+      @options = options
+      tap do |mod|
+        mod.define_singleton_method :included do |object|
+          super(object)
+          after_included(object, mod)
+        end
+      end
     end
 
-    module ClassMethods
-      def find(id)
-        Jouba.find(self, id)
+    def after_included(object, mod)
+      object.extend(ClassMethods)
+      object.send :include, InstanceMethods
+      object.send :include, Wisper::Publisher
+      object.define_singleton_method :__module_options__ do
+        mod.options
       end
+    end
 
-      def build_from_events(uuid, events = [])
-        new.tap do |aggregate|
-          aggregate[:uuid] = uuid
-          aggregate.apply_events(events)
+    module InstanceMethods
+      def emit(name, *args)
+        event = Jouba.Event.new(key: to_key, name: name, data: args)
+        apply_event(event)
+        Jouba.Cache.refresh(to_key, self) { event.track }
+        publish(event.name, event.data)
+      end
 
-          after_initialize_blocks.each do |block|
-            block.call(aggregate)
-          end
-        end
+      def replay(event)
+        send __callback_method__(:"#{event.name}"), *event.data
       end
+      alias_method :apply_event, :replay
 
-      def after_initialize(&block)
-        after_initialize_blocks.push(block)
+      def to_key
+        fail 'Please make sure there is a uuid first' unless respond_to?(:uuid) && !uuid.nil?
+        self.class.key_from_uuid(uuid)
       end
 
       private
 
-      def after_initialize_blocks
-        @after_initialize_blocks ||= []
+      def __callback_method__(name)
+        :"#{__callback_prefix__}#{name}"
       end
-    end
 
-    def uuid
-      @uuid ||= SecureRandom.uuid
+      def __callback_prefix__
+        options = self.class.__module_options__
+        options[:prefix].nil? ? '' : "#{options[:prefix]}_"
+      end
     end
 
-    def commit(event_name, args)
-      event = Event.build(event_name, args)
-
-      apply_events(event)
-      Jouba.commit(self, event) do
-        publish(event_name, args)
+    module ClassMethods
+      def replay(events)
+        new.tap { |aggregate| Array(events).each { |event| aggregate.replay(event) } }
       end
-    end
 
-    def commit_with_lock(event_name, args, lock_key)
-      Jouba.with_lock(lock_key) do
-        commit(event_name, args)
+      def find(uuid)
+        key = key_from_uuid(uuid)
+        Jouba.Cache.fetch(key) { replay stream(uuid) }
       end
-    end
 
-    def apply_events(events)
-      [events].flatten.each do |event|
-        next unless respond_to?(event.name.to_sym)
+      def stream(uuid, params = {})
+        Jouba.Event.stream(key_from_uuid(uuid), params)
+      end
 
-        send(event.name.to_sym, event.data)
+      def key_from_uuid(uuid)
+        Jouba.Key.serialize(name, uuid) # => default "ClassName.id"
       end
     end
   end