koalemos 0.0.2 → 0.0.3

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+.yardoc
 
 ## PROJECT::SPECIFIC

data/Rakefile

@@ -11,7 +11,6 @@ begin
     gem.homepage = "http://github.com/Talby/koalemos"
     gem.authors = ["Tal Atlas"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "yard", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/koalemos.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{koalemos}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tal Atlas"]
@@ -58,14 +58,11 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<yard>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<yard>, [">= 0"])
   end
 end
 

data/lib/koalemos.rb

@@ -3,4 +3,4 @@ files.each do |f|
  require f
 end
 
-include Koalemos
+#include Koalemos

data/lib/koalemos/beginning_of_day.rb

@@ -1,6 +1,7 @@
-module Koalemos
+module Koalemos # :nodoc:
   class ::Time
     unless method_defined?(:beginning_of_day)
+      # Returns a time object at midnight for the particular day
       def beginning_of_day
         ::Time.mktime(self.year,self.month,self.day)
       end

data/lib/koalemos/blank.rb

@@ -1,34 +1,39 @@
-module Koalemos
-  module Blank
+module Koalemos # :nodoc:# :nodoc:
+  module Blank# :nodoc:
+    # Allows for detection of whether an object contains something regardless of
+    # what class the object is
+    # @author Florian Frank
     module Object
+      # Returns the !empty? or !self for any object
       def blank?
         respond_to?(:empty?) ? empty? : !self
       end
-
+      
+      # Returns !blank?
       def present?
         !blank?
       end
     end
 
-    module NilClass
+    module NilClass# :nodoc:
       def blank?
         true
       end
     end
 
-    module FalseClass
+    module FalseClass# :nodoc:
       def blank?
         true
       end
     end
 
-    module TrueClass
+    module TrueClass# :nodoc:
       def blank?
         false
       end
     end
 
-    module Array
+    module Array # :nodoc:
       def self.included(modul)
         modul.module_eval do
           alias_method :blank?, :empty?
@@ -36,7 +41,7 @@ module Koalemos
       end
     end
 
-    module Hash
+    module Hash # :nodoc:
       def self.included(modul)
         modul.module_eval do
           alias_method :blank?, :empty?
@@ -44,13 +49,13 @@ module Koalemos
       end
     end
 
-    module String
+    module String # :nodoc:
       def blank?
         self !~ /\S/
       end
     end
 
-    module Numeric
+    module Numeric # :nodoc:
       def blank?
         false
       end

data/lib/koalemos/commaify.rb

@@ -1,6 +1,7 @@
-module Koalemos
+module Koalemos # :nodoc:
   class ::Numeric
     unless method_defined?(:commafy)
+      # Returns a string for a number with commas ever 3 digits
       def commaify
         to_s.reverse.scan(/(?:\d*\.)?\d{1,3}-?/).join(',').reverse
       end
@@ -9,7 +10,7 @@ module Koalemos
   
   class ::Float
     unless method_defined?(:commafy)
-      def commaofy
+      def commaofy# :nodoc:
         to_s.gsub(/\d+\./) do |s|
           s.reverse.scan(/(?:\d*\.)?\d{1,3}-?/).join(',').reverse
         end

data/lib/koalemos/friendly_time.rb

@@ -1,7 +1,8 @@
 require File.join(File.dirname(__FILE__),'num_to_time.rb')
 
-module Koalemos
-  module FriendlyTime
+module Koalemos # :nodoc:
+  module FriendlyTime# :nodoc:
+    # Friendly time
     def friendly(since = Time.now)
       ago = since - self
       case ago
@@ -31,7 +32,7 @@ module Koalemos
     end
   end
   
-  class ::Time
+  class ::Time # :nodoc:
     if !method_defined?(:friendly) && ::Numeric.method_defined?(:day)
       include FriendlyTime
     else

data/lib/koalemos/full.rb

@@ -1,4 +1,4 @@
-module Koalemos
+module Koalemos # :nodoc:
   module Full
     # Returns the object if it isn't blank (as in Object#blank?), otherwise it
     # returns nil. If a block was given as an argument and the object isn't
@@ -25,7 +25,7 @@ module Koalemos
     end
   end
  
-  class ::Object
+  class ::Object # :nodoc:
     include Full
   end
 end

data/lib/koalemos/hash_union.rb

@@ -1,12 +1,16 @@
-module Koalemos
+module Koalemos # :nodoc:
   module HashUnion
+    # Reverse merge
+    #   h1 = {:foo => 'foo',:bar => 'bar'}
+    #   h1 |= {:foo => 'none',:baz => 'baz'}
+    #   h1.should == {:foo => 'foo',:bar => 'bar',:baz => 'baz'} #=> true
     def |(other)
       other = other.to_hash if other.respond_to?(:to_hash)
       other.merge(self)
     end
   end
   
-  class ::Hash
+  class ::Hash # :nodoc:
     if method_defined?(:|)
       warn "#{self}#| already defined, didn't include at #{__FILE__}:#{__LINE__}"
     else

data/lib/koalemos/num_to_time.rb

@@ -1,49 +1,55 @@
-module Koalemos
+module Koalemos # :nodoc:
+  # Blah blah blah
   module NumToTime
-    def minute
+    def minute# :nodoc:
       self * 60
     end
-    alias_method :minutes, :minute
+    alias_method :minutes, :minute# :nodoc:
 
-    def hour
+    def hour# :nodoc:
       self * 3600
     end
-    alias_method :hours, :hour
+    alias_method :hours, :hour# :nodoc:
 
-    def day
+    def day# :nodoc:
       self * 86400
     end
-    alias_method :days, :day
+    alias_method :days, :day# :nodoc:
 
-    def week
+    def week# :nodoc:
       self * 604800
     end
-    alias_method :weeks, :week
+    alias_method :weeks, :week# :nodoc:
 
-    def month
+    def month# :nodoc:
       self * 2592000
     end
-    alias_method :months, :month
+    alias_method :months, :month# :nodoc:
 
-    def year
+    def year# :nodoc:
       self * 31536000
     end
-    alias_method :years, :year
-
+    alias_method :years, :year# :nodoc:
+    
+    # Changes a number into a Time object num seconds in the past
+    #   60.ago #=> 1 minute ago
     def ago
       Time.now - to_i
     end
-
+    
+    # Changes a number into a Time object num seconds in the future
+    #   60.ago #=> 1 minute from now
     def from_now
       Time.now + to_i
     end
-
+    
+    # Converts seconds to Epoch time
     def to_time
       Time.at(to_i)
     end
   end
   
-  class ::Numeric
+  class ::Numeric # :nodoc:
     unless method_defined?(:minute)
       include NumToTime
     end

data/lib/koalemos/odd.rb

@@ -1,11 +1,12 @@
-module Koalemos
+module Koalemos # :nodoc:
   module Odd
+    # Returns boolean of whether the Numeric is odd or not
     def odd?
       self%2 == 1
     end
   end
   
-  class ::Numeric
+  class ::Numeric # :nodoc:
     unless method_defined?(:odd?)
       include Odd
     end

data/lib/koalemos/rand.rb

@@ -6,7 +6,8 @@
 # Documentation:: Christian Neukirchen <mailto:chneukirchen@gmail.com>
 # 
 
-module Koalemos
+module Koalemos # :nodoc:
+  # @author Ilmari Heikkinen
   module Rand
     module Enumerable_
       # Choose and return a random element of the Enumerable.

data/lib/koalemos/round.rb

@@ -1,4 +1,4 @@
-module Koalemos
+module Koalemos # :nodoc:
   # A bit more versatile rounding for Ruby
   module RoundTo
       # def self.included(klass)
@@ -14,7 +14,9 @@ module Koalemos
       #     raise NoMethodError, 'no round method found'
       #   end
       # end
-
+    
+    # A more versitile rounding function that rounds to an arbitrary number
+    # of decimil places
     def round_to(places = 0)
       unless Integer === places
         raise TypeError, "argument places has to be an Integer"
@@ -36,7 +38,7 @@ module Koalemos
     end
   end
   
-  class ::Float
+  class ::Float # :nodoc:
     unless method_defined?(:round_to)
       include RoundTo
     end

data/lib/koalemos/symbol_to_proc.rb

@@ -1,5 +1,6 @@
-module Koalemos
+module Koalemos # :nodoc:
   module ToProc
+    # Converts a symbol to a proc
     def to_proc
       lambda do |obj, *args|
         obj.__send__(self, *args[0..-1])
@@ -7,7 +8,7 @@ module Koalemos
     end
   end
   
-  class ::Symbol
+  class ::Symbol# :nodoc:
     unless method_defined?(:to_proc)
       include ToProc
     end

data/lib/koalemos/try.rb

@@ -1,10 +1,11 @@
-module Koalemos
+module Koalemos # :nodoc:
   unless Object.method_defined?(:try)
-    class Object
-      alias_method :try, :__send__
+    class Object# :nodoc
+      alias_method :try, :__send__ # :nodoc
     end
     
-    class ::NilClass
+    class ::NilClass# :nodoc
+      # Trys to call a method (alias for +send+)
       def try(*a)
         nil
       end

data/lib/koalemos/uniq_by.rb

@@ -1,12 +1,18 @@
-module Koalemos
+module Koalemos # :nodoc:
   module UniqBy
+    # Finds unique values in an array based on a block passed
+    #   [ {:key => 'foo'},
+    #    {:key => 'foo'},
+    #    {:key => 'bar'},
+    #    {:key => 'baz'},
+    #    {:key => 'bbaz'}].uniq_by{|a| a[:key]} #=> [{:key=>"bbaz"}, {:key=>"baz"}, {:key=>"foo"}, {:key=>"bar"}]
     def uniq_by(&b)
       b ||= lambda { |x| x }
       inject({}) { |h, e| h[b[e]] ||= e; h }.values
     end
   end
   
-  module ::Enumerable
+  module ::Enumerable# :nodoc:
     if method_defined?(:uniq_by)
       warn "#{self}#uniq_by already defined, didn't include at #{__FILE__}:#{__LINE__}"
     else
@@ -14,7 +20,7 @@ module Koalemos
     end
   end
   
-  class ::Array
+  class ::Array # :nodoc:
     if method_defined?(:uniq_by)
       warn "#{self}#uniq_by already defined, didn't include at #{__FILE__}:#{__LINE__}"
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: koalemos
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tal Atlas
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.9
     version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
 description: A bunch of small extensions to built in classes/modules
 email: me@talatlas.com
 executables: []