shaf 1.5.0 → 2.0.0

data/lib/shaf/extensions/symbolic_routes.rb

@@ -2,32 +2,35 @@ module Shaf
   module SymbolicRoutes
     class UriHelperNotRegisterdError < Error; end
 
-    SUPPORTED_METHODS = [
-      :get,
-      :put,
-      :post,
-      :patch,
-      :delete,
-      :head,
-      :options,
-      :link,
-      :unlink
-    ].freeze
-
-    SUPPORTED_METHODS.each do |m|
-      define_method m do |path, collection: false, &block|
-        super(rewrite_path(path, collection), &block)
+    Shaf::SUPPORTED_HTTP_METHODS.each do |m|
+      define_method m do |path, **options, &block|
+        collection = options.delete(:collection)
+        path = rewrite_path(path, collection, m)
+        super(path, **options, &block)
       end
     end
 
-    def rewrite_path(path, collection = nil)
+    def rewrite_path(path, collection, method)
       return path unless path.is_a? Symbol
 
-      m = "#{path}_template"
-      return send(m, collection) if respond_to? m
+      warn <<~DEPRECATION unless collection.nil?
+        Deprecated use of declaring route with collection keyword argument:
+        Use `#{method} :#{path.to_s.sub(/_(path|uri)/, '_collection_path')} do`
+        instead of `#{method} :#{path}, collection: #{collection} do`
+        #{caller.find { |s| s.match?(/_controller.rb/) }}
+
+      DEPRECATION
+
+      method = "#{path}_template"
+      send_args = [method]
+      send_args << collection unless collection.nil?
+      return send(*send_args) if respond_to? method
+
+      method = "#{path}_path_template"
+      return send(*send_args) if respond_to? method
 
       raise UriHelperNotRegisterdError, <<~RUBY
-        Undefined method '#{m}'. Did you forget to register a uri helper for #{path}?
+        Undefined method '#{method}'. Did you forget to register a uri helper for #{path}?
       RUBY
     end
   end

data/lib/shaf/formable.rb

@@ -18,9 +18,8 @@ module Shaf
     # Deprecated legacy way of specifying forms inside models
     def form(&block)
       forms_for(self, &block)
-      return unless defined? $logger
 
-      $logger.info <<~MSG
+      Shaf.log.info <<~MSG
 
 
         DEPRECATED method ::form in #{self}

data/lib/shaf/formable/form.rb

@@ -112,7 +112,7 @@ module Shaf
       end
 
       def submit_element
-        %Q(<div class="form--input-group"><input type="submit" class="button" value="Submit"</div>)
+        %Q(<div class="form--input-group"><input type="submit" class="button" value="#{submit}"</div>)
       end
     end
   end

data/lib/shaf/generator.rb

@@ -10,9 +10,11 @@ end
 
 require 'shaf/generator/base'
 require 'shaf/generator/controller'
+require 'shaf/generator/doc'
 require 'shaf/generator/forms'
 require 'shaf/generator/migration'
 require 'shaf/generator/model'
 require 'shaf/generator/policy'
 require 'shaf/generator/scaffold'
 require 'shaf/generator/serializer'
+require 'shaf/generator/profile'

data/lib/shaf/generator/base.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'erb'
+require 'file_transactions'
 require 'shaf/generator/helper'
 
 module Shaf
@@ -56,9 +57,7 @@ module Shaf
       end
 
       def write_output(file, content)
-        dir = File.dirname(file)
-        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
-        File.write(file, content)
+        FileTransactions::CreateFileCommand.execute(file) { content }
         puts "Added:      #{file}"
       end
     end

data/lib/shaf/generator/controller.rb

@@ -1,3 +1,5 @@
+require 'file_transactions'
+
 module Shaf
   module Generator
     class Controller < Base
@@ -81,15 +83,17 @@ module Shaf
         end
         added = false
         content = []
-        File.readlines(file).reverse_each do |line|
-          if match = !added && line.match(/^(\s*)link /)
-            content.unshift link_content(match[1].to_s)
-            added = true
+        FileTransactions::ChangeFileCommand.execute(file) do
+          File.readlines(file).reverse_each do |line|
+            if match = !added && line.match(/^(\s*)link /)
+              content.unshift link_content(match[1].to_s)
+              added = true
+            end
+            content.unshift(line)
           end
-          content.unshift(line)
+          File.open(file, 'w') { |f| f.puts content }
+          puts "Modified:   #{file}"
         end
-        File.open(file, 'w') { |f| f.puts content }
-        puts "Modified:   #{file}"
       end
 
       def link_content(indentation = '')

