shaf 1.6.0 → 3.0.0

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/extensions/current_user.rb

@@ -1,48 +0,0 @@
-require 'digest'
-
-module Shaf
-  module CurrentUser
-    def self.registered(settings)
-      return unless settings.respond_to?(:current_user) && settings.current_user
-
-      settings.log.info 'Using Shaf::CurrentUser'
-      settings.helpers Helpers
-    end
-
-    def self.digest(token)
-      Digest::SHA256.hexdigest(token) if token
-    end
-  end
-
-  module Helpers
-    ERR_MSG = 'The default Shaf implementation of #current_user requires a ' \
-      'User model with a column auth_token_digest'.freeze
-
-    def auth_token
-      header = Utils.rackify_header(settings.auth_token_header)
-      request.env[header]
-    end
-
-    def current_user
-      return @current_user if defined?(@current_user)
-
-      return unless check_user_model
-      digest = Shaf::CurrentUser.digest(auth_token) || return
-      @current_user = User.where(auth_token_digest: digest).first
-    end
-
-    def authenticated?
-      !current_user.nil?
-    end
-
-    def authenticate!
-      authenticated? || raise(Shaf::Errors::UnauthorizedError)
-    end
-
-    def check_user_model
-      return true if defined?(User) && User.columns.include?(:auth_token_digest)
-      log.warn ERR_MSG
-      false
-    end
-  end
-end

data/lib/shaf/middleware.rb

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

data/lib/shaf/responder/hal_serializable.rb

@@ -1,64 +0,0 @@
-require 'hal_presenter'
-require 'shaf/errors'
-
-module Shaf
-  module Responder
-    module HalSerializable
-      def lookup_rel(rel, response)
-        hal = response.serialized_hash
-        links = hal&.dig(:_links, rel.to_sym)
-        return [] unless links
-
-        links = [links] unless links.is_a? Array
-        links.map do |link|
-          {
-            href: link[:href],
-            as: 'fetch',
-            crossorigin: 'anonymous'
-          }
-        end
-      end
-
-      def collection?
-        !!options.fetch(:collection, false)
-      end
-
-      def serializer
-        @serializer ||= options[:serializer] || HALPresenter.lookup_presenter(resource)
-      end
-
-      def serialized_hash
-        return {} unless serializer
-
-        @serialized_hash ||=
-          if collection?
-            serializer.to_collection(resource, current_user: user, as_hash: true, **options)
-          else
-            serializer.to_hal(resource, current_user: user, as_hash: true, **options)
-          end
-
-        # hal_presenter versions before v1.5.0 does not understand the :as_hash
-        # keyword argument and will always return a String from
-        # to_hal/to_collection, thus we need to parse it if its a String.
-        if @serialized_hash.is_a? String
-          @body = @serialized_hash
-          @serialized_hash = JSON.parse(@serialized_hash, symbolize_names: true)
-        end
-
-        @serialized_hash
-      end
-
-      def profile
-        @profile ||= options[:profile]
-        return unless @profile || serializer
-
-        @profile ||= serializer.semantic_profile
-      end
-
-      def generate_json
-        # FIXME: change to Oj??
-        JSON.generate(serialized_hash)
-      end
-    end
-  end
-end

data/lib/shaf/tasks/api_doc_task.rb

@@ -1,125 +0,0 @@
-require 'shaf/api_doc/document'
-require 'shaf/api_doc/comment'
-
-module Shaf
-  module Tasks
-    class ApiDocTask
-      include Rake::DSL
-
-      attr_accessor :document_class, :source_dir, :html_output_dir, :yaml_output_dir
-
-      def initialize
-        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
-            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 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