shaf 2.1.0 → 3.0.0

data/lib/shaf/generator/serializer.rb

@@ -11,19 +11,8 @@ module Shaf
         create_profile
       end
 
-      def name
-        n = args.first || ""
-        return n unless n.empty?
-        raise Command::ArgumentError,
-          "Please provide a model name when using the serializer generator!"
-      end
-
-      def plural_name
-        Utils.pluralize(name)
-      end
-
-      def model_class_name
-        Utils.model_name(name)
+      def serializer_class_name
+        "#{model_class_name}Serializer"
       end
 
       def policy_class_name
@@ -38,21 +27,31 @@ module Shaf
         'spec/serializer_spec.rb'
       end
 
-      def target
-        "api/serializers/#{name}_serializer.rb"
+      def target_dir
+        'api/serializers'
+      end
+
+      def target_name
+        "#{name}_serializer.rb"
       end
 
       def spec_target
-        "spec/serializers/#{name}_serializer_spec.rb"
+        target(directory: 'spec/serializers', name: "#{name}_serializer_spec.rb")
+      end
+
+      def policy_file
+        File.join(['policies', namespace, "#{name}_policy"].compact)
       end
 
       def create_serializer
         content = render(template, opts)
+        content = wrap_in_module(content, module_name)
         write_output(target, content)
       end
 
       def create_serializer_spec
         content = render(spec_template, opts)
+        content = wrap_in_module(content, module_name, search: "describe #{serializer_class_name}")
         write_output(spec_target, content)
       end
 
@@ -74,16 +73,16 @@ module Shaf
 
       def profile_with_doc
         doc = <<~DOC
