rohbau 0.1.0 → 0.2.0

data/lib/rohbau/interface.rb

@@ -0,0 +1,130 @@
+require_relative 'runtime'
+require_relative 'request_cache'
+
+module Rohbau
+  class Interface
+    include RequestCache
+    def initialize
+      @calls = Hash.new { |h, k| h[k] = nil }
+      @call_count = Hash.new { |h, k| h[k] = 0 }
+      @stub_results = Hash.new { |h, k| h[k] = nil }
+      @stub_type_for = Hash.new { |h, k| h[k] = nil }
+    end
+
+    def clear_stubs
+      calls.clear
+      call_count.clear
+      stub_results.clear
+      stub_type_for.clear
+    end
+
+    def clear_cached_requests
+      RequestCache.clear
+    end
+
+    def calls
+      @calls
+    end
+
+    def call_count
+      @call_count
+    end
+
+    private
+
+    def call_use_case(domain, use_case, args)
+      call_count[use_case] += 1 unless args.key?(:stub_result)
+      calls[use_case] = args
+      domain = camel_case(domain)
+      use_case = camel_case(use_case)
+      caller = Caller.new domain
+
+      overwrite_stub_result_for(use_case, args[:stub_result])
+      overwrite_stub_type_for(use_case, args[:stub_type])
+
+      caller.call use_case, args,
+        :stub_result => stub_results[use_case],
+        :stub_type => stub_type_for[use_case] || :Success
+    end
+
+    def overwrite_stub_result_for(use_case, stub_result)
+      return if stub_result.nil?
+      stub_results[use_case] = stub_result
+    end
+
+    def overwrite_stub_type_for(use_case, stub_type)
+      return if stub_type.nil?
+      stub_type_for[use_case] = stub_type
+    end
+
+    def stub_results
+      @stub_results
+    end
+
+    def stub_type_for
+      @stub_type_for
+    end
+
+    def camel_case(sym)
+      sym.to_s.split('_').each(&:capitalize!).join
+    end
+
+    def method_missing(domain, *args)
+      use_case = args[0]
+      input = args[1] || {}
+      call_use_case(domain, use_case, input)
+    rescue NameError => e
+      msg = "You tried to call a use case from the #{domain} domain, " \
+        "but the following error occured: #{e.inspect}"
+      raise msg
+    end
+
+    class Caller
+      def initialize(domain)
+        @domain = domain
+      end
+
+      def call(use_case, args, options = {})
+        type = options[:stub_type]
+        stubbed_result = options[:stub_result]
+        use_case = get_use_case_for(use_case, args)
+
+        if stubbed_result
+          stub_use_case(use_case, type, stubbed_result)
+        else
+          call_use_case(use_case, args)
+        end
+      end
+
+      private
+
+      def call_use_case(use_case, args)
+        request = RequestCache.for[domain]
+        input = get_input_for(use_case, args)
+
+        use_case.new(request, input).call
+      end
+
+      def stub_use_case(use_case, type, result)
+        result_class = use_case.const_get type
+
+        return result_class.new if result == true
+        result_class.new(result)
+      end
+
+      def get_input_for(use_case, args)
+        use_case.const_get(:Input).new(args)
+      end
+
+      def get_use_case_for(use_case, args)
+        [domain, :UseCases, use_case].inject(Object) do |ns, const|
+          ns.const_get(const)
+        end
+      end
+
+      def domain
+        @domain
+      end
+    end
+  end
+end

data/lib/rohbau/it_behaves_like.rb

@@ -2,7 +2,6 @@ require 'minitest/spec'
 
 module Rohbau
   module ItBehavesLike
-
     def get_shared_example(spec_name)
       Rohbau::SharedSpec::SpecIndex.get spec_name
     end
@@ -17,7 +16,6 @@ module Rohbau
 
       instance_eval(&shared_example)
     end
-
   end
 end
 

data/lib/rohbau/minitest/exclude.rb

@@ -1,7 +1,6 @@
 module Rohbau
   module Minitest
     module Exclude
-
       class SpecNuker
         def initialize(description_name, description_caller)
           spec_class = find_spec_class(description_caller)
@@ -39,20 +38,15 @@ module Rohbau
             description_class.name == @description_name
           end
         end
-
       end
-
     end
   end
 end
 
 module MiniTest::Spec::DSL
-
-
   # only single nesting in one describe block is supported
   # for now
   def exclude(it_desc, reason = "")
     Rohbau::Minitest::Exclude::SpecNuker.new(self.name, self).nuke!(it_desc)
   end
-
 end

data/lib/rohbau/registry.rb

@@ -14,13 +14,11 @@ module Rohbau
 
     module ExternalInterface
       def register(service_name, &constructor)
-        registrations << service_name
         implementations[service_name] << constructor
-        this = self
 
-        this.send :define_method, service_name do
+        define_method service_name do
           cache service_name do
-            instance_eval(&this.implementations[service_name].last)
+            instance_eval(&self.class.implementations[service_name].last)
           end
         end
       end
@@ -29,12 +27,12 @@ module Rohbau
         implementations[service_name].pop
 
         if implementations[service_name].empty?
-          self.send :remove_method, service_name
+          remove_method service_name
         end
       end
 
       def registrations
-        @registrations ||= []
+        implementations.keys
       end
 
       def implementations

data/lib/rohbau/request.rb

@@ -1,8 +1,7 @@
 module Rohbau
   class Request
-
     def initialize(runtime)
-      raise "No Runtime instanciated (#{self.inspect})" unless runtime
+      raise "No Runtime instantiated (#{self.inspect})" unless runtime
       @runtime = runtime
     end
 
@@ -13,12 +12,11 @@ module Rohbau
     protected
 
     def build_service_factory
-      raise NotImplementedError, "Please provide #{self.class}#build_service_factory"
+      raise NotImplementedError
     end
 
     def runtime
       @runtime
     end
-
   end
 end

data/lib/rohbau/request_cache.rb

@@ -0,0 +1,19 @@
+module Rohbau
+  module RequestCache
+    def self.for
+      requests
+    end
+
+    def self.clear
+      requests.clear
+    end
+
+    private
+
+    def self.requests
+      @requests ||= Hash.new do |hash, domain|
+        hash[domain] = Object.const_get(domain).const_get(:Request).new
+      end
+    end
+  end
+end

data/lib/rohbau/require.rb

@@ -15,6 +15,5 @@ module Rohbau
       files = File.expand_path("../#{dir}/*.rb", file)
       Dir[files].each { |f| require f }
     end
-
   end
 end

data/lib/rohbau/runtime.rb

@@ -46,7 +46,6 @@ module Rohbau
     def after_termination
     end
 
-
     def initialize_plugins
       self.class.plugins.each do |name, plugin_class|
         instance_variable_set :"@#{name}", plugin_class.new
@@ -89,6 +88,5 @@ module Rohbau
         @handling_plugin = nil
       end
     end
-
   end
 end

data/lib/rohbau/service_factory.rb

@@ -5,7 +5,7 @@ module Rohbau
     include Rohbau::Registry
 
     def initialize(runtime)
-      raise "No Runtime instanciated" unless runtime
+      raise "No Runtime instantiated" unless runtime
       @runtime = runtime
     end
 
@@ -32,6 +32,5 @@ module Rohbau
     def runtime
       @runtime
     end
-
   end
 end

data/lib/rohbau/shared_spec.rb

@@ -3,7 +3,6 @@ require 'rohbau/minitest/exclude'
 
 module Rohbau
   class SharedSpec < Proc
-
     def self.for(name, &block)
       shared_specs[name] = Proc.new(&block)
     end
@@ -44,4 +43,3 @@ module Rohbau
     end
   end
 end
-

data/lib/rohbau/shared_specs/default_gateway.rb

@@ -1,7 +1,6 @@
 module Rohbau
   module SharedSpecs
     DefaultGateway = Proc.new do
-
       describe 'add' do
         it 'inserts an entity' do
           subject.add entity
@@ -71,7 +70,6 @@ module Rohbau
       end
 
       describe 'all' do
-
         it 'returns an empty array' do
           assert_equal [], subject.all
         end
@@ -83,7 +81,6 @@ module Rohbau
 
           assert_equal entities, subject.all
         end
-
       end
 
       describe 'get' do
@@ -131,7 +128,7 @@ module Rohbau
         it 'adds a copy as stored entity on add' do
           uid = subject.add(entity).uid
 
-          entity.uid = uid  + '1'
+          entity.uid = uid + '1'
 
           assert_equal uid, subject.get(uid).uid
         end
@@ -173,7 +170,7 @@ module Rohbau
           results = subject.bulk_add(entities)
           uid = results[0].uid
 
-          entity.uid = uid  + '1'
+          entity.uid = uid + '1'
 
           assert_equal uid, subject.get(uid).uid
         end
@@ -299,7 +296,6 @@ module Rohbau
           refute_includes subject.all.map(&:uid), uid
         end
       end
-
     end
   end
 end

data/lib/rohbau/use_case.rb

@@ -1,9 +1,7 @@
 require 'bound'
 
 module Rohbau
-
   class UseCase
-
     def self.call(request, input = nil)
       args = [request]
       args << input if input
@@ -21,5 +19,4 @@ module Rohbau
       @request.services.public_send service_name
     end
   end
-
 end

data/lib/rohbau/version.rb

@@ -1,3 +1,3 @@
 module Rohbau
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rohbau.rb

@@ -1,5 +1,23 @@
 require "rohbau/version"
 
+# Rohbau provides a set of patterns used in Domain Driven Design.
+#
+# Require individual parts of Rohbau to use its functionality
+#
+# @example
+#     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
+#
+# @see README for more examples
 module Rohbau
-  # Your code goes here...
 end

data/rakelib/build_readme.rake

@@ -0,0 +1,23 @@
+desc 'Generate README.md from README.md.template'
+task :build_readme do
+  root = Pathname.new(File.dirname(__FILE__)).join('..')
+
+  template = root.join(ENV.fetch('TEMPLATE', 'README.md.template'))
+  output = root.join(ENV.fetch('OUTPUT', 'README.md'))
+
+  content = File.read(template)
+  content.gsub!(/include_example '(.*?)'/) do |match|
+    example = $1
+    file = root.join('examples').join("#{example}.rb")
+    if File.exist?(file)
+      File.read(file)
+    else
+      warn "#{file} is missing" unless example =~ /example_file_name/
+      match
+    end
+  end
+
+  File.open(output, 'wb') do |file|
+    file.write(content)
+  end
+end

data/rakelib/ci.rake

@@ -0,0 +1,5 @@
+run_on_ci = [:spec]
+run_on_ci << 'examples:verify' unless defined?(JRUBY_VERSION)
+
+desc 'Run tests etc. on CI'
+task :ci => run_on_ci

data/rakelib/examples.rake

