jsonapi_compliable 0.4.0 → 0.5.1

data/lib/jsonapi_compliable/{scope → scoping}/filterable.rb

@@ -1,5 +1,5 @@
 module JsonapiCompliable
-  module Scope::Filterable
+  module Scoping::Filterable
     def find_filter(name)
       find_filter!(name)
     rescue JsonapiCompliable::Errors::BadFilter
@@ -8,16 +8,16 @@ module JsonapiCompliable
 
     def find_filter!(name)
       filter_name, filter_value = \
-        dsl.filters.find { |_name, opts| opts[:aliases].include?(name.to_sym) }
+        resource.filters.find { |_name, opts| opts[:aliases].include?(name.to_sym) }
       raise JsonapiCompliable::Errors::BadFilter unless filter_name
       if guard = filter_value[:if]
-        raise JsonapiCompliable::Errors::BadFilter if controller.send(guard) == false
+        raise JsonapiCompliable::Errors::BadFilter if resource.context[:object].send(guard) == false
       end
       { filter_name => filter_value }
     end
 
     def filter_param
-      params[:filter] || {}
+      query_hash[:filter]
     end
   end
 end

data/lib/jsonapi_compliable/{scope → scoping}/paginate.rb

@@ -1,5 +1,5 @@
 module JsonapiCompliable
-  class Scope::Paginate < Scope::Base
+  class Scoping::Paginate < Scoping::Base
     MAX_PAGE_SIZE = 1_000
 
     def apply
@@ -12,11 +12,11 @@ module JsonapiCompliable
     end
 
     def custom_scope
-      dsl.pagination
+      resource.pagination
     end
 
     def apply_standard_scope
-      @scope.page(number).per(size)
+      resource.adapter.paginate(@scope, number, size)
     end
 
     def apply_custom_scope
@@ -26,15 +26,15 @@ module JsonapiCompliable
     private
 
     def page_param
-      @page_param ||= (params[:page] || {})
+      @page_param ||= (query_hash[:page] || {})
     end
 
     def number
-      (page_param[:number] || controller.default_page_number).to_i
+      (page_param[:number] || resource.default_page_number).to_i
     end
 
     def size
-      (page_param[:size] || controller.default_page_size).to_i
+      (page_param[:size] || resource.default_page_size).to_i
     end
   end
 end

data/lib/jsonapi_compliable/scoping/sort.rb

@@ -0,0 +1,33 @@
+module JsonapiCompliable
+  class Scoping::Sort < Scoping::Base
+    def custom_scope
+      resource.sorting
+    end
+
+    def apply_standard_scope
+      each_sort do |attribute, direction|
+        @scope = resource.adapter.order(@scope, attribute, direction)
+      end
+      @scope
+    end
+
+    def apply_custom_scope
+      each_sort do |attribute, direction|
+        @scope = custom_scope.call(@scope, attribute, direction)
+      end
+      @scope
+    end
+
+    private
+
+    def each_sort
+      sort_param.each do |sort_hash|
+        yield sort_hash.keys.first, sort_hash.values.first
+      end
+    end
+
+    def sort_param
+      @sort_param ||= query_hash[:sort].empty? ? resource.default_sort : query_hash[:sort]
+    end
+  end
+end

data/lib/jsonapi_compliable/sideload.rb

