inheritable_instance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6838791e50f9ff4c630c2ae217b5200d741df97
+  data.tar.gz: 4cfe14e619e66c20501435aa1a9f50c847a32c2e
+SHA512:
+  metadata.gz: 53bb54775f60122eef596cc6279a22dbcbb8741cd63a0589401e3a88218d9a15722228c432bf4676c76fdee67a1f8a1e3817f0a324b4fdebe0a857e8a3f0af55
+  data.tar.gz: 1538da874d1e9f31efee1d62ea1e7aae739e36bd8e936bc293ba0019965fe5409f00f87c6bd107e41a9e550c6ab34193dbd4f4ce139d8d0bc7abd3cfb11d9fd0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in inheritable_instance.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Feldman
+
+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,80 @@
+# InheritableInstance
+
+Allow descending classes to inherit instance variables.
+This is useful for persisting class-level configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'inheritable_instance'
+```
+
+## Usage
+
+Insert the `InheritableInstance` module into the ancestry chain of your class:
+```ruby
+class FakeClass
+  extend InheritableInstance
+end
+```
+
+Then use `inheritable_instance` to set any instance variables
+that you want to be inherited by subclasses:
+```ruby
+class FakeClass
+  inheritable_instance :@thing_one, 1
+  inheritable_instance :@thing_two, 2
+end
+```
+
+These variables will be automatically set on inheritance:
+```ruby
+class DoubleFake < FakeClass; end
+DoubleFake.instance_variable_get(:@thing_one) == 1
+DoubleFake.instance_variable_get(:@thing_two) == 2
+```
+
+It is convenient to pair this with the attr_* methods:
+```ruby
+class << FakeClass
+  attr_accessor :thing_two
+end
+DoubleFake.thing_two = "two"
+FakeClass.thing_two == 2
+DoubleFake.thing_two == "two"
+```
+
+Note that the values are duplicated (when possible):
+```ruby
+class OneTwoThree
+  extend InheritableInstance
+  inheritable_instance :@list, []
+  class << self; attr_reader :list; end
+end
+OneTwoThree.list << 1 << 2 << 3
+Abc = Class.new(OneTwoThree)
+Abc.list << 'a' << 'b' << 'c'
+Abc.list == [1,2,3,'a','b','c']
+OneTwoThree.list == [1,2,3]
+```
+
+## Additional Details
+
+If for some reason it is inconvenient to `extend` the module,
+there is an `Includible` helper that you can use instead:
+```ruby
+class SameAsFakeClass
+  include InheritableInstance::Includible
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fledman/inheritable_instance.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inheritable_instance"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inheritable_instance.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'inheritable_instance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "inheritable_instance"
+  spec.version       = InheritableInstance::VERSION
+  spec.authors       = ["David Feldman"]
+  spec.email         = ["dbfeldman@gmail.com"]
+
+  spec.summary       = "Allow descendants to inherit instance variables"
+  spec.description   = "Useful for persisting class-level configuration to subclasses"
+  spec.homepage      = "https://github.com/fledman/inheritable_instance"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry", "~>0.10"
+end

data/lib/inheritable_instance.rb

@@ -0,0 +1,29 @@
+require "inheritable_instance/version"
+require "inheritable_instance/safe_deep_dup"
+require "inheritable_instance/includible"
+require "set"
+
+module InheritableInstance
+
+  def inheritable_instance(ivar, value)
+    ivar = ivar.to_sym
+    inheritable_instance_vars << ivar
+    instance_variable_set ivar, value
+  end
+
+  def inherited(subclass)
+    super
+    inheritable_instance_vars.each do |ivar|
+      original  = instance_variable_get(ivar)
+      duplicate = SafeDeepDup.duplicate(original)
+      subclass.instance_variable_set(ivar, duplicate)
+    end
+  end
+
+  private
+
+  def inheritable_instance_vars
+    @inheritable_instance_vars ||= Set.new([:@inheritable_instance_vars])
+  end
+
+end

data/lib/inheritable_instance/includible.rb

@@ -0,0 +1,9 @@
+module InheritableInstance
+  module Includible
+
+    def self.included(base)
+      base.extend InheritableInstance
+    end
+
+  end
+end

data/lib/inheritable_instance/safe_deep_dup.rb

@@ -0,0 +1,43 @@
+require "bigdecimal"
+
+module InheritableInstance
+  module SafeDeepDup
+    extend self
+
+    SKIP = [ NilClass, FalseClass, TrueClass,
+             Symbol, Module, Method, UnboundMethod ].freeze
+
+    def duplicate(obj)
+      return duplicate_hash(obj)  if obj.is_a?(Hash)
+      return duplicate_array(obj) if obj.is_a?(Array)
+      return obj.dup if should_duplicate?(obj)
+      obj
+    end
+
+    private
+
+    def should_duplicate?(obj)
+      return false if SKIP.any?{ |klass| obj.is_a?(klass) }
+      return false if obj.is_a?(Numeric) && !obj.is_a?(BigDecimal)
+      return false unless obj.respond_to?(:dup)
+      !obj.respond_to?(:duplicable?) || obj.duplicable?
+    end
+
+    def duplicate_array(array)
+      array.map{ |element| duplicate(element) }
+    end
+
+    def duplicate_hash(hash)
+      hash.each_with_object(blank_hash(hash)) do |(k, v), copy|
+        copy[duplicate(k)] = duplicate(v)
+      end
+    end
+
+    def blank_hash(hash)
+      return hash.dup.clear unless hash.class.equal?(Hash)
+      hash.default_proc ? Hash.new(&hash.default_proc) :
+                          Hash.new(hash.default)
+    end
+
+  end
+end

data/lib/inheritable_instance/version.rb

@@ -0,0 +1,3 @@
+module InheritableInstance
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: inheritable_instance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Feldman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Useful for persisting class-level configuration to subclasses
+email:
+- dbfeldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- inheritable_instance.gemspec
+- lib/inheritable_instance.rb
+- lib/inheritable_instance/includible.rb
+- lib/inheritable_instance/safe_deep_dup.rb
+- lib/inheritable_instance/version.rb
+homepage: https://github.com/fledman/inheritable_instance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Allow descendants to inherit instance variables
+test_files: []