filesize 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1 +1,3 @@
-v0.0.1. first version. enjoy!
+Version 0.0.2 -- 2010-10-04
+* Fixing float handling
+* Use yardoc for documentation

data/README.markdown

@@ -5,7 +5,7 @@ That means:
 * Parsing strings (e.g. "1 GiB") and saving it internally as bytes
 * Handling both SI and binary prefixes
 * Converting from any type and unit to any other (SI to SI, SI to Binary and so on)
-* doing calculatings with filesizes (in a smart way, see Usage for more)
+* doing calculations with filesizes (in a smart way, see Usage for more)
 * filesize.rb also provides some default sizes, like the ones of DVDs
 
 ## Usage

data/filesize.gemspec

@@ -1,34 +1,17 @@
 # -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
-  s.name = %q{filesize}
-  s.version = "0.0.1"
+  s.name = "filesize"
+  s.version = "0.0.2"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dominik Honnef"]
-  s.cert_chain = ["/home/dominikh/.rubyforge/gem-public_cert.pem"]
   s.date = %q{2009-07-26}
-  s.description = %q{filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.}
-  s.email = %q{dominikho@gmx.net}
-  s.extra_rdoc_files = ["README.markdown", "CHANGELOG", "lib/filesize.rb"]
-  s.files = ["Rakefile", "README.markdown", "CHANGELOG", "lib/filesize.rb", "Manifest", "filesize.gemspec"]
-  s.has_rdoc = true
-  s.homepage = %q{http://filesize.rubyforge.org/}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Filesize", "--main", "README.markdown"]
-  s.require_paths = ["lib"]
-  s.required_ruby_version = Gem::Requirement.new(">= 1.8.6")
-  s.rubyforge_project = %q{filesize}
-  s.rubygems_version = %q{1.3.1}
-  s.signing_key = %q{/home/dominikh/.rubyforge/gem-private_key.pem}
-  s.summary = %q{filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.}
+  s.description = "filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size."
+  s.summary = s.description
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.email = "dominikh@fork-bomb.org"
+  s.extra_rdoc_files = ["README.markdown", "CHANGELOG", "lib/filesize.rb"]
+  s.files = ["README.markdown", "CHANGELOG", "lib/filesize.rb", "filesize.gemspec"]
+  s.homepage = "http://filesize.rubyforge.org/"
+  s.required_ruby_version = ">= 1.8.6"
+  s.rubyforge_project = "filesize"
 end

data/lib/filesize.rb

@@ -1,20 +1,26 @@
 class Filesize
+  # Set of rules describing file sizes according to SI units.
   SI     = {:regexp => /^([\d,.]+)?\s?([kmgtpezy]?)b$/i, :multiplier => 1000, :presuffix => ''}
+  # Set of rules describing file sizes according to binary units.
   BINARY = {:regexp => /^([\d,.]+)?\s?(?:([kmgtpezy])i)?b$/i, :multiplier => 1024, :presuffix => 'i'}
+  # Unit prefixes used for file sizes.
   PREFIXES  = %w{k M G T P E Z Y}
 
+  # @param [Number] size A file size, in bytes.
+  # @param [SI, BINARY] type Which type to use for conversions.
   def initialize(size, type = BINARY)
     @bytes = size.to_i
     @type  = type
   end
 
-  # Returns the size in bytes
+  # @return [Number] Returns the size in bytes.
   def to_i
     @bytes
   end
   alias_method :to_int, :to_i
 
-  # Returns the size in the given unit, as a float
+  # @param [String] unit Which unit to convert to.
+  # @return [Float] Returns the size in a given unit.
   def to(unit = 'B')
     to_parts = self.class.parse(unit)
     prefix   = to_parts[:prefix]
@@ -32,13 +38,18 @@ class Filesize
   end
   alias_method :to_f, :to
 
-  # Same as to_f, but as a string, with the unit appended
+  # @param (see #to_f)
+  # @return [String] Same as {#to_f}, but as a string, with the unit appended.
+  # @see #to_f
   def to_s(unit = 'B')
     "%.2f %s" % [to(unit).to_f.to_s, unit]
   end
 
-  # Same as to_s but with an automatic determinition of the most
-  # sensible unit
+  # Same as {#to_s} but with an automatic determination of the most
+  # sensible unit.
+  #
+  # @return [String]
+  # @see #to_s
   def pretty
     size = @bytes
     if size < @type[:multiplier]
@@ -53,18 +64,22 @@ class Filesize
     to_s(unit)
   end
 
+  # @return [Filesize]
   def +(other)
     self.class.new(@bytes + other.to_i, @type)
   end
 
+  # @return [Filesize]
   def -(other)
     self.class.new(@bytes - other.to_i, @type)
   end
 
+  # @return [Filesize]
   def *(other)
     self.class.new(@bytes * other.to_i, @type)
   end
 
+  # @return [Filesize]
   def /(other)
     result = @bytes / other.to_f
     if other.is_a? Filesize
@@ -74,11 +89,19 @@ class Filesize
     end
   end
 
+  # @return [Array<self, other>]
+  # @api private
   def coerce(other)
     return self, other
   end
 
   class << self
+    # Parses a string, which describes a file size, and returns a
+    # Filesize object.
+    #
+    # @param [String] arg A file size to parse.
+    # @raise [ArgumentError] Raised if the file size cannot be parsed properly.
+    # @return [Filesize]
     def from(arg)
       parts  = parse(arg)
       prefix = parts[:prefix]
@@ -92,6 +115,8 @@ class Filesize
       new(size * (type[:multiplier] ** (offset)), type)
     end
 
+    # @return [Hash<:prefix, :size, :type>]
+    # @api private
     def parse(string)
       type = nil
       # in this order, so we prefer binary :)
@@ -103,19 +128,28 @@ class Filesize
       }
 
       prefix = $2 || ''
-      size   = ($1 || "0").gsub(", ", "").to_i
+      size   = ($1 || 0).to_f
 
       return { :prefix => prefix, :size => size, :type => type}
     end
   end
 
+  # The size of a floppy disk
   Floppy = Filesize.from("1474 KiB")
+  # The size of a CD
   CD     = Filesize.from("700 MB")
+  # The size of a common DVD
   DVD_5  = Filesize.from("4.38 GiB")
+  # The same as a DVD 5
   DVD    = DVD_5
+  # The size of a single-sided dual-layer DVD
   DVD_9  = Filesize.from("7.92 GiB")
+  # The size of a double-sided single-layer DVD
   DVD_10 = DVD_5 * 2
-  DVD_14 = Filesize.from("7.92 GiB") + DVD_5
+  # The size of a double-sided DVD, combining a DVD-9 and a DVD-5
+  DVD_14 = DVD_9 + DVD_5
+  # The size of a double-sided dual-layer DVD
   DVD_18 = DVD_14 * 2
+  # The size of a Zip disk
   ZIP    = Filesize.from("100 MB")
 end

metadata

@@ -1,41 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: filesize
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dominik Honnef
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MRIwEAYDVQQDDAlkb21p
-  bmlraG8xEzARBgoJkiaJk/IsZAEZFgNnbXgxEzARBgoJkiaJk/IsZAEZFgNuZXQw
-  HhcNMDkwNzI0MjE1NDQ3WhcNMTAwNzI0MjE1NDQ3WjA+MRIwEAYDVQQDDAlkb21p
-  bmlraG8xEzARBgoJkiaJk/IsZAEZFgNnbXgxEzARBgoJkiaJk/IsZAEZFgNuZXQw
-  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCgfogFNoAcdrR5mK0t5NiN
-  MbWCH2QVLqOvpuaHN6uiaE30R9fT+1CcF97PSboMHMKaQFgiyAcBj8c2uGw5Sk7+
-  Kv9TE2TIIG8l8oslnf9PVqrHSz823IjzbXo4WET4khI2v02pE2wx/souJ4PRgnEr
-  gxQaOF7fqJRT2eYiZAMQye1y9tNSShRoKP3JIlp51KBXUMzGdzq4Mopp32zhEcio
-  yEzcp1PYqu6D1Pr00fS/Alurnp/My5o3oIk0vBfJ6Q8j/6OSk+ck5xev2Z2Y9AUK
-  iwipCxKrAsfOjpPc/Y66okMeTmKxx5N/8h/xNp/HiUApHQwjbYgFOAwmht5UzoPp
-  AgMBAAGjOTA3MAkGA1UdEwQCMAAwHQYDVR0OBBYEFLlluBMEZ3rFvxFcB+ULjUNd
-  V+7WMAsGA1UdDwQEAwIEsDANBgkqhkiG9w0BAQUFAAOCAQEAoDJGicQwBqMnhMkC
-  JY7bgsrIwxoTMQT6B1keUtt9VQ3deywQu0ogawNmee5wy5oFqnMZFcSCXcJE/zIE
-  iuSYU5t87iF09BIsSHWg2OlHAB4+GTUL0PkVsCVBDFukqEiXpNcqMUjTr8U+fe7V
-  oD/qvzyMG1ooAFuTDfPknIQxTcavdnmUmO9Sfw10yXkomX8jjwaGduF/JHDIufub
-  /f4b22rpLBhrOD6dqHCl7WuAfAhpobLqc7sa6Ro8caSUnpq9blOrT/PRtiTXwN6h
-  p3eI3JV0LC6/tMHoeLAbHqauVbWUqDB+AfFw24sgZBqFA+MtMkDpqZ+BKiwiHl+S
-  YEfDWg==
-  -----END CERTIFICATE-----
+cert_chain: []
 
 date: 2009-07-26 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.
-email: dominikho@gmx.net
+email: dominikh@fork-bomb.org
 executables: []
 
 extensions: []
@@ -45,42 +29,43 @@ extra_rdoc_files:
 - CHANGELOG
 - lib/filesize.rb
 files: 
-- Rakefile
 - README.markdown
 - CHANGELOG
 - lib/filesize.rb
-- Manifest
 - filesize.gemspec
 has_rdoc: true
 homepage: http://filesize.rubyforge.org/
+licenses: []
+
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Filesize
-- --main
-- README.markdown
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
       version: 1.8.6
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
-  version: 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: filesize
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.
 test_files: []
 

data.tar.gz.sig

@@ -1,3 +0,0 @@
-��[�f�;k����9��Mb����TF�;�
8i�P���R_������N���S"T�o-A������k;m�D�D'��m{G��OE��G�i��֟��y��^���la����ʘ�4#�
-�RA��ae���5��B� �5��鴄
-`"�v�8G�;�償u�R�ba�#Ĩ$U�k,��4�����-�S�qH��&���q9�"� �.e�, �

data/Manifest

@@ -1,5 +0,0 @@
-Rakefile
-README.markdown
-CHANGELOG
-lib/filesize.rb
-Manifest

data/Rakefile

@@ -1,17 +0,0 @@
-require 'echoe'
-Echoe.new('filesize') do |p|
-  p.author = "Dominik Honnef"
-  p.email  = "dominikho@gmx.net"
-
-  p.description = %q{filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.}
-  p.summary     = %q{filesize is a small class for handling filesizes with both the SI and binary prefixes, allowing conversion from any size to any other size.}
-
-  p.url       = "http://filesize.rubyforge.org/"
-  p.docs_host = "rubyforge.org:/var/www/gforge-projects/"
-
-  p.ruby_version = '>= 1.8.6'
-
-  p.require_signed = true
-
-  p.project = 'filesize'
-end

metadata.gz.sig

@@ -1,3 +0,0 @@
-J>M���y�+}�ɻ��&����<�Ł{�} *�G͘��j�xn���s����K�}�Z��T�Lvt�8�����(j�����y0j�7'���0�v�i�jM�
-�29����
-�a��@8�&P� y��r
+�|FG��cz!_g��µr&L�-�/[pZ~��֜�m������<��0Úͼ5_y�Ғ��/?2YaZҝy�R�&8�K��M�7���7W}�_���������<6�e���g��uu