auto_preload 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b400e79944285da53bdd3246948248bdef10323e536761b38794fa7c774a085
-  data.tar.gz: 222fcad81c801c6f33f1ae91e005b6402f87549b30e4f62d5e587b800e888f2d
+  metadata.gz: 83981d329237a816c396eeeb96058bf601531562846d5d365b664a25cbc683b6
+  data.tar.gz: 7090bcf8922549d45cd8410a98d09d841a17cdbd822dae21e1f69d8abd918890
 SHA512:
-  metadata.gz: 46b10d83dde0c430ff36e0a4a0ac49daab14426240c696a396e7687e762ebed642a06a7a0a97feb08707552f6723174837a99c36bcfb29b92206f262f9c45afe
-  data.tar.gz: 294bd08145cd0712de2899c2366b7e8c6783292cb837a1b397502410965cdb501e2c53198dcbd0a5814caecee87821be5d7b3cee9661193f0fc1cae3cca33e4a
+  metadata.gz: 61bb4dcb606073730f9edbf2d8888d9e28bdafaf2e22a409866a95bd771462ca83ce08a6c1828f14c65bb540d9f3e4bd3968e04bef3df40d23c49e3ab4e2b7f8
+  data.tar.gz: 4fff43c826eeb13787beb5f7b1c179c7d05045ea8090a91257c91264ff15f23144d8276137d0771a5f682952916cc8feeb2073b146b74397f1e6a267fe4d7316

data/.github/workflows/gem-push.yml

@@ -16,9 +16,9 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby 3.0
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.x
+        ruby-version: '3.0'
 
     - name: Publish to GPR
       run: |

data/.solargraph.yml

@@ -0,0 +1,25 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require:
+- activesupport
+- activerecord
+domains: []
+reporters:
+- rubocop
+- require_not_found
+- typecheck
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins: []
+max_files: 5000

data/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.1.2] - 2022-12-10
+
+### Added
+- Documentation to all methods
+- `solargraph` gem for development
+
 ## [0.1.1] - 2022-11-30
 
 ### Fixed

data/Gemfile

@@ -12,6 +12,8 @@ gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.7"
 
+gem "solargraph"
+
 gem "active_model_serializers", "~> 0.10"
 gem "simplecov"
 gem "yard"

data/lib/auto_preload/active_record.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 module AutoPreload
+  # Extensions to ActiveRecord::Base
   module ActiveRecord
     extend ActiveSupport::Concern
 
     included do
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_includes, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -13,6 +17,9 @@ module AutoPreload
           self
         end
       }
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_preload, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -21,6 +28,9 @@ module AutoPreload
           self
         end
       }
+      # @param [String, Array<String>] inclusions
+      # @param [Hash] options
+      # @return [ActiveRecord::Relation]
       scope :auto_eager_load, lambda { |inclusions, options = {}|
         if inclusions.present?
           resolved = Resolver.new(options).resolve(self, inclusions)
@@ -30,6 +40,7 @@ module AutoPreload
         end
       }
 
+      # @return [nil, Array<Symbol>]
       class_attribute :auto_preloadable
     end
   end

data/lib/auto_preload/adapters/active_record.rb

@@ -4,6 +4,8 @@ module AutoPreload
   module Adapters
     # This class takes a model and finds all the preloadable associations.
     class ActiveRecord
+      # @param [ActiveRecord::Base] model
+      # @return [Array<ActiveRecord::Reflection>] The preloadable associations.
       def resolve_preloadables(model, _options = {})
         if model.auto_preloadable
           model.auto_preloadable.map { |w| model.reflect_on_association(w) }.compact

data/lib/auto_preload/adapters/serializer.rb

@@ -24,6 +24,11 @@ module AutoPreload
         end.compact
       end
 
+      # @param model [ActiveRecord::Base]
+      # @param options [Hash]
+      # @option options [Boolean] :root
+      # @option options [ActiveModel::Serializer] :serializer
+      # @return [ActiveModel::Serializer]
       def resolve_serializer(model, options = {})
         if options[:root]
           options[:serializer] || ActiveModel::Serializer.serializer_for(model)

data/lib/auto_preload/adapters.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module AutoPreload
+  # This module contains the adapters used to parse JSON::API include strings.
   module Adapters
     extend ActiveSupport::Autoload
 

data/lib/auto_preload/config.rb

@@ -3,7 +3,7 @@
 module AutoPreload
   # This class handles the gem configurations.
   class Config
-    # @attr_writr [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] adapter The adapter to use.
+    # @return [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] The adapter to use.
     attr_writer :adapter
 
     # @return [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] The adapter to use.

data/lib/auto_preload/resolver.rb

@@ -3,8 +3,13 @@
 module AutoPreload
   # This class parses a string in the format "articles,comments" and returns an array of symbols.
   class Resolver
+    # Default max number of iterations
+    # @return [Integer]
     MAX_ITERATIONS = 100
 
+    # @param options [Hash]
+    # @option options [Integer] :max_iterations
+    # @option options [AutoPreload::Adapters::ActiveRecord, AutoPreload::Adapters::Serializer] :adapter
     def initialize(options = {})
       @iterations = 0
       @options = options
@@ -43,7 +48,7 @@ module AutoPreload
       objects.present? ? (symbols << objects) : symbols
     end
 
-    # @param list [Array<Hash>]
+    # @param objects [Array<Hash>]
     # @return [Hash]
     def merge(objects)
       objects.reduce({}) do |result, object|

data/lib/auto_preload/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module AutoPreload
-  VERSION = "0.1.1"
+  # @return [String] The version of the gem.
+  VERSION = "0.1.2"
 end

data/lib/auto_preload.rb

@@ -3,6 +3,8 @@
 require "active_support"
 require "active_record"
 
+# Provides methods to run `preload`/`includes`/`eager_load` on your model
+# from a JSON::API include string.
 module AutoPreload
   extend ActiveSupport::Autoload
 
@@ -11,13 +13,18 @@ module AutoPreload
   autoload :Resolver
   autoload :Config
 
+  # @yield [AutoPreload::Config]
+  # @return [AutoPreload::Config]
   def self.configure
     yield(config)
   end
 
+  # @return [AutoPreload::Config]
   def self.config
     @config ||= Config.new
   end
 end
 
-ActiveRecord::Base.include AutoPreload::ActiveRecord
+# rubocop:disable Lint/SendWithMixinArgument
+ActiveRecord::Base.send(:include, AutoPreload::ActiveRecord)
+# rubocop:enable Lint/SendWithMixinArgument

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: auto_preload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mònade
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -64,6 +64,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE