hal_presenter 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87410b9fd22646e39f88be76f6643df56f195aaa1b5301a7e68a65b750bcf90f
-  data.tar.gz: 06f256252ca7d7db3529b5d065717fe2d382345f91c83bd68fc650bf6ed2c179
+  metadata.gz: 3c2260ced3e580fbed871cd6926b0d4429b8e3db3f79584bdbc5740561ef402f
+  data.tar.gz: f65027a7452a434c21bc266ecd862a2fce7a147a2fd7b73938fc6a577c425946
 SHA512:
-  metadata.gz: 4314d9b1e1428bfbbd5b969cc8501f28401eef04a3ab4857dccc4a03f7fb4835efe72530f15f1c529bf0b847b9aa6894cc84ded10712e7258c6a76d2731dc2ef
-  data.tar.gz: 295a1112d0e103bf536357d2f221191311c592fdc614bfd26b2bfbb350fa0cd7e25ff9ac3804d89ff2e22cd1b0b788e2a60d63577e8ce324b107a51fe72d125e
+  metadata.gz: 7fec5bb05a99d8db7439c8d84adf6803c4253d288dd7777235912a8f08b0de88639bb17e8d7fe53e3d1d78568e102422b5813c2e70e99f4a891ac4a86a296f3e
+  data.tar.gz: e4ce6d2d6ce31a4059b22ac7329dfb38e3324ba7b68c9e84183b5f03d8f5f779bc62114117056b96586f9c8d67c77c30928753c09d219ced9af9125a3987d529

checksums.yaml.gz.sig

@@ -1,4 +1,2 @@
-i'�{
-}֤.�Q�ovv��:M϶��h-b,;���Kg^T�5<���>�!�����lrnWEU���XPqTAu��f>��%�>��d���e6��J=�B��gj�����X��|
-����)A)�r�<]���kk1p#���0��H2(4���8��
Z0%��	;����C���F
-��n�\���^�3���ք�:b�J~F7�D�p���w�Vŏ���N����+Q��FbJ
+(r��8��Q?YT3H����v�8JG��ޭ"�zU�íӖ=��k�t٪�cI�����XyS5�6m(��V�z&ZޭE#�2����JS�(X����b��{F=w�x��lz_s���`
+]D�|�U=�xF)�L�1�2��8�g�),Qܳ#!˼	W��<������m�є

data/lib/hal_presenter/attributes.rb

@@ -2,10 +2,10 @@ require 'hal_presenter/property'
 
 module HALPresenter
   module Attributes
-    def attribute(*args, &block)
+    def attribute(*args, **kw_args, &block)
       @_attributes ||= init_attributes
       @_attributes = @_attributes.reject { |attr| attr.name == args.first }
-      @_attributes << Property.new(*args, &block)
+      @_attributes << Property.new(*args, **kw_args, &block)
     end
 
     protected

data/lib/hal_presenter/collection.rb

@@ -3,7 +3,7 @@ require 'hal_presenter/property'
 module HALPresenter
   module Collection
 
-    class CollectionParameters
+    class Properties
       include Attributes
       include Links
       include Curies
@@ -31,25 +31,25 @@ module HALPresenter
     end
 
     def collection(of:, &block)
-      @_parameters = CollectionParameters.new(of, self, &block)
+      @_collection_properties = Properties.new(of, self, &block)
     end
 
     protected
 
-    def collection_parameters
-      @_parameters ||= init_collection_params
+    def collection_properties
+      @_collection_properties ||= init_collection_params
     end
 
     def can_serialize_collection?
-      !collection_parameters.nil?
+      !collection_properties.nil?
     end
 
     private
 
     def init_collection_params
       return unless Class === self
-      if superclass.respond_to?(:collection_parameters, true)
-        superclass.collection_parameters
+      if superclass.respond_to?(:collection_properties, true)
+        superclass.collection_properties
       end
     end
   end

data/lib/hal_presenter/curies.rb

@@ -2,13 +2,13 @@ require 'hal_presenter/property'
 
 module HALPresenter
   module Curies
