shaf 1.5.0 → 2.0.0

data/lib/shaf/responder/html.rb

@@ -1,19 +1,75 @@
-require 'shaf/responder/hal_serializable'
-
 module Shaf
   module Responder
     class Html < Base
-      include HalSerializable
-
       mime_type :html
 
+      class << self
+        def call(controller, resource, preload: [], **kwargs)
+          responder = responder_for(resource, controller, preload_rels: preload, **kwargs)
+          response = responder.build_response
+          add_preload_links(controller, response)
+
+          html_responder = new(controller, resource, response: response)
+          html_response = html_responder.build_response
+          log_response(controller, response)
+
+          write_response(controller, html_response)
+        end
+
+
+        # Returns the "original" (non-html) responder
+        def responder_for(resource, controller, **kwargs)
+          responders = Responder.send(:supported_responders_for, resource)
+          responder_class = (responders - [self]).first || Responder.default
+          responder_class.new(controller, resource, **kwargs)
+        end
+      end
+
       def body
-        case resource
-        when Formable::Form
-          controller.erb(:form, locals: {form: resource, serialized: serialized_hash})
-        else
-          controller.erb(:payload, locals: {serialized: serialized_hash})
+        response = options[:response]
+        serialized = response.serialized_hash
+        if serialized.empty?
+          serialized = begin
+                         JSON.parse(response.body)
+                       rescue StandardError
+                         response.body
+                       end
         end
+
+        render serialized
+      end
+
+      def render(serialized)
+        locals = {
+          request_headers: request_headers,
+          response_headers: response_headers,
+          serialized: serialized
+        }
+
+        template =
+          case resource
+          when Formable::Form
+            locals.merge!(form: resource)
+            :form
+          else
+            :payload
+          end
+
+        controller.erb(template, locals: locals)
+      end
+
+      def request_headers
+        controller.request_headers
+      end
+
+      def response_headers
+        etag, kind = controller.send(:etag_for, options[:response].body)
+        prefix = kind == :weak ? 'W/' : ''
+        etag = %Q{#{prefix}"#{etag}"}
+
+        type = options[:response].content_type
+
+        controller.headers.merge('Content-Type' => type, 'ETag' => etag)
       end
     end
   end

data/lib/shaf/responder/problem_json.rb

@@ -4,7 +4,7 @@ module Shaf
       mime_type :problem_json, 'application/problem+json'
 
       def self.can_handle?(resource)
-        klass = resource.is_a?(Class) ? resource: resource.class
+        klass = resource.is_a?(Class) ? resource : resource.class
         klass <= StandardError
       end
 

data/lib/shaf/serializer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'hal_presenter'
+
+module Shaf
+  # A base class used for serializing objects into a HAL representations.
+  class Serializer
+    extend HALPresenter
+    extend UriHelper
+
+    class << self
+      attr_reader :default_curie_prefix
+
+      # Creates a link with rel profile and href pointing to the corresponding profile.
+      # It also adds a Curie link.
+      # @param name [String] the name of the profile
+      # @param curie_prefix [Symbol] the prefix used for the Curie
+      def profile(name, curie_prefix: :doc)
+        link :profile do
+          profile_uri(name)
+        end
+
+        curie curie_prefix do
+          doc_curie_uri(name)
+        end
+
+        @default_curie_prefix = curie_prefix.to_sym
+      end
+    end
+  end
+end

data/lib/shaf/settings.rb

@@ -12,24 +12,41 @@ module Shaf
       documents_dir: 'doc/api',
       migrations_dir: 'db/migrations',
       fixtures_dir: 'spec/fixtures',
-      auth_token_header: 'X-Auth-Token',
       paginate_per_page: 25
     }.freeze
 
     class << self
-      def load
-        @settings = DEFAULTS.dup
-        config = Utils.read_config(SETTINGS_FILE, erb: true)
-        @settings.merge! config.fetch(env, {})
+      def env
+        (ENV['APP_ENV'] || ENV['RACK_ENV'] || 'development').to_sym
       end
 
+      def key?(key)
+        settings.key? key
+      end
 
-      def env
-        (ENV['APP_ENV'] || ENV['RACK_ENV'] || 'development').to_sym
+      def to_h
+        settings.dup
+      end
+
+      def loaded?
+        !!defined? @settings
+      end
+
+      private
+
+      def settings
+        load_config unless loaded?
+        @settings
+      end
+
+      def load_config
+        @settings = DEFAULTS.dup
+        config = Utils.read_config(SETTINGS_FILE, erb: true)
+        @settings.merge! config.fetch(env, {})
       end
 
       def method_missing(method, *args)
