praxis-mapper 3.1.2 → 3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71bd06fa8f2c3ff667aef12cf116a714c17c76fa
-  data.tar.gz: 3ab68cf2cdf25df7fe6ba341a459b3c0047fc1e1
+  metadata.gz: c0f5ae2201ca9a681d3f65c4ea8a51d3523e1620
+  data.tar.gz: 5fa2fc72ff6c38fac99fa60a4fd42d3bcadc7aa6
 SHA512:
-  metadata.gz: 19cb0ef80ba71a29fc8674ed6278cdc3c9e3336504698117818e3c856a3fb1e0cdfa5b5f4c4850e84c95cda2ed57a204b99709fc7113b9f3e0dfbe68a57e191a
-  data.tar.gz: 66b34d0b5c243c2ac1f092f041bc68995bc5a200b30d3e0ad3ed269213108548b8e5ce7947eaeb46f327be443fd5c0b76045467e70c58da1d95e9ecce10aa5ec
+  metadata.gz: 2add48d3bca8c0ce48ee4bf2d66ba02582f0c781bcb45e792af98b500eb0f368b7e6e93fd64c0e1a211fe2e1a02355c1b190130cd2fd750409e44c0a79197b1d
+  data.tar.gz: 13e3428c8129be0d9eb2a3c9c3269ab50cd10545027092e971fcdbc07e6c0f3af67fa51d277c4abfca56a7e19a88ac9b09a63c292a116a64e5a107f300be4bca

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 # praxis-mapper changelog
 
-## next
+## 3.2.0
 
-* Next feature or fix here.
+* Add `Resource.decorate` for extending/overriding methods on Resource associations. See `PersonResource` in [spec_resources.rb](spec/support/spec_resources.rb) for usage. 
 
 ## 3.1.2
 

data/lib/praxis-mapper/model.rb

@@ -18,16 +18,13 @@ module Praxis::Mapper
 
       klass.instance_eval do
         @config = {
-          :belongs_to => {},
-          :excluded_scopes => [],
-          :identities => []
+          excluded_scopes: [],
+          identities: []
         }
         @associations = {}
         @serialized_fields = {}
         @contexts = Hash.new
       end
-
-
     end
 
     # Internal finalize! logic

data/lib/praxis-mapper/resource.rb

@@ -3,33 +3,56 @@ require 'active_support/inflector'
 # A resource creates a data store and instantiates a list of models that it wishes to load, building up the overall set of data that it will need.
 # Once that is complete, the data set is iterated and a resultant view is generated.
 module Praxis::Mapper
+
+  class ResourceDecorator < BasicObject
+    def initialize(parent, object)
+      @parent = parent
+      @object = object # store obj for future use
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @object.respond_to?(name, include_private) || super
+    end
+
+    def method_missing(name,*args, &block)
+      @object.__send__(name, *args, &block)
+    end
+
+    def __getobj__
+      @object
+    end
+  end
+
+
   class Resource
     extend Finalizable
 
     attr_accessor :record
-    
+
+    class << self
+      attr_reader :model_map
+      attr_reader :decorations
+    end
+
     # TODO: also support an attribute of sorts on the versioned resource module. ie, V1::Resources.api_version.
-    #       replacing the self == Praxis::Mapper::Resource condition below.
+    #       replacing the self.superclass == Praxis::Mapper::Resource condition below.
     def self.inherited(klass)
       super
 
-      # It is expected that each versioned set of resources will have a common Base class.
-      # self is Praxis::Mapper::Resource only for Base resource classes which are versioned.
-      if self == Praxis::Mapper::Resource
-        klass.instance_variable_set(:@model_map, Hash.new)
-      elsif defined?(@model_map)
-        klass.instance_variable_set(:@model_map, @model_map)
-      end
-    end
+      klass.instance_eval do
+        # It is expected that each versioned set of resources
+        # will have a common Base class, and so should share
+        # a model_map
+        if self.superclass == Praxis::Mapper::Resource
+          @model_map = Hash.new
+        else
+          @model_map = self.superclass.model_map 
+        end
 
-    def self.model_map
-      if defined? @model_map
-        return @model_map
-      else
-        return {}
+        @decorations = {}
       end
-    end
 
+    end
 
     #TODO: Take symbol/string and resolve the klass (but lazily, so we don't care about load order)
     def self.model(klass=nil)
@@ -41,9 +64,16 @@ module Praxis::Mapper
       end
     end
 
+
+    def self.decorate(name, &block)
+      self.decorations[name] = Class.new(ResourceDecorator, &block)
+    end
+
     def self._finalize!
       finalize_resource_delegates
       define_model_accessors
+      define_decorators
+
       super
     end
 
@@ -60,6 +90,7 @@ module Praxis::Mapper
 
     def self.define_model_accessors
       return if model.nil?
+
       model.associations.each do |k,v|
         if self.instance_methods.include? k
           warn "WARNING: #{self.name} already has method named #{k.inspect}. Will not define accessor for resource association."
@@ -69,6 +100,29 @@ module Praxis::Mapper
     end
 
 
+    def self.define_decorators
+      self.decorations.each do |name,block|
+        self.define_decorator(name, block)
+      end
+    end
+
+    def self.define_decorator(name, block)
+      unless self.instance_methods.include?(name)
+        # assume it'll be a regular accessor and create it 
+        self.define_accessor(name)
+      end
+      # alias original method and wrap it 
+      raw_name = "_raw_#{name}"
+      alias_method(raw_name.to_sym, name)
+
+      module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{name}
+          object = self.#{raw_name}
+          self.class.decorations[#{name.inspect}].new(self, object)
+        end
+      RUBY
+    end
+
     def self.for_record(record)
       return record._resource if record._resource
 
@@ -83,17 +137,17 @@ module Praxis::Mapper
     end
 
 
-    def self.wrap(records)
-      case records
-      when Model
-        return self.for_record(records)
-      when nil
-        # Return an empty set if `records` is nil
-        return []
-      else
-        return records.collect { |record| self.for_record(record) }
-      end
+  def self.wrap(records)
+    case records
+    when nil
+      return []
+    when Enumerable
+      return records.collect { |record| self.for_record(record) }
+    else
+      return self.for_record(records)
     end
+  end
+
 
 
     def self.get(condition)
@@ -109,14 +163,6 @@ module Praxis::Mapper
     end
 
 
-    def initialize(record)
-      @record = record
-    end
-
-    def respond_to_missing?(name,*)
-      @record.respond_to?(name) || super
-    end
-
     def self.resource_delegates
       @resource_delegates ||= {}
     end
@@ -127,17 +173,18 @@ module Praxis::Mapper
       end
     end
 
-    # Defines wrapers for model associations that return Resources
+    # Defines wrappers for model associations that return Resources
     def self.define_model_association_accessor(name, association_spec)
       association_model = association_spec.fetch(:model)
       association_resource_class = model_map[association_model]
+
       if association_resource_class
         module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{name}
-            records = record.#{name}
+        def #{name}
+          records = record.#{name}
             return nil if records.nil?
-            @__#{name} ||= #{association_resource_class}.wrap(records)
-          end
+          @__#{name} ||= #{association_resource_class}.wrap(records)
+        end
         RUBY
       end
     end
@@ -154,13 +201,12 @@ module Praxis::Mapper
     end
 
 
-
     def self.define_delegation_for_related_attribute(resource_name, resource_attribute)
       module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{resource_attribute}
           @__#{resource_attribute} ||= if (rec = self.#{resource_name})
-            rec.#{resource_attribute}
-          end
+          rec.#{resource_attribute}
+            end
         end
       RUBY
     end
@@ -172,11 +218,11 @@ module Praxis::Mapper
       module_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{resource_attribute}
           @__#{resource_attribute} ||= if (rec = self.#{resource_name})
-            if (related = rec.#{resource_attribute})
-              #{related_resource_class.name}.wrap(related)
-            end
+          if (related = rec.#{resource_attribute})
+            #{related_resource_class.name}.wrap(related)
           end
         end
+      end
       RUBY
     end
 
@@ -188,13 +234,22 @@ module Praxis::Mapper
       end
 
       module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def #{name}
-          return @__#{ivar_name} if defined? @__#{ivar_name}
-          @__#{ivar_name} = record.#{name}
-        end
+      def #{name}
+        return @__#{ivar_name} if defined? @__#{ivar_name}
+        @__#{ivar_name} = record.#{name}
+      end
       RUBY
     end
 
+
+    def initialize(record)
+      @record = record
+    end
+
+    def respond_to_missing?(name,*)
+      @record.respond_to?(name) || super
+    end
+
     def method_missing(name,*args)
       if @record.respond_to?(name)
         self.class.define_accessor(name)

data/lib/praxis-mapper/version.rb

@@ -1,5 +1,5 @@
 module Praxis
   module Mapper
-    VERSION = "3.1.2"
+    VERSION = "3.2"
   end
 end

data/spec/praxis-mapper/resource_spec.rb

@@ -21,7 +21,6 @@ describe Praxis::Mapper::Resource do
     its(:collection_name) { should == 'simple_resources' }
   end
 
-
   context 'retrieving resources' do
 
     context 'getting a single resource' do
@@ -114,6 +113,43 @@ describe Praxis::Mapper::Resource do
   end
 
 
+  context 'decorate' do
+    let(:person_record) do
+      PersonModel.new(id: 1, email: "one@example.com", address_id: 2)
+    end
+
+    let(:address_record) do
+      AddressModel.new(id: 2, owner_id: 1, state: 'OR')
+    end
+
+    before do
+      identity_map.add_records([person_record])
+      identity_map.add_records([address_record])
+    end
+
+    subject(:person) { PersonResource.for_record(person_record) }
+    let(:address){ AddressResource.for_record(address_record) }
+
+    it 'wraps the decorated associations in a ResourceDecorator' do
+      # somewhat hard to test, as ResourceDecorator uses BasicObject
+      person.address.should_not be(address)
+      person.address.__getobj__.should be(address)
+    end
+
+
+    it 'decorates many_to_one associations properly' do
+      person.address.href.should eq('/people/1/address')
+      person.address.state.should eq('OR')
+      address.href.should eq('/addresses/2')
+
+    end
+
+    it 'decorates one_to_many associations properly' do
+      person.properties.href.should eq('/people/1/properties')
+      person.properties.first.should be(address)
+    end
+  end
+
   context "memoized resource creation" do
     let(:other_name) { "foo" }
     let(:other_attribute) { "other value" }

data/spec/support/spec_models.rb

@@ -129,7 +129,7 @@ class PersonModel < Praxis::Mapper::Model
     model AddressModel
     key :address_id # people.address_id
   end
-
+               
   one_to_many :properties do
     model AddressModel
     primary_key :id #people.id

data/spec/support/spec_resources.rb

@@ -37,3 +37,34 @@ end
 class YamlArrayResource < BaseResource
   model YamlArrayModel
 end
+
+
+class PersonResource < BaseResource
+  model PersonModel
+
+  decorate :address do
+    def href
+      @parent.href + "/address"
+    end
+  end
+
+  decorate :properties do
+    def href
+      @parent.href + "/properties"
+    end
+  end
+
+  def href
+    "/people/#{self.id}"
+  end
+
+end
+
+class AddressResource < BaseResource
+  model AddressModel
+
+  def href 
+    "/addresses/#{self.id}"
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-mapper
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: '3.2'
 platform: ruby
 authors:
 - Josep M. Blanquer