bytesize 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aa26ab3dee5c630d19eda1edc877cc12d251ed719347b1af722cbb8b66d387b
-  data.tar.gz: 2a5f2ff76d9e7c1bf2dbcca25cec46cf77b642f4e3c4ea4e7189bd520f7a8aa9
+  metadata.gz: 3a1ec6caf50e4b92ce400618733fce6e0c63337decb18851bf2adcb613d31088
+  data.tar.gz: 8793a89bdcd3571a44871619adf2cd78b059a564cb21546eee3b2932131b23ab
 SHA512:
-  metadata.gz: '0096603896d44f87d44c048c6b8da3b89469103f73e0336ce113f4f2025cf7664ec986706ce8129bb89b454d70c959bf6d2190be11a7ee6c8d4f60a092caf221'
-  data.tar.gz: 9b8a3fdf9331eff6158efa41b40bab085a3ebc0968309a1d8e25d2e867a0bd629d73f6c24fd87f7f4159fe367231044a0d9d77f8b166672c9b77cd175423619f
+  metadata.gz: 02fcb8ef3c111c7100c5c66e29aed886b4785fd0cb504ce07d319e828716280b0e61476959fc8a99c031fb4712e29d77079a1b2efc33572ecce92272a16fbf0a
+  data.tar.gz: a5778c3b14f6a8e4c3cc72b42b67329bfc6c225a7738891c6cc9fd2fdceee14b2b0f10baed9568a5643f0c9f1fe3ae66b1d9a53231e273db7d267808de5c9c8a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bytesize.gemspec
+gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2018 Adam Hunt
+Copyright © 2018-2021 Adam Hunt
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bytesize.gemspec

