ice_nine 0.10.0 → 0.11.0

checksums.yaml

@@ -1,15 +1,7 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWEyOTlkYzI1MTM2YTg3YjdmMTg0MzU1MzA5NjQwOTBkNzViOTg3NQ==
-  data.tar.gz: !binary |-
-    ZDM3ZmJkYzE4MjFjZTdiOGMyODJhNTg3NzJiNmNmNjJlYjE1MTM4OQ==
-SHA512:
-  metadata.gz: !binary |-
-    NGFlY2QxNDNmOWE2MDBjYmUyMzE5ZTU2NzE4ZmQxNDQ1OTMzNTFkZmFlNDJj
-    YjlkODVhNWI3MmFiYzBmZTA0ZTViZjg0YmJjZDNhMmZjZDk4NTA1MzQzYzdm
-    YWI3N2QzOTZkMGQwMDU5ODIxMmFlOWNjMzJmMzlkOGY3YzRlMzA=
-  data.tar.gz: !binary |-
-    YzQ5ZWY3NjQ4ZTJjNjYzZjMxZGI4Nzk3MGI1OGEzZmQ2NjQ5ZDExOTU0NDM1
-    OTRlNWY2ZDFiMTEzNDhkNTcwZmE4NTc4NTE2NWU1NGJjM2M2YTg4MDdjM2Q4
-    N2JiMjlmYzM2Mzk3YjQ3YTJkNzBkODdjM2JlNzMwNzNmNDc5ODU=
+--- 
+SHA1: 
+  metadata.gz: 1f7071ad57746e7737cabbd2b77cb04f716d0338
+  data.tar.gz: f042013897a106e927f81857121b7ef2c2d118fd
+SHA512: 
+  metadata.gz: 4a8b26471b093168d8b769ee344b8b9e47c579d321f2f604438b79246899868089ededcec51238fa59727ae3bbc5c46d13fb7a3c5769ab2cc48815ade54a7d9c
+  data.tar.gz: 45623b5d9fa123b9901167b648121643dea9b055652a476c1af1be9ed4f8a47ab669c7f37e818f8da1717d5a6aa4bd436db7616a2427f5fbab92ee398f06b2d1

data/.travis.yml

@@ -1,20 +1,21 @@
 language: ruby
+cache: bundler
 bundler_args: --without yard guard benchmarks
-script: "bundle exec rake ci"
+script: "bundle exec rake ci:metrics"
 rvm:
   - 1.9.3
   - 2.0.0
   - ruby-head
-  - rbx-19mode
+  - rbx
 matrix:
   include:
     - rvm: jruby-19mode
-      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+    - rvm: jruby-20mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
     - rvm: jruby-head
-      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
-  allow_failures:
-    - rvm: ruby-head   # travis broken
-    - rvm: rbx-19mode  # mutant fails
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+  fast_finish: true
 notifications:
   irc:
     channels:

data/Gemfile

@@ -4,6 +4,16 @@ source 'https://rubygems.org'
 
 gemspec
 
+platform :rbx do
+  gem 'racc',              '~> 1.4.10'
+  gem 'rubinius-coverage', '~> 2.0.3'
+  gem 'rubysl-bigdecimal', '~> 2.0.2'
+  gem 'rubysl-coverage',   '~> 2.0.3'
+  gem 'rubysl-json',       '~> 2.0.2'
+  gem 'rubysl-logger',     '~> 2.0.0'
+  gem 'rubysl-singleton',  '~> 2.0.0'
+end
+
 group :development, :test do
   gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
 end

data/Gemfile.devtools

@@ -30,16 +30,17 @@ group :guard do
 end
 
 group :metrics do
-  gem 'coveralls', '~> 0.6.7'
+  gem 'coveralls', '~> 0.7.0'
   gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.1.1'
+  gem 'flog',      '~> 4.2.0'
   gem 'reek',      '~> 1.3.2'
-  gem 'rubocop',   '~> 0.13.0'
+  gem 'rubocop',   '~> 0.14.1'
   gem 'simplecov', '~> 0.7.1'
   gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
 
   platforms :ruby_19, :ruby_20 do
-    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'mutant',          '~> 0.3.0.rc3', git: 'https://github.com/mbj/mutant.git'
+    gem 'unparser',        '~> 0.1.3',     git: 'https://github.com/mbj/unparser.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
 end

data/README.md

@@ -19,42 +19,22 @@ Examples
 --------
 
 ```ruby
-# Freezes most objects
+# Deep freezes most kinds of objects
 hash   = IceNine.deep_freeze('a' => '1')
 array  = IceNine.deep_freeze([ 'a', 'b', 'c' ])
 range  = IceNine.deep_freeze('a'..'z')
 struct = IceNine.deep_freeze(Struct.new(:a, :b).new('a', 'b'))
 object = IceNine.deep_freeze(Object.new)
-user   = IceNine.deep_freeze(Application::User.new('dkubb'))
+user   = IceNine.deep_freeze(User.new(name: 'dkubb'))
 
 # Add core extension for Object#deep_freeze (not required by default)
 require 'ice_nine/core_ext/object'
 
 object = Object.new
 object.deep_freeze
-```
-
-Installation
-------------
-
-With Rubygems:
-
-```bash
-$ gem install ice_nine
-$ irb -rubygems
->> require 'ice_nine'
-=> true
-```
-
-With git and local working copy:
 
-```bash
-$ git clone git://github.com/dkubb/ice_nine.git
-$ cd ice_nine
-$ rake install
-$ irb -rubygems
->> require 'ice_nine'
-=> true
+# Faster deep freeze that skips walking frozen objects
+object = IceNine.deep_freeze!(Object.new)
 ```
 
 Contributing

data/benchmarks/speed.rb

@@ -25,8 +25,10 @@ def self.nested(depth, width, array_length)
   hash
 end
 
-hash = nested(3, 5, 100)
+hash = nested(3, 5, 500)
+hash2 = nested(3, 5, 500)
 
 RBench.run do
-  report("deep_freeze") { IceNine.deep_freeze(hash) }
+  report('deep_freeze')  { IceNine.deep_freeze(hash)   }
+  report('deep_freeze!') { IceNine.deep_freeze!(hash2) }
 end

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 5
-total_score: 29.0
+threshold: 8
+total_score: 50.0

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 9.1
+threshold: 5.5

data/config/reek.yml

@@ -23,7 +23,8 @@ DuplicateMethodCall:
   allow_calls: []
 FeatureEnvy:
   enabled: true
-  exclude: []
+  exclude:
+  - IceNine::RecursionGuard::Frozen#guard
 IrresponsibleModule:
   enabled: true
   exclude: []
@@ -61,9 +62,14 @@ TooManyMethods:
 TooManyStatements:
   enabled: true
   exclude:
+  - IceNine::Freezer::Hash#self.freeze_key_value_pairs
+  - IceNine::Freezer::Hash#self.guarded_deep_freeze
   - IceNine::Freezer::Hash#self.deep_freeze
+  - IceNine::Freezer::Object#self.guarded_deep_freeze
   - IceNine::Freezer::Range#self.deep_freeze
+  - IceNine::Freezer::Range#self.guarded_deep_freeze
   - IceNine::RecursionGuard#guard
+  - IceNine::RecursionGuard::ObjectSet#guard
   - each
   max_statements: 2
 UncommunicativeMethodName:
@@ -102,5 +108,6 @@ UnusedParameters:
   exclude: []
 UtilityFunction:
   enabled: true
-  exclude: []
+  exclude:
+  - IceNine::RecursionGuard::Frozen#guard
   max_helper_calls: 0

data/config/rubocop.yml

@@ -2,7 +2,6 @@ AllCops:
   Includes:
     - '**/*.rake'
     - 'Gemfile'
-    - 'Gemfile.devtools'
   Excludes:
     - '**/vendor/**'
     - '**/benchmarks/**'

data/ice_nine.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |gem|
   gem.description = 'Deep Freeze Ruby Objects'
   gem.summary     = gem.description
   gem.homepage    = 'https://github.com/dkubb/ice_nine'
+  gem.license     = 'MIT'
 
   gem.require_paths    = %w[lib]
   gem.files            = `git ls-files`.split($/)

data/lib/ice_nine.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'set'
-
 require 'ice_nine/support/recursion_guard'
 
 require 'ice_nine/freezer'
@@ -32,16 +30,33 @@ module IceNine
   #   object = IceNine.deep_freeze(object)
   #
   # @param [Object] object
-  # @param [RecursionGuard] recursion_guard
   #
   # @return [Object]
   #
   # @api public
-  def self.deep_freeze(object, recursion_guard = RecursionGuard.new)
-    return object if object.frozen?
-    recursion_guard.guard(object.__id__) do
-      Freezer[object.class].deep_freeze(object, recursion_guard)
-    end
+  def self.deep_freeze(object)
+    Freezer.deep_freeze(object)
+  end
+
+  # Deep Freeze an object
+  #
+  # This method uses a faster algorithm that will assume objects that are
+  # `frozen?` do not need to be frozen deeply. Use this method when `object`
+  # contains no shallowly frozen objects that need deep freezing.
+  #
+  # @example
+  #   IceNine.deep_freeze!(['a', 'b']).map(&:frozen?) # [true, true]
+  #
+  # @example
+  #   IceNine.deep_freeze!(['a', 'b'].freeze).map(&:frozen?) # [false, false]
+  #
+  # @param [Object] object
+  #
+  # @return [Object]
+  #
+  # @api public
+  def self.deep_freeze!(object)
+    Freezer.deep_freeze!(object)
   end
 
-end # module IceNine
+end # IceNine

data/lib/ice_nine/core_ext/object.rb

@@ -20,9 +20,23 @@ module IceNine
         IceNine.deep_freeze(self)
       end
 
-    end # module Object
-  end # module CoreExt
-end # module IceNine
+      # Deep freeze an object
+      #
+      # @see IceNine.deep_freeze!
+      #
+      # @example
+      #   object = object.deep_freeze!
+      #
+      # @return [self]
+      #
+      # @api public
+      def deep_freeze!
+        IceNine.deep_freeze!(self)
+      end
+
+    end # Object
+  end # CoreExt
+end # IceNine
 
 # Add Object#deep_freeze
 Object.instance_eval { include IceNine::CoreExt::Object }

data/lib/ice_nine/freezer.rb

@@ -29,6 +29,32 @@ module IceNine
       @freezer_cache[mod]
     end
 
+    # Deep freeze an object with a particular Freezer
+    #
+    # @see IceNine.deep_freeze
+    #
+    # @param [Object] object
+    #
+    # @return [Object]
+    #
+    # @api public
+    def self.deep_freeze(object)
+      guarded_deep_freeze(object, RecursionGuard::ObjectSet.new)
+    end
+
+    # Deep freeze an object with a particular Freezer
+    #
+    # @see IceNine.deep_freeze!
+    #
+    # @param [Object] object
+    #
+    # @return [Object]
+    #
+    # @api public
+    def self.deep_freeze!(object)
+      guarded_deep_freeze(object, RecursionGuard::Frozen.new)
+    end
+
     # Find a Freezer descendant by name
     #
     # @param [String] name
@@ -62,9 +88,23 @@ module IceNine
       const_get(namespace) if const_defined?(namespace, nil)
     end
 
+    # Deep freeze an object with a particular Freezer and RecursionGuard
+    #
+    # @param [Object] object
+    # @param [RecursionGuard] recursion_guard
+    #
+    # @return [Object]
+    #
+    # @api private
+    def self.guarded_deep_freeze(object, recursion_guard)
+      recursion_guard.guard(object) do
+        Freezer[object.class].guarded_deep_freeze(object, recursion_guard)
+      end
+    end
+
     class << self
-      protected :const_lookup
+      protected :const_lookup, :guarded_deep_freeze
     end
 
-  end # class Freezer
-end # module IceNine
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/array.rb

@@ -16,15 +16,13 @@ module IceNine
       # @param [RecursionGuard] recursion_guard
       #
       # @return [Array]
-      #
-      # @api public
-      def self.deep_freeze(array, recursion_guard = RecursionGuard.new)
+      def self.guarded_deep_freeze(array, recursion_guard)
+        super
         array.each do |entry|
-          IceNine.deep_freeze(entry, recursion_guard)
+          Freezer.guarded_deep_freeze(entry, recursion_guard)
         end
-        super
       end
 
-    end # class Array
-  end # class Freezer
-end # module IceNine
+    end # Array
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/false_class.rb

@@ -6,5 +6,5 @@ module IceNine
     # Skip freezing false objects
     class FalseClass < NoFreeze; end
 
-  end # class Freezer
-end # module IceNine
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/hash.rb

@@ -17,17 +17,30 @@ module IceNine
       # @param [RecursionGuard] recursion_guard
       #
       # @return [Hash]
+      def self.guarded_deep_freeze(hash, recursion_guard)
+        super
+        default = hash.default_proc || hash.default
+        Freezer.guarded_deep_freeze(default, recursion_guard)
+        freeze_key_value_pairs(hash, recursion_guard)
+      end
+
+      # Handle freezing the key/value pairs
       #
-      # @api public
-      def self.deep_freeze(hash, recursion_guard = RecursionGuard.new)
-        IceNine.deep_freeze(hash.default_proc || hash.default, recursion_guard)
+      # @param [Hash] hash
+      # @param [RecursionGuard] recursion_guard
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.freeze_key_value_pairs(hash, recursion_guard)
         hash.each do |key, value|
-          IceNine.deep_freeze(key, recursion_guard)
-          IceNine.deep_freeze(value, recursion_guard)
+          Freezer.guarded_deep_freeze(key, recursion_guard)
+          Freezer.guarded_deep_freeze(value, recursion_guard)
         end
-        super
       end
 
-    end # class Hash
-  end # class Freezer
-end # module IceNine
+      private_class_method :freeze_key_value_pairs
+
+    end # Hash
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/hash/state.rb

@@ -7,6 +7,6 @@ module IceNine
       # Skip freezing Hash::State objects on Rubinius
       class State < NoFreeze; end
 
-    end # class Hash
-  end # class Freezer
-end # module IceNine
+    end # Hash
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/module.rb

@@ -6,5 +6,5 @@ module IceNine
     # Skip freezing Module objects
     class Module < NoFreeze; end
 
-  end # class Freezer
-end # module IceNine
+  end # Freezer
+end # IceNine

data/lib/ice_nine/freezer/nil_class.rb

@@ -6,5 +6,5 @@ module IceNine
     # Skip freezing nil objects
     class NilClass < NoFreeze; end
 
-  end # class Freezer
-end # module IceNine
+  end # Freezer
+end # IceNine