scripterator 0.1.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGUxZGVhNWNmNjNkMDM2YzY0MWQ5MzkzY2Y2Y2ExYWQ2ZTM1YzVkNA==
+    Zjc3Yjk1YzdjZTZkODIxYmExYmJmMWFjNDNhYTQ0MzE0ZDBjMTY3Zg==
   data.tar.gz: !binary |-
-    Y2FmYzZhNmZmYjY0MWYxZThkYThmZjE0ZThiYTkwOWFkMzM4Yzk1Ng==
+    MTBiYjQ5NWE3OWQ5ZGY5Yzg1YTNmNDJjM2EyMzE0ZDVhZGU3YWZhOQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTFiYzA3ZGVkNjdkOTc5NmIwN2NmNGQ1ZTAyNDM4YTA0MzgwNDEyMDA4NzYz
-    YTcxYTFiNTc2MDA3MGQwZWU3MWY4OWY0NWQzNjM3NWRhMTViZDIxYTFmOTU3
-    M2IyMmZlMGQ1NThmNWFjYTQwNWYwY2Y3MDIyOTkzYzExN2ZiZjk=
+    MDkzN2ExOTU4MzRhMDJmNjQxMTYyMWVkY2ZiZjkwMTg3OTBlNWFmYTI2YzJl
+    ZTRjNjA3N2ZmM2MzZDNhMDc4MzQxZDkxYzA5MDA3NDU2OGJjZDU4MTQ3OWM4
+    MDA2MTk5YTU4YjE1NWJlZDUzNTI0YmZjYzE1M2QxOGQxNmU5MDg=
   data.tar.gz: !binary |-
-    Njc0ZmYyMjIwNGU5NTRjYzg3MTg2YTdmMGRmNjE2OGQyNmRhZGUxOTE3NDE2
-    NzVmNDVhYjhiNzZmOTFjMzFiMGUxOGZhOWUxYjdiNzg5MjEyYzgyYTMyZmFi
-    YmI0MjY1NDE4NGQ3YmExNmNlNTg3YTAwYjQxMzY3NTg1N2E4ODY=
+    YjMzZDI0YjI3ZTVhZmRlY2QzYzUyYjRjOWJhYTUyOTY4YTJhZGU0MzIyODk2
+    Yjc0MDU0NTI2ZjNjZjZlNjVkMjAzZDhiNmYxYjNjZWYzYmIzZGMxMTQ1Mzk0
+    ZGNlZTlkOTI4NWY2MTNkZjkzNzU0NDA2N2NlZjUyMzcwYTU5MDE=

data/README.md

@@ -24,6 +24,7 @@ Works with ActiveRecord 3.* (Rails 4 support coming).
 ## Usage
 
 Create a .rb file with your script code:
+
 ```ruby
 Scripterator.run "Convert users from legacy auth data" do
 
@@ -62,6 +63,10 @@ Total rows migrated: 34903 / 34903
 0 errors
 ```
 
+Or, instead of a range, pass in the specific IDs you want to run against:
+
+    $ ID_LIST=1,2,100,999 bundle exec rails runner my_script.rb >out.txt
+
 Retrieve set information about checked and failed records:
 
 ```
@@ -88,6 +93,7 @@ Environment variable options:
 
 - `START`: first model ID to scripterate
 - `END`: last model ID to scripterate
+- `ID_LIST`: comma-delimited list of IDs to scripterate (e.g. "ID_LIST=1,99,440,23")
 - `REDIS_EXPIRATION`: amount of time (in seconds) before Redis result sets (checked IDs and failed IDs) are expired
 
 Either a starting or an ending ID must be provided.

data/lib/scripterator/runner.rb

@@ -17,9 +17,10 @@ module Scripterator
     end
 
     def run(options = {})
-      unless options[:start_id] || options[:end_id]
-        raise 'You must provide either a start ID or end ID'
+      unless (options[:start_id] || options[:end_id]) || options[:id_list]
+        raise 'You must provide either a start ID or end ID, or a comma-delimited id list'
       end
+      @id_list          = options[:id_list] || []
       @start_id         = options[:start_id] || 1
       @end_id           = options[:end_id]
       @redis_expiration = options[:redis_expiration]
@@ -27,6 +28,7 @@ module Scripterator
 
       raise 'No per_record code defined' unless @per_record
 
+      output_init_details
       init_vars
       run_blocks
       output_stats
@@ -79,6 +81,11 @@ module Scripterator
       end
     end
 
+    def output_init_details
+      output "Checked IDs being stored in redis list: #{script_key(:checked)}"
+      output "Failed IDs being stored in redis list: #{script_key(:failed)}"
+    end
+
     def output(*args)
       @output_stream.puts(*args)
     end
@@ -95,8 +102,11 @@ module Scripterator
     end
 
     def run_loop
-      if @end_id
-        (@start_id..@end_id).each { |id| transform_one_record(fetch_record(id)) }
+      if @id_list.count > 0
+        run_for_id_list
+      elsif @end_id
+        @id_list = (@start_id..@end_id)
+        run_for_id_list
       else
         model_finder.find_each(start: @start_id) { |record| transform_one_record(record) }
       end
@@ -104,6 +114,10 @@ module Scripterator
       expire_redis_sets
     end
 
+    def run_for_id_list
+      @id_list.each { |id| transform_one_record(fetch_record(id)) }
+    end
+
     def transform_one_record(record)
       return if record.nil?
 

data/lib/scripterator/version.rb

@@ -1,3 +1,3 @@
 module Scripterator
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/scripterator.rb

@@ -18,6 +18,7 @@ module Scripterator
       options = {}.tap do |o|
         o[:start_id]         = ENV['START'].try(:to_i)
         o[:end_id]           = ENV['END'].try(:to_i)
+        o[:id_list]          = ENV['ID_LIST'].try(:split, ',')
         o[:redis_expiration] = ENV['REDIS_EXPIRATION'].try(:to_i) || config.redis_expiration
       end
 

data/scripterator.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/scripterator/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Ted Dumitrescu"]
-  gem.email         = ["ted@lumoslabs.com"]
+  gem.authors       = ["Ted Dumitrescu", "Carl Furrow"]
+  gem.email         = ["ted@lumoslabs.com", "carl@lumoslabs.com"]
   gem.description   = %q{Script iterator for ActiveRecord models}
   gem.summary       = %q{DSL for running operations on each of a set of models}
   gem.homepage      = "http://lumosity.com"

data/spec/runner_spec.rb

@@ -49,6 +49,20 @@ describe Scripterator::Runner do
     it_behaves_like 'raises an error'
   end
 
+  context 'when an id list is passed' do
+    before { num_widgets.times { Widget.create! } }
+
+    let(:num_widgets) { 3 }
+    let(:options) { { id_list: Widget.all.map(&:id) } }
+
+    it 'transforms each widget in the list' do
+      options[:id_list].each do |id|
+        runner.should_receive(:fetch_record).once.with(id)
+      end
+      subject
+    end
+  end
+
   context 'when no per-record block is defined' do
     let(:awesome_script) do
       Proc.new do

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scripterator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ted Dumitrescu
+- Carl Furrow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,6 +84,7 @@ dependencies:
 description: Script iterator for ActiveRecord models
 email:
 - ted@lumoslabs.com
+- carl@lumoslabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: DSL for running operations on each of a set of models