shaf 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '028cf2f2137e5f2e08115766a8e7b53e4213005fbc6677a15aa6d86dbe430f80'
-  data.tar.gz: 61b109326927ecb8a74811fd418b3bd8b2124a96820786be90dbcc9d43d578bf
+  metadata.gz: bd5e02da6f878d5f9e0ef2e4d3adb641e9ea34362c943cff5a9e94d93ffaad26
+  data.tar.gz: 565dd3872f4b46a48955b94ebbb6324472ec6293bf1f7ead551a55fdc5bd4d4a
 SHA512:
-  metadata.gz: 5da2756d178e7521539c8cc43a8661671434f1ccab7b0c8881905643155cf72eef5569e2d82d7a7c8a89b33e82607f106192c2a882c0c55bd6fab00dd2910ab6
-  data.tar.gz: b9859646533cf4b293e2f6a715f0309619b7ed280ba312cb0cdd6207b9b29e007ae0f5a5629575f929fe7f08ab47a94ad8a063ef0749b70d668102718c5abe71
+  metadata.gz: 129bf19d6c7ff6ff0f1df840078fbba5df8e47045e69a5b3a3e40ebdc2680f46ad36dc3c4660f8dd8ba5187368fa3b0ecdb503b0575def9f1403ed0d6e743935
+  data.tar.gz: c4fa82f52be8f910f40cebe13b0c5df52239a780788d7d083bc6f969cbfb02c9d72a4aa1fa1e2dce6cc23013be92e9d0eaacc849beaf9e05decacc34ccb9ed3d

data.tar.gz.sig

@@ -1 +1,2 @@
-��������E�r
�¬ѫ
�麲!�X\���(o�Oۏ�u:}$l�t
�K��A�k�!s�e�*31�4��4��>g֣mڪ�0i}d��C|��2I��vZ(�B-�:Y�?���|~�<����u�� $�}��l=��E�T����u�����D	�*D�31Tpy~�t"6"���Z�O~L%V!X�c4P>ڧ7�Uz�_��>T���_t&O"���)(I�c���:I��Tv}��Ԗ��{0�
+�u�
+�� %5,2kc����S�Py�S��I�����

data/lib/shaf/helpers/json_html.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module Shaf
   module JsonHtml
+    STRUCTURAL_PATTERN = /^[\[\]\{\}:,]$/.freeze
 
     def json2html(json)
       as_html JSON.parse(json)
@@ -18,7 +21,7 @@ module Shaf
       when Hash
         html_hash(obj, indent, pre_indent)
       else
-        html_scalar(obj, indent, pre_indent)
+        html_scalar(obj, pre_indent)
       end
     end
 
@@ -28,41 +31,78 @@ module Shaf
       end
 
       <<~EOS.chomp
-        #{pre_indent}<span>[</span>
-        #{array_of_strings.join(",\n")}
-        #{indentation(indent)}<span>]</span>
+        #{pre_indent}#{span '['}
+        #{array_of_strings.join(item_separator)}
+        #{indentation(indent)}#{span ']'}
       EOS
     end
 
     def html_hash(h, indent, pre_indent)
       <<~EOS.chomp
-        #{pre_indent}<span>{</span>
-        #{h.map { |k,v| sub_hash(k,v, indent + 1) }.join(",\n")},
-        #{indentation(indent)}<span>}</span>
+        #{pre_indent}#{span '{'}
+        #{h.map { |k,v| sub_hash(k,v, indent + 1) }.join(item_separator)}#{item_separator}
+        #{indentation(indent)}#{span '}'}
       EOS
     end
 
-    def html_scalar(s, indent, pre_indent)
-      q = around(s)
-      format "%s%s%s%s", pre_indent, q, s, q
+    def html_scalar(s, pre_indent)
+      format '%s%s', pre_indent, span(s)
     end
 
     def sub_hash(key, value, indent)
