rdux 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f80889d90e6024e5de59e51ee24c2e91dc87499b0dedd84ad0ac3d15a1358226
-  data.tar.gz: b4063bb3cf881541261be635b53820a93b59e6844f8ded7d8424e1dcd9951176
+  metadata.gz: 56611332f7071f2e1b9975e05c8886ff05f6b7107817ee5b71bb36d97e6b720d
+  data.tar.gz: 210f46fd573288d20dbdc38f4fa62c3ecef064ff7cafa48ee0f8549ab631ebcc
 SHA512:
-  metadata.gz: 2f187a3b1131c8db35fe7f09fc7bb284dba17f1c32b78874ccd567592f0bbaba33a1ab7b34b6b7a94874f0153f76a84215afc2e7ac3e34ed4d1a360d424a300e
-  data.tar.gz: b22cc76bbcbbe0dcc55806153ee92705c7054ce5a45486c3241cc1f3f62cf719b5da16fe579481c40107756ae1fc2f2177ce9394b880563ffc46a8d81df3950f
+  metadata.gz: 140e8bb81c6ad284a931a3d5565777c76e57bbc20405e8220846e2d4691635939f4fa0069ce2a22756b5f79e4788a9a873895de36a7b5f7ad07cac3b23d28d35
+  data.tar.gz: e61e3931c6ddd9b206ba58d1eb95d2ca375f6343a61c293198bb24be9f119f2020aebee9a35be2aa664ea59b1a8b8f3372b394b2e2e0748fcde61c17025c3e47

data/README.md

@@ -1,10 +1,26 @@
 # Rdux
-Short description and motivation.
+Minimal take on event sourcing.
 
 ## Usage
 
 ```bash
 $ bin/rails rdux:install:migrations
+$ bin/rails db:migrate
+```
+
+### Code structure
+
+### Dispatch action
+
+```ruby
+Rdux.perform(
+  Activity::Stop,
+  { activity_id: current_activity.id },
+  { activity: current_activity },
+  meta: {
+    stream: { user_id: 123, context: 'foo' }, bar: 'baz'
+  }
+)
 ```
 
 ## Installation
@@ -27,11 +43,9 @@ $ gem install rdux
 ## Test
 
 ```bash
-$ bin/test
+$ DB=postgres bin/test
+$ DB=sqlite bin/test
 ```
 
-## Contributing
-Contribution directions go here.
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -26,4 +26,6 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
+Dir.glob('lib/tasks/**/*.rake').each { |r| import r }
+
 task default: :test

data/app/models/rdux/action.rb

@@ -2,32 +2,75 @@
 
 module Rdux
   class Action < ApplicationRecord
-    def self.table_name_prefix
-      'rdux_'
-    end
+    include Actionable
+
+    belongs_to :rdux_failed_action, optional: true, class_name: 'Rdux::FailedAction'
+    belongs_to :rdux_action, optional: true, class_name: 'Rdux::Action'
+    has_many :rdux_actions, class_name: 'Rdux::Action', foreign_key: 'rdux_action_id'
 
-    serialize :up_payload, JSON
     serialize :down_payload, JSON
 
-    validates :name, presence: true
-    validates :up_payload, presence: true
+    scope :up, -> { where(down_at: nil) }
+    scope :down, -> { where.not(down_at: nil) }
 
-    def up(opts)
-      if opts.any?
-        action_creator.up(up_payload, opts)
-      else
-        action_creator.up(up_payload)
-      end
+    def call(opts = {})
+      perform_action(:call, up_payload, opts)
+    end
+
+    def up(opts = {})
+      return false if up_payload_sanitized
+      return false unless down_at.nil?
+
+      perform_action(:up, up_payload, opts)
     end
 
     def down
-      action_creator.down(down_payload)
+      return false unless down_at.nil?
+      return false unless can_down?
+
+      perform_action(:down, down_payload, build_opts)
+      update(down_at: Time.current)
+    end
+
+    def to_failed_action
+      FailedAction.new(attributes.except('down_payload', 'down_at', 'rdux_action_id'))
     end
 
     private
 
-    def action_creator
-      name.to_s.classify.constantize.new
+    def can_down?
+      q = self.class.where('created_at > ?', created_at)
+              .where(down_at: nil)
+              .where('id != ?', rdux_action_id.to_i)
+      q = q.where(stream_hash: stream_hash) unless stream_hash.nil?
+      !q.count.positive?
+    end
+
+    def action_creator(meth)
+      name_const = name.to_s.classify.constantize
+      return name_const if name_const.respond_to?(meth)
+      return unless name_const.is_a?(Class)
+
+      obj = name_const.new
+      obj.respond_to?(meth) ? obj : nil
+    end
+
+    def perform_action(meth, payload, opts)
+      responder = action_creator(meth)
+      return if responder.nil?
+
+      if opts.any?
+        responder.public_send(meth, payload, opts)
+      else
+        responder.public_send(meth, payload)
+      end
+    end
+
+    def build_opts
+      {}.tap do |h|
+        nested = rdux_actions.order(:created_at)
+        h[:nested] = nested if nested.any?
+      end
     end
   end
 end

data/app/models/rdux/actionable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rdux
+  module Actionable
+    extend ActiveSupport::Concern
+
+    included do
+      serialize :up_payload, JSON
+      serialize :up_result, JSON
+      serialize :meta, JSON
+
+      validates :name, presence: true
+      validates :up_payload, presence: true
+
+      before_save do
+        if meta_changed? && meta['stream'] && (meta_was || {})['stream'] != meta['stream']
+          self.stream_hash = Digest::SHA256.hexdigest(meta['stream'].to_json)
+        end
+      end
+    end
+
+    class_methods do
+      def table_name_prefix
+        'rdux_'
+      end
+    end
+  end
+end

data/app/models/rdux/failed_action.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rdux
+  class FailedAction < ApplicationRecord
+    include Actionable
+
+    belongs_to :rdux_failed_action, optional: true, class_name: 'Rdux::FailedAction'
+    has_many :rdux_failed_actions, class_name: 'Rdux::FailedAction', foreign_key: 'rdux_failed_action_id'
+    has_many :rdux_actions, class_name: 'Rdux::Action', foreign_key: 'rdux_failed_action_id'
+  end
+end

data/db/migrate/20230621215717_create_rdux_failed_actions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateRduxFailedActions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :rdux_failed_actions do |t|
+      t.string :name, null: false
+      t.column :up_payload, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text), null: false
+      t.boolean :up_payload_sanitized, default: false
+      t.column :up_result, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text)
+      t.column :meta, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text)
+      t.string :stream_hash
+
+      t.belongs_to :rdux_failed_action, index: true, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230621215718_create_rdux_actions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class CreateRduxActions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :rdux_actions do |t|
+      t.string :name, null: false
+      t.column :up_payload, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text), null: false
+      t.column :down_payload, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text)
+      t.datetime :down_at
+      t.boolean :up_payload_sanitized, default: false
+      t.column :up_result, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text)
+      t.column :meta, (ActiveRecord::Base.connection.adapter_name == 'PostgreSQL' ? :jsonb : :text)
+      t.string :stream_hash
+
+      t.belongs_to :rdux_action, index: true, foreign_key: true
+      t.belongs_to :rdux_failed_action, index: true, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/rdux/result.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 module Rdux
-  Result = Struct.new(:ok, :down_payload, :resp, :action) do
+  Result = Struct.new(:ok, :down_payload, :resp, :action, :up_result, :nested, :save) do
     def payload
       resp || down_payload
     end
+
+    def save_failed?
+      ok == false && save
+    end
   end
 end

data/lib/rdux/sanitize.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rdux
+  module Sanitize
+    class << self
+      def call(payload)
+        filtered_payload = payload.deep_dup # Create a duplicate to avoid modifying the original params
+        Rails.application.config.filter_parameters.each do |filter_param|
+          filter_recursive(filtered_payload, filter_param)
+        end
+        filtered_payload
+      end
+
+      private
+
+      def filter_recursive(payload, filter_param)
+        payload.each do |key, value|
+          if value.is_a? Hash # If the value is a nested parameter
+            filter_recursive(value, filter_param)
+          elsif key == filter_param.to_s # to_s is used to ensure that symbol/string difference does not matter
+            payload[key] = '[FILTERED]'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rdux
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/rdux.rb

@@ -1,19 +1,82 @@
 # frozen_string_literal: true
 
 require 'rdux/engine'
-
 require 'rdux/result'
+require 'rdux/sanitize'
+require 'active_support/concern'
 
 module Rdux
