cow_proxy 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14efdb18ea2cebbd36eeff0bd8806527863ddc0d
-  data.tar.gz: a5e3b93b639672be82f37f0990d9bce4d477122d
+  metadata.gz: 5734151ca0f1283bf177dc381ba8d360542c8592
+  data.tar.gz: 72ff1be5e09e74f47913c3925770a1d90b6d517a
 SHA512:
-  metadata.gz: edfd0a67bbadf39a3be94a82c30513d9724f06bcc9ac8222f01fbbcd2688498d4572d18fb8364697ed3d5f23bd219e12bf846d3611f7a59eb831a11ff95e44b9
-  data.tar.gz: 9fcecde8d412d062cf0da1aa0592bba8204da2d1bbaac7a798f4e40b3861912b146abad31cc8d07511dbe45f6e2833bc5b048bcf542bf4f66b0f0869b2c8f8e8
+  metadata.gz: c0495f7a2a83f85d17aa7a38f5c09483c4674dcc98dc8b11f6fb6f6756b63d0fac421f899e4d0c17651e1732b0d7c8b414eb4d436f821d31151738b51a247d26
+  data.tar.gz: 2c75c262bbc0eb327c26d220723e42eb1e244461c45da01e0001093bec66a437a3e8c458e9de2a6e79fae96581d736c01f1b428cf3efc3bcf1b9827fb848fd8e

data/README.md

@@ -51,11 +51,11 @@ end
 
 If your custom class has some getters with arguments, such as [] method of Array or Hash, you will have to define it in your Proxy so it wraps returned values and memoizes them, and override _copy_on_write to set memoized proxies to duplicated object. Wrapped object can be accessed from proxy with \__getobj\__ method. You can see an example in CowProxy::Indexable module, which is used for Array and Hash classes.
  
-If your custom class inherits from a class with CowProxy class, you don't need to create an own class, unless you need to override some method:
+If your custom class inherits from a class with CowProxy class, you don't need to create an own class, unless you need to override some method. But you must inherit from WrapClass(CustomClass) so your new proxy class is registered:
  
  ```ruby
 module CowProxy
-  class CustomClass < Array
+  class CustomClass < WrapClass(::CustomClass)
     def custom_get(arg)
       return @custom_var[index] if @custom_var && @custom_var.has_key?(arg)
 

data/lib/cow_proxy.rb

@@ -12,6 +12,8 @@
 #   proxy = CowProxy.wrap(obj)
 
 module CowProxy
+  autoload :Enumerable, 'cow_proxy/enumerable.rb'
+  autoload :Indexable, 'cow_proxy/indexable.rb'
   class << self
     # @!visibility private
     @@wrapper_classes = {}
@@ -93,7 +95,7 @@ module CowProxy
       end
       register_proxy klass, proxy_klass if register
       methods = klass.instance_methods
-      methods -= [:__copy_on_write__, :__wrap__, :__wrapped_value__, :__wrapped_method__, :__getobj__, :send, :===, :frozen?]
+      methods -= [:__copy_on_write__, :__wrap__, :__wrapped_value__, :__wrapped_method__, :__getobj__, :enum_for, :send, :===, :frozen?]
       methods -= proxy_superclass.wrapped_class.instance_methods if proxy_superclass.wrapped_class
       methods -= [:inspect] if ENV['DEBUG']
 
@@ -133,7 +135,6 @@ if defined? Bignum
 end
 
 require 'cow_proxy/base.rb'
-require 'cow_proxy/indexable.rb'
 require 'cow_proxy/array.rb'
 require 'cow_proxy/hash.rb'
 require 'cow_proxy/string.rb'

data/lib/cow_proxy/array.rb

@@ -1,6 +1,41 @@
 module CowProxy
+  # Wrapper class for Array
   class Array < WrapClass(::Array)
     include Indexable
+    include ::Enumerable
+    include Enumerable
+
+    # Calls the given block once for each element in self,
+    # passing wrapped element as a parameter.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @return [CowProxy::Array] self if block given
+    # @return [Enumerator] if no block given
+    def each
+      return enum_for(:each) unless block_given?
+      __getobj__.each.with_index do |_, i|
+        yield self[i]
+      end
+      self
+    end
+
+    # Invokes the given block once for each element of self,
+    # replacing the element with the value returned by the block.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @yieldreturn item to replace
+    # @return [CowProxy::Array] self if block given
+    # @return [Enumerator] if no block given
+    def map!
+      __copy_on_write__
+      return enum_for(:map!) unless block_given?
+      __getobj__.each.with_index do |_, i|
+        self[i] = yield(self[i])
+      end
+    end
+    alias collect! map!
 
     # Used for concatenating into another Array
     # needs to return unwrapped Array
@@ -10,5 +45,4 @@ module CowProxy
       __getobj__
     end
   end
-
 end

data/lib/cow_proxy/enumerable.rb

@@ -0,0 +1,69 @@
+module CowProxy
+  # A mixin to add mutable methods for keep_if, delete_if, select! and reject!
+  # to wrap block params with CowProxy
+  module Enumerable
+    # Invokes the given block passing in successive elements from self,
+    # deleting elements for which the block returns a false value.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @yieldreturn [Boolean] true if item must be kept
+    # @return [CowProxy::Array] self if block given
+    # @return [Enumerator] if no block given
+    def keep_if(&block)
+      mutable_selector(:select, &block)
+    end
+
+    # Invokes the given block passing in successive elements from self,
+    # deleting elements for which the block returns a false value.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @yieldreturn [Boolean] true if item must be kept
+    # @return [CowProxy::Array] self if block given and changes were made
+    # @return [nil] if block given and no changes were made
+    # @return [Enumerator] if no block given
+    def select!(&block)
+      mutable_selector!(:keep_if, &block)
+    end
+
+    # Deletes every element of self for which block evaluates to true.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @yieldreturn [Boolean] true if item must be deleted
+    # @return [CowProxy::Array] self if block given
+    # @return [Enumerator] if no block given
+    def delete_if(&block)
+      mutable_selector(:reject, &block)
+    end
+
+    # Deletes every element of self for which block evaluates to true.
+    #
+    # @yield [item] Gives each element in self to the block
+    # @yieldparam item Wrapped item in self
+    # @yieldreturn [Boolean] true if item must be deleted
+    # @return [CowProxy::Array] self if block given and changes were made
+    # @return [nil] if block given and no changes were made
+    # @return [Enumerator] if no block given
+    def reject!(&block)
+      mutable_selector!(:delete_if, &block)
+    end
+
+    private
+    def mutable_selector(method, &block)
+      return send(method) unless block
+      @delegate_dc_obj = send(method, &block).tap do
+        @dc_obj_duplicated = true
+      end
+      self
+    end
+
+    def mutable_selector!(method, &block)
+      return send(method) unless block
+      size = __getobj__.size
+      send(method, &block)
+      self unless __getobj__.size == size
+    end
+  end
+end

data/lib/cow_proxy/hash.rb

@@ -1,6 +1,64 @@
 module CowProxy
+  # Wrapper class for Hash
   class Hash < WrapClass(::Hash)
     include Indexable
+    include ::Enumerable
+    include Enumerable
+
+    # Calls block once for each key in hash, passing the key-value pair
+    # as parameters.
+    #
+    # @yield [pair] Gives each key-value pair in self to the block
+    # @yieldparam pair Array of key and wrapped value
+    # @return [CowProxy::Hash] self if block given
+    # @return [Enumerator] if no block given
+    def each
+      return enum_for(:each) unless block_given?
+      __getobj__.each_key do |k|
+        yield [k, self[k]]
+      end
+    end
+    alias each_pair each
+
+    # Calls block once for each key in hash, passing the value as parameter.
+    #
+    # @yield [value] Gives each value in hash to the block
+    # @yieldparam value Wrapped value
+    # @return [CowProxy::Hash] self if block given
+    # @return [Enumerator] if no block given
+    def each_value
+      return enum_for(:each) unless block_given?
+      each { |_, v| yield v }
+    end
+
+    # Returns a new hash consisting of entries for which the block returns true.
+    #
+    # @yield [pair] Gives each key-value pair in self to the block
+    # @yieldparam pair Array of key and wrapped value
+    # @yieldreturn [Boolean] true if item must be included
+    # @return [CowProxy::Hash] self if block given
+    # @return [Enumerator] if no block given
+    def select
+      ::Hash[super]
+    end
+
+    # Returns a new hash consisting of entries for which the block returns false.
+    #
+    # @yield [pair] Gives each key-value pair in self to the block
+    # @yieldparam pair Array of key and wrapped value
+    # @yieldreturn [Boolean] true if item must not be included
+    # @return [CowProxy::Hash] self if block given
+    # @return [Enumerator] if no block given
+    def reject
+      ::Hash[super]
+    end
+
+    # Returns a new array populated with the wrapped values from hash.
+    #
+    # @return [Array] Wrapped values from hash
+    def values
+      map(&:last)
+    end
 
     # Used for merging into another Hash
     # needs to return unwrapped Hash
@@ -10,5 +68,4 @@ module CowProxy
       __getobj__
     end
   end
-
 end

data/lib/cow_proxy/indexable.rb

@@ -36,7 +36,7 @@ module CowProxy
           @hash.each do |k, v|
             __getobj__[k] = v
           end
-          @hash = nil
+          @hash.clear
         end
       end
     end

data/lib/cow_proxy/set.rb

@@ -1,6 +1,7 @@
 require 'set'
 
 module CowProxy
+  # Wrapper class for Set
   class Set < WrapClass(::Set)
   end
 

data/lib/cow_proxy/string.rb

@@ -1,7 +1,13 @@
 module CowProxy
+  # Wrapper class for String
   class String < WrapClass(::String)
+    # returns the wrapped object.
+    #
+    # needed to used wrapped string as parameter for send
+    #
+    # @return the wrapped object.
     def to_str
-      __getobj__.to_str
+      __getobj__
     end
   end
 end

data/lib/cow_proxy/version.rb

@@ -1,8 +1,8 @@
 module CowProxy
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 4
+    MINOR = 2
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cow_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Sergio Cambra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies: []
 description: Make a COW proxy for a frozen object (or deep frozen), it will delegate
   every read method to proxied object, wrap value in COW proxy if frozen. Trying to
@@ -24,6 +24,7 @@ files:
 - lib/cow_proxy.rb
 - lib/cow_proxy/array.rb
 - lib/cow_proxy/base.rb
+- lib/cow_proxy/enumerable.rb
 - lib/cow_proxy/hash.rb
 - lib/cow_proxy/indexable.rb
 - lib/cow_proxy/set.rb
@@ -49,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Copy-on-write proxy class, to use with frozen objects