sinja 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4606d9daabb3be7a7aca0c603f36134f86cf2885
-  data.tar.gz: 210cc332302ab5b34140b14bd74e24c2a72fb93a
+  metadata.gz: 851e8f43eabf59529257a1ef2fcc7a6df84f8ea5
+  data.tar.gz: b75968556128599080ba71d790d8b1671cbc89e6
 SHA512:
-  metadata.gz: c5627d6ea47b5a62945a49b42e69f165ca10b100723b17cd3efd9b04fdc1e8b67b84e334a98b8814b90961c38958287fb1c86fce5389f9250c72cf58c234d961
-  data.tar.gz: f1dda55b7f38c2e09f7ccb4d00fce2a09ef2342df085cd847e2937d58ccf5c5acfae2d9d004594bc12174ddf0abf0b8129e2823cbdc1124793395708e9850299
+  metadata.gz: 0ddd2782e3e63efab5bfee81ace29615708e08cc9a137ba28451724543f98ee3f2f6d59eda0444a0859ebd9f4b8ccdc26ed661ebde0cbdf9b902e97e18f8d23f
+  data.tar.gz: 1fea65b16d22c9bbb22dc0af0ed4744308eaf5dfe217da0c054da4c57b40ae5d00a36617b06d114ae2a50b324a72ac45a4c17917bd61debed1ed812d35c5e0ef

data/.travis.yml

@@ -2,14 +2,18 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.3
+  - 2.4.0
   - ruby-head
-  - jruby-9.1.6.0
+  - jruby-9.1.7.0
   - jruby-head
 env:
   - sinatra=1.4.7 rails=4.2.7.1
-  - sinatra=2.0.0.beta2 rails=5.0.0.1
+  - sinatra=2.0.0.beta2 rails=5.0.1
 jdk:
   - oraclejdk8
 before_install:
-  - gem uninstall bundler
-  - gem install bundler -v 1.11.2
+  - gem install bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/README.md

@@ -778,6 +778,24 @@ end
 
 Please see the [demo-app](/demo-app) for a more complete example.
 
+Finally, because the `role` helper is invoked several times and may return
+different results throughout the request lifecycle, Sinja does not memoize
+(cache the return value keyed by function signature) it. If you have an
+expensive component of your role helper that is not context-dependent, it may
+be worth memoizing yourself:
+
+```ruby
+helpers do
+  def role
+    @roles ||= expensive_role_lookup.freeze
+
+    @roles.dup.tap do |a|
+      a << :foo if bar
+    end
+  end
+end
+```
+
 ### Query Parameters
 
 The {json:api} specification states that any unhandled query parameters should
@@ -1167,6 +1185,30 @@ The following matrix outlines which combinations of action helpers and
 </tbody>
 </table>
 
+#### Deferring Relationships
+
+If you're side-loading multiple relationships, you may need one applied before
+another (e.g. set the author of a post before setting its tags). You can use
+the built-in `defer` helper to affect the order of operations:
+
+```ruby
+has_one :author do
+  graft do |rio|
+    resource.author = Author.with_pk!(rio[:id].to_i)
+    resource.save_changes
+  end
+end
+
+has_many :tags do
+  replace do |rios|
+    defer unless resource.author # come back to this if the author isn't set yet
+
+    tags = resource.author.preferred_tags
+    # ..
+  end
+end
+```
+
 #### Avoiding Null Foreign Keys
 
 Now, let's say our DBA is forward-thinking and wants to make the foreign key

data/demo-app/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.3-alpine
+FROM ruby:2.4-alpine
 ARG container_port=4567
 ENV container_port=$container_port
 

data/demo-app/Gemfile

@@ -1,10 +1,12 @@
 source 'https://rubygems.org'
 
+gem 'jdbc-sqlite3', '~> 3.8', :platform=>:jruby
 gem 'json', '~> 2.0'
+gem 'sequel', '~> 4.43'
 gem 'sinatra', '>= 2.0.0.beta2', '< 3'
 gem 'sinatra-contrib', '>= 2.0.0.beta2', '< 3'
 gem 'sinja',
   git: 'https://github.com/mwpastore/sinja.git', branch: 'master'
 gem 'sinja-sequel',
   git: 'https://github.com/mwpastore/sinja-sequel.git', branch: 'master'
-gem 'sqlite3', '~> 1.3'
+gem 'sqlite3', '~> 1.3', :platform=>[:ruby, :mswin]

data/demo-app/app.rb

@@ -10,6 +10,9 @@ require_relative 'classes/comment'
 require_relative 'classes/post'
 require_relative 'classes/tag'
 
+# Freeze database after creating tables and loading models
+DB.freeze
+
 configure :development do
   set :server_settings, AccessLog: [] # avoid WEBrick double-logging issue
 end

data/demo-app/database.rb

@@ -5,6 +5,7 @@ require_relative 'boot'
 DB = Sequel.connect ENV.fetch 'DATABASE_URL',
   defined?(JRUBY_VERSION) ? 'jdbc:sqlite::memory:' : 'sqlite:/'
 
-DB.extension :pagination
+DB.extension(:freeze_datasets)
+DB.extension(:pagination)
 
 DB.loggers << Logger.new($stderr) if Sinatra::Base.development?

data/lib/jsonapi/ember_serializer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'jsonapi-serializers'
+
+module JSONAPI
+  module EmberSerializer
+    def self.included(base)
+      base.class_eval do
+        include Serializer
+
+        alias type_for_link type
+        alias format_name_for_link format_name
+
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def type
+        object.class.name.demodulize.underscore.dasherize
+      end
+
+      def format_name(attribute_name)
+        attribute_name.to_s.underscore.camelize(:lower)
+      end
+
+      def self_link
+        "#{base_url}/#{type_for_link}/#{id}"
+      end
+
+      def relationship_self_link(attribute_name)
+        "#{self_link}/relationships/#{format_name_for_link(attribute_name)}"
+      end
+
+      def relationship_related_link(attribute_name)
+        "#{self_link}/#{format_name_for_link(attribute_name)}"
+      end
+    end
+  end
+end

data/lib/sinja.rb

@@ -13,6 +13,7 @@ require 'sinja/resource'
 require 'sinja/version'
 
 module Sinja
+  DEFER_CODE = 357
   MIME_TYPE = 'application/vnd.api+json'
   ERROR_CODES = ObjectSpace.each_object(Class).to_a
     .keep_if { |klass| klass < HttpError }
@@ -138,11 +139,14 @@ module Sinja
 
       def can?(action)
         roles = settings._resource_config[:resource].fetch(action, {})[:roles]
-        roles.nil? || roles.empty? || roles.intersect?(memoized_role)
+        roles.nil? || roles.empty? || roles.intersect?(role)
       end
 
       def content?
-        request.body.respond_to?(:size) && request.body.size > 0
+        request.body.respond_to?(:size) && request.body.size > 0 || begin
+          request.body.rewind
+          request.body.read(1)
+        end
       end
 
       def data
@@ -243,10 +247,6 @@ module Sinja
         end
       end
 
-      def memoized_role
-        @role ||= Roles[*role]
-      end
-
       def sideloaded?
         env.key?('sinja.passthru')
       end
@@ -256,7 +256,7 @@ module Sinja
       end
 
       def role?(*roles)
-        Roles[*roles].intersect?(memoized_role)
+        Roles[*roles].intersect?(role)
       end
 
       def sanity_check!(resource_name, id=nil)
@@ -328,7 +328,7 @@ module Sinja
     # trigger default procs
     config = _sinja.resource_config[resource_name]
 
-    namespace "/#{resource_name}" do
+    namespace %r{/#{resource_name}(?![^/])} do
       define_singleton_method(:_resource_config) { config }
       define_singleton_method(:resource_config) { config[:resource] }
 

data/lib/sinja/helpers/nested.rb

@@ -2,6 +2,10 @@
 module Sinja
   module Helpers
     module Nested
+      def defer(msg=nil)
+        halt DEFER_CODE, msg
+      end
+
       def relationship_link?
         !params[:r].nil?
       end

data/lib/sinja/helpers/relationships.rb

@@ -19,11 +19,18 @@ module Sinja
       end
 
       def dispatch_relationship_requests!(id, methods: {}, **opts)
-        data.fetch(:relationships, {}).each do |rel, body|
-          rel_type = settings._resource_config[:has_one].key?(rel) ? :has_one : :has_many
+        rels = data.fetch(:relationships, {}).to_a
+        rels.each do |rel, body, rel_type=nil, count=0|
+          rel_type ||= settings._resource_config[:has_one].key?(rel) ? :has_one : :has_many
           code, _, *json = dispatch_relationship_request id, rel,
             opts.merge(:body=>body, :method=>methods.fetch(rel_type, :patch))
 
+          if code == DEFER_CODE && count == 0
+            rels << [rel, body, rel_type, count + 1]
+
+            next
+          end
+
           # TODO: Gather responses and report all errors instead of only first?
           # `halt' was called (instead of raise); rethrow it as best as possible
           raise SideloadError.new(code, json) unless (200...300).cover?(code)

data/lib/sinja/helpers/serializers.rb

@@ -87,7 +87,7 @@ module Sinja
               config.dig(:has_many, last_term.pluralize.to_sym, :fetch, :roles) ||
               config.dig(:has_one, last_term.singularize.to_sym, :pluck, :roles)
 
-            throw :keep?, roles && (roles.empty? || roles.intersect?(memoized_role))
+            throw :keep?, roles && (roles.empty? || roles.intersect?(role))
           end
         end
       end
@@ -170,12 +170,14 @@ module Sinja
       def serialize_linkage(model, rel, options={})
         options[:is_collection] = false
         options[:skip_collection_check] = defined?(::Sequel::Model) && model.is_a?(::Sequel::Model)
-        options[:include] = rel.to_s
         options = settings._sinja.serializer_opts.merge(options)
 
+        options[:serializer] ||= ::JSONAPI::Serializer.find_serializer_class(model, options)
+        options[:include] = options[:serializer].new(model, options).format_name(rel)
+
         # TODO: This is extremely wasteful. Refactor JAS to expose the linkage serializer?
         content = ::JSONAPI::Serializer.serialize(model, options)
-        content['data']['relationships'][rel.to_s].tap do |linkage|
+        content['data']['relationships'].fetch(options[:include]).tap do |linkage|
           %w[meta jsonapi].each do |key|
             linkage[key] = content[key] if content.key?(key)
           end
@@ -192,7 +194,7 @@ module Sinja
 
       def error_hash(title: nil, detail: nil, source: nil)
         [
-          { id: SecureRandom.uuid }.tap do |hash|
+          { :id=>SecureRandom.uuid }.tap do |hash|
             hash[:title] = title if title
             hash[:detail] = detail if detail
             hash[:status] = status.to_s if status

data/lib/sinja/relationship_routes/has_many.rb

@@ -9,7 +9,7 @@ module Sinja
         app.def_action_helper(app, :merge, %i[roles sideload_on])
         app.def_action_helper(app, :subtract, :roles)
 
-        app.head '' do
+        app.options '' do
           unless relationship_link?
             allow :get=>:fetch
           else

data/lib/sinja/relationship_routes/has_one.rb

@@ -7,7 +7,7 @@ module Sinja
         app.def_action_helper(app, :prune, %i[roles sideload_on])
         app.def_action_helper(app, :graft, %i[roles sideload_on])
 
-        app.head '' do
+        app.options '' do
           unless relationship_link?
             allow :get=>:pluck
           else

data/lib/sinja/resource.rb

@@ -89,7 +89,7 @@ module Sinja
 
         config = _resource_config[rel_type][rel] # trigger default proc
 
-        namespace %r{/[^/]+(?<r>/relationships)?/#{rel}} do
+        namespace %r{/[^/]+(?<r>/relationships)?/#{rel}(?![^/])} do
           define_singleton_method(:resource_config) { config }
 
           helpers Helpers::Nested do
@@ -97,7 +97,7 @@ module Sinja
               parent = sideloaded? && env['sinja.passthru'].to_sym
 
               roles, sideload_on = config.fetch(action, {}).values_at(:roles, :sideload_on)
-              roles.nil? || roles.empty? || roles.intersect?(memoized_role) ||
+              roles.nil? || roles.empty? || roles.intersect?(role) ||
                 parent && sideload_on.include?(parent) && super(parent, *args)
             end
 

data/lib/sinja/resource_routes.rb

@@ -9,7 +9,7 @@ module Sinja
       app.def_action_helper(app, :update, :roles)
       app.def_action_helper(app, :destroy, :roles)
 
-      app.head '', :qcaptures=>{ :filter=>:id } do
+      app.options '', :qcaptures=>{ :filter=>:id } do
         allow :get=>:show
       end
 
@@ -38,7 +38,7 @@ module Sinja
         serialize_models(resources, opts)
       end
 
-      app.head '' do
+      app.options '' do
         allow :get=>:index, :post=>:create
       end
 
@@ -82,7 +82,7 @@ module Sinja
         end
       end
 
-      app.head '/:id' do
+      app.options '/:id' do
         allow :get=>:show, :patch=>:update, :delete=>:destroy
       end
 

data/lib/sinja/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sinja
-  VERSION = '1.2.3'
+  VERSION = '1.2.4'
 end

data/sinja.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['mike@oobak.org']
 
   spec.summary       = 'RESTful, {json:api}-compliant web services in Sinatra'
-  spec.description   = <<~EOF
+  spec.description   = <<~'EOF'
     Sinja is a Sinatra extension for quickly building RESTful,
     {json:api}-compliant web services, leveraging the excellent
     JSONAPI::Serializers gem for payload serialization. It enhances Sinatra's

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -251,6 +251,7 @@ files:
 - demo-app/classes/post.rb
 - demo-app/classes/tag.rb
 - demo-app/database.rb
+- lib/jsonapi/ember_serializer.rb
 - lib/sinatra/jsonapi.rb
 - lib/sinja.rb
 - lib/sinja/config.rb
@@ -285,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: RESTful, {json:api}-compliant web services in Sinatra