bulk_loader 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 905e932ce017b63197cd743a2c856e50def0c6d52083d5c287a6d1463124f0e3
-  data.tar.gz: a6481e11d19e6eb455d5f54c5a2f9e736561cdd9c6dbe7ff3053ac06e9e7a711
+  metadata.gz: 7f1d67abfc96cf07c2567f79aea5d9aa72a788a4eb1177cfb82f54a895645ba7
+  data.tar.gz: 7d35e81f819371a5cf2c2962f16b3b0be51c1ea6dd56bd209bcf4a548f9ea092
 SHA512:
-  metadata.gz: 8a2ef5b610d4635c521f0a04fef831e19b1b330473054cd2b99d8da340f6433bced83c2683f8b9125d5a186ce5c0a7fca31c8aa54a99501c85d1e629f42a81af
-  data.tar.gz: 49747836ca7331d9134deaad2ac9840a51c92a7ec0a5e48fc845e862a69300ce1cd1c035ec84be39258fe80d86caf448dd71019b6912b90260be788ad0bf4b2c
+  metadata.gz: 7c6c1a2de3185b089168f03046fc115f523c80b4319b83c366cd58f40bb43c6719e7471c9890618c915b2a4be5983b3397f97e148b50114d997d6bfe0069d3c1
+  data.tar.gz: 4d1f5ee95f42cfc48967261c5af00214da6716f7a5b7602481de83ff740aa86c9e443af5f0924423bb2dda77ed19fbdbe115d4f7cebee7fb87a5008e0e58cf84

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.0', '2.7', '2.6', '2.5']
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
+--warnings
 --color

data/.rubocop.yml

@@ -8,20 +8,25 @@ AllCops:
     - 'Guardfile'
     - 'bin/*'
     - 'Rakefile'
+    - 'Steepfile'
     - 'example/**/*'
+  NewCops: enable
 
 Metrics/AbcSize:
-  Max: 17
+  Max: 22
 
 Metrics/MethodLength:
-  Max: 14
+  Max: 20
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Style/Documentation:
   Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false

data/README.md

@@ -80,7 +80,7 @@ class YourModel
 end
 ```
 
-#### export: false
+#### export: false option ( default: true )
 
 :name method is just shorthand for bulk\_loader.public\_send(:name). So if you not want to create :name method, you can pass export: false to bulk\_loader definition.
 
@@ -100,6 +100,32 @@ then you can use this like followings.
   YourModel.new.bulk_loader.name
 ```
 
