shaf 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa31b5bc9a9cc80cc5b34c5a3f6101eb17ebf8166bd1a6ae46f0008709c3fa0f
-  data.tar.gz: d4fc21aa271c30bb3e52bbc65571917beb0b16029e7ee764fc8705a5d4197ca8
+  metadata.gz: c508aa7154d738ed2009c18256326f590917af8c24d60bfacfd5bb91613c4270
+  data.tar.gz: 49e9fec1c522764bb1a722623cfb49cf8de3d6d7e026355a09310a6099828711
 SHA512:
-  metadata.gz: 6820ebc741c7392a44a767d1be674394fb307c3e937997c0428dea3663fd57faa3ab9ff6700dedda76e522650373997413b4a5b256198d9646c4741a91ae33d7
-  data.tar.gz: 9315cdd74263a2ae7b39f8a5960267aff7b61c498e0d95ca00559f61a3756f53f84f62b946bb24d8d818d901133cc537ef4402a0b3e201ae34f52b201015f72c
+  metadata.gz: d1d2ddda76cb3e76470f4cbc0297e72ef3c3b9c6119a12d101d999a50bc0aab37a442067ddd0cb4fdd3e698d0446982e65d199e633e46d875175e087f3bc9a61
+  data.tar.gz: 3d2c97ed1362ac58addf9c282e37d8754adad5a994c421d72779e4576dd91c8cbd1bbfc67689d20bf51bc20410270f61752383d36b11eb9dcbe28883c6552440

data/lib/shaf/link_relations.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'tempfile'
+require 'uri'
+require 'csv'
+
+module Shaf
+  class LinkRelations
+    class LinkRelation
+      attr_reader :name, :description, :reference, :notes
+
+      def initialize(name, description, reference, notes)
+        @name = name.to_sym
+        @description = description.freeze
+        @reference = reference.freeze
+        @notes = notes.freeze
+      end
+    end
+
+    class << self
+      IANA_URL = URI('https://www.iana.org/assignments/link-relations/link-relations-1.csv')
+
+      def all
+        relations.values
+      end
+
+      def get(key)
+        load_iana
+        relations[key.to_sym]
+      end
+
+      def add(link_relation)
+        relations[link_relation.name.to_sym] = link_relation
+      end
+
+      private
+
+      def load_iana
+        return if @loaded
+
+        iana_csv.each do |name, desc, ref, notes|
+          next if name == 'Relation Name'
+          add LinkRelation.new(name, desc, ref, notes)
+        end
+
+        @loaded = true
+      end
+
+      def relations
+        @relations ||= {}
+      end
+
+      def tmp_file_name
+        File.join(Dir.tmpdir, 'shaf_iana_link_relations')
+      end
+
+      def iana_csv
+        CSV.new(iana_links)
+      end
+
+      def iana_links
+        return File.read(tmp_file_name) if File.readable? tmp_file_name
+
+        response = Net::HTTP.get_response(IANA_URL)
+
+        if response.code.to_i == 200
+          response.body.tap do |content|
+            File.open(tmp_file_name, 'w') { |file| file.write(content) }
+          end
+        else
+          Utils.iana_link_relations
+        end
+      end
+    end
+  end
+end

data/lib/shaf/utils.rb

@@ -107,9 +107,9 @@ module Shaf
         end
       end
 
-      def iana_link_relations_csv
+      def iana_link_relations
         zip_file = File.join(gem_root, 'iana_link_relations.csv.gz')
-        Zlib::GzipReader.open(zip_file) { |content| CSV.new(content.read) }
+        Zlib::GzipReader.open(zip_file) { |content| content.read }
       end
 
       private

data/lib/shaf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shaf
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 end

data/lib/shaf/yard/link_object.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'shaf/api_doc/link_relations'
+require 'shaf/link_relations'
 
 module Shaf
   module Yard
@@ -52,8 +52,7 @@ module Shaf
       end
 
       def iana_doc
-        ApiDoc::LinkRelations.load_iana
-        ApiDoc::LinkRelations[name.to_sym]&.description
+        LinkRelations.get(name)&.description
       end
     end
   end

data/yard_templates/api_doc/profile_attribute/html/attribute.erb

@@ -1,6 +1,7 @@
 <h4 class=description-list>
     <strong> <%= object.name %></strong>
-    <% value_types.each do |type:, class_name:| %>
+    <% value_types.each do |value_type| %>
+      <% type, class_name = value_type.values_at(:type, :class_name) %>
         <span class="property-source <%= class_name %>"><%= type %></span>
     <% end %>
 </h4>

data/yard_templates/api_doc/resource_attribute/html/attribute.erb

@@ -1,6 +1,7 @@
 <h4 class=description-list>
     <strong> <%= object.name %></strong>
-    <% value_types.each do |type:, class_name:| %>
+    <% value_types.each do |value_type| %>
+      <% type, class_name = value_type.values_at(:type, :class_name) %>
         <span class="property-source <%= class_name %>"><%= type %></span>
     <% end %>
 </h4>

data/yard_templates/api_doc/sidebar/html/profile_list.erb

@@ -1,6 +1,7 @@
 <div id="profile-list" class="list sidebar-content <%= 'active' if profile? %>">
   <ul>
