rohbau 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d05d28272851e7d359b3640cdb9e4a21250f704
+  data.tar.gz: 183ca9c967b841d7dc8e4bc6dbdd57e222eab5fc
+SHA512:
+  metadata.gz: 9b144522c39a33baa618b912f17e3f9a2a6f743a910194cc052409cd890992a0994eb629da418eb5b5d8cb1816f64159f944c9daada4b55546b1b58f71a86529
+  data.tar.gz: 9e6e8cd4e34c668c81172180d3ca99b64af7d5b32e9b1d19a35a72c420e2ad15eda820b0c122f6529bb2a946fe56c0a1d7dbc854bb5b4e458791edfd661e96f7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - ruby-head
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9.3
+  - jruby
+  - jruby-head
+  - jruby-19mode # JRuby in 1.9 mode
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/c6efc69df9417bda7808
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rohbau.gemspec
+gemspec
+
+if ENV['CODECLIMATE_REPO_TOKEN']
+  gem "codeclimate-test-reporter", :group => :test, :require => nil
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,189 @@
+[github]: https://github.com/neopoly/rohbau
+[doc]: http://rubydoc.info/github/neopoly/rohbau/master/file/README.md
+[gem]: https://rubygems.org/gems/rohbau
+[gem-badge]: https://img.shields.io/gem/v/rohbau.svg
+[travis]: https://travis-ci.org/neopoly/rohbau
+[travis-badge]: https://img.shields.io/travis/neopoly/rohbau.svg?branch=master
+[codeclimate]: https://codeclimate.com/github/neopoly/rohbau
+[codeclimate-climate-badge]: https://img.shields.io/codeclimate/github/neopoly/rohbau.svg
+[codeclimate-coverage-badge]: https://codeclimate.com/github/neopoly/rohbau/badges/coverage.svg
+[inchpages]: https://inch-ci.org/github/neopoly/rohbau
+[inchpages-badge]: https://inch-ci.org/github/neopoly/rohbau.svg?branch=master&style=flat
+
+# Rohbau
+
+[![Travis][travis-badge]][travis]
+[![Gem Version][gem-badge]][gem]
+[![Code Climate][codeclimate-climate-badge]][codeclimate]
+[![Test Coverage][codeclimate-coverage-badge]][codeclimate]
+[![Inline docs][inchpages-badge]][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
+## Description
+
+Rohbau provides a set of patterns used in Domain Driven Design.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rohbau'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rohbau
+
+## Usage
+
+### Runtime
+
+By instantiation of the `RuntimeLoader`, an instance of the `Runtime`is created and stored as a singleton.
+Internal units of the respective component can access this instance by referring to the `RuntimeLoader`.
+By this a place is made where for example memories for in-memory gateway backend implementations can be stored.
+
+#### Examples
+
+Inject a user service to your application
+
+```ruby
+require 'rohbau/runtime'
+require 'rohbau/runtime_loader'
+
+module MyApplication
+  class RuntimeLoader < Rohbau::RuntimeLoader
+    def initialize
+      super(Runtime)
+    end
+  end
+
+  class Runtime < Rohbau::Runtime
+  end
+end
+
+module UserService
+  class RuntimeLoader < Rohbau::RuntimeLoader
+    def initialize
+      super(Runtime)
+    end
+  end
+
+  class Runtime < Rohbau::Runtime
+  end
+end
+
+# Register user service on my application runtime
+MyApplication::Runtime.register :user_service, UserService::RuntimeLoader
+MyApplication::Runtime.plugins # => {:user_service=>UserService::RuntimeLoader}
+
+# Runtimes are not initialized yet
+MyApplication::RuntimeLoader.instance # => nil
+MyApplication::Runtime.plugins[:user_service].instance # => nil
+
+# Boot my application runtime
+MyApplication::RuntimeLoader.running? # => false
+MyApplication::RuntimeLoader.new
+MyApplication::RuntimeLoader.running? # => true
+
+# Runtimes are initialized
+MyApplication::RuntimeLoader.instance # => #<MyApplication::Runtime:0x00000000f5b8d8 @user_service=UserService::RuntimeLoader>
+MyApplication::Runtime.plugins[:user_service].instance # => #<UserService::Runtime:0x00000000b1ecc0>
+
+# Runtimes are singletons
+MyApplication::RuntimeLoader.instance === MyApplication::RuntimeLoader.instance
+MyApplication::Runtime.plugins[:user_service].instance === MyApplication::Runtime.plugins[:user_service].instance
+
+# Terminate my application runtime
+MyApplication::RuntimeLoader.terminate
+MyApplication::RuntimeLoader.running? # => false
+
+```
+
+##### Registrar
+
+Every injected `RuntimeLoader` knows about it's registrar.
+In the example above `UserService::RuntimeLoader` has been injected to `MyApplication::RuntimeLoader`.
+`UserService::RuntimeLoader.registrar` therefore returns `MyApplication::RuntimeLoader`.
+
+##### List of plugins
+
+Accordingly to the sample above `MyApplication::RuntimeLoader` knows about it's registered plugins.
+`MyApplication::RuntimeLoader.plugins` therefore returns `{:user_service => UserService::RuntimeLoader}`.
+
+### ServiceFactory
+
+The `ServiceFactory` is considered the authority for retrieval of service instances.
+It follows partly the service locator / registry pattern.
+
+#### Examples
+
+Register and unregister default service and override with specific service.
+
+```ruby
+require 'rohbau/service_factory'
+
+MyServiceFactory = Class.new(Rohbau::ServiceFactory)
+
+user_service_1 = Struct.new(:users).new([:alice, :bob])
+user_service_2 = Struct.new(:users).new([:jim, :kate])
+
+runtime = Object.new
+registry = MyServiceFactory.new(runtime)
+
+MyServiceFactory.register(:user_service) { user_service_1 }
+registry.user_service.users # => [:alice, :bob]
+
+MyServiceFactory.register(:user_service) { user_service_2 }
+registry.user_service.users # => [:jim, :kate]
+
+MyServiceFactory.unregister(:user_service)
+registry.user_service.users # => [:alice, :bob]
+
+MyServiceFactory.unregister(:user_service)
+registry.user_service # => NoMethodError: undefined method `user_service'
+
+```
+
+Validate registered dependencies
+
+```ruby
+MyServiceFactory.external_dependencies :user_service
+MyServiceFactory.missing_dependencies # => [:user_service] 
+MyServiceFactory.external_dependencies_complied? # => false
+
+MyServiceFactory.register(:user_service) { Object.new } # => :user_service 
+MyServiceFactory.external_dependencies_complied? # => true 
+MyServiceFactory.missing_dependencies # => [] 
+```
+
+## Build README
+
+Make changes to README.md.template, not to README.md
+
+Include examples with
+
+```bash
+include_example example_file_name
+```
+
+Build README.md with
+
+```bash
+  ./bin/build_readme
+```
+
+Always commit README.md.template and README.md together.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md.template

@@ -0,0 +1,119 @@
+[github]: https://github.com/neopoly/rohbau
+[doc]: http://rubydoc.info/github/neopoly/rohbau/master/file/README.md
+[gem]: https://rubygems.org/gems/rohbau
+[gem-badge]: https://img.shields.io/gem/v/rohbau.svg
+[travis]: https://travis-ci.org/neopoly/rohbau
+[travis-badge]: https://img.shields.io/travis/neopoly/rohbau.svg?branch=master
+[codeclimate]: https://codeclimate.com/github/neopoly/rohbau
+[codeclimate-climate-badge]: https://img.shields.io/codeclimate/github/neopoly/rohbau.svg
+[codeclimate-coverage-badge]: https://codeclimate.com/github/neopoly/rohbau/badges/coverage.svg
+[inchpages]: https://inch-ci.org/github/neopoly/rohbau
+[inchpages-badge]: https://inch-ci.org/github/neopoly/rohbau.svg?branch=master&style=flat
+
+# Rohbau
+
+[![Travis][travis-badge]][travis]
+[![Gem Version][gem-badge]][gem]
+[![Code Climate][codeclimate-climate-badge]][codeclimate]
+[![Test Coverage][codeclimate-coverage-badge]][codeclimate]
+[![Inline docs][inchpages-badge]][inchpages]
+
+[Gem][gem] |
+[Source][github] |
+[Documentation][doc]
+
+## Description
+
+Rohbau provides a set of patterns used in Domain Driven Design.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rohbau'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rohbau
+
+## Usage
+
+### Runtime
+
+By instantiation of the `RuntimeLoader`, an instance of the `Runtime`is created and stored as a singleton.
+Internal units of the respective component can access this instance by referring to the `RuntimeLoader`.
+By this a place is made where for example memories for in-memory gateway backend implementations can be stored.
+
+#### Examples
+
+Inject a user service to your application
+
+```ruby
+include_example runtime
+```
+
+##### Registrar
+
+Every injected `RuntimeLoader` knows about it's registrar.
+In the example above `UserService::RuntimeLoader` has been injected to `MyApplication::RuntimeLoader`.
+`UserService::RuntimeLoader.registrar` therefore returns `MyApplication::RuntimeLoader`.
+
+##### List of plugins
+
+Accordingly to the sample above `MyApplication::RuntimeLoader` knows about it's registered plugins.
+`MyApplication::RuntimeLoader.plugins` therefore returns `{:user_service => UserService::RuntimeLoader}`.
+
+### ServiceFactory
+
+The `ServiceFactory` is considered the authority for retrieval of service instances.
+It follows partly the service locator / registry pattern.
+
+#### Examples
+
+Register and unregister default service and override with specific service.
+
+```ruby
+include_example service_factory
+```
+
+Validate registered dependencies
+
+```ruby
+MyServiceFactory.external_dependencies :user_service
+MyServiceFactory.missing_dependencies # => [:user_service] 
+MyServiceFactory.external_dependencies_complied? # => false
+
+MyServiceFactory.register(:user_service) { Object.new } # => :user_service 
+MyServiceFactory.external_dependencies_complied? # => true 
+MyServiceFactory.missing_dependencies # => [] 
+```
+
+## Build README
+
+Make changes to README.md.template, not to README.md
+
+Include examples with
+
+```bash
+include_example example_file_name
+```
+
+Build README.md with
+
+```bash
+  ./bin/build_readme
+```
+
+Always commit README.md.template and README.md together.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs += ['spec', 'lib']
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :spec

data/bin/build_readme

@@ -0,0 +1 @@
+cat README.md.template | etc/build_readme.rb > README.md

data/etc/build_readme.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+template = $stdin.read
+examples = template.scan(/include_example (.*)/).flatten
+
+examples.each do |example|
+  file = "examples/#{example}.rb"
+  if File.exists?(file)
+    replacement = File.read(file)
+    template.gsub!(/include_example #{example}/, replacement)
+  end
+end
+
+$stdout.print template

data/examples/runtime.rb

@@ -0,0 +1,49 @@
+require 'rohbau/runtime'
+require 'rohbau/runtime_loader'
+
+module MyApplication
+  class RuntimeLoader < Rohbau::RuntimeLoader
+    def initialize
+      super(Runtime)
+    end
+  end
+
+  class Runtime < Rohbau::Runtime
+  end
+end
+
+module UserService
+  class RuntimeLoader < Rohbau::RuntimeLoader
+    def initialize
+      super(Runtime)
+    end
+  end
+
+  class Runtime < Rohbau::Runtime
+  end
+end
+
+# Register user service on my application runtime
+MyApplication::Runtime.register :user_service, UserService::RuntimeLoader
+MyApplication::Runtime.plugins # => {:user_service=>UserService::RuntimeLoader}
+
+# Runtimes are not initialized yet
+MyApplication::RuntimeLoader.instance # => nil
+MyApplication::Runtime.plugins[:user_service].instance # => nil
+
+# Boot my application runtime
+MyApplication::RuntimeLoader.running? # => false
+MyApplication::RuntimeLoader.new
+MyApplication::RuntimeLoader.running? # => true
+
+# Runtimes are initialized
+MyApplication::RuntimeLoader.instance # => #<MyApplication::Runtime:0x00000000f5b8d8 @user_service=UserService::RuntimeLoader>
+MyApplication::Runtime.plugins[:user_service].instance # => #<UserService::Runtime:0x00000000b1ecc0>
+
+# Runtimes are singletons
+MyApplication::RuntimeLoader.instance === MyApplication::RuntimeLoader.instance
+MyApplication::Runtime.plugins[:user_service].instance === MyApplication::Runtime.plugins[:user_service].instance
+
+# Terminate my application runtime
+MyApplication::RuntimeLoader.terminate
+MyApplication::RuntimeLoader.running? # => false

data/examples/service_factory.rb

@@ -0,0 +1,21 @@
+require 'rohbau/service_factory'
+
+MyServiceFactory = Class.new(Rohbau::ServiceFactory)
+
+user_service_1 = Struct.new(:users).new([:alice, :bob])
+user_service_2 = Struct.new(:users).new([:jim, :kate])
+
+runtime = Object.new
+registry = MyServiceFactory.new(runtime)
+
+MyServiceFactory.register(:user_service) { user_service_1 }
+registry.user_service.users # => [:alice, :bob]
+
+MyServiceFactory.register(:user_service) { user_service_2 }
+registry.user_service.users # => [:jim, :kate]
+
+MyServiceFactory.unregister(:user_service)
+registry.user_service.users # => [:alice, :bob]
+
+MyServiceFactory.unregister(:user_service)
+registry.user_service # => NoMethodError: undefined method `user_service'

data/examples/service_factory_validation.rb

@@ -0,0 +1,11 @@
+require 'rohbau/service_factory'
+
+MyServiceFactory = Class.new(Rohbau::ServiceFactory)
+
+MyServiceFactory.external_dependencies :user_service
+MyServiceFactory.missing_dependencies # => [:user_service] 
+MyServiceFactory.external_dependencies_complied? # => false
+
+MyServiceFactory.register(:user_service) { Object.new } # => :user_service 
+MyServiceFactory.external_dependencies_complied? # => true 
+MyServiceFactory.missing_dependencies # => [] 

data/lib/rohbau/application.rb

@@ -0,0 +1,70 @@
+module Rohbau
+  module Application
+
+    class RuntimeWrapper
+      def self.wrap(&constructor)
+        wrapper = Class.new do
+          def self.set_constructor(constructor)
+            @constructor = constructor
+            self
+          end
+
+          def self.new(*ignored_args)
+            @constructor.call
+          end
+        end
+
+        wrapper.set_constructor(constructor)
+      end
+    end
+
+    def set_application_runtime(runtime_class)
+      @runtime_class = runtime_class
+    end
+
+    def register_domain(name, namespace)
+      dummy = RuntimeWrapper.wrap do |cls|
+        namespace::Runtime.start
+      end
+
+      @runtime_class.register name, dummy
+
+      domains << namespace
+    end
+
+    def domains
+      @domains ||= []
+    end
+
+    def domain_requests
+      domains.map{|d| d.const_get :Request }
+    end
+
+    def use_case_domains
+      domains.select do |domain|
+        domain.const_defined?('UseCases')
+      end
+    end
+
+    def use_cases(use_case_domain = :all)
+      if use_case_domain == :all
+        domains = use_case_domains
+      else
+        domains = [use_case_domain]
+      end
+
+      domains.inject([]) do |use_cases, domain|
+
+        if domain.const_defined?('UseCases')
+          use_case_namespace = domain.const_get('UseCases')
+          use_case_namespace.constants.each do |use_case_class_name|
+            use_cases << use_case_namespace::const_get(use_case_class_name)
+          end
+        end
+
+        use_cases
+      end
+    end
+
+  end
+end

data/lib/rohbau/default_memory_gateway.rb

@@ -0,0 +1,78 @@
+require 'rohbau/index'
+
+module Rohbau
+  class DefaultMemoryGateway
+
+    def initialize(memory = Index.new, services = {})
+      @memory = memory
+      @services = services
+    end
+
+    def memory
+      @memory
+    end
+
+    def add(entity)
+      @memory.add entity
+    end
+
+    def bulk_add(*entities)
+      @memory.bulk_add(*entities)
+    end
+
+    def get(uid)
+      @memory.get(uid)
+    end
+
+    def update(entity)
+      @memory.update(entity)
+    end
+
+    def delete(uid)
+      @memory.delete(uid)
+    end
+
+    def bulk_delete(*uids)
+      @memory.bulk_delete(*uids)
+    end
+
+    def all
+      @memory.all
+    end
+
+    def size
+      @memory.size
+    end
+
+    protected
+
+    def service(service_name)
+      @services[service_name] || raise(no_service_error service_name)
+    end
+
+    def no_service_error(service_name)
+      NotImplementedError.new("#{service_name} service in #{self.class}")
+    end
+
+    def map(entity_name, entity)
+      gateway = gateway_for_entity(entity_name)
+
+      if entity.uid
+        result = gateway.update(entity)
+      else
+        result = gateway.add(entity)
+      end
+
+      result.uid
+    end
+
+    def unmap(entity_name, uid)
+      gateway_for_entity(entity_name).get(uid)
+    end
+
+    def gateway_for_entity(entity_name)
+      service(:"#{entity_name}_gateway")
+    end
+
+  end
+end

data/lib/rohbau/entity.rb

@@ -0,0 +1,41 @@
+module Rohbau
+
+  class Entity
+    class << self; attr_accessor :__attributes__ end
+    def self.attributes(*attributes)
+      @__attributes__ ||= []
+      @__attributes__ += attributes
+
+
+      predicate_attributes = attributes.select do |attr|
+        attr =~ /\?$/
+      end
+
+      regular_attributes = attributes - predicate_attributes
+
+      predicate_attributes.each do |attribute|
+        attribute_without_predicate = attribute.to_s.gsub(/\?$/, '')
+        attr_accessor attribute_without_predicate
+
+        define_method attribute do ||
+          !!instance_variable_get(:"@#{attribute_without_predicate}")
+        end
+      end
+
+      attr_accessor(*regular_attributes)
+    end
+
+    def ==(other)
+      other && __attributes__.all? do |attr|
+        other.respond_to?(attr) &&
+          self.public_send(attr) == other.public_send(attr)
+      end
+    end
+
+    protected
+    def __attributes__
+      self.class.__attributes__ || []
+    end
+  end
+
+end