human_size 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ce0238ef7558590ab59ffbc0f4d2636bf4193c60ca5e8e3b76c7f01f0a2da9d
-  data.tar.gz: 19e40d58ab32edb79771be980c812cc3045d86e9f22ff0136c171975dfb771a1
+  metadata.gz: 11fdc48e4306cd561cf09deda15f67b526acb8adb0deb28d1ffcf58f507fa77e
+  data.tar.gz: f5acea948b763c92736eb551e8de1ac25cd9630bb8cfcc670d55d8270789246e
 SHA512:
-  metadata.gz: 579f788092707a21bc8e97f0942114992bf34ea6e1427b956f4e7a97f54b66e1ce9d1028d33ecfd5f1938f21ba5d34f72fc4b01ba5b5d2316d37e4b02630947c
-  data.tar.gz: 3f6e7898718e7de8c2c7d8089fabd21b640653314f4863b4668fddb4ddc65fae842e8d7260481632135fe1b4298122935a13af419498e91c3c74fecb86986912
+  metadata.gz: f809185a8dbca0ad88a031ab084ccbe67080757cf39b42759fe1c6def90e56d3053924ce0de6fdaa2d26ea147043bbe251cd5ac6fc686f72fff0c6f99f2b92e6
+  data.tar.gz: 36bc70e14dd5f6dfb069f87fd0f778ab08e2ea16b043ccb49c5dbf3fec233a628aed11d722a1ae8d02134b985935d4947bf7df60a16eb18aa7fe6d1ad7ad145b

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## 1.0.0 (January 17, 2019)
+## 1.1.0 (January 24, 2019)
+
+IMPROVEMENTS:
+
+* Move the code inside of a module namespace. ([@TGWolf][])
+* Extend the integer class so that int.human_size works. ([@TGWolf][])
+* Update the documentation. ([@TGWolf][])
+
+## 1.0.0 (January 18, 2019)
 
 * Initial Release ([@TGWolf][])
 

data/README.md

@@ -8,7 +8,7 @@
 
 # Human Size
 
-Stuff
+Convert the number of bytes into a more human readable format.
 
 ## Installation
 
@@ -29,7 +29,13 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+  require 'human_size'
 
+  puts Humansize::Size.human_size(10)
+
+  # or
+
+  puts 10.human_size
 ```
 
 ## Development

data/example/example.rb

@@ -7,10 +7,8 @@ test_value = [-10, 0, 9, 98, 987, 987_6, 987_65, 987_654, 987_654_3, 987_654_32,
 printf "\t%20s | %20s | %20s |\n", 'Original', 'Binary', 'Si'
 printf "\t%20s + %20s + %20s +\n", '-' * 20, '-' * 20, '-' * 20
 
-h = HumanSize.new
-
 test_value.each do |x|
-    printf "\t%20s | %20s | %20s |\n", x, h.human_size(x), h.human_size(x, false)
+    printf "\t%20s | %20s | %20s |\n", x, x.human_size, x.human_size(false)
 end
 
 printf "\t%20s + %20s + %20s +\n", '-' * 20, '-' * 20, '-' * 20

data/lib/human_size/overloads.rb

@@ -0,0 +1,8 @@
+#
+# Overload the integer class
+#
+class Integer
+    def human_size(a_kilobyte_is_1024_bytes = true)
+        HumanSize::Size.human_size(self, a_kilobyte_is_1024_bytes)
+    end
+end

data/lib/human_size/version.rb

@@ -1,3 +1,3 @@
-class HumanSize
-    VERSION = '1.0.0'.freeze
+module HumanSize
+    VERSION = '1.1.0'.freeze
 end

data/lib/human_size.rb

@@ -1,68 +1,43 @@
-require 'human_size/version'
-
-# -------------------------------------------------------------------------------- #
-# Description                                                                      #
-# -------------------------------------------------------------------------------- #
-# Display number of bytes in a more human readable format.                         #
-# -------------------------------------------------------------------------------- #
-
-# -------------------------------------------------------------------------------- #
-# Description                                                                      #
-# -------------------------------------------------------------------------------- #
-# This is a simple global method to short cut the usage of the class below.        #
-# -------------------------------------------------------------------------------- #
-def human_size(bytes, a_kilobyte_is_1024_bytes = true)
-    h = HumanSize.new
-    h.human_size(bytes, a_kilobyte_is_1024_bytes)
-end
-
-# -------------------------------------------------------------------------------- #
-# Description                                                                      #
-# -------------------------------------------------------------------------------- #
-# This is a static access wrapper to the main HumanDuration class below.           #
-# -------------------------------------------------------------------------------- #
-class HumanSizeStatic
-    def self.human_size(bytes, a_kilobyte_is_1024_bytes = true)
-        h = HumanSize.new
-        h.human_size(bytes, a_kilobyte_is_1024_bytes)
-    end
-end
-
-# -------------------------------------------------------------------------------- #
-# Description                                                                      #
-# -------------------------------------------------------------------------------- #
-# This is the main class and the one that does all the real work and is called by  #
-# the static access class and the direct method access above.                      #
-# -------------------------------------------------------------------------------- #
-class HumanSize
-    def human_size(bytes, a_kilobyte_is_1024_bytes = true)
-        suffixes_table = {
-            # Unit prefixes used for SI file sizes.
-            'SI' => ['B', 'KB', 'MB', 'GB', 'TB', 'Pb', 'EB', 'ZB', 'YB'],
-            # Unit prefixes used for binary file sizes.
-            'BINARY' => ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'Pib', 'EiB', 'ZiB', 'YiB']
-        }
-
-        return 'unknown' if bytes < 0
-        return '0.0 B' if bytes.zero?
-
-        units = if a_kilobyte_is_1024_bytes
-                    suffixes_table['BINARY']
-                else
-                    suffixes_table['SI']
-                end
-
-        multiple = if a_kilobyte_is_1024_bytes
-                       1024
-                   else
-                       1000
-                   end
-
-        exp = (Math.log(bytes) / Math.log(multiple)).to_i
-        exp = units.length if exp > units.length
-
-        # rubocop:disable Layout/SpaceAroundOperators
-        format('%<bytes>.1f %<unit>s', bytes: bytes.to_f / multiple ** exp, unit: units[exp])
-        # rubocop:enable Layout/SpaceAroundOperators
+require_relative 'human_size/version'
+require_relative 'human_size/overloads'
+
+#
+# Add docs
+#
+module HumanSize
+    #
+    # Add docs
+    #
+    class Size
+        def self.human_size(bytes, a_kilobyte_is_1024_bytes = true)
+            suffixes_table = {
+                # Unit prefixes used for SI file sizes.
+                'SI' => ['B', 'KB', 'MB', 'GB', 'TB', 'Pb', 'EB', 'ZB', 'YB'],
+                # Unit prefixes used for binary file sizes.
+                'BINARY' => ['B', 'KiB', 'MiB', 'GiB', 'TiB', 'Pib', 'EiB', 'ZiB', 'YiB']
+            }
+
+            return 'unknown' if bytes < 0
+            return '0.0 B' if bytes.zero?
+
+            units = if a_kilobyte_is_1024_bytes
+                        suffixes_table['BINARY']
+                    else
+                        suffixes_table['SI']
+                    end
+
+            multiple = if a_kilobyte_is_1024_bytes
+                           1024
+                       else
+                           1000
+                       end
+
+            exp = (Math.log(bytes) / Math.log(multiple)).to_i
+            exp = units.length if exp > units.length
+
+            # rubocop:disable Layout/SpaceAroundOperators
+            format('%<bytes>.1f %<unit>s', bytes: bytes.to_f / multiple ** exp, unit: units[exp])
+            # rubocop:enable Layout/SpaceAroundOperators
+        end
     end
 end

data/spec/human_size_spec.rb

@@ -7,99 +7,66 @@ RSpec.describe HumanSize do
         expect(HumanSize::VERSION).not_to be nil
     end
 
-    context 'Class method access' do
+    context 'Class Accessor Method' do
         before(:each) do
-            @h = HumanSize.new
+            @hs = HumanSize::Size
         end
 
         context 'Binary (1024 bytes per Megabyte)) mode' do
             it 'says unknown for bytes < 0' do
-                expect(@h.human_size(-1)).to eql('unknown')
+                expect(@hs.human_size(-1)).to eql('unknown')
             end
 
             it 'says 0.0 B for 0 bytes' do
-                expect(@h.human_size(0)).to eql('0.0 B')
+                expect(@hs.human_size(0)).to eql('0.0 B')
             end
 
             it 'says 941.9 MiB for 987654321 bytes' do
-                expect(@h.human_size(987_654_321)).to eql('941.9 MiB')
+                expect(@hs.human_size(987_654_321)).to eql('941.9 MiB')
             end
         end
 
         context 'SI (1000 bytes per Megabyte) mode' do
             it 'says unknown for bytes < 0' do
-                expect(@h.human_size(-1, false)).to eql('unknown')
+                expect(@hs.human_size(-1, false)).to eql('unknown')
             end
 
             it 'says 0.0 B for 0 bytes' do
-                expect(@h.human_size(0, false)).to eql('0.0 B')
+                expect(@hs.human_size(0, false)).to eql('0.0 B')
             end
 
             it 'says 987.7 MB for 987654321 bytes' do
-                expect(@h.human_size(987_654_321, false)).to eql('987.7 MB')
+                expect(@hs.human_size(987_654_321, false)).to eql('987.7 MB')
             end
         end
     end
 
-    context 'Static method access' do
-        before(:each) do
-            @h = HumanSizeStatic
-        end
-
+    context 'String Accessor Method' do
         context 'Binary (1024 bytes per Megabyte)) mode' do
             it 'says unknown for bytes < 0' do
-                expect(@h.human_size(-1)).to eql('unknown')
+                expect(-1.human_size).to eql('unknown')
             end
 
             it 'says 0.0 B for 0 bytes' do
-                expect(@h.human_size(0)).to eql('0.0 B')
+                expect(0.human_size).to eql('0.0 B')
             end
 
             it 'says 941.9 MiB for 987654321 bytes' do
-                expect(@h.human_size(987_654_321)).to eql('941.9 MiB')
+                expect(987_654_321.human_size).to eql('941.9 MiB')
             end
         end
 
         context 'SI (1000 bytes per Megabyte)) mode' do
             it 'says unknown for bytes < 0' do
-                expect(@h.human_size(-1, false)).to eql('unknown')
-            end
-
-            it 'says 0.0 B for 0 bytes' do
-                expect(@h.human_size(0, false)).to eql('0.0 B')
-            end
-
-            it 'says 987.7 MB for 987654321 bytes' do
-                expect(@h.human_size(987_654_321, false)).to eql('987.7 MB')
-            end
-        end
-    end
-
-    context 'Direct method access' do
-        context 'Binary (1024 bytes per Megabyte)) mode' do
-            it 'says unknown for bytes < 0' do
-                expect(human_size(-1)).to eql('unknown')
-            end
-
-            it 'says 0.0 B for 0 bytes' do
-                expect(human_size(0)).to eql('0.0 B')
-            end
-
-            it 'says 941.9 MiB for 987654321 bytes' do
-                expect(human_size(987_654_321)).to eql('941.9 MiB')
-            end
-        end
-        context 'SI (1000 bytes per Megabyte)) mode' do
-            it 'says unknown for bytes < 0' do
-                expect(human_size(-1, false)).to eql('unknown')
+                expect(-1.human_size(false)).to eql('unknown')
             end
 
             it 'says 0.0 B for 0 bytes' do
-                expect(human_size(0, false)).to eql('0.0 B')
+                expect(0.human_size(false)).to eql('0.0 B')
             end
 
             it 'says 987.7 MB for 987654321 bytes' do
-                expect(human_size(987_654_321, false)).to eql('987.7 MB')
+                expect(987_654_321.human_size(false)).to eql('987.7 MB')
             end
         end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_size
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - example/example.rb
 - human_size.gemspec
 - lib/human_size.rb
+- lib/human_size/overloads.rb
 - lib/human_size/version.rb
 - spec/human_size_spec.rb
 - spec/spec_helper.rb