rails_redhot 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '059048dabb167e99b923d1021bf334dc4ed59f4fb0d2306aaa199ade9e1a1b67'
+  data.tar.gz: fcdf3b027a5d62b400ae824caeef344d1aaa91593d197d4e48a7b27c963cd4e3
+SHA512:
+  metadata.gz: 91d1d21a37b5b6f2b7c9e96a5757e848b53ba92430ffbc794a0ed8313281b474dbfa42369492615822753a6b0667ae235e622a8e896000ab2fc369bef9faaf40
+  data.tar.gz: 17714334908de5714a7e18539ae264d4b937373f3e16888f5c07c91d0f3406485183c12d3bf328d65eb31ab086f8d50f48a6b6899b0f656c2c4da1c3ec9fcb8f

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.0.2 - December 10, 2021
+
+[0.0.2]: https://github.com/easydatawarehousing/rails_redhot/compare/v0.0.1...v0.0.2
+
+- Added testset
+- Polished demo application
+
+# 0.0.1 - November 16, 2021
+
+- Initial release, not pulished to rubygems

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Ivo Herweijer
+
+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,141 @@
+# RailsRedhot gem
+__REDux pattern for HOTwire == Redhot__  
+Single page applications using redux (react) are very popular.
+And with good reason, redux makes maintaining the current state of the app easy.
+For instance when building some kind of editor, every action of the user is added
+to the redux store. All actions can be reduced to the determine the current state of
+the editor. Views are rendered using the current state.  
+Or when building a search page for a webshop. Whenever the user selects a category
+or price range to filter on this can be an action for the redux store. If the user
+hits the back button the last action can be deleted and the current state
+regenerated by reducing all remaining actions. The user only sees the last filter
+being reverted to what it was before.  
+Sometimes the actions of the user in the frontend should be sent to a backend
+application. For instance when actions of multiple users should be kept in-sync.
+Often command-query-responsibility-separation (CQRS) is used for this purpose.
+These solutions can become very complex
+([example](https://medium.com/resolvejs/resolve-redux-backend-ebcfc79bbbea)
+scroll down a bit).
+
+The Hotwire (Html Over The Wire) approach does an excellent job of removing the need
+to build single page apps. Hotwire will be the
+[default tool](https://world.hey.com/dhh/the-time-is-right-for-hotwire-ecdb9b33)
+for frontend development in Rails 7.
+However when using hotwire the responsibilty of maintaining frontend state entirely
+falls to the backend application. So when building your editor or search page
+you need a way to keep track of that state. The redux (also known as flux) pattern
+is still very useful for this purpose.
+
+This gem aims to combine html-over-the-wire approach with the redux pattern to
+radically reduce complexity of the overall application.
+(At least when compared to for instance react+cqrs.)
+Only four components are required:
+
+1. Views, normal rails views rendering the current state and delivered as turbo frames
+2. Actions, just (submit) buttons that send a request to the backend
+3. Store, keeping the list of actions and current state, managed by this gem and stored
+   in an activerecord model
+4. Reducers, a set of functions (provided by you) that translate actions to changes in state
+
+Common actions (undo, redo, flatten actions to initial state) are provided by this gem.
+Combined with turbo frames for rendering partial page updates this makes it easy to
+create a very smooth user experience.
+
+## Usage
+Create a migration to add a 'text' type attribute to a model that should have a redux store.
+In the model add an `acts_as_redux` line, specifying the name of the text attribute.
+Add a private method holding all your reducer functions.
+See [this example](test/dummy/app/models/foobar.rb).
+Note that all reducer functions must return the state object (a Hash).
+
+```ruby
+include RailsRedhot::ActsAsRedux
+
+acts_as_redux :my_redux
+
+private
+
+def my_redux_reducers
+->(state, action) {
+  case action[:type]
+  when :add
+    state[:total] += 1
+  when :remove
+    state[:total] -= 1
+  end
+  state
+},
+end
+```
+
+Or specify your own reducer method:
+
+```ruby
+acts_as_redux :my_redux, reducers: :list_of_reducers
+
+def list_of_reducers
+# ...
+```
+
+In your views add some submit buttons for adding and undoing actions.
+See [this example](test/dummy/app/views/foobars/_editor.html.erb).
+And let your controller ([example](test/dummy/app/controllers/foobars_controller.rb))
+process these actions.  
+See section [Demo application](https://github.com/easydatawarehousing/rails_redhot#demo-application)
+for a working example.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_redhot"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails_redhot
+```
+
+## Demo application
+To use the demo application, clone the repo and run rails:
+
+```bash
+git clone https://github.com/easydatawarehousing/rails_redhot.git
+cd rails_redhot
+bundle install
+cd test/dummy
+rails db:setup
+rails server
+```
+
+Open the [application](http://localhost:3000/foobars).
+Click on 'New foobar', 'Add a new foobar' and 'Edit this foobar'.
+
+## Test
+Run:
+
+```bash
+rails test/dummy/test
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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.
+  One would need add 'savepoints' that regularly save the state and rebuild
+  the current state from that point forward
+- No checking on the size of the text attribute used for the store is done
+- Currently only one redux store can be added to a model
+- Redux store code inspired by:
+  - https://gist.github.com/eadz/31c87375722397be861a0dbcf7fb7408
+  - https://github.com/janlelis/redux.rb

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/rails_redhot/acts_as_redux.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module RailsRedhot
+  # Include ActAsRedux module to add redux functionality to Rails
+  module ActsAsRedux
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_redux(store_name, options = {})
+        reducers = options.key?(:reducers) ? options[:reducers] : "#{store_name}_reducers".to_sym
+
+        store(store_name, accessors: [ :initial_state, :state, :actions, :head, :seq_id ], coder: JSON)
+
+        after_initialize :load_store
+
+        define_method('view_state') do
+          state || initial_state || {}
+        end
+
+        define_method('undo?') do
+          head > -1
+        end
+
+        define_method('redo?') do
+          (head + 1) < actions.length
+        end
+
+        define_method('flatten?') do
+          undo?
+        end
+
+        define_method('undo_action') do
+          undo? ? actions[head] : nil
+        end
+
+        define_method('redo_action') do
+          redo? ? actions[head + 1] : nil
+        end
+
+        define_method('undo!') do
+          if undo?
+            self.head -= 1
+            self.state = initial_state
+            if head > -1
+              actions[0..head].each { |action| perform_reduce(action) }
+            else
+              perform_reduce(initial_state)
+            end
+            true
+          else
+            false
+          end
+        end
+
+        define_method('redo!') do
+          if redo?
+            self.head += 1
+            perform_reduce(actions[head])
+            true
+          else
+            false
+          end
+        end
+
+        define_method('flatten!') do
+          self.initial_state = state
+          self.state         = nil
+          self.head          = -1
+          self.actions       = []
+          true
+        end
+
+        define_method('next_seq_id') do
+          self.seq_id += 1
+        end
+
+        define_method('dispatch!') do |action|
+          # Destroy any redo actions
+          self.actions.slice!(head + 1, actions.length - head - 1) if redo?
+
+          self.actions << action
+          self.head += 1
+          perform_reduce(action)
+          true
+        end
+
+        # private
+
+          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?
+          end
+
+          define_method('all_reducers') do
+            send(reducers)
+          end
+
+          define_method('perform_reduce') do |action|
+            self.state = all_reducers.reduce(
+              view_state.dup.deep_symbolize_keys
+            ) do |current_state, reducer|
+              reducer.call(current_state, action.deep_symbolize_keys)
+            end
+          end
+
+          private :load_store, :all_reducers, :perform_reduce,
+                  :initial_state,  :state,  :actions,  :head,
+                  :initial_state=, :state=, :actions=, :head=, :seq_id=
+      end
+    end
+  end
+end

data/lib/rails_redhot/version.rb

@@ -0,0 +1,4 @@
+module RailsRedhot
+  # Gem version
+  VERSION = "0.0.2"
+end

data/lib/rails_redhot.rb

@@ -0,0 +1,6 @@
+require "rails_redhot/version"
+require "rails_redhot/acts_as_redux"
+
+# Module containing all rails_redhot functionality
+module RailsRedhot
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rails_redhot
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ivo Herweijer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0.rc1
+description: REDux pattern for HOTwire == Redhot
+email:
+- info@edwhs.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails_redhot.rb
+- lib/rails_redhot/acts_as_redux.rb
+- lib/rails_redhot/version.rb
+homepage: https://github.com/easydatawarehousing/rails_redhot
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/easydatawarehousing/rails_redhot
+  source_code_uri: https://github.com/easydatawarehousing/rails_redhot
+  changelog_uri: https://github.com/easydatawarehousing/rails_redhot/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: REDux pattern for HOTwire == Redhot
+test_files: []