shaf 2.1.0 → 3.0.1

data/lib/shaf/router.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'shaf/middleware'
 require 'set'
+require 'sinatra'
+require 'shaf/errors'
 
 module Shaf
   class Router
@@ -21,16 +22,56 @@ module Shaf
       end
     end
 
+    class NullController
+      def call(env)
+        request = request(env)
+        responder = Responder.for(request, error)
+        responder.call(self, error)
+
+        response.finish
+      end
+
+      # Called from responder
+      def content_type(mime)
+        response["Content-Type"] = mime
+      end
+
+      # Called from responder
+      def body(body)
+        response.body  = body
+      end
+
+      private
+
+      def status
+        500
+      end
+
+      def request(env)
+        Sinatra::Request.new(env)
+      end
+
+      def response
+        @response ||= Sinatra::Response.new(nil, status)
+      end
+
+      def error
+        @error ||= Errors::ServerError.new(
+          'Internal error: No controller has been mounted on Router',
+          code: 'NO_MOUNTED_CONTROLLERS',
+          title: 'Shaf::Router must have at least one mounted controller',
+        )
+      end
+    end
+
     class << self
       def mount(controller, default: false)
         @default_controller = controller if default
-        @controllers ||= []
-        @controllers << controller
+        controllers << controller
       end
 
       def routes
-        init_routes unless defined? @routes
-        @routes
+        @routes ||= init_routes
       end
 
       # This controller will be used when no other can handle the request
@@ -41,32 +82,44 @@ module Shaf
 
       private
 
-      attr_reader :controllers
+      def controllers
+        @controllers ||= []
+      end
 
       def init_routes
-        @routes = Hash.new do |hash, key|
+        routes = Hash.new do |hash, key|
           hash[key] = Hash.new { |h, k| h[k] = Set.new }
         end
-        controllers.each { |controller| init_routes_for(controller) }
+        controllers.each { |controller| init(controller, routes) }
+        routes
       end
 
-      def init_routes_for(controller)
+      def init(controller, routes)
         controller.routes.each do |method, controller_routes|
           routes[method][controller] += controller_routes.map(&:first)
         end
       end
     end
 
-    def initialize(app)
+    def initialize(app = NullController.new)
       @app = app
     end
 
     def call(env)
+      # When the api is mounted in Rails then the mount point will be not be
+      # present in PATH_INFO but it will instead be available in SCRIPT_NAME
+      # Shaf need to know about the full path in order to make all path helpers
+      # work, so we need to add the mountpoint back to PATH_INFO.
+      unless String(env['SCRIPT_NAME']).empty?
+        env['PATH_INFO'] = '' if env['PATH_INFO'] == '/'
+        env['PATH_INFO'] = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+      end
+
       http_method, path = http_details(env)
 
       result = nil
 
-      controllers_for(http_method, path) do |controller|
+      each_controller_for(http_method, path) do |controller|
         result = controller.call(env)
         break unless cascade? result
       end
@@ -80,7 +133,7 @@ module Shaf
       [env['REQUEST_METHOD'], env['PATH_INFO']]
     end
 
-    def controllers_for(http_method, path)
+    def each_controller_for(http_method, path)
       find_cached(http_method, path).each { |ctrlr| yield ctrlr }
 
       if controller = find(http_method, path)

data/lib/shaf/spec/integration_spec.rb

@@ -30,7 +30,7 @@ module Shaf
       end
 
       def app
-        App.app
+        App.instance
       end
 
       def authenticate(user)

data/lib/shaf/tasks.rb

@@ -1,6 +1,5 @@
 require 'shaf/tasks/test_task'
 require 'shaf/tasks/db_task'
-require 'shaf/tasks/api_doc_task'
 require 'shaf/tasks/routes_task'
 
 module Shaf

data/lib/shaf/upgrade/package.rb

@@ -236,18 +236,16 @@ module Shaf
         replacement = params[:replace]
 
         changed = false
-        tmp = Tempfile.open do |new_file|
+        new_content = ""
+        FT::ChangeFileCommand.execute(file) do
           File.readlines(file).each do |line|
             changed = line.gsub!(pattern, replacement) || changed
-            new_file << line
+            new_content << line
           end
-          new_file
+          new_content
         end
 
-        return true unless changed
-
-        puts "modifying file: #{file}"
-        FT::MoveFileCommand.new(from: tmp.path, to: file).execute
+        puts "modifying file: #{file}" if changed
         true
       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 = '2.1.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/templates/Rakefile

@@ -5,12 +5,6 @@ $LOAD_PATH.unshift __dir__ unless $LOAD_PATH.include? __dir__
 require 'shaf/rake'
 require 'shaf/settings'
 
-Shaf::ApiDocTask.new do |api_doc|
-  api_doc.source_dir = File.join(%w(api serializers))
-  api_doc.html_output_dir = File.join(Shaf::Settings.public_folder, "doc")
-  api_doc.yaml_output_dir = Shaf::Settings.documents_dir || "doc/api"
-end
-
 namespace :test do
   Shaf::TestTask.new(:integration) do |t|
     t.pattern = "spec/integration/**/*_spec.rb"

data/templates/api/controllers/base_controller.rb

@@ -13,8 +13,6 @@ class BaseController < Sinatra::Base
     set :show_exceptions, :after_handler
   end
 
-  use Rack::Deflater
-
   Shaf::Router.mount(self, default: true)
 
   register(*Shaf.extensions)

data/templates/api/serializers/root_serializer.rb

@@ -1,16 +1,5 @@
 require 'serializers/base_serializer'
 
 class RootSerializer < BaseSerializer
-
-  # Auto generated doc:  
-  # Link to the root resource. All clients should fetch this resource
-  # when starting to interact with this API.  
-  # Method: GET  
-  # Example:
-  # ```
-  # curl -H "Accept: application/json" \
-  #      -H "Authorization: abcdef" \
-  #      /
-  #```
   link :self, root_uri
 end

data/templates/config/initializers/middleware.rb

@@ -0,0 +1,6 @@
+require 'shaf/middleware/request_id'
+require 'shaf/router'
+
+Shaf::App.use Rack::Deflater
+Shaf::App.use Shaf::Middleware::RequestId
+Shaf::App.use Shaf::Router

data/templates/spec/spec_helper.rb

@@ -4,4 +4,7 @@ require 'minitest/autorun'
 require 'minitest/hooks'
 require 'shaf/spec'
 
-Shaf::Spec::Authenticator.restricted { |id:| User[id] }
+realm = Shaf::Settings.default_authentication_realm
+Shaf::Spec::Authenticator.restricted realm: realm do |id:|
+  User[id]
+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: 2.1.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-04-07 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
@@ -149,20 +149,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +205,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A framework for building hypermedia driven APIs with sinatra and sequel.
 email: sammy.henningsson@gmail.com
 executables:
@@ -232,9 +232,6 @@ files:
 - lib/shaf/alps/attribute_serializer.rb
 - lib/shaf/alps/json_serializer.rb
 - lib/shaf/alps/relation_serializer.rb
-- lib/shaf/api_doc/comment.rb
-- lib/shaf/api_doc/document.rb
-- lib/shaf/api_doc/link_relations.rb
 - lib/shaf/app.rb
 - lib/shaf/authenticator.rb
 - lib/shaf/authenticator/base.rb
@@ -307,8 +304,8 @@ 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.rb
 - lib/shaf/middleware/request_id.rb
 - lib/shaf/parser.rb
 - lib/shaf/parser/base.rb
@@ -352,7 +349,6 @@ files:
 - lib/shaf/spec/system_spec.rb
 - lib/shaf/supported_http_methods.rb
 - lib/shaf/tasks.rb
-- lib/shaf/tasks/api_doc_task.rb
 - lib/shaf/tasks/db_task.rb
 - lib/shaf/tasks/routes_task.rb
 - lib/shaf/tasks/test_task.rb
@@ -397,6 +393,7 @@ files:
 - templates/config/initializers/db_migrations.rb
 - templates/config/initializers/hal_presenter.rb
 - templates/config/initializers/logging.rb
+- templates/config/initializers/middleware.rb
 - templates/config/initializers/sequel.rb
 - templates/config/paths.rb
 - templates/frontend/assets/css/main.css
@@ -422,6 +419,7 @@ files:
 - upgrades/1.6.0.tar.gz
 - upgrades/1.6.1.tar.gz
 - upgrades/2.0.0.tar.gz
+- upgrades/3.0.0.tar.gz
 - yard_templates/api_doc/doc_index/html/body.erb
 - yard_templates/api_doc/doc_index/setup.rb
 - yard_templates/api_doc/html/css/api-doc.css
@@ -455,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
@@ -476,8 +474,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.18
+signing_key:
 specification_version: 4
 summary: Sinatra Hypermedia Api Framework
 test_files: []

data/lib/shaf/api_doc/comment.rb

@@ -1,27 +0,0 @@
-module Shaf
-  module ApiDoc
-    class Comment
-      def initialize
-        @indent = 0
-        @comment = ""
-      end
-
-      def to_s
-        @comment
-      end
-
-      def empty?
-        @comment.empty?
-      end
-
-      def <<(line)
-        @indent = line[/\A\s*/].size if empty?
-        @comment << "\n#{extract(line)}"
-      end
-
-      def extract(line)
-        line.sub(%r(\A\s{#{@indent}}), "")
-      end
-    end
-  end
-end

data/lib/shaf/api_doc/document.rb

@@ -1,137 +0,0 @@
-require 'fileutils'
-require 'yaml'
-require 'redcarpet'
-require 'redcarpet/render_strip'
-
-module Shaf
-  module ApiDoc
-    class Document
-      attr_writer :model
-      attr_accessor :serializer_class, :policy, :attributes, :links, :curies, :embeds
-
-      def initialize
-        @model = nil
-        @serializer_class = nil
-        @policy = nil
-        @attributes = {}
-        @links = {}
-        @curies = {}
-        @embeds = {}
-        @md = {}
-      end
-
-      def model
-        @model || @serializer_class && @serializer_class.sub("Serializer", "")
-      end
-
-      def attribute(attr, comment)
-        @attributes[attr] = comment unless comment.empty?
-      end
-
-      def link(rel, comment)
-        @links[strip_curie(rel)] = comment unless comment.empty?
-      end
-
-      def curie(rel, comment)
-        @curies[rel] = comment unless comment.empty?
-      end
-
-      def embedded(name, comment)
-        @embeds[strip_curie(name)] = comment unless comment.empty?
-      end
-
-      def valid?
-        return false unless model
-        attributes.merge(links).merge(curies).any?
-      end
-
-      def generate_markdown!
-        return @md unless @md.empty?
-
-        generate_title!
-        generate_policy!
-        generate_section!(key: :attributes, heading: "Attributes")
-        generate_section!(key: :curies, heading: "Curies", sub_title: "rel")
-        generate_section!(key: :links, heading: "Links", sub_title: "rel")
-        generate_section!(key: :embeds, heading: "Embedded resources", sub_title: "rel")
-        @md[:doc]
-      end
-
-      def generate_yaml!
-        generate_markdown!
-        renderer = Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
-
-        hash = {}
-        hash['policy'] = renderer.render(@md[:policy]).chomp if @md[:policy]
-
-        [:attributes, :curies, :links, :embeds].each do |key|
-          hash[key.to_s] = @md[key].map { |k, v| [k.to_s, renderer.render(v).chomp] }.to_h
-        end
-        hash.to_yaml
-      end
-
-      def markdown
-        generate_markdown!
-        @md[:doc]
-      end
-
-      def to_html
-        options = {autolink: true, fenced_code_blocks: true}
-        markdown_renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options)
-        html = markdown_renderer.render markdown
-        # For some reason redcarpet don't like to surround my markdown code blocks
-        # with <pre> tags, so let's fix that here.
-        html.gsub!("<code>", "<pre><code>")
-        html.gsub!("</code>", "</code></pre>")
-        html
-      end
-
-      def write_html(output)
-        FileUtils.mkdir_p(output) unless Dir.exist? output
-        File.open(File.join(output, "#{model.downcase}.html"), "w") do |file|
-          file.write(to_html)
-        end
-      end
-
-      def write_yaml(output)
-        FileUtils.mkdir_p(output) unless Dir.exist? output
-        File.open(File.join(output, "#{model.downcase}.yml"), "w") do |file|
-          file.write(generate_yaml!)
-        end
-      end
-
-
-      private
-
-      def strip_curie(rel)
-        rel.split(':', 2)[1] || rel
-      end
-
-      def generate_title!
-        @md[:doc] = "# #{model.capitalize}\n"
-        @md[:title] = model.capitalize
-      end
-
-      def generate_policy!
-        return if policy.nil?
-        @md[:doc] << "## Policy\n#{policy}\n"
-        @md[:policy] = policy
-      end
-
-      def generate_section!(key:, heading:, sub_title: "")
-        list = send(key)
-        @md[:doc] << "## #{heading}\n"
-        @md[key] = {}
-        if list.empty?
-          @md[:doc] << "This resource does not have any documented #{heading.downcase}\n"
-        else
-          sub_title += ": " unless sub_title.empty?
-          list.each do |name, comment|
-            @md[:doc] << "- *#{sub_title}#{name.tr('_', '-')}*\n  #{comment.to_s.gsub("\n", "\n  ")}\n\n"
-            @md[key][name] = comment.to_s.chomp
-          end
-        end
-      end
-    end
-  end
-end