hal_presenter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fe4271a7912587144464a955caafd6d5391f34b6f2ed3a41f5daa5249a39eeb
-  data.tar.gz: c17ab721cbbd1ff37ae96fa921a3a3bb1d003f67943c13863058dfda60a42e4d
+  metadata.gz: e1cae2dc6aea584c397b91fc95c485b1e53602184c51d20760c02c7b0c76ac2f
+  data.tar.gz: 7e0abe48f0337d05bea36e1fe62e2c451d18450b6044f1a5200754cb387e98a3
 SHA512:
-  metadata.gz: b0d7657cdb1609fe0a9e9a072be80ef61b9f9b8df31750575d9cbe007fdef6f86668b4a4c84431c1b94e04165195704eaced191443b8eaa7a3d91909f8b5bcc8
-  data.tar.gz: 9dac165e3f659f3e36c7d1e3f3ec8af60cb74e93152f5f68361b1b13037157fac157d0b5a40e92a60425a2b6c686f2c46a47a43a5da001bbe3efb8d022a4de28
+  metadata.gz: a1f9cdfc3286ee107dd3600e7621bc1c1d435bc04c4a181301214d41999a3ea3a142522e692a85c925950cee4e4c6bb6df7449b26f53efd3a24be6ed54fcbac1
+  data.tar.gz: f157c99026624748d91be20cf8fcf99d294a29c11f9d93e90b3ff50419e65e928256698d74c4bb50bcba956ed8e071879b2930eaa1719254c43c808cc392d86d

data/lib/hal_presenter.rb

@@ -9,6 +9,7 @@ require 'hal_presenter/serializer'
 require 'hal_presenter/deserializer'
 require 'hal_presenter/collection'
 require 'hal_presenter/serialize_hooks'
+require 'hal_presenter/namespace'
 
 module HALPresenter
   include HALPresenter::Attributes
@@ -21,4 +22,5 @@ module HALPresenter
   include HALPresenter::Serializer
   include HALPresenter::Deserializer
   include HALPresenter::Policy
+  include HALPresenter::Namespace
 end

data/lib/hal_presenter/attributes.rb

@@ -1,27 +1,22 @@
 require 'hal_presenter/property'
+require 'hal_presenter/super_init'
 
 module HALPresenter
   module Attributes
-    def attribute(*args, **kw_args, &block)
-      @_attributes ||= __init_attributes
-      @_attributes = @_attributes.reject { |attr| attr.name == args.first }
-      @_attributes << Property.new(*args, **kw_args, &block)
+    include SuperInit
+
+    def attribute(*args, **kwargs, &block)
+      kwargs[:context] ||= self
+      attributes.delete_if { |attr| attr.name == args.first }
+      Property.new(*args, **kwargs, &block).tap do |attr|
+        attributes << attr
+      end
     end
 
     protected
 
     def attributes
-      @_attributes ||= __init_attributes
-    end
-
-    private
-
-    def __init_attributes
-      return [] unless Class === self
-      return [] unless superclass.respond_to?(:attributes, true)
-      superclass.attributes.each do |attr|
-        attr.change_context(self)
-      end
+      @__attributes ||= __init_from_superclass(:attributes)
     end
   end
 end

data/lib/hal_presenter/collection.rb

@@ -1,7 +1,9 @@
 require 'hal_presenter/property'
+require 'hal_presenter/super_init'
 
 module HALPresenter
   module Collection
+    include SuperInit
 
     class Properties
       include Attributes
@@ -18,6 +20,33 @@ module HALPresenter
         instance_exec(&block)
       end
 
+      def attribute(*args, **kwargs, &block)
+        kwargs[:context] = scope
+        super
+      end
+
+      def link(rel, value = nil, **kwargs, &block)
+        kwargs[:context] = scope
+        super
+      end
+
+      def curie(rel, value = nil, **kwargs, &block)
+        kwargs[:context] = scope
+        super
+      end
+
+      def embed(*args, **kwargs, &block)
+        kwargs[:context] = scope
+        super
+      end
+
+      def change_context(context)
+        @scope = context
+        self
+      end
+
+      private
+
       def method_missing(method, *args, &block)
         return super unless scope&.respond_to? method
         define_singleton_method(method) { |*a, &b| scope.public_send method, *a, &b }
@@ -31,26 +60,17 @@ module HALPresenter
     end
 
     def collection(of:, &block)
-      @_collection_properties = Properties.new(of, self, &block)
+      @__collection_properties = Properties.new(of, self, &block)
     end
 
     protected
 
     def collection_properties
-      @_collection_properties ||= __init_collection_params
+      @__collection_properties ||= __init_from_superclass(:collection_properties, default: nil)
     end
 
     def can_serialize_collection?
       !collection_properties.nil?
     end
-
-    private
-
-    def __init_collection_params
-      return unless Class === self
-      if superclass.respond_to?(:collection_properties, true)
-        superclass.collection_properties
-      end
-    end
   end
 end

data/lib/hal_presenter/curies.rb

@@ -1,7 +1,10 @@
 require 'hal_presenter/property'
+require 'hal_presenter/super_init'
 
 module HALPresenter
   module Curies
+    include SuperInit
+
     class Curie < HALPresenter::Property
       def to_h(resource = nil, options = {})
         href = value(resource, options)
@@ -15,29 +18,22 @@ module HALPresenter
       end
     end
 
-    def curie(rel, value = nil, embed_depth: nil, &block)
+    def curie(rel, value = nil, **kwargs, &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 = @_curies.reject { |curie| curie.name == rel }
-      @_curies << Curie.new(rel, value, embed_depth: embed_depth, &block)
+
+      kwargs[:context] ||= self
+      curies.delete_if { |curie| curie.name == rel }
+      Curie.new(rel, value, **kwargs, &block).tap do |curie|
+        curies << curie
+      end
     end
 
     protected
 
     def curies
-      @_curies ||= __init_curies
-    end
-
-    private
-
-    def __init_curies
-      return [] unless Class === self
-      return [] unless superclass.respond_to?(:curies, true)
-      superclass.curies.each do |curie|
-        curie.change_context(self)
-      end
+      @_curies ||= __init_from_superclass(:curies)
     end
   end
 end

data/lib/hal_presenter/embedded.rb

@@ -1,36 +1,31 @@
 require 'hal_presenter/property'
+require 'hal_presenter/super_init'
 
 module HALPresenter
   module Embedded
+    include SuperInit
+
     class Embed < HALPresenter::Property
       attr_reader :presenter_class
 
-      def initialize(name, value = nil, **kw_args, &block)
-        @presenter_class = kw_args.delete(:presenter_class)
-        super(name, value, **kw_args, &block)
+      def initialize(name, value = nil, **kwargs, &block)
+        @presenter_class = kwargs.delete(:presenter_class)
+        super(name, value, **kwargs, &block)
       end
     end
 
-    def embed(*args, **kw_args, &block)
-      @_embedded ||= __init_embedded
-      @_embedded = @_embedded.reject { |embed| embed.name == args.first }
-      @_embedded << Embed.new(*args, **kw_args, &block)
+    def embed(*args, **kwargs, &block)
+      kwargs[:context] ||= self
+      embedded.delete_if { |embed| embed.name == args.first }
+      Embed.new(*args, **kwargs, &block).tap do |embed|
+        embedded << embed
+      end
     end
 
     protected
 
     def embedded
-      @_embedded ||= __init_embedded
-    end
-
-    private
-
-    def __init_embedded
-      return [] unless Class === self
-      return [] unless superclass.respond_to?(:embedded, true)
-      superclass.embedded.each do |embed|
-        embed.change_context(self)
-      end
+      @__embedded ||= __init_from_superclass(:embedded)
     end
   end
 end

data/lib/hal_presenter/lazy_evaluator.rb

@@ -5,13 +5,13 @@ module HALPresenter
     attr_reader :resource, :options
     alias resources resource
 
-    def initialize(block)
-      @__context = eval 'self', block.binding
+    def initialize(block, context)
+      @context = context
       define_singleton_method(:evaluate_block, &block)
     end
 
     def update_context(context)
-      @__context = context
+      @context = context
     end
 
     def evaluate(resource, options)
@@ -25,20 +25,20 @@ module HALPresenter
 
     private
 
-    attr_reader :__context
+    attr_reader :context
 
     def method_missing(method, *args, &block)
-      return super unless __context.respond_to?(method)
+      return super unless context.respond_to?(method)
 
       define_singleton_method(method) do |*a, &b|
-        __context.public_send(method, *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
+      context.respond_to?(method) || super
     end
   end
 end

data/lib/hal_presenter/links.rb

@@ -1,4 +1,5 @@
 require 'hal_presenter/property'
+require 'hal_presenter/super_init'
 
 module HALPresenter
 
@@ -13,24 +14,24 @@ module HALPresenter
   end
 
   module Links
+    include SuperInit
 
     class Link < HALPresenter::Property
       attr_reader :type, :deprecation, :profile, :title
       attr_accessor :templated
 
+      alias rel name
+
       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
-        @type =         kwargs[:type]
-        @deprecation =  kwargs[:deprecation]
-        @profile =      kwargs[:profile]
-        @title =        kwargs[:title]
-        super(rel, value, embed_depth: kwargs[:embed_depth], &block)
-      end
+        @type =         kwargs[:type].freeze
+        @deprecation =  kwargs[:deprecation].freeze
+        @profile =      kwargs[:profile].freeze
+        @title =        kwargs[:title].freeze
 
-      def rel
-        name
+        curie = kwargs[:curie].to_s
+        rel = [curie, rel.to_s].join(':') unless curie.empty?
+
+        super(rel, value, kwargs.slice(:embed_depth, :context), &block)
       end
 
       def to_h(resource = nil, options = {})
@@ -50,25 +51,21 @@ module HALPresenter
     end
 
     def link(rel, value = nil, **kwargs, &block)
-      @_links ||= __init_links
-      @_links = @_links.reject { |link| link.rel == rel }
-      @_links << Link.new(rel, value, **kwargs, &block)
+      if value.nil? && !block_given?
+        raise 'link must be called with non nil value or be given a block'
+      end
+
+      kwargs[:context] ||= self
+      links.delete_if { |link| link.rel == rel }
+      Link.new(rel, value, **kwargs, &block).tap do |link|
+        links << link
+      end
     end
 
     protected
 
     def links
-      @_links ||= __init_links
-    end
-
-    private
-
-    def __init_links
-      return [] unless Class === self
-      return [] unless superclass.respond_to?(:links, true)
-      superclass.links.each do |link|
-        link.change_context(self)
-      end
+      @__links ||= __init_from_superclass(:links)
     end
   end
 end

data/lib/hal_presenter/model.rb

@@ -2,6 +2,7 @@ module HALPresenter
   @presenters = {}
 
   def HALPresenter.register(model:, presenter:)
+    return unless presenter && model
     @presenters[presenter] = model
   end
 
@@ -14,10 +15,15 @@ module HALPresenter
   end
 
   def HALPresenter.lookup_presenter(model)
+    lookup_presenters(model).last
+  end
+
+  def HALPresenter.lookup_presenters(model)
     clazz = model.is_a?(Class) ? model : model.class
-    presenters = @presenters.select { |d, m| m == clazz }.keys.compact
+    presenters = @presenters.select { |_d, m| m == clazz }.keys
     return presenters unless presenters.empty?
-    lookup_presenter(clazz.superclass) unless clazz.superclass == BasicObject
+    return [] unless clazz < BasicObject
+    lookup_presenters(clazz.superclass)
   end
 
   module Model

data/lib/hal_presenter/namespace.rb

@@ -0,0 +1,41 @@
+module HALPresenter
+  module Namespace
+    class Executor
+      attr_reader :presenter, :curie
+
+      def initialize(presenter, curie)
+        @presenter = presenter
+        @curie = curie
+      end
+
+      def run(block)
+        instance_exec(&block) if block
+      end
+
+      private
+
+      def link(rel, value = nil, **kwargs, &block)
+        add_property(:link, rel, value, **kwargs, &block)
+      end
+
+      def embed(rel, value = nil, **kwargs, &block)
+        add_property(:embed, rel, value, **kwargs, &block)
+      end
+
+      def add_property(method, rel, value, **kwargs, &block)
+        rel = add_curie!(rel, kwargs)
+        kwargs[:context] = presenter
+        presenter.public_send(method, rel, value, **kwargs, &block)
+      end
+
+      def add_curie!(rel, kwargs)
+        ns = kwargs.delete(:curie) { curie }
+        "#{ns}:#{rel}"
+      end
+    end
+
+    def namespace(curie, &block)
+      Executor.new(self, curie).run(block)
+    end
+  end
+end

data/lib/hal_presenter/policy.rb

@@ -2,13 +2,13 @@ module HALPresenter
   module Policy
 
     def policy(clazz)
-      @_policy = clazz
+      @__policy = clazz
     end
 
     protected
 
     def policy_class
-      @_policy ||= __init_policy
+      @__policy ||= __init_policy
     end
 
     private

data/lib/hal_presenter/property.rb

@@ -2,29 +2,41 @@ require 'hal_presenter/lazy_evaluator'
 
 module HALPresenter
   class Property
-
     attr_reader :name, :embed_depth
 
-    def initialize(name, value = nil, embed_depth: nil, &block)
+    def initialize(name, value = nil, **kwargs, &block)
       @name = name.to_sym
-      @value = value
-      @embed_depth = embed_depth
-      @lazy = block_given? && LazyEvaluator.new(block)
+      @value = value.freeze
+      @embed_depth = kwargs[:embed_depth].freeze
+      @context = kwargs[:context]
+      @lazy = block_given? ? LazyEvaluator.new(block, @context) : nil
     end
 
     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
+      elsif @value
         @value
+      elsif resource&.respond_to? name_without_curie
+        resource.public_send(name_without_curie)
       end
     end
 
     def change_context(context)
-      return unless @lazy
-      @lazy.update_context(context)
+      @context = context
+      @lazy.update_context(context) if @lazy
+      self
+    end
+
+    private
+
+    def initialize_copy(source)
+      @lazy = source.instance_variable_get(:@lazy).clone
+      super
+    end
+
+    def name_without_curie
+      @name_without_curie ||= name.to_s.split(':', 2).last
     end
   end
 end

data/lib/hal_presenter/serialize_hooks.rb

@@ -21,13 +21,13 @@ module HALPresenter
     end
 
     def post_serialize(&block)
-      @_post_serialize_hook = Hook.new(&block)
+      @__post_serialize_hook = Hook.new(&block)
     end
 
     protected
 
     def post_serialize_hook
-      @_post_serialize_hook ||= __init_post_serialize_hook
+      @__post_serialize_hook ||= __init_post_serialize_hook
     end
 
     private

data/lib/hal_presenter/serializer.rb

@@ -6,7 +6,7 @@ module HALPresenter
   def self.to_hal(resource, options = {})
     raise Serializer::Error, "Resource is nil" if resource.nil?
     presenter = options.delete(:presenter)
-    presenter ||= HALPresenter.lookup_presenter(resource)&.last
+    presenter ||= HALPresenter.lookup_presenter(resource)
     raise Serializer::Error, "No presenter for #{resource.class}" unless presenter
     presenter.to_hal(resource, options)
   end
@@ -14,7 +14,7 @@ module HALPresenter
   def self.to_collection(resources, options = {})
     raise Serializer::Error, "resources is nil" if resources.nil?
     presenter = options.delete(:presenter)
-    presenter ||= HALPresenter.lookup_presenter(resources.first)&.last
+    presenter ||= HALPresenter.lookup_presenter(resources.first)
     raise Serializer::Error, "No presenter for #{resources.first.class}" unless presenter
     presenter.to_collection(resources, options)
   end
@@ -69,13 +69,13 @@ module HALPresenter
         Pagination.paginate!(serialized, resources) if options[:paginate]
 
         # Embedded from collection block
-        embedded = _serialize_embedded(embedded, resources, policy, options)
-        serialized[:_embedded] = embedded[:_embedded] || {}
+        serialized.merge! _serialize_embedded(embedded, resources, policy, options)
 
         # Embedded resources
         options[:_depth] += 1
         serialized_resources = resources.map { |resource| to_hash(resource, options) }
-        serialized[:_embedded].merge!({properties.name => serialized_resources })
+        serialized[:_embedded] ||= {}
+        serialized[:_embedded].merge!(properties.name => serialized_resources)
       end
     end
 
@@ -168,7 +168,7 @@ module HALPresenter
           if resource.is_a? Array
             _serialize_embedded_collection(resource, presenter, options)
           else
-            presenter ||= HALPresenter.lookup_presenter(resource).first
+            presenter ||= HALPresenter.lookup_presenter(resource)
             presenter.to_hash(resource, options)
           end
       end
@@ -178,7 +178,7 @@ module HALPresenter
 
     def _serialize_embedded_collection(resources, presenter, options)
       clazz = resources.first.class
-      presenter ||= HALPresenter.lookup_presenter(clazz)&.first
+      presenter ||= HALPresenter.lookup_presenter(clazz)
       if presenter.nil?
         raise Serializer::Error,
           "No presenter specified to handle serializing embedded #{clazz}"

data/lib/hal_presenter/super_init.rb

@@ -0,0 +1,20 @@
+module HALPresenter
+  module SuperInit
+    private
+
+    def __init_from_superclass(method, default: [])
+      return default unless Class === self
+      return default unless superclass.respond_to?(method, true)
+
+      if default.respond_to? :each
+        superclass.send(method).map do |prop|
+          prop.clone.change_context(self)
+        end
+      else
+        prop = superclass.send(method)
+        return default unless prop
+        prop.clone.change_context(self)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_presenter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -169,12 +169,14 @@ files:
 - lib/hal_presenter/lazy_evaluator.rb
 - lib/hal_presenter/links.rb
 - lib/hal_presenter/model.rb
+- lib/hal_presenter/namespace.rb
 - lib/hal_presenter/pagination.rb
 - lib/hal_presenter/policy.rb
 - lib/hal_presenter/policy/dsl.rb
 - lib/hal_presenter/property.rb
 - lib/hal_presenter/serialize_hooks.rb
 - lib/hal_presenter/serializer.rb
+- lib/hal_presenter/super_init.rb
 homepage: https://github.com/sammyhenningsson/hal_presenter
 licenses:
 - MIT