rddd 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+rddd.sublime*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p194@rddd

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rddd.gemspec
+gemspec
+
+group :testing do
+  gem 'rspec'
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    rddd (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    metaclass (0.0.1)
+    mocha (0.12.7)
+      metaclass (~> 0.0.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rddd!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Petr Janda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+rddd
+====
+
+Ruby DDD (Domain Driven Development) framework
+
+Intention of rddd is to provide basic skeleton for DDD ruby application. Its framework agnostic, although some framework specific extensions might come later to make it easier to start.
+
+## Key goals
+
+* Provide basic DDD elements
+* Support separation of domain from delivery mechanism (MVC framework)
+* Support separation of domain from persistancy mechanism
+
+## Basic elements
+
+As defined in DDD itself, framework has couple basic object types:
+
+* Services - use cases
+* Entities - domain objects with identity
+* Aggregate roots - entities roots to setup consistency boundaries
+* Repositories - abstraction over persistancy providing collections of aggregate roots
+
+Alongside core DDD object types, there is couple supporting ones, mostly factories.
+
+### Service bus
+
+To further enhance the separation of delivery mechanism and domain from each other, every call to the domain service is done through the ```Service bus```. The key design goal is to decouple concrete service implementation from the non-domain code, so they never have to be directly instantiated outside the domain itself. Instead, service bus defines simple protocol for any object, which can call its ```execute``` method with service name and parameters. The instantiation of the service object then becomes implementation detail of domain code, thus leaves the flexibility for alternative solutions within domain.
+
+## Project structure
+
+Recommented project file structure:
+
+    app/entities
+    app/repositories
+    app/services

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rddd.rb

@@ -0,0 +1,3 @@
+require "rddd/version"
+
+module Rddd; end

data/lib/rddd/aggregate_root.rb

@@ -0,0 +1,15 @@
+require 'rddd/entity'
+require 'rddd/repository_factory'
+require 'rddd/aggregate_root_finders'
+
+class AggregateRoot < Entity
+  extend AggregateRootFinders
+
+  finder :find_by_id
+
+  [:create, :update, :delete].each do |action|
+    define_method action do
+      self.class.repository.send(action, self)  
+    end
+  end
+end

data/lib/rddd/aggregate_root_finders.rb

@@ -0,0 +1,11 @@
+module AggregateRootFinders
+  def finder(name)
+    define_singleton_method name do |*args|
+      repository.send(name, *args)
+    end
+  end
+
+  def repository
+    RepositoryFactory.build(self)
+  end
+end

data/lib/rddd/entity.rb

@@ -0,0 +1,11 @@
+class Entity
+  attr_reader :id
+
+  def initialize(id)
+    @id = id
+  end
+
+  def ==(b)
+    @id == b.id
+  end
+end

data/lib/rddd/repository.rb

@@ -0,0 +1,5 @@
+#
+# Repository base class.
+#
+class Repository
+end

data/lib/rddd/repository_factory.rb

@@ -0,0 +1,18 @@
+require 'rddd/repository'
+
+class NotExistingRepository < RuntimeError
+end
+
+class RepositoryFactory
+  def self.build(clazz)
+    repository_name = "#{clazz}Repository"
+    
+    begin
+      repository = const_get(repository_name)
+    rescue
+      raise NotExistingRepository unless repository
+    end
+
+    repository.new
+  end
+end

data/lib/rddd/service.rb

@@ -0,0 +1,22 @@
+#
+# Service is the object to represent a single use case. Service is usually good
+# entry point to the system domain. Its responsibility is to orchestrate the
+# cooperation of multiple entities, in a given order defined by use case.
+#
+# Service takes a list of attributes, which are necessary to execute the given
+# use case. At the end nothing is returned, so service represent the command to
+# the domain, but doesn't return any data back.
+#
+class Service
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def valid?
+    true
+  end
+
+  def execute
+    raise NotImplementedError  
+  end
+end

data/lib/rddd/service_bus.rb

@@ -0,0 +1,57 @@
+require 'rddd/service_factory'
+
+class InvalidService < RuntimeError; end
+
+#
+# Service bus is the central entry point for execution of service within the
+# domain layer. Unless you have a very good reason, services should not be
+# instantiated directly outside the domain layer, as you leave the flexibility
+# on domain itself to choose the correct implementation.
+#
+#
+# ## Usage
+#
+# Service bus as the module could be included to any object which intend to
+# call services within the domain layer.
+#
+#
+# ## Example
+#
+# class ProjectsController
+#   include ServiceBus
+#
+#   def create
+#     execute(:create_project, params) do |errors|
+#       render :new, :errors => errors
+#       return
+#     end
+#
+#     redirect_to projects_path, :notice => 'Project was successfully created!'
+#   end
+# 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_name, attributes = {})    
+    raise InvalidService unless service = build_service(service_name, attributes)
+
+    unless service.valid?
+      yield(service.errors) and return if block_given?
+    end
+
+    service.execute
+  end
+
+  private
+
+  def build_service(service_name, attributes)
+    ServiceFactory.build(service_name, attributes)
+  end
+end

data/lib/rddd/service_factory.rb

@@ -0,0 +1,12 @@
+class ServiceFactory
+  def self.build(name, attributes)
+    class_name = "#{camel_case(name.to_s)}Service"
+
+    Object.const_get(class_name.to_sym).new(attributes)
+  end
+
+  def self.camel_case(string)
+    return string if string !~ /_/ && string =~ /[A-Z]+.*/
+    string.split('_').map{|e| e.capitalize}.join
+  end
+end

data/lib/rddd/version.rb

@@ -0,0 +1,3 @@
+module Rddd
+  VERSION = "0.1.0"
+end

data/rddd.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rddd/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rddd"
+  gem.version       = Rddd::VERSION
+  gem.authors       = ["Petr Janda"]
+  gem.email         = ["petrjanda@me.com"]
+  gem.description   = %q{Ruby DDD framework}
+  gem.summary       = %q{Intention of rddd is to provide basic skeleton for DDD ruby application. Its framework agnostic, although some framework specific extensions might come later to make it easier to start.}
+  gem.homepage      = "http://blog.ngneers.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/spec/integration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'rddd/service'
+require 'rddd/aggregate_root'
+require 'rddd/service_bus'
+require 'rddd/service'
+
+class Project < AggregateRoot
+  attr_accessor :name
+end
+
+class CreateProjectService < Service
+  def execute
+    project = Project.new(@attributes[:id])
+    project.name = @attributes[:name]
+
+    project.create
+  end
+end
+
+class ProjectRepository
+  def create(project)
+
+  end
+end
+
+class ProjectsController
+  include ServiceBus
+
+  def create(params)
+    execute(:create_project, params)
+  end
+end
+
+describe 'CreateProject' do
+  it 'should call project save' do
+    ProjectRepository.any_instance.expects(:create)
+
+    ProjectsController.new.create(:id => 1, :name => 'Rddd')
+  end  
+end

data/spec/lib/aggregate_root_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'rddd/aggregate_root'
+
+describe AggregateRoot do
+  let(:id) { stub('id') }
+  
+  let(:aggregate_root) { AggregateRoot.new(id) }
+
+  it 'should be entity' do
+    aggregate_root.should be_kind_of Entity
+  end
+
+  describe '#find_by_id' do
+    subject { AggregateRoot.find_by_id(id) }
+
+    let(:repository) { stub('repository') }
+
+    before {
+      RepositoryFactory.expects(:build).returns(repository)
+      repository.expects(:find_by_id).with(id) 
+    }
+
+    it { subject }
+  end
+
+  [:create, :update, :delete].each do |action|
+    describe "##{action}" do
+      subject { aggregate_root.send(action) }
+
+      let(:repository) { stub('repository') }
+
+      it 'should call #create on repository' do
+        RepositoryFactory.expects(:build).with(AggregateRoot).returns(repository)
+
+        repository.expects(action).with(subject)
+        
+        subject
+      end
+    end
+  end
+end

data/spec/lib/entity_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'rddd/entity'
+
+describe Entity do
+  it 'should have identity' do
+    entity = Entity.new('1234')
+
+    entity.id.should == '1234'
+  end
+
+  it 'two entities with same identity are equal' do
+    a = Entity.new('1234')
+    b = Entity.new('1234')
+
+    (a == b).should be_true
+  end
+end

data/spec/lib/repository_factory_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rddd/entity'
+require 'rddd/repository_factory'
+
+describe RepositoryFactory do
+  describe '.build' do
+    subject { RepositoryFactory.build(Entity) }
+
+    context 'with existing repository' do
+      before { Object.const_set(:EntityRepository, Class.new) }
+
+      after { Object.class_eval{remove_const :EntityRepository} }
+
+      it 'should return instance of repository' do
+        should be_kind_of EntityRepository
+      end
+    end
+
+    context 'with not existing repository' do
+      it 'should raise NotExistingRepository' do
+        lambda { subject }.should raise_exception NotExistingRepository
+      end
+    end
+  end
+end

data/spec/lib/repository_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'rddd/repository'
+
+describe Repository do
+end

data/spec/lib/service_bus_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'rddd/service_bus'
+
+describe ServiceBus do
+  let(:attributes) { stub('attributes') }
+
+  let(:controller) do
+    stub('controller').tap { |controller| controller.extend ServiceBus }
+  end
+
+  describe '.execute' do
+    subject { controller.execute(:foo, attributes) }
+
+    let(:service) { stub('service', :valid? => true, :execute => nil) }
+
+    context 'existing service' do
+      it do
+        ServiceFactory.expects(:build).with(:foo, attributes).returns(service)
+        service.expects(:execute)
+
+        subject
+      end
+    end
+
+    context 'not-existing service' do
+      it do
+        ServiceFactory.expects(:build).with(:foo, attributes).returns(nil)
+        service.expects(:execute).never
+
+        lambda { subject }.should raise_exception InvalidService
+      end
+    end
+
+    context 'not valid call to service' do
+      context 'without block' do
+        before { service.stubs(:valid?).returns(false) }
+
+        it do
+          ServiceFactory.expects(:build).with(:foo, attributes).returns(service)
+          service.expects(:execute).never
+
+          subject
+        end
+      end
+
+      context 'with error callback block' do
+        let(:errors) { stub('errors') }
+
+        before do
+          service.stubs(:valid?).returns(false)
+          service.stubs(:errors).returns(errors)
+        end
+
+        let(:error_block) { lambda {|errors|} }
+
+        it do
+          ServiceFactory.expects(:build).with(:foo, attributes).returns(service)
+          service.expects(:execute).never
+
+          controller.execute(:foo, attributes, &error_block)
+        end
+      end
+    end
+  end
+end

data/spec/lib/service_factory_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'rddd/service_factory'
+
+describe ServiceFactory do
+  let(:attributes) { stub('attributes') }
+
+  before { Object.const_set(:CreateProjectService, Class.new) }
+
+  after { Object.class_eval {remove_const(:CreateProjectService)} }
+
+  describe '.build' do
+    it do
+      CreateProjectService.expects(:new).with(attributes)
+
+      ServiceFactory.build(:create_project, attributes)
+    end
+  end
+end

data/spec/lib/service_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'rddd/service'
+
+describe Service do
+  let(:attributes) { stub('attributes') }
+
+  describe '#initialize' do
+    subject { Service.new(attributes) }
+
+    it 'should store attributes' do
+      subject.instance_variable_get(:@attributes).should == attributes
+    end
+  end  
+
+  describe '#valid?' do
+    subject { Service.new.valid? }
+    it { should be_true }
+  end
+
+  describe '#execute' do
+    it 'should raise not implemented' do
+      lambda do
+        Service.new(attributes).execute
+      end.should raise_exception(NotImplementedError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rddd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Petr Janda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies: []
+description: Ruby DDD framework
+email:
+- petrjanda@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rddd.rb
+- lib/rddd/aggregate_root.rb
+- lib/rddd/aggregate_root_finders.rb
+- lib/rddd/entity.rb
+- lib/rddd/repository.rb
+- lib/rddd/repository_factory.rb
+- lib/rddd/service.rb
+- lib/rddd/service_bus.rb
+- lib/rddd/service_factory.rb
+- lib/rddd/version.rb
+- rddd.gemspec
+- spec/integration_spec.rb
+- spec/lib/aggregate_root_spec.rb
+- spec/lib/entity_spec.rb
+- spec/lib/repository_factory_spec.rb
+- spec/lib/repository_spec.rb
+- spec/lib/service_bus_spec.rb
+- spec/lib/service_factory_spec.rb
+- spec/lib/service_spec.rb
+- spec/spec_helper.rb
+homepage: http://blog.ngneers.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Intention of rddd is to provide basic skeleton for DDD ruby application.
+  Its framework agnostic, although some framework specific extensions might come later
+  to make it easier to start.
+test_files:
+- spec/integration_spec.rb
+- spec/lib/aggregate_root_spec.rb
+- spec/lib/entity_spec.rb
+- spec/lib/repository_factory_spec.rb
+- spec/lib/repository_spec.rb
+- spec/lib/service_bus_spec.rb
+- spec/lib/service_factory_spec.rb
+- spec/lib/service_spec.rb
+- spec/spec_helper.rb