iso-init 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Biesemeyer
+
+MIT License
+
+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,72 @@
+# Iso::Init
+
+This is a gem to help Isolate object initialization.
+
+What's wrong with the following?
+
+```ruby
+SomeKlass = Class.new(Struct.new(options))
+options = {foo: bar}
+object = SomeKlass.new(options)
+object.options
+# => { :foo => :bar }
+options[:baz] = bingo # DANGER, WILL ROBINSON
+object.options
+# => { :foo => :bar, :baz : bingo }
+```
+
+That's right. You passed an object by reference, so when that object changed,
+all references to it also changed, which was not what you intended to do.
+
+`IsoInit` fixes that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iso-init'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iso-init
+
+## Usage
+
+```ruby
+SomeKlass = Class.new(Struct.new(options)) { include IsoInit }
+options = {foo: bar}
+object = SomeKlass.new(options)
+object.options
+# => { :foo => :bar }
+options[:baz] = bingo # DANGER, WILL ROBINSON ???
+object.options
+# => { :foo => :bar }
+# Sweet! It didn't change!
+object.options.frozen?
+# => true
+# ok. that's what I was hoping for. yay.
+```
+
+If an object is immutable, it won't be dup'd (e.g., `true`, `nil`, `1`, `3.1415926`), but if it is mutable, `initialize` will be called with a frozen duplicate.
+
+Sweeeeet.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+Dual-licensed under [MIT][] and [WTFPL][].
+
+[MIT]: http://en.wikipedia.org/wiki/MIT_License
+[WTFPL]: http://en.wikipedia.org/wiki/WTFPL

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.verbose = true
+end

data/iso-init.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iso-init/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'iso-init'
+  spec.version       = IsoInit::VERSION
+  spec.authors       = ['Ryan Biesemeyer']
+  spec.email         = ['ryan@yaauie.com']
+  spec.description   = 'Attempts to isolate initialize arguments'
+  spec.summary       = <<-EOSUMMARY
+    Where possible, runs initialize with frozen duplicates of the
+    original arguments.
+  EOSUMMARY
+  spec.homepage      = 'https://github.com/yaauie/iso-init'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/iso-init.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'iso-init/version'
+
+module IsoInit
+  def self.included(base)
+    base.extend(Isolator)
+  end
+
+  module Isolator
+    def new(*args, &block)
+      super(*args.map(&(Isolator.method(:isolate))), &block)
+    end
+
+    def self.isolate(arg)
+      arg.dup.freeze rescue arg
+    end
+  end
+end

data/lib/iso-init/version.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+module IsoInit
+  VERSION = '0.0.1'
+end

data/spec/iso_init_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'iso-init'
+require_relative 'spec_helper.rb'
+
+describe IsoInit do
+
+  let(:isolated_class_args) do
+    {
+      string:       'a string',
+      integer:      1,
+      nil_class:    nil,
+      false_class:  false,
+      true_class:   true,
+      float:        1.1,
+      array:        [1,2,3],
+      hash:         { a: 1 },
+    }
+  end
+  let(:isolated_class) do
+    Class.new(Struct.new(*isolated_class_args.keys)) do
+      include IsoInit
+    end
+  end
+  let(:isolated_instance) { isolated_class.new(*isolated_class_args.values) }
+
+  it 'should isolate anything that can be dup\'d' do
+    isolated_class_args.keys.each do |key|
+      isolated_instance.public_send(key).should(
+        be_a_frozen_duplicate_of isolated_class_args[key]
+      ) if dupable?(isolated_class_args[key])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+RSpec::Matchers.define :be_a_frozen_duplicate_of do |expected|
+  match do |actual|
+    next false unless actual == expected
+    next false unless actual.frozen?
+    next false if actual.equal?(expected) # refer to same object?
+    true
+  end
+  failure_message_for_should do |actual|
+    "expected that #{actual} would be a frozen duplicate of #{expected}"
+  end
+end
+
+module Helpers
+  def dupable?(obj)
+    obj.dup
+    true
+  rescue
+    false
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: iso-init
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Biesemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Attempts to isolate initialize arguments
+email:
+- ryan@yaauie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- iso-init.gemspec
+- lib/iso-init.rb
+- lib/iso-init/version.rb
+- spec/iso_init_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yaauie/iso-init
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Where possible, runs initialize with frozen duplicates of the original arguments.
+test_files:
+- spec/iso_init_spec.rb
+- spec/spec_helper.rb
+has_rdoc: