rydux 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1682b8b97e65ab5d08e3f7bbc73706a5d7df4fa
+  data.tar.gz: 5f64415c5777c41a64c203e098b50950c3d5472a
+SHA512:
+  metadata.gz: bd41f637c2eef4fcf69db37f912ebb5f5a74cd3e49f40fcfe031ceab26556a306711f64fefcae4a8cc916f470d62a9faad75848fb12c49dffb09e3b72ea38547
+  data.tar.gz: ae1ade43dbed82007243cb369d9a1cff75d4588ab1ab37a4b150d0a7cd1cd8d6e68b0e76b0b8953a9fc833ce18dd75b3570f90810f0256d10dcc7ffc6700367d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dovzhanyn.alex@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rydux.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    rydux (0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rydux!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex Dovzhanyn
+
+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,137 @@
+# Rydux
+
+A ruby gem that brings the functionality of Redux to your backend.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rydux'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rydux
+
+## Usage
+
+1. Require the gem somewhere in the _root_ of your application (or somewhere the store will be accessible everywhere you need it).
+2. Create some reducers in your application, you can place them anywhere, but a `reducers/` directory is recommended. A sample reducer looks something like this:
+
+  ```ruby
+  # reducers/user_reducer.rb
+
+  class UserReducer < Rydux::Reducer
+
+    # Your reducer MUST have a map_state function in order to do anything.
+    def self.map_state(action, state = {})
+      case action[:type]
+      when 'SOME_RANDOM_ACTION' # You can add as many actions here as you'd like
+        state.merge(some_random_data: true)
+      when 'APPEND_PAYLOAD'
+        state.merge(action[:payload])
+      else
+        state
+      end
+    end
+
+  end
+
+  ```
+
+3. Create a store somewhere easily accessible in your application:
+  ```ruby
+    require 'reducers/user_reducer'
+
+    # The key passed into .new here is the key at which this value
+    # will be stored in the state. E.g. { user: whatever_user_state }
+    Store = Rydux::Store.new(user: UserReducer)
+
+  ```
+4. Have something subscribe to the store:
+  ```ruby
+    class MyClass
+      def initialize
+        Store.subscribe(self)
+      end
+
+      # 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)
+        # ...
+      end
+    end
+  ```
+5. To update the store with new data, you can `dispatch` actions, like so:
+  ```ruby
+    Store.dispatch(type: 'SOME_RANDOM_ACTION')
+  ```
+
+### Putting it all together:
+
+```ruby
+require 'rydux'
+
+class UserReducer < Rydux::Reducer
+  @@initial_state = { name: 'Alex', age: 20 }
+
+  def self.map_state(action, state = @@initial_state)
+    case action[:type]
+    when 'CHANGE_USER_NAME'
+      state.merge(name: action[:payload][:name])
+    else
+      state
+    end
+  end
+
+end
+
+Store = Rydux::Store.new(user: UserReducer)
+
+class Friend
+  def initialize
+    Store.subscribe(self)
+    @users_name = Store.state.user.name
+  end
+
+  def state_changed(state)
+    @users_name = state.user.name
+  end
+
+  def greet_user
+    puts "Hello, #{@users_name}"
+  end
+end
+
+# Create a new friend (this will subscribe it to the store)
+friend = Friend.new
+friend.greet_user #=> Hello, Alex
+
+# Change a value in the store
+Store.dispatch(type: 'CHANGE_USER_NAME', payload: { name: 'Mike' })
+friend.greet_user #=> Hello, Mike
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexdovzhanyn/rydux. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rydux project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alexdovzhanyn/rydux/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "pry"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rydux"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rydux/reducer.rb

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

data/lib/rydux/rydux.rb

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

data/lib/rydux/state.rb

@@ -0,0 +1,27 @@
+require 'ostruct'
+
+module Rydux
+  class State < OpenStruct
+    def initialize(state)
+      state = state.clone
+      super(state)
+      @structure = state
+    end
+
+    def to_s
+      @structure.inspect
+    end
+
+    def inspect
+      @structure.inspect
+    end
+
+    def method_missing(method)
+      if self[method].is_a? Hash
+        self[method] = self.class.new(self[method])
+      else
+        self[method]
+      end
+    end
+  end
+end

data/lib/rydux/store.rb

@@ -0,0 +1,66 @@
+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
+    end
+
+    def subscribe(listener)
+      @listeners << listener
+    end
+
+    # Unsubscribes a listener from the store
+    def abandon(listener)
+      @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)
+      end
+    end
+
+    def state
+      State.new(@state)
+    end
+
+    private
+
+      def set_state(new_state)
+        new_state.each do |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
+      end
+
+      def notify_listeners
+        @listeners.each do |listener|
+          listener.public_send(:state_changed, state)
+        end
+      end
+
+  end
+end

data/lib/rydux/version.rb

@@ -0,0 +1,3 @@
+module Rydux
+  VERSION = "0.9.0"
+end

data/lib/rydux.rb

@@ -0,0 +1,8 @@
+require "rydux/version"
+require "rydux/store"
+require "rydux/state"
+require "rydux/reducer"
+require "rydux/rydux"
+
+module Rydux
+end

data/rydux.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rydux/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rydux"
+  spec.version       = Rydux::VERSION
+  spec.authors       = ["Alex Dovzhanyn"]
+  spec.email         = ["dovzhanyn.alex@gmail.com"]
+
+  spec.summary       = %q{An implementation of Redux in ruby}
+  spec.description   = %q{Use Redux design patterns in your ruby application}
+  spec.homepage      = "https://github.com/alexdovzhanyn/rydux"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_runtime_dependency "json"
+  # spec.add_runtime_dependency "ostruct"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rydux
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Alex Dovzhanyn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use Redux design patterns in your ruby application
+email:
+- dovzhanyn.alex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- 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
+- rydux.gemspec
+homepage: https://github.com/alexdovzhanyn/rydux
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: An implementation of Redux in ruby
+test_files: []