sequel-jsonapi_eager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f90fa7b6e3f683a6a25a63901985bac74893597
+  data.tar.gz: cf500a78f631337659560ee93f3c9511569d8fea
+SHA512:
+  metadata.gz: 333cefb4fa6d1b2fbe327e77be20a2230f1d66c829ba2875591c7877be44d5d25d9cae7860e05294806619e3f0ac7f54f342f3f260d831a14ed4b4eb1c4576f3
+  data.tar.gz: 3e8f33edb42496dccb4afc36ba51c3b1e39dedc2f4090bf16a533f1b86397518d92c5a148fe03b23b4fb496f8170152e662a38fc0a11d90dee548553f7c29cd8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Sequel::Plugins::JsonapiEager
+
+This [Sequel](http://sequel.jeremyevans.net/) plugin enables you to dynamically
+eager load associations of objects you're exposing for your JSON API.
+
+## Motivation
+
+The [JSON-API](http://jsonapi.org/) specification introduces the ability for
+clients to choose which associations they want to include in the response:
+
+```http
+GET /users?include=quizzes.questions,posts
+```
+
+You as an author of the API want to eager load those associations, to avoid
+N+1 queries. However, Sequel has a slighly different API for eager loading
+associations:
+
+```rb
+User.eager(:quizzes => :questions).eager(:posts)
+```
+
+This plugin translates the JSON-API `include` format into Sequel.
+
+## Usage
+
+```ruby
+gem 'sequel-jsonapi_eager'
+```
+
+This plugin exposes the `jsonapi_eager` method to your Sequel objects, to which
+you can pass in the `include` query parameter.
+
+```ruby
+User.plugin :jsonapi_eager
+
+users = User.jsonapi_eager("quizzes.questions,posts")
+# translates into `User.eager(:quizzes => :questions).eager(:posts)`
+
+users.all
+# SELECT * FROM `users`
+# SELECT * FROM `quizzes` WHERE (`quizzes`.`user_id` IN (3, 54, 5))
+# SELECT * FROM `questions` WHERE (`questions`.`quiz_id` IN (2, 17, 19, 43))
+# SELECT * FROM `posts` WHERE (`posts`.`user_id` IN (3, 54, 5))
+```
+
+You can also use this method in the dataset:
+
+```ruby
+User.active.jsonapi_eager("quizzes.questions,posts")
+```
+
+What this plugin also gives you, which was the non-trivial part of the plugin,
+is the ability to eager load associations on model *instances*.
+
+```ruby
+user = User[user_id]
+user.jsonapi_eager("quizzes.questions,posts")
+```
+
+You need this when exposing single resources in your API, because you need to
+determine what to eager load at serialization time, at which point you only
+have the instance. Moreover, Sequel removes the eager loading when you fetch
+single records, so the following doesn't work:
+
+```ruby
+user = User.eager(:quizzes => :questions)[user_id]
+user # Doesn't contain the eager loading anymore
+user.quizzes.map(&:questions) # N+1 query
+```
+
+This plugins helps you make very flexible APIs, while still keeping the
+performance tip-top.
+
+## License
+
+[MIT](/LICENSE.txt)

data/lib/sequel/plugins/jsonapi_eager.rb

@@ -0,0 +1,35 @@
+module Sequel
+  module Plugins
+    module JsonapiEager
+      module DatasetMethods
+        def jsonapi_eager(includes)
+          includes = includes.split(",") if includes.is_a?(String)
+
+          eager_args = includes.map do |relationship|
+            path = relationship.split(".").map(&:to_sym)
+            path.reverse.inject { |hash, rel| {rel => hash} }
+          end
+
+          eager(*eager_args)
+        end
+      end
+
+      ClassMethods = DatasetMethods
+
+      module InstanceMethods
+        def jsonapi_eager(includes)
+          includes = includes.split(",") if includes.is_a?(String)
+
+          includes.each do |relationship|
+            association_name, association_include = relationship.split(".", 2)
+            association_dataset = send("#{association_name}_dataset")
+              .jsonapi_eager(association_include.to_s)
+            associations[association_name.to_sym] = association_dataset.all
+          end
+
+          self
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sequel-jsonapi_eager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sequel/plugins/jsonapi_eager.rb
+homepage: https://github.com/janko-m/sequel-jsonapi_eager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Sequel plugin for eager loading associations in JSON-API specification.
+test_files: []
+has_rdoc: