hal_presenter 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12895524e08462462b15f197216f20f3fd24a53e7e6a60e7c5876639cd72dba5
-  data.tar.gz: b74e9c2084b7652447ee5bf90a56212fd5fc3829ee0e7a842187889b71ded750
+  metadata.gz: 10e6de4d852aa101cc4318eb88d152996adeb2e288359a0c9a53f6efcc5e9cc6
+  data.tar.gz: 89080e06a6c5a756bc00d9620663fb8e6eb97906059285666d13f007a4e6b4fa
 SHA512:
-  metadata.gz: c6f920f2d359fba3dd088f217dd94b7ecce8a5023a2f59ddf5daf3be012f81205663f6be10263ba7d67435a6c220f6904aa121fc13381eeda1d890444ada3ee2
-  data.tar.gz: '08041d1884286f31bfd1e2b14014b518ec2979081c222703f435b0b26c83d13c53f630cd9da4593c4e6be5b14af60289e0e66d7ac8e50e40a0783ad9aee664be'
+  metadata.gz: ab43657fea638457294930e648d5a33b2a6055ff02e511ba239d55b0b38bb8bad9ea6a3816b2c01674efa38c816876681af075dc5fc6ccb67ad1ebe44a891ae6
+  data.tar.gz: 84f44aa7ef856dbec2e23c56a1aceef04b35b253ebc1dd574c7379aa574f72b57d6b8e969e4a53eff8b7be5da54ecc23ca8d0411d87dbdb2f52a694bb7dcd8a7

data/lib/hal_presenter/curie_collection.rb

@@ -0,0 +1,158 @@
+require 'set'
+
+module HALPresenter
+  class CurieCollection
+    class CurieWithReferences
+      attr_reader :name, :href, :templated, :rels, :references
+
+      def initialize(curie)
+        @name = curie.fetch(:name)
+        @href = curie.fetch(:href)
+        @templated = curie.fetch(:templated, true)
+        @rels = Hash.new { |hash, key| hash[key] = Set.new }
+        @references = Hash.new do |hash, key|
+          hash[key] = Set.new.compare_by_identity
+        end
+      end
+
+      def add_reference(rel, reference, type)
+        rels[type] << rel
+        references[type] << reference
+      end
+
+      def <<(other)
+        other.rels.each do |type, rels|
+          self.rels[type] += rels
+        end
+        other.references.each do |type, references|
+          self.references[type] += references
+        end
+      end
+
+      def rename(name)
+        self.name = name
+
+        rels.each do |type, rels|
+          rels.each do |rel|
+            new_rel = replace_curie(name, rel)
+            references[type].each do |reference|
+              reference[new_rel] = reference.delete(rel)
+            end
+          end
+        end
+      end
+
+      def to_h
+        {
+          name: name,
+          href: href,
+          templated: templated
+        }
+      end
+
+      private
+
+      attr_writer :name
+
+      def replace_curie(name, rel)
+        _, rest = rel.to_s.split(':', 2)
+        :"#{name}:#{rest}"
+      end
+    end
+
+    attr_reader :collection
+
+    def self.extract_from!(hash, resolve_collisions: true)
+      new.tap do |curies|
+        curies.add_curies(hash[:_links]&.delete(:curies))
+        curies.send(:add_references, hash[:_links], :links)
+        curies.send(:add_references, hash[:_embedded], :embedded)
+        curies.resolve_collisions! if resolve_collisions
+      end
+    end
+
+    def initialize
+      @collection = []
+    end
+
+    def add_curies(curies)
+      return unless curies
+
+      curies.each do |curie|
+        next if find(curie[:name])
+        collection << CurieWithReferences.new(curie)
+      end
+    end
+
+    def generate_curie_name(base)
+      name = "#{base}0"
+      name = name.next while find(name.to_sym)
+      name.to_sym
+    end
+
+    def resolve_collisions!
+      collection.reverse_each do |curie|
+        next if collection.none? { |c| c.name == curie.name && c.href != curie.href }
+        new_name = generate_curie_name(curie.name)
+        curie.rename new_name
+      end
+
+      self
+    end
+
+    def to_a
+      collection.map(&:to_h)
+    end
+
+    def empty?
+      collection.empty?
+    end
+
+    def each
+      return collection.each unless block_given?
+      collection.each { |c| yield c }
+    end
+
+    private
+
+    def find(name, href = nil)
+      return unless name
+
+      collection.find do |c|
+        next unless c.name.to_sym == name.to_sym
+        href.nil? || c.href == href
+      end
+    end
+
+    def curie_from(rel)
+      parts = rel.to_s.split(':')
+      parts.first if parts.size > 1
+    end
+
+    def concat(other)
+      other.each do |curie|
+        if existing = find(curie.name, curie.href)
+          existing << curie
+        else
+          collection << curie
+        end
+      end
+    end
+
+    def add_references(reference, type)
+      return unless reference
+
+      reference.each do |rel, values|
+        curie_name = curie_from(rel)
+        curie = find(curie_name)
+        curie&.add_reference(rel, reference, type)
+
+        values = [values] if values.is_a? Hash
+        values.each do |value|
+          nested = self.class.extract_from!(value, resolve_collisions: false)
+          concat nested.collection
+        end
+      end
+    end
+  end
+end

data/lib/hal_presenter/deserializer.rb

@@ -1,15 +1,20 @@
 require 'json'
 
 module HALPresenter
-
-  def self.from_hal(presenter, payload, resource = nil)
-    presenter.from_hal(payload, resource)
+  module ClassMethods
+    def from_hal(presenter, payload, resource = nil)
+      presenter.from_hal(payload, resource)
+    end
   end
 
   module Deserializer
 
     class Error < StandardError; end
 
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
     def from_hal(payload, resource = nil)
       return if payload.nil? || payload.empty?
       hash = JSON.parse(payload)

data/lib/hal_presenter/links.rb

@@ -3,14 +3,16 @@ require 'hal_presenter/super_init'
 
 module HALPresenter
 
-  def self.base_href=(base)
-    @base_href = base&.sub(%r(/*$), '')
-  end
+  module ClassMethods
+    def 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
+    def href(href)
+      return href if (@base_href ||= '').empty?
+      return href if href =~ %r(\A(\w+://)?[^/])
+      @base_href + href
+    end
   end
 
   module Links
@@ -56,6 +58,10 @@ module HALPresenter
       end
     end
 
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
     def link(rel, value = nil, **kwargs, &block)
       if value.nil? && !block_given?
         raise 'link must be called with non nil value or be given a block'

data/lib/hal_presenter/model.rb

@@ -1,34 +1,40 @@
 module HALPresenter
   @presenters = {}
 
-  def self.register(model:, presenter:)
-    return unless presenter && model
-    @presenters[presenter] = model
-  end
+  module ClassMethods
+    def register(model:, presenter:)
+      return unless presenter && model
+      @presenters[presenter] = model
+    end
 
-  def self.unregister(presenter)
-    @presenters.delete_if { |d,_| d == presenter }
-  end
+    def unregister(presenter)
+      @presenters.delete_if { |d,_| d == presenter }
+    end
 
-  def self.lookup_model(presenter)
-    @presenters[presenter]
-  end
+    def lookup_model(presenter)
+      @presenters[presenter]
+    end
 
-  def self.lookup_presenter(model)
-    presenters = lookup_presenters(model)
-    return presenters.last unless presenters.empty?
-    lookup_presenters(model.first).last if model.respond_to? :first
-  end
+    def lookup_presenter(model)
+      presenters = lookup_presenters(model)
+      return presenters.last unless presenters.empty?
+      lookup_presenters(model.first).last if model.respond_to? :first
+    end
 
-  def self.lookup_presenters(model)
-    clazz = model.is_a?(Class) ? model : model.class
-    presenters = @presenters.select { |_d, m| m == clazz }.keys
-    return presenters unless presenters.empty?
-    return [] unless clazz < BasicObject
-    lookup_presenters(clazz.superclass)
+    def lookup_presenters(model)
+      clazz = model.is_a?(Class) ? model : model.class
+      presenters = @presenters.select { |_d, m| m == clazz }.keys
+      return presenters unless presenters.empty?
+      return [] unless clazz < BasicObject
+      lookup_presenters(clazz.superclass)
+    end
   end
 
   module Model
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
     def model(clazz)
       HALPresenter.register(model: clazz, presenter: self)
     end

data/lib/hal_presenter/pagination.rb

@@ -1,11 +1,12 @@
 module HALPresenter
-  class << self
+  module ClassMethods
     attr_accessor :paginate
   end
 
-  # TODO: Support Kaminari and Will_paginate
- 
   class Pagination
+    def self.included(base)
+      base.extend ClassMethods
+    end
 
     class Uri
       def self.parse(str)

data/lib/hal_presenter/serializer.rb

@@ -1,32 +1,42 @@
 require 'json'
 require 'hal_presenter/pagination'
+require 'hal_presenter/curie_collection'
 
 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)
-    raise Serializer::Error, "No presenter for #{resource.class}" unless presenter
-    presenter.to_hal(resource, options)
-  end
-
-  def self.to_collection(resources, options = {})
-    raise Serializer::Error, "resources is nil" if resources.nil?
-    presenter = options.delete(:presenter)
-    presenter ||= HALPresenter.lookup_presenter(resources)
-    raise Serializer::Error, "No presenter for #{resources.first.class}" unless presenter
-    presenter.to_collection(resources, options)
+  module ClassMethods
+	def to_hal(resource, options = {})
+	  raise Serializer::Error, "Resource is nil" if resource.nil?
+	  options = options.dup
+	  presenter = options.delete(:presenter)
+	  presenter ||= HALPresenter.lookup_presenter(resource)
+	  raise Serializer::Error, "No presenter for #{resource.class}" unless presenter
+	  presenter.to_hal(resource, options)
+	end
+
+	def to_collection(resources, options = {})
+	  raise Serializer::Error, "resources is nil" if resources.nil?
+	  options = options.dup
+	  presenter = options.delete(:presenter)
+	  presenter ||= HALPresenter.lookup_presenter(resources)
+	  raise Serializer::Error, "No presenter for #{resources.first.class}" unless presenter
+	  presenter.to_collection(resources, options)
+	end
   end
 
   module Serializer
 
     class Error < StandardError; end
 
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
     def to_hal(resource = nil, options = {})
+      options = options.dup
       options[:_depth] ||= 0
       hash = to_hash(resource, options)
-      move_curies_to_top! hash
+      move_curies_to_root! hash
       JSON.generate(hash)
     end
 
@@ -36,10 +46,11 @@ module HALPresenter
           "Trying to serialize a collection using #{self} which has no collection info. " \
           "Add a 'collection' spec to the serializer or use another serializer"
       end
+      options = options.dup
       options[:paginate] = HALPresenter.paginate unless options.key? :paginate
       options[:_depth] ||= 0
       hash = to_collection_hash(resources, options)
-      move_curies_to_top! hash
+      move_curies_to_root! hash
       JSON.generate(hash)
     end
 
@@ -72,8 +83,9 @@ module HALPresenter
         serialized.merge! _serialize_embedded(embedded, resources, policy, options)
 
         # Embedded resources
-        options[:_depth] += 1
-        serialized_resources = resources.map { |resource| to_hash(resource, options) }
+        embed_options = options.dup
+        embed_options[:_depth] += 1
+        serialized_resources = resources.map { |resource| to_hash(resource, embed_options) }
         serialized[:_embedded] ||= {}
         serialized[:_embedded].merge!(properties.name => serialized_resources)
       end
@@ -97,32 +109,16 @@ module HALPresenter
 
     private
 
-    def move_curies_to_top!(hash)
-      curies = {}
-      find_curies(hash).each do |curie|
-        name = curie[:name]
-        curies[name] = curie
-      end
+    def move_curies_to_root!(hash)
+      return if Hash(hash).empty?
 
-      return if curies.empty?
+      curie_collection = CurieCollection.extract_from!(hash)
+      return if curie_collection.empty?
 
       hash[:_links] ||= {}
-      hash[:_links][:curies] = curies.values
+      hash[:_links][:curies] = curie_collection.to_a
     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
@@ -163,13 +159,14 @@ module HALPresenter
         next if policy && !policy.embed?(embed.name)
         resource = embed.value(object, options) or next
         presenter = embed.presenter_class
-        options[:_depth] += 1
+        embed_options = options.dup
+        embed_options[:_depth] += 1
         hash[embed.name] = 
           if resource.is_a? Array
-            _serialize_embedded_collection(resource, presenter, options)
+            _serialize_embedded_collection(resource, presenter, embed_options)
           else
             presenter ||= HALPresenter.lookup_presenter(resource)
-            presenter.to_hash(resource, options)
+            presenter.to_hash(resource, embed_options)
           end
       end
       return {} if serialized.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_presenter
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-08-31 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -163,6 +163,7 @@ files:
 - lib/hal_presenter.rb
 - lib/hal_presenter/attributes.rb
 - lib/hal_presenter/collection.rb
+- lib/hal_presenter/curie_collection.rb
 - lib/hal_presenter/curies.rb
 - lib/hal_presenter/deserializer.rb
 - lib/hal_presenter/embedded.rb
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: JSON HAL serializer