activerecord_with_progress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4d04878e26b39a84c4f04ce57f308dd381982ef
+  data.tar.gz: fc65313de25bf50dd08c23fe67c605e26b43e5c2
+SHA512:
+  metadata.gz: b01db8a88432086cd0e062fcd3907dc02a0e7f90769557bdafb65e651ff1cc14226eb92ca45667844d9e385685b306823f283f5e9ae55ebe8f81b6990bd0e2a0
+  data.tar.gz: 2118b2f0ed0dc17b43d1e8ab4357e89437041681a0ecc63437903217272c747e88aa791edaf6aeb56f6608f879fb636907c070fdd58116b335a132c8cdbd026f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord_with_progress.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mike Bourgeous
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# ActiverecordWithProgress
+
+Similar to other gems that provide progress bars for `Enumerable`, this gem
+provides a progress bar for ActiveRecord relations.  We use it for Rake tasks,
+migrations, and console commands.  Maybe it's useful to you, too.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord_with_progress', github: 'deseretbook/activerecord_with_progress'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Provides `_with_progress` wrappers (via `method_missing`) for several common
+ActiveRecord iteration methods.  They should have, but are not guaranteed to
+have, the same memory usage, computation requirements, and access patterns as
+the methods they wrap.
+
+
+```ruby
+SomeModel.all.each_with_progress do |record|
+  # Do something with the record
+end
+
+SomeModel.all.find_each_with_progress do |record|
+  # ...
+end
+
+SomeModel.all.each_with_index_and_progress do |record, index|
+  # ...
+end
+
+SomeModel.where(condition: true).each_with_index_and_progress do |record, index|
+  # ...
+end
+
+mapped = SomeModel.all.map_with_progress do |record|
+  # ...
+end
+```
+
+There's an option to catch errors and return them in a second return value:
+
+```ruby
+# Returns the #each return value, and a Hash mapping failed records to exceptions
+_, errors = SomeModel.all.each_with_progress(handle_errors: true) do |record|
+  raise 'Handled'
+end
+
+# Returns the map with nil for errors, and a Hash with exceptions.
+mapped, errors = SomeModel.where(some: 'condition').map_with_progress(handle_errors: true) do |record|
+  raise 'Nil in the map'
+end
+```
+
+The `find_in_batches` method is a little bit tricker to work with:
+
+```ruby
+# Need to override :total; I would use #find_each_with_progress instead.
+query = SomeModel.where(query: 'parameters')
+query.find_in_batches_with_progress(batch_size: 5, total: query.count / 5 + !) do |batch| puts batch.size end
+```
+
+
+You can change the progress bar format from the colorful default.  See the docs
+for [ruby-progressbar](https://rubygems.org/gems/ruby-progressbar) for format
+details.
+
+```ruby
+ActiverecordWithProgress.progress_format = 'a ruby-progressbar format string'
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deseretbook/activerecord_with_progress.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+This independent gem is not an official part of or endorsed add-on for ActiveRecord.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord_with_progress.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_with_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord_with_progress"
+  spec.version       = ActiverecordWithProgress::VERSION
+  spec.authors       = ["Deseret Book", "Mike Bourgeous"]
+  spec.email         = ["webdev@deseretbook.com", "mike@mikebourgeous.com"]
+
+  spec.summary       = %q{Adds methods to ActiveRecord::Relation for iterating with progress bars}
+  spec.homepage      = "https://github.com/deseretbook/activerecord_with_progress"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '1.9.3'
+
+  spec.add_dependency "activerecord", "~> 4.1"
+  spec.add_dependency "ruby-progressbar", "~> 1.7.5"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord_with_progress"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord_with_progress/activerecord_relation.rb

@@ -0,0 +1,68 @@
+require 'active_record'
+
+module ActiverecordWithProgress
+  module ActiverecordRelation
+    # Adds a progress bar to iterator methods if _with_progress or
+    # _and_progress is appended to the method name.  Arguments are passed
+    # through to the backing method, with options pulled from the last Hash in
+    # the argument list (if any).  If only our own options are specified, the
+    # options hash will be deleted from the argument list (so no arguments will
+    # be passed to methods that expect no arguments, like #each).
+    #
+    # Options:
+    #   :handle_errors - If true, returns two values: the original result and a
+    #                    Hash mapping records to errors.
+    #   :total - Override the total count used by the progress bar.
+    def method_missing(method, *args)
+      name = method.to_s
+      if name.end_with?('_with_progress') || name.end_with?('_and_progress')
+        name = name.sub(/_(with|and)_progress$/, '')
+        iterate_with_progress(name, *args) do |*a|
+          yield *a
+        end
+      else
+        super
+      end
+    end
+
+    private
+    # Implements progress bar iteration and error handling.  Calls the given
+    # +method+ with the given arguments, incrementing the progress bar each
+    # time the method yields.
+    def iterate_with_progress(method, *args)
+      options = args.reverse.detect{|a| a.is_a?(Hash)} || {}
+      total = options.delete(:total) || self.count
+      handle_errors = options.delete(:handle_errors)
+      args.delete(options) if options.empty?
+
+      progress = ActiverecordWithProgress.create(total: total)
+
+      if handle_errors
+        errors = {}
+
+        results = send(method, *args) do |*a|
+          progress.increment rescue nil
+
+          begin
+            yield *a
+          rescue => e
+            errors[a[0]] = e
+            nil
+          end
+        end
+
+        [ results, errors ]
+      else
+        send(method, *args) do |*a|
+          progress.increment rescue nil
+          yield *a
+        end
+      end
+
+    ensure
+      progress.finish if progress
+    end
+  end
+end
+
+ActiveRecord::Relation.include ActiverecordWithProgress::ActiverecordRelation

data/lib/activerecord_with_progress/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordWithProgress
+  VERSION = "0.1.0"
+end

data/lib/activerecord_with_progress.rb

@@ -0,0 +1,28 @@
+require "activerecord_with_progress/version"
+
+require 'ruby-progressbar'
+
+module ActiverecordWithProgress
+  # Default progress bar format (see ruby-progressbar documentation).
+  DEFAULT_FORMAT = "\e[36m%a \e[35m%e\e[0m \e[34m[\e[1m%B\e[0;34m] %c/%C %p%%\e[0m"
+  @progress_format = DEFAULT_FORMAT
+
+  class << self
+    # Set or retrieve the format string used for progress bars.
+    attr_accessor :progress_format
+
+    # Creates a progress bar with our own default options and format, unless
+    # overrided by the options hash.  Also works around Spring's removal of
+    # IO.console for Rails apps that use Spring by setting :length.
+    def create(options=nil)
+      opts = {
+        format: progress_format,
+        length: (IO.console.winsize[1] rescue nil) || ENV['columns'] || `tput cols`
+      }
+      opts.merge!(options) if options.is_a?(Hash)
+      ProgressBar.create(opts)
+    end
+  end
+end
+
+require 'activerecord_with_progress/activerecord_relation'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_with_progress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Deseret Book
+- Mike Bourgeous
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email:
+- webdev@deseretbook.com
+- mike@mikebourgeous.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord_with_progress.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord_with_progress.rb
+- lib/activerecord_with_progress/activerecord_relation.rb
+- lib/activerecord_with_progress/version.rb
+homepage: https://github.com/deseretbook/activerecord_with_progress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Adds methods to ActiveRecord::Relation for iterating with progress bars
+test_files: []