anthroposi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5e2b2e1ded0d6a09c10ba2c612bf5ff959d80b1
-  data.tar.gz: 6bd849dec61e7a3de70946cf93e97e1892c8a15c
+  metadata.gz: b1b38ce6b0cf22e52a24680787a12c2fc2560a4a
+  data.tar.gz: 6a0a14d67a090f9b86d29c15c985f1c97479c6e5
 SHA512:
-  metadata.gz: de7de9b15bbc33248e8efb690ce081601a308f91b30e2a0b49fcbc040312b5315dafe89ed70c046c29af48212e76002c1ff6eadc402beda46bae7ac0a87fad46
-  data.tar.gz: 02abcb2a2a355ffb265bc537b2d5b77807a60b319b01d6c660b75c225a57ad493a288a9f2d661e0231d82e78de636c2607942863693dfe5275f356bbca6c0d73
+  metadata.gz: d6f1788445d7716b94241efb6d6a2e3a7dd12a74cb52dddbfa92a19dadd55ed91fe64cc5c9533ddd2bdab276944f951fd4c5dbdcbf51461e724cd6772ce3acb1
+  data.tar.gz: 7b7300da48cc8842a73ea43987c3fed5deb79186847fcd341da19676514e1da902dbbafc34d5d7d36e5fb06dfa54e34c9e0c0d0f25248a7582ab2c741ab77b11

data/lib/anthroposi.rb

@@ -1,3 +1,4 @@
+# A class container for various constants and methods to convert numbers into string with SI prefixes
 class Anthroposi
   SI_PREFIXES = %w(K M G T P E Z Y).freeze
   BINARY_UNITS = ['B'] + SI_PREFIXES.map { |p| "#{p}iB" }
@@ -6,6 +7,9 @@ class Anthroposi
   SIGNIFICANT_DIGITS = 3
   LARGEST_THRESHOLD = 9999
 
+  # @param bytes [Number]
+  # @param decimal[Boolean] optional
+  # @raise ArgumentError if string or number less than 1 is passed in as bytes
   def initialize(bytes, decimal = false)
     raise(ArgumentError, 'no string or fractional number') if bytes > 0 && bytes < 1
     @bytes = bytes
@@ -14,6 +18,9 @@ class Anthroposi
     @unit = compute
   end
 
+  # @return [String]
+  # @example
+  #   Anthroposi.new(314159).to_s #=> "314KiB"
   def to_s
     format @mantissa > LARGEST_THRESHOLD ? '%.2e%s' : '%s%s', @mantissa, @unit
   end
@@ -48,15 +55,30 @@ class Anthroposi
   end
 end
 
+# helper method to compute a number to a given number of significant digits
+# @param number [Numeric]
+# @param digits [Integer] number of significant digits desired
+# @return [Numeric]
+# @example
+#   significant_digits(116_067, 2) #=> 120000
 def significant_digits(number, digits)
   return 0 if number.zero? || digits.zero?
   number.to_f.round(digits - 1 - Math.log10(number.abs).floor)
 end
 
+# wrapper function around Anthroposi class
+# @param b [Integer] bytes
+# @return [String] such as 3.14MiB, 234EiB
+# @example
+#   human_size(1024) #=> "1.0KiB"
 def human_size(b)
   Anthroposi.new(b).to_s
 end
 
-def human_decimal_size(b)
-  Anthroposi.new(b, true).to_s
+# @param n [Numeric] number
+# @return [String] such as 3.14M, 234E
+# @example
+#   human_decimal_size(1000) #=> "1.0M"
+def human_decimal_size(n)
+  Anthroposi.new(n, true).to_s
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anthroposi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - k z win
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: rubygems@happyw.info