page_iterator 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,76 @@
+# PageIterator
+
+The idea is splitting a large number of data in small parts (pagination concept) and iterating through them, so the execution of your script, batch file, rake task and so on, can be better managed regarding CPU and memory.
+The differential of **PageIterator** is that it keeps track of each iterated page in a log file. If the iteration was interrupted for any reason, the next execution of that iteration is going to start from the page it was previously interrupted.
+
+## Installation
+
+    gem install page_iterator
+
+### Usage
+    page_iterator = PageIterator.new(<NUMBER_OF_TOTAL_ITEMS>, <FILENAME_TO_LOG>)
+
+    page_iterator.each_remaining_page! do |page|
+        # do something here
+    end
+
+### PageIterator Resources
+* `page_iterator.each_remaining_page! { |page| }` - iterates through each page passing the current page number as parameter to the block
+* `page_iterator.next!` - increments one page and logs it to filesystem. **PageIterator** execute it after each iteration
+* `page_iterator.previous!` - decrement one page and logs it to filesystem.
+* `page_iterator.total_pages` - total number of pages
+* `page_iterator.remaining_items` - number of remaining items to be iterated through pages
+* `page_iterator.remaining_pages` - range of remaining pages to be iterated
+* `page_iterator.per_page` - number of items per page. Default: 50
+
+
+### Limitations
+There is plenty room for improvements, but so far **PageIterator** just splits the total number of items to be processed, gets page numbers and other valued numbers calculated from the initial data, but it doesn't iterate through the items themselves. It's still needed a pagination mechanism for the items.
+
+
+### Real Life Usage Example
+The example below shows **PageIterator** in action.
+Consider the following MongoMapper document.
+
+    class Person
+      include MongoMapper::Document
+      key :name, String
+      key :status, String
+      timestamps!
+    end
+
+It could be any other Mapping layer that provides pagination feature.
+
+If you want to iterate through all records from the database an amount each time, you can do the following
+
+     STDOUT.sync = true
+     STDOUT.write "Running..."
+ 
+     page_iterator = PageIterator.new(Person.count, "current_page.log")
+
+     STDOUT.write "\n - #{Person.to_s} (#{page_iterator.remaining_items}/#{page_iterator.total_items})"
+     page_iterator.each_remaining_page! do |page|
+       person_list = Person.paginate(:per_page => page_iterator.per_page , :page => page)
+       person_list.each do |person| 
+         person.status = 'active'
+         if person.save
+           STDOUT.write "."
+         else
+           STDOUT.write "F"
+           exit(1)
+         end
+       end  
+     end
+
+The script is setting the status of a Person instance to *active*. If something goes wrong, the script will print *F* in the screen and exit. So, after you fix the reason of failure (*F*) and run the script again, **PageIterator** is going to start the execution from the page where the failure happened, and not since the beginning of the collection.
+It's possible to see that it's still needed a pagination mechanism for the items themselves, as `paginate` method that MongoMapper provides.
+
+
+## Project
+* https://github.com/ericfer/page_iterator
+
+## Report bugs and suggestions
+* [Issue Tracker](https://github.com/ericfer/page_iterator/issues)
+
+## Author
+* [Eric Fer](https://github.com/ericfer)

data/lib/page_iterator.rb

@@ -1,22 +1,26 @@
 class PageIterator
-  DEFAULT_ITENS_PER_PAGE = 50
+  DEFAULT_ITEMS_PER_PAGE = 50
 
-  attr_reader :total_itens, :per_page
+  attr_reader :total_items
 
-  def initialize(total_itens, logfile, itens_per_page=DEFAULT_ITENS_PER_PAGE)
-    @total_itens = total_itens
-    @itens_per_page = itens_per_page
+  def initialize(total_items, logfile, items_per_page=DEFAULT_ITEMS_PER_PAGE)
+    @total_items = total_items
+    @items_per_page = items_per_page
     @logfile = logfile
     @current_page = current_page_from_file
   end
 
+  def per_page
+    @items_per_page
+  end
+
   def total_pages
-    pages = @total_itens / @itens_per_page
+    pages = @total_items / @items_per_page
     if pages == 0
       1
     else
-      last_page_itens = @total_itens % @itens_per_page
-      last_page_itens > 0 ? pages + 1 : pages
+      last_page_items = @total_items % @items_per_page
+      last_page_items > 0 ? pages + 1 : pages
     end
   end
 
@@ -30,11 +34,11 @@ class PageIterator
     log @current_page
   end
 
-  def remaining_itens
+  def remaining_items
     if @current_page > total_pages
       0
     else
-      @total_itens - (@current_page - 1) * @itens_per_page
+      @total_items - (@current_page - 1) * @items_per_page
     end
   end
 

data/page_iterator.gemspec

@@ -1,14 +1,14 @@
-gem_name = Dir["*.gemspec"].first.match(/\A(\w*).gemspec\z/).captures.first
+gem_name = File.basename(__FILE__, ".gemspec")
 
 Gem::Specification.new do |s|
   s.name        =  gem_name
-  s.version     = "0.1.0"
-  s.summary     = "A library to split a number of data in pages and iterate through them, keeping track in log"
+  s.version     = "0.1.1"
+  s.summary     = "Split a number of data in pages and iterate through them, keeping track in a log file"
   s.author      = "Eric Fer"
   s.email       = "eric.fer@gmail.com"
   s.homepage    = "https://github.com/ericfer/#{gem_name}"
+  s.files       = Dir["**/*.{md,rb,gemspec}"] - Dir["spec/**/*.rb"]
+  s.rubyforge_project = gem_name
   s.add_development_dependency "rspec"
   s.add_development_dependency "mocha"  
-  s.rubyforge_project         = gem_name
-  s.files       = Dir["{lib/**/*.rb,README.rdoc,Rakefile,*.gemspec}"]
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: page_iterator
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Eric Fer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 -03:00
+date: 2011-04-01 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,8 +55,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
 - lib/page_iterator.rb
-- Rakefile
 - page_iterator.gemspec
 has_rdoc: true
 homepage: https://github.com/ericfer/page_iterator
@@ -91,6 +91,6 @@ rubyforge_project: page_iterator
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A library to split a number of data in pages and iterate through them, keeping track in log
+summary: Split a number of data in pages and iterate through them, keeping track in a log file
 test_files: []
 

data/Rakefile

@@ -1,44 +0,0 @@
-begin
-  require 'rspec/core/rake_task'
-
-  desc "Run specs"
-  RSpec::Core::RakeTask.new do |t|
-    t.rspec_opts = %w(-fs --color)
-  end
-rescue LoadError
-  task :spec do
-    abort "Run `rake spec:deps` to be able to run the specs"
-  end
-
-  namespace :spec do
-    desc "Ensure spec dependencies are installed"
-    task :deps do
-      sh "gem list rspec | (grep 'rspec (2.0' 1> /dev/null) || gem install rspec --no-ri --no-rdoc"
-    end
-  end
-end
-
-gem_name = Dir["*.gemspec"].first.match(/\A(\w*).gemspec\z/).captures.first
-
-desc "Build the gem, removing old ones"
-task :build do
-  # gem_name = 'rakesupport'
-  gem_files = Dir['*.gem']
-  commands = []
-  commands << ["rm #{ gem_files.join(' ') }"] unless gem_files.empty?
-  commands << ["gem build #{gem_name}.gemspec"]
-  sh commands.join(" && ")
-end
-
-desc "Build and install the gem"
-task :install => :build do
-  # gem_name = 'rakesupport'
-  gem_file = Dir['*.gem'].first
-  if gem_file.nil?
-    puts "There is no gem file to install"
-  else
-    sh "gem uninstall --ignore-dependencies #{gem_name}; gem install #{gem_file}"
-  end
-end
-
-task :default => :spec