rddd 0.2.0 → 0.2.1

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rddd.gemspec
 gemspec
 
+gem 'rake'
+
 group :testing do
   gem 'rspec'
   gem 'mocha'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rddd (0.1.3)
+    rddd (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +10,7 @@ GEM
     metaclass (0.0.1)
     mocha (0.12.7)
       metaclass (~> 0.0.1)
+    rake (0.9.2.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -24,5 +25,6 @@ PLATFORMS
 
 DEPENDENCIES
   mocha
+  rake
   rddd!
   rspec

data/README.md

@@ -1,5 +1,7 @@
 [rDDD@sniffer](https://sniffer.io/info/public-project-135230969156499600) - see the code quality on Sniffer.io
 
+[![Build Status](https://travis-ci.org/petrjanda/rddd.png?branch=master)](https://travis-ci.org/petrjanda/rddd)
+
 rddd
 ====
 
@@ -63,9 +65,13 @@ Presenter is the view to the domain data, which is typically aggregation over mu
 language presenter is report. In Rddd, views output plain Ruby hashes, thus no domain object is leaking outside the domain
 itself. The key design goal was to dont let framework later call any additional adhoc methods. Thats why framework doesn't interact with view object directly and pure Hash is returned back.
 
-### Aggregate root, entity, repository
+### Aggregate root
+
+### Entity
+
+### Repository
 
-TBA
+### Factory
 
 ## Planned features
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rddd.rb

@@ -8,13 +8,13 @@ module Rddd
   #
   # ## Usage
   #
-  # Rddd.configure do |config|
-  #   config.service_creator = lambda do |name|
-  #     class_name = "#{name.to_s.camel_case}Service"
+  #   Rddd.configure do |config|
+  #     config.service_creator = lambda do |name|
+  #       class_name = "#{name.to_s.camel_case}Service"
   #
-  #     Rddd::Services.const_get(class_name.to_sym)
+  #       Rddd::Services.const_get(class_name.to_sym)
+  #     end
   #   end
-  # end
   #
   def self.configure
     yield(Rddd::Configuration.instance)

data/lib/rddd/aggregates/entity.rb

@@ -0,0 +1,75 @@
+module Rddd
+  module Aggregates
+    #
+    # Entity is the object with identity, which is unique across the system. Entities
+    # are considered equal only in case their identity is equal discregarding rest 
+    # of the similarities.
+    #
+    # rDDD works agnostic to identifier type. String is used by default.
+    #
+    # Lets create a model of flat and rooms with some basic calculations:
+    #
+    #   class Room < Entity
+    #     def initialize(id, rooms)
+    #       super(id)
+    #
+    #       @rooms = rooms
+    #     end
+    #   end
+    #
+    #   # (see AggregateRoot)
+    #   class Flat < AggregateRoot 
+    #     attr_reader :size
+    #
+    #     def initialize(id, size)
+    #       super(id)
+    #
+    #       @size = size
+    #     end
+    #
+    #     def size
+    #       @rooms.reduce(0) {|total, room| total += room.size }
+    #     end
+    #   end
+    #
+    #   rooms = []
+    #   rooms << Room.new('kitchen', 15)
+    #   rooms << Room.new('living room', 35)
+    #   rooms << Room.new('bed room', 20)
+    #
+    #   flat = Flat.new('A12TY83', rooms)
+    #   
+    #   flat.size #= 70
+    #
+    # As you can see Room entity has its identity (room name) which although isn't
+    # global, but local to the given flat instead. Its natural way how we seem rooms.
+    # We always identify flat/house first and then room within it. Maintaining global
+    # identity is sometimes overkill. Local identity can do just fine.
+    #
+    class Entity
+
+      #
+      # Entity unique identifier.
+      #
+      attr_reader :id
+
+      #
+      # Create entity with given identity.
+      #
+      # @param [String] Entity identity.
+      #
+      def initialize(id)
+        @id = id
+      end
+
+      #
+      # Compare two entities for equality.
+      #
+      # @param [Entity] Entity to compare with.
+      #
+      def ==(other)
+        @id == other.id
+      end
+    end
+  end
+end

data/lib/rddd/aggregates/finders.rb

@@ -0,0 +1,23 @@
+module Rddd
+  module Aggregates
+    module Finders
+      def finder(name)
+        craete_static_method(name) do |*args|
+          repository.send(name, *args)
+        end
+      end
+
+      def repository
+        Repositories::Factory.build(self)
+      end
+
+      private
+
+      def craete_static_method(name, &block)
+        (class << self; self; end).module_eval do
+          define_method name, &block
+        end
+      end
+    end
+  end
+end

data/lib/rddd/aggregates/repositories/base.rb

@@ -0,0 +1,20 @@
+#
+# Repository base class.
+#
+module Rddd
+  module Repositories
+    class Base
+      def create(subject)
+        raise NotImplementedError
+      end
+
+      def update(subject)
+        raise NotImplementedError
+      end
+
+      def delete(subject)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/rddd/aggregates/repositories/factory.rb

@@ -0,0 +1,33 @@
+require 'rddd/configuration'
+require 'rddd/aggregates/repositories/base'
+
+module Rddd
+  module Repositories
+    class NotExistingRepository < RuntimeError
+    end
+
+    #
+    # @private
+    #
+    # Create instance of Repository using the Configration#repository_creator
+    # and passing the class along.
+    #
+    class Factory
+      CreatorNotGiven = Class.new(RuntimeError)
+
+      def self.build(clazz)
+        creator = Configuration.instance.repository_creator
+
+        raise CreatorNotGiven unless creator
+
+        begin
+          repository = creator.call(clazz)
+        rescue
+          raise NotExistingRepository unless repository
+        end
+
+        repository.new
+      end
+    end
+  end
+end

data/lib/rddd/aggregates/root.rb

@@ -0,0 +1,25 @@
+require 'rddd/aggregates/entity'
+require 'rddd/aggregates/finders'
+require 'rddd/aggregates/repositories/factory'
+
+module Rddd
+  module Aggregates
+    #
+    # Domain model Entities (see Entity#initialize) are organized to clusters
+    # called Aggregates. Every Aggregate should have its Root. Aggregate Root
+    # should be only entity from Aggregate visible from outside to guarantee
+    # consistency of all operations performed on the given Aggregate.
+    #
+    class Root < Entity
+      extend Finders
+
+      finder :find
+
+      [:create, :update, :delete].each do |action|
+        define_method action do
+          self.class.repository.send(action, self)  
+        end
+      end
+    end
+  end
+end

data/lib/rddd/configuration.rb

@@ -8,14 +8,6 @@ module Rddd
   class Configuration
     include Singleton
 
-    attr_writer :service_creator, :repository_creator
-
-    def service_creator
-      @service_creator
-    end
-
-    def repository_creator
-      @repository_creator
-    end
+    attr_accessor :service_creator, :repository_creator
   end
 end

data/lib/rddd/{service.rb → services/service.rb}

@@ -14,17 +14,19 @@
 # Remember dummy data goes in, dummy data goes out.
 #
 module Rddd
-  class Service
-    def initialize(attributes = {})
-      @attributes = attributes
-    end
+  module Services
+    class Service
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
 
-    def valid?
-      true
-    end
+      def valid?
+        true
+      end
 
-    def execute
-      raise NotImplementedError  
+      def execute
+        raise NotImplementedError  
+      end
     end
   end
 end

data/lib/rddd/{service_bus.rb → services/service_bus.rb}

@@ -1,4 +1,4 @@
-require 'rddd/service_factory'
+require 'rddd/services/service_factory'
 
 module Rddd
   #
@@ -30,29 +30,32 @@ module Rddd
   # end 
   #
   #
-  module ServiceBus
-    #
-    # Execute the given service.
-    #
-    # @param [Symbol] service to be executed.
-    # @param [Hash] attributes to be passed to the service call.
-    # @param [Block] optional error callback block.
-    #
-    def execute_service(service_name, attributes = {})
-      service = build_service(service_name, attributes)
 
-      unless service.valid?
-        yield(service.errors) if block_given?
-        return
-      end
+  module Services
+    module ServiceBus
+      #
+      # Execute the given service.
+      #
+      # @param [Symbol] service to be executed.
+      # @param [Hash] attributes to be passed to the service call.
+      # @param [Block] optional error callback block.
+      #
+      def execute_service(service_name, attributes = {})
+        service = build_service(service_name, attributes)
 
-      service.execute
-    end
+        unless service.valid?
+          yield(service.errors) if block_given?
+          return
+        end
 
-    private
+        service.execute
+      end
 
-    def build_service(service_name, attributes)
-      ServiceFactory.build(service_name, attributes)
+      private
+
+      def build_service(service_name, attributes)
+        ServiceFactory.build(service_name, attributes)
+      end
     end
   end
 end

data/lib/rddd/services/service_factory.rb

@@ -0,0 +1,23 @@
+require 'rddd/configuration'
+
+module Rddd
+  module Services
+    class ServiceFactory
+      CreatorNotGiven = Class.new(RuntimeError)
+
+      InvalidService = Class.new(RuntimeError)
+
+      def self.build(name, attributes)
+        creator = Configuration.instance.service_creator
+
+        raise CreatorNotGiven unless creator
+
+        begin
+          creator.call(name).new(attributes)
+        rescue
+          raise Rddd::Services::ServiceFactory::InvalidService
+        end
+      end
+    end
+  end
+end

data/lib/rddd/version.rb

@@ -1,3 +1,3 @@
 module Rddd
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/rddd/views/cache.rb

@@ -0,0 +1,24 @@
+module Rddd
+  module Views
+    class Cache
+      def initialize(id, repository)
+        @id = id
+        @repository = repository
+      end
+
+      def read
+        @repository.get(@id) if @repository
+      end
+
+      def invalidate
+        @repository.set(@id, nil)
+      end
+
+      def write(data, timeout)
+        expire_at = timeout ? Time.now + timeout : nil
+
+        @repository.set(@id, data, expire_at)
+      end
+    end
+  end
+end

data/lib/rddd/views/cacheable.rb

@@ -0,0 +1,50 @@
+module Rddd
+  module Views
+    module Caching
+      attr_reader :cache_disabled, :timeout
+
+      def cache(attributes)
+        @cache_disabled = attributes.has_key?(:enabled) ? !attributes[:enabled] : false
+        @timeout = attributes.has_key?(:timeout) ? 60 * attributes[:timeout] : nil
+      end
+    end
+
+    module Cacheable
+      def invalidate
+        cache.invalidate if cache
+      end
+
+      def warm_cache
+        update_cache(build)
+      end
+
+      private
+
+      def read_cache
+        cache.read if cache
+      end
+
+      def update_cache(data)
+        cache.write(data, self.class.timeout) if cache
+      end
+
+      def cache
+        nil unless repository
+
+        @cache ||= Cache.new(cache_id, repository)
+      end
+
+      def cache_id
+        "#{name}#{id}"
+      end
+
+      def repository
+        begin
+          @repository ||= ViewRepository.new
+        rescue
+          nil 
+        end
+      end
+    end
+  end
+end