heredity 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec31e3521f55721c771972fa759a5af017fb8171
+  data.tar.gz: 82d9c7cea355d67b0286ecee5074a65db1e44c1e
+SHA512:
+  metadata.gz: 59526772bd0b154ea527a272de9feb23fb6c02427494563dca3f21492eb04f559f077b00c567b857deb8fa3c88bfc07c6248c1ccd0f449a78110318f1dc08b99
+  data.tar.gz: edb62863333394c783d70da8dbb4f7012ed2d61796ac0a5866682ea89c95d8903c1acb33d6fe7da2fdb33641b0573bdb9d150b082e5bcf593793303dc506d9e2

data/README.md

@@ -1,6 +1,6 @@
 # Heredity
 
-TODO: Write a gem description
+Heredity adds on_inherit hooks to Ruby which providing a clean way execute code on inherited classes without the need to override `inherited`. It also adds the ability to specify class instance variables that should be copied to subclasses.
 
 ## Installation
 
@@ -18,7 +18,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Inheritance hooks
+
+To use Heredity's inheritance hooks, simply call `on_herit` with a block:
+
+```Ruby
+class Foo
+  on_inherit do
+    puts 'Child of Foo!'
+  end
+end
+```
+
+This is very useful for injecting behavior into subclasses that is dependent on class state (e.g. behavior that relies on the columns of an active record model).
+
+#### Class instance variables
+
+Because class instance variables in Ruby are not inherited (and rightfully so), Heredity provides the ability to define specific class instance variables that should be inherited. To define inheritable attributes:
+
+```Ruby
+class Foo
+  include Heredity
+
+  # Define inheritable attributes
+  inheritable_attributes :bar
+
+  # Initialize inheritable attributes (so there's something to copy).
+  self.bar = {}
+end
+```
 
 ## Contributing
 

data/lib/heredity/inheritable_class_instance_variables.rb

@@ -1,11 +1,12 @@
-require 'thread'
-
 module Heredity
   module InheritableClassInstanceVariables
+
+    MUTEX_FOR_THREAD_EXCLUSIVE = Mutex.new
+
     def self.included(klass)
       return if klass.respond_to?(:_inheritable_class_instance_variables)
 
-      Thread.exclusive do
+      MUTEX_FOR_THREAD_EXCLUSIVE.synchronize do
         klass.extend(::Heredity::InheritableClassInstanceVariables::ClassMethods)
 
         klass.class_eval do
@@ -26,7 +27,7 @@ module Heredity
       end
 
       def inheritable_attributes(*args)
-        Thread.exclusive do
+        MUTEX_FOR_THREAD_EXCLUSIVE.synchronize 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
@@ -54,7 +55,7 @@ module Heredity
       def inherited(klass)
         super # ActiveRecord needs the inherited hook to setup fields
 
-        Thread.exclusive do
+        MUTEX_FOR_THREAD_EXCLUSIVE.synchronize do
           @_inheritable_class_instance_variables.each do |attribute|
             attr_sym = :"@#{attribute}"
             klass.instance_variable_set(attr_sym, self.instance_variable_get(attr_sym))

data/lib/heredity/version.rb

@@ -1,3 +1,3 @@
 module Heredity
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/heredity/inheritable_class_instance_variables_spec.rb

@@ -30,41 +30,41 @@ describe Heredity::InheritableClassInstanceVariables do
 
   # 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) }
+    specify { expect(test_class).to respond_to(:inheritable_attributes) }
+    specify { expect(test_class).to respond_to(:inheritable_attribute) }
+    specify { expect(test_class).to respond_to(:class_inheritable_attributes) }
+    specify { expect(test_class).to respond_to(:class_inheritable_attribute) }
   end
 
   context "when inheritable class instance variables is already included" do
     it "doesn't reset inheritable attributes" do
       TestInheritTop.__send__(:include, ::Heredity::InheritableClassInstanceVariables)
-      TestInheritTop.inheritable_attributes.should include :first, :awesomeness, :bestest
+      expect(TestInheritTop.inheritable_attributes).to include :first, :awesomeness, :bestest
     end
   end
 
   context "when overriding child class instance variables" 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")
+        expect(TestEditSecondTier.first).to eq("Songs are for Singing")
+        expect(TestEditSecondTier.awesomeness).to eq("Songs are for Singing" * 3)
+        expect(TestEditSecondTier.bestest).to 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([])
+        expect(TestEditThirdTier.first).to eq([])
+        expect(TestEditThirdTier.awesomeness).to eq([])
+        expect(TestEditThirdTier.bestest).to 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")
+        expect(TestEditThirdTierWithoutEdit.first).to eq("Songs are for Singing")
+        expect(TestEditThirdTierWithoutEdit.awesomeness).to eq("Songs are for Singing" * 3)
+        expect(TestEditThirdTierWithoutEdit.bestest).to eq("SSSSSOOOOOOOOOONNNNNNNNGGGGGGGSSSSSS")
       end
     end
   end
@@ -73,21 +73,21 @@ describe Heredity::InheritableClassInstanceVariables 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)
+        expect(TestSecondTier).to respond_to(:first)
+        expect(TestSecondTier).to respond_to(:awesomeness)
+        expect(TestSecondTier).to respond_to(:bestest)
       end
 
       it "inherits the values of hashes" do
-        TestSecondTier.first.should eq({})
+        expect(TestSecondTier.first).to eq({})
       end
 
       it "inherits the values of arrays" do
-        TestSecondTier.awesomeness.should eq([:this, :that, :the_other])
+        expect(TestSecondTier.awesomeness).to eq([:this, :that, :the_other])
       end
 
       it "inherits the values of Objects" do
-        TestSecondTier.bestest.should eq("dirt apple (Po-ta-toes!)")
+        expect(TestSecondTier.bestest).to eq("dirt apple (Po-ta-toes!)")
       end
 
     end
@@ -95,21 +95,21 @@ describe Heredity::InheritableClassInstanceVariables do
     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)
+        expect(TestThirdTier).to respond_to(:first)
+        expect(TestThirdTier).to respond_to(:awesomeness)
+        expect(TestThirdTier).to respond_to(:bestest)
       end
 
       it "inherits the values of hashes" do
-        TestThirdTier.first.should eq({})
+        expect(TestThirdTier.first).to eq({})
       end
 
       it "inherits the values of arrays" do
-        TestThirdTier.awesomeness.should eq([:this, :that, :the_other])
+        expect(TestThirdTier.awesomeness).to eq([:this, :that, :the_other])
       end
 
       it "inherits the values of Objects" do
-        TestThirdTier.bestest.should eq("dirt apple (Po-ta-toes!)")
+        expect(TestThirdTier.bestest).to eq("dirt apple (Po-ta-toes!)")
       end
 
     end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: heredity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Brandon Dewitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2016-07-01 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
@@ -98,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,33 +102,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 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: 252453511989656056
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 252453511989656056
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: inherit class instance variables
 test_files:
 - spec/heredity/inheritable_class_instance_variables_spec.rb