edrive 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87b602aac5580212cdda2ac42171483d375e5483cf2a3951a355258054ea68c6
-  data.tar.gz: 8276bd2eba5c98ad4db391c872655922496994625b40d341c1ce98babdab11d8
+  metadata.gz: 7d15d921aedb78d60f0761a60b775f6c4b46d250501c198d17693fe83ddad71a
+  data.tar.gz: 8dd7c8c5b6ad755f598c624ca033e05d322648c837ab1334a20e714a874f28c1
 SHA512:
-  metadata.gz: bf4d32b81ce17027337f76b618ad56617dba5c0b0eb4c484f0a2a1d3f8ca33f3b6cfd8f3d9cb97255862f0e661063045e3b8748fdb413f077849741c80bf2145
-  data.tar.gz: 4faed2572abec5e1335462092541b1ce8ed316f2f9dc90196c1c85d9f8970d32a6bedbf318bb15d397d2a02ccac21e24550cc051873a9f4d1616b0e2d6209dd2
+  metadata.gz: 32304c9cf830abd4053f576fe3e2dea981512790f65fc028f4c3ef7cf6371136299122147c7f2c55b1ce2b61b6c48dc5b4bd7e8304c2e1e4c8711323903f2b44
+  data.tar.gz: e1443d02b252514f2957c6ece035ff0f4a2fb93f88fe1716ec136a8b20d1bb444bfd733757a5af9b6dc5de0003da342cdae5f8555944cc87306ef9b0a638032d

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # # Database setup
+      # - run: bundle exec rake db:create
+      # - run: bundle exec rake db:schema:load
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile.lock

@@ -1,12 +1,14 @@
 PATH
   remote: .
   specs:
-    edrive (1.0.3)
+    edrive (1.0.4)
+      oj (~> 3.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    oj (3.6.2)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -21,6 +23,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
 
 PLATFORMS
   ruby
@@ -30,6 +34,7 @@ DEPENDENCIES
   edrive!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
 
 BUNDLED WITH
    1.16.2

data/README.md

@@ -1,6 +1,8 @@
-# Edrive
+# edrive
 
 [![Gem Version](https://badge.fury.io/rb/edrive.svg)](https://badge.fury.io/rb/edrive)
+[![CircleCI](https://circleci.com/gh/MichinaoShimizu/edrive.svg?style=svg)](https://circleci.com/gh/MichinaoShimizu/edrive)
+[![Maintainability](https://api.codeclimate.com/v1/badges/5ad04170d3d57b928dc6/maintainability)](https://codeclimate.com/github/MichinaoShimizu/edrive/maintainability)
 
 Provide simple event dispatcher mechanism for all of ruby products.
 
@@ -22,7 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
-### lambda & dispatch
+### Edrive::Dispatcher
+
+#### lambda & dispatch
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
@@ -36,7 +40,7 @@ dispatcher.dispatch(:event)
 3
 ```
 
-### lambda & dispatch with data
+#### lambda & dispatch with data
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
@@ -49,7 +53,7 @@ dispatcher.dispatch_with_data(:event, 100)
 106
 ```
 
-### block
+#### block
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
@@ -63,7 +67,7 @@ dispatcher.dispatch(:event)
 3
 ```
 
-### block & dispatch with data
+#### block & dispatch with data
 
 ```ruby
 dispatcher = Edrive::Dispatcher.new
@@ -75,28 +79,37 @@ dispatcher.dispatch_with_data(:event, 100)
 106
 ```
 
-### multi dispatch
+### Edrive::ProcessorDispatcher
 
-```ruby
-dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe(:event) { puts 1 }
-dispatcher.multi_dispatch(3, :event)
+Event dispatcher for processor class inherited `Edrive::Dispatcher` class.
 
-1
-1
-1
-```
+Use `:before_process`, `:after_process` events only in this class.
 
-### multi dispatch with data
+This class has `dispatch_all` method.
 
 ```ruby
-dispatcher = Edrive::Dispatcher.new
-dispatcher.subscribe(:event) { |data| data + 1 }
-dispatcher.multi_dispatch_with_data(3, :event, 0)
+  def dispatch_all(use_result = true)
+    dispatch(DEFINED_EVENT[0])
+    if use_result
+      result = dispatch_processor_process
+      return dispatch_with_data(DEFINED_EVENT[1], result)
+    end
+    dispatch_processor_process
+    dispatch(DEFINED_EVENT[1])
+  end
+```
 
-1
-2
-3
+### Edrive::Handler
+
+sample event handlers.
+
+```ruuby
+require 'edrive'
+
+dispatcher = Edrive::Dispatcher.new
+dispatcher.subscribe(:before, Edrive::Handler.hash2json)
+dispatcher.subscribe(:before, Edrive::Handler.json2hash)
+puts dispatcher.dispatch_with_data(:before, hoge: 2, fuga: 3)
 ```
 
 ### clear target event
@@ -105,7 +118,7 @@ dispatcher.multi_dispatch_with_data(3, :event, 0)
 dispatcher.clear!(:event)
 ```
 
-### clean all event
+### clear all event
 
 ```ruby
 dispatcher.clear_all!

data/edrive.gemspec

@@ -28,10 +28,12 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'oj', '~> 3.6'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
 end

data/lib/edrive.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'edrive/version'
 require 'edrive/dispatcher'
+require 'edrive/processor_dispatcher'
+require 'edrive/handler'
 
+# main module
 module Edrive
   # Your code goes here...
 end

data/lib/edrive/dispatcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Edrive
   # Simple Event Dispatcher
   # @author Michinao Shimizu <shimizu.michinao@gmail.com>
@@ -29,18 +31,6 @@ module Edrive
       result
     end
 
-    # multiple dispatch
-    # @param [Integer] loop_num loop num
-    # @param [Symbol] event event name
-    # @param [Mixed] *args
-    # @return [Mixed] last handler return value
-    def multi_dispatch(loop_num, event, *args)
-      raise ArgumentError, 'loop_num must be integer.' unless loop_num.is_a?(Integer)
-      result = nil
-      loop_num.times { result = dispatch(event, *args) }
-      result
-    end
-
     # dispatch specific event handlers with data
     # @param [Symbol] event event name
     # @param [Mixed] data initial value
@@ -52,19 +42,6 @@ module Edrive
       result
     end
 
-    # multiple dispatch with data
-    # @param [integer] loop_num loop_num
-    # @param [Symbol] event event name
-    # @param [Mixed] data  initial value
-    # @param [Mixed] *args
-    # @return [Mixed] last handler return value
-    def multi_dispatch_with_data(loop_num, event, data, *args)
-      raise ArgumentError, 'loop_num must be integer.' unless loop_num.is_a?(Integer)
-      result = data.dup
-      loop_num.times { result = dispatch_with_data(event, result, *args) }
-      result
-    end
-
     # get event handlers
     # @param [Symbol] event event name symbol
     # @return [Array] registered handler list

data/lib/edrive/handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module Edrive
+  # event handlers sample
+  class Handler
+    class << self
+      # hash to json
+      # @return [Proc] proc hash to json
+      def hash2json
+        ->(hash) { Oj.dump(hash, :compat) }
+      end
+
+      # json to hash
+      # @return [JSON] proc json to hash
+      def json2hash
+        ->(json) { Oj.load(json) }
+      end
+    end
+  end
+end

data/lib/edrive/processor_dispatcher.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'edrive/dispatcher'
+
+# Event Dispatcher For Processors
+# @attr [Processor] processor processor object
+# @attr [Symbol] processor_process processor main method symbol
+# @author shimimi
+class ProcessorDispatcher < Edrive::Dispatcher
+  attr_accessor :processor, :processor_process
+
+  # @return [Array] defined event symbols
+  DEFINED_EVENT = %i[before after].freeze
+
+  # @return [Symbol] default processor process symbol
+  DEFAULT_PROCESSOR_PROCESS = :process
+
+  # Initialize
+  # @param [Processor] processor processor object
+  # @param [Symbol] processor_process processor main method
+  def initialize(processor, processor_process = DEFAULT_PROCESSOR_PROCESS)
+    super()
+    @processor = processor
+    @processor_process = processor_process
+  end
+
+  # subscribe handler (proc, lambda, block)
+  # @param [Symbol] event event name symbol
+  # @param [Proc] handler handler (lambda, proc)
+  # @param [Block] block handler (block)
+  # @raise ArgumentError
+  # @return [Array] registered handler list
+  def subscribe(event, handler = nil, &block)
+    undefined_event_protect(event)
+    super
+  end
+
+  # Dispatch all events
+  # @param [Boolean] use_result use processor process result in after_process event
+  # @return [Mixed] last subscriber return value
+  def dispatch_all(use_result = true)
+    dispatch(DEFINED_EVENT[0])
+    if use_result
+      result = dispatch_processor_process
+      return dispatch_with_data(DEFINED_EVENT[1], result)
+    end
+    dispatch_processor_process
+    dispatch(DEFINED_EVENT[1])
+  end
+
+  # Dispach processor process
+  # @param [Mixed] args
+  # @return [Mixed] processor process return value
+  def dispatch_processor_process(*args)
+    processor.send(processor_process, *args)
+  end
+
+  private
+
+  # Check event is defined or not
+  # @param [Symbol] event event name symbol
+  # @raise ArgumentError
+  def undefined_event_protect(event)
+    raise ArgumentError, "event #{event} is not defined." unless DEFINED_EVENT.include?(event)
+  end
+end

data/lib/edrive/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Edrive
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.0.4'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: edrive
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - MichinaoShimizu
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: "Generic Event Dispatcher.\n  Provide simple event dispatcher mechanism
   for all of ruby products.\n\n  "
 email:
@@ -60,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -72,6 +101,8 @@ files:
 - edrive.gemspec
 - lib/edrive.rb
 - lib/edrive/dispatcher.rb
+- lib/edrive/handler.rb
+- lib/edrive/processor_dispatcher.rb
 - lib/edrive/version.rb
 homepage: https://github.com/MichinaoShimizu/edrive
 licenses: