jsonapi_compliable 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0e2b34af698b690cd0d1f5fea26dcc427cb8c2
-  data.tar.gz: e0e5a124231ae7e35fdaeb75365aa88537657ad8
+  metadata.gz: e0418e83aaae7d67b616dab559f7f5986430d022
+  data.tar.gz: da31edddd52610cd95b14868b797b4197b508a68
 SHA512:
-  metadata.gz: f9f74ff51519f73a6e85cd3c1b0dac20dc4111b044d7c93e9218415cf647143a9b57bf76c23c8611e66f2d509df3779e08a46644d8696d6678284b7702120252
-  data.tar.gz: 762dc586bda947c104cea4aec73ee89164608644dc10aa09f552dca22762307f9eff761a8b78256899242c1153ce24928d6fa72d9ac5af6d43eca113427a89a5
+  metadata.gz: cf21cdf1b18b9af6190d790214e24009ab48c679d18f4d12b40d97952053d0752e1363d59dc8921a77cf3b845de07327381e412fa600bebaaa1193d3b7fe40de
+  data.tar.gz: 999ba235c7156753d37c5f8a3a8a70dc5f980fde4598e37d4ca6c597cc92db8ce04dac4bc6a88daba63c789a9512083587e80da87e5bec3c60b57c88e8d76efc

data/lib/jsonapi_compliable/base.rb

@@ -7,7 +7,7 @@ module JsonapiCompliable
 
     included do
       class_attribute :_jsonapi_compliable
-      attr_reader :_jsonapi_scoped
+      attr_reader :_jsonapi_scope
 
       before_action :parse_fieldsets!
       after_action :reset_scope_flag
@@ -36,13 +36,14 @@ module JsonapiCompliable
       scope = JsonapiCompliable::Scope::ExtraFields.new(self, scope).apply if extra_fields
       scope = JsonapiCompliable::Scope::Sideload.new(self, scope).apply if includes
       scope = JsonapiCompliable::Scope::Sort.new(self, scope).apply if sort
+      # This is set before pagination so it can be re-used for stats
+      @_jsonapi_scope = scope
       scope = JsonapiCompliable::Scope::Paginate.new(self, scope).apply if paginate
-      @_jsonapi_scoped = true
       scope
     end
 
     def reset_scope_flag
-      @_jsonapi_scoped = false
+      @_jsonapi_scope = nil
     end
 
     def parse_fieldsets!
@@ -51,14 +52,16 @@ module JsonapiCompliable
     end
 
     def render_ams(scope, opts = {})
-      scope = jsonapi_scope(scope) if Util::Scoping.apply?(self, scope, opts.delete(:scope))
+      scoped = Util::Scoping.apply?(self, scope, opts.delete(:scope)) ? jsonapi_scope(scope) : scope
       options = default_ams_options
       options[:include] = forced_includes || Util::IncludeParams.scrub(self)
-      options[:jsonapi] = scope
+      options[:jsonapi] = JsonapiCompliable::Util::Pagination.zero?(params) ? [] : scoped
       options[:fields] = Util::FieldParams.fieldset(params, :fields) if params[:fields]
       options[:extra_fields] = Util::FieldParams.fieldset(params, :extra_fields) if params[:extra_fields]
-
+      options[:meta] ||= {}
       options.merge!(opts)
+      options[:meta][:stats] = Stats::Payload.new(self, scoped).generate if params[:stats]
+
       render(options)
     end
 

data/lib/jsonapi_compliable/dsl.rb

@@ -5,6 +5,7 @@ module JsonapiCompliable
       :extra_fields,
       :filters,
       :sorting,
+      :stats,
       :pagination
 
     def initialize
@@ -19,6 +20,7 @@ module JsonapiCompliable
       instance.extra_fields = extra_fields.deep_dup
       instance.sorting = sorting.deep_dup
       instance.pagination = pagination.deep_dup
+      instance.stats = stats.deep_dup
       instance
     end
 
@@ -27,6 +29,7 @@ module JsonapiCompliable
       @filters = {}
       @default_filters = {}
       @extra_fields = {}
+      @stats = {}
       @sorting = nil
       @pagination = nil
     end
@@ -50,6 +53,12 @@ module JsonapiCompliable
       }
     end
 
+    def allow_stat(symbol_or_hash, &blk)
+      dsl = Stats::DSL.new(symbol_or_hash)
+      dsl.instance_eval(&blk) if blk
+      @stats[dsl.name] = dsl
+    end
+
     def default_filter(name, &blk)
       @default_filters[name.to_sym] = {
         filter: blk
@@ -71,5 +80,11 @@ module JsonapiCompliable
         proc: blk
       }
     end
