zanzou 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 562e3759ee6493bda4a1f63cff36cbe0d936e53f47317c5ab8dceda53b5a62be
+  data.tar.gz: e5167c410c4d0c3d7e1a4db3a017d8d43a4b9bcbff92a9dbd8b7b37776d0c9d2
+SHA512:
+  metadata.gz: 3cb4b2d79d5e2b790f061457b27e978801aa507297542ff8aba2f1c76413055e01814f1315693c619b991c2376c92fce1aa06c419483d42e8e1df984b248a691
+  data.tar.gz: a3fdf7818710d1e178894cdc1d90d790cd602bce9c40d549aabdbc3bf9837b48c35a8bf96bf1eaecca2c2e9a36db3b54e308e79f0251c81ac4d70c8785330a10

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 (2019/06/29)
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yutaka HARA
+
+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,105 @@
+# Zanzou
+
+Something like Ruby port of [immer.js](https://github.com/immerjs/immer)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zanzou'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zanzou
+
+## Usage
+
+With `Zanzou.with_updates`, you can create a modified copy of `orig_obj` with
+imperative style.
+
+```rb
+require 'zanzou'
+orig_obj = {a: 1, b: 2}
+p Zanzou.with_updates(orig_obj){|o| o[:b] = 3}
+# => {a: 1, b: 3}
+p orig_obj
+# => {a: 1, b: 2}
+```
+
+Or you can just call `.with_updates` by requir'ing `zanzou/install`.
+
+```rb
+require 'zanzou/install'
+orig_obj = {a: 1, b: 2}
+p orig_obj.with_updates{|o| o[:b] = 3}
+p orig_obj
+```
+
+## Supported classes
+
+Zanzou should work well with these objects.
+
+- Array, Hash, String, numbers, true, false, nil
+
+Normally other objects, say a Range, should be OK too. However, container
+classes (i.e. objects which contains other objects in it) need special
+treatment to be used with Zanzou.
+
+Steps to add support for a container class:
+
+1. Define `class XxxShadow < Zanzou::ShadowNode` 
+
+See spec/zanzou_spec.rb for an example.
+
+## Known issues
+
+Some methods of Array/Hash may does not work well. See the pending specs (`git grep pending`).
+
+FYI immer.js does not have such problems because ES6 Proxy is very powerful - it
+reports object set/get even for methods like Array sort.
+
+```js
+const hooks = {
+    get(target, prop, receiver) {
+      console.log({hook: "get", prop})
+      return target[prop];
+    },
+    set(target, prop, value) {
+      console.log({hook: "set", prop, value})
+      return target[prop] = value;
+    }
+};
+
+const obj = [5613,2348,2987,2387,7823,1987];
+const pxy = new Proxy(obj, hooks);
+pxy.sort();
+
+// Output:
+//   ...
+//   { hook: 'get', prop: '4' }
+//   { hook: 'get', prop: '5' }
+//   { hook: 'set', prop: '0', value: 1987 }  // It reports all the set/get operations
+//   { hook: 'set', prop: '1', value: 2348 }  // sort() does and thus immer.js can
+//   { hook: 'set', prop: '2', value: 2387 }  // track movements of child elements.
+//   { hook: 'set', prop: '3', value: 2987 }
+//   { hook: 'set', prop: '4', value: 5613 }
+//   { hook: 'set', prop: '5', value: 7823 }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yhara/zanzou.
+
+### How to run test
+
+    bundle exec rspec
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+#require "bundler/gem_tasks"
+task :default => :spec
+
+desc "git ci, git tag and git push"
+task :release do
+  load 'lib/zanzou/version.rb'
+  sh "git diff HEAD"
+  v = "v#{Zanzou::VERSION}"
+  puts "release as #{v}? [y/N]"
+  break unless $stdin.gets.chomp == "y"
+
+  sh "gem build zanzou"  # First, make sure we can build gem
+  sh "git ci -am '#{v}'"
+  sh "git tag '#{v}'"
+  sh "git push origin master --tags"
+  sh "gem push zanzou-#{Zanzou::VERSION}.gem"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zanzou"
+
+# 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/zanzou.rb

@@ -0,0 +1,206 @@
+require "zanzou/version"
+
+module Zanzou
+  class ShadowNode
+    IMMUTABLE_CLASSES = [
+      TrueClass, FalseClass, NilClass,
+      Symbol, Numeric
+    ]
+
+    def self.create(orig_obj, parent:, parent_key:)
+      case orig_obj
+      when Array
+        ArrayShadow.new(orig_obj, parent: parent, parent_key: parent_key)
+      when Hash
+        HashShadow.new(orig_obj, parent: parent, parent_key: parent_key)
+      else
+        if orig_obj.frozen? || IMMUTABLE_CLASSES.include?(orig_obj.class)
+          orig_obj
+        elsif orig_obj.respond_to?(:zanzou_class)
+          orig_obj.zanzou_class.new(orig_obj, parent: parent, parent_key: parent_key)
+        else
+          AnyObjectShadow.new(orig_obj, parent: parent, parent_key: parent_key)
+        end
+      end
+    end
+
+    def self.finalize(shadow)
+      orig_obj      = shadow.instance_variable_get(:@orig_obj)
+      modified      = shadow.instance_variable_get(:@modified)
+      new_obj       = shadow.instance_variable_get(:@new_obj)
+      modifications = shadow.instance_variable_get(:@modifications)
+      modifications.transform_values!{|v|
+        ShadowNode === v ? ShadowNode.finalize(v) : v
+      }
+
+      #pp cls: shadow.class.name, orig_obj: orig_obj, modified: modified, modifications: modifications, new_obj: new_obj
+      if modified
+        if new_obj
+          if modifications.empty?
+            ret = new_obj
+          else
+            ret = shadow.class.merge(new_obj, modifications)
+          end
+        else
+          if modifications.empty?
+            ret = orig_obj
+          else
+            ret = shadow.class.merge(orig_obj, modifications)
+          end
+        end
+      else
+        ret = orig_obj
+      end
+      #pp ret: ret
+      return ret
+    end
+
+    def initialize(orig_obj, parent:, parent_key:)
+      @orig_obj, @parent, @parent_key = orig_obj, parent, parent_key
+      @modified = false
+      @modifications = {}
+      @new_obj = nil
+    end
+
+    private
+
+    def handle_destructive_method_call(name, args)
+      modified!
+      @new_obj = @orig_obj.dup
+      return @new_obj.public_send(name, *args)
+    end
+
+    def handle_non_destructive_method_call(name, args)
+      return (@new_obj || @orig_obj).public_send(name, *args)
+    end
+
+    def modified!
+      @modified = true
+
+      # Mark ancestors to be modified
+      parent = @parent
+      while parent && !parent.instance_variable_get(:@modified)
+        parent.instance_variable_set(:@modified, true)
+        parent = parent.instance_variable_get(:@parent)
+      end
+
+      # Tell parent for the modification
+      if @parent
+        @parent.instance_variable_get(:@modifications)[@parent_key] = self
+      end
+    end
+  end
+
+  class HashShadow < ShadowNode
+    def self.merge(orig_hash, modifications)
+      orig_hash.merge(modifications)
+    end
+
+    def method_missing(name, *args)
+      case name
+      when :[]=
+        handle_setter(args[0], args[1])
+      when :[]
+        handle_getter(args[0])
+      else
+        handle_destructive_method_call(name, args)
+      end
+    end
+
+    private
+
+    def handle_setter(key, value)
+      modified!
+      @modifications[key] = value
+      return value
+    end
+
+    def handle_getter(key)
+      if @modifications.key?(key)
+        return @modifications[key]
+      else
+        return ShadowNode.create(@orig_obj.public_send(key), parent: self, parent_key: key)
+      end
+    end
+  end
+
+  class ArrayShadow < ShadowNode
+    def self.merge(orig_ary, modifications)
+      ret = orig_ary.dup
+      modifications.each{|k, v| ret[k] = v}
+      ret
+    end
+
+    def initialize(*args)
+      super
+      @children = {}
+    end
+
+    def method_missing(name, *args)
+      case name
+      when :[]=
+        handle_setter(args[0], args[1])
+      when :[]
+        handle_getter(args[0])
+      else
+        handle_destructive_method_call(name, args)
+      end
+    end
+
+    private
+
+    def handle_setter(key, value)
+      modified!
+      @modifications[key] = value
+      return value
+    end
+
+    def handle_getter(idx)
+      if @new_obj
+        return @new_obj[idx]
+      else
+        if @children.key?(idx)
+          return @children[key]
+        else
+          child_shadow = ShadowNode.create(@orig_obj[idx], parent: self, parent_key: idx)
+          @children[idx] = child_shadow
+          return child_shadow
+        end
+      end
+    end
+
+    def handle_destructive_method_call(name, args)
+      modified!
+      @new_obj = @orig_obj.dup
+
+      # Apply modification to children now because the index may change by the public_send 
+      @children.each do |idx, child_shadow|
+        @new_obj[idx] = ShadowNode.finalize(child_shadow)
+      end
+      # Forget about the children we've finalized
+      @modifications.clear
+
+      return @new_obj.public_send(name, *args)
+    end
+  end
+
+  # Shadow for any Ruby objects (except container objects, which needs 
+  # special Shadow class to handle parent-child relationship).
+  # We know nothing about the class, so assume all methods are
+  # destructive (pessimistic)
+  class AnyObjectShadow < ShadowNode
+    def method_missing(name, *args)
+      return handle_destructive_method_call(name, args)
+    end
+  end
+
+  def with_updates(&block)
+    Zanzou.with_updates(self, &block)
+  end
+
+  def self.with_updates(obj, &block)
+    shadow = ShadowNode.create(obj, parent: nil, parent_key: nil)
+    block.call(shadow)
+    return ShadowNode.finalize(shadow)
+  end
+end

data/lib/zanzou/array.rb

@@ -0,0 +1,31 @@
+# require'ing this file improves Zanzou's performance, but it will
+# break if any of these methods are redefined to be destructive.
+require 'zanzou/whitelist'
+
+module Zanzou
+  module WhitelistArrayMethods
+    NON_DESTRUCTIVE_ARRAY_METHODS = %i(
+      & * + - <=> == [] at assoc bsearch bsearch_index clone dup 
+      combination compact cycle difference dig each each_index empty?
+      eql? fetch find_index index first flatten hash include? inspect
+      to_s join last length size max min pack permutation pop product
+      rassoc repeated_combination repeated_permutation reverse 
+      reverse_each rindex rotate sample shuffle slice sort sum
+      to_a to_ary to_h transpose union uniq values_at zip |
+    ) +
+      NON_DESTRUCTIVE_BASIC_OBJECT_METHODS +
+      NON_DESTRUCTIVE_OBJECT_METHODS
+
+    def method_missing(name, *args)
+      if NON_DESTRUCTIVE_ARRAY_METHODS.include?(name)
+        handle_non_destructive_method_call(name, args)
+      else
+        super
+      end
+    end
+  end
+
+  class ArrayShadow < ShadowNode
+    prepend WhitelistArrayMethods
+  end
+end

data/lib/zanzou/hash.rb

@@ -0,0 +1,31 @@
+# require'ing this file improves Zanzou's performance, but it will
+# break if any of these methods are redefined to be destructive.
+require 'zanzou/whitelist'
+
+module Zanzou
+  module WhitelistHashMethods
+    NON_DESTRUCTIVE_HASH_METHODS = %i(
+      < <= == === eql? > >= [] assoc clone dup compact compare_by_identity?
+      default default_proc dig each each_pair each_key each_value empty?
+      equal? fetch fetch_values filter select flatten has_key? include?
+      key? member? has_value? value? hash index key inspect to_s invert
+      keys length size merge rassoc reject slice sort to_a to_h to_hash
+      to_proc transform_keys transform_values values values_at
+    ) +
+      NON_DESTRUCTIVE_BASIC_OBJECT_METHODS +
+      NON_DESTRUCTIVE_OBJECT_METHODS
+
+    def method_missing(name, *args)
+      if NON_DESTRUCTIVE_METHODS.include?(name)
+        handle_non_destructive_method_call(name, args)
+      else
+        super
+      end
+    end
+  end
+
+  class HashShadow < ShadowNode
+    prepend WhitelistHashMethods
+  end
+end
+

data/lib/zanzou/install.rb

@@ -0,0 +1,7 @@
+require 'zanzou'
+
+class Object
+  def with_updates(&block)
+    Zanzou.with_updates(self, &block)
+  end
+end

data/lib/zanzou/version.rb

@@ -0,0 +1,3 @@
+module Zanzou
+  VERSION = "0.1.0"
+end

data/lib/zanzou/whitelist.rb

@@ -0,0 +1,16 @@
+module Zanzou
+  NON_DESTRUCTIVE_BASIC_OBJECT_METHODS = %i(
+    ! != == __id__ equal?
+  )
+
+  NON_DESTRUCTIVE_OBJECT_METHODS = %i(
+    ~ <=> == === =~ class clone dup display enum_for to_enum eql? equal? 
+    frozen? hash inspect instance_of? instance_variable_defined? 
+    instance_variable_get instance_variables is_a? kind_of? itself 
+    method methods nil? object_id private_methods protected_methods 
+    public_method public_methods respond_to? singleton_class 
+    singleton_method singleton_methods tainted? tap then yield_self
+    to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str
+    untrusted?
+  )
+end

data/zanzou.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zanzou/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zanzou"
+  spec.version       = Zanzou::VERSION
+  spec.authors       = ["Yutaka HARA"]
+  spec.email         = ["yutaka.hara+github@gmail.com"]
+
+  spec.summary       = %q{Provides DSL for "modifying immutable objects"}
+  spec.homepage      = "https://github.com/yhara/zanzou"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: zanzou
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yutaka HARA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- yutaka.hara+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zanzou.rb
+- lib/zanzou/array.rb
+- lib/zanzou/hash.rb
+- lib/zanzou/install.rb
+- lib/zanzou/version.rb
+- lib/zanzou/whitelist.rb
+- zanzou.gemspec
+homepage: https://github.com/yhara/zanzou
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yhara/zanzou
+  source_code_uri: https://github.com/yhara/zanzou
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Provides DSL for "modifying immutable objects"
+test_files: []