jace 0.0.2 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48246a546ecbb574464b1e411d4d72c30369eda539c121309d02c9f6d47978e
-  data.tar.gz: 42b96e64f9a04f1e4b0d6eb3430044890ea18b48648bde0c9189be07867c2630
+  metadata.gz: 9deeac89b6a000553037f4d1b46892a6d2a4382e2bd90631b15a8aebf72ef937
+  data.tar.gz: 14f9708ec211705b8cb7c5f34e58b376e69023dc2cabdb3ed99257076499c65f
 SHA512:
-  metadata.gz: 70c38cdaaa607c953d94ce21ad5acead8692e33a383d01d2cb5301fa7ace4dfb7e48c9cd4ec5179c1f1a008277379107374d48931dd604ba9589398ac4973312
-  data.tar.gz: 70785d17966a037cabf6f8f092b23df4215b129265de4fd57f141511bd926596ff1fd9e31340db464d6d0a7e95ba283ff7ef12c3fd4b6fbd0fa5e7006f30fb6f
+  metadata.gz: 2cb63290e009f73af1079d45f2d2498d1c93b645e64cff7351ca1167da542772e684e61eaa016f46c4ea33577633bcb73e136da2cfc3a814e29e61a5427d6cca
+  data.tar.gz: f7bfb72698544a326cca4ae042bd48ddc4e6325839f58ea5516e100f0aef8324dbaced3571b0e44f15c4cd933c2ed15688be92a2adf0808cc0141d8dd8a5e2f4

data/.circleci/config.yml

@@ -1,8 +1,28 @@
 version: 2
+workflows:
+  version: 2
+  test-and-build:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /.*/
+      - checks:
+          filters:
+            tags:
+              only: /.*/
+      - build-and-release:
+          requires: [test, checks]
+          filters:
+            tags:
+              only: /\d+\.\d+\.\d+/
+            branches:
+              only:
+                - master
 jobs:
-  build:
+  test:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.5.2
+      - image: darthjee/circleci_ruby_270:1.1.0
         environment:
           PROJECT: jace
     steps:
@@ -16,12 +36,22 @@ jobs:
       - run:
           name: RSpec
           command: bundle exec rspec
-      - run:
-          name: Rubocop
-          command: rubocop
       - run:
           name: Coverage Test Report
           command: cc-test-reporter after-build --exit-code $?
+  checks:
+    docker:
+      - image: darthjee/circleci_ruby_270:1.1.0
+        environment:
+          PROJECT: jace
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Rubocop
+          command: rubocop
       - run:
           name: Yardstick coverage check
           command: bundle exec rake verify_measurements
@@ -34,3 +64,22 @@ jobs:
       - run:
           name: Check unit tests
           command: check_specs
+  build-and-release:
+    docker:
+      - image: darthjee/circleci_ruby_270:1.1.0
+        environment:
+          PROJECT: jace
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Signin
+          command: build_gem.sh signin
+      - run:
+          name: Build Gem
+          command: build_gem.sh build
+      - run:
+          name: Push Gem
+          command: build_gem.sh push

data/.rubocop.yml

@@ -39,6 +39,7 @@ RSpec/NestedGroups:
 RSpec/InstanceVariable:
   Exclude:
     - 'spec/lib/jace/executer_spec.rb'
+    - 'spec/lib/jace/dispatcher_spec.rb'
 
 Naming/MemoizedInstanceVariableName:
   Exclude:

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.1.7 as scripts
+FROM darthjee/scripts:0.3.1 as scripts
 
-FROM darthjee/ruby_gems:0.5.2 as base
+FROM darthjee/ruby_270:1.1.0 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/README.md

