rails_redhot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5be8aff1e9314532378f476e76fe310b84bfe386abe0ba18c33ec60820696d24
-  data.tar.gz: f77470f8cec6b501c56fb0102e1b63242b0a11a4c453d4bbe3b3068b148b88fe
+  metadata.gz: 2bc4f84383d654009f5141fe5f0b2a7133d92a9cfa7cb8b95be9076430964928
+  data.tar.gz: e41024b7b92269e0d683d639928ce295f17ffff8f43541c6af803d1c96964353
 SHA512:
-  metadata.gz: adbb2a15f3bcffe7b910b05217d5e564125915bd39710347b527a863462fb7bef50951358d0b2d31829994410abca865f88f183abe09e09e0aef8be56956a5bf
-  data.tar.gz: 922d4eac6e294a8f25ac027eca82c457115884758fc785289c79867785618aa0f7a788975e5f66fcb4139bfd819cca39b4b263d6d7d8df989a6cdc03bec8f97d
+  metadata.gz: edbc120531cccaafad095636979183cf818505f7213a4bdc2957f47dc298905c039bbf9897efbf8ae23ba3bb055ae46c0c1132b5f78805a1fb4aa658ff0fc8d7
+  data.tar.gz: 58bab798b14f920c6e037d54afdc57b02ec44000dafacad5adab5c9c10c0bb792d17a340391f31157d793323d8c1e9742960fbf3c0b610e2b46f1cf8a5d68d96

data/CHANGELOG.md

@@ -1,6 +1,15 @@
-# 0.0.2 - December 10, 2021
+# 0.1.1 - April 14, 2022
+
+- Fix calling flatten! multiple times erased initial state
+- Documentation updates
+- Demo application: Use Ruby 3.1.2, Rails 7.0.2
+
+# 0.1.0 - December 30, 2021
 
-[0.0.2]: https://github.com/easydatawarehousing/rails_redhot/compare/v0.0.1...v0.0.2
+- Documentation updates
+- Use Rails 7.0.0
+
+# 0.0.2 - December 10, 2021
 
 - Added testset
 - Polished demo application

data/README.md

@@ -1,34 +1,76 @@
 # RailsRedhot gem
-__REDux pattern for HOTwire == Redhot__  
+### __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 when building a complex 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.
 
+### What is redux?
+```
+It is a store containing a list of changes.
+All changes combined determine the current view state through one or more reducer functions.
+The current view state is also stored.
+If a new change arrives it only needs to be applied to the current view state.
+To undo a change apply all but the last action again to rebuild te view state.
+
+For example a view contains a number counting the likes for an article.
+There are two buttons: increase- and decrease the likes counter.
+Clicking on a button adds an action to the store.
+The action is passed on to all reducer functions,
+each function passes the new computed state on to the next function:
+- If the counter value is nil in the current state set it to zero
+- If the action was 'increase' then increment the counter value
+- If the action was 'decrease' then decrement the counter value
+- If the counter value is lower than zero set it to zero
+Save the new state in the store.
+Render the view showing the updated counter value.
+```
+
+### What are the advantages of redux?
+From the [redux website](https://redux.js.org/) (minus the part about plugins):
+```
+Predictable
+Redux helps you write applications that behave consistently,
+run in different environments (client, server, and native)
+and are easy to test.
+
+Centralized
+Centralizing your application's state and logic enables powerful capabilities
+like undo/redo, state persistence, and much more.
+
+Debuggable
+The Redux DevTools make it easy to trace when, where, why
+and how your application's state changed.
+Redux's architecture lets you log changes, use 'time-travel debugging'
+and even send complete error reports to a server.
+```
+
+### Remove complexity
 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
+In react applications command-query-responsibility-separation (CQRS) is often
+used for this purpose. These solutions can become very complex
 ([example](https://medium.com/resolvejs/resolve-redux-backend-ebcfc79bbbea),
-scroll down a bit for a full example).
+scroll down a bit for a full architecture picture).
 
 The Hotwire (Html Over The Wire) approach does an excellent job of removing the need
-to build single page apps. Hotwire will be the
+to build single page apps. Hotwire is 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.
+you need a way to keep track of that state. The redux (also known as flux- or observer-)
+pattern is very useful for this purpose.
 
+### Hotwire
 This gem aims to combine html-over-the-wire approach with the redux pattern to
-radically reduce complexity of the overall application.
+radically reduce overall complexity of an application.
 (At least when compared to for instance react+cqrs application stacks.)
 Only four components are required:
 
@@ -39,9 +81,16 @@ Only four components are required:
 4. Reducers, a set of functions (provided by you) that translate actions to changes in
    state. The state can be used again in step 1
 
-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.
+### Benefits
+
+- Straightforward workflow
+- 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
+- You can create a store of attributes within a single ActiveRecord model.
+  In a Single Page App (SPA) lots of settings may be needed for a good user
+  experience. It may be a lot of work to store these in multiple models.
+  A redux store can hold an arbitrary amount of attributes
 
 ## Usage
 ### Model
@@ -112,7 +161,7 @@ Methods `flatten?` and `flatten!` can be used in a view and controller:
 ```
 
 ### Sequence ID
-As a convenience a sequence ID id available which should always return a unique id
+As a convenience a sequence ID id is available which should always return a unique id
 (within the context of the model instance). To get the next sequence id use `next_seq_id`,
 to get the current sequence value use `seq_id`.
 You could use a sequence in a reducer function to make sure every added item is assigned a unique id.
@@ -175,7 +224,7 @@ cd rails_redhot
 bundle install
 cd test/dummy
 rails db:setup
-rails server
+bin/dev
 ```
 
 Then open the [application](http://localhost:3000/foobars).

data/lib/rails_redhot/acts_as_redux.rb

@@ -63,7 +63,7 @@ module RailsRedhot
         end
 
         define_method('flatten!') do
-          self.initial_state = state
+          self.initial_state = view_state
           self.state         = nil
           self.head          = -1
           self.actions       = []

data/lib/rails_redhot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_redhot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ivo Herweijer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-04-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.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: REDux pattern for HOTwire == Redhot