nutella 0.1 → 0.1.1

data/README.md

@@ -1,9 +1,9 @@
-# Nutella [![Build Status](https://secure.travis-ci.org/gbchaosmaster/nutella.png)](http://travis-ci.org/gbchaosmaster/nutella)
+# Nutella [![Build Status](https://secure.travis-ci.org/gbchaosmaster/nutella.png)](http://travis-ci.org/gbchaosmaster/nutella) [![Dependency Status](https://gemnasium.com/gbchaosmaster/nutella.png)](https://gemnasium.com/gbchaosmaster/nutella) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/gbchaosmaster/nutella)
 
 This library is my personal collection of Ruby utilities, mainly core
-extensions. It is similar to
-[Active Support](https://github.com/rails/rails/tree/master/activesupport),
-but lighter.
+extensions.
+
+ * [RubyGems](https://rubygems.org/gems/nutella)
 
 ## Installation
 
@@ -15,39 +15,18 @@ gem install nutella
 
 ## Contributing
 
-This library is my own little collection of core extensions that I like to use,
-and I add things as they are useful to me. I cannot guarantee that you will
-find it useful as I do.
+All contributions to Nutella are welcome. Feel free to send a pull request if
+you feel that you have a feature that is useful, and definitely let me know if
+you find any bugs.
 
-That being said, I welcome any contributions. Feel free to send a pull request
-if you feel that you have a feature that is useful, and definitely let me know
-if you find any bugs.
+Be sure that all tests succeed before sending a pull request! Pull requests
+with failing tests will not be accepted. Also, please test your code- if your
+change affects the functionality of the library, write tests that fail
+without your code, and pass with your code.
 
 ## License
 
-```nutella``` is released under the MIT license.
-
-```
-Copyright (C) 2012 Vinny Diehl
-
-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.
-```
-
-See [the official page on OSI](http://opensource.org/licenses/MIT) for more
+Nutella is released under the MIT license. See the LICENSE file included with
+this code or
+[the official page on OSI](http://opensource.org/licenses/MIT) for more
 information.

data/Rakefile

@@ -1,8 +1,17 @@
+require "nutella/version"
+
 require "bundler"
 Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new :spec
-
 task test: :spec
+
+require "yard"
+YARD::Rake::YardocTask.new do |doc|
+  doc.files << "lib/**/*.rb"
+  doc.options << ["--title", "Nutella #{Nutella::VERSION} Documentation"]
+end
+task doc: :yard
+
 task default: :spec

data/lib/nutella/core_ext/enumerable.rb

@@ -2,9 +2,11 @@ module Enumerable
   alias_method :contains?, :include?
   alias_method :includes?, :include?
 
-  # The inverse of <tt>Enumerable#include?</tt>. Returns +true+ if the
-  # collection does not contain +object+.
-  def exclude? object
+  # The inverse of <tt>Enumerable#include?</tt>.
+  #
+  # @param [Object] object the object to test for exclusion
+  # @return [Boolean] whether or not the collection excludes +object+
+  def exclude?(object)
     !include? object
   end
   alias_method :excludes?, :exclude?
@@ -13,28 +15,43 @@ module Enumerable
   # at the end will be put into a smaller group if necessary, unless
   # +discard_excess+ is true, in which case they will be discarded.
   #
+  # @example Groups numbers 1..4 into groups of 2
   #   (1..4).group(2)       # => [[1, 2], [3, 4]]
+  # @example Groups numbers 1..8 into groups of 3
   #   (1..8).group(3)       # => [[1, 2, 3], [4, 5, 6], [7, 8]]
+  # @example Groups numbers 1..8 into groups of 3, discarding excess elements
   #   (1..8).group(3, true) # => [[1, 2, 3], [4, 5, 6]]
+  #
+  # @param [Integer] size the size of the groups to create
+  # @param [Boolean] discard_excess whether or not to discard extra elements
+  # @return [Array] an array of the groups
   def group(size, discard_excess = false)
     groups = each_slice(size).to_a
-    discard_excess && groups.last.size < size ? groups[0..-2] : groups
+    groups[0..(discard_excess && groups.last.size < size ? -2 : -1)]
   end
 
   # Modifies the collection in place as described for
   # <tt>Enumerable#group</tt>. Returns the modified collection, or nil if no
   # modifications were made.
+  #
+  # @see Enumerable#group
   def group!(size, discard_excess = false)
     return nil if empty?
     self.replace group(size, discard_excess)
   end
 
-  # Returns the sum of all numeric elements in the collection
+  # Add together all numeric elements in the collection.
   #
+  # @example Sums up the elements of an array
   #   [1, 2, 3].sum         # => 6
+  # @example Sums up the elements of a 2-dimensional array
   #   [[1, 2], [3, 4]].sum  # => 10
+  # @example Sums up the numeric elements of a hash
   #   { a: 4, b: 5 }.sum    # => 9
+  # @example Ignores the non-numeric element in the array
   #   [2, "string", 9].sum  # => 11
+  #
+  # @return [Numeric] the sum of all numeric elements in the collection
   def sum
     flatten.select { |e| e.is_a? Numeric }.inject(:+) || 0
   end

data/lib/nutella/core_ext/string.rb

@@ -4,15 +4,28 @@ class String
 
   alias_method :each, :each_char
 
-  # The inverse of <tt>String#include?</tt>. Returns +true+ if the string does
-  # not contain +str+.
+  # The inverse of <tt>String#include?</tt>.
+  #
+  # @param [String] str the string to test for exclusion
+  # @return [Boolean] whether or not the string excludes the substring +str+
   def exclude?(str)
     !include? str
   end
   alias_method :excludes?, :exclude?
 
-  # Left-aligns a heredoc by finding the lest indented line in the string, and
-  # removing that amount of leading whitespace.
+  # Left-aligns a heredoc by finding the least indented line in the string, and
+  # removing that amount of leading whitespace from each line.
+  #
+  # @example Prints the contents of the heredoc as described on each line
+  #   puts <<-EOS.heredoc
+  #     This line would be left-aligned.
+  #     This line too.
+  #         This line would be indented by four spaces.
+  #         As well as this line.
+  #     And back to left-aligned.
+  #   EOS
+  #
+  # @return [String] the string with excess leading whitespace stripped
   def heredoc
     gsub /^[ \t]{#{scan(/^[ \t]*(?=\S)/).min.size}}/, ""
   end

data/lib/nutella/version.rb

@@ -1,3 +1,4 @@
 module Nutella
-  VERSION = "0.1"
+  # The current version of Nutella.
+  VERSION = "0.1.1"
 end

data/nutella.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |gem|
   ]
 
   gem.required_ruby_version = ">= 1.9.2"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake", "~> 0.9"
+  gem.add_development_dependency "redcarpet", "~> 2.1"
+  gem.add_development_dependency "rdoc", "~> 3.0"
+  gem.add_development_dependency "rspec", "~> 2.11"
+  gem.add_development_dependency "yard", "~> 0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nutella
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -16,33 +16,81 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 description: My collection of Ruby utilities, mainly core extensions.
 email: gbchaosmaster926@gmail.com
 executables: []
@@ -81,6 +129,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2447363496143350435
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -91,3 +142,4 @@ test_files:
 - spec/nutella/core_ext/enumerable_spec.rb
 - spec/nutella/core_ext/string_spec.rb
 - spec/spec_helper.rb
+has_rdoc: