hal_decorator 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a057aea9fde00c1fece1badea0112c09a0c0d92
-  data.tar.gz: b2d13e8db0031a61aeee53e1e4e25c3559f91e4c
+  metadata.gz: fd9ad6b7f80ed3d5d036ca4c7472b88e0b803989
+  data.tar.gz: 3977c9f47eab6816f2f7db9a2e37886ca6cee24a
 SHA512:
-  metadata.gz: 19f2b2cc25265859f03b6fabda3518cdafa0ea1177c28c879134100f09ccdcd053676d16b19ad1f5205ad0b07d10735c6f8200b9d8b3f43598625b989a3180e4
-  data.tar.gz: 98bfed67cd1a6d0b00e759d8506dfe83ebc853cedfc4a06ac9286899c93a90b111dc021a6260a9a5a35734cc2052c20e7355ec4360c4fb3e01d7687f52ab2008
+  metadata.gz: 422776e1d29392bf2f63d501cff3d68235d656c950e3964417e50ac6b333cb46e90eda5526c8048a0ebb363926c1e910b4a50941906662c44a03457ef6da20ac
+  data.tar.gz: 56aec582f8f8824cddbfc7d9d5db60baafb50c63f7c6c5a50d36e013726d9cff0c25865f09c3b0e21b1042db993de97ba4162acab0033ac930c87089608585f7

data/lib/hal_decorator/collection.rb

@@ -26,6 +26,10 @@ module HALDecorator
       @_parameters ||= init_collection_params
     end
 
+    def can_serialize_collection?
+      !collection_parameters.nil?
+    end
+
     private
 
     def init_collection_params

data/lib/hal_decorator/pagination.rb

@@ -0,0 +1,126 @@
+module HALDecorator
+  class << self
+    attr_accessor :paginate
+  end
+
+  # TODO: Support Kaminari and Will_paginate
+ 
+  class Pagination
+
+    class Uri
+      def self.parse(str)
+        uri = nil
+        query = nil
+        unless str.nil? || str.empty?
+          if m = str.match(%r(\A([^\?]+)\??([^\#]+)?.*\Z))
+            uri = m[1]
+            query = query_from_string m[2]
+          end
+        end
+        new(uri, query)
+      end
+
+      def self.query_from_string(str)
+        return {} if str.nil? || str.empty?
+        str.split('&').each_with_object({}) do |pair, q|
+          key_value = pair.split('=')
+          q[key_value[0]] = key_value[1];
+        end
+      end
+
+      def initialize(uri, query)
+        @uri = uri
+        @query = query
+      end
+
+      def +(query)
+        self.class.new(@uri, @query.merge(query))
+      end
+
+      def to_s
+        return if @uri.nil?
+        @uri.dup.tap do |uri|
+          next if @query.nil? || @query.empty?
+          uri << "?" + @query.map { |k,v| "#{k}=#{v}" }.join('&')
+        end
+      end
+    end
+
+    def self.paginate!(serialized, collection)
+      new(serialized, collection).call
+    end
+
+    def initialize(serialized, collection)
+      @serialized = serialized
+      @collection = collection
+      @self_uri = Uri.parse serialized.dig(:_links, :self, :href)
+    end
+
+    def call
+      return unless should_paginate?
+      add_query_to_self
+      add_prev_link
+      add_next_link
+    end
+
+    private
+
+    attr_accessor :serialized, :collection, :self_uri
+
+    def should_paginate?
+      self_uri && current_page
+    end
+
+    def query(page)
+      return {} unless page
+      {
+        page: page,
+        per_page: per_page,
+      }
+    end
+
+    def add_query_to_self
+      serialized[:_links][:self][:href] = (self_uri + query(current_page)).to_s
+    end
+
+    def add_prev_link
+      return if serialized[:_links][:prev] || !prev_page
+      serialized[:_links][:prev] = {
+        href: (self_uri + query(prev_page)).to_s
+      }
+    end
+
+    def add_next_link
+      return if serialized[:_links][:next] || !next_page
+      serialized[:_links][:next] = {
+        href: (self_uri + query(next_page)).to_s
+      }
+    end
+
+    # Supported by Sequel, Kaminari and will_paginate
+    def current_page
+      collection.respond_to?(:current_page) && collection.current_page
+    end
+
+    def prev_page
+      return collection.prev_page if collection.respond_to?(:prev_page) # Sequel and Kaminari
+      return collection.previous_page if collection.respond_to?(:previous_page) # will_paginate
+    end
+
+    # Supported by Sequel, Kaminari and will_paginate
+    def next_page
+      collection.respond_to?(:next_page) && collection.next_page
+    end
+
+    def per_page
+      if collection.respond_to?(:page_size)
+        collection.page_size # Supported by Sequel
+      elsif collection.respond_to?(:max_per_page)
+        collection.max_per_page # Supported by Kaminari
+      elsif collection.respond_to?(:per_page)
+        collection.per_page # Supported by will_paginate
+      end
+    end
+  end
+end
+

data/lib/hal_decorator/serializer.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'hal_decorator/pagination'
 
 module HALDecorator
 
@@ -28,20 +29,14 @@ module HALDecorator
     end
 
     def to_collection(resources = [], options = {})
-      parameters = collection_parameters
-      if parameters.nil?
+      unless can_serialize_collection?
         raise Error,
           "Trying to serialize a collection using #{self} which has no collection info. " \
           "Add a 'collection' spec to the serializer or use another serializer"
       end
-      links = parameters.links
-      curies = parameters.curies
-      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 }
-      JSON.generate(serialized)
+      options[:paginate] = HALDecorator.paginate unless options.key? :paginate
+      hash = to_collection_hash(resources, options)
+      JSON.generate(hash)
     end
 
     protected
@@ -58,6 +53,20 @@ module HALDecorator
       end
     end
 
+    def to_collection_hash(resources, options)
+      parameters = collection_parameters
+      links = parameters.links
+      curies = parameters.curies
+      {}.tap do |serialized|
+        serialized.merge!  _serialize_attributes(parameters.attributes, resources, nil, options)
+        serialized.merge! _serialize_links(links, curies, resources, nil, options)
+        Pagination.paginate!(serialized, resources) if options[:paginate]
+
+        serialized_resources = resources.map { |resource| to_hash(resource, options) }
+        serialized[:_embedded] = { parameters.name => serialized_resources }
+      end
+    end
+
     def serialize_attributes(resource, policy, options)
       _serialize_attributes(attributes, resource, policy, options)
     end
@@ -121,10 +130,7 @@ module HALDecorator
         decorator = embed.decorator_class
         hash[embed.name] = 
           if resource.respond_to? :each
-            decorator ||= HALDecorator.lookup_decorator(resource.first).first
-            resource.map do |resrc|
-              decorator.to_hash(resrc, options)
-            end
+            _serialize_embedded_collection(resource, decorator, options)
           else
             decorator ||= HALDecorator.lookup_decorator(resource).first
             decorator.to_hash(resource, options)
@@ -133,6 +139,23 @@ module HALDecorator
       return {} if serialized.empty?
       { _embedded: serialized }
     end
+
+    def _serialize_embedded_collection(resources, decorator, options)
+      clazz = resources.first.class
+      decorator ||= HALDecorator.lookup_decorator(clazz)&.first
+      if decorator.nil?
+        raise Serializer::Error,
+          "No decorator specified to handle serializing embedded #{clazz}"
+      end
+      if decorator.respond_to?(:can_serialize_collection?, true) &&
+          decorator.can_serialize_collection?
+        decorator.to_collection_hash(resources, options)
+      else
+        resources.map do |resrc|
+          decorator.to_hash(resrc, options)
+        end
+      end
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_decorator
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -31,7 +31,7 @@ cert_chain:
   CNZdF8Vavp6xMQbPHZwqjaeZz2WRXYS7jyYSvCunjwa3OtvXtfbIEGEWE6IM+t9k
   H1g6Q+B6qk9O6g==
   -----END CERTIFICATE-----
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,7 +59,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -69,7 +69,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -113,6 +113,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.6
 description: |
   A DSL for serializing resources according to
   HypertextApplicationLanguage.
@@ -129,6 +169,7 @@ files:
 - lib/hal_decorator/embedded.rb
 - lib/hal_decorator/links.rb
 - lib/hal_decorator/model.rb
+- lib/hal_decorator/pagination.rb
 - lib/hal_decorator/policy.rb
 - lib/hal_decorator/policy/dsl.rb
 - lib/hal_decorator/property.rb