shaf 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80966929b3dbd95660efc1734f58af69073d1fe2d52279ebd167e6f94e57084c
-  data.tar.gz: ffbeb725dbb8442a589c6dc50129e19207145f0d159284e4a4f09e04ad995cf0
+  metadata.gz: 319f7f6a1725c5e3e5d9ab293531dc72cced237cf5967d2beb3ef3f47c5be8e7
+  data.tar.gz: 4f37d5e9c0424c31c6dda4ec2c5e628920963d01dd61d367681504cd6f50f0e0
 SHA512:
-  metadata.gz: abdc53f555ca5143ed1d7cd8aa475910ae19c4d285104cfa5f576f4b53e4fe6d2666978dbd7158b7440cfaab6ae07ff53a939ce098f6140d68ad070d8558a3b3
-  data.tar.gz: e881b178f16a2938e5e65163e21c0dcf3a83e714e284bc7c7bff596277681f1059bd47f405a9a0709eea6169bd35caf39fe9aa34b34911b2954c96c09e92b12f
+  metadata.gz: 3431790d086472d8cbac8ec9e51ed8fb02ddc4a402ec993a5ed7d17ea1eb048e89902693b3c4c3f88a3630c226fddc175dd4c0024136cac4adb43cd4d2869531
+  data.tar.gz: 004321671f62d6578e35c42ed1a1b3b1345bc9308743710dc5cc645195303af8235e30d4288ec6f8048c3ad7ab04ca6087912d27ea983b5ecc45768b997b6347

checksums.yaml.gz.sig

@@ -1 +1,4 @@
-V�A�͑���,\Z�U�!�^ϸlpw:ٶAF�#4��iH�8���S��I�?c"r��p��vB�.��{�y�%6���%�M7�4�k[zkG���q�YРb���:T"�v����H���-�KWv��Z@�_`mh����� 8��^�*O���]QU]kl���1#j�vΑl�������R�]dΜ�=>zī0��E��'	�������KN3�^qQ3�p"��@�&=�������=�x�o�iN�8�I�:H��
+x��=����3.��
+p?�2,x�)���F#�
+
+OWO���א�ൠ4T�pDkZ�|ߌJ�;��,�ZgB|i:�8���l�y��Ԣ\u�.Ԛ]%D��,zy���Pr�<���B+���XC�p�,yޝԒ�wM�1�<x�
M�KvK�H�VӤ��iC<;e�F��0#�G]3r�;{X�͕)<�Gң���I�

data/lib/shaf.rb

@@ -7,5 +7,5 @@ require 'shaf/errors'
 require 'shaf/formable'
 require 'shaf/extensions'
 require 'shaf/helpers'
-require 'shaf/doc_model'
+require 'shaf/resource_doc'
 require 'shaf/upgrade'

data/lib/shaf/api_doc/document.rb

@@ -40,7 +40,7 @@ module Shaf
         @embeds[strip_curie(name)] = comment unless comment.empty?
       end
 
-      def has_enough_info?
+      def valid?
         return false unless model
         attributes.merge(links).merge(curies).any?
       end
@@ -70,12 +70,17 @@ module Shaf
         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.
-        options = {autolink: true, fenced_code_blocks: true}
-        markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, options)
-        html = markdown.render(generate_markdown!)
         html.gsub!("<code>", "<pre><code>")
         html.gsub!("</code>", "</code></pre>")
         html
@@ -103,26 +108,26 @@ module Shaf
       end
 
       def generate_title!
-        @md[:doc] = "##%s\n" % model.capitalize
+        @md[:doc] = "# #{model.capitalize}\n"
         @md[:title] = model.capitalize
       end
 
       def generate_policy!
         return if policy.nil?
-        @md[:doc] << "###Policy\n#{policy}\n"
+        @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[: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?
+          sub_title += ": " unless sub_title.empty?
           list.each do |name, comment|
-            @md[:doc] << "#######{sub_title}#{name.tr('_', '-')}\n#{comment.to_s}\n"
+            @md[:doc] << "- *#{sub_title}#{name.tr('_', '-')}*\n  #{comment.to_s.gsub("\n", "\n  ")}\n\n"
             @md[key][name] = comment.to_s.chomp
           end
         end

data/lib/shaf/command/upgrade.rb

@@ -24,10 +24,23 @@ module Shaf
 
       def call
         in_project_root do
-          upgrade_packages.each { |package| apply(package) }
+          upgrade_packages.each do |package|
+            next if skip? package
+
+            if package.version == current_failed_version
+              print_previous_failed_warning package.version
+            else
+              apply!(package)
+            end
+
+            write_shaf_version(package.version)
+          end
+
           puts "\nProject is up-to-date! Shaf version: #{current_version}"
         end
       rescue UpgradeFailedError => e
+        write_shaf_upgrade_failure e.version
+
         puts <<~ERR
         
           Failed to upgrade project to version #{e.version}
@@ -35,13 +48,12 @@ module Shaf
           For more info see:
           https://github.com/sammyhenningsson/shaf/blob/master/doc/UPGRADE.md
         ERR
+
+        raise
       end
 
-      def apply(package)
-        unless skip? package
-          package.load.apply or raise UpgradeFailedError.new(package.version)
-        end
-        write_shaf_version package.version.to_s
+      def apply!(package)
+        package.load.apply or raise UpgradeFailedError.new(package.version)
       rescue Errno::ENOENT
         raise UpgradeFailedError,
           "Failed to execute system command 'patch'. Make sure that 'patch' installed!" \
@@ -70,6 +82,19 @@ module Shaf
       def target_version
         Shaf::Upgrade::Version.new(ENV.fetch('UPGRADE_TARGET', '99.9.9'))
       end
+
+      def current_failed_version
+        version = read_shaf_upgrade_failure_version
+        Shaf::Upgrade::Version.new(version) if version
+      end
+
+      def print_previous_failed_warning(version)
+        puts <<~MSG
+          Previous upgrade to version #{version} failed!
+          Assuming all files has been fixed manually and continuing with
+          upgrade.
+        MSG
+      end
     end
   end
 end

data/lib/shaf/generator/serializer.rb

@@ -69,7 +69,7 @@ module Shaf
       end
 
       def links
-        %w(collection self doc:edit-form doc:delete)
+        %w(collection self edit-form doc:delete)
       end
 
       def curies_with_doc
@@ -108,7 +108,8 @@ module Shaf
           "Send a POST request to this uri to create a new #{name}",
           method: "GET or POST",
           uri: "/#{plural_name}",
-          uri_helper: "#{plural_name}_uri"
+          uri_helper: "#{plural_name}_uri",
+          kwargs: ', embed_depth: 0'
         )
       end
 