+#### autoload: false option ( default: true )
+
+If you set this option to false, +BulkLoader::UnloadAccessError+ occured when you does not call +YourModel.bulk\_loader.load explicitly on :name method.
+
+```ruby
+class YourModel
+  include BulkLoader::DSL
+
+  bulk_loader :name, :mapped_key, default: nil, autoload: false do |mapped_keys|
+    # something with mapped_keys
+  end
+end
+```
+
+```ruby
+  YourModel.new.name #=> raise error BulkLoader::UnloadAccessError
+```
+
+You can pass this by calling load explicitly.
+
+```ruby
+  model = YourModel.new
+  YourModel.bulk_loader.load(:name, [model])
+  model.name #=> it does not raise BulkLoader::UnloadAccessError
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
+task :default => [:spec, :rubocop]

data/bulk_loader.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.15"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.49"
+  spec.add_development_dependency "rubocop", ">= 0.74"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "guard-rubocop", "~> 1.3.0"

data/lib/bulk_loader/attribute.rb

@@ -8,7 +8,11 @@ module BulkLoader
     end
 
     def lazy(name)
-      @lazy_of[name] ||= BulkLoader::Lazy.new(@target)
+      @lazy_of[name] ||= BulkLoader::Lazy.new(@target, name: name)
+    end
+
+    def loaded?(name)
+      lazy(name).loaded?
     end
 
     def marshal_dump
@@ -35,7 +39,7 @@ module BulkLoader
       names = [name].freeze
       define_singleton_method(name) do
         attr = lazy(name)
-        class_attribute.load(names, [self]) unless attr.loaded?
+        class_attribute.load(names, [self]) if !attr.loaded? && class_attribute.autoload?(name)
         attr.get
       end
       public_send(name)

data/lib/bulk_loader/class_attribute.rb

@@ -6,12 +6,18 @@ module BulkLoader
   class ClassAttribute
     def initialize
       @loader_of = {}
+
+      @no_autoload_of = {}
     end
 
     def include?(name)
       @loader_of.include?(name)
     end
 
+    def autoload?(name)
+      !@no_autoload_of[name]
+    end
+
     def each(&block)
       @loader_of.each(&block)
     end
@@ -27,8 +33,9 @@ module BulkLoader
       end
     end
 
-    def define_loader(name, loader)
+    def define_loader(name, loader, autoload: true)
       @loader_of[name] = loader
+      @no_autoload_of[name] = true unless autoload
       define_singleton_method(name) { loader }
     end
 

data/lib/bulk_loader/dsl.rb

@@ -6,7 +6,9 @@ module BulkLoader
       # getter for +BulkLoader::ClassAttribute+
       # If you pass name, mapping, options argument, you can define loader
       # if you does not want to export name to object, pass export: false to options.
-      def bulk_loader(*args, &block)
+      # if you would like to raise error when implicitly calling loader, pass autoload: false
+      # to options.
+      def bulk_loader(*args, export: nil, autoload: true, default: nil, &block)
         @bulk_loader ||= if superclass.respond_to?(:bulk_loader)
                            superclass.bulk_loader.dup
                          else
@@ -15,13 +17,12 @@ module BulkLoader
 
         return @bulk_loader if args.empty?
 
-        name, mapping, options = *args
-        options ||= {}
-        does_export = options.delete(:export)
+        name, mapping = *args
 
-        @bulk_loader.define_loader(name, BulkLoader::Loader.new(mapping, options, &block))
+        loader = BulkLoader::Loader.new(mapping, default: default, &block)
+        @bulk_loader.define_loader(name, loader, autoload: autoload)
 
-        return if does_export == false
+        return if export == false
 
         define_method name do
           bulk_loader.public_send(name)
@@ -34,7 +35,7 @@ module BulkLoader
     end
 
     def bulk_loader
-      return @bulk_loader if @bulk_loader
+      return @bulk_loader if defined?(@bulk_loader) && @bulk_loader
 
       @bulk_loader = BulkLoader::Attribute.new(self)
     end

data/lib/bulk_loader/lazy.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
 module BulkLoader
+  class UnloadAccessError < StandardError; end
+
   # lazy class
   class Lazy
     attr_reader :target
 
-    def initialize(target)
+    def initialize(target, name: nil)
       @loaded = false
       @value = nil
+      @name = name
       @target = target
     end
 
     def get
-      raise 'data is not loaded!!' unless @loaded
+      raise UnloadAccessError, "#{@name} has not been loaded!!" unless @loaded
 
       @value
     end

data/lib/bulk_loader/loader.rb

@@ -13,7 +13,7 @@ module BulkLoader
     end
 
     def load(lazy_objs, *args)
-      lazy_obj_of = lazy_objs.each_with_object({}) { |e, h| h[e.target] = e }
+      return if lazy_objs.empty?
 
       mapping_of = get_mapping(lazy_objs)
 
@@ -21,7 +21,7 @@ module BulkLoader
 
       lazy_objs.each(&:clear)
 
-      set_result_to_lazy_objs(result_of, lazy_obj_of, mapping_of)
+      set_result_to_lazy_objs(result_of, mapping_of)
 
       fill_default_to_unloaded_obj(lazy_objs)
     end
@@ -30,32 +30,33 @@ module BulkLoader
 
     def call_block(mapping_of, *args)
       if args.size < @block.arity - 1
-        message = "block should take #{@block.arity} parameters, but given #{arity.size + 1}"
+        message = "load should take #{@block.arity} parameters, but given #{args.size + 1}"
         raise ArgumentError, message
       end
       result_of = @block.call(mapping_of.keys, *args)
-      raise 'block shuold return Hash' unless result_of.is_a?(Hash)
+
+      raise 'block should return Hash' unless result_of.is_a?(Hash)
 
       result_of
     end
 
     def get_mapping(lazy_objs)
       mapping_of = {}
-      targets = lazy_objs.map(&:target)
-      targets.each do |target|
+      lazy_objs.each do |lazy_obj|
+        target = lazy_obj.target
         mapped_target = @is_mapping_proc ? @mapping.call(target) : target.public_send(@mapping)
         mapping_of[mapped_target] = [] unless mapping_of[mapped_target]
-        mapping_of[mapped_target].push(target)
+        mapping_of[mapped_target].push(lazy_obj)
       end
       mapping_of
     end
 
-    def set_result_to_lazy_objs(result_of, lazy_obj_of, mapping_of)
+    def set_result_to_lazy_objs(result_of, mapping_of)
       result_of.each do |mapped_target, value|
         next unless mapping_of[mapped_target]
 
-        mapping_of[mapped_target].each do |target|
-          lazy_obj_of[target]&.set(value)
+        mapping_of[mapped_target].each do |lazy_obj|
+          lazy_obj.set(value)
         end
       end
     end

data/lib/bulk_loader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BulkLoader
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: bulk_loader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Keiji Yoshimi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -56,16 +56,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: utility to avoid N+1 queries