data/lib/shaf/generator/doc.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Generator
+    class Doc < Base
+      identifier %r{\Adoc(\b|umentation)\Z}
+      usage 'generate doc [SERIALIZER_NAME] [..]'
+
+      def call
+        require 'shaf/yard'
+        name = String(args[0]).strip
+        Shaf::Yard::Parser.call(name: name)
+        YARD::Templates::Engine.render(template: :api_doc, format: :html)
+      end
+    end
+  end
+end

data/lib/shaf/generator/forms.rb

@@ -33,6 +33,7 @@ module Shaf
 
       def create_forms
         content = render(template, opts)
+        # FIXME: Append if file exists!
         write_output(target, content)
       end
 

data/lib/shaf/generator/helper.rb

@@ -10,7 +10,8 @@ module Shaf
 
       def print(lines, indent_level = 2)
         strip_blank(lines).inject do |result, line|
-          result + "\n#{i(indent_level) unless line.empty?}#{line}"
+          indent = i(indent_level) unless line.empty?
+          result + "\n#{indent}#{line}"
         end.chomp
       end
 

data/lib/shaf/generator/migration/base.rb

@@ -42,9 +42,13 @@ module Shaf
 
         def column_def(str, create: true)
           _, col_type = str.split(':')
-          type = Type.find(col_type)
-          raise "No supported DB column types for: #{col_type}" unless type
-          type.build(str, create: create, alter: !create)
+          type = Types.find(col_type)
+          return type.build(str, create: create, alter: !create) if type
+
+          raise <<~ERR
+            No supported DB column types for: #{col_type}
+            Supported types: #{Types.all.map(&:name).join(', ')}
+          ERR
         end
 
         def target(name)

data/lib/shaf/generator/migration/type.rb

@@ -4,34 +4,12 @@ module Shaf
       class Type
         attr_reader :name, :create_template, :alter_template, :validator
 
-        class << self
-          def add(name, **kwargs)
-            new(name, **kwargs).tap do |type|
-              types[type.name] = type
-            end
-          end
-
-          def find(str)
-            name, _ = str.to_s.split(',', 2)
-            types[name.to_sym]
-          end
-
-          private
-
-          def types
-            @types ||= {}
-          end
-
-          def clear
-            @types.clear if defined? @types
-          end
-        end
-
         def initialize(str, create_template:, alter_template:, validator: nil)
           @name = str.downcase.to_sym
-          @create_template = create_template
-          @alter_template = alter_template
-          @validator = validator
+          @create_template = create_template.freeze
+          @alter_template = alter_template.freeze
+          @validator = validator.freeze
+          freeze
         end
 
         def build(str, create: false, alter: false)

data/lib/shaf/generator/migration/types.rb

@@ -3,22 +3,51 @@ require 'shaf/generator/migration/type'
 module Shaf
   module Generator
     module Migration