+
+    def stat(attribute, calculation)
+      stats_dsl = @stats[attribute] || @stats[attribute.to_sym]
+      raise Errors::StatNotFound.new(attribute, calculation) unless stats_dsl
+      stats_dsl.calculation(calculation)
+    end
   end
 end

data/lib/jsonapi_compliable/errors.rb

@@ -11,5 +11,26 @@ module JsonapiCompliable
         "Requested page size #{@size} is greater than max supported size #{@max}"
       end
     end
+
+    class StatNotFound < StandardError
+      def initialize(attribute, calculation)
+        @attribute = attribute
+        @calculation = calculation
+      end
+
+      def message
+        "No stat configured for calculation #{pretty(@calculation)} on attribute #{pretty(@attribute)}"
+      end
+
+      private
+
+      def pretty(input)
+        if input.is_a?(Symbol)
+          ":#{input}"
+        else
+          "'#{input}'"
+        end
+      end
+    end
   end
 end

data/lib/jsonapi_compliable/stats/dsl.rb

@@ -0,0 +1,54 @@
+module JsonapiCompliable
+  module Stats
+    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)
+        config = { config => [] } if config.is_a?(Symbol)
+
+        @calculations = {}
+        @name = config.keys.first
+        Array(config.values.first).each { |c| send(:"#{c}!") }
+      end
+
+      def method_missing(meth, *args, &blk)
+        @calculations[meth] = blk
+      end
+
+      def calculation(name)
+        callable = @calculations[name] || @calculations[name.to_sym]
+        callable || raise(Errors::StatNotFound.new(@name, name))
+      end
+
+      def count!
+        @calculations[:count] = self.class.defaults[:count]
+      end
+
+      def sum!
+        @calculations[:sum] = self.class.defaults[:sum]
+      end
+
+      def average!
+        @calculations[:average] = self.class.defaults[:average]
+      end
+
+      def maximum!
+        @calculations[:maximum] = self.class.defaults[:maximum]
+      end
+
+      def minimum!
+        @calculations[:minimum] = self.class.defaults[:minimum]
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/stats/payload.rb

@@ -0,0 +1,34 @@
+module JsonapiCompliable
+  module Stats
+    class Payload
+      def initialize(controller, scope)
+        @dsl       = controller._jsonapi_compliable
+        @directive = controller.params[:stats]
+        @scope     = controller._jsonapi_scope || scope
+      end
+
+      def generate
+        {}.tap do |stats|
+          @directive.each_pair do |name, calculation|
+            stats[name] = {}
+
+            each_calculation(name, calculation) do |calc, function|
+              stats[name][calc] = function.call(@scope, name)
+            end
+          end
+        end
+      end
+
+      private
+
+      def each_calculation(name, calculation_string)
+        calculations = calculation_string.split(',').map(&:to_sym)
+
+        calculations.each do |calc|
+          function = @dsl.stat(name, calc)
+          yield calc, function
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/pagination.rb

@@ -0,0 +1,11 @@
+module JsonapiCompliable
+  module Util
+    class Pagination
+      def self.zero?(params)
+        params = params[:page] || params['page'] || {}
+        size   = params[:size] || params['size']
+        [0, '0'].include?(size)
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/util/scoping.rb

@@ -3,9 +3,9 @@ module JsonapiCompliable
     class Scoping
       def self.apply?(controller, object, force)
         return false if force == false
-        return true if !controller._jsonapi_scoped && object.is_a?(ActiveRecord::Relation)
+        return true if controller._jsonapi_scope.nil? && object.is_a?(ActiveRecord::Relation)
 
-        already_scoped = !!controller._jsonapi_scoped
+        already_scoped = !!controller._jsonapi_scope
         is_activerecord = object.is_a?(ActiveRecord::Base)
         is_activerecord_array = object.is_a?(Array) && object[0].is_a?(ActiveRecord::Base)
 

data/lib/jsonapi_compliable/version.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

data/lib/jsonapi_compliable.rb

@@ -13,9 +13,12 @@ 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/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/railtie' if defined?(::Rails)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_compliable
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Lee Richmond
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -228,8 +228,11 @@ files:
 - lib/jsonapi_compliable/scope/paginate.rb
 - lib/jsonapi_compliable/scope/sideload.rb
 - lib/jsonapi_compliable/scope/sort.rb
+- lib/jsonapi_compliable/stats/dsl.rb
+- lib/jsonapi_compliable/stats/payload.rb
 - lib/jsonapi_compliable/util/field_params.rb
 - lib/jsonapi_compliable/util/include_params.rb
+- lib/jsonapi_compliable/util/pagination.rb
 - lib/jsonapi_compliable/util/scoping.rb
 - lib/jsonapi_compliable/version.rb
 homepage: