shaf 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9123190de71ec1df3a8c53c32a8f7e26a72b42bf6255fe2e0613cd0ee5f15837
-  data.tar.gz: 53f39cd9d1283771a638a4f1a53f85e79e9f329b0dacb8f7dd3ce08ed54d8199
+  metadata.gz: ff5e3dc188a76a89a8b4443f3996e61486a6836b91978b0fae3cd5adb9e88296
+  data.tar.gz: bbc13631ee68eeef0b86edd050602b625f001d070a3f704d3915b20ce015149e
 SHA512:
-  metadata.gz: 9713237dc988ae3a336016338ad711d59766533a68f88db7bbec9da70ac349906f779abef11cf8e9fb3b3865b652120cc756f8a0bd6558d0a7406405b7122ee6
-  data.tar.gz: 5f80c980f49450f27e1b17b3a13b1d3b724c43c7ae75c297cce54807b1a2a99920159171be152da6dd0fa6d7c239dd0e1e42d4cd08307c3d91f393f730ec5038
+  metadata.gz: 65f87a51936f02635793ecb730d211563950c3953cd08b967094d2586b2b1f8bf725e87b6f100b3a61c45c36070fd3a69f2e6b0916185f9c935ae333b10bd89f
+  data.tar.gz: ad411b694fe94039f6577d7e934944054657572feeef49abc4557dec4b726a3e9cd71940ae66cfbe52c6de390cecedfa80d107207e1016d50e5dedda2c524297

data/lib/shaf/api_doc/document.rb

@@ -122,7 +122,7 @@ module Shaf
         else
           sub_title << ": " unless sub_title.empty?
           list.each do |name, comment|
-            @md[:doc] << "#######{sub_title}#{name.gsub('_', '-')}\n#{comment.to_s}\n"
+            @md[:doc] << "#######{sub_title}#{name.tr('_', '-')}\n#{comment.to_s}\n"
             @md[key][name] = comment.to_s.chomp
           end
         end

data/lib/shaf/command/generate.rb

@@ -19,7 +19,7 @@ module Shaf
 
       def call
         in_project_root do
-          Generator::Factory.create(*args).call(options)
+          Generator::Factory.create(*args, **options).call
         end
       rescue StandardError => e
         raise Command::ArgumentError, e.message

data/lib/shaf/command/new.rb

@@ -35,8 +35,12 @@ module Shaf
       def create_gemfile
         template_file = File.expand_path('../templates/Gemfile.erb', __FILE__)
         content = File.read(template_file)
-        File.write "Gemfile",
-          ERB.new(content, 0, '%-<>').result
+        File.write "Gemfile", erb(content)
+      end
+
+      def erb(content)
+        return ERB.new(content, 0, '%-<>').result if RUBY_VERSION < "2.6.0"
+        ERB.new(content, 0, trim_mode: '%-<>').result
       end
 
       def copy_templates

data/lib/shaf/errors.rb

@@ -64,6 +64,17 @@ module Shaf
       end
     end
 
+    class ConflictError
+      def http_status
+        409
+      end
+
+      def initialize(msg = nil)
+        msg ||= "The request conflicts with another resource"
+        super(msg, code: "CONFLICT", title: "Conflicting resource")
+      end
+    end
+
     class UnsupportedMediaTypeError < ServerError
       def http_status
         415
@@ -75,5 +86,16 @@ module Shaf
         super(msg, code: "UNSUPPORTED_MEDIA_TYPE", title: "Unsupported media type")
       end
     end
+
+    class UnprocessableEntityError
+      def http_status
+        422
+      end
+
+      def initialize(msg = nil)
+        msg ||= "The server can not process this request"
+        super(msg, code: "UNPROCESSABLE_ENTITY", title: "Request can not be processed")
+      end
+    end
   end
 end

data/lib/shaf/extensions/current_user.rb

@@ -2,43 +2,47 @@ require 'digest'
 
 module Shaf
   module CurrentUser
-    def self.registered(app)
-      return unless app.respond_to?(:current_user) && app.current_user
+    def self.registered(settings)
+      return unless settings.respond_to?(:current_user) && settings.current_user
 
-      app.log.info 'Using Shaf::CurrentUser'
-      app.helpers Helpers
+      settings.log.info 'Using Shaf::CurrentUser'
+      settings.helpers Helpers
     end
 
-    def lookup_user_with(&block)
-      unless block_given? && block.respond_to?(:call)
-        raise ArgumentError, '::lookup_user_with requires a block argument'
-      end
-      log.info 'Using custom current_user lookup'
-      Helpers.lookup_proc = block
+    def self.digest(token)
+      Digest::SHA256.hexdigest(token) if token
     end
   end
 
   module Helpers
-    class << self
-      attr_accessor :lookup_proc
-
-      def user_lookup(request, token)
-        return lookup_proc.call(token, request) if lookup_proc
-        return unless token
-        digest = Digest::SHA256.hexdigest(token)
-        User.where(auth_token_digest: digest).first
-      end
+    ERR_MSG = 'The default Shaf implementation of #current_user requires a ' \
+      'User model with a column auth_token_digest'.freeze
+
+    def auth_token
+      header = settings.auth_token_header
+      request.env[header]
     end
 
     def current_user
       return @current_user if defined?(@current_user)
-      header = settings.auth_token_header
-      token = request.env[header]
-      @current_user = Helpers.user_lookup(request, token)
+
+      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/formable.rb

@@ -9,10 +9,13 @@ module Shaf
         getter = "#{f.action}_form"
 
         define_singleton_method(getter) { f }
-        next unless builder.instance_accessor_for? f
+        next unless instance_accessor = builder.instance_accessor_for(f)
 
         define_method(getter) do
-          f.dup.tap { |fm| fm.resource = self }
+          f.dup.tap do |fm|
+            fm.resource = self
+            fm.fill! if instance_accessor.prefill?
+          end
         end
       end
     end

data/lib/shaf/formable/builder.rb

@@ -3,19 +3,20 @@ require 'shaf/formable/form'
 module Shaf
   module Formable
     class Builder
+      InstanceAccessorType = Struct.new(:prefill?)
       DELEGATES = %i[title name action method type fields].freeze
 
       attr_reader :forms
 
       def initialize(&block)
         @forms = []
-        @instance_accessors = []
+        @instance_accessors = {}
 
         exec_with_form(block)
       end
 
-      def instance_accessor_for?(form)
-        @instance_accessors.include? form
+      def instance_accessor_for(form)
+        @instance_accessors[form.action]
       end
 
       private
@@ -34,8 +35,9 @@ module Shaf
         (form&.dup || Formable::Form.new).tap { |f| @forms << f }
       end
 
-      def instance_accessor
-        @instance_accessors << form
+      def instance_accessor(prefill: true)
+        acc = InstanceAccessorType.new(prefill)
+        @instance_accessors[form.action] = acc
       end
 
       DELEGATES.each do |name|

data/lib/shaf/formable/field.rb

@@ -5,7 +5,7 @@ module Shaf
     class Field
       extend Shaf::ImmutableAttr
 
