transflow 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c18bc0bd37bd89215142adefd13b8a965ea0994
-  data.tar.gz: 7827d58aeef106f8cf0eb6969381b76433f44a4e
+  metadata.gz: 3dde7fc2cfdb940553b3a4ddabe1004d01ca49a6
+  data.tar.gz: 2c7b0e6c01338cd5087ac5dc332e9c5936d3a5b5
 SHA512:
-  metadata.gz: 531682614e131a47544798c2700fd2c22258b6fa9a61c309515ef5a6bf72404dbd8a4faa29e8111c3f3c930d73243e7791546d1b4d6ff0aaa1699b0755a0833d
-  data.tar.gz: e87f9e64c7249a0c550e43b148391da884bdd90bb23b0eeb3131249961c8fd4882a9e6f0d43a7b98e3fb7513c7d699cf63fa63138df53a184f3dbdfa61621643
+  metadata.gz: c4601d2a9a7a8dfd1d72c03199f696483fa1de7bf66f0e398cecd17115bbf6a54333c32c11740ec2998d7626bbb8dadc3aab9088b4ed580f0a71cd2bd0af803d
+  data.tar.gz: f0ccebb883cc983ace244989008a23c649e2b234ced17692923747c95d6be1b185a4528d5e64202fdf71e829b94f5162ffb3e08611eb05286556a4865b1e5b47

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.0.2 2015-08-16
+
+## Added
+
+- Ability to publish events from operations via `publish: true` option (solnic)
+- Ability to subscribe to events via `Transflow::Transaction#subscribe` interface (solnic)
+
+[Compare v0.0.1...v0.0.2](https://github.com/rom-rb/rom/compare/v0.0.1...v0.0.2)
+
 # 0.0.1 2015-08-16
 
 First public release \o/

data/README.md

@@ -51,6 +51,56 @@ errors from multiple steps without stopping the processing. It's not implemented
 yet but *probably* using pub/sub for that will do the work as we can register an
 error listener that can simply gather errors and return it as a result.
 
+## Synopsis
+
+``` ruby
+DB = []
+
+container = {
+  validate: -> input { raise "name nil" if input[:name].nil? },
+  persist: -> input { DB << input[:name] }
+}
+
+my_business_flow = Transflow(container: container) do
+  step(:validate) { step(:persist) }
+end
+
+my_business_flow[{ name: 'Jane' }]
+
+puts DB.inspect
+# ["Jane"]
+
+## The same but with events
+
+NOTIFICATIONS = []
+
+class Notify
+  def persist_success(user)
+    NOTIFICATIONS << "#{user} persisted"
+  end
+
+  def persist_failure(user, err)
+    # do sth about that
+  end
+end
+
+my_business_flow = Transflow(container: container) do
+  step(:validate) { step(:persist, publish: true) }
+end
+
+notify = Notify.new
+
+my_business_flow.subscribe(persist: notify)
+
+my_business_flow[{ name: 'Jane' }]
+
+puts DB.inspect
+# ["Jane"]
+
+puts NOTIFICATIONS.inspect
+# ["Jane persisted"]
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/transflow.rb

@@ -1,73 +1,21 @@
-require 'transproc'
 require 'transflow/version'
-
-module Transflow
-  class Transaction
-    attr_reader :handler
-
-    attr_reader :steps
-
-    def initialize(steps, handler)
-      @steps = steps
-      @handler = handler
-    end
-
-    def call(*args)
-      handler.call(*args)
-    end
-    alias_method :[], :call
-  end
-
-  class StepDSL
-    attr_reader :name
-
-    attr_reader :handler
-
-    attr_reader :container
-
-    attr_reader :steps
-
-    def initialize(name, options, container, steps, &block)
-      @name = name
-      @handler = options.fetch(:with)
-      @container = container
-      @steps = steps
-      instance_exec(&block) if block
-    end
-
-    def step(*args, &block)
-      self.class.new(*args, container, steps, &block).call
-    end
-
-    def call
-      steps[name] = container[handler]
-    end
-  end
-
-  class FlowDSL
-    attr_reader :options
-
-    attr_reader :container
-
-    attr_reader :steps
-
-    def initialize(options, &block)
-      @options = options
-      @container = options.fetch(:container)
-      @steps = {}
-      instance_exec(&block)
-    end
-
-    def step(*args, &block)
-      StepDSL.new(*args, container, steps, &block).call
-    end
-
-    def call
-      Transaction.new(steps, steps.values.reverse.reduce(:>>))
-    end
-  end
-end
-
+require 'transflow/flow_dsl'
+
+# Define a transaction flow
+#
+# @example
+#
+#   container = { do_one: some_obj, do_two: some_obj }
+#
+#   my_business_flow = Transflow(container: container) do
+#     step(:one, with: :do_one) { step(:two, with: :do_two }
+#   end
+#
+#   my_business_flow[some_input]
+#
+# @options [Hash] options The option hash
+#
+# @api public
 def Transflow(options = {}, &block)
   Transflow::FlowDSL.new(options, &block).call
 end

data/lib/transflow/flow_dsl.rb

@@ -0,0 +1,45 @@
+require 'transproc'
+
+require 'transflow/step_dsl'
+require 'transflow/transaction'
+
+module Transflow
+  class FlowDSL
+    module Registry
+      extend Transproc::Registry
+    end
+
+    def self.[](op)
+      if op.respond_to?(:>>)
+        op
+      else
+        Registry[op]
+      end
+    end
+
+    attr_reader :options
+
+    attr_reader :container
+
+    attr_reader :steps
+
+    def initialize(options, &block)
+      @options = options
+      @container = options.fetch(:container)
+      @steps = {}
+      instance_exec(&block)
+    end
+
+    def step(*args, &block)
+      StepDSL.new(*args, container, steps, &block).call
+    end
+
+    def call
+      Transaction.new(steps, operations.reduce(:>>))
+    end
+
+    def operations
+      steps.values.reverse.map { |op| self.class[op] }
+    end
+  end
+end

data/lib/transflow/publisher.rb

@@ -0,0 +1,26 @@
+require 'wisper'
+
+module Transflow
+  class Publisher
+    include Wisper::Publisher
+
+    attr_reader :name
+
+    attr_reader :op
+
+    def initialize(name, op)
+      @name = name
+      @op = op
+    end
+
+    def call(*args)
+      result = op.call(*args)
+      broadcast(:"#{name}_success", result)
+      result
+    rescue => err
+      broadcast(:"#{name}_failure", *args, err)
+      raise err
+    end
+    alias_method :[], :call
+  end
+end

data/lib/transflow/step_dsl.rb

@@ -0,0 +1,41 @@
+require 'transflow/publisher'
+
+module Transflow
+  class StepDSL
+    attr_reader :name
+
+    attr_reader :handler
+
+    attr_reader :container
+
+    attr_reader :steps
+
+    attr_reader :publish
+
+    def initialize(name, options, container, steps, &block)
+      @name = name
+      @handler = options.fetch(:with)
+      @publish = options.fetch(:publish, false)
+      @container = container
+      @steps = steps
+      instance_exec(&block) if block
+    end
+
+    def step(*args, &block)
+      self.class.new(*args, container, steps, &block).call
+    end
+
+    def call
+      operation = container[handler]
+
+      step =
+        if publish
+          Publisher.new(name, operation)
+        else
+          operation
+        end
+
+      steps[name] = step
+    end
+  end
+end

data/lib/transflow/transaction.rb

@@ -0,0 +1,42 @@
+module Transflow
+  class TransactionFailedError < StandardError
+    attr_reader :transaction
+
+    attr_reader :original_error
+
+    def initialize(transaction, original_error)
+      @transaction = transaction
+      @original_error = original_error
+
+      super("#{transaction} failed")
+
+      set_backtrace(original_error.backtrace)
+    end
+  end
+
+  class Transaction
+    attr_reader :handler
+
+    attr_reader :steps
+
+    def initialize(steps, handler)
+      @steps = steps
+      @handler = handler
+    end
+
+    def subscribe(listeners)
+      listeners.each { |step, listener| steps[step].subscribe(listener) }
+    end
+
+    def call(*args)
+      handler.call(*args)
+    rescue Transproc::MalformedInputError => err
+      raise TransactionFailedError.new(self, err)
+    end
+    alias_method :[], :call
+
+    def to_s
+      "Transaction(#{steps.keys.join(' => ')})"
+    end
+  end
+end

data/lib/transflow/version.rb

@@ -1,3 +1,3 @@
 module Transflow
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/transflow.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'transproc', '~> 0.3', '>= 0.3.1'
+  spec.add_runtime_dependency 'wisper'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transflow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Piotr Solnica
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +104,10 @@ files:
 - bin/console
 - bin/setup
 - lib/transflow.rb
+- lib/transflow/flow_dsl.rb
+- lib/transflow/publisher.rb
+- lib/transflow/step_dsl.rb
+- lib/transflow/transaction.rb
 - lib/transflow/version.rb
 - transflow.gemspec
 homepage: https://github.com/solnic/transflow