-    def curie(rel, value = nil, &block)
+    def curie(rel, value = nil, **kw_args, &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 << Property.new(rel, value, &block)
+      @_curies << Property.new(rel, value, **kw_args, &block)
     end
 
     protected

data/lib/hal_presenter/deserializer.rb

@@ -67,7 +67,7 @@ module HALPresenter
     end
 
     def deserialize_collection(hash, resource)
-      hash['_embedded'][collection_parameters.name].each do |resource_hash|
+      hash['_embedded'][collection_properties.name].each do |resource_hash|
         resource << from_hash(resource_hash, nil)
       end
     end
@@ -75,7 +75,7 @@ module HALPresenter
     private
 
     def deserialize_as_collection?(hash)
-      name = collection_parameters&.name
+      name = collection_properties&.name
       # return true/false (Hash#key? returns nil if not found..)
       name && hash['_embedded']&.key?(name) || false
     end

data/lib/hal_presenter/embedded.rb

@@ -5,16 +5,16 @@ module HALPresenter
     class Embed < HALPresenter::Property
       attr_reader :presenter_class
 
-      def initialize(name, value = nil, presenter_class: nil, decorator_class: nil, &block)
-        super(name, value, &block)
-        @presenter_class = presenter_class || decorator_class
+      def initialize(name, value = nil, **kw_args, &block)
+        @presenter_class = kw_args.delete(:presenter_class)
+        super(name, value, **kw_args, &block)
       end
     end
 
-    def embed(*args, &block)
+    def embed(*args, **kw_args, &block)
       @_embedded ||= init_embedded
       @_embedded = @_embedded.reject { |embed| embed.name == args.first }
-      @_embedded << Embed.new(*args, &block)
+      @_embedded << Embed.new(*args, **kw_args, &block)
     end
 
     protected

data/lib/hal_presenter/links.rb

@@ -16,12 +16,12 @@ module HALPresenter
 
     class Link < HALPresenter::Property
       attr_reader :http_method
-      def initialize(rel, value = nil, http_method: nil, &block)
+      def initialize(rel, value = nil, **kw_args, &block)
         if value.nil? && !block_given?
           raise 'link must be called with non nil value or be given a block'
         end
-        @http_method = http_method
-        super(rel, value, &block)
+        @http_method = kw_args.delete(:method) || kw_args.delete(:methods)
+        super(rel, value, **kw_args, &block)
       end
 
       def rel
@@ -29,10 +29,10 @@ module HALPresenter
       end
     end
 
-    def link(rel, value = nil, method: nil, methods: nil, &block)
+    def link(rel, value = nil, **kw_args, &block)
       @_links ||= init_links
       @_links = @_links.reject { |link| link.rel == rel }
-      @_links << Link.new(rel, value, http_method: method || methods, &block)
+      @_links << Link.new(rel, value, **kw_args, &block)
     end
 
     protected

data/lib/hal_presenter/property.rb

@@ -1,12 +1,13 @@
 module HALPresenter
   class Property
-    attr_reader :name, :resource, :options
+    attr_reader :name, :resource, :embed_depth, :options
 
     alias :resources :resource
 
-    def initialize(name, value = nil, &block)
+    def initialize(name, value = nil, embed_depth: nil, &block)
       @name = name
       @value = value
+      @embed_depth = embed_depth
       @scope = nil
       return unless block_given?
       @scope = eval 'self', block.binding

data/lib/hal_presenter/serializer.rb

@@ -24,6 +24,7 @@ module HALPresenter
     class Error < StandardError; end
 
     def to_hal(resource = nil, options = {})
+      options[:_depth] ||= 0
       hash = to_hash(resource, options)
       JSON.generate(hash)
     end
@@ -35,6 +36,7 @@ module HALPresenter
           "Add a 'collection' spec to the serializer or use another serializer"
       end
       options[:paginate] = HALPresenter.paginate unless options.key? :paginate
+      options[:_depth] ||= 0
       hash = to_collection_hash(resources, options)
       JSON.generate(hash)
     end
@@ -42,8 +44,7 @@ module HALPresenter
     protected
 
     def to_hash(resource, options)
-      policy = policy_class&.new(options[:current_user], resource, options)
-
+      policy = policy_for(resource, options)
       {}.tap do |serialized|
         serialized.merge! serialize_attributes(resource, policy, options)
         serialized.merge! serialize_links(resource, policy, options)
@@ -54,22 +55,24 @@ module HALPresenter
     end
 
     def to_collection_hash(resources, options)
-      policy = policy_class&.new(options[:current_user], nil, options)
-      parameters = collection_parameters
-      links = parameters.links
-      curies = parameters.curies
+      policy = policy_for(nil, options)
+      properties = collection_properties
+      attributes = properties.attributes
+      links = properties.links
+      curies = properties.curies
+      embedded = properties.embedded
       {}.tap do |serialized|
-        serialized.merge!  _serialize_attributes(parameters.attributes, resources, policy, options)
+        serialized.merge!  _serialize_attributes(attributes, resources, policy, options)
         serialized.merge! _serialize_links(links, curies, resources, policy, options)
         Pagination.paginate!(serialized, resources) if options[:paginate]
 
         # Embedded from collection block
-        embedded = _serialize_embedded(parameters.embedded, resources, policy, options)
+        embedded = _serialize_embedded(embedded, resources, policy, options)
         serialized[:_embedded] = embedded[:_embedded] || {}
 
         # Embedded resources
         serialized_resources = resources.map { |resource| to_hash(resource, options) }
-        serialized[:_embedded].merge!({parameters.name => serialized_resources })
+        serialized[:_embedded].merge!({properties.name => serialized_resources })
       end
     end
 
@@ -98,6 +101,7 @@ module HALPresenter
 
     def _serialize_attributes(attributes, resource, policy, options)
       attributes.each_with_object({}) do |attribute, hash|
+        next unless nested_depth_ok?(attribute, options[:_depth])
         next if policy && !policy.attribute?(attribute.name)
         hash[attribute.name] = attribute.value(resource, options)
       end
@@ -105,6 +109,7 @@ module HALPresenter
 
     def _serialize_links(links, curies, resource, policy, options)
       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|
@@ -119,6 +124,7 @@ module HALPresenter
 
     def _serialize_curies(curies, resource, policy, 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,
@@ -130,11 +136,13 @@ module HALPresenter
 
     def _serialize_embedded(embedded, object, policy, options)
       serialized = embedded.each_with_object({}) do |embed, hash|
+        next unless nested_depth_ok?(embed, options[:_depth])
         next if policy && !policy.embed?(embed.name)
         resource = embed.value(object, options) or next
         presenter = embed.presenter_class
+        options[:_depth] += 1
         hash[embed.name] = 
-          if resource.respond_to? :each
+          if resource.is_a? Array
             _serialize_embedded_collection(resource, presenter, options)
           else
             presenter ||= HALPresenter.lookup_presenter(resource).first
@@ -152,8 +160,7 @@ module HALPresenter
         raise Serializer::Error,
           "No presenter specified to handle serializing embedded #{clazz}"
       end
-      if presenter.respond_to?(:can_serialize_collection?, true) &&
-          presenter.can_serialize_collection?
+      if presenter.can_serialize_collection?
         presenter.to_collection_hash(resources, options)
       else
         resources.map do |resrc|
@@ -161,6 +168,15 @@ module HALPresenter
         end
       end
     end
+
+    def policy_for(resource, options)
+      policy = policy_class&.new(options[:current_user], resource, options)
+    end
+
+    def nested_depth_ok?(property, level)
+      return true unless embed_depth = property.embed_depth
+      level <= embed_depth
+    end
   end
 end
 

data/lib/hal_presenter.rb

@@ -22,12 +22,3 @@ module HALPresenter
   include HALPresenter::Deserializer
   include HALPresenter::Policy
 end
-
-# Keeping this module for backward compatibility!
-module HALDecorator
-  include HALPresenter
-
-  def self.method_missing(m, *args, &block)
-    HALPresenter.send(m, *args, &block)
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_presenter
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -10,107 +10,106 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRowGAYDVQQDDBFzYW1t
-  eS5oZW5uaW5nc3NvbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
-  LGQBGRYDY29tMB4XDTE3MDcwODE0MDUxOVoXDTE4MDcwODE0MDUxOVowSDEaMBgG
-  A1UEAwwRc2FtbXkuaGVubmluZ3Nzb24xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDET
-  MBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
-  ggEBAK+SDC1mfyhucJ6Va21rIHUGscEtQrdvyBqxFG1s2TgPMAv4RbqwdJVPa7kj
-  tbCzslADlUE1oru2C+rcJsMtVGX02ukMIPHT1OjTyy0/EMqLqSy3WeRI8APyDSxC
-  Vbe+h5BMf3zZnYfddR6AeG7ln09T1P/tX+9lTMc+I+DW1fUlQgY48CNUayvtJR61
-  svXvXMrhLhi29SQig1qmH6Zoe22/JgH+m2JksPndY5Ep3gqfDc6Imwu2vGvmGErJ
-  D63FB0XQ/wb4WVH4l7sHQSTfKDp8SImCt1xqNgIyjw578ZG2geGLoncuxgDrbQ/U
-  FIJ11lDZd4vLevMhnIxTSJpPr2cCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
-  DwQEAwIEsDAdBgNVHQ4EFgQUukjj1Cd2ea6IOHDLZe0ymzs2jWkwJgYDVR0RBB8w
-  HYEbc2FtbXkuaGVubmluZ3Nzb25AZ21haWwuY29tMCYGA1UdEgQfMB2BG3NhbW15
-  Lmhlbm5pbmdzc29uQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAGBReofO0
-  CDGI8uQNn/btde+zQBiCX0mONJMQ6An760MzOHMlWFi6VaVeeKmYj5xCpI2nWaJN
-  49ALW/v7GZ+JIW5YmbzWIuD8YfwHJYCFPoH0llzg3GCFCMxbYqI3nDtHX3dMxpOc
-  01A72okERe0ne/O5Z4Ym/fOECkyXr0fYondhDQcSuqxU22jsXs1ZjISN8IuHmVkA
-  GtGteOIqmA05lP+eCXGvyARGLg1GwZDTjnlH5OfpiT1Oy7Dghewi58Gn4/AlZ4bY
-  CNZdF8Vavp6xMQbPHZwqjaeZz2WRXYS7jyYSvCunjwa3OtvXtfbIEGEWE6IM+t9k
-  H1g6Q+B6qk9O6g==
+  MIIDXjCCAkagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFzYW1t
+  eS5oZW5uaW5nc3Nvbi9EQz1nbWFpbC9EQz1jb20wHhcNMTgwNzE2MTYzNTMzWhcN
+  MjAwNzE2MTYzNTMzWjAsMSowKAYDVQQDDCFzYW1teS5oZW5uaW5nc3Nvbi9EQz1n
+  bWFpbC9EQz1jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvkgwt
+  Zn8obnCelWttayB1BrHBLUK3b8gasRRtbNk4DzAL+EW6sHSVT2u5I7Wws7JQA5VB
+  NaK7tgvq3CbDLVRl9NrpDCDx09To08stPxDKi6kst1nkSPAD8g0sQlW3voeQTH98
+  2Z2H3XUegHhu5Z9PU9T/7V/vZUzHPiPg1tX1JUIGOPAjVGsr7SUetbL171zK4S4Y
+  tvUkIoNaph+maHttvyYB/ptiZLD53WORKd4Knw3OiJsLtrxr5hhKyQ+txQdF0P8G
+  +FlR+Je7B0Ek3yg6fEiJgrdcajYCMo8Oe/GRtoHhi6J3LsYA620P1BSCddZQ2XeL
+  y3rzIZyMU0iaT69nAgMBAAGjgYowgYcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFLpI49QndnmuiDhwy2XtMps7No1pMCYGA1UdEQQfMB2BG3NhbW15
+  Lmhlbm5pbmdzc29uQGdtYWlsLmNvbTAmBgNVHRIEHzAdgRtzYW1teS5oZW5uaW5n
+  c3NvbkBnbWFpbC5jb20wDQYJKoZIhvcNAQELBQADggEBAFJZqH6sgeiTLvMLpxaK
+  K1GaYSCyZbMutf5C3tIAgkmU5UD6B8R0bw6gTM1deM5NJ60LjzqY7rlK3YKDIbTn
+  iXMCe9vd4yE/jb5Zi8Wk//9n8CMG68dQpBvmcQ58/M4gTtgsx+lIgXuI5dPQMmRi
+  bhWQqqWqxT9X6njjfXFk4xn3z6mfFQNPAYqRVeTHUpXBQZPt+bYXRwHPFZGWkx4l
+  BnuuhYKt3CR7YIgvnsQWlTAcU1Ipdayj6UfYqUtlc6cF3CL96NOx7mgZXV8URFiX
+  ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
+  M40=
   -----END CERTIFICATE-----
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2019-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '9.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '9.0'
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
 - !ruby/object:Gem::Dependency
@@ -194,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: JSON HAL serializer