hal_decorator 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2897e8bc0d974babfc03d1461b90ae41c9e082a7
-  data.tar.gz: d2205bd5adc36fb326f2e90571e5f7b5ea02fd2b
+  metadata.gz: 17e8c82477966a527d6a2f9d51120641f2b6bb11
+  data.tar.gz: 8a4043e183c059f458c5495cb4eb287e7b3e6278
 SHA512:
-  metadata.gz: 78f1ff66a8dee4282b2286cb7fdb96d56d48a498eb43f00d1606b8362d7d5597d58ce6eddf82fd8f2d513865fc1a969c01588cced3855c962c764ec3e97c76e9
-  data.tar.gz: 22b1031407abe3fc434add985e476c1d7281f56884e22162325694b052f8e7d48184e879fac68654da845c1c405f212d8c4bfd5e7b3ac591587e74dddf2f21c7
+  metadata.gz: 674b6c85ae4dc3b1498bb0386d24903504aa7a026a2fc6592891c098117b08ba2f7c696ce26161ddf88009bed66c02e9d5dcfe18c74ead3a7d9f430515ce05d2
+  data.tar.gz: 5ad6702a98818ab1fde31b646cb77b766cc60688dfc5858bf3105a43cbcda1db6509d6f1d4506ff89f9fae18801f2d7464c1fc6e241c7be2a04dff5f39f4531d

data/lib/hal_decorator/attributes.rb

@@ -3,15 +3,25 @@ require 'hal_decorator/property'
 module HALDecorator
   module Attributes
     def attribute(*args, &block)
-      @_attributes ||= []
+      @_attributes ||= init_attributes
+      @_attributes = @_attributes.reject { |attr| attr.name == args.first }
       @_attributes << Property.new(*args, &block)
     end
 
     protected
 
     def attributes
-      @_attributes ||= []
-      @_attributes.dup
+      @_attributes ||= init_attributes
+    end
+
+    private
+
+    def init_attributes
+      return [] unless is_a? Class
+      return [] unless superclass.respond_to?(:attributes, true)
+      superclass.attributes.each do |attr|
+        attr.change_scope(self)
+      end
     end
   end
 end

data/lib/hal_decorator/collection.rb

@@ -3,8 +3,6 @@ require 'hal_decorator/property'
 module HALDecorator
   module Collection
 
-    attr_reader :collection_name
-
     class CollectionParameters
       include Attributes
       include Links
@@ -25,7 +23,16 @@ module HALDecorator
     protected
 
     def collection_parameters
-      @_parameters ||= nil
+      @_parameters ||= init_collection_params
+    end
+
+    private
+
+    def init_collection_params
+      return unless is_a? Class
+      if superclass.respond_to?(:collection_parameters, true)
+        superclass.collection_parameters
+      end
     end
   end
 end

data/lib/hal_decorator/curies.rb

@@ -6,15 +6,25 @@ module HALDecorator
       if value.nil? && !block_given?
         raise 'curie must be called with non nil value or be given a block'
       end
-      @_curies ||= []
+      @_curies ||= init_curies
+      @_curies = @_curies.reject { |curie| curie.name == rel }
       @_curies << Property.new(rel, value, &block)
     end
 
     protected
 
     def curies
-      @_curies ||= []
-      @_curies.dup
+      @_curies ||= init_curies
+    end
+
+    private
+
+    def init_curies
+      return [] unless is_a? Class
+      return [] unless superclass.respond_to?(:curies, true)
+      superclass.curies.each do |curie|
+        curie.change_scope(self)
+      end
     end
   end
 end

data/lib/hal_decorator/deserializer.rb

@@ -2,6 +2,10 @@ require 'json'
 
 module HALDecorator
 
+  def self.from_hal(decorator, payload, resource = nil)
+    decorator.from_hal(payload, resource)
+  end
+
   module Deserializer
 
     class Error < StandardError; end

data/lib/hal_decorator/embedded.rb

@@ -12,15 +12,25 @@ module HALDecorator
     end
 
     def embed(*args, &block)
-      @_embedded ||= []
+      @_embedded ||= init_embedded
+      @_embedded = @_embedded.reject { |embed| embed.name == args.first }
       @_embedded << Embed.new(*args, &block)
     end
 
     protected
 
     def embedded
-      @_embedded ||= []
-      @_embedded.dup
+      @_embedded ||= init_embedded
+    end
+
+    private
+
+    def init_embedded
+      return [] unless is_a? Class
+      return [] unless superclass.respond_to?(:embedded, true)
+      superclass.embedded.each do |embed|
+        embed.change_scope(self)
+      end
     end
   end
 end

data/lib/hal_decorator/links.rb

@@ -1,6 +1,17 @@
 require 'hal_decorator/property'
 
 module HALDecorator
+
+  def self.base_href=(base)
+    @base_href = base&.sub(%r(/*$), '')
+  end
+
+  def self.href(href)
+    return href if (@base_href ||= '').empty?
+    return href if href =~ %r(\A(\w+://)?[^/])
+    @base_href + href
+  end
+
   module Links
 
     class Link < HALDecorator::Property
@@ -12,18 +23,32 @@ module HALDecorator
         @http_method = http_method
         super(rel, value, &block)
       end
+
+      def rel
+        name
+      end
     end
 
     def link(rel, value = nil, method: nil, methods: nil, &block)
-      @_links ||= []
+      @_links ||= init_links
+      @_links = @_links.reject { |link| link.rel == rel }
       @_links << Link.new(rel, value, http_method: method || methods, &block)
     end
 
     protected
 
     def links
-      @_links ||= []
-      @_links.dup
+      @_links ||= init_links
+    end
+
+    private
+
+    def init_links
+      return [] unless is_a? Class
+      return [] unless superclass.respond_to?(:links, true)
+      superclass.links.each do |link|
+        link.change_scope(self)
+      end
     end
   end
 end

data/lib/hal_decorator/model.rb

@@ -14,7 +14,7 @@ module HALDecorator
   end
 
   def HALDecorator.lookup_decorator(model)
-    clazz = model.class == Class ? model : model.class
+    clazz = model.is_a?(Class) ? model : model.class
     decorators = @decorators.select { |d, m| m == clazz }.keys.compact
     decorators.empty? ? nil : decorators
   end
@@ -23,6 +23,13 @@ module HALDecorator
     def model(clazz)
       HALDecorator.register(model: clazz, decorator: self)
     end
+
+    def inherited(subclass)
+      if model = HALDecorator.lookup_model(self)
+        HALDecorator.register(model: model, decorator: subclass)
+      end
+      super
+    end
   end
 end
 

data/lib/hal_decorator/property.rb

@@ -16,7 +16,7 @@ module HALDecorator
     def value(resource = nil, options = {})
       @resource = resource
       @options = options
-      if @scope
+      if scope
         value_from_block
       elsif resource && @value.nil?
         resource.public_send(name) if resource.respond_to?(name)
@@ -27,21 +27,28 @@ module HALDecorator
       reset
     end
 
+    def change_scope(new_scope)
+      return unless scope
+      @scope = new_scope
+    end
+
     def method_missing(method, *args, &block)
-      if @scope&.respond_to? method
-        define_singleton_method(method) { |*a, &b| @scope.public_send method, *a, &b }
+      if scope&.respond_to? method
+        define_singleton_method(method) { |*a, &b| scope.public_send method, *a, &b }
         return public_send(method, *args, &block)
       end
       super
     end
 
     def respond_to_missing?(method, include_private = false)
-      return true if @scope&.respond_to? method
+      return true if scope&.respond_to? method
       super
     end
 
     private
 
+    attr_reader :scope
+
     def reset
       @resource = nil
       @options = nil

data/lib/hal_decorator/serialize_hooks.rb

@@ -0,0 +1,41 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module SerializeHooks
+
+    class Hook
+      attr_reader :name, :resource, :options
+
+      def initialize(&block)
+        @block = block
+      end
+
+      def run(resource, options, arg)
+        @resource = resource
+        @options = options
+        instance_exec(arg, &@block) if @block
+      ensure
+        @resource = nil
+        @options = nil
+      end
+    end
+
+    def post_serialize(&block)
+      @_post_serialize_hook = Hook.new(&block)
+    end
+
+    protected
+
+    def post_serialize_hook
+      @_post_serialize_hook ||= init_post_serialize_hook
+    end
+
+    private
+
+    def init_post_serialize_hook
+      return unless is_a? Class
+      return unless superclass.respond_to?(:post_serialize_hook, true)
+      superclass.post_serialize_hook
+    end
+  end
+end

data/lib/hal_decorator/serializer.rb

@@ -2,6 +2,22 @@ require 'json'
 
 module HALDecorator
 
+  def self.to_hal(resource, options = {})
+    raise Serializer::Error, "Resource is nil" if resource.nil?
+    decorator = options.delete(:decorator)
+    decorator ||= HALDecorator.lookup_decorator(resource)&.last
+    raise Serializer::Error, "No decorator for #{resource}" unless decorator
+    decorator.to_hal(resource, options)
+  end
+
+  def self.to_collection(resources, options = {})
+    raise Serializer::Error, "resources is nil" if resources.nil?
+    decorator = options.delete(:decorator)
+    decorator ||= HALDecorator.lookup_decorator(resources.first)&.last
+    raise Serializer::Error, "No decorator for #{resources.first}" unless decorator
+    decorator.to_collection(resources, options)
+  end
+
   module Serializer
 
     class Error < StandardError; end
@@ -30,56 +46,64 @@ module HALDecorator
 
     protected
 
-    def to_hash(object, options)
+    def to_hash(resource, options)
       {}.tap do |serialized|
-        serialized.merge! serialize_attributes(object, options)
-        serialized.merge! serialize_links(object, options)
-        serialized.merge! serialize_embedded(object, options)
+        serialized.merge! serialize_attributes(resource, options)
+        serialized.merge! serialize_links(resource, options)
+        serialized.merge! serialize_embedded(resource, options)
+
+        run_post_serialize_hook!(resource, options, serialized)
       end
     end
 
-    def serialize_attributes(object, options)
-      _serialize_attributes(attributes, object, options)
+    def serialize_attributes(resource, options)
+      _serialize_attributes(attributes, resource, options)
+    end
+
+    def serialize_links(resource, options)
+      _serialize_links(links, curies, resource, options)
     end
 
-    def serialize_links(object, options)
-      _serialize_links(links, curies, object, options)
+    def serialize_curies(resource, options)
+      _serialize_curies(curies, resource, options)
     end
 
-    def serialize_curies(object, options)
-      _serialize_curies(curies, object, options)
+    def serialize_embedded(resource, options)
+      _serialize_embedded(embedded, resource, options)
     end
 
-    def serialize_embedded(object, options)
-      _serialize_embedded(embedded, object, options)
+    def run_post_serialize_hook!(resource, options, serialized)
+      hook = post_serialize_hook
+      hook&.run(resource, options, serialized)
     end
 
     private
 
-    def _serialize_attributes(attributes, object, options)
+    def _serialize_attributes(attributes, resource, options)
       attributes.each_with_object({}) do |attribute, hash|
-        hash[attribute.name] = attribute.value(object, options)
+        hash[attribute.name] = attribute.value(resource, options)
       end
     end
 
-    def _serialize_links(links, curies, object, options)
+    def _serialize_links(links, curies, resource, options)
       serialized = links.each_with_object({}) do |link, hash|
-        value = link.value(object, options) or next
-        hash[link.name] = { href: value }.tap do |s|
+        href = link.value(resource, options) or next
+        hash[link.rel] = { href: HALDecorator.href(href) }.tap do |s|
           s[:method] = link.http_method if link.http_method
         end
       end
-      curies = _serialize_curies(curies, object, options)
+      curies = _serialize_curies(curies, resource, options)
       serialized[:curies] = curies if curies.any?
       return {} if serialized.empty?
       { _links: serialized }
     end
 
-    def _serialize_curies(curies, object, options)
+    def _serialize_curies(curies, resource, options)
       curies.each_with_object([]) do |curie, array|
+        href = curie.value(resource, options) or next
         array << {
           name: curie.name,
-          href: curie.value(object, options),
+          href: HALDecorator.href(href),
           templated: true
         }
       end

data/lib/hal_decorator.rb

@@ -6,42 +6,16 @@ require 'hal_decorator/model'
 require 'hal_decorator/serializer'
 require 'hal_decorator/deserializer'
 require 'hal_decorator/collection'
-
+require 'hal_decorator/serialize_hooks'
 
 module HALDecorator
-
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    include HALDecorator::Attributes
-    include HALDecorator::Links
-    include HALDecorator::Curies
-    include HALDecorator::Embedded
-    include HALDecorator::Collection
-    include HALDecorator::Model
-    include HALDecorator::Serializer
-    include HALDecorator::Deserializer
-  end
-
-  def self.to_hal(resource, options = {})
-    raise Serializer::Error, "Resource is nil" if resource.nil?
-    decorator = options.delete(:decorator)
-    decorator ||= HALDecorator.lookup_decorator(resource)&.first
-    raise Serializer::Error, "No decorator for #{resource}" unless decorator
-    decorator.to_hal(resource, options)
-  end
-
-  def self.to_collection(resources, options = {})
-    raise Serializer::Error, "resources is nil" if resources.nil?
-    decorator = options.delete(:decorator)
-    decorator ||= HALDecorator.lookup_decorator(resources.first)&.first
-    raise Serializer::Error, "No decorator for #{resources.first}" unless decorator
-    decorator.to_collection(resources, options)
-  end
-
-  def self.from_hal(decorator, payload, resource = nil)
-    decorator.from_hal(payload, resource)
-  end
+  include HALDecorator::Attributes
+  include HALDecorator::Links
+  include HALDecorator::Curies
+  include HALDecorator::Embedded
+  include HALDecorator::Collection
+  include HALDecorator::SerializeHooks
+  include HALDecorator::Model
+  include HALDecorator::Serializer
+  include HALDecorator::Deserializer
 end

data.tar.gz.sig

@@ -1,2 +1 @@
-����wB�I8�������"t^�uc�=,���������Z�F�#�$L��*���%�e��k�†�X������ƥŪ��	�3���N�. V7�\���	F��ӏ�����P��jv#.n1H��l2@p��Y��$)4�I3��G��Q�d��>�|��*���$8h�}&5oO�Z��K������	*�ɐ�a?�*��=�P�[�:[�o
-���܊���̜�Ш������MVj#�TA�
+�^�^��YN܅�@�B�n@d�S�`���$� �"��&�&0f�H

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_decorator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -31,7 +31,7 @@ cert_chain:
   CNZdF8Vavp6xMQbPHZwqjaeZz2WRXYS7jyYSvCunjwa3OtvXtfbIEGEWE6IM+t9k
   H1g6Q+B6qk9O6g==
   -----END CERTIFICATE-----
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -130,6 +130,7 @@ files:
 - lib/hal_decorator/links.rb
 - lib/hal_decorator/model.rb
 - lib/hal_decorator/property.rb
+- lib/hal_decorator/serialize_hooks.rb
 - lib/hal_decorator/serializer.rb
 homepage: https://github.com/sammyhenningsson/hal_decorator
 licenses: