nutella 0.7 → 0.8

data/lib/nutella/core_ext/file.rb

@@ -0,0 +1,51 @@
+class File
+  # Gives the size of a file as a string including the unit. It will choose the
+  # unit to use based on how big the file is. Decimals will be rounded to the
+  # tenths. +size+ is either a Numeric containing the size in bytes, a File
+  # object, or a String with the name of the file.
+  #
+  # @example Calculates size from several numbers
+  #   File.human_size 120         # => "120 Bytes"
+  #   File.human_size 1234        # => "1.2 KB"
+  #   File.human_size 1234567     # => "1.2 MB"
+  #   File.human_size 1234567890  # => "1.1 GB"
+  #
+  # @example Calculates the size of a 3 kilobyte file "foo.txt"
+  #   File.human_size "foo.txt"  # => "3 KB"
+  #
+  # @see File#human_size
+  #
+  # @param [String, File, Numeric] size the file to measure or size in bytes
+  # @return [String] the human readable size
+  def self.human_size(size)
+    bytes = size.is_a?(Numeric) ? size : File.size(size) rescue nil
+
+    return "Empty" if bytes.blank? || bytes.zero?
+    return "1 Byte" if bytes == 1
+
+    divisor, unit =
+      if bytes < Numeric::KILOBYTE
+        [1, "Bytes"]
+      elsif bytes < Numeric::MEGABYTE
+        [Numeric::KILOBYTE, "KB"]
+      elsif bytes < Numeric::GIGABYTE
+        [Numeric::MEGABYTE, "MB"]
+      else
+        [Numeric::GIGABYTE, "GB"]
+      end
+
+    "%g #{unit}" % (bytes.to_f / divisor).round(1)
+  end
+
+  # Returns the human readable form of the file's size.
+  #
+  # @example Calculates the size of a 4.2 megabyte file object
+  #   f.human_size  # => "4.2 MB"
+  #
+  # @see File::human_size
+  #
+  # @return [String] the human readable size
+  def human_size
+    File.human_size self
+  end
+end

data/lib/nutella/core_ext/numeric.rb

@@ -0,0 +1,43 @@
+class Numeric
+  KILOBYTE = 1024
+  MEGABYTE = KILOBYTE * 1024
+  GIGABYTE = MEGABYTE * 1024
+  TERABYTE = GIGABYTE * 1024
+  PETABYTE = TERABYTE * 1024
+  EXABYTE  = PETABYTE * 1024
+
+  def bytes
+    self
+  end
+  alias_method :byte, :bytes
+
+  def kilobytes
+    self * KILOBYTE
+  end
+  alias_method :kilobyte, :kilobytes
+
+  def megabytes
+    self * MEGABYTE
+  end
+  alias_method :megabyte, :megabytes
+
+  def gigabytes
+    self * GIGABYTE
+  end
+  alias_method :gigabyte, :gigabytes
+
+  def terabytes
+    self * TERABYTE
+  end
+  alias_method :terabyte, :terabytes
+
+  def petabytes
+    self * PETABYTE
+  end
+  alias_method :petabyte, :petabytes
+
+  def exabytes
+    self * EXABYTE
+  end
+  alias_method :exabyte, :exabytes
+end

data/lib/nutella/version.rb

@@ -1,4 +1,4 @@
 module Nutella
   # The current version of Nutella.
-  VERSION = "0.7"
+  VERSION = "0.8"
 end

data/spec/nutella/core_ext/enumerable_spec.rb

@@ -9,38 +9,38 @@ describe Enumerable do
   end
 
   describe "#exclude?" do
-    it "should return true if the collection does not contain the input" do
+    it "returns true if the collection does not contain the input" do
       [1, 2, 3].exclude?(4).should be_true
     end
 
-    it "should return false if the collection contains the input" do
+    it "returns false if the collection contains the input" do
       [1, 2, 3].exclude?(2).should be_false
     end
   end
 
   describe "#group" do
-    it "should group elements" do
+    it "groups elements" do
       [].group(2).should == []
       [1, 2].group(2).should == [[1, 2]]
       (1..4).group(2).should == [[1, 2], [3, 4]]
       (1..9).group(3).should == [[1, 2, 3], [4, 5, 6], [7, 8, 9]]
     end
 
-    it "should put all excess into the last group" do
+    it "puts all excess into the last group" do
       [1, 2].group(4).should == [[1, 2]]
       (1..8).group(3).should == [[1, 2, 3], [4, 5, 6], [7, 8]]
     end
 
-    it "should discard all excess if instructed to" do
+    it "discards all excess if instructed to" do
       (1..3).group(2, true).should == [[1, 2]]
       (1..8).group(3, true).should == [[1, 2, 3], [4, 5, 6]]
     end
 
-    it "should not discard anything if there is no excess" do
+    it "does not discard anything if there is no excess" do
       (1..4).group(2, true).should == [[1, 2], [3, 4]]
     end
 
-    it "should not modify in place" do
+    it "does not modify in place" do
       arr = (1..10).to_a
       arr.group 2
       arr.should == (1..10).to_a
@@ -50,48 +50,48 @@ describe Enumerable do
   describe "#group!" do
     let(:arr) { (1..10).to_a }
 
-    it "should modify in place" do
+    it "modifies in place" do
       arr.group! 2
       arr.should == (1..10).group(2)
     end
 
-    it "should return the modified string" do
+    it "returns the modified string" do
       return_catcher = arr.group! 2
       return_catcher.should == arr
     end
 
-    it "should return nil if nothing was modified" do
+    it "returns nil if nothing was modified" do
       return_catcher = [].group! 2
       return_catcher.should be_nil
     end
   end
 
   describe "#sum" do
-    it "should return the sum of elements" do
+    it "returns the sum of elements" do
       [].sum.should == 0
       [5].sum.should == 5
       [1, 2, 3].sum.should == 6
       (1..4).sum.should == 10
     end
 
-    it "should flatten the elements before adding" do
+    it "flattens the elements before adding" do
       [[4, 5], 1].sum.should == 10
       [[1, 2, 3], [4, 5]].sum.should == 15
     end
 
-    it "should filter out all non-numbers" do
+    it "filters out all non-numbers" do
       { a: 2, b: 4 }.sum.should == 6
       [1, "str", 4].sum.should == 5
       ["no numbers"].sum.should == 0
     end
 
     context "with a block" do
-      it "should return the sum of the elements that pass the filter block" do
+      it "returns the sum of the elements that pass the filter block" do
         (1..10).sum(&:even?).should == 30
         (1..10).sum { |n| n % 3 == 0 }.should == 18
       end
 
-      it "should still filter out all non-numbers" do
+      it "still filters out all non-numbers" do
         { a: 1, b: 2, c: 3 }.sum(&:odd?).should == 4
         [2, "str", 4, 7].sum(&:even?).should == 6
       end

data/spec/nutella/core_ext/file_spec.rb

@@ -0,0 +1,106 @@
+require "spec_helper"
+require "nutella/core_ext/file"
+require "nutella/core_ext/numeric"
+
+describe File do
+  describe "::human_size" do
+    context "when given a Numeric" do
+      it "does not change bytes" do
+        File.human_size(150.bytes).should == "150 Bytes"
+      end
+
+      it "changes kilobytes" do
+        File.human_size(1.5.kilobytes).should == "1.5 KB"
+      end
+
+      it "changes megabytes" do
+        File.human_size(1.5.megabytes).should == "1.5 MB"
+      end
+
+      it "changes gigabytes" do
+        File.human_size(1.5.gigabytes).should == "1.5 GB"
+      end
+
+      it "rounds down properly to the tenths" do
+        File.human_size(1.72.megabytes).should == "1.7 MB"
+      end
+
+      it "rounds up properly to the tenths" do
+        File.human_size(1.78.megabytes).should == "1.8 MB"
+      end
+
+      it "has a singular unit for 1 byte" do
+        File.human_size(1.byte).should == "1 Byte"
+      end
+
+      it "returns 'Empty' for an empty file or a blank parameter" do
+        File.human_size(0).should == "Empty"
+        File.human_size(nil).should == "Empty"
+      end
+
+      it "displays whole numbers without a decimal" do
+        File.human_size(1.megabyte).should == "1 MB"
+        File.human_size(24.gigabytes).should == "24 GB"
+      end
+    end
+
+    context "when given a File" do
+      it "detects empty files properly" do
+        begin
+          f = File.new("temp", "w")
+          File.human_size(f).should == "Empty"
+        ensure
+          File.delete "temp"
+        end
+      end
+
+      it "detects the file size properly" do
+        begin
+          File.truncate(f = File.new("temp", "w"), 1.5.kilobytes)
+          File.human_size(f).should == "1.5 KB"
+
+          File.truncate(f = File.new("temp", "w"), 3.kilobytes)
+          File.human_size(f).should == "3 KB"
+        ensure
+          File.delete "temp"
+        end
+      end
+    end
+
+    context "when given a String" do
+      it "detects the file size properly" do
+        begin
+          File.truncate(f = File.new("temp", "w"), 1.5.kilobytes)
+          File.human_size("temp").should == "1.5 KB"
+
+          File.truncate(f = File.new("temp", "w"), 3.kilobytes)
+          File.human_size("temp").should == "3 KB"
+        ensure
+          File.delete "temp"
+        end
+      end
+    end
+  end
+
+  describe "#human_size" do
+    it "detects empty files properly" do
+      begin
+        File.new("temp", "w").human_size.should == "Empty"
+      ensure
+        File.delete "temp"
+      end
+    end
+
+    it "detects the file size properly" do
+      begin
+        File.truncate(f = File.new("temp", "w"), 1.5.kilobytes)
+        f.human_size.should == "1.5 KB"
+
+        File.truncate(f = File.new("temp", "w"), 3.kilobytes)
+        f.human_size.should == "3 KB"
+      ensure
+        File.delete "temp"
+      end
+    end
+  end
+end

data/spec/nutella/core_ext/hash_spec.rb

@@ -10,15 +10,15 @@ describe Hash do
   end
 
   describe "#grab" do
-    it "should select the given items from a hash" do
+    it "selects the given items from a hash" do
       hash.slice(:a, :c).should == { a: 1, c: 3 }
     end
 
-    it "should skip items that do not exist in the hash" do
+    it "skips items that do not exist in the hash" do
       hash.slice(:a, :d, :f).should == { a: 1, d: 4 }
     end
 
-    it "should not modify in place" do
+    it "does not modify in place" do
       start = hash
       hash.slice :a, :b
       hash.should == start
@@ -26,16 +26,16 @@ describe Hash do
   end
 
   describe "#grab!" do
-    it "should modify in place" do
+    it "modifies in place" do
       hash.slice! :a, :c
       hash.should == { a: 1, c: 3 }
     end
 
-    it "should return the removed pairs" do
+    it "returns the removed pairs" do
       hash.slice!(:a, :c).should == { b: 2, d: 4 }
     end
 
-    it "should ignore pairs that did not affect the hash" do
+    it "ignores pairs that did not affect the hash" do
       hash.slice!(:a, :c, :g).should == { b: 2, d: 4 }
       hash.should == { a: 1, c: 3 }
     end

data/spec/nutella/core_ext/integer_spec.rb

@@ -8,7 +8,7 @@ describe Integer do
   end
 
   describe "#ordinalize" do
-    it "should return the ordinal form of the integer" do
+    it "returns the ordinal form of the integer" do
       NUMBER_FORMATS.each do |cardinal, ordinal|
         cardinal.ordinalize.should == ordinal
       end
@@ -16,41 +16,41 @@ describe Integer do
   end
 
   describe "#goes_into?" do
-    it "should return true if the number goes evenly into the argument" do
+    it "returns true if the number goes evenly into the argument" do
       5.goes_into?(10).should be_true
       3.goes_into?(21).should be_true
       25.goes_into?(100).should be_true
     end
 
-    it "should return false if the number does not go evenly in" do
+    it "returns false if the number does not go evenly in" do
       3.goes_into?(10).should be_false
       9.goes_into?(40).should be_false
       10.goes_into?(5).should be_false
     end
 
     context "when passing in zero" do
-      it "should return false if one tries to divide by zero" do
+      it "returns false if one tries to divide by zero" do
         0.goes_into?(20).should be_false
         0.goes_into?(30).should be_false
       end
 
-      it "should allow zero to go into zero" do
+      it "allows zero to go into zero" do
         0.goes_into?(0).should be_true
       end
     end
 
     context "with multiple arguments" do
-      it "should return true if all arguments succeed" do
+      it "returns true if all arguments succeed" do
         5.goes_into?(10, 15, 50).should be_true
         2.goes_into?(2, 4, 10).should be_true
       end
 
-      it "should return false if only some arguments succeed" do
+      it "returns false if only some arguments succeed" do
         5.goes_into?(10, 12, 15).should be_false
         8.goes_into?(4, 16).should be_false
       end
 
-      it "should return false if no arguments succeed" do
+      it "returns false if no arguments succeed" do
         3.goes_into?(8, 16, 20).should be_false
         6.goes_into?(5, 10, 15).should be_false
       end
@@ -58,31 +58,31 @@ describe Integer do
   end
 
   describe "#goes_into_any?" do
-    it "should return true if all arguments succeed" do
+    it "returns true if all arguments succeed" do
       5.goes_into_any?(10, 15, 50).should be_true
       2.goes_into_any?(2, 4, 10).should be_true
     end
 
