each_in_batches 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bbea736c5be75b95ae38baa209f8d32f4d14aae
-  data.tar.gz: 71e2730167f0fe260a5935fc434f077b0ec0b117
+  metadata.gz: 201302a3e132a0ffb2d4093dfe0a031d4b2873d4
+  data.tar.gz: 3dfacc828a9223a375f8e6e83fcdf3eecf17a7a0
 SHA512:
-  metadata.gz: a23bd4fb191735a13b12bf45a348763ddfdba88dc759826ed063ba251a95812765276a25cd0dd8ef7ce594824235320c1dd1832e85e6042d90d555964efe3f93
-  data.tar.gz: 3d7648849fc3fe2e7306430fb0ede3e6ef081b9a11b246652fbdf5463676c032460478d4ea8304b06127722c66462e6521fc4f7c84f3ccc67dac0c4d3604ec82
+  metadata.gz: 0da5e0e6b810e34122bd535fde4ddbfdbb86956591d6705f04c33de20a4c39d8bdd00027a9750c7280c04e99d44b9c6d66f650cb6e0f384a39d3493561b3fd7d
+  data.tar.gz: 359791e53ec39f1b1b50e7c8d2f580e8bfa2c031ba2da672aca90ab46953f86c811ba069161b4656da6bff027cbd6b0c0d7d07fc4f2c830ae077f28cf5da3541

data/.travis.yml

@@ -1,3 +1,13 @@
 language: ruby
+cache: bundler
+sudo: false
 rvm:
-  - 2.1.2
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: 1.9.3

data/README.md

@@ -1,5 +1,33 @@
 # EachInBatches
 
+Better than Rails Batching.  Can you batch backwards for destructive tasks?  `each_in_batches` can.
+
+| Project                 |  EachInBatches    |
+|------------------------ | ----------------- |
+| gem name                |  each_in_batches   |
+| license                 |  MIT              |
+| expert support          |  [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| download rank               |  [![Total Downloads](https://img.shields.io/gem/rt/each_in_batches.svg)](https://rubygems.org/gems/each_in_batches) |
+| version                 |  [![Gem Version](https://badge.fury.io/rb/each_in_batches.png)](http://badge.fury.io/rb/each_in_batches) |
+| dependencies            |  [![Dependency Status](https://gemnasium.com/pboling/each_in_batches.png)](https://gemnasium.com/pboling/each_in_batches) |
+| code quality            |  [![Code Climate](https://codeclimate.com/github/pboling/each_in_batches.png)](https://codeclimate.com/github/pboling/each_in_batches) |
+| inline documenation     |  [![Inline docs](http://inch-ci.org/github/pboling/each_in_batches.png)](http://inch-ci.org/github/pboling/each_in_batches) |
+| continuous integration  |  [![Build Status](https://secure.travis-ci.org/pboling/each_in_batches.png?branch=master)](https://travis-ci.org/pboling/each_in_batches) |
+| test coverage           |  [![Coverage Status](https://coveralls.io/repos/pboling/each_in_batches/badge.png)](https://coveralls.io/r/pboling/each_in_batches) |
+| homepage                |  [on Github.com][homepage] |
+| documentation           |  [on Rdoc.info][documentation] |
+| live chat               |  [![Join the chat at https://gitter.im/pboling/each_in_batches](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/each_in_batches?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on Coderbits][coderbits], [on Coderwall][coderwall] |
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[coderbits]: https://coderbits.com/pboling
+[coderwall]: http://coderwall.com/pboling
+[documentation]: http://rdoc.info/github/pboling/each_in_batches/frames
+[homepage]: https://github.com/pboling/each_in_batches
+
 (Originally BolingForBatches)
 
 ### NOTE:
@@ -21,8 +49,7 @@ batch loop.  But I didn't let that stop me!
 2. Metrics.  I measure stuff.
 3. I can batch from the top down (a.k.a backwards), making it possible to DELETE things in batches.
 		A. If you've never tried using the built-in rails batching for deleting millions of records... don't start now.  Use this gem instead.
-4. Exception Handling.  Exceptions occurring within the batching can be rescued, in a customizable fashion, which means that the process doesn't need to die on batch 309,675 of 402,540.
-5. Merged in the EachInBatches fork (from Brian Kidd):
+4. Merged in the EachInBatches fork (from Brian Kidd):
     I needed to iterate over the results and perform more actions than a single
     method would provide.  I didn't want to write a method in my app that performed
     the needed functionality as I felt the plugin should support this directly.

data/each_in_batches.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "~> 3.2"
-  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_dependency "activerecord", ">= 3.2", "< 5.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
 end

data/lib/each_in_batches.rb

@@ -135,14 +135,14 @@ module EachInBatches
       @last_batch = args.first[:last_batch] ? args.first[:last_batch].is_a?(Integer) ? args.first[:last_batch] : args.first[:last_batch].to_i : false
       @first_batch = args.first[:first_batch] ? args.first[:first_batch].is_a?(Integer) ? args.first[:first_batch] : args.first[:first_batch].to_i : 0
       @show_results = case
-        when args.first[:show_results].blank? && @verbose.blank?; false
-        when args.first[:show_results].blank? && @verbose == true; true
+        when args.first[:show_results].blank? && !verbose?; false
+        when args.first[:show_results].blank? &&  verbose?; true
         else args.first[:show_results]
       end
       @total_time = 0
       @skipped_batches = []
 
-      puts "Counting Records..." if self.verbose
+      puts "Counting Records..." if verbose?
       @total_records = @arel.count
       @num_runs = @total_records / @batch_size
       @size_of_last_run = @total_records.modulo(@batch_size)
@@ -154,13 +154,13 @@ module EachInBatches
         @extra_run = false
       end
 
-      puts "Records: #{@total_records}, Batches: #{@num_runs}" if @verbose
+      puts "Records: #{@total_records}, Batches: #{@num_runs}" if verbose?
 
       @last_batch = @num_runs - 1 unless @num_runs == 0 || @last_batch #because batch numbers start at 0 like array indexes, but only if it was not set in *args
 
       current_batch = 0
       @offset_array = Array.new
-      if @verbose
+      if verbose?
         puts "Batch Numbering Begins With 0 (ZERO) and counts up"
         puts "Batch Size (SQL Limit): #{@batch_size}" #This is the SQL Limit
         puts "First Batch # to run: #{@first_batch}" #This is the number of the first batch to run
@@ -170,18 +170,18 @@ module EachInBatches
       end
       while current_batch < @num_runs
         @offset_array << (current_batch * @batch_size)
-        print "." if @verbose
+        print "." if verbose?
         current_batch += 1
       end
-      puts " #{@num_runs} Batches Created" if @verbose
+      puts " #{@num_runs} Batches Created" if verbose?
       #in order to use batching for record deletion, the offsets need to start with largest first
       if @backwards
         @offset_array.reverse!
-        puts "Backwards Mode:" if @verbose
+        puts "Backwards Mode:" if verbose?
       else
-        puts "Normal Mode:" if @verbose
+        puts "Normal Mode:" if verbose?
       end
-      if @verbose
+      if verbose?
         puts "  First Offset: #{@offset_array.first}"
         puts "  Last Offset: #{@offset_array.last}"
         # technically the last run doesn't need a limit, and we don't technically use a limit on the last run,
@@ -204,10 +204,17 @@ module EachInBatches
       self.completion_times.empty?
     end
 
+    def verbose?
+      !!verbose
+    end
+
     def run(&block)
       return false unless block_given?
       self.start_time = Time.current
-      puts "There are no batches to run" and return false unless self.num_runs > 0
+      unless self.num_runs > 0
+        puts "There are no batches to run" if verbose?
+        return false
+      end
       self.total_time = 0
       self.completion_times = Array.new
       self.offset_array.each_with_index do |offset, current_batch|
@@ -217,13 +224,13 @@ module EachInBatches
           limite = self.batch_size
         end
         if self.first_batch > current_batch
-          print "[O] #{show_status(current_batch, limite)} skipped" if self.verbose
+          print "[O] #{show_status(current_batch, limite)} skipped" if verbose?
           self.skipped_batches << current_batch
         elsif self.last_batch && self.last_batch < current_batch
-          print "[L] #{show_status(current_batch, limite)} skipped" if self.verbose
+          print "[L] #{show_status(current_batch, limite)} skipped" if verbose?
           self.skipped_batches << current_batch
         else
-          print "[P] #{show_status(current_batch, limite)}" if self.verbose
+          print "[P] #{show_status(current_batch, limite)}" if verbose?
 
           #start the timer
           beg_time = Time.current
@@ -235,7 +242,7 @@ module EachInBatches
 
           this_time = fin_time.to_i - beg_time.to_i
           self.total_time += this_time unless extra_run && current_batch == self.num_runs
-          puts "[C] #{show_status(current_batch, limite)} in #{this_time} seconds" if self.verbose
+          puts "[C] #{show_status(current_batch, limite)} in #{this_time} seconds" if verbose?
           self.completion_times << [current_batch, {:elapsed => this_time, :begin_time => beg_time, :end_time => fin_time}]
         end
       end
@@ -244,7 +251,8 @@ module EachInBatches
       self.elapsed_time = (self.end_time.to_i - self.start_time.to_i)
       self.overhead_time = self.elapsed_time - self.total_time
       print_results if self.show_results
-      return "Process Complete"
+      puts "Process Complete" if verbose?
+      return true
     end
 
     def show_status(current_batch, limite)
@@ -261,7 +269,7 @@ module EachInBatches
         puts "Total # of #{self.arel.table} - After : #{self.arel.count}"
       end
       # With a large number of batches this is far too verbose, but don't want to introduce a more complicated verbosity setting.
-      # if verbose
+      # if verbose?
       #   puts "Completion times for each batch:"
       #   self.completion_times.each do |x|
       #     puts "Batch #{x[0]}: Time Elapsed: #{x[1][:elapsed]}s, Begin: #{x[1][:begin_time].strftime("%m.%d.%Y %I:%M:%S %p")}, End: #{x[1][:end_time].strftime("%m.%d.%Y %I:%M:%S %p")}"

data/lib/each_in_batches/version.rb

@@ -1,3 +1,3 @@
 module EachInBatches
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: each_in_batches
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Batch Processing of Records with Blocks in Rails
 test_files: []
-has_rdoc: