shaf 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c865a1b9a6d772f631b559f0cb82d170e22661ea7cbf0138cac2dcd41c8c94
-  data.tar.gz: 036cc7276471887b64083989a91760c4781c20ddddecd3b62bfd74f000b364a8
+  metadata.gz: a9af4fa12d1002e4c4fcfe233c640e0efff4d779d8bed3b884dec7da3d2d7eef
+  data.tar.gz: 7748f68242de611ece5e8f556686e924f627f6346f5c90e56b1b15d3bbd4ce04
 SHA512:
-  metadata.gz: b812af36d9a0d79c69ed73c68b84ddc056fe62f9c34086d183148a9f1f709e06cee65daa46942b09de95f81f60454ba54c502d04079d2dafaedbca1984138aae
-  data.tar.gz: '075085884194b73706e217760914aa7f5707f5f1960968d30b643c76c39801b054ac77b15d65c678a79f5f866a323d4f12cc49da134c036075e7d177fc34031f'
+  metadata.gz: 0dc246772c0a1c5d74d738a4618173e83819a67d9cb88e17b37c7894ffbc27ce977f1acfb2edcf3cf88bc12fc34f202e9e974d930976ff997c26f2cceaa1b3cb
+  data.tar.gz: 4fb0286154086c4859b109f79fd70836d3dd44d777688964b235cb32a2ad1afc897f8ae3df9544616934d9b63363c2714e6d11d81d4d0c327238b46aae3db50d

data/lib/shaf/api_doc/document.rb

@@ -70,7 +70,7 @@ module Shaf
         hash.to_yaml
       end
 
-      def to_markdown
+      def to_html
         # For some reason redcarpet don't like to surround my markdown code blocks
         # with <pre> tags, so let's fix that here.
         options = {autolink: true, fenced_code_blocks: true}
@@ -84,7 +84,7 @@ module Shaf
       def write_html(output)
         FileUtils.mkdir_p(output) unless Dir.exist? output
         File.open(File.join(output, "#{model.downcase}.html"), "w") do |file|
-          file.write(to_markdown)
+          file.write(to_html)
         end
       end
 

data/lib/shaf/extensions/authorize.rb

@@ -1,10 +1,10 @@
 require 'sinatra/base'
 
 module Shaf
-
   module Authorize
-    class NoPolicyError < StandardError; end
-    class PolicyViolationError < StandardError; end
+    class NoPolicyError < Error; end
+    class PolicyViolationError < Error; end
+    class MissingPolicyAction < Error; end
 
     attr_reader :policy_class
 
@@ -20,7 +20,10 @@ module Shaf
   module Helpers
     def authorize(action, resource = nil)
       policy(resource) or raise Authorize::NoPolicyError
-      @policy.public_send method_for(action)
+      method = __method_for(action)
+      return @policy.public_send(method) if @policy.respond_to? method
+      raise Authorize::MissingPolicyAction,
+        "#{@policy.class} does not implement method #{method}"
     end
 
     def authorize!(action, resource = nil)
@@ -35,7 +38,7 @@ module Shaf
       @policy = self.class.policy_class&.new(user, resource)
     end
 
-    def method_for(action)
+    def __method_for(action)
       return action if action.to_s.end_with? '?'
       "#{action}?".to_sym
     end

data/lib/shaf/extensions/resource_uris.rb

@@ -263,7 +263,7 @@ module Shaf
       uri, alt_uri = @uri, @alt_uri
 
       if alt_uri.nil?
-        -> { uri.freeze }
+        ->(_ = nil) { uri.freeze }
       else
         ->(collection = false) { collection ? alt_uri : uri }
       end

data/lib/shaf/extensions/symbolic_routes.rb

@@ -1,6 +1,8 @@
 module Shaf
   module SymbolicRoutes