@@ -0,0 +1,95 @@
+module JsonapiCompliable
+  class Sideload
+    attr_reader :name,
+      :resource,
+      :polymorphic,
+      :sideloads,
+      :scope_proc,
+      :assign_proc,
+      :grouper
+
+    def initialize(name, opts)
+      @name               = name
+      @resource           = (opts[:resource] || Class.new(Resource)).new
+      @sideloads          = {}
+      @polymorphic        = !!opts[:polymorphic]
+      @polymorphic_groups = {} if polymorphic?
+
+      extend @resource.adapter.sideloading_module
+    end
+
+    def polymorphic?
+      @polymorphic == true
+    end
+
+    def scope(&blk)
+      @scope_proc = blk
+    end
+
+    def assign(&blk)
+      @assign_proc = blk
+    end
+
+    def group_by(&grouper)
+      @grouper = grouper
+    end
+
+    def resolve(parents, query, namespace = nil)
+      namespace ||= name
+
+      if polymorphic?
+        resolve_polymorphic(parents, query)
+      else
+        resolve_basic(parents, query, namespace)
+      end
+    end
+
+    def allow_sideload(name, opts = {}, &blk)
+      sideload = Sideload.new(name, opts)
+      sideload.instance_eval(&blk) if blk
+
+      if polymorphic?
+        @polymorphic_groups[name] = sideload
+      else
+        @sideloads[name] = sideload
+      end
+    end
+
+    def sideload(name)
+      @sideloads[name]
+    end
+
+    # Grab from nested sideloads, AND resource, recursively
+    def to_hash
+      { name => {} }.tap do |hash|
+        @sideloads.each_pair do |key, sideload|
+          hash[name][key] = sideload.to_hash[key]
+
+          if sideloading = sideload.resource.sideloading
+            sideloading.sideloads.each_pair do |k, s|
+              hash[name][k] = s.to_hash[k]
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def resolve_polymorphic(parents, query)
+      parents.group_by(&@grouper).each_pair do |group_type, group_members|
+        sideload_for_group = @polymorphic_groups[group_type]
+        if sideload_for_group
+          sideload_for_group.resolve(group_members, query, name)
+        end
+      end
+    end
+
+    def resolve_basic(parents, query, namespace)
+      sideload_scope   = scope_proc.call(parents)
+      sideload_scope   = Scope.new(sideload_scope, resource, query, namespace: namespace)
+      sideload_results = sideload_scope.resolve
+      assign_proc.call(parents, sideload_results)
+    end
+  end
+end

data/lib/jsonapi_compliable/stats/dsl.rb

@@ -3,19 +3,10 @@ module JsonapiCompliable
     class DSL
       attr_reader :name, :calculations
 
-      def self.defaults
-        {
-          count: ->(scope, attr) { scope.count },
-          average: ->(scope, attr) { scope.average(attr).to_f },
-          sum: ->(scope, attr) { scope.sum(attr) },
-          maximum: ->(scope, attr) { scope.maximum(attr) },
-          minimum: ->(scope, attr) { scope.minimum(attr) }
-        }
-      end
-
-      def initialize(config)
+      def initialize(adapter, config)
         config = { config => [] } if config.is_a?(Symbol)
 
+        @adapter = adapter
         @calculations = {}
         @name = config.keys.first
         Array(config.values.first).each { |c| send(:"#{c}!") }
@@ -31,23 +22,23 @@ module JsonapiCompliable
       end
 
       def count!
-        @calculations[:count] = self.class.defaults[:count]
+        @calculations[:count] = @adapter.method(:count)
       end
 
       def sum!
-        @calculations[:sum] = self.class.defaults[:sum]
+        @calculations[:sum] = @adapter.method(:sum)
       end
 
       def average!
-        @calculations[:average] = self.class.defaults[:average]
+        @calculations[:average] = @adapter.method(:average)
       end
 
       def maximum!
-        @calculations[:maximum] = self.class.defaults[:maximum]
+        @calculations[:maximum] = @adapter.method(:maximum)
       end
 
       def minimum!
-        @calculations[:minimum] = self.class.defaults[:minimum]
+        @calculations[:minimum] = @adapter.method(:minimum)
       end
     end
   end

data/lib/jsonapi_compliable/stats/payload.rb

@@ -1,18 +1,18 @@
 module JsonapiCompliable
   module Stats
     class Payload
-      def initialize(controller, scope)
-        @dsl       = controller._jsonapi_compliable
-        @directive = controller.params[:stats]
-        @scope     = controller._jsonapi_scope || scope
+      def initialize(dsl, query_hash, scope)
+        @dsl        = dsl
+        @query_hash = query_hash[:stats]
+        @scope      = scope
       end
 
       def generate
         {}.tap do |stats|
-          @directive.each_pair do |name, calculation|
+          @query_hash.each_pair do |name, calculation|
             stats[name] = {}
 
-            each_calculation(name, parse_calculation(calculation)) do |calc, function|
+            each_calculation(name, calculation) do |calc, function|
               stats[name][calc] = function.call(@scope, name)
             end
           end
@@ -27,14 +27,6 @@ module JsonapiCompliable
           yield calc, function
         end
       end
-
-      def parse_calculation(calculation)
-        if calculation.is_a?(String)
-          calculation.split(',').map(&:to_sym)
-        else
-          calculation.map(&:to_sym)
-        end
-      end
     end
   end
 end

data/lib/jsonapi_compliable/util/field_params.rb

@@ -1,17 +1,15 @@
 module JsonapiCompliable
   module Util
     class FieldParams
-      def self.parse!(params, name)
-        return unless params[name]
+      def self.parse(params)
+        return {} if params.nil?
 
-        params[name].each_pair do |key, value|
-          params[name][key] = value.split(',').map(&:to_sym)
+        {}.tap do |parsed|
+          params.each_pair do |key, value|
+            parsed[key.to_sym] = value.split(',').map(&:to_sym)
+          end
         end
       end
-
-      def self.fieldset(params, name)
-        params[name].to_unsafe_hash.deep_symbolize_keys
-      end
     end
   end
 end

data/lib/jsonapi_compliable/util/hash.rb

@@ -0,0 +1,14 @@
+module JsonapiCompliable
+  module Util
+    class Hash
+      def self.keys(hash, collection = [])
+        hash.each_pair do |key, value|
+          collection << key
+          keys(value, collection)
+        end
+
+        collection
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/include_params.rb

@@ -1,28 +1,17 @@
 module JsonapiCompliable
   module Util
     class IncludeParams
-      def self.compare(includes, whitelist)
-        {}.tap do |valid|
-          includes.to_hash.each_pair do |key, sub_hash|
-            if whitelist[key]
-              valid[key] = compare(sub_hash, whitelist[key])
+      class << self
+        def scrub(requested_includes, allowed_includes)
+          {}.tap do |valid|
+            requested_includes.each_pair do |key, sub_hash|
+              if allowed_includes[key]
+                valid[key] = scrub(sub_hash, allowed_includes[key])
+              end
             end
           end
         end
       end
-
-      def self.scrub(controller)
-        dsl       = controller._jsonapi_compliable
-        whitelist = dsl.sideloads[:whitelist] || {}
-        whitelist = whitelist[controller.action_name]
-        includes  = JSONAPI::IncludeDirective.new(controller.params[:include])
-
-        if whitelist
-          Util::IncludeParams.compare(includes, whitelist)
-        else
-          {}
-        end
-      end
     end
   end
 end

data/lib/jsonapi_compliable/util/render_options.rb

@@ -0,0 +1,25 @@
+module JsonapiCompliable
+  module Util
+    class RenderOptions
+      def self.generate(object, query_hash, overrides = {})
+        resolved = object.respond_to?(:resolve) ? object.resolve : object
+
+        options            = {}
+        options[:include]  = query_hash[:include]
+        options[:jsonapi]  = resolved
+        options[:fields]   = query_hash[:fields]
+        options.merge!(overrides)
+        options[:meta]   ||= {}
+        options[:expose] ||= {}
+        options[:expose][:extra_fields] = query_hash[:extra_fields]
+
+        if object.respond_to?(:resolve_stats)
+          stats = object.resolve_stats
+          options[:meta][:stats] = stats unless stats.empty?
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

data/lib/jsonapi_compliable.rb

@@ -1,22 +1,31 @@
-require 'jsonapi/rails'
-
 require "jsonapi_compliable/version"
 require "jsonapi_compliable/errors"
-require "jsonapi_compliable/dsl"
-require "jsonapi_compliable/scope/base"
-require "jsonapi_compliable/scope/sort"
-require "jsonapi_compliable/scope/paginate"
-require "jsonapi_compliable/scope/sideload"
-require "jsonapi_compliable/scope/extra_fields"
-require "jsonapi_compliable/scope/filterable"
-require "jsonapi_compliable/scope/default_filter"
-require "jsonapi_compliable/scope/filter"
+require "jsonapi_compliable/resource"
+require "jsonapi_compliable/query"
+require "jsonapi_compliable/sideload"
+require "jsonapi_compliable/scope"
+require "jsonapi_compliable/scoping/base"
+require "jsonapi_compliable/scoping/sort"
+require "jsonapi_compliable/scoping/paginate"
+require "jsonapi_compliable/scoping/extra_fields"
+require "jsonapi_compliable/scoping/filterable"
+require "jsonapi_compliable/scoping/default_filter"
+require "jsonapi_compliable/scoping/filter"
+require "jsonapi_compliable/util/render_options"
+require "jsonapi_compliable/adapters/abstract"
 require "jsonapi_compliable/stats/dsl"
 require "jsonapi_compliable/stats/payload"
 require "jsonapi_compliable/util/include_params"
 require "jsonapi_compliable/util/field_params"
-require "jsonapi_compliable/util/scoping"
-require "jsonapi_compliable/util/pagination"
+require "jsonapi_compliable/util/hash"
+
+# require correct jsonapi-rb before extensions
+if defined?(Rails)
+  require 'jsonapi_compliable/rails'
+else
+  require 'jsonapi/serializable'
+end
+
 require "jsonapi_compliable/extensions/extra_attribute"
 require "jsonapi_compliable/extensions/boolean_attribute"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,30 +9,10 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: jsonapi-rails
+  name: jsonapi-serializable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -46,47 +26,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: activerecord
   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'
-- !ruby/object:Gem::Dependency
-  name: active_model_serializers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '4.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
-  name: jsonapi_spec_helpers
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -115,20 +87,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -180,33 +138,39 @@ files:
 - bin/console
 - bin/rspec
 - bin/setup
-- gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_4.gemfile.lock
 - gemfiles/rails_5.gemfile
 - gemfiles/rails_5.gemfile.lock
 - jsonapi_compliable.gemspec
 - lib/jsonapi_compliable.rb
+- lib/jsonapi_compliable/adapters/abstract.rb
+- lib/jsonapi_compliable/adapters/active_record.rb
+- lib/jsonapi_compliable/adapters/active_record_sideloading.rb
+- lib/jsonapi_compliable/adapters/null.rb
 - lib/jsonapi_compliable/base.rb
 - lib/jsonapi_compliable/deserializable.rb
-- lib/jsonapi_compliable/dsl.rb
 - lib/jsonapi_compliable/errors.rb
 - lib/jsonapi_compliable/extensions/boolean_attribute.rb
 - lib/jsonapi_compliable/extensions/extra_attribute.rb
-- lib/jsonapi_compliable/scope/base.rb
-- lib/jsonapi_compliable/scope/default_filter.rb
-- lib/jsonapi_compliable/scope/extra_fields.rb
-- lib/jsonapi_compliable/scope/filter.rb
-- lib/jsonapi_compliable/scope/filterable.rb
-- lib/jsonapi_compliable/scope/paginate.rb
-- lib/jsonapi_compliable/scope/sideload.rb
-- lib/jsonapi_compliable/scope/sort.rb
+- lib/jsonapi_compliable/query.rb
+- lib/jsonapi_compliable/rails.rb
+- lib/jsonapi_compliable/resource.rb
+- lib/jsonapi_compliable/scope.rb
+- lib/jsonapi_compliable/scoping/base.rb
+- lib/jsonapi_compliable/scoping/default_filter.rb
+- lib/jsonapi_compliable/scoping/extra_fields.rb
+- lib/jsonapi_compliable/scoping/filter.rb
+- lib/jsonapi_compliable/scoping/filterable.rb
+- lib/jsonapi_compliable/scoping/paginate.rb
+- lib/jsonapi_compliable/scoping/sort.rb
+- lib/jsonapi_compliable/sideload.rb
 - lib/jsonapi_compliable/stats/dsl.rb
 - lib/jsonapi_compliable/stats/payload.rb
 - lib/jsonapi_compliable/util/field_params.rb
+- lib/jsonapi_compliable/util/hash.rb
 - lib/jsonapi_compliable/util/include_params.rb
-- lib/jsonapi_compliable/util/pagination.rb
-- lib/jsonapi_compliable/util/scoping.rb
+- lib/jsonapi_compliable/util/render_options.rb
 - lib/jsonapi_compliable/version.rb
 homepage: 
 licenses:

data/gemfiles/rails_3.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://artprod.dev.bloomberg.com/artifactory/api/gems/rubygems/"
-
-gem "appraisal"
-gem "active_model_serializers", :git => "https://github.com/richmolj/active_model_serializers.git"
-gem "rails", "~> 3.2"
-
-gemspec :path => "../"