ice_nine 0.1.0

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.pelusa.yml

@@ -0,0 +1,9 @@
+sources: lib/**/*.rb
+lints:
+  InstanceVariables:
+    limit: 1
+  LineRestriction:
+    limit: 87
+  ElseClauses:
+    exclude:
+      - 'IceNine::Freezer'

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+bundler_args: --without guard metrics
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - ruby-head
+  - jruby-head
+notifications:
+  email:
+    - dan.kubb@gmail.com

data/.yardopts

@@ -0,0 +1 @@
+- README.md LICENSE

data/Gemfile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+source :rubygems
+
+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'
+
+  platforms :mri_18, :rbx do
+    gem 'heckle',    '~> 1.4.3'
+    gem 'json',      '~> 1.6.5'
+    gem 'mspec',     '~> 1.5.17'
+    gem 'ruby2ruby', '=  1.2.2'
+  end
+
+  platforms :mri_18 do
+    gem 'metric_fu', '~> 2.1.1'
+    gem 'rcov',      '~> 1.0.0'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.0'
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dan Kubb
+
+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,54 @@
+# Ice Nine
+
+Deep Freeze Ruby Objects
+
+[![Build Status](https://secure.travis-ci.org/dkubb/ice_nine.png)](http://travis-ci.org/dkubb/ice_nine)
+
+## Usage
+
+```ruby
+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'))
+```
+
+## 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
+```
+
+## Note on Patches/Pull Requests
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it. This library is still in early development, and it may not always be clear the direction it is going. Some features may not be appropriate yet, may need to be deferred until later when the foundation for them is laid, or may be more applicable in a plugin.
+* Fork the project.
+* Make your feature addition or bug fix.
+  * Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the
+  metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright © 2012 Dan Kubb. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+desc 'Default: run all specs'
+task :default => :spec

data/TODO

@@ -0,0 +1,3 @@
+* Move some of spec/unit/ice_nine/class_methods/deep_freeze_spec.rb into an
+  integration test.
+  * Keep some minimal unit tests just for the functionality in the method.

data/config/flay.yml

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

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 11.3

data/config/roodi.yml

@@ -0,0 +1,16 @@
+---
+AbcMetricMethodCheck:            { score: 0 }
+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 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 0 }
+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/ }
+ParameterNumberCheck:            { parameter_count: 0 }

data/config/site.reek

@@ -0,0 +1,91 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 0
+  exclude: []
+  enabled: true
+  max_instance_variables: 0
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 1
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 5
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 0
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 0
+  min_clump_size: 0
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 0
+  exclude: []
+  enabled: true

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100.0

data/ice_nine.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/ice_nine/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'ice_nine'
+  gem.version     = IceNine::VERSION
+  gem.authors     = [ 'Dan Kubb' ]
+  gem.email       = [ 'dan.kubb@gmail.com' ]
+  gem.description = 'Deep Freeze Ruby Objects'
+  gem.summary     = gem.description
+  gem.homepage    = "https://github.com/dkubb/ice_nine"
+
+  gem.require_paths    = %w[ lib ]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[ LICENSE README.md TODO ]
+
+  gem.add_development_dependency('rake',  '~> 0.9.2.2')
+  gem.add_development_dependency('rspec', '~> 1.3.2')
+end

data/lib/ice_nine.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'ice_nine/freezer'
+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/version'
+
+# Base IceNine module
+module IceNine
+
+  # Deep Freeze an object
+  #
+  # @example
+  #   object = IceNine.deep_freeze(object)
+  #
+  # @param [Object] object
+  #
+  # @return [Object]
+  #
+  # @api public
+  def self.deep_freeze(object)
+    recursion_guard(recursion_guard_key(object)) 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/freezer.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+module IceNine
+
+  # The default class that handles freezing objects
+  class Freezer
+
+    # Configure const_get and const_defined? to not search ancestors
+    SKIP_ANCESTORS = (RUBY_VERSION < '1.9' ? [] : [ false ]).freeze
+
+    # Lookup the Freezer subclass by object type
+    #
+    # @example
+    #   freezer_class = IceNine::Freezer[mod]
+    #
+    # @param [Module] mod
+    #
+    # @return [Class<Freezer>]
+    #
+    # @api public
+    def self.[](mod)
+      mod.ancestors.each do |ancestor|
+        name = ancestor.name.to_s
+        freezer = find(name) unless name.empty?  # skip anonymous modules
+        return freezer if freezer
+      end
+    end
+
+    # 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
+
+    # Find a Freezer subclass by name
+    #
+    # @param [String] mod_name
+    #
+    # @return [Class<Freezer>]
+    #
+    # @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
+    end
+
+    class << self
+      protected :find
+    end
+
+    # Lookup a constant in the namespace
+    #
+    # @param [String] namespace
+    #
+    # @return [Module]
+    #   returned if a matching freezer is found
+    # @return [nil]
+    #   returned if no matchiner freezer is found
+    #
+    # @api private
+    def self.const_lookup(namespace)
+      if const_defined?(namespace, *SKIP_ANCESTORS)
+        const_get(namespace, *SKIP_ANCESTORS)
+      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
+    end
+
+    private_class_method :freeze_instance_variables
+
+  end # class Freezer
+end # module IceNine