attributable 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ae2deaa3e88ed46bd80f2f96e721c71093f06ca
-  data.tar.gz: b0253f219bc607ccb07ac8b9bdedc76a7af16b97
+  metadata.gz: 167cb3bfb8d4237095209222dd5e925e909b3e6c
+  data.tar.gz: 99d532b61ef03948d2e43a3c00412f54323a7978
 SHA512:
-  metadata.gz: 133f45dda1e6cf016f88811a8d67813743c58e4b4b2873c2aac7c2fedc562576f47be47faeab67860088081847135e709750559d377c65cae9468154fa663ecd
-  data.tar.gz: 3b954192277be8bb214c55a953d6fac6475f395295b4eb0bea3b152727cd36773d002cb3af36e5d649d9d49f8e6fe7ca9dd209b14f2a81c2e0aed90a5e964285
+  metadata.gz: 3b6b9812417f37be3717ce38c74dd04c4e13ba0ddda2278aa7684aeca11f3a0fb234a1bcb3b3359c52c98ad8cdbf1e432473b3f2bdb71a0edff1b0cdbcb33400
+  data.tar.gz: dd81b2cc7552dfe36f6d2f9ca1b69b8197055439f6e728615695493741481816674038169dd33d22053a6773424becb84ebe6cfa36a63a3cd2a8c722a031597c

data/README.md

@@ -76,8 +76,6 @@ Attributable adds an `inspect` method to your class which display attribute valu
 
 Attributable provides the `initialize_attributes` method which can be used if you need to specify your own `initialize` method. For example:
 
-    require "attributable"
-
     class UserWithDerivedAttribute
       extend Attributable
       attributes :forename, :surname
@@ -126,6 +124,22 @@ Specialising classes can override the defaults set in specialised classes.
     Ronson.new(forename: "Jon").inspect # <Ronson forename="Jon", surname="Ronson">
     Ronson.new(forename: "Mark").inspect # <Ronson forename="Mark", surname="Ronson">
 
+### Automatic specialisation for superclasses
+
+`specialise` is automatically called when subclassing a type that already mixes-in Attributable. In other words, the following code:
+
+    class AuthorWithDerivedAttribute < UserWithDerivedAttribute
+      attributes blogs: []
+    end
+    
+is equivalent to the slightly more verbose:
+
+    class AuthorWithDerivedAttribute < UserWithDerivedAttribute
+      specialises UserWithDerivedAttribute
+      attributes blogs: []
+    end
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/attributable/version.rb

@@ -1,3 +1,3 @@
 module Attributable
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/attributable.rb

@@ -16,6 +16,7 @@ module Attributable
     @predefined_attributes ||= {}
     @predefined_attributes = super_attributes.merge(@predefined_attributes)
     add_instance_methods(@predefined_attributes)
+    @predefined_attributes
   end
 
   private
@@ -42,6 +43,9 @@ module Attributable
     end
 
     define_method "initialize_attributes" do |attributes = {}|
+      if self.class.superclass.kind_of? Attributable
+        predefined_attributes = self.class.specialises(self.class.superclass)
+      end
       @attributes = predefined_attributes.merge(attributes)
     end
   end

data/spec/attributable/specialisation_spec.rb

@@ -79,4 +79,33 @@ describe Attributable do
       )
     end
   end
+
+  describe "automatic specialisation" do
+    it "should automatically specialise if superclass is an instance of Attributable" do
+      class SuperUser6 < User
+        attributes :password, active: true
+      end
+
+      s = SuperUser6.new(id: 1, forename: "Bob", password: "secret", active: false)
+
+      expect(s.id).to eq(1)
+      expect(s.forename).to eq("Bob")
+      expect(s.surname).to eq("Bloggs")
+      expect(s.password).to eq("secret")
+      expect(s.active).to be_false
+    end
+
+    it "shouldn't automatically specialise unless superclass is an instance of Attributable" do
+      class PORO
+        attr_accessor :name
+      end
+
+      class SuperUser7 < PORO
+        extend Attributable
+        attributes :forename, :surname
+      end
+
+      expect { SuperUser7.new }.to_not raise_error
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Louis Rose