jsonapi_actions 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36ec7e18ffd84c14377409471e3f3dd911d956e0e1d3960dc52113cd51f20923
-  data.tar.gz: 1d9034c3807d27a04923332af04f1008bd1b9d1af7fa05ced37f5a279f7d26a5
+  metadata.gz: fe65b6ed02022e7f5962df4faca6f9326aa69e270ce3a7206d23b604141b03d8
+  data.tar.gz: f429a5e20e6caa7f485b25873d30887bde4321e12ff22483505ffce2ded6b249
 SHA512:
-  metadata.gz: 4454b8e91c724d5178e80be964bb85e4d214ee5bfcfbb92b67c6522d5f970ec034a2a238f3ab19618cd8073c7856fb9a6d60cfe150d3387e28850f29f9995628
-  data.tar.gz: 57e35c3a97f5ad2418767ad556f17e1a46d7499b9a6cc0f20a8fa52a190342547a249aad7ee17ce20e617bce7f4cf0ad642b88a7dffbfaf8367bcbad1f04874b
+  metadata.gz: 68cf00f70d0727172195ddc306e5b450e83cf003203c94cdbfa85677e4c9fde9dc3853737e17640d6b9546f47287481b240653c03c13bfb72356d5f820ab6770
+  data.tar.gz: '0992c33f6b4e04eb049ffef3139dba7b7339ace3ebff6d66a631ab408d52395ca038a4ec47c23b263bde7a83b09b78715659747d00c7edfcf90e3021ace19da6'

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-*

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-2.7.4

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0] - 2023-02-22
+### Added
+- Added `serializer_params` method to more easily allow for custom serializer params.
+
 ## [0.2.2] - 2020-05-18
 ### Fixed
 - JsonapiActions#json_response uses `defined?` to check for serializer library

data/Gemfile.lock

@@ -112,6 +112,8 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.8)
+    nokogiri (1.13.9-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.13.9-x86_64-darwin)
       racc (~> 1.4)
     racc (1.6.0)
@@ -168,6 +170,7 @@ GEM
     zeitwerk (2.6.6)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
   x86_64-darwin-20
 

data/lib/jsonapi_actions/version.rb

@@ -1,3 +1,3 @@
 module JsonapiActions
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/jsonapi_actions.rb

@@ -74,146 +74,148 @@ module JsonapiActions
 
     private
 
-    def metadata
-      {}
-    end
+      def metadata
+        {}
+      end
 
-    def parent_scope(records)
-      return records if self.class.parent_associations.blank?
+      def parent_scope(records)
+        return records if self.class.parent_associations.blank?
 
-      self.class.parent_associations.each do |parent|
-        next if params[parent[:param]].blank?
+        self.class.parent_associations.each do |parent|
+          next if params[parent[:param]].blank?
 
-        records = records.joins(parent[:association]) unless parent[:association].blank?
-        records = if parent[:table]
-                    records.where(parent[:table] => { parent[:attribute] => params[parent[:param]] })
-                  else
-                    records.where(parent[:attribute] => params[parent[:param]])
-                  end
-      end
+          records = records.joins(parent[:association]) unless parent[:association].blank?
+          records = if parent[:table]
+                      records.where(parent[:table] => { parent[:attribute] => params[parent[:param]] })
+                    else
+                      records.where(parent[:attribute] => params[parent[:param]])
+                    end
+        end
 
-      records
-    end
+        records
+      end
 
-    def filter(records)
-      records
-    end
+      def filter(records)
+        records
+      end
 
-    def sort(records)
-      return records if params[:sort].blank?
-      order = {}
+      def sort(records)
+        return records if params[:sort].blank?
+        order = {}
 
-      params[:sort].split(',').each do |sort|
-        if sort[0] == '-'
-          order[sort[1..-1]] = :desc
-        else
-          order[sort] = :asc
+        params[:sort].split(',').each do |sort|
+          if sort[0] == '-'
+            order[sort[1..-1]] = :desc
+          else
+            order[sort] = :asc
+          end
         end
+
+        return records.order(order)
       end
 
-      return records.order(order)
-    end
+      def paginate(records)
+        records.page(page[:number]).per(page[:size])
+      end
 
-    def paginate(records)
-      records.page(page[:number]).per(page[:size])
-    end
+      def page
+        @page ||= begin
+                    page = {}
+                    page[:number] = (params.dig(:page, :number) || 1).to_i
+                    page[:size] = [[(params.dig(:page, :size) || 20).to_i, 1000].min, 1].max
+                    page
+                  end
+      end
 
-    def page
-      @page ||= begin
-                  page = {}
-                  page[:number] = (params.dig(:page, :number) || 1).to_i
-                  page[:size] = [[(params.dig(:page, :size) || 20).to_i, 1000].min, 1].max
-                  page
-                end
-    end
+      def set_record
+        @record = model.find(params[:id])
+        authorize(@record)
+      end
 
-    def set_record
-      @record = model.find(params[:id])
-      authorize(@record)
-    end
+      def id_param
+        params.require(:data).permit(policy(@record).permitted_attributes)[:id]
+      end
 
-    def id_param
-      params.require(:data).permit(policy(@record).permitted_attributes)[:id]
-    end
+      def record_params
+        params.require(:data).require(:attributes).permit(policy(@record).permitted_attributes)
+      end
 
-    def record_params
-      params.require(:data).require(:attributes).permit(policy(@record).permitted_attributes)
-    end
+      def include_param
+        if %w[* **].include? params[:include]
+          inclusion_map
+        else
+          params[:include].to_s.split(',').reject(&:blank?).map(&:to_sym)
+        end
+      end
 
-    def include_param
-      if %w[* **].include? params[:include]
-        inclusion_map
-      else
-        params[:include].to_s.split(',').reject(&:blank?).map(&:to_sym)
+      def inclusion_map
+        InclusionMapper.new(serializer, include: params[:include]).map
       end
-    end
 
-    def inclusion_map
-      InclusionMapper.new(serializer, include: params[:include]).map
-    end
+      def unprocessable_entity(record)
+        Rails.logger.debug(record.errors.messages)
+        { json: record.errors.messages, status: :unprocessable_entity }
+      end
 
-    def unprocessable_entity(record)
-      Rails.logger.debug(record.errors.messages)
-      { json: record.errors.messages, status: :unprocessable_entity }
-    end
+      def pagination_meta(collection)
+        return {} if collection.nil?
 
-    def pagination_meta(collection)
-      return {} if collection.nil?
+        {
+          current_page: collection.current_page,
+          next_page: collection.next_page,
+          prev_page: collection.prev_page,
+          total_pages: collection.total_pages,
+          total_count: collection.total_count
+        }
+      end
 
-      {
-        current_page: collection.current_page,
-        next_page: collection.next_page,
-        prev_page: collection.prev_page,
-        total_pages: collection.total_pages,
-        total_count: collection.total_count
-      }
-    end
+      def model
+        self.class.model || self.class.model_name.constantize
+      end
 
-    def model
-      self.class.model || self.class.model_name.constantize
-    end
+      def json_response(data, options = {})
+        if defined?(JSONAPI::Serializer) || defined?(FastJsonapi)
+          {
+            json: serializer(data).new(data, options.deep_merge(
+              include: include_param,
+              meta: metadata,
+              params: serializer_params)
+            )
+          }
 
-    def json_response(data, options = {})
-      if defined?(JSONAPI::Serializer) || defined?(FastJsonapi)
-        {
-          json: serializer(data).new(data, options.deep_merge(
-            include: include_param,
-            meta: metadata,
-            params: {
-              current_user: try(:current_user)
-            })
-          )
-        }
+        elsif defined?(ActiveModel::Serializer)
+          { json: data }.merge(meta: metadata, include: include_param).merge(options)
 
-      elsif defined?(ActiveModel::Serializer)
-        { json: data }.merge(meta: metadata, include: include_param).merge(options)
+        else
+          { json: { data: data }.merge(options) }
+        end
+      end
 
-      else
-        { json: { data: data }.merge(options) }
+      def serializer(data = nil)
+        serializer_classes = [
+          self.class.serializer,
+          data.try(:serializer_class),
+          "#{data.class.name}Serializer".safe_constantize,
+          data.try(:first).try(:serializer_class),
+          "#{data.try(:first).class.name}Serializer".safe_constantize
+        ].compact
+
+        if serializer_classes.any?
+          serializer_classes.first
+        else
+          "#{model.name}Serializer".safe_constantize
+        end
+      rescue NoMethodError, NameError
+        raise 'Unknown serializer'
       end
-    end
 
-    def serializer(data = nil)
-      serializer_classes = [
-        self.class.serializer,
-        data.try(:serializer_class),
-        "#{data.class.name}Serializer".safe_constantize,
-        data.try(:first).try(:serializer_class),
-        "#{data.try(:first).class.name}Serializer".safe_constantize
-      ].compact
-
-      if serializer_classes.any?
-        serializer_classes.first
-      else
-        "#{model.name}Serializer".safe_constantize
+      def serializer_params
+        { current_user: try(:current_user) }
       end
-    rescue NoMethodError, NameError
-      raise 'Unknown serializer'
-    end
 
-    def eager_load(records)
-      records
-    end
+      def eager_load(records)
+        records
+      end
   end
 
   module ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_actions
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Pheasey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails JSON:API Controller Actions