json_api_ruby 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cf3164f2abf635e618957c75eea9210e2964c3e
-  data.tar.gz: f1927eafda56413ca744cc43ac5608344db1af55
+  metadata.gz: 2ba5f435a463e08420afbfe01b6e6c00d872c1d6
+  data.tar.gz: 82bd54e3e35ce66ac027407ddd5edcc71d06a9bf
 SHA512:
-  metadata.gz: 6af9abffd2f8321a35ef837a92bcfc8da35bec3685cfda916b0559db0c152bc3e00d80a39f34a5a381736a48af28f9fa15a409e0f85052c6dd30e1dd65c44aaf
-  data.tar.gz: 9e1a89a1741949c212c6833df0e65aa266bfc17630eca272b56f2690a4477e655d68f36442f8d370fc2a1bd7be12cc614f1bdfe3035f1547e0b9e0ad2fd6bd7b
+  metadata.gz: 07593a0a1372734b4adcd11bd263e129cece029dc3f3bf3de9dd8998a7a28f32ebf0d02de4e9ff1c77cbdda4a7f6e976a15d666a803a0d983d57a4da935bea80
+  data.tar.gz: 3625634704e631f29bcce7f64bbd53c847febf50806b063dffced0b3babe90f88360b2349622dce08a47a2bd4ec77529db629e3540fcd0aa9d95534216b451ad

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+0.2.0
+Added the ability to subclass from a class whose superclass is Resource
+
 0.1.1
 Fix issues related to empty or nil objects
 

data/lib/json_api_ruby/resources/base.rb

@@ -37,7 +37,7 @@ module JsonApi
       end
 
       def attributes_hash
-        Array(self.class.fields).inject({}) do |attrs, attr|
+        fields_array.inject({}) do |attrs, attr|
           meth = method(attr)
           attrs[attr.to_s] = meth.call
           attrs
@@ -47,12 +47,47 @@ module JsonApi
       # Builds relationship resource classes
       def build_object_graph
         @relationships ||= []
-        Array(self.class.relationships).each do |relationship|
+        relationships_array.each do |relationship|
           included = includes.include?(relationship.name)
           rel = relationship.build_resources({parent_resource: self, included: included})
           @relationships << rel
         end
       end
+
+      # Traverses fields set on super-class(es) and concatinates them into a
+      # single set. Stores the set in `self.class.fields`, leaving super-class
+      # `fields` sets untouched.
+      def fields_array(klass = self.class)
+        fields_list = concat_list(self.class.fields, klass.fields)
+        unless klass.superclass == Resource
+          return fields_array(klass.superclass)
+        end
+        fields_list
+      end
+
+      # Traverses relationships set on super-class(es) and concatinates them
+      # into a single set. Stores the set in `self.class.relationships`,
+      # leaving super-class `relationships` sets untouched.
+      def relationships_array(klass = self.class)
+        rel_list = concat_list(self.class.relationships, klass.relationships)
+        unless klass.superclass == Resource
+          return relationships_array(klass.superclass)
+        end
+        rel_list
+      end
+
+      private
+
+      # Adds elements of the `concat_list` to the `target_list` if they are
+      # not already present.
+      def concat_list(target_list, concat_list)
+        list = Array(target_list)
+        not_in_list = Array(concat_list).reject do |item|
+          list.include?(item)
+        end
+        not_in_list.each { |item| list << item }
+        list
+      end
     end
 
   end

data/lib/json_api_ruby/version.rb

@@ -1,3 +1,3 @@
 module JsonApi
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/json_api_ruby/resource_spec.rb

@@ -87,4 +87,65 @@ RSpec.describe JsonApi::Resource do
       expect(serialized_person['links']['self']).to eq("http://localhost:3000/people/#{person.id}")
     end
   end
+
+  describe 'deep subclassing of Resources' do
+    let(:person) { Person.new('Philip J. Fry', 'fry@thefuture.com', 'www.thefuture.com', '@philipjfry') }
+    subject(:super_class_serialization) do
+      PersonResource.new(person).to_hash
+    end
+
+    context 'subclasses of class whose superclass is Resource' do
+      subject(:subclass_serialization) do
+        SubclassedPersonResource.new(person).to_hash
+      end
+
+      it "does not affect its super-class's list of attributes" do
+        expect(PersonResource.fields).to_not eq(SubclassedPersonResource.fields)
+      end
+
+      it 'concatinates its attributes with the list of attributes from its super-class' do
+        expected_attributes = super_class_serialization['attributes'].merge('website' => 'www.thefuture.com')
+        expect(subclass_serialization['attributes']).to eq(expected_attributes)
+      end
+
+      it 'returns the same relationships as its super-class' do
+        expect(subclass_serialization['relationships']).to eq(super_class_serialization['relationships'])
+      end
+
+      context 'with overridden attributes' do
+        subject(:overridden_serialization) do
+          OverriddenSubclassedPersonResource.new(person).to_hash
+        end
+
+        it 'returns overridden attributes from the subclass' do
+          expect(overridden_serialization['attributes']['name']).to eq('Philip J. Fry!!')
+        end
+      end
+    end
+
+    context 'subclasses of subclasses of class whose superclass is Resource' do
+      subject(:deep_subclass_serialization) do
+        DeeplySubclassedPersonResource.new(person).to_hash
+      end
+
+      it 'concatinates its attributes with the list of attributes from its super-classes' do
+        expected_attributes = super_class_serialization['attributes'].merge('website' => 'www.thefuture.com', 'twitter' => '@philipjfry')
+        expect(deep_subclass_serialization['attributes']).to eq(expected_attributes)
+      end
+
+      it 'returns the same relationships as its super-classes' do
+        expect(deep_subclass_serialization['relationships']).to eq(super_class_serialization['relationships'])
+      end
+
+      context 'with overridden attributes' do
+        subject(:deep_overridden_serialization) do
+          OverriddenDeeplySubclassedPersonResource.new(person).to_hash
+        end
+
+        it 'returns overridden attributes from the subclass' do
+          expect(deep_overridden_serialization['attributes']['name']).to eq('Philip J. Fry?')
+        end
+      end
+    end
+  end
 end

data/spec/support/resource_objects.rb

@@ -53,11 +53,13 @@ end
 
 class Person
   include Identifiers
-  attr_accessor :name, :email_address, :created_at, :updated_at
+  attr_accessor :name, :email_address, :website, :twitter, :created_at, :updated_at
 
-  def initialize(name, email)
+  def initialize(name, email, website = nil, twitter = nil)
     @name = name
     @email_address = email
+    @website = website
+    @twitter = twitter
     @created_at = 1.month.ago
     @updated_at = 1.month.ago
   end
@@ -76,6 +78,26 @@ class PersonResource < JsonApi::Resource
   has_many :articles
 end
 
+class SubclassedPersonResource < PersonResource
+  attribute :website
+end
+
+class DeeplySubclassedPersonResource < SubclassedPersonResource
+  attribute :twitter
+end
+
+class OverriddenSubclassedPersonResource < PersonResource
+  def name
+    object.name + '!!'
+  end
+end
+
+class OverriddenDeeplySubclassedPersonResource < OverriddenSubclassedPersonResource
+  def name
+    object.name + '?'
+  end
+end
+
 class ArticleResource < JsonApi::Resource
   id_field :uuid
   attributes :publish_date, :title, :short_description, :created_at, :updated_at
@@ -127,4 +149,3 @@ module DifferentNamespace
   class ThreeResource < JsonApi::Resource
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tracey Eubanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport