sinja 1.2.0.pre3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d0d656750a406ce8ac8f8e3fc227dcd9123970
-  data.tar.gz: 87b665b88f0abc9097b935ed59a648d5fdbca4e7
+  metadata.gz: 2baae47c1aa32d45265b3726e8a57163bf1d381e
+  data.tar.gz: 2e3de4a123865207d3a9bc6090563fa979a8ee52
 SHA512:
-  metadata.gz: 14557eda5449b7249797c693497f7bf686c0dd4b040e78fdd77e868df6b3b21c794ca7709f4cd37a0cc40ace6edc2e26f424156a35b4227be9b9190873339b1d
-  data.tar.gz: d9a3e61434e0733425045e110a494bd25f4c57176ffb5ba6e374c8b45a883f1ea42704d77f3426ff73e5ae035ebcb2ed4e6830be6185e24151c47628e52dde83
+  metadata.gz: 6fcfb53cdc190885a45594927e6fdb335c2fe44152884fe7051d3420f6431a7d7762215c924aea8526fd9486deb664a58486b3858d2b17f77e072f6d9b131f63
+  data.tar.gz: 952f451d6e3f18c992015e14d82fde782e866cdd078b06bbff30a00944b1c4a623a49c673fc971630f51ad943be7aebe59c3f50e900dd7f002ad7432720f4afc

data/README.md

@@ -47,6 +47,7 @@ the {json:api} specification is).
     - [`resource`](#resource)
       - [`index {..}` => Array](#index---array)
       - [`show {|id| ..}` => Object](#show-id---object)
+      - [`show {..}` => Object](#show---object)
       - [`show_many {|ids| ..}` => Array](#show_many-ids---array)
       - [`create {|attr, id| ..}` => id, Object?](#create-attr-id---id-object)
       - [`create {|attr| ..}` => id, Object](#create-attr---id-object)
@@ -260,12 +261,10 @@ class App < Sinatra::Base
       end
     end
 
-    show do |id|
-      book = find(id)
-      next unless book
-      headers 'X-ISBN'=>book.isbn
-      last_modified book.updated_at
-      next book, include: %w[author]
+    show do
+      headers 'X-ISBN'=>resource.isbn
+      last_modified resource.updated_at
+      next resource, include: %w[author]
     end
 
     has_one :author do
@@ -482,8 +481,8 @@ Much of Sinja's advanced functionality (e.g. updating and destroying resources,
 relationship routes) is dependent upon its ability to locate the corresponding
 resource for a request. To enable these features, define an ordinary helper
 method named `find` in your resource definition that takes a single ID argument
-and returns the corresponding object. You can, of course, use this helper
-method elsewhere in your application, such as in your `show` action helper.
+and returns the corresponding object. Once defined, a `resource` object will
+be made available in any action helpers that operate on a single resource.
 
 ```ruby
 resource :posts do
@@ -493,8 +492,8 @@ resource :posts do
     end
   end
 
-  show do |id|
-    next find(id), include: 'comments'
+  show do
+    next resource, include: 'comments'
   end
 end
 ```
@@ -514,7 +513,7 @@ end
 
 * How do I control access to the resource locator?
 
-  You don't. Instead, control access to the action helpers that use it:
+  You don't. Instead, control access to the action helpers that use it: `show`,
   `update`, `destroy`, and all of the relationship action helpers such as
   `pluck` and `fetch`.
 
@@ -525,7 +524,7 @@ end
 
 As a bit of syntactic sugar, if you define a `find` helper and subsequently
 call `show` without a block, Sinja will generate a `show` action helper that
-delegates to `find`.
+simply returns `resource`.
 
 ### Action Helpers
 
@@ -560,8 +559,15 @@ Return an array of zero or more objects to serialize on the response.
 
 ##### `show {|id| ..}` => Object
 
-Take an ID and return the corresponding object (or `nil` if not found) to
-serialize on the response.
+Without a resource locator: Take an ID and return the corresponding object (or
+`nil` if not found) to serialize on the response. (Note that only one or the
+other `show` action helpers is allowed in any given resource block.)
+
+##### `show {..}` => Object
+
+With a resource locator: Return the `resource` object to serialize on the
+response. (Note that only one or the other `show` action helpers is allowed in
+any given resource block.)
 
 ##### `show_many {|ids| ..}` => Array
 
@@ -840,7 +846,7 @@ show do |id|
   exclude = []
   exclude << 'secrets' unless role?(:admin)
 
-  next find(id), exclude: exclude
+  next resource, exclude: exclude
 end
 ```
 
@@ -1370,12 +1376,12 @@ constraints on the join table.
 
 ### Coalesced Find Requests
 
-If your {json:api} client coalesces find requests, the `show` action helper will
-be invoked once for each ID in the `:id` filter, and the resulting collection
-will be serialized on the response. Both query parameter syntaxes for arrays
-are supported: `?filter[id]=1,2` and `?filter[id][]=1&filter[id][]=2`. If any
-ID is not found (i.e. `show` returns `nil`), the route will halt with HTTP
-status 404.
+If your {json:api} client coalesces find requests, the resource locator (or
+`show` action helper) will be invoked once for each ID in the `:id` filter, and
+the resulting collection will be serialized on the response. Both query
+parameter syntaxes for arrays are supported: `?filter[id]=1,2` and
+`?filter[id][]=1&filter[id][]=2`. If any ID is not found (i.e. `show` returns
+`nil`), the route will halt with HTTP status 404.
 
 Optionally, to reduce round trips to the database, you may define a "special"
 `show_many` action helper that takes an array of IDs to show. It does not take

data/demo-app/classes/comment.rb

@@ -46,8 +46,8 @@ CommentController = proc do
     end
   end
 
-  show do |id|
-    next find(id), include: 'author'
+  show do
+    next resource, include: 'author'
   end
 
   create(roles: :logged_in) do |attr|

data/demo-app/classes/post.rb

@@ -59,8 +59,8 @@ PostController = proc do
     end
   end
 
-  show do |slug|
-    next find(slug), include: %w[author comments tags]
+  show do
+    next resource, include: %w[author comments tags]
   end
 
   show_many do |slugs|

data/demo-app/classes/tag.rb

@@ -58,19 +58,19 @@ TagController = proc do
     end
 
     replace(roles: :logged_in) do |rios|
-      add_remove(:posts, rios) do |post|
+      add_remove(:posts, rios, :to_s) do |post|
         role?(:superuser) || post.author == current_user
       end
     end
 
     merge(roles: :logged_in) do |rios|
-      add_missing(:posts, rios) do |post|
+      add_missing(:posts, rios, :to_s) do |post|
         role?(:superuser) || post.author == current_user
       end
     end
 
     subtract(roles: :logged_in) do |rios|
-      remove_present(:posts, rios) do |post|
+      remove_present(:posts, rios, :to_s) do |post|
         role?(:superuser) || post.author == current_user
       end
     end

data/lib/sinatra/jsonapi.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'sinatra'
 require 'sinja'
 
 module Sinatra

data/lib/sinja.rb

@@ -48,7 +48,7 @@ module Sinja
         end
       end
 
-      before %r{/(?<id>[^/]+)(?:/.*)?} do |id|
+      before %r{/(?<id>[^/]+)(?:/.+)?} do |id|
         self.resource =
           if env.key?('sinja.resource')
             env['sinja.resource']

data/lib/sinja/resource.rb

@@ -28,7 +28,7 @@ module Sinja
         return unless block ||=
           case !method_defined?(action) && action
           when :show
-            proc { |id| find(id) } if method_defined?(:find)
+            proc { resource } if method_defined?(:find)
           end
 
         # TODO: Move this to a constant or configurable?

data/lib/sinja/resource_routes.rb

@@ -18,18 +18,22 @@ module Sinja
         ids = ids.split(',') if String === ids
         ids = [*ids].tap(&:uniq!)
 
-        resources, opts = [], {}
-        if respond_to?(:show_many)
-          resources, opts = show_many(ids)
-          raise NotFoundError, "Resource(s) not found" \
-            unless ids.length == resources.length
-        else
-          ids.each do |id|
-            tmp, opts = show(id)
-            raise NotFoundError, "Resource '#{id}' not found" unless tmp
-            resources << tmp
+        resources, opts =
+          if respond_to?(:show_many)
+            show_many(ids)
+          else
+            finder =
+              if respond_to?(:find)
+                method(:find)
+              else
+                proc { |id| show(id).first }
+              end
+
+            [ids.map!(&finder).tap(&:compact!), {}]
           end
-        end
+
+        raise NotFoundError, "Resource(s) not found" \
+          unless ids.length == resources.length
 
         serialize_models(resources, opts)
       end
@@ -52,9 +56,7 @@ module Sinja
         transaction do
           id, self.resource, opts =
             begin
-              args = [attributes]
-              args << data[:id] if data.key?(:id)
-              create(*args)
+              create(*[attributes].tap { |a| a << data[:id] if data.key?(:id) })
             rescue ArgumentError
               if data.key?(:id)
                 raise ForbiddenError, 'Client-generated ID not supported'
@@ -85,7 +87,7 @@ module Sinja
       end
 
       app.get '/:id', :qparams=>%i[include fields], :actions=>:show do |id|
-        tmp, opts = show(id)
+        tmp, opts = show(*[].tap { |a| a << id unless respond_to?(:find) })
         raise NotFoundError, "Resource '#{id}' not found" unless tmp
         serialize_model(tmp, opts)
       end

data/lib/sinja/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sinja
-  VERSION = '1.2.0.pre3'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre3
+  version: 1.2.1
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-15 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,9 +265,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8