@@ -0,0 +1,56 @@
+
+#!/usr/bin/env ruby -w
+# -*- encoding: utf-8 -*-
+#
+# ByteSize
+#
+# bytesize.gemspec
+#
+# © 2018-2021 Adam Hunt
+# Created: 2018-03-24
+# Modified: 2021-05-13
+#
+
+
+
+require 'pathname'
+require 'fileutils'
+
+
+
+gem_root = Pathname.new(__dir__).expand_path
+lib = (gem_root + 'lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib.to_s)
+
+require_relative 'lib/bytesize/version'
+
+
+
+Gem::Specification.new do |gem|
+	gem.name          = 'bytesize'
+	gem.version       = ByteSize::VERSION
+	gem.summary       = 'A simple Ruby object that stores a size in bytes, while providing human-readible string output.'
+	gem.description   = 'ByteSize is a simple Ruby object that stores a size in bytes, while providing human-readible string output with apropriate SI or IEC suffixes. Ample convenience methods are also supplied for quick shorthand.'
+	gem.author        = 'Adam Hunt'
+	gem.email         = 'bytesize@adamhunt.com'
+	gem.homepage      = 'http://github.com/ajmihunt/bytesize'
+	gem.license       = 'MIT'
+	
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	gem.files = Dir.chdir(gem_root) do
+		`git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
+	end
+
+	gem.executables   = []
+	gem.require_paths = ['lib']
+	gem.test_files    = Dir.glob('{test,spec,features}/**/*')
+
+	gem.required_ruby_version = '>= 2.1.0'
+
+	gem.add_development_dependency 'bundler', '>= 2.1.0'
+	gem.add_development_dependency 'rake',    '>= 12.3.3'
+	gem.add_development_dependency 'rspec',   '>= 3.10.0'
+end
+
+

data/lib/bytesize.rb

@@ -6,7 +6,7 @@
 #
 # © 2018 Adam Hunt
 # Created: 2018-01-17
-# Modified: 2018-04-08
+# Modified: 2018-04-09
 #
 
 
@@ -73,7 +73,6 @@ class ByteSize
 	# :stopdoc:
 	SI_BASE = 1000
 	SI_ORDERS_OF_MAGNITUDE = {
-		bytes: 1,
 		kB:	SI_BASE,
 		MB:	SI_BASE**2,
 		GB:	SI_BASE**3,
@@ -82,11 +81,11 @@ class ByteSize
 		EB:	SI_BASE**6,
 		ZB:	SI_BASE**7,
 		YB:	SI_BASE**8
-		}.freeze
+		}
+	SI_UNIT_SYMBOLS = SI_ORDERS_OF_MAGNITUDE.keys.freeze
 	
 	IEC_BASE = 1024
 	IEC_ORDERS_OF_MAGNITUDE = {
-		bytes: 1,
 		KiB:   IEC_BASE,
 		MiB:   IEC_BASE**2,
 		GiB:   IEC_BASE**3,
@@ -95,26 +94,41 @@ class ByteSize
 		EiB:   IEC_BASE**6,
 		ZiB:   IEC_BASE**7,
 		YiB:   IEC_BASE**8
-		}.freeze
-	
-	UNIT_SYMBOLS = SI_ORDERS_OF_MAGNITUDE.merge(IEC_ORDERS_OF_MAGNITUDE)
-	UNIT_SYMBOLS.delete(:bytes)
-	UNIT_SYMBOLS.freeze
+		}
+	IEC_UNIT_SYMBOLS = IEC_ORDERS_OF_MAGNITUDE.keys.freeze
+
+	ALL_ORDERS_OF_MAGNITUDE = SI_ORDERS_OF_MAGNITUDE.merge(IEC_ORDERS_OF_MAGNITUDE).freeze
+
+	# Must be after ALL_ORDERS_OF_MAGNITUDE
+	SI_ORDERS_OF_MAGNITUDE[:bytes] = 1
+	SI_ORDERS_OF_MAGNITUDE.freeze
+
+	IEC_ORDERS_OF_MAGNITUDE[:bytes] = 1
+	IEC_ORDERS_OF_MAGNITUDE.freeze
+	# :startdoc:
+
+
+
+	ALL_UNIT_SYMBOLS = ALL_ORDERS_OF_MAGNITUDE.keys.freeze
 	
+
+
+	BASE                = SI_BASE
+	UNIT_SYMBOLS        = SI_UNIT_SYMBOLS
 	ORDERS_OF_MAGNITUDE = SI_ORDERS_OF_MAGNITUDE
-	# :startdoc:
 	
 	
 	
 	# :stopdoc:
 	# Creates convenience methods for all unit symbols
-	UNIT_SYMBOLS.each do |k,v|
-		define_singleton_method(k.downcase) do |n|
-			raise( TypeError, "expected #{Numeric}, got #{n.class}" ) unless n.is_a?(Numeric)
-			self.new( (n*v).round )
+	ALL_ORDERS_OF_MAGNITUDE.each do |s,om|
+		m = s.downcase
+		define_singleton_method(m) do |val|
+			raise( TypeError, "expected #{Numeric}, got #{val.class}" ) unless val.is_a?(Numeric)
+			self.new(( val * om ).round)
 		end
-		define_method(:"to_#{k.downcase}") do
-			bytes / Float(v)
+		define_method(:"to_#{m}") do
+			bytes / Float(om)
 		end
 	end
 	# :startdoc:
@@ -123,8 +137,8 @@ class ByteSize
 	
 	# :stopdoc:
 	BYTES_REGEX = /\A\s*(\-?[0-9]+)\s*(bytes)?\s*\z/.freeze
-	SI_REGEX = /\A\s*(\-?[0-9]+(\.[0-9]+)?)\s*(#{ SI_ORDERS_OF_MAGNITUDE.keys.reject{|k| k == :bytes }.join('|') })\s*\z/i.freeze
-	IEC_REGEX = /\A\s*(\-?[0-9]+(\.[0-9]+)?)\s*(#{ IEC_ORDERS_OF_MAGNITUDE.keys.reject{|k| k == :bytes }.join('|') })\s*\z/i.freeze
+	SI_REGEX    = /\A\s*(\-?[0-9]+(\.[0-9]+)?)\s*(#{ SI_UNIT_SYMBOLS.join('|') })\s*\z/i.freeze
+	IEC_REGEX   = /\A\s*(\-?[0-9]+(\.[0-9]+)?)\s*(#{ IEC_UNIT_SYMBOLS.join('|') })\s*\z/i.freeze
 	# :startdoc:
 	
 	
@@ -310,8 +324,7 @@ class ByteSize
 	# {ByteSize}[ByteSize.html] or {IECByteSize}[IECByteSize.html] depending on it's unit symbol.
 	#
 	def self.parse( val )
-		case val
-			when String
+		if val.is_a?(String)
 			if m = val.match(BYTES_REGEX)
 				ByteSize.new( m[1].to_i )
 			elsif m = val.match(SI_REGEX)
@@ -322,7 +335,7 @@ class ByteSize
 				raise( ArgumentError, "invalid #{ByteSize} or #{IECByteSize} string: #{val.inspect}" )
 			end
 		else
-			raise( TypeError, "expected #{String}, got #{str.class}" )
+			raise( TypeError, "expected #{String}, got #{val.class}" )
 		end
 	end
 	
@@ -330,32 +343,27 @@ class ByteSize
 	
 	# :stopdoc:
 	def self.new( val )
-		if val.class == self
-			super( val.bytes )
-		else
-			case val
-				
-				when Integer
-				super( val )
-				
-				when ByteSize
-				super( val.bytes )
-				
-				when String
-				if m = val.match(BYTES_REGEX)
-					super( m[1].to_i )
-				elsif m = val.match(SI_REGEX)
-					self.send( m[3].downcase.to_sym, m[2].nil? ? m[1].to_i : m[1].to_f )
-				elsif m = val.match(IEC_REGEX)
-					self.send( m[3].downcase.to_sym, m[2].nil? ? m[1].to_i : m[1].to_f )
-				else
-					raise( ArgumentError, "invalid #{self} string: #{val.inspect}" )
-				end
+		case val
 				
+			when ByteSize
+			super( val.bytes )
+			
+			when Integer
+			super( val )
+			
+			when String
+			if m = val.match(BYTES_REGEX)
+				super( m[1].to_i )
+			elsif m = val.match(SI_REGEX)
+				self.send( m[3].downcase.to_sym, m[2].nil? ? m[1].to_i : m[1].to_f )
+			elsif m = val.match(IEC_REGEX)
+				self.send( m[3].downcase.to_sym, m[2].nil? ? m[1].to_i : m[1].to_f )
 			else
-				raise( TypeError, "no implicit conversion of #{val.class} into #{self}" )
-				
+				raise( ArgumentError, "invalid #{self} string: #{val.inspect}" )
 			end
+			
+		else
+			raise( TypeError, "no implicit conversion of #{val.class} into #{self}" )	
 		end
 	end
 	# :startdoc:
@@ -371,9 +379,7 @@ class ByteSize
 	# or {String}[https://ruby-doc.org/core/String.html].
 	#
 	def initialize( bytes )
-		raise( TypeError, "expected #{Integer}, got #{bytes.class}" ) unless bytes.is_a?(Integer)
 		@bytes = bytes
-		freeze
 	end
 	
 	
@@ -547,12 +553,12 @@ class ByteSize
 	def <( other )
 		case other
 			
-			when Numeric
-			bytes < other
-			
 			when ByteSize
 			bytes < other.bytes
 			
+			when Numeric
+			bytes < other
+			
 		else 
 			raise( ArgumentError, "comparison of #{self.class} with #{other.inspect} failed" )
 		end
@@ -569,12 +575,12 @@ class ByteSize
 	def <=( other )
 		case other
 			
-			when Numeric
-			bytes <= other
-			
 			when ByteSize
 			bytes <= other.bytes
 			
+			when Numeric
+			bytes <= other
+			
 		else 
 			raise( ArgumentError, "comparison of #{self.class} with #{other.inspect} failed" )
 		end
@@ -591,12 +597,12 @@ class ByteSize
 	def >( other )
 		case other
 			
-			when Numeric
-			bytes > other
-			
 			when ByteSize
 			bytes > other.bytes
 			
+			when Numeric
+			bytes > other
+			
 		else 
 			raise( ArgumentError, "comparison of #{self.class} with #{other.inspect} failed" )
 		end
@@ -613,12 +619,12 @@ class ByteSize
 	def >=( other )
 		case other
 			
-			when Numeric
-			bytes >= other
-			
 			when ByteSize
 			bytes >= other.bytes
 			
+			when Numeric
+			bytes >= other
+			
 		else 
 			raise( ArgumentError, "comparison of #{self.class} with #{other.inspect} failed" )
 		end
@@ -1099,6 +1105,8 @@ end
 class IECByteSize < ByteSize
 	
 	# :stopdoc:
+	BASE                = IEC_BASE
+	UNIT_SYMBOLS        = IEC_UNIT_SYMBOLS
 	ORDERS_OF_MAGNITUDE = IEC_ORDERS_OF_MAGNITUDE
 	# :startdoc:
 	

data/lib/bytesize/units.rb

@@ -6,7 +6,7 @@
 #
 # © 2018 Adam Hunt
 # Created: 2018-01-18
-# Modified: 2018-01-18
+# Modified: 2018-04-08
 #
 
 
@@ -32,7 +32,9 @@ require 'bytesize'
 #
 #   42.gib.to_mib  #=> 43008.0
 #   
-#   22.gib.to_si   #=> 
+#   22.gib.to_si   #=> (23.62 GB)
+#   
+#   16.gb.to_iec   #=> (14.9 GiB)
 #
 class Numeric
 	
@@ -40,14 +42,16 @@ class Numeric
 	
 	# :stopdoc:
 	ByteSize::SI_ORDERS_OF_MAGNITUDE.keys.each do |k|
-		define_method(k.downcase) do
-			ByteSize.send( k.downcase, self )
+		m = k.downcase
+		define_method(m) do
+			ByteSize.send( m, self )
 		end
 	end
 	
 	IECByteSize::UNIT_SYMBOLS.keys.reject{|k| k == :bytes }.each do |k|
-		define_method(k.downcase) do
-			IECByteSize.send( k.downcase, self )
+		m = k.downcase
+		define_method(m) do
+			IECByteSize.send( m, self )
 		end
 	end
 	# :startdoc:

data/lib/bytesize/version.rb

@@ -12,7 +12,7 @@
 
 
 class ByteSize
-	VERSION = "0.1.0".freeze
+	VERSION = '0.1.1'.freeze
 end
 
 

metadata

@@ -1,81 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: bytesize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Hunt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 description: ByteSize is a simple Ruby object that stores a size in bytes, while providing
   human-readible string output with apropriate SI or IEC suffixes. Ample convenience
   methods are also supplied for quick shorthand.
-email: bytesize@adamhunt.name
+email: bytesize@adamhunt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
+- Rakefile
+- bytesize.gemspec
+- lib/.DS_Store
 - lib/bytesize.rb
 - lib/bytesize/activerecord.rb
 - lib/bytesize/units.rb
 - lib/bytesize/version.rb
-- spec/bytesize_spec.rb
-- spec/iecbytesize_spec.rb
-- spec/shared_examples.rb
-- spec/test_enum.rb
-- spec/value_class_helper.rb
 homepage: http://github.com/ajmihunt/bytesize
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,15 +91,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.9
+signing_key:
 specification_version: 4
 summary: A simple Ruby object that stores a size in bytes, while providing human-readible
-  string output
-test_files:
-- spec/test_enum.rb
-- spec/value_class_helper.rb
-- spec/shared_examples.rb
-- spec/bytesize_spec.rb
-- spec/iecbytesize_spec.rb
+  string output.
+test_files: []