array_with_progress 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9168135d123a7340ac52333d1856408e57a3427
+  data.tar.gz: b5c16ae2b04e94a07719532365b4494d2fa18658
+SHA512:
+  metadata.gz: f94f10c7006041ad9038cf4b6e1f3f747aca73078e923da686d19b7c675df34ff284c40ba047ba6e067ac62d9216c458c45032bf1d51d90e6eaec0c573fef7a7
+  data.tar.gz: ad43981523803f91c6d5ef8c7f4117ca37c94c338e972f4111da05f3b1375ddcfc7079cad54b6e72a78c29f3552c19aa0c8b9d36ba176c476c8f927b2ab1cfdf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.4
+  - 2.2.0
+  - jruby-19mode
+script:
+  bundle exec rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tomasz Dąbrowski
+
+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,119 @@
+# ArrayWithProgress
+
+[![Build Status](https://travis-ci.org/dabroz/array_with_progress.svg?branch=master)](https://travis-ci.org/dabroz/array_with_progress)
+
+Easily visualize progress of any Ruby task. A drop in replacement for `Array.each`.
+
+Output uses different colors for successes/failured, allowing to easily check status of every task. Every line is trimmed/padded to match the terminal width. There is also a possiblity to change item name during processing. Transactions for `ActiveRecord` are also handled if required.
+
+![array_with_progress](https://cloud.githubusercontent.com/assets/179706/7215359/5cb6d116-e5d4-11e4-9a77-165e75330cfe.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'array_with_progress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install array_with_progress
+
+## Usage
+
+Basic usage is as easy as replacing all `Array.each` to `Array.each_with_progress` in your rake tasks.
+
+```ruby
+User.all.each_with_progress do |user|
+  user.backup_avatar!
+end
+```
+
+One of the main features is the ability to provide statuses for each task. To do that, just return one of the following in your block:
+
+- `:ok` (or `true`) - Success
+- `:warning` - Success, but with some warnings
+- `:error` (or `false`) - Failure
+- `:skip` - Task was skipped
+
+```ruby
+User.all.each_with_progress do |user|
+  if user.has_avatar?
+    user.backup_avatar! # returns true/false
+  else
+    :skip
+  end   
+end
+```
+
+You can provide a description for task block (useful if many different operations are to be performed on the same collection):
+
+```ruby
+User.all.each_with_progress('Backing up the avatar for') do |user|
+  user.backup_avatar!
+end
+```
+
+To change item name during processing (for example when performing migration on some data, and the correct name is discovered after some processing) use an extra block argument and one of the following:
+
+```ruby
+User.all.each_with_progress('Backing up the avatar for') do |user, operation|
+  operation.change_name(user.avatar_path) # this will completely replace username in output
+  operation.expand_name(user.avatar_path) # this will append extra data to the username
+  user.backup_avatar!
+end
+```
+
+For `ActiveRecord` objects, to enclose processing in transaction you can use additional option `transaction`. It can be one the following:
+
+- `none` - no transaction (default)
+- `collection` - wrap whole array in a single transaction
+- `member` - wrap every item in a separate transaction
+
+```ruby
+User.all.each_with_progress('Backing up the avatar for', transaction: :collection) do |user|
+  user.backup_avatar!
+end
+```
+
+More complicated example:
+
+```ruby
+User.all.each_with_progress('Reindex data for', transaction: :collection) do |user, operation|
+  if user.details_available?
+    operation.expand_name("[#{user.details_url}]")
+    begin
+      if user.reindex_details!
+        :ok
+      else
+        operation.expand_name("[#{user.details_url} - version mismatch]")
+        :warning
+      end
+    rescue UserDetailsHTTPError => e
+      operation.expand_name("[#{user.details_url} - HTTP 404 Not Found!]")
+      :error
+    end
+  else
+    :skip
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/dabroz/array_with_progress/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'Run example'
+task :example do
+  require './example/example.rb'
+end

data/array_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 'array_with_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "array_with_progress"
+  spec.version       = ArrayWithProgress::VERSION
+  spec.authors       = ["Tomasz Dąbrowski"]
+  spec.email         = ["t.dabrowski@rock-hard.eu"]
+
+  spec.summary       = 'Easily visualize progress of any Ruby task. A drop in replacement for Array.each.'
+  spec.description   = "Easily visualize progress of any Ruby task. A drop in replacement for Array.each. Output uses different colors for successes/failured, allowing to easily check status of every task. Every line is trimmed/padded to match the terminal width. There is also a possiblity to change item name during processing. Transactions for ActiveRecord are also handled if required."
+  spec.homepage      = "https://github.com/dabroz/array_with_progress"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|example)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'highline'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency 'activerecord'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "array_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/array_with_progress/array_progress_configuration.rb

@@ -0,0 +1,11 @@
+require 'highline/system_extensions'
+
+class ArrayProgressConfiguration
+  def self.terminal_width
+    HighLine::SystemExtensions.terminal_size[1]
+  end
+
+  def self.item_width
+    terminal_width - 22
+  end
+end

data/lib/array_with_progress/array_progress_item.rb

@@ -0,0 +1,115 @@
+require 'array_with_progress/array_progress_configuration'
+require 'colorize'
+
+class ArrayProgressItem
+  attr_accessor :parent
+  attr_accessor :item
+
+  attr_accessor :status, :extra_name, :progress, :name
+
+  def self.run!(parent_, item_, progress_, &block)
+    pi = ArrayProgressItem.new
+    pi.parent = parent_
+    pi.item = item_
+    pi.progress = sprintf('[%5.1f%%] ', progress_)
+    pi.run!(&block)
+  end
+
+  def change_name(new_name)
+    set_name(new_name)
+    reprint!
+  end
+
+  def expand_name(extra_name)
+    self.extra_name = extra_name
+    reprint!
+  end
+
+  def run!
+    self.status = nil
+    self.extra_name = ''
+    
+    set_name(item)
+    reprint!
+
+    self.status = process_status_code(yield(item, self))
+    reprint!
+    print "\n"
+  end
+
+  private
+
+  def process_status_code(code)
+    if code.is_a? Symbol
+      code
+    elsif code.is_a? TrueClass
+      :ok
+    elsif code.is_a? FalseClass
+      :error
+    else
+      :unknown
+    end
+  end
+
+  def description
+    parent.description
+  end
+
+  def set_name(new_name)
+    if new_name.is_a? Array
+      self.name = new_name.map(&:to_s).join('|')
+    else
+      self.name = new_name.to_s
+    end
+  end
+
+  def display_name
+    width = ArrayProgressConfiguration.item_width
+    (description + ' ' + self.name + ' ' + self.extra_name).strip[0..width-1].ljust(width, ' ')
+  end
+
+  def reprint!
+    print "\r"
+    print progress_colored
+    print name_colored
+    print result_colored
+  end
+
+  def progress_colored
+    if status == :error
+      progress.light_white.on_light_red
+    elsif status == :warning
+      progress.black.on_light_yellow
+    else
+      progress.white
+    end
+  end
+
+  def name_colored
+    if status == :error
+      display_name.light_white.on_light_red
+    elsif status == :warning
+      display_name.black.on_light_yellow
+    elsif status == :skip
+      display_name.white
+    else
+      display_name
+    end
+  end
+
+  def result_colored
+    if status == nil
+      ''
+    elsif status == :ok
+      ' [ Success ]'.green.bold
+    elsif status == :error
+      ' [ Failure ]'.light_white.on_light_red
+    elsif status == :warning
+      ' [ Warning ]'.black.on_light_yellow
+    elsif status == :skip
+      ' [ Skipped ]'.white.bold
+    else
+      ' [ Unknown ]'.bold
+    end
+  end
+end

data/lib/array_with_progress/array_progress_operation.rb

@@ -0,0 +1,37 @@
+require 'array_with_progress/array_progress_item'
+
+class ArrayProgressOperation
+  attr_accessor :items
+  attr_accessor :description
+  attr_accessor :transaction
+
+  def initialize(items_, description_, options_)
+    self.items = items_
+    self.description = description_
+    self.transaction = options_[:transaction] || :none
+  end
+
+  def run!(&block)
+    count = self.items.count.to_f
+    run_with_transaction(:collection) do
+      self.items.each_with_index do |item, index|
+        run_with_transaction(:member) do
+          progress = index.to_f / count * 100.0
+          ArrayProgressItem.run!(self, item, progress, &block)
+        end
+      end
+    end
+  end
+
+  private
+
+  def run_with_transaction(transaction_type)
+    if self.transaction == transaction_type
+      ActiveRecord::Base.transaction do
+        yield
+      end
+    else
+      yield
+    end
+  end
+end

data/lib/array_with_progress/version.rb

@@ -0,0 +1,3 @@
+module ArrayWithProgress
+  VERSION = "0.1.1"
+end

data/lib/array_with_progress.rb

@@ -0,0 +1,11 @@
+require 'array_with_progress/version'
+require 'array_with_progress/array_progress_operation'
+
+class Array
+  def each_with_progress(description = '', options = {}, &block)
+    ArrayProgressOperation.new(self, description, options).run!(&block)
+  end
+end
+
+module ArrayWithProgress
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: array_with_progress
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tomasz Dąbrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily visualize progress of any Ruby task. A drop in replacement for
+  Array.each. Output uses different colors for successes/failured, allowing to easily
+  check status of every task. Every line is trimmed/padded to match the terminal width.
+  There is also a possiblity to change item name during processing. Transactions for
+  ActiveRecord are also handled if required.
+email:
+- t.dabrowski@rock-hard.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- array_with_progress.gemspec
+- bin/console
+- bin/setup
+- lib/array_with_progress.rb
+- lib/array_with_progress/array_progress_configuration.rb
+- lib/array_with_progress/array_progress_item.rb
+- lib/array_with_progress/array_progress_operation.rb
+- lib/array_with_progress/version.rb
+homepage: https://github.com/dabroz/array_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Easily visualize progress of any Ruby task. A drop in replacement for Array.each.
+test_files: []