-      if key == 'href'
-        %Q(#{indentation(indent)}"#{key}"<span>:</span> <a href="#{value}">#{value}</a>)
-      else
-        "#{indentation(indent)}\"#{key}\"<span>:</span> #{to_html(value, indent: indent) }"
-      end
+	  left_side = format '%s%s%s ', indentation(indent), quoted(key), span(':')
+      left_side +
+        if key.to_s == 'href'
+          link(value)
+        else
+          to_html(value, indent: indent)
+        end
     end
 
     def indentation(i)
       "  " * i
     end
 
-    def around(obj)
-      return '"' if obj.is_a? String
-      ""
+    def quoted(obj)
+      case obj
+      when STRUCTURAL_PATTERN
+        obj
+      when String, Symbol
+        format '"%s"', obj
+      when NilClass
+        'null'
+      else
+        obj
+      end
+    end
+
+    def link(href)
+      format '<a href="%s">%s</a>', href, quoted(href)
     end
 
+    def span(value)
+      clazz = span_class(value)
+      value = quoted(value)
+      format '<span class="%s">%s</span>', clazz, value
+    end
+
+    def span_class(obj)
+      case obj
+      when TrueClass, FalseClass
+        'boolean'
+      when NilClass
+        'null'
+      when Numeric
+        'number'
+      when STRUCTURAL_PATTERN
+        'structural'
+      else
+        'string'
+      end
+    end
+
+    def item_separator
+      "#{span ','}\n"
+    end
   end
 end

data/lib/shaf/helpers/payload.rb

@@ -6,6 +6,7 @@ require 'shaf/responder'
 module Shaf
   module Payload
     EXCLUDED_FORM_PARAMS = ['captures', 'splat'].freeze
+    NO_VALUE = Object.new.freeze
 
     private
 
@@ -61,8 +62,8 @@ module Shaf
       name == '_method'
     end
 
-    def profile(value = nil)
-      return @profile unless value
+    def profile(value = NO_VALUE)
+      return @profile if value == NO_VALUE
       @profile = value
     end
 
@@ -81,15 +82,13 @@ module Shaf
       status ||= resource.respond_to?(:http_status) ? resource.http_status : 200
       status(status)
 
-      kwargs.merge!(
-        profile: profile,
-        serializer: serializer,
-        collection: collection
-      )
+      kwargs.merge!(serializer: serializer, collection: collection)
+      kwargs[:profile] ||= profile
 
       log.info "#{request.request_method} #{request.path_info} => #{status}"
       payload = Responder.for(request, resource).call(self, resource, preload: preload, **kwargs)
       add_cache_headers(payload, kwargs)
+
       payload
     rescue StandardError => err
       log.error "Failure: #{err.message}\n#{err.backtrace}"
@@ -103,10 +102,16 @@ module Shaf
 
     def add_cache_headers(payload, kwargs)
       return unless kwargs.delete(:http_cache) { Settings.http_cache }
+
+      chksum, kind = etag_for(payload)
+      etag(chksum, kind: kind) if chksum
+    end
+
+    def etag_for(payload)
       return if payload.nil? || payload.empty?
 
       sha1 = Digest::SHA1.hexdigest payload
-      etag sha1, :weak # Weak or Strong??
+     [sha1, :weak] # Weak or Strong??
     end
   end
 end

data/lib/shaf/responder/hal.rb

@@ -9,7 +9,7 @@ module Shaf
       mime_type :hal, 'application/hal+json'
 
       def body
-        @body ||= JSON.generate(serialized_hash)
+        @body ||= generate_json
       end
 
       private
@@ -19,12 +19,6 @@ module Shaf
         type = "#{type};profile=#{profile}" if profile
         type
       end
-
-      def profile
-        return unless serializer
-
-        @profile ||= options[:profile] || serializer.semantic_profile
-      end
     end
   end
 end

data/lib/shaf/responder/hal_serializable.rb

@@ -6,9 +6,7 @@ module Shaf
     module HalSerializable
       def lookup_rel(rel, response)
         hal = response.serialized_hash
-        return [] unless hal
-
-        links = hal.dig(:_links, rel.to_sym)
+        links = hal&.dig(:_links, rel.to_sym)
         return [] unless links
 
         links = [links] unless links.is_a? Array
@@ -49,6 +47,18 @@ module Shaf
 
         @serialized_hash
       end
+
+      def profile
+        @profile ||= options[:profile]
+        return unless @profile || serializer
+
+        @profile ||= serializer.semantic_profile
+      end
+
+      def generate_json
+        # FIXME: change to Oj??
+        JSON.generate(serialized_hash)
+      end
     end
   end
 end

data/lib/shaf/responder/html.rb

@@ -8,12 +8,41 @@ module Shaf
       mime_type :html
 
       def body
-        case resource
-        when Formable::Form
-          controller.erb(:form, locals: {form: resource, serialized: serialized_hash})
-        else
-          controller.erb(:payload, locals: {serialized: serialized_hash})
-        end
+        locals = variables
+
+        template =
+          case resource
+          when Formable::Form
+            locals.merge!(form: resource)
+            :form
+          else
+            :payload
+          end
+
+        controller.erb(template, locals: locals)
+      end
+
+      def variables
+        {
+          request_headers: request_headers,
+          response_headers: response_headers,
+          serialized: serialized_hash
+        }
+      end
+
+      def request_headers
+        controller.request_headers
+      end
+
+      def response_headers
+        etag, kind = controller.send(:etag_for, generate_json)
+        prefix = kind == :weak ? 'W/' : ''
+        etag = %Q{#{prefix}"#{etag}"}
+
+        type = Hal.mime_type
+        type = "#{type};profile=#{profile}" if profile
+
+        controller.headers.merge('Content-Type' => type, 'ETag' => etag)
       end
     end
   end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/templates/frontend/assets/css/main.css

@@ -16,10 +16,18 @@ ul {
   list-style-type: none;
 }
 
+td {
+  min-width: 20em;
+}
+
 pre {
   margin: 0;
 }
 
+main {
+  padding-bottom: 8em;
+}
+
 .container {
   display: flex;
   flex-direction: row;
@@ -33,6 +41,10 @@ pre {
   height: 100%;
 }
 
+.headers {
+  margin-bottom: 2em;
+}
+
 .hal-form {
   height: auto;
   display: flex;
@@ -60,11 +72,31 @@ pre {
   min-height: 100%;
   height: auto;
   overflow: auto;
-  background-color: #b5aeae;
+  background-color: #e0e0e0;
   display: flex;
   flex-direction: row;
   justify-content: flex-start;
   align-items: flex-start;
   padding: 1em;
+  border-radius: 20px;
+}
+
+span.boolean {
+  color: #0277BD;
 }
 
+span.null {
+  color: #757575;
+}
+
+span.number {
+  color: #3F51B5;
+}
+
+span.structural {
+  color: black;
+}
+
+span.string {
+  color: #43A047;
+}

data/templates/frontend/views/headers.erb

@@ -0,0 +1,20 @@
+<div class="container">
+  <section class="section headers">
+    <h3><%= title %></h3>
+    <table class="hal-payload">
+      <% headers.each do |key, value| %>
+        <tr>
+          <td><%= key %></td>
+          <td><%= value %></td>
+        </tr>
+      <% end %>
+    </table>
+    <ul>
+    <% notes.each do |note| %>
+      <li>
+        <p><sub><%= note %></sub></p>
+      </li>
+    <% end %>
+    </ul>
+  </section>
+</div>

data/templates/frontend/views/layout.erb

@@ -6,6 +6,12 @@
     <link rel="stylesheet" type="text/css" href="/css/main.css">
   </head>
   <body>
-    <%= yield %>
+    <div class="main-container">
+      <main>
+        <%= yield %>
+      </main>
+      <%= erb :headers, locals: {title: 'Request headers', headers: request_headers, notes: []} %>
+      <%= erb :headers, locals: {title: 'Response headers', headers: response_headers, notes: ["This is an example of a response to a request with Accept: #{response_headers['Content-Type']}. YMMV"]} %>
+    </div>
   </body>
 </html>

data/templates/frontend/views/payload.erb

@@ -1,6 +1,7 @@
 <% @page_title = "HAL payload" %>
 <div class="container">
   <section class="section">
+    <h3>Response</h3>
     <div class="hal-payload">
       <%= as_html(serialized) %>
     </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2020-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -328,6 +328,7 @@ files:
 - templates/config/settings.yml
 - templates/frontend/assets/css/main.css
 - templates/frontend/views/form.erb
+- templates/frontend/views/headers.erb
 - templates/frontend/views/layout.erb
 - templates/frontend/views/payload.erb
 - templates/spec/integration/root_spec.rb
@@ -345,6 +346,7 @@ files:
 - upgrades/1.3.0.tar.gz
 - upgrades/1.4.0.tar.gz
 - upgrades/1.5.0.tar.gz
+- upgrades/1.6.0.tar.gz
 homepage: 
 licenses:
 - MIT