addy 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@addy > /dev/null

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+group :test do
+  gem "rspec", "1.3.0"
+  gem "cucumber"
+end
+
+group :doc do
+  gem "yard"
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Allen Madsen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+# 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
+
+### Calling It
+You can call either sum or summation. They're aliases for the same thing.
+
+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
+
+You don't have to pass a block though!
+
+    #this
+    sum(1..5)             #=> 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.
+* 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?

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "blatyo@gmail.com"
+    gem.homepage = "http://github.com/blatyo/addy"
+    gem.authors = ["Allen Madsen"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/features/addy.feature

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

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

data/lib/addy.rb

@@ -0,0 +1,13 @@
+module Addy
+  def summation(range)
+    range.inject(0) do |memo, num|
+      if block_given?
+        yield(num) + memo
+      else
+        num + memo
+      end
+    end
+  end
+  
+  alias :sum :summation
+end

data/spec/addy_spec.rb

@@ -0,0 +1,23 @@
+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
+      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
+        sum(1..3) {|i| i**i }.should == 32
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'addy'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: addy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Prettier summations in your code.
+email: blatyo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+- README.md
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.md
+- 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
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/blatyo/addy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Prettier summations in your code.
+test_files: 
+- spec/addy_spec.rb
+- spec/spec_helper.rb