-    it "should return true if only some arguments succeed" do
+    it "returns true if only some arguments succeed" do
       5.goes_into_any?(10, 12, 15).should be_true
       8.goes_into_any?(4, 16).should be_true
     end
 
-    it "should return false if no arguments succeed" do
+    it "returns false if no arguments succeed" do
       3.goes_into_any?(8, 16, 20).should be_false
       6.goes_into_any?(5, 10, 15).should be_false
     end
   end
 
   describe "#multiple_of?" do
-    it "should return true if the number is evenly divisible" do
+    it "returns true if the number is evenly divisible" do
       5.multiple_of?(5).should be_true
       15.multiple_of?(5).should be_true
       10.multiple_of?(2).should be_true
       6000.multiple_of?(6).should be_true
     end
 
-    it "should return false if the number is not evenly divisible" do
+    it "returns false if the number is not evenly divisible" do
       20.multiple_of?(7).should be_false
       4.multiple_of?(3).should be_false
       5.multiple_of?(15).should be_false
@@ -90,30 +90,30 @@ describe Integer do
     end
 
     context "when passing in zero" do
-      it "should return false if one tries to divide by zero" do
+      it "returns false if one tries to divide by zero" do
         20.multiple_of?(0).should be_false
         30.multiple_of?(0).should be_false
       end
 
-      it "should allow zero to go into zero" do
+      it "allows zero to go into zero" do
         0.multiple_of?(0).should be_true
       end
     end
 
     context "with multiple arguments" do
-      it "should return true if evenly divisible by all arguments" do
+      it "returns true if evenly divisible by all arguments" do
         15.multiple_of?(3, 15).should be_true
         100.multiple_of?(2, 5, 25).should be_true
         0.multiple_of?(0, 1, 2).should be_true
       end
 
-      it "should return false if evenly divisible by only some arguments" do
+      it "returns false if evenly divisible by only some arguments" do
         15.multiple_of?(2, 3).should be_false
         12.multiple_of?(3, 4, 6, 8).should be_false
         10.multiple_of?(0, 5).should be_false
       end
 
-      it "should return false if evenly divisible by none of the arguments" do
+      it "returns false if evenly divisible by none of the arguments" do
         6.multiple_of?(4, 5).should be_false
         17.multiple_of?(2, 4).should be_false
       end
@@ -121,19 +121,19 @@ describe Integer do
   end
 
   describe "#multiple_of_any?" do
-    it "should return true if evenly divisible by all arguments" do
+    it "returns true if evenly divisible by all arguments" do
       15.multiple_of_any?(3, 15).should be_true
       100.multiple_of_any?(2, 5, 25).should be_true
       0.multiple_of_any?(0, 1, 2).should be_true
     end
 
-    it "should return true if evenly divisible by only some arguments" do
+    it "returns true if evenly divisible by only some arguments" do
       15.multiple_of_any?(2, 3).should be_true
       12.multiple_of_any?(3, 4, 6, 8).should be_true
       10.multiple_of_any?(0, 5).should be_true
     end
 
-    it "should return false if evenly divisible by none of the arguments" do
+    it "returns false if evenly divisible by none of the arguments" do
       6.multiple_of_any?(4, 5).should be_false
       17.multiple_of_any?(2, 4).should be_false
     end

data/spec/nutella/core_ext/numeric_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+require "nutella/core_ext/numeric"
+
+describe Numeric do
+  describe "aliases" do
+    # Test the singular aliases- byte for bytes, kilobyte for kilobytes, etc.
+    ([""] + %w[kilo mega giga tera peta exa]).each do |prefix|
+      test_alias Numeric, (name = "#{prefix}byte").to_sym, "#{name}s".to_sym
+    end
+  end
+end

data/spec/nutella/core_ext/object_spec.rb

@@ -7,43 +7,43 @@ describe Object do
   end
 
   describe "#blank?" do
-    it "should be blank when nil" do
+    it "is blank when nil" do
       nil.blank?.should be_true
     end
 
-    it "should be blank when false" do
+    it "is blank when false" do
       false.blank?.should be_true
     end
 
-    it "should not be blank when true" do
+    it "is not blank when true" do
       true.blank?.should be_false
     end
 
-    it "should not be blank when numeric" do
+    it "is not blank when numeric" do
       [0, 1].each { |n| n.blank?.should be_false }
     end
 
     context "when a string" do
-      it "should be blank if the string is empty" do
+      it "is blank if the string is empty" do
         "".blank?.should be_true
       end
 
