shaf 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9eb918ad2c43059ac408c1bd9d85e41e3c3914510a22ed08628ffc9984f1777
-  data.tar.gz: b7f1593151ad34cac7e0edde0841cde9dc3494f72d1292835814870b733681f8
+  metadata.gz: d5e022f8371c152548e409bfdf7711fa7dcd91e54b93cecfc341c09d9beee963
+  data.tar.gz: ac93080f87f7663402225692f402789fdae5b8605ec5bbba44b8a6fd8fb9bd4b
 SHA512:
-  metadata.gz: 6b76e3caf4a9e844b7c40e97e56ef37b332db9b3466efb585ad786dbbd7461f22b3b9088c758df2313eef3fcd2832ef880419f4b322ce63063861f4db8ed72fb
-  data.tar.gz: 6818d566651548ff3e8244e87fc98263b4ba52cffb728618a4c0c8822e20a9f043633ee9b4d6e1c8bbd443354f3de1c753f1ecc7255631cf5036c46560565d9e
+  metadata.gz: 5607ab31104b40ab08cbec25ae47a382e616ddaf8239b411b82509afd7bc995cd867d070fd86a8bb3f8596534f83d2e97338c8d72c9727e410196dfd8c237fa5
+  data.tar.gz: c5bd80f13128e66384a0a01a5a24137a6507509bca7a2ae5a01b2b2c36c2eb2515c2b3e082ed0ba2e55238aaa982441300c7121fa5b7d63176033ab839b92846

data/bin/shaf

@@ -16,17 +16,23 @@ module Shaf
       check_customizations
       return show_help if show_help?
       Command::Factory.create(*ARGV).call
-    rescue RegistrableFactory::NotFoundError, Command::ArgumentError => e
-      STDERR.puts e.message, "\n"
+    rescue RegistrableFactory::NotFoundError, Command::ArgumentError => err
+      STDERR.puts err.message, "\n"
+      show_backtrace(err)
       show_help
       exit 1
     rescue Utils::ProjectRootNotFound
       STDERR.puts "This command can only be executed inside a Shaf project directory. " \
         "Please change directory and try again!"
       exit 2
-    rescue Command::CommandError => e
-      STDERR.puts "Command failed: #{e.message}\n"
+    rescue Command::CommandError => err
+      STDERR.puts "Command failed: #{err.message}\n"
+      show_backtrace(err)
       exit 3
+    rescue StandardError => err
+      STDERR.puts err.message, "\n"
+      show_backtrace(err, force: true)
+      exit 4
     end
 
     def show_help
@@ -45,6 +51,15 @@ module Shaf
       ARGV.first =~ /-h/ 
     end
 
+    def show_backtrace(err, force: false)
+      if force || ARGV.include?('--trace')
+        err = err.cause while err.cause
+        STDERR.puts err.backtrace
+      else
+        STDERR.puts 'run the command with "--trace" to see a stack trace'
+      end
+    end
+
     def check_customizations
       return unless project_root
 

data/lib/shaf.rb

@@ -2,6 +2,7 @@ require 'shaf/version'
 require 'shaf/settings'
 require 'shaf/command'
 require 'shaf/app'
+require 'shaf/router'
 require 'shaf/errors'
 require 'shaf/formable'
 require 'shaf/extensions'

data/lib/shaf/app.rb

@@ -3,20 +3,17 @@ require 'shaf/middleware'
 module Shaf
   class App
     class << self
-      def instance
-        @instance ||= create_instance
+      def run!
+        app.run!
       end
 
-      def create_instance
-        Sinatra.new.tap do |instance|
-          instance.set :port, Settings.port || 3000
-          instance.use Shaf::Middleware::RequestId
+      def app
+        Sinatra.new.tap do |app|
+          app.set :port, Settings.port || 3000
+          app.use Middleware::RequestId
+          app.use Router
         end
       end
-
-      def use(middleware)
-        instance.use middleware
-      end
     end
   end
 end

data/lib/shaf/command/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Shaf
   module Command
     class Server < Base
@@ -6,7 +8,7 @@ module Shaf
       usage 'server'
 
       def self.options(parser, options)
-        parser.on("-p", "--port PORT", Integer, "Listen port") do |p|
+        parser.on('-p', '--port PORT', Integer, 'Listen port') do |p|
           options[:port] = p
         end
       end
@@ -14,7 +16,7 @@ module Shaf
       def call
         Settings.port = options[:port] if options[:port]
         bootstrap
-        App.instance.run!
+        App.run!
       end
     end
   end

data/lib/shaf/errors.rb

@@ -64,7 +64,7 @@ module Shaf
       end
     end
 
-    class ConflictError
+    class ConflictError < ServerError
       def http_status
         409
       end
@@ -87,7 +87,7 @@ module Shaf
       end
     end
 
-    class UnprocessableEntityError
+    class UnprocessableEntityError < ServerError
       def http_status
         422
       end
@@ -97,5 +97,25 @@ module Shaf
         super(msg, code: "UNPROCESSABLE_ENTITY", title: "Request can not be processed")
       end
     end
+
+    class ValidationError < ServerError
+      attr_reader :fields
+
+      def self.from_sequel(validation_failed)
+        new(validation_failed.message, validation_failed.errors).tap do |err|
+          err.set_backtrace(validation_failed.backtrace)
+        end
+      end
+
+      def http_status
+        422
+      end
+
+      def initialize(msg, fields)
+        msg ||= "The entity being created/updated is invalid"
+        super(msg, code: "VALIDATION_ERROR", title: "Invalid entity")
+        @fields = fields || {}
+      end
+    end
   end
 end

data/lib/shaf/extensions/controller_hooks.rb

@@ -15,6 +15,7 @@ module Shaf
     def __action_hook(hook, method_name, block, **options)
       only = Array(options[:only]) if options.key? :only
       except = Array(options[:except]) if options.key? :except
+      validate_symbols(hook: hook, only: only, except: except)
 
       path_helpers.each do |helper|
         next if only && !only.include?(helper)
@@ -41,6 +42,19 @@ module Shaf
       str = template.gsub(%r{:[^/]*}, '\w+')
       Regexp.new("#{str}/?")
     end
+
+    def validate_symbols(hook:, only: [], except: [])
+      s = "\n\n\"%s\" given as :%s keyword arg to %s hook. Must be a symbol!\n"
+      Array(only).each do |value|
+        next if value.is_a? Symbol
+        log.warn format(s, value, 'only', hook)
+      end
+
+      Array(except).each do |value|
+        next if value.is_a? Symbol
+        log.warn format(s, value, 'except', hook)
+      end
+    end
   end
 
   Sinatra.register ControllerHooks

data/lib/shaf/extensions/resource_uris.rb

@@ -75,7 +75,7 @@ module Shaf
 
     def self.base_uri
       protocol = Settings.protocol || 'http'
-      host = Settings.host || 'localhost'
+      host = Settings.hostname || 'localhost'
       port = Settings.port ? ":#{Settings.port}" : ""
       "#{protocol}://#{host}#{port}"
     end

data/lib/shaf/formable/field.rb

@@ -5,7 +5,9 @@ module Shaf
     class Field
       extend Shaf::ImmutableAttr
 
-      immutable_reader :name, :type, :value, :label, :required, :accessor_name
+      immutable_reader :name, :type, :value, :title, :required, :hidden, :accessor_name
+
+      alias label title
 
       HTML_TYPE_MAPPINGS = {
         string: 'text',
@@ -15,11 +17,12 @@ module Shaf
       def initialize(name, params = {})
         @name = name
         @type = params[:type]&.to_sym
-        @label = params[:label]
+        @title = params[:title] || params[:label]
+        @hidden = params.fetch(:hidden, false)
         @has_value = params.key? :value
         @value = params[:value]
-        @required = params[:required] || false
-        @accessor_name = (params[:accessor_name] || name).to_sym
+        @required = params.fetch(:required, false)
+        @accessor_name = params.fetch(:accessor_name, name).to_sym
       end
 
       def has_value?
@@ -43,15 +46,16 @@ module Shaf
       private
 
       def label_element
-        str = (label || name || "").to_s
+        str = (title || name || "").to_s
         %Q(<label for="#{name}" class="form--label">#{str}</label>)
       end
 
       def input_element
         _value = value ? %Q(value="#{value.to_s}") : nil
         _required = required ? "required" : nil
+        _type = hidden ? "hidden" : HTML_TYPE_MAPPINGS.fetch(type.to_s, 'text')
         attributes = [
-          %Q(type="#{HTML_TYPE_MAPPINGS[type.to_s]}"),
+          %Q(type="#{_type}"),
           'class="form--input"',
           %Q(id="#{name.to_s}"),
           %Q(name="#{name.to_s}"),

data/lib/shaf/formable/form.rb

@@ -73,6 +73,10 @@ module Shaf
         end
       end
 
+      def [](name)
+        fields.find { |field| field.name == name }
+      end
+
       def to_html
         form_element do
           [

data/lib/shaf/generator/base.rb

@@ -1,6 +1,6 @@
 require 'fileutils'
 require 'erb'
-require 'ostruct'
+require 'shaf/generator/helper'
 
 module Shaf
   module Generator
@@ -44,7 +44,7 @@ module Shaf
       def render(template, locals = {})
         str = read_template(template)
         locals[:changes] ||= []
-        b = OpenStruct.new(locals).instance_eval { binding }
+        b = Helper.new(locals).binding
 
         return ERB.new(str, 0, '%-<>').result(b) if RUBY_VERSION < "2.6.0"
         ERB.new(str,trim_mode: '-<>').result(b)

data/lib/shaf/generator/controller.rb

@@ -16,22 +16,22 @@ module Shaf
       end
 
       def name
-        n = args.first || ""
+        n = args.first || ''
         return n unless n.empty?
         raise Command::ArgumentError,
-          "Please provide a controller name when using the controller generator!"
+          'Please provide a controller name when using the controller generator!'
       end
 
       def model_class_name
-        Utils::model_name(name)
+        Utils.model_name(name)
       end
 
       def plural_name
-        Utils::pluralize(name)
+        Utils.pluralize(name)
       end
 
       def pluralized_model_name
-        Utils::pluralize(model_class_name)
+        Utils.pluralize(model_class_name)
       end
 
       def template
@@ -74,16 +74,16 @@ module Shaf
       end
 
       def add_link_to_root
-        file = "api/serializers/root_serializer.rb"
+        file = 'api/serializers/root_serializer.rb'
         unless File.exist? file
           puts "Warning: file '#{file}' does not exist. "\
             "Skip adding link to the #{plural_name} collection"
         end
         added = false
         content = []
-        File.readlines(file).reverse.each do |line|
+        File.readlines(file).reverse_each do |line|
           if match = !added && line.match(/^(\s*)link /)
-            content.unshift link_content("#{match[1]}")
+            content.unshift link_content(match[1].to_s)
             added = true
           end
           content.unshift(line)
@@ -92,8 +92,8 @@ module Shaf
         puts "Modified:   #{file}"
       end
 
-      def link_content(indentation = "")
-        <<~EOS.split("\n").map { |line| "#{indentation}#{line}" }
+      def link_content(indentation = '')
+        <<~DOC.split("\n").map { |line| "#{indentation}#{line}" }
 
           # Auto generated doc:  
           # Link to the collection of #{plural_name}.  
@@ -105,7 +105,7 @@ module Shaf
           #      /#{plural_name}
           #```
           link :#{plural_name}, #{plural_name}_uri
-        EOS
+        DOC
       end
     end
   end

data/lib/shaf/generator/helper.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+module Shaf
+  module Generator
+    class Helper < OpenStruct
+      # public method mapped to Kernel's private #binding
+      def binding
+        super
+      end
+
+      def print(lines, indent_level = 2)
+        strip_blank(lines).inject do |result, line|
+          result + "\n#{i(indent_level) unless line.empty?}#{line}"
+        end.chomp
+      end
+
+      def print_nested(sections, indent_level = 2)
+        sections.map(&method(:print)).join("\n\n#{i(indent_level)}")
+      end
+
+      def strip_blank(lines)
+        lines.map do |line|
+          line.strip.empty? ? '' : line
+        end
+      end
+
+      def indentation(level)
+        ' ' * level
+      end
+      alias i indentation
+    end
+  end
+end

data/lib/shaf/generator/migration.rb

@@ -11,7 +11,12 @@ module Shaf
         usage { Factory.usage }
 
         def call
-          generator = args.empty? ? Empty.new(**options) : Factory.create(*args, **options)
+          generator = 
+            if Factory.lookup(*args)
+              Factory.create(*args, **options)
+            else
+              Empty.new(*args, **options)
+            end
           (target, content) = generator.call
           write_output(target, content)
         rescue StandardError => e

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

@@ -4,12 +4,12 @@ module Shaf
       class Empty < Base
 
         identifier %r(\A\Z)
-        usage 'generate migration'
+        usage 'generate migration [name]'
 
         def validate_args; end
 
         def compile_migration_name
-          "empty"
+          args.first || "empty"
         end
 
         def compile_changes

data/lib/shaf/generator/serializer.rb

@@ -22,7 +22,7 @@ module Shaf
       end
 
       def model_class_name
-        Utils::model_name(name)
+        Utils.model_name(name)
       end
 
       def policy_class_name
@@ -155,7 +155,7 @@ module Shaf
           # #{desc}.  
           # Method: #{method}  
           #{example(method, uri)}
-          link :'#{rel}' do
+          link #{Utils.symbol_string(rel)} do
             #{uri_helper}
           end
         EOS
@@ -188,7 +188,7 @@ module Shaf
             curie(:doc) { doc_curie_uri('#{name}') }
 
             link :self, #{plural_name}_uri
-            link :up, root_uri
+            link :'doc:up', root_uri
 
             #{create_link.join("\n  ")}
           end
@@ -207,7 +207,7 @@ module Shaf
           attributes_with_doc: attributes_with_doc,
           curies_with_doc: curies_with_doc,
           links_with_doc: links_with_doc,
-          collection_with_doc: collection_with_doc,
+          collection_with_doc: collection_with_doc
         }
       end
 

data/lib/shaf/generator/templates/api/controller.rb.erb

@@ -21,7 +21,7 @@ class <%= controller_class_name %> < BaseController
   post :<%= plural_name %>_path do
     authorize! :write
     <%= name %> = <%= model_class_name %>.create(<%= name %>_params)
-    headers({ "Location" => <%= name %>_uri(<%= name %>) })
+    headers('Location' => <%= name %>_uri(<%= name %>))
     respond_with <%= name %>, status: 201
   end
 
@@ -31,7 +31,7 @@ class <%= controller_class_name %> < BaseController
   end
 
   get :edit_<%= name %>_path do
-    authorize! :read
+    authorize! :write
     cache_control(:private, http_cache_max_age: :short)
     respond_with edit_form
   end
@@ -49,7 +49,8 @@ class <%= controller_class_name %> < BaseController
   end
 
   def <%= name %>_params
-    # Generated method - TODO: Remove any params that should not be allowed!
+    # Generated method
+    # TODO: Remove any params that should not be allowed for mass update/create!
     safe_params(<%= params.map { |p| ":#{p[0]}" }.join(', ') %>)
   end