ruby_dci 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1b8372e74de2567e52902b236b08aa68779df450995d8a7d83f1d4241d37ede3
-  data.tar.gz: 13677405fdba528931c0f1b745d4507ac745192b218b363dbcc8a027f93b514c
+SHA1:
+  metadata.gz: a61a836ec90dab9c17d7f88cfd866ac24fd7e4ca
+  data.tar.gz: 892f6b68acb2b87b6ef653c6c19860b3eac95c37
 SHA512:
-  metadata.gz: 8f6a20d6b9de2c3eb81d18c845c34a073848dcf31e401fbe263674dbf0bd4e2a2960c21820948f3ece3cfb65d22b10ba564c53d30cb0e82315a8b2ebce423c7f
-  data.tar.gz: 6e750cba64ddb92652af80f1364b33c2c53b5c3ee02407203de45fd39f842056ecb4bb0d327a671c98afaf52712fb23afdeba000ae4de55b4303827b35031db7
+  metadata.gz: 3f81879bf07b9d8d4c335f9e7c53783edaf19d0cc3e1f0b6abf5f26d11edd3f696bfacd017925778f9d7b7fb93abc3258af419e27481f7cb5d0689e8c7430277
+  data.tar.gz: 888c5768b1f5c9d35454173eb91103ce3ad40914cb39f99e22b4898190e3b084fd033f3703d16b5eb725f39cc79ad03fc9c3be6ae2b40cafb06b663d2b74c89b

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.3.0 (2018-05-24)
+
+Features:
+
+  - Renamed `DCI::Configuration` accessors. `event_routes` is now `routes`, `route_methods` is now `router`, `raise_in_event_router` is now `raise_in_router`.
+  - `events` is not an instance variable defined in the context anymore, but has the same access style like the `context` itself. In the role don't push events to `context.events`, but to `context_events`.
+
+Bugfixes:
+
+  - Added specs
+  - Added `README.md`
+  - Added `CHANGELOG.md`
+
 ## 0.2.0 (2018-05-19)
 
 Features:

data/Gemfile