-    [
+    class UriHelperNotRegisterdError < Error; end
+
+    SUPPORTED_METHODS = [
       :get,
       :put,
       :post,
@@ -10,18 +12,23 @@ module Shaf
       :options,
       :link,
       :unlink
-    ].each do |m|
-      define_method m do |path, &block|
-        super(rewrite_path(path), &block)
+    ].freeze
+
+    SUPPORTED_METHODS.each do |m|
+      define_method m do |path, collection: false, &block|
+        super(rewrite_path(path, collection), &block)
       end
     end
 
-    def rewrite_path(path)
+    def rewrite_path(path, collection = nil)
       return path unless path.is_a? Symbol
 
       m = "#{path}_template"
-      raise "Don't know how to 'get #{path}'" unless respond_to? m
-      send m
+      return send(m, collection) if respond_to? m
+
+      raise UriHelperNotRegisterdError, <<~RUBY
+        Undefined method '#{m}'. Did you forget to register a uri helper for #{path}?
+      RUBY
     end
   end
 end

data/lib/shaf/generator/serializer.rb

@@ -144,7 +144,7 @@ module Shaf
         link(
           rel: "doc:create-form",
           desc: "Link to a form used to create new #{name} resources",
-          uri: "new_#{name}_uri",
+          uri: "/#{plural_name}/form",
           uri_helper: "new_#{name}_uri"
         )
       end
@@ -185,12 +185,12 @@ module Shaf
       def collection_with_doc
         <<~EOS.split("\n")
           collection of: '#{plural_name}' do
+            curie(:doc) { doc_curie_uri('#{name}') }
+
             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
         EOS
       end

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

@@ -54,7 +54,7 @@ class <%= controller_class_name %> < BaseController
   end
 
   def <%= name %>
-    <%= model_class_name %>[params['id']].tap do |<%= name %>|
+    @<%= name %> ||= <%= model_class_name %>[params['id']].tap do |<%= name %>|
       raise NotFoundError.new(clazz: <%= model_class_name %>, id: params['id']) unless <%= name %>
     end
   end

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

@@ -14,10 +14,6 @@ class <%= policy_class_name %> < BasePolicy
     write?
   end
 
-  embed :'create-form', :'edit-form' do
-    write?
-  end
-
   def read?
     # FIXME!!
     true

data/lib/shaf/helpers/payload.rb

@@ -91,6 +91,8 @@ module Shaf
       http_cache = kwargs.fetch(:http_cache, Settings.http_cache)
       add_cache_headers(serialized) if http_cache
 
+      log.info "#{request.request_method} #{request.path_info} => #{status}"
+
       if preferred_response == mime_type(:html)
         respond_with_html(resource, serialized)
       else

data/lib/shaf/spec.rb

@@ -1,5 +1,3 @@
-require 'minitest/autorun'
-require 'minitest/hooks'
 require 'shaf/spec/http_method_utils'
 require 'shaf/spec/payload_utils'
 require 'shaf/spec/fixture'

data/lib/shaf/spec/base.rb

@@ -3,7 +3,7 @@ module Shaf
     class Base < Minitest::Spec
       include Minitest::Hooks
       include PayloadUtils
-      include Fixtures
+      include Fixtures::Accessors
 
       TRANSACTION_OPTIONS = {
         rollback: :always,
@@ -13,7 +13,7 @@ module Shaf
 
       around(:all) do |&block|
         DB.transaction(TRANSACTION_OPTIONS) do
-          Shaf::Spec::Fixtures.load
+          Shaf::Spec::Fixtures.load(reload: true)
           super(&block)
         end
       end
@@ -21,6 +21,15 @@ module Shaf
       around do |&block|
         DB.transaction(TRANSACTION_OPTIONS) { super(&block) }
       end
+
+      before do
+        $logger&.info <<~LOG
+          \n
+          ##########################################################################
+          # #{self.class.superclass.name} - #{name}
+          ##########################################################################
+        LOG
+      end
     end
   end
 end

data/lib/shaf/spec/fixture.rb

@@ -4,58 +4,50 @@ require 'shaf/utils'
 module Shaf
   module Spec
     class Fixture
-      include Fixtures
 
-      def self.define(collection_name, &block)
+      include Fixtures::Accessors
+
+      attr_reader :name
+
+      def self.define(name, &block)
         return unless block_given?
-        collection = Fixtures.add_collection(collection_name)
-        new(collection_name, collection, block).run
+        Fixtures.fixture_defined new(name.to_sym, block)
       end
 
-      def initialize(collection_name, collection, block)
-        @collection_name = collection_name
-        @collection = collection
+      def initialize(name, block)
+        @name = name
         @block = block
       end
 
-      def run
+      def init
         instance_exec(&@block)
+        self
       end
 
-      def resource(name, resrc = nil, &block)
-        @collection[name.to_sym] = resrc || instance_exec(&block)
+      def add_entry(entry_name, resrc = nil, &block)
+        value = block ? instance_exec(&block) : resrc
+        fixtures = send(name)
+        fixtures[entry_name] = value
       end
 
       private
 
       def method_missing(method, *args, &block)
-        if load_fixture_if_missing_method_is_fixture?(method, args.size)
-          send(method, args.first)
-        elsif resource_name?(args.size, block_given?)
-          resource(method, args.first, &block)
-        else
-          super
-        end
+        return super unless resource_name?(args.size, block_given?)
+        add_entry(method, args.first, &block)
       end
 
-      def load_fixture_if_missing_method_is_fixture?(method, arg_count)
-        return false if arg_count > 1 # Fixtures should only be called with one argument
-
-        fixture_files = Fixtures.fixture_files
-        fixtures = fixture_files.map { |f| File.basename(f, ".rb") }
-        i = fixtures.index(method.to_s)
-        return false unless i
+      def respond_to_missing?(*)
+        true
+      end
 
-        require fixture_files[i]
-        respond_to? method
+      def nested_fixture?(*args)
+        args.size == 1 && args.first.is_a?(Symbol)
       end
 
       def resource_name?(arg_count, block_given)
-        if block_given
-          arg_count == 0
-        else
-          arg_count == 1
-        end
+        arg_count += 1 if block_given
+        arg_count == 1
       end
     end
   end

data/lib/shaf/spec/fixtures.rb

@@ -1,32 +1,102 @@
 module Shaf
   module Spec
-
-    class FixtureNotFound < StandardError; end
-
     module Fixtures
-      def self.load
-        fixture_files.map { |file| require file }
-      end
+      class FixtureNotFound < StandardError
+        def initialize(name, key = nil)
+          msg =
+            if key
+              "Instance '#{key}' is not found in fixture '#{name}'! " \
+                "Either it does not exist in the fixture definition or " \
+                "there is a circular dependency with your fixtures."
+            else
+              "No such fixture: #{name}"
+            end
 
-      def self.fixture_files
-        dir = Shaf::Settings.fixtures_dir || 'spec/fixtures'
-        Dir[File.join(dir, '**', '*.rb')]
+          super(msg)
+        end
       end
 
-      def self.add_collection(collection_name)
-        @collections ||= {}
-        collection_name = collection_name.to_sym unless collection_name.is_a? Symbol
-        return if @collections.key? collection_name
+      class << self
+        def load(reload: false)
+          clear if reload
+          require_fixture_files
+          init_fixtures
+        end
+
+        def clear
+          fixtures.each { |name, _| Accessors.clear(name) }
+          @initialized_fixtures = []
+        end
+
+        def init_fixtures
+          fixtures.each { |name, fixture| init_fixture(name, fixture) }
+        end
+
+        def init_fixture(name, fixture = nil)
+          fixture ||= fixtures[name]
+          raise FixtureNotFound, name unless fixture
+          return if initialized? name
+
+          initialized_fixtures << name
+          fixture.init
+        end
+
+        def fixture_defined(fixture)
+          fixtures[fixture.name] = fixture
+          Accessors.add(fixture.name)
+        end
+
+        def fixtures
+          @fixtures ||= {}
+        end
+
+        def initialized_fixtures
+          @initialized_fixtures ||= []
+        end
+
+        def require_fixture_files
+          fixture_files.each { |file| require(file) }
+        end
+
+        def fixture_files
+          @fixture_files ||= Dir[File.join(fixture_dir, '**', '*.rb')]
+        end
+
+        def fixture_dir
+          Shaf::Settings.fixtures_dir || 'spec/fixtures'
+        end
 
-        @collections[collection_name] = {}
-        collection = @collections[collection_name]
-        create_accessor(collection, collection_name)
-        collection
+        def initialized?(name)
+          initialized_fixtures.include? name
+        end
       end
 
-      def self.create_accessor(collection, collection_name)
-        define_method(collection_name) do |name|
-          collection[name.to_sym] or raise FixtureNotFound
+      module Accessors
+        class << self
+          def collection(name)
+            @collections ||= {}
+            @collections[name] ||= {}
+          end
+
+          def clear(name)
+            collection(name).clear
+          end
+
+          def add(name)
+            collection = collection(name)
+            return if instance_methods.include? name
+
+            define_method(name) do |arg = nil|
+              Fixtures.init_fixture(name) unless Fixtures.initialized? name
+              if arg.nil?
+                collection
+              elsif collection.key? arg
+                collection[arg]
+              else
+                raise FixtureNotFound.new(name, arg)
+              end
+            end
+          end
         end
       end
     end

data/lib/shaf/spec/integration_spec.rb

@@ -19,7 +19,7 @@ module Shaf
         return nil if body.empty?
         JSON.parse(body, symbolize_names: true)
       rescue JSON::ParserError => e
-        assert e.nil?, "Could not parse reponse as json"
+        assert e.nil?, "Could not parse reponse as json (#{body[0..40]})"
       end
 
       def app
@@ -43,19 +43,6 @@ module Shaf
       def clear_auth_token
         @__integration_test_auth_token = nil
       end
-
-#       def login(email, pass)
-#         params = {email: email, password: pass}
-#         header 'Content-Type', 'application/json'
-#         post Shaf::UriHelper.session_uri, JSON.generate(params)
-#         @__integration_test_auth_token = attribute[:auth_token]
-#       end
-# 
-#       def logout
-#         delete Shaf::UriHelper.session_uri
-#         @__integration_test_auth_token = nil
-#       end
-
     end
   end
 end

data/lib/shaf/spec/payload_utils.rb

@@ -18,7 +18,7 @@ module Shaf
       end
 
       def links
-        last_payload[:_links] || []
+        last_payload[:_links] || {}
       end
 
       def link_rels
@@ -98,9 +98,9 @@ module Shaf
       def assert_has_link(rel)
         assert last_payload.key?(:_links), "Response does not have any links: #{last_payload}"
         assert last_payload[:_links][rel.to_sym],
-          "Response does not contain link with rel '#{rel}': #{last_payload}"
+          "Response does not contain link with rel '#{rel}'!\nResponse: #{last_payload}"
         assert last_payload[:_links][rel.to_sym][:href],
-          "link with rel '#{rel}' in ressponse does not have a href: #{last_payload}"
+          "link with rel '#{rel}' in response does not have a href!\nResponse: #{last_payload}"
       end
 
       def refute_has_link(rel)

data/lib/shaf/spec/serializer_spec.rb

@@ -6,6 +6,10 @@ module Shaf
         next unless args && args.is_a?(Hash)
         args[:type]&.to_s == 'serializer'
       end
+
+      def serialize(resource, current_user:)
+        set_payload HALPresenter.to_hal(resource, current_user: current_user)
+      end
     end
   end
 end

data/lib/shaf/tasks.rb

@@ -3,5 +3,5 @@ require 'shaf/tasks/db_task'
 require 'shaf/tasks/api_doc_task'
 
 module Shaf
-  include Tasks
+  include Tasks # includes task classes rather than methods
 end

data/lib/shaf/version.rb

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

data/templates/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 ENV['RACK_ENV'] = 'test'
 require 'config/bootstrap'
 require 'minitest/autorun'
+require 'minitest/hooks'
 require 'shaf/spec'

metadata

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