sinja-sequel 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df1760457e554a3c32e7986732018fbf8aba0ebc
-  data.tar.gz: 527006ae41bc69e3c17382eeb262f1154e54b1f8
+  metadata.gz: 9b6983191193091edf129496e971949a02941748
+  data.tar.gz: 1f88be88d7d6366362543c054c2607cf4e8eb81d
 SHA512:
-  metadata.gz: 0576ac7375b2b40101dabf6c098e119f8356f4f84495f07f1cc6aec73356ce5c09912991f82c6247612ca352ca670abdcad7fce354032104372e546ba09755d3
-  data.tar.gz: f3e3fcfa3ee266d870e520991dcabf9a3402823e90d5db0d85093282278c0e7ab4d993895ad7ac603fd4b88af396588f185dfb6a9fbad85c54b67f00c52d4b58
+  metadata.gz: 64489f2281df7b119dbe0d2fc8d727dec44ff785bc9c45faa2d38b1176a165ddf36b84523ee4de18be14209376b2188209d828183660ba73e71c549dfbc64a2c
+  data.tar.gz: 9965fd332e77a4823a822e70e9377a51af27c872bafb70aa3773c261edf60e417e2d5b78cad295cde981f93d3963fe0e8eccd47fb05c7f66386111d914332931

data/README.md

@@ -33,6 +33,7 @@ out. Testers and community contributions welcome!
     - [`remove_present`](#remove_present)
     - [`add_remove`](#add_remove)
   - [Extension](#extension)
+  - [Pagination](#pagination)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -112,6 +113,10 @@ class MyApp < Sinatra::Base
   helpers do
     prepend Sinja::Sequel::Core
   end
+
+  # ..
+
+  freeze_jsonapi
 end
 ```
 
@@ -162,6 +167,10 @@ class MyApp < Sinatra::Base
   register Sinja
 
   helpers Sinja::Sequel::Helpers
+
+  # ..
+
+  freeze_jsonapi
 end
 ```
 
@@ -234,6 +243,10 @@ require 'sinja/sequel'
 class MyApp < Sinatra::Base
   register Sinja
   register Sinja::Sequel
+
+  # ..
+
+  freeze_jsonapi
 end
 ```
 
@@ -255,6 +268,66 @@ These action helpers can be subsequently overridden, customized by setting
 action helper options (i.e. `:roles`) and/or defining `before_<action>` hooks,
 or removed entirely with `remove_<action>`.
 
+Given a database connection and Foo, Bar, and Qux models and serializers,
+here's an example "classic"-style application using the extension:
+
+```ruby
+require 'sinatra/jsonapi/sequel'
+
+resource :foos do
+  has_many :bars
+  has_one :qux
+end
+
+resource :bars do
+  has_one :foo
+end
+
+resource :quxes do
+  has_many :foos
+end
+
+freeze_jsonapi
+```
+
+Pretty neat, huh?
+
+### Pagination
+
+Sinja::Sequel uses the first Sequel database to determine whether or not to
+enable pagination. If (and only if!) you have _multiple_ databases in your
+application and only _some_ support pagination, you _may_ need to prepend
+[Sinja::Sequel::Pagination](/lib/sinja/sequel/pagination.rb) after prepending
+Core, including Helpers, or registering Sinja:
+
+```ruby
+require 'sinja'
+require 'sinja/sequel'
+require 'sinja/sequel/pagination'
+
+DB = Sequel.connect ENV['DB_URL']
+
+OTHER_DB = Sequel.connect ENV['OTHER_DB_URL']
+OTHER_DB.extension :pagination
+
+class MyApp < Sinatra::Base
+  register Sinja
+  register Sinja::Sequel
+
+  helpers do
+    prepend Sinja::Sequel::Pagination
+
+    def database
+      OTHER_DB
+    end
+  end
+
+  # ..
+
+  freeze_jsonapi
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/sinatra/jsonapi/sequel.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'sinja/sequel'
 require 'sinatra/jsonapi'
+require 'sinja/sequel'
 
 module Sinatra
   register JSONAPI::Sequel

data/lib/sinja/sequel/core.rb

@@ -2,6 +2,8 @@
 require 'forwardable'
 require 'sequel'
 
+require_relative 'pagination'
+
 module Sinja
   module Sequel
     module Core
@@ -15,7 +17,7 @@ module Sinja
           c.validation_formatter = ->(e) { e.errors.keys.zip(e.errors.full_messages) }
         end
 
-        base.prepend Pagination if ::Sequel::Database::EXTENSIONS.key?(:pagination)
+        base.prepend Pagination if ::Sequel::Model.db.dataset.respond_to?(:paginate)
       end
 
       def self.included(_)
@@ -38,43 +40,5 @@ module Sinja
         raise ::Sequel::ValidationFailed, resource unless resource.valid?
       end
     end
-
-    module Pagination
-      def self.prepended(base)
-        base.sinja { |c| c.page_using = {
-          :number=>1,
-          :size=>10,
-          :record_count=>nil
-        }}
-      end
-
-      def self.included(_)
-        abort "You must `prepend' Sinja::Sequel::Pagination, not `include' it!"
-      end
-
-      def page(collection, opts)
-        collection = collection.dataset unless collection.respond_to?(:paginate)
-
-        opts = settings._sinja.page_using.merge(opts)
-        collection = collection.paginate opts[:number].to_i, opts[:size].to_i,
-          (opts[:record_count].to_i if opts[:record_count])
-
-        # Attributes common to all pagination links
-        base = {
-          :size=>collection.page_size,
-          :record_count=>collection.pagination_record_count
-        }
-
-        pagination = {
-          :first=>base.merge(:number=>1),
-          :self=>base.merge(:number=>collection.current_page),
-          :last=>base.merge(:number=>collection.page_count)
-        }
-        pagination[:next] = base.merge(:number=>collection.next_page) if collection.next_page
-        pagination[:prev] = base.merge(:number=>collection.prev_page) if collection.prev_page
-
-        return collection, pagination
-      end
-    end
   end
 end

data/lib/sinja/sequel/pagination.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Sinja
+  module Sequel
+    module Pagination
+      def self.prepended(base)
+        base.sinja { |c| c.page_using = {
+          :number=>1,
+          :size=>10,
+          :record_count=>nil
+        }}
+      end
+
+      def self.included(_)
+        abort "You must `prepend' Sinja::Sequel::Pagination, not `include' it!"
+      end
+
+      def page(collection, opts)
+        collection = collection.dataset unless collection.respond_to?(:paginate)
+
+        opts = settings._sinja.page_using.merge(opts)
+        collection = collection.paginate opts[:number].to_i, opts[:size].to_i,
+          (opts[:record_count].to_i if opts[:record_count])
+
+        # Attributes common to all pagination links
+        base = {
+          :size=>collection.page_size,
+          :record_count=>collection.pagination_record_count
+        }
+
+        pagination = {
+          :first=>base.merge(:number=>1),
+          :self=>base.merge(:number=>collection.current_page),
+          :last=>base.merge(:number=>collection.page_count)
+        }
+        pagination[:next] = base.merge(:number=>collection.next_page) if collection.next_page
+        pagination[:prev] = base.merge(:number=>collection.prev_page) if collection.prev_page
+
+        return collection, pagination
+      end
+    end
+  end
+end

data/lib/sinja/sequel/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Sinja
   module Sequel
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

data/lib/sinja/sequel.rb

@@ -15,19 +15,23 @@ module Sinja
         register Resource
 
         helpers do
+          def dataset
+            klass.dataset
+          end
+
           def find(id)
-            klass[id.send(try_convert)]
+            dataset[id.send(try_convert)]
           end
         end
 
         show
 
         show_many do |ids|
-          klass.where(klass.primary_key=>ids.map(&try_convert)).all
+          dataset.where(klass.primary_key=>ids.map!(&try_convert)).all
         end
 
         index do
-          klass.dataset
+          dataset
         end
 
         create do |attr|

data/sinja-sequel.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency 'sequel', '~> 4.0'
-  spec.add_dependency 'sinja', '>= 1.2.0.pre2', '< 2'
+  spec.add_dependency 'sinja', '~> 1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'minitest', '~> 5.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja-sequel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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: sequel
@@ -28,22 +28,16 @@ dependencies:
   name: sinja
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0.pre2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0.pre2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +99,7 @@ files:
 - lib/sinja/sequel.rb
 - lib/sinja/sequel/core.rb
 - lib/sinja/sequel/helpers.rb
+- lib/sinja/sequel/pagination.rb
 - lib/sinja/sequel/version.rb
 - sinja-sequel.gemspec
 homepage: https://github.com/mwpastore/sinja-sequel