bulk_loader 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f333c3ac367e36f34c8612ab1d1860e827414d8bd388171bd18f05d23c61325d
-  data.tar.gz: 201294000abe22d929ac1ae77c224635d582438442affffe493bc562dd5f06c8
+  metadata.gz: 3b828de71b675977a5e13ee65e0f46a7929717d712b54f38df4fd9f31442b8a8
+  data.tar.gz: d8dd3a45609fad64fc8a6f35f557b7660ca81c1e65b3bc889bfdad6ff06eea26
 SHA512:
-  metadata.gz: afe87ce84b348f199062486aef49ee2f65601535245e4a3cf4a250ed3c6fd9e0281eb76a20e48a5f322bc9f4ab727c51842fa535bfd2ed9482dedbd173bbb1fd
-  data.tar.gz: 0a377a26091d89683874c25d779641e3e876ce72a0ebd63aca3d968af577a3c1cb58bfb6af3d0adad02faae9ed7ba37b49c852d8a5c995aefac51c36b61afb20
+  metadata.gz: ed99f135707732b203fd5ab7517a808dbe5a54f46f5ad802099c77cf29337d38406715ef70d4c591d46f1c2ce1dfe3c2fec39c6e8f9249446be867494c368de1
+  data.tar.gz: 7e58ad0d7dea88ac8592a9a4261c67edf7efd55fcf5dfe0e35c2a9b8f6fe172abe963f46e7e61b8b00af2032e328da3d9bbe3ec626927d48fd9fa5eb2c0f46ce

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.6.x', '2.5.x', '2.4.x']
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/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

@@ -11,10 +11,10 @@ AllCops:
     - 'example/**/*'
 
 Metrics/AbcSize:
-  Max: 17
+  Max: 22
 
 Metrics/MethodLength:
-  Max: 14
+  Max: 20
 
 Metrics/BlockLength:
   Exclude:

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

@@ -18,8 +18,11 @@ module BulkLoader
         name, mapping, options = *args
         options ||= {}
         does_export = options.delete(:export)
+        does_autoload = options.delete(:autoload)
+        does_autoload = true if does_autoload.nil?
 
-        @bulk_loader.define_loader(name, BulkLoader::Loader.new(mapping, options, &block))
+        loader = BulkLoader::Loader.new(mapping, options, &block)
+        @bulk_loader.define_loader(name, loader, autoload: does_autoload)
 
         return if does_export == false
 
@@ -34,7 +37,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

@@ -39,7 +39,6 @@ module BulkLoader
 
     def get_mapping(lazy_objs)
       mapping_of = {}
-      targets = lazy_objs.map(&:target)
       lazy_objs.each do |lazy_obj|
         target = lazy_obj.target
         mapped_target = @is_mapping_proc ? @mapping.call(target) : target.public_send(@mapping)

data/lib/bulk_loader/version.rb

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

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: bulk_loader
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Keiji Yoshimi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-12 00:00:00.000000000 Z
+date: 2019-09-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"