processor 2.0.0 → 2.1.0

data/README.md

@@ -34,6 +34,7 @@ Contents
 1. Requirements
 1. Usage
     1. Data processors
+    1. Subroutines
     1. Run modes
     1. Processor Thread
     1. Observers
@@ -111,6 +112,33 @@ example. See `data/solr_pages_processor.rb`.
 see `data/csv_processor.rb` for running migration from CSV files.
 
 
+### Subroutines
+Subroutines are small programs that do exactly one task. It is
+possible to enhance data processor by passing it to subroutine first.
+Subroutines are decorators. There are several predefined subroutines:
+
+1. Name [[code](https://github.com/AlexParamonov/processor/blob/master/lib/processor/subroutine/name.rb), [specs](https://github.com/AlexParamonov/processor/blob/master/spec/processor/subroutine/name_spec.rb)]
+1. Count [[code](https://github.com/AlexParamonov/processor/blob/master/lib/processor/subroutine/counter.rb), [specs](https://github.com/AlexParamonov/processor/blob/master/spec/processor/subroutine/counter_spec.rb)]
+1. Recursion [[code](https://github.com/AlexParamonov/processor/blob/master/lib/processor/subroutine/recursion.rb), [specs](https://github.com/AlexParamonov/processor/blob/master/spec/processor/subroutine/recursion_spec.rb)]
+
+`Subroutine::Name` adds `name` method that returns name of the current
+data processor. `Subroutine::Count` adds `remaining_records_count` and
+`processed_records_count` methods. `Subroutine::Recursion` prevents
+recursion of data processor. It uses `total_records` method and take
+care about keeping count of `process` method calls in borders.
+
+Some subroutines are used by parts of `Processor` when needed:
+`Subroutine::Name` is used in `Observer::Logger`, `Subroutine::Count`
+is used by `Subroutine::Recursion`
+
+To use `Subroutine::Recursion`, first wrap a data processor before
+running it:
+
+``` ruby
+user_updater = Processor::Subroutine::Recursion.new(UpdateUserLocationCodes.new)
+Processor::Thread.new(user_updater).run_successive
+```
+
 ### Run modes
 Currently 2 run modes are supported:
 

data/lib/processor/thread.rb

@@ -7,8 +7,6 @@ require 'processor/subroutine/recursion'
 module Processor
   class Thread
     def initialize(data_processor, *observers)
-      data_processor = Subroutine::Recursion.new(data_processor)
-
       @runner = Runner.new EventProcessor.new(data_processor, observers)
     end
 

data/lib/processor/version.rb

@@ -1,3 +1,3 @@
 module Processor
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: processor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -152,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 81022750956299977
+      hash: 148591874566411659
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 81022750956299977
+      hash: 148591874566411659
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25