jace 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 358835f18e54f117ab1043133ddf2374a5da2cc96ff7ce9c67032adad17abdeb
-  data.tar.gz: ba47115126440c6f78833e3c32444c08bd603eef3dacb74523475a96f1a10f6c
+  metadata.gz: ba76568b768021abe49c12d16b285e9f9ac0d3d631074a1aa8e8d1619d8d397f
+  data.tar.gz: 17a86c3dbe926f9e2fd111eb6c67190421c8d455ffc35c1e9c8b4dab40c80070
 SHA512:
-  metadata.gz: 3f1dedd86ee3e4a1171b6f09b95874bf70e5e2761d989b4d6f72fd916164977994f271ea311ea82858a0e7544c19874683de5c8311b606d50cc58e69fbb8a08a
-  data.tar.gz: 98b468f58c0a46d3c7c1b73df95eb64c856c00f0ed314c5935828ac9024223d328bf0f572620c6921ffc88ee4d8f8f9a3513791e3d2f52804385a9716da1daf0
+  metadata.gz: f156ad1797a018d5c3d16c114156c1613a21315b6707c398471702d90dc7d692a89cf53b14b66631ed33d80a28557eca9e123413339497cff6b8d441f0a9b9d7
+  data.tar.gz: f16a65b15e85ce825edbe8c105ee2a8bb1575831be2e83faa83d8decf64f2bd11fffea311841c4b82420ce551a208819c3ee231ac0dc32567cfdbbdfc4a8e315

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.0
+      - 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

@@ -36,6 +36,15 @@ RSpec/NestedGroups:
   Exclude:
     - 'spec/integration/yard/**/*.rb'
 
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/lib/jace/executer_spec.rb'
+    - 'spec/lib/jace/dispatcher_spec.rb'
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'spec/support/models/person.rb'
+
 Style/HashEachMethods:
   Enabled: true
 

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.1](https://www.rubydoc.info/gems/jace/0.0.1)
+[https://www.rubydoc.info/gems/jace/0.1.0](https://www.rubydoc.info/gems/jace/0.1.0)
+
+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 +1,3 @@
-ignore: []
+ignore:
+  - lib/jace/version.rb
+  - lib/jace.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 100
+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

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.authors               = ['DarthJee']
   gem.email                 = ['darthjee@gmail.com']
   gem.homepage              = 'https://github.com/darthjee/jace'
-  gem.description           = ''
+  gem.description           = 'Gem focused on events for meta-programing'
   gem.summary               = gem.description
   gem.required_ruby_version = '>= 2.5.0'
 
@@ -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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Jace
+  # @api private
+  # @author Dartjee
+  #
+  # Class responsible for executing a given block and triggering event
+  #
+  # The event trigger has phase before and after so all methods
+  # are called before block execution and after, before returning the result
+  class Executer
+    # Calls the execution
+    #
+    # @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
+    # @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 self.call(before: [], after: [], context:, &block)
+      new(before, after, context, &block).call
+    end
+
+    # calls the execution
+    #
+    # @see .call
+    #
+    # @return (see .call)
+    def call
+      execute_actions(before)
+      result = block.call if block
+      execute_actions(after)
+
+      result
+    end
+
+    private
+
+    # @private
+    #
+    # @param (see .call)
+    def initialize(before, after, context, &block)
+      @before = [before].flatten.compact
+      @after = [after].flatten.compact
+      @context = context
+      @block = block
+    end
+
+    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
+    #
+    # @list [Array<Symbol,Proc>] methods and procs to
+    #   be executed
+    #
+    # Execute each proc and call method in the list
+    # within the given context
+    #
+    # @return [Array<Proc>]
+    def execute_actions(list)
+      actions(list).each do |action|
+        context.instance_eval(&action)
+      end
+    end
+
+    # @private
+    #
+    # Transforms the input object into a Proc
+    #
+    # @param list [Symbol,Proc] method or proc to be transformed
+    #
+    # @return [Proc]
+    def actions(list)
+      list.map do |entry|
+        if entry.is_a?(Proc)
+          proc(&entry)
+        else
+          proc { send(entry) }
+        end
+      end
+    end
+  end
+end

data/lib/jace/registry.rb

@@ -0,0 +1,78 @@
+# 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] ||= {}
+      registry[event.to_sym][instant] ||= []
+      registry[event.to_sym][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.new(registry[event.to_sym] || {}).dispatch(context, &block)
+    end
+  end
+end

data/lib/jace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class Jace
-  VERSION = '0.0.1'
+module Jace
+  VERSION = '0.1.0'
 end

data/lib/jace.rb

@@ -2,6 +2,9 @@
 
 # @api public
 # @author darthjee
-class Jace
-  autoload :VERSION, 'jace/version'
+module Jace
+  autoload :VERSION,    'jace/version'
+  autoload :Dispatcher, 'jace/dispatcher'
+  autoload :Executer,   'jace/executer'
+  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