@@ -1,6 +1,8 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{ repo_name }" }
+
+gem "coveralls", require: false
 
 # Specify your gem's dependencies in ruby_dci.gemspec
 gemspec

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    ruby_dci (0.2.0)
+    ruby_dci (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
     method_source (0.9.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -26,12 +34,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  coveralls
   pry (~> 0.11.3)
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/egze/ruby_dci.svg?branch=master)](https://travis-ci.org/egze/ruby_dci)
+[![Coverage Status](https://coveralls.io/repos/github/egze/ruby_dci/badge.svg?branch=master)](https://coveralls.io/github/egze/ruby_dci?branch=master)
 
 # RubyDci
 
@@ -9,7 +10,7 @@ A classic DCI implementation for ruby with some extra sugar. I've been using DCI
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby_dci'
+gem 'ruby_dci', require: 'dci'
 ```
 
 And then execute:
@@ -43,8 +44,8 @@ I configure the gem in `config/initializers/dci_configuration.rb`.
 
 ```ruby
 DCI.configure do |config|
-  config.event_routes = Hash.new([])
-  config.route_methods = EventRouteStore.new
+  config.routes = Hash.new([])
+  config.router = EventRouter.new
   config.transaction_class = ApplicationRecord
   config.raise_in_event_router = !Rails.env.production?
   config.on_exception_in_router = -> (exception) {}
@@ -55,7 +56,7 @@ end
 
 Usually you want your code to run in a transaction. Either everything runs fine, or nothing is saved. This is done by wrapping the executed code in a transaction block. I use ActiveRecord, but you can use whatever you want. Your class just needs to implement a `transaction` method that takes a block. If you don't want any transactions, you can either skip `config.transaction_class` completely, or set it to `DCI::NullTransaction`.
 
-### config.event_routes
+### config.routes
 
 This is your mapping of events that may happen in the context. Key is a class name, and the value is an array of method names. Example:
 
@@ -65,7 +66,7 @@ This is your mapping of events that may happen in the context. Key is a class na
 }
 ```
 
-The system will know that it needs to execute `send_product_added_notification` from `config.route_methods` for every event of class `DomainEvents::ProductAddedToCart`. If you don't have any actions that you need to perform after a transaction, the just skip `config.event_routes` completely or set it to `Hash.new([])`.
+The system will know that it needs to execute `send_product_added_notification` from `config.route_methods` for every event of class `DomainEvents::ProductAddedToCart`. If you don't have any actions that you need to perform after a transaction, then just skip `config.event_routes` completely or set it to `Hash.new([])`.
 
 I implement events as plain ruby Structs. Example:
 
@@ -79,12 +80,12 @@ end
 
 Why do I do it like this? It makes it easier to add other callbacks later. I can do it in one place instead of searching through hundreds of files. Also makes testing easier.
 
-### config.route_methods
+### config.router
 
-This is a class that implements the methods for the `config.event_routes` mapping. Example:
+This is a class that implements the methods for the `config.routes` mapping. Example:
 
 ```ruby
-class EventRouteStore
+class EventRouter
 
   def send_product_added_notification(event)
     AddedToCartNotificationJob.perform_later(id: event.product.id)
@@ -106,7 +107,7 @@ config.raise_in_event_router = !Rails.env.production?
 In case there is an exception in the event router, you can provide a handler for the exception. It should be a lambda that receives an exception as a parameter. You can use it to log the exception. If you don't need any logging, just skip `config.on_exception_in_router` completely, or assign an empty lambda.
 
 ```ruby
-config.logger = -> (exception) { Rails.logger.error(exception) }
+config.on_exception_in_router = -> (exception) { Rails.logger.error(exception) }
 ```
 
 
@@ -142,7 +143,7 @@ Couple of thigs to keep in mind:
 
 ### Role
 
-In a Rails app I put my roles in `app/roles`. Roles are plain ruby modules. You define a role by including `DCI::Role`.
+In a Rails app I put my roles in `app/roles`. Roles are plain ruby modules. You define a role by including `DCI::Role`. A role has access to the `context` and to the `context_events` methods. You can push events to `context_events` to process them after the transaction.
 
 ```ruby
 module Customer
@@ -153,7 +154,7 @@ module Customer
     # do your thing
 
     # add event to the context
-    context.events << DomainEvents::ProductAddedToCart.new(product)
+    context_events << DomainEvents::ProductAddedToCart.new(product)
   end
 
 end

data/lib/dci/accessor.rb

@@ -5,5 +5,9 @@ module DCI
       Thread.current[:context]
     end
 
+    def context_events
+      Thread.current[:context_events]
+    end
+
   end
 end

data/lib/dci/configuration.rb

@@ -1,17 +1,19 @@
 module DCI
   class Configuration
+
     attr_accessor :transaction_class,
-                  :event_routes,
-                  :route_methods,
-                  :raise_in_event_router,
-                  :on_exception_in_router
+                  :routes,
+                  :router,
+                  :on_exception_in_router,
+                  :raise_in_router
 
     def initialize
       @transaction_class      = NullTransaction
-      @event_routes           = Hash.new([])
-      @route_methods          = nil
-      @raise_in_event_router  = false
-      @on_exception_in_router = -> (exception) { }
+      @routes                 = Hash.new([])
+      @router                 = nil
+      @raise_in_router        = false
+      @on_exception_in_router = -> (exception) {}
     end
+
   end
 end

data/lib/dci/context.rb

@@ -1,5 +1,4 @@
 module DCI
-
   module Context
 
     include EventRouter
@@ -16,8 +15,10 @@ module DCI
 
       def perform_in_transaction
         old_context = context
-        @events = init_context_events
+        old_context_events = context_events
+
         self.context = self
+        self.context_events = []
 
         res = nil
 
@@ -25,33 +26,40 @@ module DCI
           res = call
         end
 
-        route_events!(events)
+        route_events!(context_events)
         res
       ensure
         self.context = old_context
-        self.events.clear
+        self.context_events = old_context_events
       end
 
       def context=(ctx)
         Thread.current[:context] = ctx
       end
 
+      def context_events=(ctx_events = [])
+        Thread.current[:context_events] = Array(ctx_events).compact.flatten
+      end
+
       def call
         raise NotImplementedError.new("implement me")
       end
 
       private
+
       def init_context_events
         []
       end
+
     end
 
     module ClassMethods
+
       def call(*args)
         new(*args).perform_in_transaction
       end
+
     end
 
   end
-
 end

data/lib/dci/event_router.rb

@@ -1,5 +1,4 @@
 module DCI
-
   module EventRouter
 
     def route_events!(events)
@@ -7,10 +6,11 @@ module DCI
     end
 
     private
+
     def route_event!(event)
-      DCI.configuration.event_routes[event.class].each do |callback|
+      DCI.configuration.routes[event.class].each do |callback|
         dispatch_catching_standard_errors do
-          DCI.configuration.route_methods.send(callback, event)
+          DCI.configuration.router.send(callback, event)
         end
       end
     end
@@ -21,10 +21,9 @@ module DCI
       rescue StandardError => exception
         DCI.configuration.on_exception_in_router.call(exception) rescue nil
 
-        raise exception if DCI.configuration.raise_in_event_router
+        raise exception if DCI.configuration.raise_in_router
       end
     end
 
   end
-
 end

data/lib/dci/null_transaction.rb

@@ -1,7 +1,9 @@
 module DCI
   class NullTransaction
+
     def self.transaction
       yield
     end
+
   end
 end

data/lib/dci/version.rb

@@ -1,3 +1,5 @@
 module DCI
-  VERSION = "0.2.0"
+
+  VERSION = "0.3.0".freeze
+
 end

data/lib/dci.rb

@@ -7,8 +7,11 @@ require "dci/context"
 require "dci/role"
 
 module DCI
+
   class << self
-    attr_accessor :configuration
+
+    #attr_accessor :configuration
+
   end
 
   def self.configuration
@@ -22,4 +25,5 @@ module DCI
   def self.configure
     yield(configuration)
   end
+
 end

data/ruby_dci.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/egze/ruby_dci"
   spec.license       = "MIT"
 
-
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_dci
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aleksandr Lossenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Opinionated DCI implementation for ruby.