@@ -123,7 +124,7 @@ module Shaf
 
       def edit_link
         link(
-          rel: "doc:edit-form",
+          rel: "edit-form",
           desc: "Link to a form to edit this resource",
           uri: "/#{plural_name}/5/edit",
           uri_helper: "edit_#{name}_uri(resource)"
@@ -132,30 +133,31 @@ module Shaf
 
       def delete_link
         link(
-          rel: "doc:delete",
+          rel: "delete",
           desc: "Link to delete this #{name}",
           method: "DELETE",
           uri: "/#{plural_name}/5",
-          uri_helper: "#{name}_uri(resource)"
+          uri_helper: "#{name}_uri(resource)",
+          kwargs: ", curie: :doc"
         )
       end
 
       def create_link
         link(
-          rel: "doc:create-form",
+          rel: "create-form",
           desc: "Link to a form used to create new #{name} resources",
           uri: "/#{plural_name}/form",
           uri_helper: "new_#{name}_uri"
         )
       end
 
-      def link(rel:, method: "GET", desc:, uri:, uri_helper:)
+      def link(rel:, method: "GET", desc:, uri:, uri_helper:, kwargs: "")
         <<~EOS.split("\n")
           # Auto generated doc:  
           # #{desc}.  
           # Method: #{method}  
           #{example(method, uri)}
-          link #{Utils.symbol_string(rel)} do
+          link #{Utils.symbol_string(rel)}#{kwargs} do
             #{uri_helper}
           end
         EOS
@@ -188,7 +190,7 @@ module Shaf
             curie(:doc) { doc_curie_uri('#{name}') }
 
             link :self, #{plural_name}_uri
-            link :'doc:up', root_uri
+            link :up, root_uri
 
             #{create_link.join("\n  ")}
           end

data/lib/shaf/generator/templates/spec/integration_spec.rb.erb

@@ -34,8 +34,8 @@ describe <%= model_class_name %>, type: :integration do
   it "can create <%= plural_name %>" do
     get <%= plural_name %>_uri
 
-    _(link_rels).must_include(:'doc:create-form')
-    follow_rel :'doc:create-form'
+    _(link_rels).must_include(:'create-form')
+    follow_rel :'create-form'
     _(links[:self][:href]).must_equal new_<%= name %>_uri
     _(attributes[:href]).must_equal <%= plural_name %>_uri
     _(attributes[:method]).must_equal "POST"
@@ -72,8 +72,8 @@ describe <%= model_class_name %>, type: :integration do
     get <%= name %>_uri(<%= name %>)
     _(status).must_equal 200
 
-    _(link_rels).must_include(:'doc:edit-form')
-    follow_rel :'doc:edit-form'
+    _(link_rels).must_include(:'edit-form')
+    follow_rel :'edit-form'
 
     _(links[:self][:href]).must_equal edit_<%= name %>_uri(<%= name %>)
     _(attributes[:href]).must_equal <%= name %>_uri(<%= name %>)

data/lib/shaf/resource_doc.rb

@@ -0,0 +1,70 @@
+require 'yaml'
+
+module Shaf
+  class ResourceDoc
+    class << self
+      def find(name)
+        unless docs[name]
+          properties = load(name) or return
+          docs[name] = new(name, properties)
+        end
+        docs[name]
+      end
+
+      def find!(name)
+        find(name) or raise(Errors::NotFoundError, "No documentation for #{name}")
+      end
+
+      private
+
+      def docs
+        @docs ||= {}
+      end
+
+      def load(name)
+        file = File.join(Settings.documents_dir, "#{name}.yml")
+        return YAML.load(File.read(file)) if File.exist? file
+      end
+    end
+    
+    attr_reader :name, :attributes, :links, :curies, :embeds
+
+    def initialize(name, properties = {})
+      @name       = name
+      @attributes = properties.fetch('attributes', {})
+      @links      = properties.fetch('links', {})
+      @curies     = properties.fetch('curies', {})
+      @embeds     = properties.fetch('embeds', {})
+    end
+
+    def to_s
+      JSON.pretty_generate(
+        attributes: attributes,
+        links: links,
+        curies: curies,
+        embeds: embeds,
+      )
+    end
+
+    def attribute(attr)
+      attr_doc = attributes[attr.to_s]
+      return attr_doc if attr_doc
+      raise Errors::NotFoundError,
+        "No documentation for #{name} attribute '#{attr}'"
+    end
+
+    def link(rel)
+      link_doc = links[rel.to_s]
+      return link_doc if link_doc
+      raise Errors::NotFoundError,
+        "No documentation for #{name} link relation '#{rel}'"
+    end
+
+    def embedded(name)
+      embed_doc = embeds[name.to_s]
+      return embed_doc if embed_doc
+      raise Errors::NotFoundError,
+        "No documentation for #{name} embedded '#{name}'"
+    end
+  end
+end

data/lib/shaf/tasks/api_doc_task.rb

@@ -28,7 +28,7 @@ module Shaf
             files = Dir.glob(File.join(source_dir, "*.rb"))
             files.each do |file|
               read_file file do |doc|
-                next unless doc.has_enough_info?
+                next unless doc.valid?
                 doc.write_html @html_output_dir
                 doc.write_yaml @yaml_output_dir
               end
@@ -106,19 +106,19 @@ module Shaf
       end
 
       def attribute(line)
-        line[/\A\s*attribute[^s]\s*\(?:(\w+)/, 1]
+        line[/\A\s*attribute\s+\(?:(\w+)/, 1]
       end
 
       def link(line)
-        line[/\A\s*link\s*\(?:?['"]?([-:\w]+)['"]?/, 1]
+        line[/\A\s*link\s+\(?:?['"]?([-:\w]+)['"]?/, 1]
       end
 
       def curie(line)
-        line[/\A\s*curie\s*\(?:'?([-\w]+)'?/, 1]
+        line[/\A\s*curie\s+\(?:'?([-\w]+)'?/, 1]
       end
 
       def embed(line)
-        line[/\A\s*embed\s*\(?:'?([-:\w]+)'?/, 1]
+        line[/\A\s*embed\s+\(?:'?([-:\w]+)'?/, 1]
       end
     end
   end

data/lib/shaf/upgrade/package.rb

@@ -77,7 +77,7 @@ module Shaf
       end
 
       def apply(dir = nil)
-        puts "Applying changes for version #{version}" if ENV["VERBOSE"] == "1"
+        puts "Applying changes for version #{version}"
         [
           apply_patches(dir),
           apply_drops(dir),

data/lib/shaf/upgrade/version.rb

@@ -25,9 +25,10 @@ module Shaf
       end
 
       def <=>(other)
-        if other.is_a? String
+        case other
+        when String
           compare_version(*split_version(other))
-        else
+        when Version
           compare_version(other.major, other.minor, other.patch)
         end
       end

data/lib/shaf/utils.rb

@@ -159,7 +159,10 @@ module Shaf
     end
 
     def write_shaf_file(data = {})
-      data = read_shaf_file.merge(data)
+      write_shaf_file! read_shaf_file.merge(data)
+    end
+
+    def write_shaf_file!(data = {})
       File.write SHAF_VERSION_FILE,
         YAML.dump(data)
     end
@@ -168,8 +171,19 @@ module Shaf
       read_shaf_file['version']
     end
 
+    def read_shaf_upgrade_failure_version
+      read_shaf_file['failed_upgrade']
+    end
+
     def write_shaf_version(version = nil)
-      write_shaf_file('version' => version || Shaf::VERSION)
+      version ||= Shaf::VERSION
+      data = read_shaf_file.merge('version' => version.to_s)
+      data.delete('failed_upgrade')
+      write_shaf_file! data
+    end
+
+    def write_shaf_upgrade_failure(version)
+      write_shaf_file 'failed_upgrade' => version.to_s
     end
   end
 end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/templates/api/controllers/docs_controller.rb

@@ -3,17 +3,19 @@ class DocsController < BaseController
   register_uri :doc_curie,      '/doc/:resource/rels/{rel}'
   register_uri :documentation,  '/doc/:resource'
 
-  get :doc_curie_uri do
+  before_action do
     cache_control(:private, http_cache_max_age: :long)
-    doc.link(params[:rel])
   end
 
-  get :documentation_uri do
-    cache_control(:private, http_cache_max_age: :long)
-    doc.to_s
+  get :doc_curie_path do
+    respond_with doc, path: request.path_info, rel: params[:rel]
+  end
+
+  get :documentation_path do
+    respond_with doc, path: request.path_info
   end
 
   def doc
-    Shaf::DocModel.find!(params[:resource])
+    Shaf::ResourceDoc.find!(params[:resource])
   end
 end

data/templates/api/serializers/documentation_serializer.rb

@@ -0,0 +1,24 @@
+class DocumentationSerializer < BaseSerializer
+  model Shaf::ResourceDoc
+
+  link :self do
+    options[:path]
+  end
+
+  link :up do
+    next unless options[:rel] || options[:attribute]
+    documentation_path(resource.name)
+  end
+
+  post_serialize do |hash|
+    if rel = options[:rel]
+      hash[rel] = resource.link(rel)
+    elsif attr = options[:attribute]
+      hash[attr] = resource.attribute(attr)
+    else
+      hash[:attributes] = resource.attributes
+      hash[:rels] = resource.links
+      hash[:embeds] = resource.embeds
+    end
+  end
+end

data/templates/frontend/views/layout.erb

@@ -2,7 +2,7 @@
 <html>
   <head>
     <meta charset="UTF-8">
-    <title>Shaba<%= @page_title && " | #{@page_title}" %></title>
+    <title>Shaf API<%= @page_title && " | #{@page_title}" %></title>
     <link rel="stylesheet" type="text/css" href="/css/main.css">
   </head>
   <body>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-10-04 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -161,7 +161,6 @@ files:
 - lib/shaf/command/test/runner.rb
 - lib/shaf/command/upgrade.rb
 - lib/shaf/command/version.rb
-- lib/shaf/doc_model.rb
 - lib/shaf/errors.rb
 - lib/shaf/extensions.rb
 - lib/shaf/extensions/authorize.rb
@@ -213,6 +212,7 @@ files:
 - lib/shaf/rake/db.rb
 - lib/shaf/rake/test.rb
 - lib/shaf/registrable_factory.rb
+- lib/shaf/resource_doc.rb
 - lib/shaf/router.rb
 - lib/shaf/settings.rb
 - lib/shaf/spec.rb
@@ -244,6 +244,7 @@ files:
 - templates/api/controllers/root_controller.rb
 - templates/api/policies/base_policy.rb
 - templates/api/serializers/base_serializer.rb
+- templates/api/serializers/documentation_serializer.rb
 - templates/api/serializers/error_serializer.rb
 - templates/api/serializers/form_serializer.rb
 - templates/api/serializers/root_serializer.rb
@@ -271,12 +272,14 @@ files:
 - templates/spec/spec_helper.rb
 - upgrades/0.4.0.tar.gz
 - upgrades/0.5.0.tar.gz
+- upgrades/0.5.1.tar.gz
 - upgrades/0.6.0.tar.gz
 - upgrades/1.0.0.tar.gz
 - upgrades/1.0.4.tar.gz
 - upgrades/1.1.0.tar.gz
 - upgrades/1.2.0.tar.gz
 - upgrades/1.2.1.tar.gz
+- upgrades/1.3.0.tar.gz
 homepage: 
 licenses:
 - MIT

data/lib/shaf/doc_model.rb

@@ -1,54 +0,0 @@
-require 'yaml'
-
-module Shaf
-  class DocModel
-    class << self
-      def find(name)
-        @@docs ||= {}
-        @@docs[name] ||= load(name)
-        new(name) if @@docs[name]
-      end
-
-      def find!(name)
-        find(name) or raise(Errors::NotFoundError, "No documentation for #{name}")
-      end
-
-      private
-
-      def load(name)
-        file = File.join(Settings.documents_dir, "#{name}.yml")
-        return YAML.load(File.read(file)) if File.exist? file
-      end
-    end
-
-    def initialize(name)
-      @name = name
-    end
-
-    def to_s
-      return "#{@name} not found" unless @@docs[@name]
-      JSON.pretty_generate(@@docs[@name])
-    end
-
-    def attribute(attr)
-      attr_doc = @@docs.dig(@name, 'attributes', attr.to_s)
-      return attr_doc if attr_doc
-      raise Errors::NotFoundError,
-        "No documentation for #{@name} attribute '#{attr}'"
-    end
-
-    def link(rel)
-      link_doc = @@docs.dig(@name, 'links', rel.to_s)
-      return link_doc if link_doc
-      raise Errors::NotFoundError,
-        "No documentation for #{@name} link relation '#{rel}'"
-    end
-
-    def embedded(name)
-      embed_doc = @@docs.dig(@name, 'embeds', name.to_s)
-      return embed_doc if embed_doc
-      raise Errors::NotFoundError,
-        "No documentation for #{@name} embedded '#{name}'"
-    end
-  end
-end