-  module_function
-
-  def dispatch(action_name, payload, opts = {})
-    action = Action.new(name: action_name, up_payload: payload)
-    res = action.up(opts)
-    action.down_payload = res.down_payload
-    res.down_payload = action.down_payload
-    action.save! if res.ok
-    res.action = action
-    res
+  class << self
+    def dispatch(action_name, payload, opts = {}, meta: nil)
+      (opts[:ars] || {}).each { |k, v| payload["#{k}_id"] = v.id }
+      action = Action.new(name: action_name, up_payload: payload, meta: meta)
+      call_call_meth_on_action(action, opts)
+    end
+
+    alias perform dispatch
+
+    private
+
+    def call_call_meth_on_action(action, opts)
+      res = action.call(opts)
+      return call_up_meth_on_action(action, opts) if res.nil?
+
+      unless res.down_payload.nil?
+        res.resp = res.down_payload.deep_stringify_keys
+        res.down_payload = nil
+      end
+      assign_and_persist(res, action)
+    end
+
+    def call_up_meth_on_action(action, opts)
+      res = action.up(opts)
+      res.down_payload&.deep_stringify_keys!
+      action.down_payload = res.down_payload
+      assign_and_persist(res, action)
+    end
+
+    def assign_and_persist(res, action)
+      if res.ok
+        assign_and_persist_for_ok(res, action)
+      elsif res.save_failed?
+        assign_and_persist_for_failed(res, action)
+      end
+      res.action ||= action
+      res
+    end
+
+    def assign_and_persist_common(res, action)
+      sanitize(action)
+      action.up_result = res.up_result
+    end
+
+    def assign_and_persist_for_ok(res, action)
+      assign_and_persist_common(res, action)
+      res.nested&.each { |nested_res| action.rdux_actions << nested_res.action }
+      action.save!
+    end
+
+    def assign_and_persist_for_failed(res, action)
+      assign_and_persist_common(res, action)
+      action.up_result ||= res.resp
+      res.action = action.to_failed_action.tap(&:save!)
+      assign_nested_responses_to_failed_action(res.action, res.nested) unless res.nested.nil?
+    end
+
+    def assign_nested_responses_to_failed_action(failed_action, nested)
+      nested.each do |nested_res|
+        if nested_res.action.is_a?(Rdux::Action)
+          failed_action.rdux_actions << nested_res.action
+        else
+          failed_action.rdux_failed_actions << nested_res.action
+        end
+      end
+    end
+
+    def sanitize(action)
+      up_payload_sanitized = Sanitize.call(action.up_payload)
+      action.up_payload_sanitized = action.up_payload != up_payload_sanitized
+      action.up_payload = up_payload_sanitized
+    end
   end
 end

data/lib/tasks/test.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :test do
+  desc 'Run tests with the SQLite database'
+  task :sqlite do
+    # Set an environment variable to change the database configuration
+    ENV['DB'] = 'sqlite'
+    Rake::Task['test'].invoke
+  end
+
+  desc 'Run tests with the Postgres database'
+  task :postgres do
+    ENV['DB'] = 'postgres'
+    Rake::Task['test'].invoke
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdux
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Zbigniew Humeniuk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,48 +30,62 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.48'
+        version: 1.54.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.48'
+        version: 1.54.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: 2.20.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: 2.20.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.6.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.6.3
 description: |
   Write apps that are easy to test.
   Rdux gives you a possibility to centralize your app's state modification logic (DB changes).
@@ -88,11 +102,16 @@ files:
 - README.md
 - Rakefile
 - app/models/rdux/action.rb
-- db/migrate/20200823045609_create_rdux_actions.rb
+- app/models/rdux/actionable.rb
+- app/models/rdux/failed_action.rb
+- db/migrate/20230621215717_create_rdux_failed_actions.rb
+- db/migrate/20230621215718_create_rdux_actions.rb
 - lib/rdux.rb
 - lib/rdux/engine.rb
 - lib/rdux/result.rb
+- lib/rdux/sanitize.rb
 - lib/rdux/version.rb
+- lib/tasks/test.rake
 homepage: https://artofcode.co
 licenses:
 - MIT
@@ -113,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Rdux adds a new layer to Rails apps - actions.

data/db/migrate/20200823045609_create_rdux_actions.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-class CreateRduxActions < ActiveRecord::Migration[6.0]
-  def change
-    create_table :rdux_actions do |t|
-      t.string :name
-      t.text :up_payload
-      t.text :down_payload
-
-      t.timestamps
-    end
-  end
-end