evento 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33a11251bc4492d972009aabaaec9a203c978a7c805e0c0706153c808ffbea0e
+  data.tar.gz: 7916a8323786c8e7bafd6a435882e603222710915e234fa45f8cf0a5c067ba95
+SHA512:
+  metadata.gz: 3fd000cffd86dbdff3d89537f21189c8d3204a479b8c0352a9145eedf1bfec4586da1d606473f290c41be74a89bed8a7bba44795a1446b8af6cbfc003d535f69
+  data.tar.gz: 95d53b17b4895393ed63be6bd0cf0c1fe1c42fe689b81cfc0a118ee8ab076921894a8758adf059b6048d51ab12d4eabc8b4bb70db23a1d8aa25105726b58c137

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:entdec) { |repo_name| "git@code.entropydecelerator.com:#{repo_name}.git" }
+
+# Specify your gem's dependencies in evento.gemspec
+gemspec
+
+gem 'auxilium', '~> 0.2', entdec: 'components/auxilium'

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GIT
+  remote: git@code.entropydecelerator.com:components/auxilium.git
+  revision: 90a6531ca2ebdf62df3921b6ec3b0bba07b38989
+  specs:
+    auxilium (0.2.0)
+      activesupport (> 5.1)
+
+PATH
+  remote: .
+  specs:
+    evento (0.1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aasm (5.0.8)
+      concurrent-ruby (~> 1.0)
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      arel (>= 9.0)
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.83.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    state_machines (0.5.0)
+    state_machines-activemodel (0.7.1)
+      activemodel (>= 4.1)
+      state_machines (>= 0.5.0)
+    state_machines-activerecord (0.6.0)
+      activerecord (>= 4.1)
+      state_machines-activemodel (>= 0.5.0)
+    state_machines-audit_trail (2.0.1)
+      state_machines
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aasm (~> 5.0)
+  activerecord (~> 5.2)
+  auxilium (~> 0.2)!
+  evento!
+  i18n (~> 1.8)
+  minitest (~> 5.0)
+  pry (~> 0.13)
+  rake (~> 12.0)
+  rubocop (~> 0.83)
+  sqlite3 (~> 1.4)
+  state_machines (~> 0.5)
+  state_machines-activerecord (~> 0.6)
+  state_machines-audit_trail (~> 2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mark Cornelissen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Evento
+
+With Evento you can hook into events generated by AASM, state\_machines and Devise.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'evento'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install evento
+
+## Usage
+
+You can create methods based on events methods from AASM or state\_machines in another class:
+
+```ruby
+orchestrator = Evento::Orchestrator.new(Order)
+orchestrator.define_event_methods_on(OrderEventHandler, state_machine: true) do |your, own, parameters, here|
+  # your code here
+end
+```
+
+If you're using devise you can also create event methods based on that:
+
+```ruby
+orchestrator = Evento::Orchestrator.new(User)
+orchestrator.define_event_methods_on(UserEventHandler, devise: true) do |your, own, parameters, here|
+  # your code here
+end
+```
+
+If you set both teh state\_machine and devise options methods for both will be created in one go.
+Existing method will *not* be overwritten using this method.
+
+You can also override Devise's send\_devise\_notification method:
+
+```ruby
+orchestrator = Evento::Orchestrator.new(User)
+orchestrator.override_devise_notification do |notification, *devise_params|
+  # your own notification logic here...
+end
+```
+
+The above *will* overwrite the existing method .
+
+If you're using state\_machines with state\_machines-audit\_trail you can add add after\_commit hooks like so:
+
+```
+orchestrator = Evento::Orchestrator.new(Order)
+orchestrator.after_audit_trail_commit(:unique_name) do |audit_trail_record|
+  # your own code here ... you could for example hook into the handler methods you created earlier with something like the below:
+  # handler = OrderEventHandler.new(audit_trail_record.resource).public_send(event.to_s, your, own, parameters, here)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/evento.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test
+
+# Adds the Auxilium semver task
+spec = Gem::Specification.find_by_name 'auxilium'
+load "#{spec.gem_dir}/lib/tasks/semver.rake"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'evento'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/evento.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/evento/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'evento'
+  spec.version       = Evento::VERSION
+  spec.authors       = ['Mark Cornelissen']
+  spec.email         = ['mark@boxture.com']
+
+  spec.summary       = 'Evento helps you use events'
+  spec.description   = 'Use Evento to hook into events generated by AASM, state\_machines and Devise'
+  spec.homepage      = 'https://code.entropydecelerator.com/components/evento'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_development_dependency 'aasm', '~> 5.0'
+  spec.add_development_dependency 'activerecord', '~> 5.2'
+  spec.add_development_dependency 'auxilium', '~> 0.2'
+  spec.add_development_dependency 'i18n', '~> 1.8'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.83'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'state_machines', '~> 0.5'
+  spec.add_development_dependency 'state_machines-activerecord', '~> 0.6'
+  spec.add_development_dependency 'state_machines-audit_trail', '~> 2'
+end

data/lib/evento/extractor.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Evento
+  class Extractor
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def extract_transaction_log_association
+      reflection = extract_association_reflection(klass, :transaction_log_entries)
+
+      reflection&.klass
+    end
+
+    def extract_audit_trail_association(options = {})
+      name       = (options[:name] || :resource_state_transitions).to_sym
+      reflection = extract_association_reflection(klass, name)
+
+      return reflection if options[:reflection]
+
+      reflection&.klass
+    end
+
+    def extract_events(options = {})
+      events = []
+      events += events_from_state_machine.map(&:to_s) if options[:state_machine]
+      events += events_from_devise if options[:devise]
+      events.sort
+    end
+
+    private
+
+    def extract_association_reflection(klass, name)
+      klass.reflect_on_all_associations.find { |a| a.name == name } if klass.respond_to?(:reflect_on_all_associations)
+    end
+
+    def events_from_state_machine
+      if klass.respond_to?(:aasm)
+        klass.aasm.events.map(&:name)
+      elsif klass.respond_to?(:state_machine) && klass.state_machine.respond_to?(:events)
+        klass.state_machine.events.map(&:name)
+      else
+        []
+      end
+    end
+
+    def events_from_devise
+      I18n.t('devise.mailer').keys.map(&:to_s)
+    end
+  end
+end

data/lib/evento/orchestrator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Evento
+  class Orchestrator
+    attr_reader :klass
+
+    def initialize(klass, options = {})
+      @klass     = klass
+      @options   = options
+      @extractor = nil
+    end
+
+    def after_transaction_log_commit(name, &block)
+      association = extractor.extract_transaction_log_association
+      after_association_commit(association, name, &block)
+    end
+
+    def after_audit_trail_commit(name, &block)
+      association = extractor.extract_audit_trail_association(extract_audit_trail_options)
+      after_association_commit(association, name, &block)
+    end
+
+    def define_event_methods_on(target_klass, options = {}, &block)
+      extractor.extract_events(state_machine: options[:state_machine], devise: options[:devise])
+               .reject { |event_name| target_klass.method_defined?(event_name) }
+               .each do |event_name|
+        target_klass.send(:define_method, event_name, &block)
+      end
+
+      return unless options[:life_cycle]
+
+      %i[create destroy update save].each do |event_name|
+        target_klass.send(:define_method, event_name, &block) unless target_klass.method_defined?(event_name)
+      end
+    end
+
+    def override_devise_notification(&block)
+      # As this is an override, ignore checking if it exists
+      klass.define_method(:send_devise_notification, block)
+    end
+
+    private
+
+    def after_association_commit(association, name, &block)
+      return unless association
+
+      tracker = "#{association.name.underscore.gsub('/',
+                                                    '__')}_after_commit_#{name.to_s.underscore.gsub('/', '__')}".upcase
+      return if self.class.const_defined?(tracker, false)
+
+      association.after_commit(&block)
+      self.class.const_set(tracker, true)
+    end
+
+    def extract_audit_trail_options
+      { name: @options[:audit_trail_name] }
+    end
+
+    def extractor
+      return @extractor if @extractor
+
+      @extractor = Extractor.new(klass)
+    end
+  end
+end

data/lib/evento/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Evento
+  VERSION = '0.1.7'
+end

data/lib/evento.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'evento/version'
+
+module Evento
+  class Error < StandardError; end
+end
+
+require 'evento/extractor'
+require 'evento/orchestrator'

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: evento
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Mark Cornelissen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: auxilium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.83'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: state_machines
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: state_machines-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: state_machines-audit_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Use Evento to hook into events generated by AASM, state\_machines and
+  Devise
+email:
+- mark@boxture.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- evento.gemspec
+- lib/evento.rb
+- lib/evento/extractor.rb
+- lib/evento/orchestrator.rb
+- lib/evento/version.rb
+homepage: https://code.entropydecelerator.com/components/evento
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Evento helps you use events
+test_files: []