@@ -0,0 +1,16 @@
+desc 'Run examples'
+task :examples do
+  examples = FileList['examples/**/*.rb'].exclude('examples/**/*_spec.rb')
+  examples.each do |example|
+    puts example
+    system %{ruby -Ilib:examples #{example} 2>&1}
+    puts
+  end
+end
+
+desc 'Verify examples'
+Rake::TestTask.new('examples:verify') do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['examples/verify/*_spec.rb']
+  t.verbose = true
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,18 @@
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+
+  namespace :rubocop do
+    desc 'Generate a configuration file acting as a TODO list.'
+    task :auto_gen_config do
+      exec "bundle exec rubocop --auto-gen-config"
+    end
+  end
+
+rescue LoadError
+end

data/spec/event_tube_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'rohbau/event_tube'
 
 describe Rohbau::EventTube do
-  let(:tube)        { Class.new(Rohbau::EventTube)}
+  let(:tube)        { Class.new(Rohbau::EventTube) }
   let(:event_class) { Struct.new(:arg1) }
   let(:event)       { event_class.new(22) }
 
@@ -41,7 +41,7 @@ describe Rohbau::EventTube do
 
     it 'processes them all on publish' do
       tube.publish :my_event, event
-      assert_equal [event,event], @calls
+      assert_equal [event, event], @calls
     end
   end
 
@@ -59,5 +59,4 @@ describe Rohbau::EventTube do
       assert_equal [], @calls
     end
   end
-
 end

data/spec/interface_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'rohbau/interface'
+require 'bound'
+
+describe Rohbau::Interface do
+  let(:interface) { Rohbau::Interface.new }
+
+  module FakeDomain
+    class Request
+    end
+
+    module UseCases
+      class FakeUseCase
+        Input = Bound.required :super_important_information
+        Success = Bound.required :message
+        Error = Bound.required :message
+
+        def initialize(request, input)
+          @request = request
+          @input = input
+        end
+
+        def call
+          Success.new :message => "original usecase output message"
+        end
+      end
+    end
+  end
+
+  it 'calls a use case' do
+    result = interface.fake_domain :fake_use_case,
+      :super_important_information => "23"
+    assert_kind_of FakeDomain::UseCases::FakeUseCase::Success, result
+    assert_equal 'original usecase output message', result.message
+  end
+
+  it 'raises if the domain is unknown' do
+    assert_raises RuntimeError do
+      interface.really_fake_domain :equally_fake_use_case
+    end
+  end
+
+  it 'returns success for all use_cases when run in stub mode' do
+    result = interface.fake_domain :fake_use_case,
+      :stub_result => { :message => 'a different message' }
+
+    assert_kind_of FakeDomain::UseCases::FakeUseCase::Success, result
+    assert_equal 'a different message', result.message
+  end
+
+  it 'can return other result types' do
+    interface.fake_domain :fake_use_case,
+      :stub_type => :Error,
+      :stub_result => {
+        :message => "error"
+      }
+
+    result = interface.fake_domain :fake_use_case
+
+    assert_kind_of FakeDomain::UseCases::FakeUseCase::Error, result
+    assert_equal 'error', result.message
+  end
+
+  it 'returns subsequent calls to the same use case as stubs' do
+    interface.fake_domain :fake_use_case,
+      :stub_result => { :message => 'a different message' }
+
+    result = interface.fake_domain :fake_use_case,
+      :super_important_information => "23"
+
+    assert_kind_of FakeDomain::UseCases::FakeUseCase::Success, result
+    assert_equal 'a different message', result.message
+  end
+
+  it 'records passed arguments by use_case' do
+    interface.fake_domain :fake_use_case,
+      :super_important_information => "23"
+
+    result = interface.calls[:fake_use_case][:super_important_information]
+
+    assert_equal "23", result
+  end
+
+  it 'records number of unstubbed calls to each use_case' do
+    interface.fake_domain :fake_use_case,
+      :super_important_information => "23"
+
+    interface.fake_domain :fake_use_case,
+      :super_important_information => "56"
+
+    interface.fake_domain :fake_use_case,
+      :stub_result => { :message => 'message' }
+
+    assert_equal 2, interface.call_count[:fake_use_case]
+  end
+
+  it 'can clear all stubbed results' do
+    interface.fake_domain :fake_use_case,
+      :stub_result => { :message => 'a different message' }
+
+    result = interface.fake_domain :fake_use_case
+    assert_equal 'a different message', result.message
+
+    interface.clear_stubs
+
+    result = interface.fake_domain :fake_use_case,
+      :super_important_information => "23"
+    refute_equal 'a different message', result.message
+    assert_equal 'original usecase output message', result.message
+  end
+end

data/spec/runtime_loader_spec.rb

@@ -52,7 +52,7 @@ describe Rohbau::RuntimeLoader do
     end
   end
 
-  it 'does not instanciate twice' do
+  it 'does not instantiate twice' do
     instance = my_runtime_loader.instance
 
     my_runtime_loader.new(ExampleClass)
@@ -60,7 +60,6 @@ describe Rohbau::RuntimeLoader do
     assert_same instance, my_runtime_loader.instance
   end
 
-
   def inject_mocked_instance_into_my_runtime_loader
     instance = MiniTest::Mock.new
 

data/spec/service_factory_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'rohbau/service_factory'
 
 describe Rohbau::ServiceFactory do
-
   let(:factory_class) do
     Class.new(Rohbau::ServiceFactory)
   end
@@ -15,7 +14,7 @@ describe Rohbau::ServiceFactory do
     Object.new
   end
 
-  it 'needs a runtime instance to get instanciated' do
+  it 'needs a runtime instance to get instantiated' do
     raised = assert_raises RuntimeError do
       factory_class.new(nil)
     end
@@ -38,13 +37,13 @@ describe Rohbau::ServiceFactory do
       end
 
       it 'is not reached with partially registers services' do
-        factory_class.register(:service1) {  }
+        factory_class.register(:service1) {}
         refute_predicate factory_class, :external_dependencies_complied?
       end
 
       it 'is reached if all required dependencies are registered' do
-        factory_class.register(:service1) {  }
-        factory_class.register(:service2) {  }
+        factory_class.register(:service1) {}
+        factory_class.register(:service2) {}
         assert_predicate factory_class, :external_dependencies_complied?
       end
     end
@@ -72,7 +71,7 @@ describe Rohbau::ServiceFactory do
       it "can unregister services" do
         factory_class.unregister(:test_service)
 
-        assert_raises(NoMethodError) {factory.test_service}
+        assert_raises(NoMethodError) { factory.test_service }
       end
 
       describe "with more than one service registered" do
@@ -99,11 +98,9 @@ describe Rohbau::ServiceFactory do
           factory_class.unregister(:test_service)
           factory_class.unregister(:test_service)
 
-          assert_raises(NoMethodError) {factory.test_service}
+          assert_raises(NoMethodError) { factory.test_service }
         end
       end
     end
-
   end
-
 end

data/spec/shared_spec_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'rohbau/shared_spec'
 
 describe Rohbau::SharedSpec do
-
   before do
     Rohbau::SharedSpec::SpecIndex.reset
   end
@@ -40,5 +39,4 @@ describe Rohbau::SharedSpec do
       assert_equal nil,             index.get(:something)
     end
   end
-
 end