shaf 1.5.1 → 2.1.0

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|
@@ -155,35 +166,38 @@ module Shaf
       end
 
       def apply_patches(dir = nil)
-        files_in(dir).all? do |file|
-          @manifest.patches_for(file).all? do |name|
+        files_in(dir).map do |file|
+          manifest.patches_for(file).map do |name|
             patch = @files[name]
             apply_patch(file, patch)
-          end
-        end
+          end.all?
+        end.all?
       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?
-          t.value.success?.tap do |patch_succeeded|
-            next if patch_succeeded
-            STDERR.puts "Failed to apply patch for: #{file}\n"
+        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"
@@ -192,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"
@@ -205,14 +219,14 @@ module Shaf
       end
 
       def apply_substitutes(dir = nil)
-        puts '' unless @manifest.regexps.empty?
-        files_in(dir).all? do |file|
-          @manifest.regexps_for(file).all? do |name|
+        puts '' unless manifest.regexps.empty?
+        files_in(dir).map do |file|
+          manifest.regexps_for(file).map do |name|
             params = YAML.safe_load(@files[name])
             params.transform_keys!(&:to_sym)
             apply_substitute(file, params)
-          end
-        end
+          end.all?
+        end.all?
       end
 
       def apply_substitute(file, params)
@@ -221,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

data/lib/shaf/upgrade/version.rb

@@ -8,7 +8,7 @@ module Shaf
       alias eql? ==
 
       class UpgradeVersionError < StandardError
-        def initialize(message = "")
+        def initialize(message = '')
           super("Bad upgrade version: #{message}")
         end
       end
@@ -16,25 +16,26 @@ module Shaf
       def initialize(version)
         case version
         when Version
-          @major, @minor, @patch = [:major, :minor, :patch].map { |m| version.send m }
+          @major, @minor, @patch = version.to_a
         when /\d+\.\d+(\.\d+)?/
           @major, @minor, @patch = split_version(version)
         else
-          raise UpgradeVersionError.new(version)
+          raise UpgradeVersionError, version
         end
       end
 
       def <=>(other)
-        case other
-        when String
-          compare_version(*split_version(other))
-        when Version
-          compare_version(other.major, other.minor, other.patch)
-        end
+        return unless other
+        other = self.class.new(other)
+        compare_version(other.major, other.minor, other.patch)
       end
 
       def to_s
-        [major, minor, patch].join('.')
+        to_a.join('.')
+      end
+
+      def to_a
+        [major, minor, patch]
       end
 
       private

data/lib/shaf/utils.rb

@@ -3,6 +3,8 @@
 require 'erb'
 require 'forwardable'
 require 'yaml'
+require 'csv'
+require 'zlib'
 require 'shaf/version'
 
 module Shaf
@@ -35,12 +37,19 @@ module Shaf
         noun[0..-2]
       end
 
-      def symbolize(str)
-        :"#{str}"
+      def symbol_string(str)
+        str.to_sym.inspect
       end
 
-      def symbol_string(str)
-        symbolize(str).inspect
+      def symbol_or_quoted_string(obj)
+        case obj
+        when Symbol
+          obj.inspect
+        when Numeric
+          obj
+        else
+          "'#{obj.to_s}'"
+        end
       end
 
       def environment
@@ -98,6 +107,11 @@ module Shaf
         end
       end
 
+      def iana_link_relations_csv
+        zip_file = File.join(gem_root, 'iana_link_relations.csv.gz')
+        Zlib::GzipReader.open(zip_file) { |content| CSV.new(content.read) }
+      end
+
       private
 
       def erb(content, binding: nil)
@@ -107,7 +121,7 @@ module Shaf
       end
     end
 
-    def_delegators Utils, :pluralize, :singularize, :symbolize, :symbol_string, :gem_root, :rackify_header
+    def_delegators Utils, :pluralize, :singularize, :symbol_string, :gem_root, :rackify_header
 
     def project_root
       return @project_root if defined? @project_root

data/lib/shaf/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shaf
-  VERSION = "1.5.1"
+  VERSION = '2.1.0'
 end

data/lib/shaf/yard.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'yard'
+require 'shaf/yard/serializer_handler'
+require 'shaf/yard/attribute_method_handler'
+require 'shaf/yard/link_method_handler'
+require 'shaf/yard/profile_method_handler'
+require 'shaf/yard/resource_object'
+require 'shaf/yard/profile_object'
+require 'shaf/yard/attribute_object'
+require 'shaf/yard/link_object'
+require 'shaf/yard/nested_attributes'
+require 'shaf/yard/parser'
+
+module Shaf
+  module Yard
+    CUSTOM_TAGS = [
+      ['Request Header', :request_header, :with_name],
+      ['Reponse Header', :response_header, :with_name],
+      ['Example Request', :example_request],
+      ['Example Response', :example_response],
+      ['Description', :description],
+      ['HTTP method', :http_method],
+      ['Attribute type', :type, :with_types]
+    ].freeze
+
+    CUSTOM_TAGS.each do |tag|
+      YARD::Tags::Library.define_tag(*tag)
+    end
+
+    TEMPLATE_PATH = File.join(Utils.gem_root, 'yard_templates').freeze
+    YARD::Templates::Engine.register_template_path TEMPLATE_PATH
+  end
+end

data/lib/shaf/yard/attribute_method_handler.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'shaf/yard/base_method_handler'
+
+module Shaf
+  module Yard
+    # Handles call to Shaf::Serializer::attribute
+    class AttributeMethodHandler < BaseMethodHandler
+      handles method_call(:attribute)
+
+      def object
+        AttributeObject.new(serializer_namespace, name).tap do |attr|
+          attr.dynamic = true
+          attr.name = name
+        end
+      end
+    end
+  end
+end

data/lib/shaf/yard/attribute_object.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    class AttributeObject < ::YARD::CodeObjects::Base
+      attr_accessor :name
+
+      def documentation
+        profile_doc || 'Not documented'
+      end
+
+      def profile
+        return unless namespace.respond_to? :profile
+        @profile ||= namespace.profile
+      end
+
+      def value_types
+        Array(descriptor&.type).compact.map(&:to_s)
+      end
+
+      def profile_doc
+        descriptor&.doc
+      end
+
+      def descriptor
+        profile&.find_attribute(name)
+      end
+    end
+  end
+end

data/lib/shaf/yard/base_method_handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Yard
+    class BaseMethodHandler < ::YARD::Handlers::Ruby::Base
+      namespace_only
+
+      def process
+        return unless serializer_namespace
+
+        register object
+      end
+
+      def name
+        call_params.first.yield_self do |name|
+          # remove single colon. Sometimes symbols get the :, (e.g. :self)
+          name.sub(/\A:(?!:)/, '')
+        end
+      end
+
+      def object
+        raise NotImplementedError, "#{self} must implement #object"
+      end
+
+      def serializer_namespace
+        @serializer_namespace ||= YARD::Registry.at ResourceObject.path(namespace)
+      end
+    end
+  end
+end