-      Type.add :integer,        create_template: 'Integer :%s',                 alter_template: 'add_column :%s, Integer'
-      Type.add :varchar,        create_template: 'String %s',                   alter_template: 'add_column :%s, String'
-      Type.add :string,         create_template: 'String :%s',                  alter_template: 'add_column :%s, String'
-      Type.add :text,           create_template: 'String :%s, text: true',      alter_template: 'add_column :%s, String, text: true'
-      Type.add :blob,           create_template: 'File :%s',                    alter_template: 'add_column :%s, File'
-      Type.add :bigint,         create_template: 'Bignum :%s',                  alter_template: 'add_column :%s, Bignum'
-      Type.add :double,         create_template: 'Float :%s',                   alter_template: 'add_column :%s, Float'
-      Type.add :numeric,        create_template: 'BigDecimal :%s',              alter_template: 'add_column :%s, BigDecimal'
-      Type.add :date,           create_template: 'Date :%s',                    alter_template: 'add_column :%s, Date'
-      Type.add :timestamp,      create_template: 'DateTime :%s',                alter_template: 'add_column :%s, DateTime'
-      Type.add :time,           create_template: 'Time :%s',                    alter_template: 'add_column :%s, Time'
-      Type.add :bool,           create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
-      Type.add :boolean,        create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
-      Type.add :index,          create_template: 'index :%s, unique: true',     alter_template: 'add_index :%s'
-
-      Type.add :foreign_key,
+      module Types
+        class << self
+          def add(name, **kwargs)
+            Type.new(name, **kwargs).tap do |type|
+              types[type.name] = type
+            end
+          end
+
+          def find(str)
+            name, _ = str.to_s.split(',', 2)
+            types[name.to_sym]
+          end
+
+          def all
+            types.values
+          end
+
+          private
+
+          def types
+            @types ||= {}
+          end
+
+          def clear
+            @types.clear if defined? @types
+          end
+        end
+      end
+
+      Types.add :integer,        create_template: 'Integer :%s',                 alter_template: 'add_column :%s, Integer'
+      Types.add :varchar,        create_template: 'String %s',                   alter_template: 'add_column :%s, String'
+      Types.add :string,         create_template: 'String :%s',                  alter_template: 'add_column :%s, String'
+      Types.add :text,           create_template: 'String :%s, text: true',      alter_template: 'add_column :%s, String, text: true'
+      Types.add :blob,           create_template: 'File :%s',                    alter_template: 'add_column :%s, File'
+      Types.add :bigint,         create_template: 'Bignum :%s',                  alter_template: 'add_column :%s, Bignum'
+      Types.add :double,         create_template: 'Float :%s',                   alter_template: 'add_column :%s, Float'
+      Types.add :numeric,        create_template: 'BigDecimal :%s',              alter_template: 'add_column :%s, BigDecimal'
+      Types.add :date,           create_template: 'Date :%s',                    alter_template: 'add_column :%s, Date'
+      Types.add :timestamp,      create_template: 'DateTime :%s',                alter_template: 'add_column :%s, DateTime'
+      Types.add :time,           create_template: 'Time :%s',                    alter_template: 'add_column :%s, Time'
+      Types.add :bool,           create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Types.add :boolean,        create_template: 'TrueClass :%s',               alter_template: 'add_column :%s, TrueClass'
+      Types.add :index,          create_template: 'index :%s, unique: true',     alter_template: 'add_index :%s'
+
+      Types.add :foreign_key,
         create_template: 'foreign_key :%s, :%s',
         alter_template: 'add_foreign_key :%s, :%s',
         validator: ->(type, *args) {

data/lib/shaf/generator/model.rb

@@ -52,8 +52,7 @@ module Shaf
       end
 
       def create_serializer
-        serializer_args = %W(serializer #{model_name})
-        serializer_args += args[1..-1].map { |arg| arg.split(':').first }
+        serializer_args = %W(serializer #{model_name}) + args[1..-1]
         Generator::Factory.create(*serializer_args, **options).call
       end
 

data/lib/shaf/generator/profile.rb

@@ -0,0 +1,52 @@
+module Shaf
+  module Generator
+    class Profile < Base
+      identifier :profile
+      usage 'generate profile NAME [attribute:type] [..]'
+
+      def call
+        create_profile
+      end
+
+      def profile_name
+        n = args.first || ""
+        return n unless n.empty?
+        raise Command::ArgumentError,
+          "Please provide a profile name when using the profile generator!"
+      end
+
+      def model_class_name
+        Utils::model_name(profile_name)
+      end
+
+      def template
+        'api/profile.rb'
+      end
+
+      def target
+        "api/profiles/#{profile_name}.rb"
+      end
+
+      def attributes
+        args[1..-1].map do |attr|
+          name, type = attr.split(':')
+          type ||= 'String'
+          [name, type.capitalize]
+        end
+      end
+
+      def create_profile
+        content = render(template, opts)
+        write_output(target, content)
+      end
+
+      def opts
+        {
+          profile_name: profile_name,
+          profile_class_name: "#{model_class_name}",
+          attributes: attributes,
+        }
+      end
+    end
+  end
+end

data/lib/shaf/generator/serializer.rb

@@ -2,12 +2,13 @@ module Shaf
   module Generator
     class Serializer < Base
       identifier :serializer
-      usage 'generate serializer MODEL_NAME [attribute] [..]'
+      usage 'generate serializer MODEL_NAME [attribute[:type]] [..]'
 
       def call
         create_serializer
         create_serializer_spec if options[:specs]
         create_policy
+        create_profile
       end
 
       def name
@@ -56,40 +57,33 @@ module Shaf
       end
 
       def attributes
-        args[1..-1].map { |attr| ":#{attr}" }
+        args[1..-1]
+      end
+
+      def attribute_names
+        attributes.map { |arg| arg.split(':').first }
       end
 
       def attributes_with_doc
-        attributes.map do |attr|
-          [
-            "# FIXME: Write documentation for attribute #{attr}",
-            "attribute #{attr}"
-          ]
-        end
+        attribute_names.map { |attr| ["attribute :#{attr}"] }
       end
 
-      def links
+      def link_relations
         %w(collection self edit-form doc:delete)
       end
 
-      def curies_with_doc
-        [
-          <<~EOS.split("\n")
-            # Auto generated doc:  
-            # Link to the documentation for a given relation of the #{name} resource.
-            # This link is templated, which means that {rel} must be replaced by the
-            # appropriate relation name.  
-            # Method: GET  
-            # Example:
-            # ```
-            # curl -H "Accept: application/hal+json" \\
-            #      /doc/#{name}/rels/delete
-            #```
-            curie :doc do
-              doc_curie_uri('#{name}')
-            end
-          EOS
-        ]
+      def profile_with_doc
+        doc = <<~DOC
+          # Adds a link to the '#{name}' profile and a curie. By default the
+          # curie prefix is 'doc', use the `curie_prefix` keyword argument to
+          # change this.
+          # Note: the target of the profile link and the curie will be set to
+          # `profile_uri('#{name}')` resp. `doc_curie_uri('#{name}')`. To
+          # create links for external profiles or curies, delete the next line
+          # and use `::link` and/or `::curie` instead.
+        DOC
+
+        doc.split("\n") << %Q(profile #{Utils.symbol_string(name)})
       end
 
       def links_with_doc
@@ -104,20 +98,14 @@ module Shaf
       def collection_link
         link(
           rel: "collection",
-          desc: "Link to the collection of all #{plural_name}. " \
-          "Send a POST request to this uri to create a new #{name}",
-          method: "GET or POST",
-          uri: "/#{plural_name}",
           uri_helper: "#{plural_name}_uri",
-          kwargs: ', embed_depth: 0'
+          kwargs: {embed_depth: 0}
         )
       end
 
       def self_link
         link(
           rel: "self",
-          desc: "Link to this #{name}",
-          uri: "/#{plural_name}/5",
           uri_helper: "#{name}_uri(resource)"
         )
       end
@@ -125,8 +113,6 @@ module Shaf
       def edit_link
         link(
           rel: "edit-form",
-          desc: "Link to a form to edit this resource",
-          uri: "/#{plural_name}/5/edit",
           uri_helper: "edit_#{name}_uri(resource)"
         )
       end
@@ -134,56 +120,30 @@ module Shaf
       def delete_link
         link(
           rel: "delete",
-          desc: "Link to delete this #{name}",
-          method: "DELETE",
-          uri: "/#{plural_name}/5",
           uri_helper: "#{name}_uri(resource)",
-          kwargs: ", curie: :doc"
+          kwargs: {curie: :doc}
         )
       end
 
       def create_link
         link(
           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:, kwargs: "")
+      def link(rel:, uri_helper:, kwargs: {})
+        kwargs_str = kwargs.inject('') do |s, (k,v)|
+          "#{s}, #{k}: #{Utils.symbol_or_quoted_string(v)}"
+        end
+
         <<~EOS.split("\n")
-          # Auto generated doc:  
-          # #{desc}.  
-          # Method: #{method}  
-          #{example(method, uri)}
-          link #{Utils.symbol_string(rel)}#{kwargs} do
+          link #{Utils.symbol_string(rel)}#{kwargs_str} do
             #{uri_helper}
           end
         EOS
       end
 
-      def example(method, uri)
-        curl_args = +'-H "Authorization: abcdef \\"'
-        case method
-        when "POST"
-          curl_args << "\n#      -d@payload \\"
-        when "PUT"
-          curl_args << "\n#      -X PUT -d@payload \\"
-        when "DELETE"
-          curl_args << "\n#      -X DELETE \\"
-        end
-
-        <<~EOS.chomp
-          # Example:
-          # ```
-          # curl -H "Accept: application/hal+json" \\
-          #      #{curl_args}
-          #      #{uri}
-          #```
-        EOS
-      end
-
       def collection_with_doc
         <<~EOS.split("\n")
           collection of: '#{plural_name}' do
@@ -204,19 +164,24 @@ module Shaf
           model_class_name: model_class_name,
           policy_class_name: policy_class_name,
           policy_name: "#{name}_policy",
-          attributes: attributes,
-          links: links,
+          attribute_names: attribute_names,
+          link_relations: link_relations,
+          profile_with_doc: profile_with_doc,
           attributes_with_doc: attributes_with_doc,
-          curies_with_doc: curies_with_doc,
           links_with_doc: links_with_doc,
           collection_with_doc: collection_with_doc
         }
       end
 
       def create_policy
-        policy_args = ["policy", name, *args[1..-1]]
+        policy_args = ["policy", name, *attribute_names]
         Generator::Factory.create(*policy_args, **options).call
       end
+
+      def create_profile
+        profile_args = ["profile", name, *attributes]
+        Generator::Factory.create(*profile_args, **options).call
+      end
     end
   end
 end