shaf 2.1.0 → 3.0.1

data/lib/shaf/api_doc/link_relations.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'tempfile'
-require 'uri'
-require 'csv'
-
-module Shaf
-  module ApiDoc
-    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 [](key)
-          relations[key]
-        end
-
-        def []=(key, value)
-          relations[key] = value
-        end
-
-        def add(link_relation)
-          relations[link_relation.name] = link_relation
-        end
-
-        def load_iana
-          csv.each do |name, desc, ref, notes|
-            next if name == 'Relation Name'
-            add LinkRelation.new(name, desc, ref, notes)
-          end
-        end
-
-        private
-
-        def relations
-          @relations ||= {}
-        end
-
-        def tmp_file_name
-          File.join(Dir.tmpdir, 'shaf_iana_link_relations')
-        end
-
-        def csv
-          if File.readable? tmp_file_name
-            content = File.read(tmp_file_name)
-            return CSV.new(content)
-          end
-
-          response = Net::HTTP.get_response(IANA_URL)
-
-          if response.code.to_i == 200
-            content = response.body
-            File.open(tmp_file_name, 'w') { |file| file.write(content) }
-            CSV.new(content)
-          else
-            Utils.iana_link_relations_csv
-          end
-        end
-      end
-    end
-  end
-end

data/lib/shaf/middleware.rb

@@ -1 +0,0 @@
-require 'shaf/middleware/request_id'

data/lib/shaf/tasks/api_doc_task.rb

@@ -1,146 +0,0 @@
-module Shaf
-  module Tasks
-    class ApiDocTask
-      include Rake::DSL
-
-      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
-        define_tasks
-      end
-
-      def validate_attributes!
-        raise "source_dir must be set!" unless source_dir
-        raise "html_output_dir must be configured in ApiDocTask" unless html_output_dir
-        raise "yaml_output_dir must be configured in ApiDocTask" unless yaml_output_dir
-      end
-
-      def define_tasks
-        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|
-                next unless doc.valid?
-                doc.write_html @html_output_dir
-                doc.write_yaml @yaml_output_dir
-              end
-            end
-          end
-
-          desc "Remove generated documentation"
-          task :clean do
-            [
-              Dir.glob(File.join(@yaml_output_dir, "*.yml")),
-              Dir.glob(File.join(@html_output_dir, "*.html"))
-            ].flatten.each do |file|
-              File.unlink file
-            end
-          end
-        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
-
-        File.readlines(file).each do |line|
-          next if empty_line?(line)
-
-          if c = comment(line)
-            comment << c
-            next
-          end
-
-          parse_line(line, doc, comment)
-          comment = ApiDoc::Comment.new
-        end
-
-        return doc unless block_given?
-        yield doc
-      end
-
-      def parse_line(line, doc, comment)
-        if model = model(line)
-          doc.model = model
-        elsif serializer_class = serializer_class(line)
-          doc.serializer_class = serializer_class
-        elsif policy = policy(line)
-          doc.policy = policy
-        elsif attr = attribute(line)
-          doc.attribute(attr, comment)
-        elsif rel = link(line)
-          doc.link(rel, comment)
-        elsif rel = curie(line)
-          doc.curie(rel, comment)
-        elsif name = embed(line)
-          doc.embedded(name, comment)
-        end
-      end
-
-      def empty_line?(line)
-        true if line[/\A[#\s*]*\Z/]
-      end
-
-      def serializer_class(line)
-        line[/\A\s*class\s*(\w+)\Z/, 1]
-      end
-
-      def model(line)
-        line[/\A\s*model\s*(?:::)?(\w+)/, 1]
-      end
-
-      def policy(line)
-        line[/\A\s*policy\s*(?:::)?(\w+)/, 1]
-      end
-
-      def comment(line)
-        line[/\A\s*#(.*)/, 1]
-      end
-
-      def attribute(line)
-        line[/\A\s*attribute\s+\(?:(\w+)/, 1]
-      end
-
-      def link(line)
-        line[/\A\s*link\s+\(?:?['"]?([-:\w]+)['"]?/, 1]
-      end
-
-      def curie(line)
-        line[/\A\s*curie\s+\(?:'?([-\w]+)'?/, 1]
-      end
-
-      def embed(line)
-        line[/\A\s*embed\s+\(?:'?([-:\w]+)'?/, 1]
-      end
-    end
-  end
-end