addy 1.0.0 → 1.1.0

data/README.md

@@ -33,28 +33,46 @@ Then use it!
       end
     end
 
+When you include addy on a class that implements inject, you don't even need to pass a value to it. Instead it calls sum on your class.
+
+    require 'addy'
+
+    class MyClass < Range
+      include Addy
+      
+      def my_awesome_adder
+        sum
+      end
+    end
+
 ### Calling It
 You can call either sum or summation. They're aliases for the same thing.
 
+Note: The following assumes Addy is included into Range.
+
 When you pass a block to sum it will execute the block on the current number before adding it to the sum.
 
-    sum(1..5) {|num| num + 1} #=> 20
+    sum(1..5) {|num| num + 1}  #=> 20
+    (1..5).sum {|num| num + 1} #=> 20
 
 You don't have to pass a block though!
 
     #this
-    sum(1..5)             #=> 15
+    sum(1..5)              #=> 15
+    #and
+    (1..5).sum             #=> 15
+    
+    #are equivalent to
+    sum(1..5) {|num| num}  #=> 15
+    #and
+    (1..5).sum {|num| num} #=> 15
     
-    #is equivalent to
-    sum(1..5) {|num| num} #=> 15
 ### Input
 Ranges and numeric arrays both work well.
 
     sum(1..5)         #=> 15
     sum([1,2,3,4,5])  #=> 15
 
-
-
 ## Note on Patches/Pull Requests
  
 * Fork the project.
@@ -69,4 +87,4 @@ Ranges and numeric arrays both work well.
 
 Copyright (c) 2010 Allen Madsen. See LICENSE for details.
 
-## PS: Isn't it ridiculous how much documentation I wrote for one function?
+PS: Isn't it ridiculous how much documentation I wrote for one function?

data/Rakefile

@@ -1,12 +1,16 @@
 require 'rubygems'
 require 'rake'
 
+def get_description
+  File.read("./README.md")
+end
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "addy"
     gem.summary = %Q{Prettier summations in your code.}
-    gem.description = %Q{Prettier summations in your code.}
+    gem.description = get_description
     gem.email = "blatyo@gmail.com"
     gem.homepage = "http://github.com/blatyo/addy"
     gem.authors = ["Allen Madsen"]

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/addy.rb

@@ -1,6 +1,10 @@
 module Addy
-  def summation(range)
-    range.inject(0) do |memo, num|
+  def summation(injectable = nil)
+    injectable ||= self
+    
+    raise "#{injectable.class.name} does not implement inject." unless injectable.respond_to? :inject
+    
+    injectable.inject(0) do |memo, num|
       if block_given?
         yield(num) + memo
       else

data/spec/addy_spec.rb

@@ -1,23 +1,51 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Addy do
-  before(:all) do
-    class ::Object
-      include ::Addy
-    end
-  end
-  
   describe "#sum" do
-    context "when no block is given" do
-      it "should calculate the sum of the values in the range" do
-        sum(1..5).should == 15
+    before(:all) do
+      class NotInjectable
+        include ::Addy
       end
     end
     
-    context "when a block is given" do
-      it "should calculate the sum of the results of the block for each value in the range" do
+    context "when sum is called with a parameter" do
+      before(:all) do
+        class ::Object
+          include ::Addy
+        end
+      end
+    
+      it "should calculate the sum of the values passed in when no block is given" do
+        sum(1..5).should == 15
+      end
+    
+      it "should calculate the sum of the results of the block for the values passed in when a block is given" do
         sum(1..3) {|i| i**i }.should == 32
       end
+      
+      it "should raise an exception when self does not respond to inject" do
+        lambda {sum NotInjectable.new}.should raise_error "NotInjectable does not implement inject."
+      end
+    end
+    
+    context "when sum is called without a parameter" do
+      before(:all) do
+        class ::Range
+          include ::Addy
+        end
+      end
+      
+      it "should calculate the sum of the values of self when no block is given" do
+        (1..5).sum.should == 15
+      end
+            
+      it "should calculate the sum of the results of the block for each value of self when a block is given" do
+        (1..3).sum {|i| i**i }.should == 32
+      end
+      
+      it "should raise an exception when self does not respond to inject" do
+        lambda {NotInjectable.new.sum}.should raise_error "NotInjectable does not implement inject."
+      end
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Allen Madsen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -04:00
+date: 2010-06-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,7 +58,97 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Prettier summations in your code.
+description: |-
+  # Addy
+  
+  Allows pretty summations. Instead of writing:
+  
+      (1..5).inject(0) do |memo, num|
+        memo + (num**num)
+      end
+  
+  You write:
+  
+      sum(1..5) do |num|
+        num**num
+      end
+      
+  Personally, I would rather write the latter.
+  
+  ## Usage
+  
+  Install the gem:
+  
+      gem install addy
+  
+  Then use it!
+  
+      require 'addy'
+  
+      class MyClass
+        #include it in a class or in Object to get it everywhere
+        include Addy
+        
+        def my_awesome_adder(range)
+          sum(range)
+        end
+      end
+  
+  When you include addy on a class that implements inject, you don't even need to pass a value to it. Instead it calls sum on your class.
+  
+      require 'addy'
+  
+      class MyClass < Range
+        include Addy
+        
+        def my_awesome_adder
+          sum
+        end
+      end
+  
+  ### Calling It
+  You can call either sum or summation. They're aliases for the same thing.
+  
+  Note: The following assumes Addy is included into Range.
+  
+  When you pass a block to sum it will execute the block on the current number before adding it to the sum.
+  
+      sum(1..5) {|num| num + 1}  #=> 20
+      (1..5).sum {|num| num + 1} #=> 20
+  
+  You don't have to pass a block though!
+  
+      #this
+      sum(1..5)              #=> 15
+      #and
+      (1..5).sum             #=> 15
+      
+      #are equivalent to
+      sum(1..5) {|num| num}  #=> 15
+      #and
+      (1..5).sum {|num| num} #=> 15
+      
+  ### Input
+  Ranges and numeric arrays both work well.
+  
+      sum(1..5)         #=> 15
+      sum([1,2,3,4,5])  #=> 15
+  
+  ## Note on Patches/Pull Requests
+   
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Commit, do not mess with rakefile, version, or history.
+    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+  * Send me a pull request. Bonus points for topic branches.
+  
+  ## Copyright
+  
+  Copyright (c) 2010 Allen Madsen. See LICENSE for details.
+  
+  PS: Isn't it ridiculous how much documentation I wrote for one function?
 email: blatyo@gmail.com
 executables: []
 
@@ -76,9 +166,6 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- features/addy.feature
-- features/step_definitions/addy_steps.rb
-- features/support/env.rb
 - lib/addy.rb
 - spec/addy_spec.rb
 - spec/spec.opts

data/features/addy.feature

@@ -1,9 +0,0 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'addy'
-
-require 'spec/expectations'