shaf 2.1.0 → 3.0.0

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shaf
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -29,7 +29,7 @@ cert_chain:
   5ZlcHq9h5CxVt380OKaU6wMg95RJBd/kUJqmPxxlxMH8QDQinTwZmmFA9wW7PJdy
   wAx8px9LkSjTs0GVLH7VtVRWAELllsswCJktz63Adelx9fmIMgrTYgZM
   -----END CERTIFICATE-----
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: file_transactions
@@ -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
@@ -308,7 +305,6 @@ files:
 - lib/shaf/helpers/vary.rb
 - lib/shaf/immutable_attr.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 +348,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 +392,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 +418,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
@@ -476,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Sinatra Hypermedia Api Framework

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

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