rails_redhot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bc4f84383d654009f5141fe5f0b2a7133d92a9cfa7cb8b95be9076430964928
-  data.tar.gz: e41024b7b92269e0d683d639928ce295f17ffff8f43541c6af803d1c96964353
+  metadata.gz: 8f5c72d2cc5029c74afb124b5bbc728d007f4d635ad9569781cdd5b2fa3f6e25
+  data.tar.gz: eaca540b27f70101cefaee8d29e78ab843c12d873ee89bc382b28a0af963ee28
 SHA512:
-  metadata.gz: edbc120531cccaafad095636979183cf818505f7213a4bdc2957f47dc298905c039bbf9897efbf8ae23ba3bb055ae46c0c1132b5f78805a1fb4aa658ff0fc8d7
-  data.tar.gz: 58bab798b14f920c6e037d54afdc57b02ec44000dafacad5adab5c9c10c0bb792d17a340391f31157d793323d8c1e9742960fbf3c0b610e2b46f1cf8a5d68d96
+  metadata.gz: 3029222021c8639cba0a7d60e9684e4571bbcd391c1a8884fdf2386b0a0c0b6b28afb4e85816a9f6f6f95d50a80825de754e2dc74939ca4511f0c6eb6c57fa3b
+  data.tar.gz: 6a27cf8634d4ccb20e833a79352ab810d2fe674c2e077a2a9c672d993657d7eb90a9ce2af7bbbd6e72981f03f11c22b4953c92e636bea25c6c2cabe1f8b70940

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.2.0 - March 14, 2023
+
+- Demo application: Use Ruby 3.2.0, Rails 7.0.4.2
+- Added simplecov and improve testcoverage
+- Added reducer errors (ActiveModel::Errors), separate from the models own error object
+- Use deep_dup before dispatching an action to make sure the original action is never
+  modified by reducer methods. Use deep_symbolize_keys on an action for convenience
+- Added after_change callback
+
 # 0.1.1 - April 14, 2022
 
 - Fix calling flatten! multiple times erased initial state
@@ -16,4 +25,4 @@
 
 # 0.0.1 - November 16, 2021
 
-- Initial release, not pulished to rubygems
+- Initial release, not published to rubygems

data/README.md

@@ -109,15 +109,17 @@ class Foobar < ApplicationRecord
   private
 
   def my_redux_reducers
-  ->(state, action) {
-    case action[:type]
-    when :add
-      state[:total] += 1
-    when :remove
-      state[:total] -= 1
-    end
-    state
-  },
+    [
+      ->(state, action) {
+        case action[:type]
+        when :add
+          state[:total] += 1
+        when :remove
+          state[:total] -= 1
+        end
+        state
+      }
+    ]
   end
 end
 ```
@@ -128,7 +130,7 @@ Or specify your own reducer method:
 acts_as_redux :my_redux, reducers: :my_list_of_reducers
 
 def my_list_of_reducers
-# ...
+  # ...
 ```
 
 ### Undo/redo
@@ -148,7 +150,8 @@ In the controller action use the `undo!` method to perform the action.
 For redoing actions the similar methods `redo?`, `redo_action` and `redo!` are available.
 
 ### Flatten
-You can 'save' the current state. Essentially this flattens the list of actions to the initial state.
+You can 'save' the current state. Essentially this copies the current view state to the initial state
+and truncates the list of actions. Redo and undo are not possible until new actions are added.
 Methods `flatten?` and `flatten!` can be used in a view and controller:
 
 ```ruby
@@ -192,11 +195,86 @@ on the reducer functions you have implemented.
 For a full working example see the demo applications [view](test/dummy/app/views/foobars/_editor.html.erb)
 and [controller](test/dummy/app/controllers/foobars_controller.rb).
 
+### Adding errors
+Just like you can add validation errors on a model, you can add errors inside your reducer methods.
+There is an ActiveModel::Errors object for redux errors. It is separate from the one for the model and
+can be accessed via `reduce_errors`. Use it like this:
+
+```ruby
+def my_redux_reducers
+  @my_redux_reducers ||= [
+    -> (state, action) {
+      case action[:type]&.to_sym
+      when :add
+        if action[:item].length <= 6
+          state[:items] << { id: next_seq_id, value: CGI.escape(action[:item]) }
+        else
+          reduce_errors.add(:item, :too_long, { count: 6 })
+        end
+      end
+
+      state
+    }
+  ]
+end
+```
+
+Since ActiveModel does not know anything about attributes living inside your redux store
+using `reduce_errors.full_messages` won't work. You can create you own error to message translation or
+supply `:base` as the attribute name plus a message.
+See the [Rails documentation](https://api.rubyonrails.org/classes/ActiveModel/Errors.html#method-i-add).
+
+```ruby
+reduce_errors.add(:base, message: 'Item should have between 1 and 6 characters')
+```
+
+If any reduce error is present the `dispatch!` method will return false.
+To check if there are any errors present (to prevent saving the model) use:
+
+```ruby
+@foobar.reduce_valid?
+```
+
+In the controller you may want to reload the model if the dispatch action gave an error,
+so the old state is rendered.
+
+### After change callback
+Sometimes you want to do something after the redux store has changed.
+For instance to manipulate the view state based on all entries
+(the reducer methods only handle one action at the time).
+This callback method is called after `dispatch!`, `undo!` and `redo!`.
+In the model:
+
+```ruby
+class AnotherFooBar < ApplicationRecord
+  include RailsRedhot::ActsAsRedux
+
+  acts_as_redux :another_redux_store, after_change: :my_after_change_actions
+
+  private
+
+    def another_redux_store_reducers
+      [
+        -> (state, _action) {
+          state[:items] ||= []
+          state
+        },
+        # ...
+      ]
+    end
+
+    def my_after_change_actions
+      # Do something with the view_state
+      # view_state[:items].each { do_something }
+    end
+end
+```
+
 ## Security
-Care must be taken to not introduce any vulnerabilities.
+Care must be taken to not introduce any vulnerabilities!
 When passing values from the request to the reducer functions treat any string or complex
-values as potential candidates for SQL injection. Either sanitize the value or `CGI.escape`
-a string before adding it to the redux store.
+values as potential candidates for SQL injection. Either sanitize or `CGI.escape`
+strings before adding them to the redux store.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -242,10 +320,9 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Remarks
 
-- Developed using Ruby 3.0.3
 - This gem is not designed to handle very large lists of actions and state.
-  When calling `undo` the state is rebuilt from scratch
-  If the list of actions to process is large this would become slow.
+  When calling `undo` the state is rebuilt from scratch,
+  if the list of actions to process is large this would become slow.
   One would need add 'savepoints' that regularly save the state and rebuild
   the current state from that point forward
 - Stricly speaking, hotwire is not needed for this gem to work. Just using

data/lib/rails_redhot/acts_as_redux.rb

@@ -8,6 +8,8 @@ module RailsRedhot
     class_methods do
       def acts_as_redux(store_name, options = {})
         reducers = options.key?(:reducers) ? options[:reducers] : "#{store_name}_reducers".to_sym
+        reducer_errors = nil
+        reducer_after_change = options[:after_change]
 
         store(store_name, accessors: [ :initial_state, :state, :actions, :head, :seq_id ], coder: JSON)
 
@@ -43,8 +45,7 @@ module RailsRedhot
             self.state = initial_state
             if head > -1
               actions[0..head].each { |action| perform_reduce(action) }
-            else
-              perform_reduce(initial_state)
+              self.send(reducer_after_change) if reducer_after_change
             end
             true
           else
@@ -56,6 +57,7 @@ module RailsRedhot
           if redo?
             self.head += 1
             perform_reduce(actions[head])
+            self.send(reducer_after_change) if reducer_after_change
             true
           else
             false
@@ -70,6 +72,14 @@ module RailsRedhot
           true
         end
 
+        define_method('reduce_errors') do
+          reducer_errors
+        end
+
+        define_method('reduce_valid?') do
+          reducer_errors.details.empty?
+        end
+
         define_method('next_seq_id') do
           self.seq_id += 1
         end
@@ -80,19 +90,29 @@ module RailsRedhot
 
           self.actions << action
           self.head += 1
-          perform_reduce(action)
-          true
+          perform_reduce(action.deep_dup.deep_symbolize_keys)
+          self.send(reducer_after_change) if reducer_after_change
+          reduce_valid?
         end
 
         # private
 
+          define_method('reset_reduce_errors') do
+            reducer_errors = ActiveModel::Errors.new(self)
+          end
+
           define_method('load_store') do
             self.initial_state ||= {}
             # self.state is initially nil: no need to store state twice when there are no actions
             self.head          ||= -1
             self.actions       ||= []
             self.seq_id        ||= 0
-            perform_reduce({}) if state.blank? && initial_state.blank?
+
+            if state.blank? && initial_state.blank?
+              perform_reduce({})
+            else
+              reset_reduce_errors
+            end
           end
 
           define_method('all_reducers') do
@@ -100,10 +120,12 @@ module RailsRedhot
           end
 
           define_method('perform_reduce') do |action|
+            reset_reduce_errors
+
             self.state = all_reducers.reduce(
-              view_state.dup.deep_symbolize_keys
+              view_state.deep_dup.deep_symbolize_keys
             ) do |current_state, reducer|
-              reducer.call(current_state, action.deep_symbolize_keys)
+              reducer.call(current_state, action)
             end
           end
 

data/lib/rails_redhot/version.rb

@@ -1,4 +1,4 @@
 module RailsRedhot
   # Gem version
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_redhot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ivo Herweijer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: REDux pattern for HOTwire == Redhot