-          # Adds a link to the '#{name}' profile and a curie. By default the
+          # Adds a link to the '#{resource_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
+          # `profile_uri('#{resource_name}')` resp. `doc_curie_uri('#{resource_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)})
+        doc.split("\n") << %Q(profile #{Utils.symbol_string(resource_name)})
       end
 
       def links_with_doc
@@ -98,7 +97,7 @@ module Shaf
       def collection_link
         link(
           rel: "collection",
-          uri_helper: "#{plural_name}_uri",
+          uri_helper: "#{collection_name}_uri",
           kwargs: {embed_depth: 0}
         )
       end
@@ -106,21 +105,21 @@ module Shaf
       def self_link
         link(
           rel: "self",
-          uri_helper: "#{name}_uri(resource)"
+          uri_helper: "#{resource_name}_uri(resource)"
         )
       end
 
       def edit_link
         link(
           rel: "edit-form",
-          uri_helper: "edit_#{name}_uri(resource)"
+          uri_helper: "edit_#{resource_name}_uri(resource)"
         )
       end
 
       def delete_link
         link(
           rel: "delete",
-          uri_helper: "#{name}_uri(resource)",
+          uri_helper: "#{resource_name}_uri(resource)",
           kwargs: {curie: :doc}
         )
       end
@@ -128,7 +127,7 @@ module Shaf
       def create_link
         link(
           rel: "create-form",
-          uri_helper: "new_#{name}_uri"
+          uri_helper: "new_#{resource_name}_uri"
         )
       end
 
@@ -147,9 +146,9 @@ module Shaf
       def collection_with_doc
         <<~EOS.split("\n")
           collection of: '#{plural_name}' do
-            curie(:doc) { doc_curie_uri('#{name}') }
+            curie(:doc) { doc_curie_uri('#{resource_name}') }
 
-            link :self, #{plural_name}_uri
+            link :self, #{collection_name}_uri
             link :up, root_uri
 
             #{create_link.join("\n  ")}
@@ -160,10 +159,12 @@ module Shaf
       def opts
         {
           name: name,
-          class_name: "#{model_class_name}Serializer",
+          resource_name: resource_name,
+          collection_name: collection_name,
+          class_name: serializer_class_name,
           model_class_name: model_class_name,
           policy_class_name: policy_class_name,
-          policy_name: "#{name}_policy",
+          policy_file: policy_file,
           attribute_names: attribute_names,
           link_relations: link_relations,
           profile_with_doc: profile_with_doc,
@@ -174,12 +175,12 @@ module Shaf
       end
 
       def create_policy
-        policy_args = ["policy", name, *attribute_names]
+        policy_args = ["policy", name_arg, *attribute_names]
         Generator::Factory.create(*policy_args, **options).call
       end
 
       def create_profile
-        profile_args = ["profile", name, *attributes]
+        profile_args = ["profile", name_arg, *attributes]
         Generator::Factory.create(*profile_args, **options).call
       end
     end

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

@@ -4,45 +4,45 @@ class <%= controller_class_name %> < BaseController
 
   authorize_with <%= policy_class_name %>
 
-  resource_uris_for :<%= name %>
+  resource_uris_for :<%= name %><%= namespace ? ", namespace: '#{namespace}'" : "" %>
 
-  get :<%= plural_name %>_path do
+  get :<%= collection_name %>_path do
     authorize! :read
     collection = paginate(<%= model_class_name %>.order(:created_at).reverse)
     respond_with_collection collection, serializer: <%= serializer_class_name %>
   end
 
-  get :new_<%= name %>_path do
+  get :new_<%= resource_name %>_path do
     authorize! :read
     cache_control(:private, http_cache_max_age: :short)
     respond_with create_form
   end
 
-  post :<%= plural_name %>_path do
+  post :<%= collection_name %>_path do
     authorize! :write
     <%= name %> = <%= model_class_name %>.create(<%= name %>_params)
-    headers('Location' => <%= name %>_uri(<%= name %>))
+    headers('Location' => <%= resource_name %>_uri(<%= name %>))
     respond_with <%= name %>, status: 201
   end
 
-  get :<%= name %>_path do
+  get :<%= resource_name %>_path do
     authorize! :read
     respond_with <%= name %>
   end
 
-  get :edit_<%= name %>_path do
+  get :edit_<%= resource_name %>_path do
     authorize! :write
     cache_control(:private, http_cache_max_age: :short)
     respond_with edit_form
   end
 
-  put :<%= name %>_path do
+  put :<%= resource_name %>_path do
     authorize! :write
     <%= name %>.update(<%= name %>_params)
     respond_with <%= name %>
   end
 
-  delete :<%= name %>_path do
+  delete :<%= resource_name %>_path do
     authorize! :write
     <%= name %>.destroy
     status 204
@@ -62,15 +62,15 @@ class <%= controller_class_name %> < BaseController
 
   def create_form
     <%= model_class_name %>.create_form.tap do |form|
-      form.self_link = new_<%= name %>_uri
-      form.href = <%= plural_name %>_uri
+      form.self_link = new_<%= resource_name %>_uri
+      form.href = <%= collection_name %>_uri
     end
   end
 
   def edit_form
     <%= name %>.edit_form.tap do |form|
-      form.self_link = edit_<%= name %>_uri(<%= name %>)
-      form.href = <%= name %>_uri(<%= name %>)
+      form.self_link = edit_<%= resource_name %>_uri(<%= name %>)
+      form.href = <%= resource_name %>_uri(<%= name %>)
     end
   end
 end

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

@@ -4,12 +4,12 @@ class <%= class_name %>
   forms_for(<%= model_class_name %>) do
     <%= fields.join("\n    ") %>
 
-    create do
+    create_form do
       title 'Create <%= model_class_name %>'
       name  'create-<%= model_name %>'
     end
 
-    edit do
+    edit_form do
       instance_accessor
       title 'Update <%= model_class_name %>'
       name  'update-<%= model_name %>'

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

@@ -1,4 +1,4 @@
-class <%= class_name %> < Sequel::Model
+class <%= class_name %> < Sequel::Model(:<%= table_name %>)
 
 end
 

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

@@ -1,6 +1,6 @@
 module Profiles
   class <%= profile_class_name %> < Shaf::Profile
-    name '<%= profile_name %>'
+    name '<%= resource_name %>'
 
     doc 'FIXME: replace this with a description of the <%= profile_name %> profile'
 

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

@@ -1,5 +1,5 @@
 require 'serializers/base_serializer'
-require 'policies/<%= policy_name %>'
+require '<%= policy_file %>'
 
 class <%= class_name %> < BaseSerializer
 

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

@@ -4,10 +4,10 @@ describe <%= model_class_name %>, type: :integration do
 
   it "returns a <%= name %>" do
     <%= name %> = <%= model_class_name %>.create
-    get <%= name %>_uri(<%= name %>)
+    get <%= resource_name %>_uri(<%= name %>)
     _(status).must_equal 200
     _(link_rels).must_include(:self)
-    _(links[:self][:href]).must_equal <%= name %>_uri(<%= name %>)
+    _(links[:self][:href]).must_equal <%= resource_name %>_uri(<%= name %>)
 <% params.each do |param| -%>
     _(attributes).must_include(:'<%= param[0] %>')
 <% end -%>
@@ -16,10 +16,10 @@ describe <%= model_class_name %>, type: :integration do
   it "lists all <%= plural_name %>" do
     2.times { <%= model_class_name %>.create }
 
-    get <%= plural_name %>_uri
+    get <%= collection_name %>_uri
     _(status).must_equal 200
     _(link_rels).must_include(:self)
-    _(links[:self][:href]).must_include <%= plural_name %>_uri
+    _(links[:self][:href]).must_include <%= collection_name %>_uri
     _(embedded(:'<%= plural_name %>').size).must_equal 2
 
     each_embedded :'<%= plural_name %>' do
@@ -31,12 +31,12 @@ describe <%= model_class_name %>, type: :integration do
   end
 <% if params.size > 0 %>
   it "can create <%= plural_name %>" do
-    get <%= plural_name %>_uri
+    get <%= collection_name %>_uri
 
     _(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
+    _(links[:self][:href]).must_equal new_<%= resource_name %>_uri
+    _(attributes[:href]).must_equal <%= collection_name %>_uri
     _(attributes[:method]).must_equal "POST"
     _(attributes[:name]).must_equal "create-<%= name %>"
     _(attributes[:title]).must_equal "Create <%= model_class_name %>"
@@ -49,9 +49,9 @@ describe <%= model_class_name %>, type: :integration do
     _(link_rels).must_include(:self)
     _(headers["Location"]).must_equal links[:self][:href]
 
-    get <%= plural_name %>_uri
+    get <%= collection_name %>_uri
     _(status).must_equal 200
-    _(links[:self][:href]).must_include <%= plural_name %>_uri
+    _(links[:self][:href]).must_include <%= collection_name %>_uri
     _(embedded(:'<%= plural_name %>').size).must_equal 1
 
     embedded :'<%= plural_name %>' do
@@ -68,14 +68,14 @@ describe <%= model_class_name %>, type: :integration do
 
   it "<%= plural_name %> can be updated" do
     <%= name %> = <%= model_class_name %>.create
-    get <%= name %>_uri(<%= name %>)
+    get <%= resource_name %>_uri(<%= name %>)
     _(status).must_equal 200
 
     _(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 %>)
+    _(links[:self][:href]).must_equal edit_<%= resource_name %>_uri(<%= name %>)
+    _(attributes[:href]).must_equal <%= resource_name %>_uri(<%= name %>)
     _(attributes[:method]).must_equal "PUT"
     _(attributes[:name]).must_equal "update-<%= name %>"
     _(attributes[:title]).must_equal "Update <%= model_class_name %>"
@@ -91,14 +91,14 @@ describe <%= model_class_name %>, type: :integration do
 
   it "<%= plural_name %> can be deleted" do
     <%= name %> = <%= model_class_name %>.create
-    get <%= name %>_uri(<%= name %>)
+    get <%= resource_name %>_uri(<%= name %>)
     _(status).must_equal 200
     _(link_rels).must_include(:'doc:delete')
 
     follow_rel(:'doc:delete', method: :delete)
     _(status).must_equal 204
 
-    get <%= name %>_uri(<%= name %>)
+    get <%= resource_name %>_uri(<%= name %>)
     _(status).must_equal 404
   end
 

data/lib/shaf/helpers/paginate.rb

@@ -12,7 +12,7 @@ module Shaf
       unless collection.respond_to? :paginate
         log.warn "Trying to paginate a collection that doesn't " \
                     "support pagination: #{collection}"
-        return
+        return collection
       end
 
       per_page = params[:per_page].to_i if params[:per_page]

data/lib/shaf/profile.rb

@@ -5,6 +5,14 @@ require 'shaf/extensions/resource_uris'
 
 module Shaf
   class Profile
+    module NormalizeName
+      private def normalize(name)
+        name.to_s.downcase.tr('-', '_')
+      end
+    end
+
+    extend NormalizeName
+    include NormalizeName
     include Shaf::UriHelper
 
     class << self
@@ -98,18 +106,10 @@ module Shaf
       def evaluator
         Evaluator.new(parent: self)
       end
-
-      def normalize(name)
-        name.to_s.downcase.tr('-', '_')
-      end
     end
 
     def name
       normalize(self.class.name)
     end
-
-    def normalize(str)
-      self.class.normalize(str)
-    end
   end
 end

data/lib/shaf/registrable_factory.rb

@@ -1,15 +1,58 @@
 module Shaf
   module RegistrableFactory
-
     class NotFoundError < StandardError; end
+    class NoIdentifiersError < StandardError
+
+      def initialize(clazz)
+        super <<~ERR
+          #{clazz} does not have an @identifiers ivar.
+          Did you perhaps forget to call `#{clazz}.identifier`?
+        ERR
+      end
+    end
+
+    class Entry
+      attr_reader :clazz
+
+      def initialize(clazz)
+        @clazz = clazz
+      end
+
+      def match?(strings)
+        raise NoIdentifiersError, clazz unless identifiers
+        return false if strings.size < identifiers.size
+        identifiers.zip(strings).all? { |pattern, str| matching_identifier? str, pattern }
+      end
+
+      def identifier_count
+        identifiers&.size || 0
+      end
+
+      def usage
+        clazz.instance_variable_get(:@usage)
+      end
+
+      private
+
+      def identifiers
+        clazz.identified_by
+      end
+
+      def matching_identifier?(str, pattern)
+        return false if pattern.nil? || str.nil? || str.empty?
+        pattern = pattern.to_s if pattern.is_a? Symbol
+        return str == pattern if pattern.is_a? String
+        !!str.match(pattern)
+      end
+    end
 
     def all
-      reg.dup
+      reg.map(&:clazz)
     end
 
-    def each
+    def each(&block)
       return all.each unless block_given?
-      all.each { |c| yield c }
+      all.each(&block)
     end
 
     def size
@@ -17,34 +60,31 @@ module Shaf
     end
 
     def register(clazz)
-      reg << clazz
+      reg << Entry.new(clazz)
     end
 
     def unregister(*str)
       return if str.empty? || !str.all?
-      reg.delete_if { |clazz| matching_class? str, clazz }
+      reg.delete_if { |entry| entry.match? str }
     end
 
     def lookup(*str)
-      return if str.empty? || !str.all?
-      reg.select { |clazz| matching_class? str, clazz }
-        .sort_by(&method(:identifier_count))
-        .last
+      lookup_entry(*str)&.clazz
     end
 
     def usage
       reg.compact.map do |entry|
-        usage = entry.instance_variable_get(:@usage)
+        usage = entry.usage
         usage.respond_to?(:call) ? usage.call : usage
       end
     end
 
     def create(*params, **options)
-      clazz = lookup(*params)
-      raise NotFoundError.new(%Q(Command '#{ARGV}' is not supported)) unless clazz
+      entry = lookup_entry(*params)
+      raise NotFoundError.new(%Q(Command '#{ARGV}' is not supported)) unless entry
 
-      args = init_args(clazz, params)
-      clazz.new(*args, **options)
+      args = init_args(entry, params)
+      entry.clazz.new(*args, **options)
     end
 
     private
@@ -53,25 +93,15 @@ module Shaf
       @reg ||= []
     end
 
-    def matching_class?(strings, clazz)
-      identifiers = clazz.instance_variable_get(:@identifiers)
-      return false if strings.size < identifiers.size
-      identifiers.zip(strings).all? { |pattern, str| matching_identifier? str, pattern }
-    end
-
-    def matching_identifier?(str, pattern)
-      return false if pattern.nil? || str.nil? || str.empty?
-      pattern = pattern.to_s if pattern.is_a? Symbol
-      return str == pattern if pattern.is_a? String
-      str.match(pattern) || false
-    end
-
-    def identifier_count(clazz)
-      clazz.instance_variable_get(:@identifiers)&.size || 0
+    def lookup_entry(*str)
+      return if str.empty? || !str.all?
+      reg.select { |entry| entry.match? str }
+        .sort_by { |entry| entry.identifier_count }
+        .last
     end
 
-    def init_args(clazz, params)
-      first_non_id = identifier_count(clazz)
+    def init_args(entry, params)
+      first_non_id = entry.identifier_count
       params[first_non_id..-1]
     end
   end

data/lib/shaf/responder/problem_json.rb

@@ -16,7 +16,7 @@ module Shaf
 
       def hash
         {
-          status: controller.status,
+          status: status,
           type: code,
           title: title,
           detail: resource.message,

data/lib/shaf/router.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'shaf/middleware'
 require 'set'
+require 'sinatra'
+require 'shaf/errors'
 
 module Shaf
   class Router
@@ -21,16 +22,56 @@ module Shaf
       end
     end
 
+    class NullController
+      def call(env)
+        request = request(env)
+        responder = Responder.for(request, error)
+        responder.call(self, error)
+
+        response.finish
+      end
+
+      # Called from responder
+      def content_type(mime)
+        response["Content-Type"] = mime
+      end
+
+      # Called from responder
+      def body(body)
+        response.body  = body
+      end
+
+      private
+
+      def status
+        500
+      end
+
+      def request(env)
+        Sinatra::Request.new(env)
+      end
+
+      def response
+        @response ||= Sinatra::Response.new(nil, status)
+      end
+
+      def error
+        @error ||= Errors::ServerError.new(
+          'Internal error: No controller has been mounted on Router',
+          code: 'NO_MOUNTED_CONTROLLERS',
+          title: 'Shaf::Router must have at least one mounted controller',
+        )
+      end
+    end
+
     class << self
       def mount(controller, default: false)
         @default_controller = controller if default
-        @controllers ||= []
-        @controllers << controller
+        controllers << controller
       end
 
       def routes
-        init_routes unless defined? @routes
-        @routes
+        @routes ||= init_routes
       end
 
       # This controller will be used when no other can handle the request
@@ -41,32 +82,44 @@ module Shaf
 
       private
 
-      attr_reader :controllers
+      def controllers
+        @controllers ||= []
+      end
 
       def init_routes
-        @routes = Hash.new do |hash, key|
+        routes = Hash.new do |hash, key|
           hash[key] = Hash.new { |h, k| h[k] = Set.new }
         end
-        controllers.each { |controller| init_routes_for(controller) }
+        controllers.each { |controller| init(controller, routes) }
+        routes
       end
 
-      def init_routes_for(controller)
+      def init(controller, routes)
         controller.routes.each do |method, controller_routes|
           routes[method][controller] += controller_routes.map(&:first)
         end
       end
     end
 
-    def initialize(app)
+    def initialize(app = NullController.new)
       @app = app
     end
 
     def call(env)
+      # When the api is mounted in Rails then the mount point will be not be
+      # present in PATH_INFO but it will instead be available in SCRIPT_NAME
+      # Shaf need to know about the full path in order to make all path helpers
+      # work, so we need to add the mountpoint back to PATH_INFO.
+      unless String(env['SCRIPT_NAME']).empty?
+        env['PATH_INFO'] = '' if env['PATH_INFO'] == '/'
+        env['PATH_INFO'] = "#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
+      end
+
       http_method, path = http_details(env)
 
       result = nil
 
-      controllers_for(http_method, path) do |controller|
+      each_controller_for(http_method, path) do |controller|
         result = controller.call(env)
         break unless cascade? result
       end
@@ -80,7 +133,7 @@ module Shaf
       [env['REQUEST_METHOD'], env['PATH_INFO']]
     end
 
-    def controllers_for(http_method, path)
+    def each_controller_for(http_method, path)
       find_cached(http_method, path).each { |ctrlr| yield ctrlr }
 
       if controller = find(http_method, path)