@@ -1,5 +1,5 @@
-Sinclair
-========
+Jace
+====
 [![Code Climate](https://codeclimate.com/github/darthjee/jace/badges/gpa.svg)](https://codeclimate.com/github/darthjee/jace)
 [![Test Coverage](https://codeclimate.com/github/darthjee/jace/badges/coverage.svg)](https://codeclimate.com/github/darthjee/jace/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/jace/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/jace)
@@ -11,23 +11,56 @@ Sinclair
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/jace/0.0.2](https://www.rubydoc.info/gems/jace/0.0.2)
+[https://www.rubydoc.info/gems/jace/0.1.1](https://www.rubydoc.info/gems/jace/0.1.1)
+
+Jace is designed to have a semi event driven development
+
+Using `Jace::Registry`, event handlers can be registered to events, and when an event
+is triggered, the block that triggers it is given to Jace, which will triger, around it,
+the +before+ and +after+ handlers
 
 Installation
 ---------------
 
 - Install it
 
-```ruby
+```bash
   gem install jace
 ```
 
 - Or add Sinclair to your `Gemfile` and `bundle install`:
 
-```ruby
+```bash
   gem 'jace'
 ```
 
 ```bash
   bundle install jace
 ```
+
+Using
+-----
+
+Initialize a registry, register event handlers nad trigger events
+
+```ruby
+  class SomeContext
+    def do_something(instant)
+      puts "doing something #{instant}"
+    end
+  end
+
+  registry = described_class.new
+  context = SomeContext.new
+
+  registry.register(:the_event) { do_something(:after) }
+  registry.register(:the_event, :before) { do_something(:before) }
+
+  registry.trigger(:the_event, context) do
+   context.do_something(:middle)
+  end
+
+  # puts 'doing something before',
+  # puts 'doing something middle',
+  # puts 'doing something after'
+```

data/config/check_specs.yml

@@ -1,2 +1,3 @@
 ignore:
   - lib/jace/version.rb
+  - lib/jace.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 90
+threshold: 84.6
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -15,13 +15,20 @@ rules:
     exclude: []
   ExampleTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Jace::Registry#registry
+      - Jace::Registry#events
   ReturnTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Jace::Executer#before
+      - Jace::Executer#after
   Summary::Presence:
     enabled: true
-    exclude: []
+    exclude:
+      - Jace::Dispatcher#initialize
+      - Jace::Executer#initialize
+      - Jace::Registry#initialize
   Summary::Length:
     enabled: true
     exclude: []

data/jace.gemspec

@@ -19,20 +19,20 @@ Gem::Specification.new do |gem|
   gem.test_files            = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths         = ['lib']
 
-  gem.add_development_dependency 'bundler',            '1.16.1'
-  gem.add_development_dependency 'pry',                '0.12.2'
-  gem.add_development_dependency 'pry-nav',            '0.3.0'
+  gem.add_development_dependency 'bundler',            '2.3.20'
+  gem.add_development_dependency 'pry',                '0.14.1'
+  gem.add_development_dependency 'pry-nav',            '1.0.0'
   gem.add_development_dependency 'rake',               '13.0.1'
-  gem.add_development_dependency 'reek',               '5.6.0'
-  gem.add_development_dependency 'rspec',              '3.9.0'
-  gem.add_development_dependency 'rspec-core',         '3.9.1'
-  gem.add_development_dependency 'rspec-expectations', '3.9.1'
-  gem.add_development_dependency 'rspec-mocks',        '3.9.1'
-  gem.add_development_dependency 'rspec-support',      '3.9.2'
+  gem.add_development_dependency 'reek',               '6.0.3'
+  gem.add_development_dependency 'rspec',              '3.11.0'
+  gem.add_development_dependency 'rspec-core',         '3.11.0'
+  gem.add_development_dependency 'rspec-expectations', '3.11.0'
+  gem.add_development_dependency 'rspec-mocks',        '3.11.1'
+  gem.add_development_dependency 'rspec-support',      '3.11.0'
   gem.add_development_dependency 'rubocop',            '0.80.1'
   gem.add_development_dependency 'rubocop-rspec',      '1.38.1'
-  gem.add_development_dependency 'rubycritic',         '4.4.1'
-  gem.add_development_dependency 'simplecov',          '0.17.1'
-  gem.add_development_dependency 'yard',               '0.9.24'
+  gem.add_development_dependency 'rubycritic',         '4.7.0'
+  gem.add_development_dependency 'simplecov',          '0.21.2'
+  gem.add_development_dependency 'yard',               '0.9.27'
   gem.add_development_dependency 'yardstick',          '0.9.9'
 end

data/lib/jace/dispatcher.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Jace
+  # @api private
+  # @author Darthjee
+  #
+  # Class responsible for dispatching the call of events
+  class Dispatcher
+    # @param before [Symbol,Proc,Array] all the methods / proc
+    #   to be executed before block call
+    # @param after [Symbol,Proc,Array] all the methods / proc
+    #   to be executed after block call
+    def initialize(before: [], after: [])
+      @before = [before].flatten.compact
+      @after = [after].flatten.compact
+    end
+
+    # Dispatch the event call on a context
+    #
+    # @param context [Object] Object where the procs / methods
+    #   will be called on
+    # @block [Proc] bloc to be performed between befores and afters
+    #
+    # @return [Object] result of block call
+    def dispatch(context, &block)
+      Executer.call(
+        before: before,
+        after: after,
+        context: context,
+        &block
+      )
+    end
+
+    private
+
+    attr_reader :before, :after
+
+    # @method before
+    # @private
+    # @api private
+    #
+    # Contains a list of event handlers to be called before
+    #
+    # @return [Array<Object>] list of handlers
+
+    # @method after
+    # @private
+    # @api private
+    #
+    # Contains a list of event handlers to be called after
+    #
+    # @return [Array<Object>] list of handlers
+  end
+end

data/lib/jace/executer.rb

@@ -31,7 +31,7 @@ module Jace
     # @return (see .call)
     def call
       execute_actions(before)
-      result = block.call
+      result = block.call if block
       execute_actions(after)
 
       result
@@ -51,6 +51,44 @@ module Jace
 
     attr_reader :before, :after, :context, :block
 
+    # @method before
+    # @private
+    # @api private
+    #
+    # Contains a list of event handlers to be called before
+    #
+    # @return (see Jace::Dispatcher#before)
+
+    # @method after
+    # @private
+    # @api private
+    #
+    # Contains a list of event handlers to be called after
+    #
+    # @return (see Jace::Dispatcher#after)
+
+    # @method context
+    # @private
+    # @api private
+    #
+    # context where the events handlers will be executed
+    #
+    # all the method calls inside the event handler will be evaluated
+    # from within the context
+    #
+    # @return [Object]
+
+    # @method block
+    # @private
+    # @api private
+    #
+    # block to be executed representing the event
+    #
+    # the block is executed after the +before+ handlers
+    # and before the +after+ handlers
+    #
+    # @return [Proc]
+
     # @private
     #
     # Perform actions from list
@@ -70,18 +108,14 @@ module Jace
 
     # @private
     #
-    # Transforms the input object into a Proc
+    # Transforms the input objects into hadlers
     #
-    # @param list [Symbol,Proc] method or proc to be transformed
+    # @param list [Array<Symbol,Proc>] method or proc to be transformed
     #
-    # @return [Proc]
+    # @return [Array<Handler>]
     def actions(list)
       list.map do |entry|
-        if entry.is_a?(Proc)
-          proc(&entry)
-        else
-          proc { send(entry) }
-        end
+        Handler.new(entry)
       end
     end
   end

data/lib/jace/handler.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Jace
+  # @api private
+  # @author Darthjee
+  #
+  # Handler that will be executed once an event has been triggerd
+  #
+  # Handler will use the given method name or block to execute some code
+  # within the given context
+  class Handler
+    attr_reader :block
+
+    # @overload initialize(method_name)
+    #   @param method_name [Symbol] method to be called in context
+    # @overload initialize(block)
+    #   @param block [Proc] block object to be called within context
+    # @overload initialize(&block)
+    #   @param block [Proc] block to be called within context
+    def initialize(method_name = nil, &block)
+      if block
+        @block = block if block
+      elsif method_name.is_a?(Proc)
+        @block = method_name
+      else
+        @block = proc { send(method_name) }
+      end
+    end
+
+    def call(context)
+      context.instance_eval(&block)
+    end
+
+    def to_proc
+      handler = self
+      proc { |context| handler.call(context) }
+    end
+  end
+end

data/lib/jace/registry.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Jace
+  # @api public
+  # @author Darthjee
+  #
+  # Class responsible for registering handlers to events
+  class Registry
+    # Event & Handlers registry
+    #
+    # @return [Hash] map of all events and the registered handlers
+    def registry
+      @registry ||= {}
+    end
+
+    # Registered events
+    #
+    # @return [Array<Symbol>]
+    def events
+      registry.keys
+    end
+
+    # Register a handler to an event
+    #
+    # @param event [Symbol,String] event name
+    # @param instant [Symbol] intant where the handler will be ran (before or
+    #   after)
+    # @param block [Proc] block to be executed when the event is called
+    #
+    # @return [Array<Proc>]
+    #
+    # @example registering an event
+    #   registry = described_class.new
+    #
+    #   registry.register(:the_event) do
+    #     do_something_after
+    #   end
+    #
+    #   registry.register(:the_event, :before) do
+    #     do_something_before
+    #   end
+    def register(event, instant = :after, &block)
+      registry[event.to_sym] ||= Dispatcher.new
+      registry[event.to_sym].send(instant) << block
+    end
+
+    # Triggers an event
+    # @param event [Symbol,String] event to be triggered
+    # @param context [Object] context where the events will be ran
+    #
+    # @return [Object] the result of the block call
+    #
+    # @example triggering an event
+    #   class SomeContext
+    #     def do_something(instant)
+    #       puts "doing something #{instant}"
+    #     end
+    #   end
+    #
+    #   registry = described_class.new
+    #   context = SomeContext.new
+    #
+    #   registry.register(:the_event) { do_something(:after) }
+    #   registry.register(:the_event, :before) { do_something(:before) }
+    #
+    #   registry.trigger(:the_event, context) do
+    #    context.do_something(:middle)
+    #   end
+    #
+    #   # puts 'doing something before',
+    #   # puts 'doing something middle',
+    #   # puts 'doing something after'
+    def trigger(event, context, &block)
+      dispatcher_for(event).dispatch(context, &block)
+    end
+
+    private
+
+    def dispatcher_for(event)
+      registry[event.to_sym] || Dispatcher.new
+    end
+  end
+end

data/lib/jace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jace
-  VERSION = '0.0.2'
+  VERSION = '0.1.1'
 end

data/lib/jace.rb

@@ -3,6 +3,9 @@
 # @api public
 # @author darthjee
 module Jace
-  autoload :VERSION,  'jace/version'
-  autoload :Executer, 'jace/executer'
+  autoload :VERSION,    'jace/version'
+  autoload :Dispatcher, 'jace/dispatcher'
+  autoload :Executer,   'jace/executer'
+  autoload :Handler,    'jace/handler'
+  autoload :Registry,   'jace/registry'
 end

data/spec/integration/readme/jace/registry_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Jace::Registry do
+  describe 'yard' do
+    subject(:registry) { described_class.new }
+
+    let(:context) { SomeContext.new }
+    let(:expected_texts) do
+      [
+        'doing something before',
+        'doing something middle',
+        'doing something after'
+      ]
+    end
+
+    it 'runs the event handlers' do
+      registry.register(:the_event) { do_something(:after) }
+      registry.register(:the_event, :before) { do_something(:before) }
+
+      registry.trigger(:the_event, context) do
+        context.do_something(:middle)
+      end
+
+      expect(context.text)
+        .to eq(expected_texts)
+    end
+  end
+end

data/spec/integration/yard/jace/registry_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Jace::Registry do
+  describe 'yard' do
+    subject(:registry) { described_class.new }
+
+    describe '#register' do
+      it 'register a new handler for an event' do
+        registry.register(:the_event) do
+          do_something_after
+        end
+      end
+
+      it 'register a new handler for before an event' do
+        registry.register(:the_event, :before) do
+          do_something_before
+        end
+      end
+    end
+
+    describe '#trigger' do
+      let(:context) { SomeContext.new }
+      let(:expected_texts) do
+        [
+          'doing something before',
+          'doing something middle',
+          'doing something after'
+        ]
+      end
+
+      it 'runs the event handlers' do
+        registry.register(:the_event) { do_something(:after) }
+        registry.register(:the_event, :before) { do_something(:before) }
+
+        registry.trigger(:the_event, context) do
+          context.do_something(:middle)
+        end
+
+        expect(context.text)
+          .to eq(expected_texts)
+      end
+    end
+  end
+end