hal_decorator 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e8c82477966a527d6a2f9d51120641f2b6bb11
-  data.tar.gz: 8a4043e183c059f458c5495cb4eb287e7b3e6278
+  metadata.gz: 8343a995eb8b48575002dae6dd95cb7537403209
+  data.tar.gz: c1547111bfdec4083e4fdd4048eba42b32a79e8d
 SHA512:
-  metadata.gz: 674b6c85ae4dc3b1498bb0386d24903504aa7a026a2fc6592891c098117b08ba2f7c696ce26161ddf88009bed66c02e9d5dcfe18c74ead3a7d9f430515ce05d2
-  data.tar.gz: 5ad6702a98818ab1fde31b646cb77b766cc60688dfc5858bf3105a43cbcda1db6509d6f1d4506ff89f9fae18801f2d7464c1fc6e241c7be2a04dff5f39f4531d
+  metadata.gz: d168ffdf32bdb764797f3eb82b5145459976efeff5b8121a7485ea8eeea594b01439f9fc8270948d280e491c48361491f7da8a09e3a4f4e627a885fec59a2dc4
+  data.tar.gz: 7f5217f70e6ef567590d423987c1b07e94ae23cee953f629c0084ba2c02bbab1147139998bff8d538959e120c6bca63eaea9526b731adeb7189011eddb458824

data/lib/hal_decorator/policy/dsl.rb

@@ -0,0 +1,59 @@
+module HALDecorator
+  module Policy
+    module DSL
+
+      module ClassMethods
+        attr_reader :rules
+
+        def attribute(name, &block)
+          @rules ||= {}
+          @rules[:attributes] ||= {}
+          @rules[:attributes][name] = block
+        end
+
+        def link(rel, &block)
+          @rules ||= {}
+          @rules[:links] ||= {}
+          @rules[:links][rel] = block
+        end
+
+        def embed(name, &block)
+          @rules ||= {}
+          @rules[:embeds] ||= {}
+          @rules[:embeds][name] = block
+        end
+      end
+
+      def self.included(mod)
+        mod.extend(ClassMethods)
+      end
+
+      def initialize(current_user = nil, resource)
+        @current_user = current_user
+        @resource = resource
+      end
+
+      def attribute?(name)
+        run self.class.rules&.dig(:attributes, name)
+      end
+
+      def link?(rel)
+        run self.class.rules&.dig(:links, rel)
+      end
+
+      def embed?(name)
+        run self.class.rules&.dig(:embeds, name)
+      end
+
+      private
+
+      attr_reader :current_user, :resource
+
+      def run(block)
+        return false unless block && block.respond_to?(:call)
+        instance_eval(&block) && true || false
+      end
+
+    end
+  end
+end

data/lib/hal_decorator/policy.rb

@@ -0,0 +1,22 @@
+module HALDecorator
+  module Policy
+
+    def policy(clazz)
+      @_policy = clazz
+    end
+
+    protected
+
+    def policy_class
+      @_policy ||= init_policy
+    end
+
+    private
+
+    def init_policy
+      return unless is_a? Class
+      return unless superclass.respond_to?(:policy_class, true)
+      superclass.policy_class
+    end
+  end
+end

data/lib/hal_decorator/serializer.rb

@@ -36,8 +36,8 @@ module HALDecorator
       end
       links = parameters.links
       curies = parameters.curies
-      serialized = _serialize_attributes(parameters.attributes, resources, options)
-      serialized.merge! _serialize_links(links, curies, resources, options)
+      serialized = _serialize_attributes(parameters.attributes, resources, nil, options)
+      serialized.merge! _serialize_links(links, curies, resources, nil, options)
 
       serialized_resources = resources.map { |resource| to_hash(resource, options) }
       serialized[:_embedded] = { parameters.name => serialized_resources }
@@ -47,29 +47,31 @@ module HALDecorator
     protected
 
     def to_hash(resource, options)
+      policy = policy_class&.new(options[:current_user], resource)
+
       {}.tap do |serialized|
-        serialized.merge! serialize_attributes(resource, options)
-        serialized.merge! serialize_links(resource, options)
-        serialized.merge! serialize_embedded(resource, options)
+        serialized.merge! serialize_attributes(resource, policy, options)
+        serialized.merge! serialize_links(resource, policy, options)
+        serialized.merge! serialize_embedded(resource, policy, options)
 
         run_post_serialize_hook!(resource, options, serialized)
       end
     end
 
-    def serialize_attributes(resource, options)
-      _serialize_attributes(attributes, resource, options)
+    def serialize_attributes(resource, policy, options)
+      _serialize_attributes(attributes, resource, policy, options)
     end
 
-    def serialize_links(resource, options)
-      _serialize_links(links, curies, resource, options)
+    def serialize_links(resource, policy, options)
+      _serialize_links(links, curies, resource, policy, options)
     end
 
-    def serialize_curies(resource, options)
-      _serialize_curies(curies, resource, options)
+    def serialize_curies(resource, policy, options)
+      _serialize_curies(curies, resource, policy, options)
     end
 
-    def serialize_embedded(resource, options)
-      _serialize_embedded(embedded, resource, options)
+    def serialize_embedded(resource, policy, options)
+      _serialize_embedded(embedded, resource, policy, options)
     end
 
     def run_post_serialize_hook!(resource, options, serialized)
@@ -79,27 +81,30 @@ module HALDecorator
 
     private
 
-    def _serialize_attributes(attributes, resource, options)
+    def _serialize_attributes(attributes, resource, policy, options)
       attributes.each_with_object({}) do |attribute, hash|
+        next if policy && !policy.attribute?(attribute.name)
         hash[attribute.name] = attribute.value(resource, options)
       end
     end
 
-    def _serialize_links(links, curies, resource, options)
+    def _serialize_links(links, curies, resource, policy, options)
       serialized = links.each_with_object({}) do |link, hash|
+        next if policy && !policy.link?(link.rel)
         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, resource, options)
+      curies = _serialize_curies(curies, resource, policy, options)
       serialized[:curies] = curies if curies.any?
       return {} if serialized.empty?
       { _links: serialized }
     end
 
-    def _serialize_curies(curies, resource, options)
+    def _serialize_curies(curies, resource, policy, options)
       curies.each_with_object([]) do |curie, array|
+        next if policy && !policy.link?(curie.name)
         href = curie.value(resource, options) or next
         array << {
           name: curie.name,
@@ -109,8 +114,9 @@ module HALDecorator
       end
     end
 
-    def _serialize_embedded(embedded, object, options)
+    def _serialize_embedded(embedded, object, policy, options)
       serialized = embedded.each_with_object({}) do |embed, hash|
+        next if policy && !policy.embed?(embed.name)
         resource = embed.value(object, options) or next
         decorator = embed.decorator_class
         hash[embed.name] = 

data/lib/hal_decorator.rb

@@ -1,8 +1,10 @@
+require 'hal_decorator/model'
+require 'hal_decorator/policy'
+require 'hal_decorator/policy/dsl'
 require 'hal_decorator/attributes'
-require 'hal_decorator/embedded'
 require 'hal_decorator/links'
+require 'hal_decorator/embedded'
 require 'hal_decorator/curies'
-require 'hal_decorator/model'
 require 'hal_decorator/serializer'
 require 'hal_decorator/deserializer'
 require 'hal_decorator/collection'
@@ -18,4 +20,5 @@ module HALDecorator
   include HALDecorator::Model
   include HALDecorator::Serializer
   include HALDecorator::Deserializer
+  include HALDecorator::Policy
 end

data.tar.gz.sig

@@ -1 +1 @@
-�^�^��YN܅�@�B�n@d�S�`���$� �"��&�&0f�H
+
�Bpo:r�����(1�a���)����iD�#���_ȍ>S�]�<5P�<���23��US�VZ���13oԔ�˾��%��E�g�Q괸H����Dcq�P_�Eֈȵ>�.Y��+��'�S����k)���+���v��Q�i2�ӖQ|��b�fG�Փ.��P��9Wx7� ��Ʉ����=�+���DŇ�[�����	twm›,������8���-������甋4��e�[Lś�z�νѨ֬(q.c

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_decorator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -31,7 +31,7 @@ cert_chain:
   CNZdF8Vavp6xMQbPHZwqjaeZz2WRXYS7jyYSvCunjwa3OtvXtfbIEGEWE6IM+t9k
   H1g6Q+B6qk9O6g==
   -----END CERTIFICATE-----
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,7 +114,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '9.0'
 description: |
-  Serialize resources according to
+  A DSL for serializing resources according to
   HypertextApplicationLanguage.
 email: sammy.henningsson@gmail.com
 executables: []
@@ -129,6 +129,8 @@ files:
 - lib/hal_decorator/embedded.rb
 - lib/hal_decorator/links.rb
 - lib/hal_decorator/model.rb
+- lib/hal_decorator/policy.rb
+- lib/hal_decorator/policy/dsl.rb
 - lib/hal_decorator/property.rb
 - lib/hal_decorator/serialize_hooks.rb
 - lib/hal_decorator/serializer.rb
@@ -152,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: HAL serializer