-      it "should be blank if only whitespace" do
+      it "is blank if only whitespace" do
         ["  ", "\n  \t"].each { |str| str.blank?.should be_true }
         "  something here  ".blank?.should be_false
       end
 
-      it "should not be blank if the string has content" do
+      it "is not blank if the string has content" do
         "string".blank?.should be_false
       end
     end
 
     context "when a collection" do
-      it "should be blank if the collection is empty" do
+      it "is blank if the collection is empty" do
         [[], {}].each { |collection| collection.blank?.should be_true }
       end
 
-      it "should not be blank if there are elements in the collection" do
+      it "is not blank if there are elements in the collection" do
         [[1, 2, 3], { 1 => 2, 3 => 4 }].each do |collection|
           collection.blank?.should be_false
         end
@@ -52,7 +52,7 @@ describe Object do
   end
 
   describe "#present?" do
-    it "should be the inverse of #blank?" do
+    it "is the inverse of #blank?" do
       [0, 1].each { |n| n.present?.should be_true }
       [[], {}].each { |collection| collection.present?.should be_false }
       ["", "  "].each { |str| str.present?.should be_false }
@@ -61,12 +61,12 @@ describe Object do
   end
 
   describe "#presence" do
-    it "should return the object if the object is present" do
+    it "returns the object if the object is present" do
       1.presence.should == 1
       "str".presence.should == "str"
     end
 
-    it "should return nil if the object is not present" do
+    it "returns nil if the object is not present" do
       "".presence.should be_nil
       false.presence.should be_nil
     end

data/spec/nutella/core_ext/string_spec.rb

@@ -14,11 +14,11 @@ describe Enumerable do
   end
 
   describe "#exclude?" do
-    it "should return true if the string does not contain the input string" do
+    it "returns true if the string does not contain the input string" do
       "hello".exclude?("test").should be_true
     end
 
-    it "should return false if the string contains the input string" do
+    it "returns false if the string contains the input string" do
       "hello".exclude?("llo").should be_false
     end
   end
@@ -48,7 +48,7 @@ Left-aligned again.
 EOS
     end
 
-    it "should strip all excess whitespace from the left" do
+    it "strips all excess whitespace from the left" do
       test.should == expected
     end
   end

data/spec/support/alias.rb

@@ -1,7 +1,7 @@
 # Tests if +method_a+ is an alias to +method_b+ in the class +cls+.
 def test_alias(cls, method_a, method_b)
   describe "##{method_a.to_s}" do
-    it "should be an alias of ##{method_b.to_s}" do
+    it "is an alias of ##{method_b.to_s}" do
       cls.instance_method(method_a).should === cls.instance_method(method_b)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nutella
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.8'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-22 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuubar
@@ -116,10 +116,12 @@ files:
 - lib/nutella.rb
 - lib/nutella/version.rb
 - lib/nutella/input.rb
+- lib/nutella/core_ext/numeric.rb
 - lib/nutella/core_ext/integer/multiples.rb
 - lib/nutella/core_ext/integer/format.rb
 - lib/nutella/core_ext/object.rb
 - lib/nutella/core_ext/string.rb
+- lib/nutella/core_ext/file.rb
 - lib/nutella/core_ext/integer.rb
 - lib/nutella/core_ext/hash.rb
 - lib/nutella/core_ext/object/blank.rb
@@ -130,9 +132,11 @@ files:
 - spec/support/number_formats.rb
 - spec/nutella/core_ext/object_spec.rb
 - spec/nutella/core_ext/hash_spec.rb
+- spec/nutella/core_ext/numeric_spec.rb
 - spec/nutella/core_ext/enumerable_spec.rb
 - spec/nutella/core_ext/integer_spec.rb
 - spec/nutella/core_ext/string_spec.rb
+- spec/nutella/core_ext/file_spec.rb
 - spec/spec_helper.rb
 - .rspec
 - LICENSE
@@ -160,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3181334132306800521
+      hash: 2449410360859195033
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -172,8 +176,10 @@ test_files:
 - spec/support/number_formats.rb
 - spec/nutella/core_ext/object_spec.rb
 - spec/nutella/core_ext/hash_spec.rb
+- spec/nutella/core_ext/numeric_spec.rb
 - spec/nutella/core_ext/enumerable_spec.rb
 - spec/nutella/core_ext/integer_spec.rb
 - spec/nutella/core_ext/string_spec.rb
+- spec/nutella/core_ext/file_spec.rb
 - spec/spec_helper.rb
 has_rdoc: