ruby_peter_v 0.0.6 → 0.0.7

data/HISTORY.txt

@@ -23,5 +23,10 @@
 * module DefineEquality
 * Module#DefineEquality
 
+0.0.7 (2013-06-03)
+
+* remove Object#max_with_nil(a,b)
+  (use [a,b,c].compact.max)
+
 TODO
 * Object#assert_keys_in

data/README.md

@@ -18,16 +18,25 @@ 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
-  inadvertently more elements are present, the first
+  inadvertently more elements are present, `.first`
   will happily choose a random entry (certainly with
   ActiveRecord first) which is a silent bug.
 
-### 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.
+  TODO: refactor : use a dedicated exception UniquenessError  
+  TODO: refactor : take a block (a "detect" with uniqueness check)
+
+```
+$ irb
+2.0.0-p195 :001 > require 'ruby_peter_v'
+ => true
+2.0.0-p195 :002 > [].single
+ => nil
+2.0.0-p195 :003 > [1].single
+ => 1
+2.0.0-p195 :004 > [1,2].single
+RuntimeError: INTERNAL ERROR: size of set was 2
+...
+```
 
 ### set_once(attribute, value) on Object
 
@@ -36,24 +45,79 @@ Add this line to your application's Gemfile:
   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 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
+2.0.0-p195 :011?>   def foo=(_foo)
+2.0.0-p195 :012?>     set_once(:foo, _foo)
+2.0.0-p195 :013?>   end
+2.0.0-p195 :014?> end
+ => nil
+2.0.0-p195 :015 > a = A.new
+ => #<A:0x007fa82905f720>
+2.0.0-p195 :016 > a.foo
+ => nil
+2.0.0-p195 :017 > a.foo = 1
+ => 1
+2.0.0-p195 :018 > a.foo
+ => 1
+2.0.0-p195 :019 > a.foo = 1
+ => 1
+2.0.0-p195 :020 > a.foo = 2
+SetOnceError: Value of foo was 1, trying to set it to 2
+```
 
 ### 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
+  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"
+
+```
+2.0.0-p195 :021 > do_recursively([:a, [:b, [:c]]]) { |e| puts e.succ }
+b
+c
+d
+```
+
 ### DefineEquality(*accessors) on Module
 
-  Defining the equality (.eql?, ==, hash) between instances.
+  Defining the equality (eql?, ==, hash) between instances.
   The class is included by default in the accessor list in
   the usage `include DefineEquality(:foo, :bar)`.
 
   Defining equality for instances of different classes is
   possible by manually defining the `equality_accessors`
   function (see the spec with the b5 instance).
+
+```
+2.0.0-p195 :022 > class B
+2.0.0-p195 :023?>   include DefineEquality(:foo)
+2.0.0-p195 :024?>   attr_accessor :foo
+2.0.0-p195 :025?> end
+ => nil
+2.0.0-p195 :026 > b1 = B.new
+ => #<B:0x007fc1488f4ce0>
+2.0.0-p195 :027 > b1.foo = '1'
+ => "1"
+2.0.0-p195 :028 > b2 = B.new
+ => #<B:0x007fc1488a0028>
+2.0.0-p195 :029 > b2.foo = '1'
+ => "1"
+2.0.0-p195 :030 > b1 == b2
+ => true
+2.0.0-p195 :031 > b2.foo = '2'
+ => "2"
+2.0.0-p195 :032 > b1 == b2
+ => false
+```

data/lib/ruby_peter_v/version.rb

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

data/lib/ruby_peter_v.rb

@@ -1,6 +1,5 @@
 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'
 require 'ruby_peter_v/define_equality'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_peter_v
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -94,14 +94,12 @@ files:
 - lib/ruby_peter_v.rb
 - lib/ruby_peter_v/define_equality.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/lib/ruby_peter_v/define_equality_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
@@ -132,7 +130,6 @@ 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/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

data/lib/ruby_peter_v/max_with_nil.rb

@@ -1,15 +0,0 @@
-class Object
-
-  def max_with_nil(a,b)
-    if b.nil?
-      a
-    else
-      if a.nil?
-        b
-      else
-        (b > a) ? b : a
-      end
-    end
-  end
-
-end

data/spec/lib/ruby_peter_v/max_with_nil_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe "max_with_nil" do
-  it "nil if a and b are nil" do
-    max_with_nil(nil, nil).should == nil
-  end
-
-  it "b if a is nil" do
-    max_with_nil(nil, 10).should == 10
-  end
-
-  it "a if b is nil" do
-    max_with_nil(10, nil).should == 10
-  end
-
-  it "a if a > b" do
-    max_with_nil(10, 5).should == 10
-  end
-
-  it "b if b > a" do
-    max_with_nil(5, 10).should == 10
-  end
-
-  it "a if a == b" do
-    a = "test"
-    b = "test"
-    max_with_nil(a, b).object_id.should == a.object_id
-  end
-end