ice_nine 0.1.0 → 0.2.0

data/Gemfile

@@ -1,18 +1,25 @@
 # encoding: utf-8
 
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 
 group :metrics do
-  gem 'fattr',       '~> 2.2.1'
-  gem 'arrayfields', '~> 4.7.4'
-  gem 'flay',        '~> 1.4.3'
-  gem 'flog',        '~> 2.5.3'
-  gem 'map',         '~> 5.4.0'
-  gem 'reek',        '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
-  gem 'roodi',       '~> 2.1.0'
-  gem 'yardstick',   '~> 0.4.0'
+  gem 'fattr',           '~> 2.2.1'
+  gem 'arrayfields',     '~> 4.7.4'
+  gem 'flay',            '~> 1.4.3'
+  gem 'flog',            '~> 2.5.3'
+  gem 'map',             '~> 5.4.0'
+  gem 'reek',            '~> 1.2.8', :git => 'git://github.com/dkubb/reek.git'
+  gem 'roodi',           '~> 2.1.0'
+  gem 'tailor',          '~> 0.1.5'
+  gem 'yardstick',       '~> 0.4.0'
+  gem 'yard-spellcheck', '~> 0.1.4'
+
+  platforms :mri_19 do
+    gem 'cane',      '~> 1.1.0'
+    gem 'simplecov', '~> 0.6.1'
+  end
 
   platforms :mri_18, :rbx do
     gem 'heckle',    '~> 1.4.3'

data/README.md

@@ -7,12 +7,19 @@ Deep Freeze Ruby Objects
 ## Usage
 
 ```ruby
+# Freezes most 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'))
+
+# Add core extension for Object#deep_freeze (not required by default)
+require 'ice_nine/core_ext/object'
+
+object = Object.new
+object.deep_freeze
 ```
 
 ## Installation

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 6
-total_score: 42.0
+total_score: 44.0

data/config/roodi.yml

@@ -1,15 +1,15 @@
 ---
-AbcMetricMethodCheck:            { score: 0 }
+AbcMetricMethodCheck:            { score: 1 }
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
 ClassLineCountCheck:             { line_count: 88 }
 ClassNameCheck:                  { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }
 ClassVariableCheck:              { }
 CyclomaticComplexityBlockCheck:  { complexity: 3 }
-CyclomaticComplexityMethodCheck: { complexity: 0 }
+CyclomaticComplexityMethodCheck: { complexity: 1 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
-MethodLineCountCheck:            { line_count: 0 }
+MethodLineCountCheck:            { line_count: 1 }
 MethodNameCheck:                 { pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/ }
 ModuleLineCountCheck:            { line_count: 92 }
 ModuleNameCheck:                 { pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/ }

data/config/site.reek

@@ -8,7 +8,7 @@ UncommunicativeParameterName:
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
 LargeClass:
-  max_methods: 0
+  max_methods: 1
   exclude: []
   enabled: true
   max_instance_variables: 0

data/lib/ice_nine.rb

@@ -1,12 +1,19 @@
 # encoding: utf-8
 
+require 'set'
+
+require 'ice_nine/support/recursion_guard'
+
 require 'ice_nine/freezer'
+require 'ice_nine/freezer/object'
+
 require 'ice_nine/freezer/array'
 require 'ice_nine/freezer/hash'
-require 'ice_nine/freezer/no_freeze'
 require 'ice_nine/freezer/range'
 require 'ice_nine/freezer/struct'
 
+require 'ice_nine/freezer/no_freeze'
+
 require 'ice_nine/version'
 
 # Base IceNine module
@@ -23,43 +30,9 @@ module IceNine
   #
   # @api public
   def self.deep_freeze(object)
-    recursion_guard(recursion_guard_key(object)) do
+    RecursionGuard.guard(object.object_id) do
       Freezer[object.class].deep_freeze(object)
     end
-    object
   end
 
-  # Guard the system from recursive freezing
-  #
-  # @param [String] key
-  #
-  # @return [undefined]
-  #
-  # @api private
-  def self.recursion_guard(key)
-    thread = Thread.current
-    return if thread[key]
-    begin
-      thread[key] = true
-      yield
-    ensure
-      thread[key] = nil
-    end
-  end
-
-  private_class_method :recursion_guard
-
-  # Create a unique key to guard against recursively deep freezing the object
-  #
-  # @param [#object_id]
-  #
-  # @return [String]
-  #
-  # @api private
-  def self.recursion_guard_key(object)
-    "__ice_nine_deep_freeze_#{object.object_id}"
-  end
-
-  private_class_method :recursion_guard_key
-
 end # module IceNine

data/lib/ice_nine/core_ext/object.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module IceNine
+
+  # Core Ruby extensions
+  module CoreExt
+
+    # Extend Object with deep freezing
+    module Object
+
+      # Deep freeze an object
+      #
+      # @example
+      #   object = object.deep_freeze
+      #
+      # @return [self]
+      #
+      # @api public
+      def deep_freeze
+        IceNine.deep_freeze(self)
+      end
+
+    end #module Object
+  end # module CoreExt
+end # module IceNine
+
+# Add Object#deep_freeze
+Object.instance_eval { include IceNine::CoreExt::Object }

data/lib/ice_nine/freezer.rb

@@ -6,9 +6,9 @@ module IceNine
   class Freezer
 
     # Configure const_get and const_defined? to not search ancestors
-    SKIP_ANCESTORS = (RUBY_VERSION < '1.9' ? [] : [ false ]).freeze
+    SKIP_ANCESTORS = (RUBY_VERSION < '1.9' ? [] : [false]).freeze
 
-    # Lookup the Freezer subclass by object type
+    # Look up the Freezer descendant by object type
     #
     # @example
     #   freezer_class = IceNine::Freezer[mod]
@@ -20,52 +20,38 @@ module IceNine
     # @api public
     def self.[](mod)
       mod.ancestors.each do |ancestor|
-        name = ancestor.name.to_s
-        freezer = find(name) unless name.empty?  # skip anonymous modules
+        freezer = find(ancestor.name.to_s)
         return freezer if freezer
       end
     end
 
-    # Deep Freeze an object
+    # Find a Freezer descendant by name
     #
-    # @example
-    #   object = IceNine.deep_freeze(Object.new)
-    #
-    # @param [Object] object
-    #
-    # @return [Object]
-    #
-    # @api public
-    def self.deep_freeze(object)
-      freeze_instance_variables(object)
-      object.freeze
-    end
-
-    # Find a Freezer subclass by name
-    #
-    # @param [String] mod_name
+    # @param [String] name
     #
     # @return [Class<Freezer>]
+    #   returned if a matching freezer is found
+    # @return [nil]
+    #   returned if no matching freezer is found
     #
     # @api private
-    def self.find(mod_name)
-      namespace, const = mod_name.split('::', 2)
-      mod = const_lookup(namespace) if namespace
-      mod ? mod.find(const.to_s) : self
+    def self.find(name)
+      freezer = name.split('::').reduce(self) do |mod, const|
+        mod.const_lookup(const) or break mod
+      end
+      freezer if freezer < self  # only return a descendant freezer
     end
 
-    class << self
-      protected :find
-    end
+    private_class_method :find
 
-    # Lookup a constant in the namespace
+    # Look up a constant in the namespace
     #
     # @param [String] namespace
     #
     # @return [Module]
-    #   returned if a matching freezer is found
+    #   returned if a matching constant is found
     # @return [nil]
-    #   returned if no matchiner freezer is found
+    #   returned if no matching constant is found
     #
     # @api private
     def self.const_lookup(namespace)
@@ -74,22 +60,9 @@ module IceNine
       end
     end
 
-    private_class_method :const_lookup
-
-    # Handle freezing the object's instance variables
-    #
-    # @param [Object] object
-    #
-    # @return [undefined]
-    #
-    # @api private
-    def self.freeze_instance_variables(object)
-      object.instance_variables.each do |ivar_name|
-        IceNine.deep_freeze(object.instance_variable_get(ivar_name))
-      end
+    class << self
+      protected :const_lookup
     end
 
-    private_class_method :freeze_instance_variables
-
   end # class Freezer
 end # module IceNine

data/lib/ice_nine/freezer/array.rb

@@ -4,13 +4,13 @@ module IceNine
   class Freezer
 
     # A freezer class for handling Array objects
-    class Array < self
+    class Array < Object
 
       # Deep Freeze an Array
       #
       # @example
-      #   array = IceNine:Freezer::Array.deep_freeze(%w[ a b c ])
-      #   array.select(&:frozen?)  # => [ 'a', 'b', 'c' ]
+      #   array = IceNine:Freezer::Array.deep_freeze(%w[a b c])
+      #   array.select(&:frozen?)  # => ['a', 'b', 'c']
       #
       # @param [Array] array
       #

data/lib/ice_nine/freezer/hash.rb

@@ -4,14 +4,14 @@ module IceNine
   class Freezer
 
     # A freezer class for handling Hash objects
-    class Hash < self
+    class Hash < Object
 
       # Deep Freeze a Hash
       #
       # @example
       #   hash = IceNine::Freezer::Hash.deep_freeze('a' => '1', 'b' => '2')
-      #   hash.keys.select(&:frozen?)    # => [ 'a', 'b' ]
-      #   hash.values.select(&:frozen?)  # => [ '1', '2' ]
+      #   hash.keys.select(&:frozen?)    # => ['a', 'b']
+      #   hash.values.select(&:frozen?)  # => ['1', '2']
       #
       # @param [Hash] hash
       #

data/lib/ice_nine/freezer/object.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module IceNine
+  class Freezer
+
+    # A freezer class for handling Object instances
+    class Object < self
+
+      # Deep Freeze an object
+      #
+      # @example
+      #   object = IceNine.deep_freeze(Object.new)
+      #
+      # @param [Object] object
+      #
+      # @return [Object]
+      #
+      # @api public
+      def self.deep_freeze(object)
+        freeze_instance_variables(object)
+        object.freeze
+      end
+
+      # Handle freezing the object's instance variables
+      #
+      # @param [Object] object
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def self.freeze_instance_variables(object)
+        object.instance_variables.each do |ivar_name|
+          IceNine.deep_freeze(object.instance_variable_get(ivar_name))
+        end
+      end
+
+      private_class_method :freeze_instance_variables
+
+    end # class Object
+  end # class Freezer
+end # module IceNine

data/lib/ice_nine/freezer/range.rb

@@ -4,7 +4,7 @@ module IceNine
   class Freezer
 
     # A freezer class for handling Range objects
-    class Range < self
+    class Range < Object
 
       # Deep Freeze a Range
       #

data/lib/ice_nine/freezer/struct.rb

@@ -4,19 +4,19 @@ module IceNine
   class Freezer
 
     # A freezer class for handling Struct objects
-    class Struct < self
+    class Struct < Object
 
       # Deep Freeze a Struct
       #
       # @example
       #   struct = IceNine:Freezer::Struct.deep_freeze(klass.new('1'))
-      #   struct.values.select(&:frozen?)  # => [ '1' ]
+      #   struct.values.select(&:frozen?)  # => ['1']
       #
       # @param [Struct] struct
       #
       # @return [Struct]
       #
-      # @todo use super on Struct#each once it returns self in rbx
+      # @todo use super on Struct#each once it returns self in Rubinius
       #
       # @api public
       def self.deep_freeze(struct)

data/lib/ice_nine/support/recursion_guard.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module IceNine
+
+  # Protect against infinite recursion
+  module RecursionGuard
+
+    # Guard against recursively calling a block with the same object
+    #
+    # @example
+    #  IceNine::RecursionGuard.guard(object_id) do
+    #    logic_which_may_recursively_call_the_containing_method
+    #  end
+    #
+    # @param [Integer] object_id
+    #
+    # @return [Object]
+    #
+    # @api public
+    def self.guard(object_id)
+      objects = guarded_objects(caller.first)
+      return if objects.include?(object_id)
+      begin
+        objects << object_id
+        yield
+      ensure
+        objects.delete(object_id)
+      end
+    end
+
+    # The current objects guarded at a specific location in the source
+    #
+    # @param [String] location
+    #
+    # @return [Set<Integer>]
+    #
+    # @api private
+    def self.guarded_objects(location)
+      Thread.current[location] ||= Set.new
+    end
+
+    private_class_method :guarded_objects
+
+  end # RecursionGuard
+end # module IceNine

data/lib/ice_nine/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module IceNine
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/spec_helper.rb

@@ -1,18 +1,22 @@
 # encoding: utf-8
 
-require 'rubygems'
+require 'spec'
+require 'spec/autorun'
 
-begin
-  require 'rspec'  # try for RSpec 2
-rescue LoadError
-  require 'spec'   # try for RSpec 1
-  RSpec = Spec::Runner
+# require spec support files and shared behavior
+Dir[File.expand_path('../shared/**/*.rb', __FILE__)].each do |file|
+  require file
 end
 
-# require spec support files and shared behavior
-Dir[File.expand_path('../shared/**/*.rb', __FILE__)].each { |file| require file }
+Spec::Runner.configure do |config|
+end
 
-RSpec.configure do |config|
+if RUBY_VERSION >= '1.9' and ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  SimpleCov.start do
+    command_name 'spec:unit'
+    add_filter   'spec'
+  end
 end
 
 # change the heckle timeout to be 5 seconds

data/spec/unit/ice_nine/class_methods/deep_freeze_spec.rb

@@ -6,7 +6,7 @@ require 'ice_nine'
 describe IceNine, '.deep_freeze' do
   subject { object.deep_freeze(value) }
 
-  let(:object) { self.class.described_type }
+  let(:object) { IceNine }
 
   context 'with an Object' do
     let(:value) { Object.new }
@@ -47,7 +47,7 @@ describe IceNine, '.deep_freeze' do
   end
 
   context 'with an Array' do
-    let(:value) { %w[ a ] }
+    let(:value) { %w[a] }
 
     it 'returns the object' do
       should be(value)
@@ -177,7 +177,7 @@ describe IceNine, '.deep_freeze' do
     end
   end
 
-  [ 0.0, 0, 0x7fffffffffffffff, true, false, nil, :symbol ].each do |value|
+  [0.0, 0, 0x7fffffffffffffff, true, false, nil, :symbol].each do |value|
     context "with a #{value.class}" do
       let(:value) { value }
 

data/spec/unit/ice_nine/freezer/array/class_methods/deep_freeze_spec.rb

@@ -10,7 +10,7 @@ describe IceNine::Freezer::Array, '.deep_freeze' do
   let(:object) { described_class }
 
   context 'with an Array object' do
-    let(:value) { %w[ a ] }
+    let(:value) { %w[a] }
 
     it 'returns the object' do
       should be(value)

data/spec/unit/ice_nine/freezer/class_methods/element_reference_spec.rb

@@ -8,7 +8,7 @@ describe IceNine::Freezer, '.[]' do
   subject { object[mod] }
 
   let(:object)  { described_class }
-  let(:freezer) { object          }
+  let(:freezer) { object::Object  }
 
   describe 'when the module matches a descendant' do
     let(:freezer) { Class.new(object) }

data/spec/unit/ice_nine/freezer/numeric/class_methods/deep_freeze_spec.rb

@@ -8,7 +8,7 @@ describe IceNine::Freezer::Numeric, '.deep_freeze' do
 
   let(:object) { described_class }
 
-  [ 0.0, 0, 0x7fffffffffffffff ].each do |value|
+  [0.0, 0, 0x7fffffffffffffff].each do |value|
     context "with a #{value.class} object" do
       let(:value) { value }
 

data/spec/unit/ice_nine/freezer/{class_methods → object/class_methods}/deep_freeze_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 require 'ice_nine'
 
-describe IceNine::Freezer, '.deep_freeze' do
+describe IceNine::Freezer::Object, '.deep_freeze' do
   subject { object.deep_freeze(value) }
 
   let(:object) { described_class }

data/spec/unit/ice_nine/recursion_guard/class_methods/guard_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'ice_nine/support/recursion_guard'
+
+describe IceNine::RecursionGuard, '.guard' do
+  subject { object.guard(object_id, &method(:block)) }
+
+  let(:object)       { IceNine::RecursionGuard }
+  let(:object_id)    { 1                       }
+  let(:return_value) { stub('return_value')    }
+
+  context 'when the block is not recursive' do
+    def block
+      return_value
+    end
+
+    it 'returns the expected value' do
+      should equal(return_value)
+    end
+  end
+
+  context 'when the block is recursive' do
+    def block
+      subject.should be_nil
+      return_value
+    end
+
+    it 'returns the expected value' do
+      should equal(return_value)
+    end
+  end
+end

data/spec/unit/object/deep_freeze_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'ice_nine'
+require 'ice_nine/core_ext/object'
+
+describe Object, '#deep_freeze' do
+  subject { object.deep_freeze }
+
+  let(:object) { Object.new }
+
+  it 'returns the object' do
+    should be(object)
+  end
+
+  it 'freezes the object' do
+    expect { subject }.should change(object, :frozen?).from(false).to(true)
+  end
+end

data/tasks/metrics/heckle.rake

@@ -12,7 +12,7 @@ begin
   require 'mspec'
   require 'mspec/utils/name_map'
 
-  SKIP_METHODS = %w[ blank_slate_method_added ].freeze
+  SKIP_METHODS = %w[ blank_slate_method_added guarded_objects ].freeze
 
   class NameMap
     def file_name(method, constant)
@@ -27,7 +27,7 @@ begin
   end
 
   desc 'Heckle each module and class'
-  task :heckle => :rcov do
+  task :heckle => :coverage do
     unless Ruby2Ruby::VERSION == '1.2.2'
       raise "ruby2ruby version #{Ruby2Ruby::VERSION} may not work properly, 1.2.2 *only* is recommended for use with heckle"
     end

data/tasks/spec.rake

@@ -1,27 +1,17 @@
 # encoding: utf-8
 
 begin
-  begin
-    require 'rspec/core/rake_task'
-  rescue LoadError
-    require 'spec/rake/spectask'
-
-    module RSpec
-      module Core
-        RakeTask = Spec::Rake::SpecTask
-      end
-    end
-  end
+  require 'spec/rake/spectask'
 
   desc 'Run all specs'
   task :spec => %w[ spec:unit spec:integration ]
 
   namespace :spec do
-    RSpec::Core::RakeTask.new(:integration) do |t|
+    Spec::Rake::SpecTask.new(:integration) do |t|
       t.pattern = 'spec/integration/**/*_spec.rb'
     end
 
-    RSpec::Core::RakeTask.new(:unit) do |t|
+    Spec::Rake::SpecTask.new(:unit) do |t|
       t.pattern = 'spec/unit/**/*_spec.rb'
     end
   end
@@ -32,14 +22,24 @@ rescue LoadError
 end
 
 begin
-  desc 'Generate code coverage'
-  RSpec::Core::RakeTask.new(:rcov) do |t|
-    t.rcov      = true
-    t.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+  if RUBY_VERSION < '1.9'
+    desc 'Generate code coverage'
+    Spec::Rake::SpecTask.new(:coverage) do |t|
+      t.rcov      = true
+      t.pattern   = 'spec/unit/**/*_spec.rb'
+      t.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+    end
+  else
+    desc 'Generate code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task['spec:unit'].execute
+    end
   end
 rescue LoadError
-  task :rcov do
-    abort 'rcov is not available. In order to run rcov, you must: gem install rcov'
+  task :coverage do
+    lib = RUBY_VERSION < '1.9' ? 'rcov' : 'simplecov'
+    abort "coverage is not available. In order to run #{lib}, you must: gem install #{lib}"
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ice_nine
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dan Kubb
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-23 00:00:00 Z
+date: 2012-03-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -79,29 +79,34 @@ files:
 - config/yardstick.yml
 - ice_nine.gemspec
 - lib/ice_nine.rb
+- lib/ice_nine/core_ext/object.rb
 - lib/ice_nine/freezer.rb
 - lib/ice_nine/freezer/array.rb
 - lib/ice_nine/freezer/hash.rb
 - lib/ice_nine/freezer/no_freeze.rb
+- lib/ice_nine/freezer/object.rb
 - lib/ice_nine/freezer/range.rb
 - lib/ice_nine/freezer/struct.rb
+- lib/ice_nine/support/recursion_guard.rb
 - lib/ice_nine/version.rb
 - spec/rcov.opts
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/unit/ice_nine/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/array/class_methods/deep_freeze_spec.rb
-- spec/unit/ice_nine/freezer/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/class_methods/element_reference_spec.rb
 - spec/unit/ice_nine/freezer/false_class/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/hash/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/nil_class/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/no_freeze/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/numeric/class_methods/deep_freeze_spec.rb
+- spec/unit/ice_nine/freezer/object/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/range/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/struct/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/symbol/class_methods/deep_freeze_spec.rb
 - spec/unit/ice_nine/freezer/true_class/class_methods/deep_freeze_spec.rb
+- spec/unit/ice_nine/recursion_guard/class_methods/guard_spec.rb
+- spec/unit/object/deep_freeze_spec.rb
 - tasks/metrics/ci.rake
 - tasks/metrics/flay.rake
 - tasks/metrics/flog.rake