rydux 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 227768589d0be878a92145d23af95c075d3cf198
-  data.tar.gz: 37220686166c5b47e4787751dc712ff19e96eae3
+  metadata.gz: ff4a7bee8b3d4dcba4b03571e76464b0ca723726
+  data.tar.gz: 30356e6ededd51f480f9b148f271228708339136
 SHA512:
-  metadata.gz: 9bbd10687936395ac6da6b8948a7bf7d08fb3651eafc2692a21a708ca3a2a10b33aa7a8bcc12374ce4a05673dbc54f294decfaca9156be423e1670514771e50f
-  data.tar.gz: ee787426f33df12e0a1f6fc352b8c7323f3f73fab99303c7395b17796449bd27e214e215544bb9e17b4c6d72687fa8db4c2484eb27b3618f996d66a050a1832a
+  metadata.gz: 52d1ddfb5a9860ee19c7b5bc43f8945f039116e516db46547bb755f8c274c26d06ef5c3e9cd7538e042bf92bc0f20d093492da07fe83ce72f0a1cc06de0d92c5
+  data.tar.gz: dc65de528f92a9d1863c0849d15dfe95a46accb3c4eba51b0e98f962549c4de4e7eb8e6a5f0b48c484be871f9392ebe8047f770f0c9809eb9621043bb9327439

data/README.md

@@ -65,7 +65,7 @@ Or install it yourself as:
       # Every instance that subscribes to the store will
       # get this state_changed method called whenever the state
       # in the store changes. Do whatever you want with your state here.
-      def state_changed(state, last_dispatch_type)
+      def state_changed(state)
         # ...
       end
     end
@@ -102,7 +102,7 @@ class Friend
     @users_name = Store.state.user.name
   end
 
-  def state_changed(state, last_dispatch_type)
+  def state_changed(state)
     @users_name = state.user.name
   end
 
@@ -120,6 +120,9 @@ Store.dispatch(type: 'CHANGE_USER_NAME', payload: { name: 'Mike' })
 friend.greet_user #=> Hello, Mike
 ```
 
+View the [Documentation](https://github.com/alexdovzhanyn/rydux/wiki) for more information
+on methods and parameters
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rydux/reducer.rb

@@ -1,7 +1,6 @@
 module Rydux
   class Reducer
     def self.map_state(action, state = {})
-
     end
   end
 end

data/lib/rydux/state.rb

@@ -3,9 +3,8 @@ require 'ostruct'
 module Rydux
   class State < OpenStruct
     def initialize(state)
-      state = state.clone
       super(state)
-      @structure = state
+      @structure = state.clone
     end
 
     def to_s

data/lib/rydux/store.rb

@@ -2,21 +2,9 @@ module Rydux
   class Store
     attr_reader :listeners
 
-    def initialize(combined_reducers)
-      @state = {}
-      @listeners = []
-      @reducers = combined_reducers
-
-      @reducers.each do |k, reducer|
-        if !reducer.ancestors.include? ::Rydux::Reducer
-          raise "Store expected a Reducer or array of reducers, but instead got: #{reducers}"
-        end
-
-        new_state = {}
-        new_state[k] = reducer.map_state(type: nil)
-
-        set_state(new_state)
-      end
+    def initialize(reducers)
+      @state, @listeners = {}, []
+      @reducers = strap_reducers(reducers)
     end
 
     def subscribe(listener)
@@ -28,38 +16,62 @@ module Rydux
       @listeners.delete(listener)
     end
 
-    def dispatch(action)
-      @reducers.each do |k, reducer|
-        new_state = {}
-        new_state[k] = reducer.map_state(action, state[k])
-        set_state(new_state, action[:type])
+    # Dispatches an action to all reducers. Can be called any of the following ways:
+    # Takes in an action and an optional callback proc, which will be called after the
+    # dispatch is finished.
+    # The action can be passed in either as a hash or as two seperate arguments.
+    # E.g. dispatch({ type: 'SOME_ACTION', payload: { key: 'value' } })
+    # is the same as dispatch('SOME_ACTION', { key: 'value' })
+    # Here's an example with a proc: dispatch('SOME_ACTION', { key: 'value' }, ->{ puts "The dispatch is done" })
+    def dispatch(*args)
+      if args.first.is_a? Hash
+        _dispatch(args.first, args[1])
+      else
+        if args[1].is_a? Proc
+          _dispatch({ type: args.first }, args[1])
+        else
+          _dispatch({ type: args.first, payload: args[1] }, args[2])
+        end
       end
     end
 
+    # Return a clone of the current state so that the user cannot directly
+    # modify state, and introduce side effects
     def state
       State.new(@state)
     end
 
     private
 
-      def set_state(new_state, last_dispatch = nil)
-        new_state.each do |k, v|
-          @state[k] = v
+      def _dispatch(action, callback = ->{})
+        @reducers.each {|k, reducer| set_state *[k, reducer.map_state(action, state[k])] }
+        callback.call if callback
+      end
 
-          if !self.methods.include? k
-            self.define_singleton_method(k.to_sym) do
-              return State.new(state[k])
-            end
-          end
+      # Initialize state with the key-value pair associated with each reducer
+      def strap_reducers(reducers)
+        reducers.each {|k, reducer| set_state *[k, reducer.map_state(type: nil)]}
+        reducers
+      end
 
-          notify_listeners(last_dispatch)
+      # Argument 1 should always be the key within state that we're mutating
+      # Argument 2 should be the actual state object
+      def set_state(k, v)
+        @state[k] = v
+
+        if !self.methods.include? k
+          self.define_singleton_method(k.to_sym) do
+            return State.new(@state[k])
+          end
         end
+
+        notify_listeners
       end
 
-      def notify_listeners(last_dispatch)
+      def notify_listeners
         @listeners.each do |listener|
           if listener.respond_to? :state_changed
-            listener.public_send(:state_changed, state, last_dispatch)
+            listener.public_send(:state_changed, state)
           end
         end
       end

data/lib/rydux/version.rb

@@ -1,3 +1,3 @@
 module Rydux
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/lib/rydux.rb

@@ -2,7 +2,6 @@ require "rydux/version"
 require "rydux/store"
 require "rydux/state"
 require "rydux/reducer"
-require "rydux/rydux"
 
 module Rydux
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rydux
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Alex Dovzhanyn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,6 @@ files:
 - bin/setup
 - lib/rydux.rb
 - lib/rydux/reducer.rb
-- lib/rydux/rydux.rb
 - lib/rydux/state.rb
 - lib/rydux/store.rb
 - lib/rydux/version.rb

data/lib/rydux/rydux.rb

@@ -1,9 +0,0 @@
-module Rydux
-  class Rydux
-
-    def self.dispatch(action)
-
-    end
-
-  end
-end