ruby_peter_v 0.0.4 → 0.0.5

data/.rvmrc

@@ -1 +1 @@
-rvm use --create 1.9.3@ruby_peter_v
+rvm use --create 2.0.0@ruby_peter_v

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: --without debug
+script: "bundle exec rspec spec"
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('lib/ruby_peter_v.rb')  { "spec" }
+end
+

data/HISTORY.txt

@@ -10,6 +10,15 @@
 
 * Object#max_with_nil(a, b) added
 
-0.0.4 (20123-05-22)
+0.0.4 (2013-05-22)
 
 * Object#set_once(attribute, value) added
+
+0.0.5 (2013-05-31)
+
+* Object#do_recursively
+
+TODO:
+
+* Object#define_eql
+* Object#assert_keys_in

data/README.md

@@ -2,23 +2,18 @@
 
 Ruby helpers for Peter Vandenabeele
 
+[![Gem Version](https://badge.fury.io/rb/ruby_peter_v.png)](http://badge.fury.io/rb/ruby_peter_v)
+[![Build Status](https://travis-ci.org/petervandenabeele/ruby_peter_v.png?branch=master)](http://travis-ci.org/petervandenabeele/ruby_peter_v)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
     gem 'ruby_peter_v'
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ruby_peter_v
-
 ## Usage
 
-* #single on enumerable (instead of unstable .first)
+### single on enumerable (instead of unstable .first)
 
   The background of this is that in many cases,
   the developer knows there _should_ only be 1
@@ -27,21 +22,31 @@ Or install it yourself as:
   will happily choose a random entry (certainly with
   ActiveRecord first) which is a silent bug.
 
-* #max_with_nil on Object
+### max_with_nil on Object
 
   Finding the max of two arguments, but if one of them
   is nil, take the other one, and both nil, return nil.
   This is similar to the behavior ios nil would be considered
   smaller than all other objects.
 
-* #set_once(attribute, value) on Object
+### set_once(attribute, value) on Object
 
   Setting the instance variable with name attribute (a symbol),
   once to a value value. This acts as a simple form of an
   immutable attribute. After initialization of the object, it
   can still be set once from nil to a specific value, but after
   that, it can never be changed to a different value. Writing
-  it twice with the same value does not trow an exception. 
+  it twice with the same value does not trow an exception.
+
+### do_recursively(entry_or_collection, &block) on Object
+
+  Call the block on each entry that is given as entry, in a
+  collection, or in a colletion in a collection to unrestricted
+  depth. This implementation only uses each and loops recursively,
+  so it never instantiates an array or actual collection of all
+  objects (this allows streaming, lazy evaluation, e.g. for looping
+  over objects that are read from a file that is much larger than
+  the memory size, needed for Big Data processing).
 
 ## Contributing
 

data/lib/ruby_peter_v.rb

@@ -2,3 +2,4 @@ require 'ruby_peter_v/version'
 require 'ruby_peter_v/single'
 require 'ruby_peter_v/max_with_nil'
 require 'ruby_peter_v/set_once'
+require 'ruby_peter_v/do_recursively'

data/lib/ruby_peter_v/do_recursively.rb

@@ -0,0 +1,17 @@
+class Object
+
+  def do_recursively(entry_or_collection, &block)
+    if entry_or_collection.respond_to?(:each)
+      loop_over_collection(entry_or_collection, &block)
+    else
+      yield(entry_or_collection)
+    end
+  end
+
+  def loop_over_collection(entry_or_collection, &block)
+    entry_or_collection.each do |inner_entry_or_collection|
+      do_recursively(inner_entry_or_collection, &block)
+    end
+  end
+
+end

data/lib/ruby_peter_v/version.rb

@@ -1,3 +1,3 @@
 module RubyPeterV
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/ruby_peter_v.gemspec

@@ -14,8 +14,11 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rspec', '> 2'
+  gem.add_development_dependency 'rspec', '>= 2'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9'
+  gem.add_development_dependency 'terminal-notifier-guard'
 end

data/spec/lib/ruby_peter_v/do_recursively_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe "do_recursively" do
+
+  let(:a) {Object.new}
+
+  it "does it once for a non collection object" do
+    a.should_receive(:test_it).exactly(1).times
+    do_recursively(a) do |_e|
+      _e.test_it
+    end
+  end
+
+  it "does it for each entry in a simple array" do
+    a.should_receive(:test_it).exactly(2).times
+    do_recursively([a,a]) do |_e|
+      _e.test_it
+    end
+  end
+
+  it "does it for each entry in a complex combination" do
+    a.should_receive(:test_it).exactly(6).times
+    do_recursively([a,[a,a],[[[a],a],a]]) do |_e|
+      _e.test_it
+    end
+  end
+
+  # This feature allows streaming
+  describe "works on an enumerable that is NOT an array" do
+    let(:b) do
+      _b = Object.new
+      _b.extend Enumerable
+      _b.instance_eval do
+        def each
+          yield "test"
+          yield "test"
+        end
+      end
+      _b
+    end
+
+    it "call the each block 2 times" do
+      a.should_receive(:test_it).with("test").exactly(2).times
+      do_recursively(b) do |_e|
+        a.test_it(_e)
+      end
+    end
+
+    it "works with lazy in Ruby 2.0" do
+      pending("only Ruby >= 2.0") unless RUBY_VERSION.split('.').first.to_i >= 2
+      a.should_receive(:test_it).with("test").exactly(2).times
+      do_recursively(b.lazy) do |_e|
+        a.test_it(_e)
+      end
+    end
+
+    it "does not call to_a on the collection" do
+      b.instance_eval do
+        def to_a
+          raise "Should not call to_a (no instantiation of the stream)"
+        end
+      end
+
+      do_recursively(b) do |_e|
+        _e
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_peter_v
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
@@ -24,9 +24,57 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby helpers for @peter_v
 email:
 - peter@vandenabeele.com
@@ -36,20 +84,24 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
+- Guardfile
 - HISTORY.txt
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/ruby_peter_v.rb
+- lib/ruby_peter_v/do_recursively.rb
 - lib/ruby_peter_v/max_with_nil.rb
 - lib/ruby_peter_v/set_once.rb
 - lib/ruby_peter_v/single.rb
 - lib/ruby_peter_v/version.rb
 - ruby_peter_v.gemspec
-- spec/max_with_nil_spec.rb
-- spec/set_once_spec.rb
-- spec/single_spec.rb
+- spec/lib/ruby_peter_v/do_recursively_spec.rb
+- spec/lib/ruby_peter_v/max_with_nil_spec.rb
+- spec/lib/ruby_peter_v/set_once_spec.rb
+- spec/lib/ruby_peter_v/single_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/petervandenabeele/ruby_peter_v
 licenses: []
@@ -76,7 +128,8 @@ signing_key:
 specification_version: 3
 summary: Ruby helpers for @peter_v
 test_files:
-- spec/max_with_nil_spec.rb
-- spec/set_once_spec.rb
-- spec/single_spec.rb
+- spec/lib/ruby_peter_v/do_recursively_spec.rb
+- spec/lib/ruby_peter_v/max_with_nil_spec.rb
+- spec/lib/ruby_peter_v/set_once_spec.rb
+- spec/lib/ruby_peter_v/single_spec.rb
 - spec/spec_helper.rb