-        load unless defined? @settings
+        load_config unless loaded?
 
         if method.to_s.end_with? '='
           define_setter(method)
@@ -56,10 +73,6 @@ module Shaf
           @settings[key] = arg
         end
       end
-
-      def to_h
-        @settings.dup
-      end
     end
   end
 end

data/lib/shaf/spec.rb

@@ -6,3 +6,4 @@ require 'shaf/spec/base'
 require 'shaf/spec/integration_spec'
 require 'shaf/spec/serializer_spec'
 require 'shaf/spec/system_spec'
+require 'shaf/spec/authenticator'

data/lib/shaf/spec/authenticator.rb

@@ -0,0 +1,13 @@
+module Shaf
+  module Spec
+    class Authenticator < Shaf::Authenticator::Base
+      scheme 'Test'
+
+      param :realm, required: false
+
+      def self.credentials(authorization, _request)
+        { id: authorization&.to_i }
+      end
+    end
+  end
+end

data/lib/shaf/spec/base.rb

@@ -24,7 +24,7 @@ module Shaf
       end
 
       before do
-        $logger&.info <<~LOG
+        Shaf.log.info <<~LOG
           \n
           ##########################################################################
           # #{self.class.superclass.name} - #{name}

data/lib/shaf/spec/http_method_utils.rb

@@ -7,7 +7,7 @@ module Shaf
 
       %i[get put patch post delete options head link unlink].each do |m|
         define_method m do |uri, payload = nil, options = {}|
-          set_headers
+          set_authentication
 
           if payload
             payload = JSON.generate(payload) if payload.respond_to? :to_h

data/lib/shaf/spec/integration_spec.rb

@@ -8,13 +8,18 @@ module Shaf
 
       register_spec_type self do |_desc, args|
         next unless args&.is_a?(Hash)
-        args[:type]&.to_s == 'integration'
+        args[:type].to_s == 'integration'
       end
 
-      def set_headers
-        if defined?(@__integration_test_auth_token) && @__integration_test_auth_token
-          header Settings.auth_token_header, @__integration_test_auth_token
-        end
+      private
+
+      attr_accessor :__authenticated_user_id
+
+      def set_authentication
+        id = __authenticated_user_id
+        authorization = "#{Authenticator.scheme} #{id}" if id
+
+        header 'Authorization', authorization
       end
 
       def parse_response(body)
@@ -28,6 +33,21 @@ module Shaf
         App.app
       end
 
+      def authenticate(user)
+        self.__authenticated_user_id = user&.id
+      end
+
+      def unauthenticate
+        self.__authenticated_user_id = nil
+      end
+
+      def with_authenticated(user, &block)
+        authenticate(user)
+        yield
+      ensure
+        unauthenticate
+      end
+
       def follow_rel(rel, method: nil)
         assert_has_link(rel)
         link = links[rel.to_sym]
@@ -37,14 +57,6 @@ module Shaf
           get link[:href]
         end
       end
-
-      def auth_token(token)
-        @__integration_test_auth_token = token
-      end
-
-      def clear_auth_token
-        @__integration_test_auth_token = nil
-      end
     end
   end
 end

data/lib/shaf/spec/payload_utils.rb

@@ -29,11 +29,11 @@ module Shaf
         last_payload[:_embedded]&.keys || []
       end
 
-      def embedded(name = nil)
+      def embedded(name = nil, &block)
         assert_has_embedded name unless name.nil?
         keys = [:_embedded, name&.to_sym].compact
         return last_payload.dig(*keys) unless block_given?
-        exec_embed_block(last_payload.dig(*keys), Proc.new)
+        exec_embed_block(last_payload.dig(*keys), block)
       end
 
       def each_embedded(name, &block)

data/lib/shaf/supported_http_methods.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Shaf
+  SUPPORTED_HTTP_METHODS = [
+    :get,
+    :put,
+    :post,
+    :patch,
+    :delete,
+    :head,
+    :options,
+    :link,
+    :unlink
+  ]
+end

data/lib/shaf/tasks/api_doc_task.rb

@@ -1,6 +1,3 @@
-require 'shaf/api_doc/document'
-require 'shaf/api_doc/comment'
-
 module Shaf
   module Tasks
     class ApiDocTask
@@ -9,6 +6,11 @@ module Shaf
       attr_accessor :document_class, :source_dir, :html_output_dir, :yaml_output_dir
 
       def initialize
+        return show_deprecation_message if RUBY_VERSION >= '3.0.0'
+
+        require 'shaf/api_doc/document'
+        require 'shaf/api_doc/comment'
+
         yield self if block_given?
         validate_attributes!
         @document_class ||= ApiDoc::Document
@@ -25,6 +27,8 @@ module Shaf
         namespace :doc do
           desc "Generate API documentation"
           task :generate do
+            show_deprecation_message
+
             files = Dir.glob(File.join(source_dir, "*.rb"))
             files.each do |file|
               read_file file do |doc|
@@ -47,6 +51,23 @@ module Shaf
         end
       end
 
+      def show_deprecation_message
+        ruby3_msg = <<~RUBY3 if RUBY_VERSION >= '3.0.0'
+
+          Due to errors with the Redcarpet gem it's not possible to use this deprecated rake task with Ruby >= 3.0.0
+          If you need to continue with this task please use an older version of Ruby.
+        RUBY3
+
+        puts <<~MSG
+          This way of generating documentation is DEPRECATED.#{ruby3_msg}
+
+          Please move the documentation comments into profiles instead and run:
+          shaf generate doc
+          See https://github.com/sammyhenningsson/shaf/blob/main/doc/DOCUMENTATION.md for more info
+
+        MSG
+      end
+
       def read_file(file)
         doc = document_class.new
         comment = ApiDoc::Comment.new

data/lib/shaf/tasks/routes_task.rb

@@ -1,29 +1,26 @@
 module Shaf
   module Tasks
     class RoutesTask
-      include Rake::DSL
+      extend Rake::DSL
 
-      def initialize(*)
-        desc "List path helpers"
-        task :routes do
-          require 'shaf/utils'
-          require 'config/database'
+      desc 'List path helpers'
+      task :routes do
+        require 'shaf/utils'
+        require 'config/database'
 
-          extend Shaf::Utils
-          bootstrap
+        extend Shaf::Utils
+        bootstrap
 
-          helpers = UriHelperMethods.path_helpers_for.sort { |a, b| a[0].to_s <=> b[0].to_s }
-          helpers.each do |controller, methods|
-            puts "\n#{controller}:"
-            methods.each do |method|
-              template_method = "#{method}_template".to_sym
-              puts sprintf( "%-60s%s" , method, controller.send(template_method))
-            end
+        Shaf::ApiRoutes::Registry.controllers.each do |controller|
+          puts "\n#{controller}:"
+          Shaf::ApiRoutes::Registry.routes_for(controller) do |methods, template, symbol|
+            puts format(
+              '  %-50<symbol>s%-30<methods>s%<template>s',
+              {symbol: symbol, methods: methods.join(' | '), template: template}
+            )
           end
         end
       end
     end
-
-    RoutesTask.new
   end
 end

data/lib/shaf/upgrade/manifest.rb

@@ -12,6 +12,7 @@ module Shaf
         @files[:add] = params[:add] || {}
         @files[:drop] = (params[:drop] || []).map { |d| Regexp.new(d) }
         @files[:regexp] = build_patterns(params[:substitutes])
+        @files[:messages] = params[:messages] || []
       end
 
       def patches
@@ -30,6 +31,10 @@ module Shaf
         files[:regexp]
       end
 
+      def messages
+        files[:messages]
+      end
+
       def patches_for(file)
         patches.select { |_, pattern| file =~ pattern }.keys
       end
@@ -47,7 +52,8 @@ module Shaf
           additions: additions.size,
           removals: removals.size,
           patches: patches.size,
-          regexps: regexps.size
+          regexps: regexps.size,
+          messages: messages.size
         }
       end
 
@@ -55,7 +61,8 @@ module Shaf
         "Add: #{additions.size}, " \
           "Del: #{removals.size}, " \
           "Patch: #{patches.size}, " \
-          "Regexp: #{regexps.size}"
+          "Regexp: #{regexps.size}, " \
+          "Messages: #{messages.size}"
       end
 
       private
@@ -82,3 +89,5 @@ end
 # - api/policies/base_policy.rb
 # substitutes:
 #   d3b07384d113edec49eaa6238ad5ff00: api/models/.*.rb
+# messages:
+# - b1946ac92492d2347c6235b4d2611184