heredity 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 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heredity.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brandon Dewitt
+
+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,29 @@
+# Heredity
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heredity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heredity
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

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

data/heredity.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heredity/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "heredity"
+  gem.version       = Heredity::VERSION
+  gem.authors       = ["Brandon Dewitt"]
+  gem.email         = ["brandonsdewitt@gmail.com"]
+  gem.description   = %q{provides class inheritable attributes outside of rails and other gem/frameworks}
+  gem.summary       = %q{inherit class instance variables}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  ##
+  # Development dependencies
+  #
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-pride"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "simplecov"
+end

data/lib/heredity.rb

@@ -0,0 +1,61 @@
+require 'thread'
+require "heredity/version"
+
+module Heredity
+  module InheritableClassInstanceVariables
+    def self.included(klass)
+      Thread.exclusive do
+        klass.extend(::Heredity::InheritableClassInstanceVariables::ClassMethods)
+
+        klass.class_eval do
+          @_inheritable_class_instance_variables = [ :_inheritable_class_instance_variables ]
+
+          class << self
+            alias_method :inheritable_attribute, :inheritable_attributes
+            alias_method :class_inheritable_attributes, :inheritable_attributes
+            alias_method :class_inheritable_attribute, :inheritable_attributes
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def inheritable_attributes(*args)
+        Thread.exclusive do
+          args.flatten.compact.uniq.each do |class_instance_variable|
+            unless @_inheritable_class_instance_variables.include?(class_instance_variable)
+              @_inheritable_class_instance_variables << class_instance_variable
+            end
+          end
+
+          @_inheritable_class_instance_variables.each do |attr_symbol|
+            unless self.respond_to?("#{attr_symbol}")
+              class_eval %Q{
+                class << self; attr_reader :#{attr_symbol}; end
+              }
+            end
+
+            unless self.respond_to?("#{attr_symbol}=")
+              class_eval %Q{
+                class << self; attr_writer :#{attr_symbol}; end
+              }
+            end
+          end
+
+          @_inheritable_class_instance_variables
+        end
+      end
+
+      def inherited(klass)
+        super # ActiveRecord needs the inherited hook to setup fields
+
+        Thread.exclusive do
+          @_inheritable_class_instance_variables.each do |attribute|
+            attr_sym = :"@#{attribute}"
+            klass.instance_variable_set(attr_sym, self.instance_variable_get(attr_sym))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/heredity/version.rb

@@ -0,0 +1,3 @@
+module Heredity
+  VERSION = "0.0.1"
+end

data/spec/inheritable_class_instance_variables_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Heredity::InheritableClassInstanceVariables do
+
+  class TestInheritTop
+    include ::Heredity::InheritableClassInstanceVariables
+    inheritable_attributes :first, :awesomeness, :bestest  
+
+    @first = {}
+    @awesomeness = [:this, :that, :the_other]
+    @bestest = "dirt apple (Po-ta-toes!)"
+  end
+
+  class TestSecondTier < TestInheritTop; end
+  class TestThirdTier < TestSecondTier; end
+
+  class TestEditSecondTier < TestInheritTop
+    @first = "Songs are for Singing"    
+    @awesomeness = @first * 3
+    @bestest = "SSSSSOOOOOOOOOONNNNNNNNGGGGGGGSSSSSS"
+  end
+
+  class TestEditThirdTier < TestEditSecondTier
+    @first = []
+    @awesomeness = []
+    @bestest = []
+  end
+
+  class TestEditThirdTierWithoutEdit < TestEditSecondTier; end
+
+  # API
+  [TestInheritTop, TestSecondTier, TestThirdTier].each do |test_class|
+    specify { test_class.should respond_to(:inheritable_attributes) }
+    specify { test_class.should respond_to(:inheritable_attribute) }
+    specify { test_class.should respond_to(:class_inheritable_attributes) }
+    specify { test_class.should respond_to(:class_inheritable_attribute) }
+  end
+
+  context "when overiding child class instance varialbes" do 
+    describe "single tier inheritance" do 
+      it "overrides the instance variables with the child defined values" do 
+        TestEditSecondTier.first.should eq("Songs are for Singing")
+        TestEditSecondTier.awesomeness.should eq("Songs are for Singing" * 3)
+        TestEditSecondTier.bestest.should eq("SSSSSOOOOOOOOOONNNNNNNNGGGGGGGSSSSSS")
+      end
+    end
+
+    describe "second tier inheritance" do 
+      it "overrides the instance variables with the child defined values" do 
+        TestEditThirdTier.first.should eq([])
+        TestEditThirdTier.awesomeness.should eq([])
+        TestEditThirdTier.bestest.should eq([])
+      end
+    end
+
+    describe "second tier inheritance without changing first override" do 
+      it "keeps instance variables the same as first override" do 
+        TestEditThirdTierWithoutEdit.first.should eq("Songs are for Singing")
+        TestEditThirdTierWithoutEdit.awesomeness.should eq("Songs are for Singing" * 3)
+        TestEditThirdTierWithoutEdit.bestest.should eq("SSSSSOOOOOOOOOONNNNNNNNGGGGGGGSSSSSS")
+      end
+    end
+  end
+
+  context "without overriding inherited values" do 
+    describe "single tier inheritance" do 
+
+      it "creates public attr_readers for inherited attributes" do 
+        TestSecondTier.should respond_to(:first)
+        TestSecondTier.should respond_to(:awesomeness)
+        TestSecondTier.should respond_to(:bestest)
+      end
+
+      it "inherits the values of hashes" do 
+        TestSecondTier.first.should eq({})
+      end
+
+      it "inherits the values of arrays" do 
+        TestSecondTier.awesomeness.should eq([:this, :that, :the_other])
+      end
+
+      it "inherits the values of Objects" do 
+        TestSecondTier.bestest.should eq("dirt apple (Po-ta-toes!)")
+      end
+
+    end
+
+    describe "2nd tier inheritance" do 
+
+      it "creates public attr_readers for inherited attributes" do 
+        TestThirdTier.should respond_to(:first)
+        TestThirdTier.should respond_to(:awesomeness)
+        TestThirdTier.should respond_to(:bestest)
+      end
+
+      it "inherits the values of hashes" do 
+        TestThirdTier.first.should eq({})
+      end
+
+      it "inherits the values of arrays" do 
+        TestThirdTier.awesomeness.should eq([:this, :that, :the_other])
+      end
+
+      it "inherits the values of Objects" do 
+        TestThirdTier.bestest.should eq("dirt apple (Po-ta-toes!)")
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+Bundler.require(:default, :development, :test)

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: heredity
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Dewitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-pride
+  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: pry-nav
+  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: simplecov
+  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: provides class inheritable attributes outside of rails and other gem/frameworks
+email:
+- brandonsdewitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heredity.gemspec
+- lib/heredity.rb
+- lib/heredity/version.rb
+- spec/inheritable_class_instance_variables_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1738474534293620341
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1738474534293620341
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: inherit class instance variables
+test_files:
+- spec/inheritable_class_instance_variables_spec.rb
+- spec/spec_helper.rb