shaf 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef999e9f5ceac2a21b21e33ae805a6f576bc1363c6cbd4622cbbbdf715e8252
-  data.tar.gz: '0030305862359ea34e55516b2d49abcd78c20eb1393ae9d99eabcb86d1b30de4'
+  metadata.gz: 39c865a1b9a6d772f631b559f0cb82d170e22661ea7cbf0138cac2dcd41c8c94
+  data.tar.gz: 036cc7276471887b64083989a91760c4781c20ddddecd3b62bfd74f000b364a8
 SHA512:
-  metadata.gz: 3ac44a36ff0d58fce2e7fb58d9f85187dc75e1077cc801f5fcfd637738be364619c3ccbb3d5ea28b0cd46319f258d36a6047f4c22f53564487a4af8652569ffd
-  data.tar.gz: d4bddad299a6236d0930d861a2fdc054531f5892c29cc9c2f5c918066d6943c0aa888b9e2fa346a7733784f2311da5845c475632c4641949711a8f0784546d15
+  metadata.gz: b812af36d9a0d79c69ed73c68b84ddc056fe62f9c34086d183148a9f1f709e06cee65daa46942b09de95f81f60454ba54c502d04079d2dafaedbca1984138aae
+  data.tar.gz: '075085884194b73706e217760914aa7f5707f5f1960968d30b643c76c39801b054ac77b15d65c678a79f5f866a323d4f12cc49da134c036075e7d177fc34031f'

data/lib/shaf/extensions/resource_uris.rb

@@ -126,9 +126,9 @@ module Shaf
     end
 
     def call
-      if UriHelper.respond_to? method_name
+      if UriHelper.respond_to? uri_method_name
         raise "resource uri #{@name} can't be registered. " \
-          "Method :#{method_name} already exist!"
+          "Method :#{uri_method_name} already exist!"
       end
 
       if @alt_uri.nil?
@@ -141,24 +141,38 @@ module Shaf
     private
 
     def build_methods
-      UriHelperMethods.eval_method method_string
+      UriHelperMethods.eval_method uri_method_string
+      UriHelperMethods.eval_method path_method_string
       UriHelperMethods.register(template_method_name, &template_proc)
     end
 
     def build_methods_with_optional_arg
-      UriHelperMethods.eval_method method_with_optional_arg_string
+      UriHelperMethods.eval_method uri_method_with_optional_arg_string
+      UriHelperMethods.eval_method path_method_with_optional_arg_string
       UriHelperMethods.register(template_method_name, &template_proc)
     end
 
-    def method_name
+    def uri_method_name
       "#{@name}_uri".freeze
     end
 
+    def path_method_name
+      "#{@name}_path".freeze
+    end
+
     def template_method_name
-      "#{method_name}_template".freeze
+      "#{uri_method_name}_template".freeze
+    end
+
+    def uri_signature(optional_args: 0)
+      signature(uri_method_name, optional_args: optional_args)
+    end
+
+    def path_signature(optional_args: 0)
+      signature(path_method_name, optional_args: optional_args)
     end
 
-    def signature(optional_args: 0)
+    def signature(method_name, optional_args: 0)
       s = "#{method_name}("
 
       symbols = extract_symbols.size.times.map { |i| "arg#{i}" }
@@ -175,21 +189,30 @@ module Shaf
       s << (args.empty? ? "**query)" : "#{args.join(', ')}, **query)")
     end
 
-    def method_string
+    def uri_method_string
       base_uri = UriHelper.base_uri
       <<~Ruby
-        def #{signature}
+        def #{uri_signature}
           query_str = Shaf::MethodBuilder.query_string(query)
           \"#{base_uri}#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
         end
       Ruby
     end
 
-    def method_with_optional_arg_string
+    def path_method_string
+      <<~Ruby
+        def #{path_signature}
+          query_str = Shaf::MethodBuilder.query_string(query)
+          \"#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+        end
+      Ruby
+    end
+
+    def uri_method_with_optional_arg_string
       base_uri = UriHelper.base_uri
       arg_no = extract_symbols.size - 1
       <<~Ruby
-        def #{signature(optional_args: 1)}
+        def #{uri_signature(optional_args: 1)}
           query_str = Shaf::MethodBuilder.query_string(query)
           if arg#{arg_no}.nil?
             \"#{base_uri}#{interpolated_uri_string(@alt_uri)}\#{query_str}\".freeze
@@ -200,6 +223,20 @@ module Shaf
       Ruby
     end
 
+    def path_method_with_optional_arg_string
+      arg_no = extract_symbols.size - 1
+      <<~Ruby
+        def #{path_signature(optional_args: 1)}
+          query_str = Shaf::MethodBuilder.query_string(query)
+          if arg#{arg_no}.nil?
+            \"#{interpolated_uri_string(@alt_uri)}\#{query_str}\".freeze
+          else
+            \"#{interpolated_uri_string(@uri)}\#{query_str}\".freeze
+          end
+        end
+      Ruby
+    end
+
     def extract_symbols(uri = @uri)
       uri.split('/').grep(/:.*/).map { |t| t[1..-1].to_sym }
     end

data/lib/shaf/generator/serializer.rb

@@ -140,6 +140,15 @@ module Shaf
         )
       end
 
+      def create_link
+        link(
+          rel: "doc:create-form",
+          desc: "Link to a form used to create new #{name} resources",
+          uri: "new_#{name}_uri",
+          uri_helper: "new_#{name}_uri"
+        )
+      end
+
       def link(rel:, method: "GET", desc:, uri:, uri_helper:)
         <<~EOS.split("\n")
           # Auto generated doc:  
@@ -178,6 +187,8 @@ module Shaf
           collection of: '#{plural_name}' do
             link :self, #{plural_name}_uri
             link :up, root_uri
+
+            #{create_link.join("\n  ")}
             link :'doc:create-form', new_#{name}_uri
             curie(:doc) { doc_curie_uri('#{name}') }
           end

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/templates/api/controllers/docs_controller.rb

@@ -3,12 +3,12 @@ class DocsController < BaseController
   register_uri :doc_curie,      '/doc/:resource/rels/{rel}'
   register_uri :documentation,  '/doc/:resource'
 
-  get doc_curie_uri_template do
+  get :doc_curie_uri do
     cache_control(:private, http_cache_max_age: :long)
     doc.link(params[:rel])
   end
 
-  get documentation_uri_template do
+  get :documentation_uri do
     cache_control(:private, http_cache_max_age: :long)
     doc.to_s
   end

data/templates/config/directories.rb

@@ -4,20 +4,36 @@ $:.unshift APP_DIR
 
 def sort_files(files)
   files.sort_by do |file|
-    case file
-    when /\Alib/
-      0
-    when /\Ahelpers/
-      1
-    when /\Amodels/
-      2
-    when /\Acontrollers/
-      3
-    when /\Apolicies/
-      4
-    else
-      5
-    end
+    directory_priority(file) + file_priority(file)
+  end
+end
+
+def directory_priority(file)
+  case file
+  when /\Alib/
+    0
+  when /\Ahelpers/
+    10
+  when /\Amodels/
+    20
+  when /\Apolicies/
+    30
+  when /\Acontrollers/
+    40
+  when /\Aserializers/
+    50
+  else
+    60
+  end
+end
+
+
+def file_priority(file)
+  case File.basename(file)
+  when /\Abase[\._]/
+    0
+  else
+    9
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake