hal_presenter 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e7545934daa7962d7706b4e7bc60cb78c9cd75375f6ff32a09618229b3df767
-  data.tar.gz: 042d67754faeb73d9bac72067f478c9bf1ce62053e32eb380b9c37e8c22c8147
+  metadata.gz: 2fe4271a7912587144464a955caafd6d5391f34b6f2ed3a41f5daa5249a39eeb
+  data.tar.gz: c17ab721cbbd1ff37ae96fa921a3a3bb1d003f67943c13863058dfda60a42e4d
 SHA512:
-  metadata.gz: 89e17c89c666b5f284c69fa9c0d8bc114270e138c03942cdd0c5046220b97525e5e6ac24e3cbaeab176ac703cab96f9e7dd1df7a87e9597490bc52ccdc38b469
-  data.tar.gz: febb52acd4490e3527caa92bdb6b82b90701efe734f6474e5e4464786bf413c7ad9c8e84488bb17ec5241cecf60aae412bd68459b1a2a8a0f192b2077ca2f252
+  metadata.gz: b0d7657cdb1609fe0a9e9a072be80ef61b9f9b8df31750575d9cbe007fdef6f86668b4a4c84431c1b94e04165195704eaced191443b8eaa7a3d91909f8b5bcc8
+  data.tar.gz: 9dac165e3f659f3e36c7d1e3f3ec8af60cb74e93152f5f68361b1b13037157fac157d0b5a40e92a60425a2b6c686f2c46a47a43a5da001bbe3efb8d022a4de28

checksums.yaml.gz.sig

@@ -1,3 +1,3 @@
-=����:�fZ�f����3��J7���rS�`g���v"M��+��sfԏV�٢��E��ώ�&^�'�0�p�45զ�����r1hy�<J�����*t����x��(�G�"�+)G��aC�
^ {�]M
-U��)<=T�k,�bLc���+^Dm'9B�m�Ҋ4.|z9�zNfԦR_��~z�Юg�Υ#]y��˷*��]bod��dJ�k��lve�L
-9���GIMה;A%}~
+Sp�gLP@b��ܘ��Lb���šד��y������6��n��K��B}���`V0���3�F�X:���}���	�tT�a���ݷ<C����#��@�t<�";�#�
+PӦ���[@���ib	���z��1̢��>���L�
+������ئ�R������-nv;:L};���c�({f���ІXɲ�

data/lib/hal_presenter/attributes.rb

@@ -3,7 +3,7 @@ require 'hal_presenter/property'
 module HALPresenter
   module Attributes
     def attribute(*args, **kw_args, &block)
-      @_attributes ||= init_attributes
+      @_attributes ||= __init_attributes
       @_attributes = @_attributes.reject { |attr| attr.name == args.first }
       @_attributes << Property.new(*args, **kw_args, &block)
     end
@@ -11,16 +11,16 @@ module HALPresenter
     protected
 
     def attributes
-      @_attributes ||= init_attributes
+      @_attributes ||= __init_attributes
     end
 
     private
 
-    def init_attributes
+    def __init_attributes
       return [] unless Class === self
       return [] unless superclass.respond_to?(:attributes, true)
       superclass.attributes.each do |attr|
-        attr.change_scope(self)
+        attr.change_context(self)
       end
     end
   end

data/lib/hal_presenter/collection.rb

@@ -37,7 +37,7 @@ module HALPresenter
     protected
 
     def collection_properties
-      @_collection_properties ||= init_collection_params
+      @_collection_properties ||= __init_collection_params
     end
 
     def can_serialize_collection?
@@ -46,7 +46,7 @@ module HALPresenter
 
     private
 
-    def init_collection_params
+    def __init_collection_params
       return unless Class === self
       if superclass.respond_to?(:collection_properties, true)
         superclass.collection_properties

data/lib/hal_presenter/curies.rb

@@ -2,28 +2,41 @@ require 'hal_presenter/property'
 
 module HALPresenter
   module Curies
-    def curie(rel, value = nil, **kw_args, &block)
+    class Curie < HALPresenter::Property
+      def to_h(resource = nil, options = {})
+        href = value(resource, options)
+        return {} unless href
+
+        {
+          name: name,
+          href: HALPresenter.href(href),
+          templated: true
+        }
+      end
+    end
+
+    def curie(rel, value = nil, embed_depth: nil, &block)
       if value.nil? && !block_given?
         raise 'curie must be called with non nil value or be given a block'
       end
-      @_curies ||= init_curies
+      @_curies ||= __init_curies
       @_curies = @_curies.reject { |curie| curie.name == rel }
-      @_curies << Property.new(rel, value, **kw_args, &block)
+      @_curies << Curie.new(rel, value, embed_depth: embed_depth, &block)
     end
 
     protected
 
     def curies
-      @_curies ||= init_curies
+      @_curies ||= __init_curies
     end
 
     private
 
-    def init_curies
+    def __init_curies
       return [] unless Class === self
       return [] unless superclass.respond_to?(:curies, true)
       superclass.curies.each do |curie|
-        curie.change_scope(self)
+        curie.change_context(self)
       end
     end
   end

data/lib/hal_presenter/embedded.rb

@@ -12,7 +12,7 @@ module HALPresenter
     end
 
     def embed(*args, **kw_args, &block)
-      @_embedded ||= init_embedded
+      @_embedded ||= __init_embedded
       @_embedded = @_embedded.reject { |embed| embed.name == args.first }
       @_embedded << Embed.new(*args, **kw_args, &block)
     end
@@ -20,16 +20,16 @@ module HALPresenter
     protected
 
     def embedded
-      @_embedded ||= init_embedded
+      @_embedded ||= __init_embedded
     end
 
     private
 
-    def init_embedded
+    def __init_embedded
       return [] unless Class === self
       return [] unless superclass.respond_to?(:embedded, true)
       superclass.embedded.each do |embed|
-        embed.change_scope(self)
+        embed.change_context(self)
       end
     end
   end

data/lib/hal_presenter/lazy_evaluator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module HALPresenter
+  class LazyEvaluator
+    attr_reader :resource, :options
+    alias resources resource
+
+    def initialize(block)
+      @__context = eval 'self', block.binding
+      define_singleton_method(:evaluate_block, &block)
+    end
+
+    def update_context(context)
+      @__context = context
+    end
+
+    def evaluate(resource, options)
+      @resource = resource
+      @options = options || {}
+      evaluate_block
+    ensure
+      @resource = nil
+      @options = nil
+    end
+
+    private
+
+    attr_reader :__context
+
+    def method_missing(method, *args, &block)
+      return super unless __context.respond_to?(method)
+
+      define_singleton_method(method) do |*a, &b|
+        __context.public_send(method, *a, &b)
+      end
+
+      public_send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, _include_private = false)
+      __context.respond_to?(method) || super
+    end
+  end
+end

data/lib/hal_presenter/links.rb

@@ -15,39 +15,59 @@ module HALPresenter
   module Links
 
     class Link < HALPresenter::Property
-      attr_reader :http_method
-      def initialize(rel, value = nil, **kw_args, &block)
+      attr_reader :type, :deprecation, :profile, :title
+      attr_accessor :templated
+
+      def initialize(rel, value = nil, **kwargs, &block)
         if value.nil? && !block_given?
           raise 'link must be called with non nil value or be given a block'
         end
-        @http_method = kw_args.delete(:method) || kw_args.delete(:methods)
-        super(rel, value, **kw_args, &block)
+        @type =         kwargs[:type]
+        @deprecation =  kwargs[:deprecation]
+        @profile =      kwargs[:profile]
+        @title =        kwargs[:title]
+        super(rel, value, embed_depth: kwargs[:embed_depth], &block)
       end
 
       def rel
         name
       end
+
+      def to_h(resource = nil, options = {})
+        href = value(resource, options)
+        return {} unless href
+
+        hash = {href: HALPresenter.href(href)}.tap do |h|
+          h[:type] = type if type
+          h[:deprecation] = deprecation if deprecation
+          h[:profile] = profile if profile
+          h[:title] = title if title
+          h[:templated] = templated if templated
+        end
+
+        {rel => hash}
+      end
     end
 
-    def link(rel, value = nil, **kw_args, &block)
-      @_links ||= init_links
+    def link(rel, value = nil, **kwargs, &block)
+      @_links ||= __init_links
       @_links = @_links.reject { |link| link.rel == rel }
-      @_links << Link.new(rel, value, **kw_args, &block)
+      @_links << Link.new(rel, value, **kwargs, &block)
     end
 
     protected
 
     def links
-      @_links ||= init_links
+      @_links ||= __init_links
     end
 
     private
 
-    def init_links
+    def __init_links
       return [] unless Class === self
       return [] unless superclass.respond_to?(:links, true)
       superclass.links.each do |link|
-        link.change_scope(self)
+        link.change_context(self)
       end
     end
   end

data/lib/hal_presenter/policy.rb

@@ -8,12 +8,12 @@ module HALPresenter
     protected
 
     def policy_class
-      @_policy ||= init_policy
+      @_policy ||= __init_policy
     end
 
     private
 
-    def init_policy
+    def __init_policy
       return unless Class === self
       return unless superclass.respond_to?(:policy_class, true)
       superclass.policy_class

data/lib/hal_presenter/property.rb

@@ -1,58 +1,30 @@
+require 'hal_presenter/lazy_evaluator'
+
 module HALPresenter
   class Property
-    attr_reader :name, :resource, :embed_depth, :options
 
-    alias :resources :resource
+    attr_reader :name, :embed_depth
 
     def initialize(name, value = nil, embed_depth: nil, &block)
-      @name = name
+      @name = name.to_sym
       @value = value
       @embed_depth = embed_depth
-      @scope = nil
-      return unless block_given?
-      @scope = eval 'self', block.binding
-      define_singleton_method(:value_from_block, &block)
+      @lazy = block_given? && LazyEvaluator.new(block)
     end
 
-    def value(resource = nil, options = {})
-      @resource = resource
-      @options = options
-      if scope
-        value_from_block
+    def value(resource = nil, options = nil)
+      if @lazy
+        @lazy.evaluate(resource, options)
       elsif resource && @value.nil?
         resource.public_send(name) if resource.respond_to?(name)
       else
         @value
       end
-    ensure
-      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 }
-        return public_send(method, *args, &block)
-      end
-      super
-    end
-
-    def respond_to_missing?(method, include_private = false)
-      return true if scope&.respond_to? method
-      super
     end
 
-    private
-
-    attr_reader :scope
-
-    def reset
-      @resource = nil
-      @options = nil
+    def change_context(context)
+      return unless @lazy
+      @lazy.update_context(context)
     end
   end
 end

data/lib/hal_presenter/serialize_hooks.rb

@@ -27,12 +27,12 @@ module HALPresenter
     protected
 
     def post_serialize_hook
-      @_post_serialize_hook ||= init_post_serialize_hook
+      @_post_serialize_hook ||= __init_post_serialize_hook
     end
 
     private
 
-    def init_post_serialize_hook
+    def __init_post_serialize_hook
       return unless Class === self
       return unless superclass.respond_to?(:post_serialize_hook, true)
       superclass.post_serialize_hook

data/lib/hal_presenter/serializer.rb

@@ -26,6 +26,7 @@ module HALPresenter
     def to_hal(resource = nil, options = {})
       options[:_depth] ||= 0
       hash = to_hash(resource, options)
+      move_curies_to_top! hash
       JSON.generate(hash)
     end
 
@@ -38,6 +39,7 @@ module HALPresenter
       options[:paginate] = HALPresenter.paginate unless options.key? :paginate
       options[:_depth] ||= 0
       hash = to_collection_hash(resources, options)
+      move_curies_to_top! hash
       JSON.generate(hash)
     end
 
@@ -71,6 +73,7 @@ module HALPresenter
         serialized[:_embedded] = embedded[:_embedded] || {}
 
         # Embedded resources
+        options[:_depth] += 1
         serialized_resources = resources.map { |resource| to_hash(resource, options) }
         serialized[:_embedded].merge!({properties.name => serialized_resources })
       end
@@ -85,20 +88,47 @@ module HALPresenter
     end
 
     def serialize_curies(resource, policy, options)
-      _serialize_curies(curies, resource, policy, options)
+      _serialize_curies(curies, resource, options)
     end
 
     def serialize_embedded(resource, policy, options)
       _serialize_embedded(embedded, resource, policy, options)
     end
 
+    private
+
+    def move_curies_to_top!(hash)
+      curies = {}
+      find_curies(hash).each do |curie|
+        name = curie[:name]
+        curies[name] = curie
+      end
+
+      return if curies.empty?
+
+      hash[:_links] ||= {}
+      hash[:_links][:curies] = curies.values
+    end
+
+    def find_curies(hash)
+      return [] if Hash(hash).empty?
+
+      curies = hash[:_links].delete(:curies) if hash.key? :_links
+      curies ||= []
+
+      hash.fetch(:_embedded, {}).values.each do |embedded|
+        collection = embedded.is_a?(Array) ? embedded : [embedded]
+        collection.each { |resrc| curies += find_curies(resrc) }
+      end
+
+      curies
+    end
+
     def run_post_serialize_hook!(resource, options, serialized)
       hook = post_serialize_hook
       hook&.run(resource, options, serialized)
     end
 
-    private
-
     def _serialize_attributes(attributes, resource, policy, options)
       attributes.each_with_object({}) do |attribute, hash|
         next unless nested_depth_ok?(attribute, options[:_depth])
@@ -111,26 +141,19 @@ module HALPresenter
       serialized = links.each_with_object({}) do |link, hash|
         next unless nested_depth_ok?(link, options[:_depth])
         next if policy && !policy.link?(link.rel)
-        href = link.value(resource, options) or next
-        hash[link.rel] = { href: HALPresenter.href(href) }.tap do |s|
-          s[:method] = link.http_method if link.http_method
-        end
+        hash.merge! link.to_h(resource, options)
       end
-      curies = _serialize_curies(curies, resource, policy, options)
+      curies = _serialize_curies(curies, resource, options)
       serialized[:curies] = curies if curies.any?
       return {} if serialized.empty?
       { _links: serialized }
     end
 
-    def _serialize_curies(curies, resource, policy, options)
+    def _serialize_curies(curies, resource, options)
       curies.each_with_object([]) do |curie, array|
         next unless nested_depth_ok?(curie, options[:_depth])
-        href = curie.value(resource, options) or next
-        array << {
-          name: curie.name,
-          href: HALPresenter.href(href),
-          templated: true
-        }
+        hash = curie.to_h(resource, options)
+        array << hash unless hash.empty?
       end
     end
 
@@ -179,5 +202,3 @@ module HALPresenter
     end
   end
 end
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_presenter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -166,6 +166,7 @@ files:
 - lib/hal_presenter/curies.rb
 - lib/hal_presenter/deserializer.rb
 - lib/hal_presenter/embedded.rb
+- lib/hal_presenter/lazy_evaluator.rb
 - lib/hal_presenter/links.rb
 - lib/hal_presenter/model.rb
 - lib/hal_presenter/pagination.rb