shaf 1.6.1 → 2.0.0

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

data/lib/shaf/upgrade/package.rb

@@ -6,6 +6,9 @@ require 'open3'
 require 'fileutils'
 require 'tempfile'
 require 'yaml'
+require 'file_transactions'
+
+FT = FileTransactions
 
 module Shaf
   module Upgrade
@@ -23,8 +26,6 @@ module Shaf
       MANIFEST_FILENAME = 'manifest'.freeze
       IGNORE_FILE_PATTERNS = [/.rej\z/, /.orig\z/]
 
-      attr_reader :version
-
       class << self
         def all
           target_versions.map(&method(:new))
@@ -53,6 +54,8 @@ module Shaf
         end
       end
 
+      attr_reader :version, :manifest
+
       def initialize(version, manifest = nil, files = {})
         @version = Version.new(version)
         @manifest = manifest
@@ -77,25 +80,32 @@ module Shaf
       end
 
       def apply(dir = nil)
-        puts "Applying changes for version #{version}"
-        [
-          apply_patches(dir),
-          apply_drops(dir),
-          apply_additions,
-          apply_substitutes(dir),
-        ].all?
+        puts "\n ## Applying changes for Shaf version: #{version} ##"
+
+        FT.transaction do
+          result = [
+            apply_patches(dir),
+            apply_drops(dir),
+            apply_additions,
+            apply_substitutes(dir),
+            print_messages,
+          ]
+          raise UpgradeError, 'Upgrade failed' unless result.all?
+        end
+
+        true
       end
 
       def to_s
-        str = "Shaf::Upgrade::Package for version #{@version}"
-        return str if @manifest.nil?
-        "#{str} (#{@manifest.stats_str})"
+        str = "Shaf::Upgrade::Package for version #{version}"
+        return str if manifest.nil?
+        "#{str} (#{manifest.stats_str})"
       end
 
       private
 
       def tarball
-        file = File.join(UPGRADE_FILES_PATH, "#{@version}.tar.gz")
+        file = File.join(UPGRADE_FILES_PATH, "#{version}.tar.gz")
         return file if File.exist? file
         raise VersionNotFoundError
       end
@@ -114,24 +124,25 @@ module Shaf
       def parse_manifest(content)
         hash = YAML.safe_load(content)
         @manifest = Manifest.new(
-          target_version: hash["target_version"],
-          patches: hash["patches"],
-          add: hash["add"],
-          drop: hash["drop"],
-          substitutes: hash["substitutes"]
+          target_version: hash['target_version'],
+          patches: hash['patches'],
+          add: hash['add'],
+          drop: hash['drop'],
+          substitutes: hash['substitutes'],
+          messages: hash['messages']
         )
       end
 
       def validate
-        raise ManifestNotFoundError unless @manifest
-        raise VersionConflictError unless @version == @manifest.target_version
+        raise ManifestNotFoundError unless manifest
+        raise VersionConflictError unless version == manifest.target_version
 
         from_file = @files.keys.to_set
 
-        manifest_patches = @manifest.files[:patch].keys.to_set
+        manifest_patches = manifest.patches.keys.to_set
         raise MissingFileError if from_file < manifest_patches
 
-        to_add = @manifest.files[:add].keys.to_set
+        to_add = manifest.additions.keys.to_set
         raise MissingFileError if from_file < to_add
 
         @files.each do |md5, content|
@@ -156,7 +167,7 @@ module Shaf
 
       def apply_patches(dir = nil)
         files_in(dir).map do |file|
-          @manifest.patches_for(file).map do |name|
+          manifest.patches_for(file).map do |name|
             patch = @files[name]
             apply_patch(file, patch)
           end.all?
@@ -164,25 +175,29 @@ module Shaf
       end
 
       def apply_patch(file, patch)
-        Open3.popen3('patch', file) do |i, o, e, t|
-          i.write patch
-          i.close
-          puts o.read
-          err = e.read
-          puts err unless err.empty?
-          result = t.value.success?
-          STDERR.puts "Failed to apply patch for: #{file}\n" unless result
-          result
+        result = nil
+
+        FT::ChangeFileCommand.execute(file) do
+          Open3.popen3('patch', file) do |i, o, e, t|
+            i.write patch
+            i.close
+            puts o.read
+            err = e.read
+            puts err unless err.empty?
+            result = t.value.success?
+          end
         end
+
+        STDERR.puts "Failed to apply patch for: #{file}\n" unless result
+        result
       end
 
       def apply_additions
-        puts '' unless @manifest.additions.empty?
-        @manifest.additions.all? do |chksum, filename|
+        puts '' unless manifest.additions.empty?
+        manifest.additions.all? do |chksum, filename|
           content = @files[chksum]
-          FileUtils.mkdir_p File.dirname(filename)
           puts "adding file: #{filename}"
-          File.open(filename, 'w') { |file| file.write(content) }
+          FT::CreateFileCommand.execute(filename) { content }
           true
         rescue StandardError => e
           STDERR.puts "Failed to add '#{filename}': #{e.message}\n"
@@ -191,11 +206,11 @@ module Shaf
       end
 
       def apply_drops(dir = nil)
-        puts '' unless @manifest.removals.empty?
+        puts '' unless manifest.removals.empty?
         files_in(dir).all? do |file|
-          next true unless @manifest.drop?(file)
+          next true unless manifest.drop?(file)
           puts "removing file: #{file}"
-          File.unlink(file)
+          FT::DeleteFileCommand.execute file
           true
         rescue StandardError => e
           STDERR.puts "Failed to unlink '#{file}': #{e.message}\n"
@@ -204,9 +219,9 @@ module Shaf
       end
 
       def apply_substitutes(dir = nil)
-        puts '' unless @manifest.regexps.empty?
+        puts '' unless manifest.regexps.empty?
         files_in(dir).map do |file|
-          @manifest.regexps_for(file).map do |name|
+          manifest.regexps_for(file).map do |name|
             params = YAML.safe_load(@files[name])
             params.transform_keys!(&:to_sym)
             apply_substitute(file, params)
@@ -220,14 +235,29 @@ module Shaf
         pattern = Regexp.new(params[:pattern])
         replacement = params[:replace]
 
+        changed = false
         tmp = Tempfile.open do |new_file|
           File.readlines(file).each do |line|
-            new_file << line.gsub(pattern, replacement)
+            changed = line.gsub!(pattern, replacement) || changed
+            new_file << line
           end
           new_file
         end
 
-        FileUtils.mv(tmp.path, file)
+        return true unless changed
+
+        puts "modifying file: #{file}"
+        FT::MoveFileCommand.new(from: tmp.path, to: file).execute
+        true
+      end
+
+      def print_messages
+        manifest.messages.each do |chksum|
+          message = @files[chksum]
+          puts "\n#{message}"
+        end
+
+        true
       end
     end
   end