-    <% @profiles.each do |name:, path:| %>
+    <% @profiles.each do |profile| %>
+      <% name, path = profile.values_at(:name, :path) %>
       <li class="sidebar-link <%= 'active' if profile_active?(name) %>">
         <a href=<%= path %> class="<%= 'active' if profile_active?(name) %>"><%= name%></a>
       </li>

data/yard_templates/api_doc/sidebar/html/serializer_list.erb

@@ -1,6 +1,7 @@
 <div id="serializer-list" class="list sidebar-content <%= 'active' if resource? || index? %>">
   <ul>
-    <% @resources.each do |name:, path:| %>
+    <% @resources.each do |resource| %>
+      <% name, path = resource.values_at(:name, :path) %>
       <li class="sidebar-link <%= 'active' if resource_active?(name) %>">
         <a href=<%= path %> class="<%= 'active' if resource_active?(name) %>"><%= name%></a>
       </li>

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Sammy Henningsson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIDVjCCAj6gAwIBAgIBATANBgkqhkiG9w0BAQsFADAqMSgwJgYDVQQDDB9zYW1t
-  eS5oZW5uaW5nc3Nvbi9EQz1oZXkvREM9Y29tMB4XDTIxMDIwMjEzNTY1OFoXDTIy
-  MDIwMjEzNTY1OFowKjEoMCYGA1UEAwwfc2FtbXkuaGVubmluZ3Nzb24vREM9aGV5
+  eS5oZW5uaW5nc3Nvbi9EQz1oZXkvREM9Y29tMB4XDTIzMDkwMjIxMDQ1MVoXDTI1
+  MDkwMTIxMDQ1MVowKjEoMCYGA1UEAwwfc2FtbXkuaGVubmluZ3Nzb24vREM9aGV5
   L0RDPWNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK+SDC1mfyhu
   cJ6Va21rIHUGscEtQrdvyBqxFG1s2TgPMAv4RbqwdJVPa7kjtbCzslADlUE1oru2
   C+rcJsMtVGX02ukMIPHT1OjTyy0/EMqLqSy3WeRI8APyDSxCVbe+h5BMf3zZnYfd
@@ -22,14 +22,14 @@ cert_chain:
   nIxTSJpPr2cCAwEAAaOBhjCBgzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
   HQ4EFgQUukjj1Cd2ea6IOHDLZe0ymzs2jWkwJAYDVR0RBB0wG4EZc2FtbXkuaGVu
   bmluZ3Nzb25AaGV5LmNvbTAkBgNVHRIEHTAbgRlzYW1teS5oZW5uaW5nc3NvbkBo
-  ZXkuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQBt310FZ56E/fp/y5Wym1xb4C0owfnI
-  LzUqOjXWZTO7RezlBJV/qIwqt6bEjYDQR56zULJFSp4YdoDsratmQ+/kwtbHF7xf
-  WYkSE36mhLP2ggQFH9fXtX6XdyIlwFqwEfNW73ZrkBXGjMxLVKIS9uHdN7PoNhbS
-  0YjOZZD/rq1Jf+klwl/G7bBDPjn58DWlUmwzoj49goGS/UBG37RssQxRwPelKHZh
-  5ZlcHq9h5CxVt380OKaU6wMg95RJBd/kUJqmPxxlxMH8QDQinTwZmmFA9wW7PJdy
-  wAx8px9LkSjTs0GVLH7VtVRWAELllsswCJktz63Adelx9fmIMgrTYgZM
+  ZXkuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQAsxqfXdj/fWsDuJmENnfpYLkPJ96MS
+  8GcxCGRaq2k5nZlGU38tPzTm9HdOjCOouO4PthohqNQ9X7jOkSbKA/zrGGTHyao9
+  0URFQQ/ln3liGyjD4FsXSVZVBqbw9U0AGXh9MwatyWBj9Q679SttxCIGYJtNwtVo
+  jCXrgrCX+Slrrlfi7ve5Dz/V9bhl2jZrv4d2rIuMBJCHPr8sa/nobyskfYgs0v2D
+  Dw5VdKSj3KIY2gdwi1boraHAMinBgq6VXJczYUhdWtQln+0GFS1XHf1dBlCSZCTN
+  trIX62sesXxQtqAqHQHNIbWC2vP1K04nAzyw4ohA0yTAo/Hscqusp+If
   -----END CERTIFICATE-----
-date: 2021-10-03 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: file_transactions
@@ -54,7 +54,7 @@ dependencies:
         version: '5'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -64,7 +64,7 @@ dependencies:
         version: '5'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.19'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +304,7 @@ files:
 - lib/shaf/helpers/payload.rb
 - lib/shaf/helpers/vary.rb
 - lib/shaf/immutable_attr.rb
+- lib/shaf/link_relations.rb
 - lib/shaf/logger.rb
 - lib/shaf/middleware/request_id.rb
 - lib/shaf/parser.rb
@@ -452,13 +453,13 @@ files:
 - yard_templates/api_doc/sidebar/html/serializer_list.erb
 - yard_templates/api_doc/sidebar/html/sidebar.erb
 - yard_templates/api_doc/sidebar/setup.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/sammyhenningsson/shaf/blob/master/CHANGELOG.md
   homepage_uri: https://github.com/sammyhenningsson/shaf
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -473,8 +474,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.18
+signing_key:
 specification_version: 4
 summary: Sinatra Hypermedia Api Framework
 test_files: []