-      immutable_reader :name, :type, :value, :label, :required
+      immutable_reader :name, :type, :value, :label, :required, :accessor_name
 
       HTML_TYPE_MAPPINGS = {
         string: 'text',
@@ -19,12 +19,18 @@ module Shaf
         @has_value = params.key? :value
         @value = params[:value]
         @required = params[:required] || false
+        @accessor_name = (params[:accessor_name] || name).to_sym
       end
 
       def has_value?
         @has_value
       end
 
+      def value=(v)
+        @value = v
+        @has_value = true
+      end
+
       def to_html
         [
           '<div class="form--input-group">',

data/lib/shaf/formable/form.rb

@@ -6,6 +6,8 @@ module Shaf
     class Form
       extend Shaf::ImmutableAttr
 
+      class FormHasNoResourceError < Shaf::Error; end
+
       DEFAULT_TYPE = 'application/json'.freeze
 
       attr_accessor :resource
@@ -15,7 +17,7 @@ module Shaf
       def initialize(params = {})
         @title = params[:title]
         @action = params[:action]
-        @name = params[:name] || name_from(@action)
+        @name = params[:name]&.to_sym || name_from(@action)
         @method = params[:method] ||= http_method_from(@action)
         @type = params[:type] || DEFAULT_TYPE
         @fields = (params[:fields] || {}).map do |name, args|
@@ -56,6 +58,19 @@ module Shaf
         dup.tap { |obj| obj.freeze if frozen? }
       end
 
+      def fill!(from: nil)
+        resrc = from || resource
+        raise FormHasNoResourceError, <<~MSG unless resrc
+          Trying to fill form with values from resource, but form '#{name}' has no resource!
+        MSG
+
+        fields.each do |field|
+          accessor_name = field.accessor_name
+          next unless resrc.respond_to? accessor_name
+          field.value = resrc.send(accessor_name)
+        end
+      end
+
       def to_html
         form_element do
           [

data/lib/shaf/generator/base.rb

@@ -5,7 +5,7 @@ require 'ostruct'
 module Shaf
   module Generator
     class Base
-      attr_reader :args
+      attr_reader :args, :options
 
       class << self
         def inherited(child)
@@ -23,11 +23,12 @@ module Shaf
         def options(option_parser, options); end
       end
 
-      def initialize(*args)
-        @args = args.dup
+      def initialize(*args, **options)
+        @args = args
+        @options = options
       end
 
-      def call(options = {}); end
+      def call; end
 
       def template_dir
         File.expand_path('../templates', __FILE__)
@@ -44,7 +45,9 @@ module Shaf
         str = read_template(template)
         locals[:changes] ||= []
         b = OpenStruct.new(locals).instance_eval { binding }
-        ERB.new(str, 0, '%-<>').result(b)
+
+        return ERB.new(str, 0, '%-<>').result(b) if RUBY_VERSION < "2.6.0"
+        ERB.new(str, 0, trim_mode: '%-<>').result(b)
       rescue SystemCallError => e
         puts "Failed to render template #{template}: #{e.message}"
         raise

data/lib/shaf/generator/controller.rb

@@ -5,7 +5,7 @@ module Shaf
       identifier :controller
       usage 'generate controller RESOURCE_NAME [attribute:type] [..]'
 
-      def call(options = {})
+      def call
         create_controller
         create_integration_spec if options[:specs]
         add_link_to_root

data/lib/shaf/generator/migration.rb

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

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

@@ -32,7 +32,7 @@ module Shaf
           }
         ]
 
-        attr_reader :args
+        attr_reader :args, :options
 
         class << self
           def inherited(child)
@@ -48,8 +48,9 @@ module Shaf
           end
         end
 
-        def initialize(*args)
-          @args = args.dup
+        def initialize(*args, **options)
+          @args = args
+          @options = options
         end
 
         def call

data/lib/shaf/generator/model.rb

@@ -5,10 +5,10 @@ module Shaf
       identifier :model
       usage 'generate model MODEL_NAME [attribute:type] [..]'
 
-      def call(options = {})
+      def call
         create_model
         create_migration
-        create_serializer(options)
+        create_serializer
       end
 
       def model_name
@@ -61,10 +61,10 @@ module Shaf
         Migration::Generator.new(*migration_args).call
       end
 
-      def create_serializer(options)
+      def create_serializer
         serializer_args = %W(serializer #{model_name})
         serializer_args += args[1..-1].map { |arg| arg.split(':').first }
-        Generator::Factory.create(*serializer_args).call(options)
+        Generator::Factory.create(*serializer_args, **options).call
       end
     end
   end

data/lib/shaf/generator/policy.rb

@@ -4,7 +4,7 @@ module Shaf
       identifier :policy
       usage 'generate policy MODEL_NAME [attribute] [..]'
 
-      def call(options = {})
+      def call
         create_policy
       end
 

data/lib/shaf/generator/scaffold.rb

@@ -5,14 +5,14 @@ module Shaf
       identifier :scaffold
       usage 'generate scaffold RESOURCE_NAME [attribute:type] [..]'
 
-      def call(options = {})
+      def call
         if name.empty?
           raise "Please provide a resource name when using the scaffold generator!"
         end
 
         options[:specs] = true if options[:specs].nil? 
-        Generator::Factory.create('model', *args).call(options)
-        Generator::Factory.create('controller', *controller_args).call(options)
+        Generator::Factory.create('model', *args, **options).call
+        Generator::Factory.create('controller', *controller_args, **options).call
       end
 
       def name

data/lib/shaf/generator/serializer.rb

@@ -4,10 +4,10 @@ module Shaf
       identifier :serializer
       usage 'generate serializer MODEL_NAME [attribute] [..]'
 
-      def call(options = {})
+      def call
         create_serializer
         create_serializer_spec if options[:specs]
-        create_policy(options)
+        create_policy
       end
 
       def name
@@ -211,9 +211,9 @@ module Shaf
         }
       end
 
-      def create_policy(options)
+      def create_policy
         policy_args = ["policy", name, *args[1..-1]]
-        Generator::Factory.create(*policy_args).call(options)
+        Generator::Factory.create(*policy_args, **options).call
       end
     end
   end

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

@@ -10,7 +10,7 @@ class <%= policy_class_name %> < BasePolicy
 
   link :up
 
-  link :edit, :'create-form', :'edit-form', :delete do
+  link :'create-form', :'edit-form', :delete do
     write?
   end
 

data/lib/shaf/spec.rb

@@ -1,6 +1,8 @@
 require 'shaf/spec/http_method_utils'
 require 'shaf/spec/payload_utils'
 require 'shaf/spec/fixture'
+require 'shaf/spec/let_bang'
 require 'shaf/spec/base'
 require 'shaf/spec/integration_spec'
 require 'shaf/spec/serializer_spec'
+require 'shaf/spec/system_spec'

data/lib/shaf/spec/base.rb

@@ -2,8 +2,9 @@ module Shaf
   module Spec
     class Base < Minitest::Spec
       include Minitest::Hooks
-      include PayloadUtils
       include Fixtures::Accessors
+      include UriHelper
+      include LetBang
 
       TRANSACTION_OPTIONS = {
         rollback: :always,
@@ -29,6 +30,8 @@ module Shaf
           # #{self.class.superclass.name} - #{name}
           ##########################################################################
         LOG
+
+        let_bangs.each { |name| send(name) }
       end
     end
   end

data/lib/shaf/spec/integration_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Shaf
   module Spec
     class IntegrationSpec < Base
+      include PayloadUtils
       include HttpUtils
-      include UriHelper
 
       register_spec_type self do |desc, args|
         next unless args && args.is_a?(Hash)

data/lib/shaf/spec/let_bang.rb

@@ -0,0 +1,31 @@
+require 'set'
+
+module LetBang
+  module ClassMethods
+    def let!(name, &block)
+      return unless respond_to? :let
+      let(name, &block)
+      let_bangs << name
+    end
+
+    def let_bangs
+      @let_bangs ||= Set.new
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def let_bangs
+    klass = self.class
+    Set.new.tap do |bangs|
+      loop do
+        bangs.merge(klass.let_bangs) if klass.respond_to? :let_bangs
+        klass = klass.superclass
+        break if Object == klass
+      end
+    end
+  end
+end
+

data/lib/shaf/spec/serializer_spec.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Shaf
   module Spec
     class SerializerSpec < Base
+      include PayloadUtils
+
       register_spec_type self do |desc, args|
         next true if desc.to_s =~ /Serializer$/
         next unless args && args.is_a?(Hash)
@@ -8,7 +12,18 @@ module Shaf
       end
 
       def serialize(resource, current_user:)
-        set_payload HALPresenter.to_hal(resource, current_user: current_user)
+        serializer = __serializer || HALPresenter
+        set_payload serializer.to_hal(resource, current_user: current_user)
+      end
+
+      private
+
+      def __serializer
+        serializer = self.class.ancestors.find do |klass|
+          desc = klass.desc if klass.respond_to? :desc
+          break desc if desc&.to_s&.end_with? "Serializer"
+        end
+        Class === serializer ? serializer : Kernel.const_get(serializer.to_s)
       end
     end
   end

data/lib/shaf/spec/system_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Shaf
+  module Spec
+    class SystemSpec < Base
+      register_spec_type self do |desc, args|
+        next unless args && args.is_a?(Hash)
+        args[:type]&.to_s == 'system'
+      end
+    end
+  end
+end
+

data/lib/shaf/version.rb

@@ -1,3 +1,3 @@
 module Shaf
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-11-24 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -182,10 +182,12 @@ files:
 - lib/shaf/spec/fixtures.rb
 - lib/shaf/spec/http_method_utils.rb
 - lib/shaf/spec/integration_spec.rb
+- lib/shaf/spec/let_bang.rb
 - lib/shaf/spec/model.rb
 - lib/shaf/spec/payload_test.rb
 - lib/shaf/spec/payload_utils.rb
 - lib/shaf/spec/serializer_spec.rb
+- lib/shaf/spec/system_spec.rb
 - lib/shaf/tasks.rb
 - lib/shaf/tasks/api_doc_task.rb
 - lib/shaf/tasks/db_task.rb
@@ -249,8 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Sinatra Hypermedia Api Framework