human_bytes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 183acd226d1223244610b305c2acd982a7e67ed3
+  data.tar.gz: 21d1bbd52bda1348a9df0288715ae33f3ed4425d
+SHA512:
+  metadata.gz: 96f5c4fb99eaa98a69f583cebc7880dd80e385929f997d9622607776134bbb186f87a0a4a41a38b75c171f26b69054bcac559d6e7c5441fd398094de42e777d3
+  data.tar.gz: c2c648247c87e915d9a67a295e0195f923f7533f1b11473f3436e4c130467a831c9193a334d32cc6f6133284c02af369e9d9b1adfc7637c5a81a8e475b62d5f3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in human_bytes.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,41 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch('spec/spec_helper.rb')                                               { "spec" }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})                                                   { |m| "spec/#{m[1]}_spec.rb" }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Petr Skocik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# HumanBytes
+
+Convert bytesizes into a human-readable format
+
+Either uses decimal byte prefixes or prefixes based on powers of 2 (Ki, Mi, etc.).
+The functionality is exposed as a:
+
+- module function named `HumanBytes.human_bytes`
+- includable submodule `HumanBytes::MethodVersion` for numeric types
+- simple executable named `human_bytes`
+
+Arbitrary precision arithmetic is used so that even astronomical bytesizes are handled correctly.
+
+## Module function
+    include HumanBytes
+    Humanbytes.human_bytes(1024) #=> '1.00 KiB'
+    human_bytes(1050, places: 10) #=> '1.0253906250 KiB'
+    human_bytes(1050, places: 3, i: false) #=> '1.050 KB'
+
+## Includable submodule
+
+    Numeric.include(HumanBytes::MethodVersion)
+    #Same as: HumanBytes.monkey_patch!(Numeric)
+    1024.human_bytes #=> '1.00 KiB'
+    1050.human_bytes(places: 10) #=> '1.0253906250 KiB'
+    1050.human_bytes(places: 3, i: false) #=> '1.050 KB'
+
+## Executable
+    $ echo 1024 | human_bytes -d #=> 1.00 KiB
+    $ echo 352853503285093280958325083205832| human_bytes #=> 291873576.99 YiB
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'human_bytes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install human_bytes
+
+## Usage
+
+TODO: Improve the executable.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/human_bytes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Copyright © Petr Skočík, 2015 

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "human_bytes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/human_bytes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'human_bytes'
+
+decimal = ARGV.delete('-d')
+places = ARGV[0] ? Integer(ARGV[0]) : nil
+
+STDIN.each do |num_str|
+  puts HumanBytes.human_bytes(Integer(num_str), i: !decimal, places: (places || 2) )
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/human_bytes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'human_bytes'
+
+decimal = ARGV.delete('-d')
+places = ARGV[0] ? Integer(ARGV[0]) : nil
+
+STDIN.each do |num_str|
+  puts HumanBytes.human_bytes(Integer(num_str), i: !decimal, places: (places || 2) )
+end

data/human_bytes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'human_bytes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "human_bytes"
+  spec.version       = HumanBytes::VERSION
+  spec.authors       = ["Petr Skocik"]
+  spec.email         = ["pskocik@gmail.com"]
+
+  spec.summary       = %q{Convert bytesizes into a human-readable format}
+  spec.description   = %q{Either uses decimal byte prefixes or prefixes based on powers of 2 (Ki, Mi, etc.).}
+  spec.homepage      = "https://github.com/pjump/human_bytes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'flt'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec-mocks"
+end

data/lib/human_bytes/version.rb

@@ -0,0 +1,3 @@
+module HumanBytes
+  VERSION = "0.1.0"
+end

data/lib/human_bytes.rb

@@ -0,0 +1,72 @@
+require "human_bytes/version"
+require 'flt'
+
+module HumanBytes
+  UNIT_SETS =  [
+    {
+      B: 1,
+      KiB: 2**10,
+      MiB: 2**20,
+      GiB: 2**30,
+      TiB: 2**40,
+      PiB: 2**50,
+      EiB: 2**60,
+      ZiB: 2**70,
+      YiB: 2**80
+    },
+    {
+      B: 1,
+      KB: 10**3,
+      MB: 10**6,
+      GB: 10**9,
+      TB: 10**12,
+      PB: 10**15,
+      EB: 10**18,
+      ZB: 10**21,
+      YB: 10**24,
+    }
+  ]
+  B = 1
+  UNIT_SETS.each do |prefix_set|
+    prefix_set.each_pair do |prefix,value|
+      self.const_set(prefix,value) unless prefix == :B
+    end
+  end
+
+  ## 
+  # places (Integer): number of places after the decimal point
+  # i (Boolean): use IT prefixes based on powers of 2 rather than 10
+
+  DEFAULTS = { places: 2, i: true }
+  def human_bytes(byte_size, opts={})
+    opts = DEFAULTS.merge(opts)
+    places = opts[:places]
+    i = opts[:i]
+
+    unit_sizes = UNIT_SETS[ i ? 0 : 1]
+
+    last_unit = :B
+    unit_sizes.each_pair do |unit,unit_size|
+      break if byte_size < unit_size
+      last_unit = unit
+    end
+    last_unit_size = unit_sizes[last_unit]
+
+    qty = (Flt::DecNum(byte_size)/(last_unit_size)).round(places: places)
+    "#{qty} #{last_unit}"
+  end
+  module_function :human_bytes
+
+  module MethodVersion
+    def human_bytes(opts={})
+      HumanBytes.human_bytes(self, opts)
+    end
+  end
+
+  def self.monkey_patch!(klass)
+    klass.class_eval do
+      self.include HumanBytes::MethodVersion
+    end
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: human_bytes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Petr Skocik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Either uses decimal byte prefixes or prefixes based on powers of 2 (Ki,
+  Mi, etc.).
+email:
+- pskocik@gmail.com
+executables:
+- human_bytes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/human_bytes
+- bin/setup
+- exe/human_bytes
+- human_bytes.gemspec
+- lib/human_bytes.rb
+- lib/human_bytes/version.rb
+homepage: https://github.com/pjump/human_bytes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Convert bytesizes into a human-readable format
+test_files: []