ruby_peter_v 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e366938bf072caf8371100290278e5a06f99afa4
+  data.tar.gz: 4b910a5a1190a1e7cd747036586a38d566c8952c
+SHA512:
+  metadata.gz: 8f6ed3f6f642e20dbc4c1eb37f111c0773325151fcd5aa94c66166678c0d3a599a59a013e9fa07092d7e90a912c1a8ce8ed8bacf28f573fbc1ca259da0ac70aa
+  data.tar.gz: 71317efb8a6f7ac53145e75da57dc4a42bcb277b8efc32ae78e03ab7c4c0f9f7f416d4fdc64b93ee2da0b15e597d9e73b00ce3d3f0c0dd680758872880f7b108

data/HISTORY.txt

@@ -23,10 +23,17 @@
 * module DefineEquality
 * Module#DefineEquality
 
-0.0.7 (2013-06-03)
+0.0.7 (2013-06-02)
 
 * remove Object#max_with_nil(a,b)
   (use [a,b,c].compact.max)
 
+0.0.8 (2013-06-02)
+
+* fix some TODO's
+* Enumerable#single takes a block
+* Enumerable#single works properly on lazy Enumerables
+* Object#each_recursively
+
 TODO
 * Object#assert_keys_in

data/README.md

@@ -17,13 +17,15 @@ Add this line to your application's Gemfile:
 
   The background of this is that in many cases,
   the developer knows there _should_ only be 1
-  element in the set. Using first is fine, but if
+  element in a collection. Using first is fine, but if
   inadvertently more elements are present, `.first`
   will happily choose a random entry (certainly with
   ActiveRecord first) which is a silent bug.
 
-  TODO: refactor : use a dedicated exception UniquenessError  
-  TODO: refactor : take a block (a "detect" with uniqueness check)
+  single also works smartly on an Enumerable that
+  does not have a `single` method (a lazy collection).
+  It will only evaluate the first(2) elements of
+  the collection to determine that it is oversized.
 
 ```
 $ irb
@@ -34,7 +36,7 @@ $ irb
 2.0.0-p195 :003 > [1].single
  => 1
 2.0.0-p195 :004 > [1,2].single
-RuntimeError: INTERNAL ERROR: size of set was 2
+RubyPeterV::UniquenessError: size of collection was 2.
 ...
 ```
 
@@ -46,9 +48,6 @@ RuntimeError: INTERNAL ERROR: size of set was 2
   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 throw an exception.
-
-  TODO: refactor to a Module method that also defines the attr_accessor
-
 ```
 2.0.0-p195 :009 > class A
 2.0.0-p195 :010?>   attr_reader :foo
@@ -71,20 +70,18 @@ RuntimeError: INTERNAL ERROR: size of set was 2
 SetOnceError: Value of foo was 1, trying to set it to 2
 ```
 
-### do_recursively(entry_or_collection, &block) on Object
+### entry_or_collection.each_recursively on Object
 
   Call the block on each entry that is given as entry, in a
-  collection, or in a collection 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).
-
-  TODO: refactor to "entry_or_collection.each_recursively"
+  collection, or in a collection in a collection, etc. to
+  unrestricted depth. This implementation only uses each and it
+  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).
 
 ```
-2.0.0-p195 :021 > do_recursively([:a, [:b, [:c]]]) { |e| puts e.succ }
+2.0.0-p195 :021 > [:a, [:b, [:c]]].each_recursively{ |e| puts e.succ }
 b
 c
 d

data/lib/ruby_peter_v/each_recursively.rb

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

data/lib/ruby_peter_v/set_once.rb

@@ -1,4 +1,4 @@
-class SetOnceError < StandardError ; end
+class RubyPeterV::SetOnceError < StandardError ; end
 
 class Object
 
@@ -7,7 +7,7 @@ class Object
     instance_value = instance_variable_get(ivar_symbol)
     if (instance_value && instance_value != value)
       raise(
-        SetOnceError,
+        RubyPeterV::SetOnceError,
         "Value of #{attribute} was #{instance_value}, trying to set it to #{value}")
     end
     instance_variable_set(:"@#{attribute}", value)

data/lib/ruby_peter_v/single.rb

@@ -1,8 +1,18 @@
+class RubyPeterV::UniquenessError < StandardError ; end
+
 module Enumerable
 
-  def single
-    raise "INTERNAL ERROR: size of set was #{size}" if size > 1
-    first
+  def single(&block)
+    filtered = block_given? ? self.select(&block) : self
+    if filtered.respond_to?(:size)
+      _size = filtered.size
+      message = size
+    else
+      _size = filtered.first(2).size
+      message = "greater than 1 (on Enumerable, the size cannot be calculated)"
+    end
+    raise RubyPeterV::UniquenessError, "size of collection was #{message}." if _size > 1
+    filtered.first
   end
 
 end

data/lib/ruby_peter_v/version.rb

@@ -1,3 +1,3 @@
 module RubyPeterV
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/ruby_peter_v.rb

@@ -1,5 +1,5 @@
 require 'ruby_peter_v/version'
 require 'ruby_peter_v/single'
 require 'ruby_peter_v/set_once'
-require 'ruby_peter_v/do_recursively'
 require 'ruby_peter_v/define_equality'
+require 'ruby_peter_v/each_recursively'

data/spec/lib/ruby_peter_v/{do_recursively_spec.rb → each_recursively_spec.rb}

@@ -1,26 +1,26 @@
 require 'spec_helper'
 
-describe "do_recursively" do
+describe "each_recursively" do
 
-  let(:a) {Object.new}
+  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|
+    a.each_recursively 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|
+    [a,a].each_recursively 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|
+    [a,[a,a],[[[a],a],a]].each_recursively do |_e|
       _e.test_it
     end
   end
@@ -41,7 +41,7 @@ describe "do_recursively" do
 
     it "call the each block 2 times" do
       a.should_receive(:test_it).with("test").exactly(2).times
-      do_recursively(b) do |_e|
+      b.each_recursively do |_e|
         a.test_it(_e)
       end
     end
@@ -49,7 +49,7 @@ describe "do_recursively" do
     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|
+      b.lazy.each_recursively do |_e|
         a.test_it(_e)
       end
     end
@@ -61,10 +61,9 @@ describe "do_recursively" do
         end
       end
 
-      do_recursively(b) do |_e|
+      b.each_recursively do |_e|
         _e
       end
     end
   end
-
 end

data/spec/lib/ruby_peter_v/set_once_spec.rb

@@ -23,7 +23,7 @@ describe "set_once" do
       value = 10
       subject.set_once(:attr, value)
       lambda { subject.set_once(:attr, value+1) } . should raise_error(
-        SetOnceError,
+        RubyPeterV::SetOnceError,
         "Value of attr was 10, trying to set it to 11")
     end
   end

data/spec/lib/ruby_peter_v/single_spec.rb

@@ -1,23 +1,109 @@
 require 'spec_helper'
 
 describe "single" do
-  it "raises error on nil value (nil.first also raises error)" do
-    a = nil
-    lambda { a.single } . should raise_error NoMethodError
-  end
+  describe "without a block" do
+    it "raises error on nil value (nil.first also raises error)" do
+      a = nil
+      lambda{ a.single }.should raise_error NoMethodError
+    end
+
+    it "nil for empty set" do
+      a = []
+      a.single.should == nil
+    end
 
-  it "nil for empty set" do
-    a = []
-    a.single.should == nil
+    it "OK for 1 element in set" do
+      a = [:a]
+      a.single.should == :a
+    end
+
+    it "exception for > 1 element in set" do
+      a = [:a, :b]
+      lambda{ a.single }.should raise_error(
+        RubyPeterV::UniquenessError,
+        "size of collection was 2.")
+    end
   end
 
-  it "OK for 1 element in set" do
-    a = [:a]
-    a.single.should == :a
+  describe "accepts a block and uses it for a select" do
+    it "block all true" do
+      a = [:a, :b]
+      lambda{ a.single{ true } }.should raise_error(RubyPeterV::UniquenessError)
+    end
+
+    it "block filters on :a" do
+      a = [:a, :b]
+      a.single{|e| e == :a}.should == :a
+    end
+
+    it "nil block" do
+      a = [:a, :b]
+      a.single{  }.should == nil
+    end
   end
 
-  it "exception for > 1 element in set" do
-    a = [:a, :b]
-    lambda { a.single } . should raise_exception RuntimeError
+  describe "works with a lazy Enumerator" do
+    let(:large_collection) do
+      Object.new.tap do |_a|
+        _a.extend Enumerable
+        _a.instance_eval do
+          def each
+            (1..3).each do |i|
+              test i
+              yield i
+            end
+          end
+
+          def test(i)
+          end
+        end
+      end
+    end
+
+    it "does not have a size method" do
+      lambda{ large_collection.size }.should raise_error(NoMethodError)
+    end
+
+    it "count reports 3" do
+      large_collection.count.should == 3
+    end
+
+    describe "single" do
+      it "reports the UniquenessError" do
+        lambda{ large_collection.single }.should raise_error(
+          RubyPeterV::UniquenessError,
+          "size of collection was greater than 1 (on Enumerable, the size cannot be calculated).")
+      end
+
+      it "does not loop over _all_ elements!" do
+        # only needs first and second element to know it is over size
+        large_collection.should_receive(:test).with(1)
+        large_collection.should_receive(:test).with(2)
+        large_collection.should_receive(:test).with(3).exactly(0).times
+        begin
+          large_collection.single
+        rescue RubyPeterV::UniquenessError
+        end
+      end
+    end
+
+    let(:single_collection) do
+      Object.new.tap do |_a|
+        _a.extend Enumerable
+        _a.instance_eval do
+          def each
+            yield :a
+          end
+        end
+      end
+    end
+
+    it "count reports 1" do
+      single_collection.count.should == 1
+    end
+
+    it "single returns the single value" do
+      single_collection.single.should == :a
+    end
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_peter_v
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - Peter Vandenabeele
@@ -14,39 +13,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   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
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,17 +55,15 @@ dependencies:
 - !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
@@ -93,43 +84,42 @@ files:
 - Rakefile
 - lib/ruby_peter_v.rb
 - lib/ruby_peter_v/define_equality.rb
-- lib/ruby_peter_v/do_recursively.rb
+- lib/ruby_peter_v/each_recursively.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/lib/ruby_peter_v/define_equality_spec.rb
-- spec/lib/ruby_peter_v/do_recursively_spec.rb
+- spec/lib/ruby_peter_v/each_recursively_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: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby helpers for @peter_v
 test_files:
 - spec/lib/ruby_peter_v/define_equality_spec.rb
-- spec/lib/ruby_peter_v/do_recursively_spec.rb
+- spec/lib/ruby_peter_v/each_recursively_spec.rb
 - spec/lib/ruby_peter_v/set_once_spec.rb
 - spec/lib/ruby_peter_v/single_spec.rb
 - spec/spec_helper.rb

data/lib/ruby_peter_v/do_recursively.rb

@@ -1,17 +0,0 @@
-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