human_duration 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fcb063f0ad7d76dc1d62a289263fdbd25e236e4f589a25490947735333264d
-  data.tar.gz: ee2ca9c18f07f7ccc27dd495471c5eac486781103f785652144db5dfe77e1cd4
+  metadata.gz: 102134bea90036b011d22347bc8f8470f4b4dd15772fd9b9cde82e99e2592245
+  data.tar.gz: 667534f6929deba4722e44a773f7420ea8eab1b35f02df893cac4b2b7e70952b
 SHA512:
-  metadata.gz: 0f3f5225dc736788e4489fddceed77e404f0545ed560a28dec47a6d6c6db95e966a7b5fb2da999647275d145066c964903d197720a63a6be62bebe8d0da9f179
-  data.tar.gz: a046d4634d2701080a08a61122b9cc3bcb32ca128f74fc38c26f95ce09f88058544fee18cb05e4b31b9ea5a1c091589cb149bdc11c62dfdb585baf4bdf449ecc
+  metadata.gz: d79a19c23c24ae488e85a95a4d25303894e945575173f04fc1d754a5847aea58e96475bd36de0ba629a358367e1308aec8672a514ff17b686e539b3abdd6eda8
+  data.tar.gz: dee5232b143c5a3a6d24a0c764a3d9374e40cd0d1d0433ff88117804bb0e2ae5862f090c345bf02d553ee8c0d05bbc5ade3acd44ae96027a7c5421458c280574

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.1  (January 17, 2019)
+
+CHANGES:
+
+* Added a new direct access method so that you can call humanize directly. ([@TGWolf][])
+* Updated the example.rb to show the new method in actions. ([@TGWolf][])
+* Updated the docs to detail this new access method. ([@TGWolf][])
+
 ## 1.0.0 (January 17, 2019)
 
 * Initial Release ([@TGWolf][])

data/README.md

@@ -1,13 +1,14 @@
 [![Build Status](https://img.shields.io/travis/WolfSoftware/human_duration/master.svg)](https://travis-ci.org/WolfSoftware/human_duration)
 [![Software License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)
 [![Release](https://img.shields.io/github/release/wolfsoftware/human_duration.svg)](https://github.com/wolfsoftware/human_duration/releases/latest)
+[![Gem Version](https://badge.fury.io/rb/human_duration.svg)](https://badge.fury.io/rb/human_duration)
 [![Github commits (since latest release)](https://img.shields.io/github/commits-since/wolfsoftware/human_duration/latest.svg)](https://github.com/wolfsoftware/human_duration/commits)
 [![GitHub repo size in bytes](https://img.shields.io/github/repo-size/wolfsoftware/human_duration.svg)](https://github.com/wolfsoftware/human_duration)
 [![GitHub contributors](https://img.shields.io/github/contributors/wolfsoftware/human_duration.svg)](https://github.com/wolfsoftware/human_duration)
 
 # HumanDuration
 
-Human Durartion is a simple ruby gem to convert a number of seconds into a more human readable version.
+Human Durartion is a simple ruby gem to convert a number of seconds into a more human readable form.
 
 ## Installation
 
@@ -27,6 +28,14 @@ Or install it yourself as:
 
 ## Usage
 
+The main function that needs to be called is the 'humanize' function but there are 3 different ways to do this (as show in the code snippet below)
+
+* Class method access - `hd = HumanDuration.new` followed by `hd.humanize(x)` 
+* Static method access - `HumanDurationStatic.humanize(x)`
+* Direct method access - `humanize(x)`
+
+The first method is the main/original method for accessing this function, the other 2 are simple wrappers to the first.
+
 ```ruby
 #!/usr/bin/env ruby
 
@@ -47,6 +56,14 @@ puts 'Config: default'
 test_value.each do |x|
     puts HumanDurationStatic.humanize(x)
 end
+
+puts 'Direct method access'
+
+puts 'Config: default'
+test_value.each do |x|
+    puts humanize(x)
+end
+
 ```
 
 It is possible to configure the output using one of the options 'compact', 'small' and 'full', 'compact' isthe default. For more detailed example please refer to [example/example.rb](https://github.com/WolfSoftware/human_duration/blob/master/example/example.rb)

data/example/example.rb

@@ -39,3 +39,20 @@ puts "\tConfig: type = full"
 test_value.each do |x|
     printf "\t\t%s\n", HumanDurationStatic.humanize(x)
 end
+
+puts 'Direct method access'
+
+printf "\tConfig: type = conpact [default]\n"
+test_value.each do |x|
+    printf "\t\t%s\n", humanize(x)
+end
+
+printf "\tConfig: type = short\n"
+test_value.each do |x|
+    printf "\t\t%s\n", humanize(x)
+end
+
+puts "\tConfig: type = full"
+test_value.each do |x|
+    printf "\t\t%s\n", humanize(x)
+end

data/human_duration.gemspec

@@ -8,16 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tim Gurney aka Wolf"]
   spec.email         = ["wolf@tgwolf.com"]
 
-  spec.summary       = %q{Display elapsed time in a more human readable way.}
-  spec.description   = %q{Display elapsed time in a more human readable way.}
+  spec.summary       = %q{Human Durartion is a simple ruby gem to convert a number of seconds into a more human readable form.}
+  spec.description   = %q{Human Durartion is a simple ruby gem to convert a number of seconds into a more human readable form.}
   spec.homepage      = "https://github.com/WolfSoftware/human_duration"
   spec.license       = "MIT"
 
  spec.files         = `git ls-files`.split($/)
-# spec.files = Dir['lib/**/*.rb']
-#  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-#    f.match(%r{^(test|spec|features)/})
-#  end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/lib/human_duration/version.rb

@@ -1,3 +1,3 @@
 class HumanDuration
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
 end

data/lib/human_duration.rb

@@ -1,6 +1,26 @@
 require 'human_duration/version'
 
-# Doc here
+# -------------------------------------------------------------------------------- #
+# Description                                                                      #
+# -------------------------------------------------------------------------------- #
+# Display elapsed time in a more human readable way.                               #
+# -------------------------------------------------------------------------------- #
+
+# -------------------------------------------------------------------------------- #
+# Description                                                                      #
+# -------------------------------------------------------------------------------- #
+# This is a simple global method to short cut the usage of the class below.        #
+# -------------------------------------------------------------------------------- #
+def humanize(seconds, config = { 'type' => 'compact' })
+    hd = HumanDuration.new(config)
+    hd.humanize(seconds)
+end
+
+# -------------------------------------------------------------------------------- #
+# Description                                                                      #
+# -------------------------------------------------------------------------------- #
+# This is a static access wrapper to the main HumanDuration class below.           #
+# -------------------------------------------------------------------------------- #
 class HumanDurationStatic
     def self.humanize(seconds, config = { 'type' => 'compact' })
         hd = HumanDuration.new(config)
@@ -8,7 +28,12 @@ class HumanDurationStatic
     end
 end
 
-# Doc here
+# -------------------------------------------------------------------------------- #
+# 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 HumanDuration
     def initialize(config = { 'type' => 'compact' })
         @config = config

data/spec/human_duration_spec.rb

@@ -238,6 +238,110 @@ RSpec.describe HumanDuration do
             end
         end
     end
+
+    context 'Direct method access' do
+        context 'Using default compact mode' do
+            it 'says negative for seconds < 0 (Negative value test)' do
+                expect(humanize(-1)).to eql('negative')
+            end
+
+            it 'says now for 0 seconds (Zero second test)' do
+                expect(humanize(0)).to eql('now')
+            end
+
+            it 'says \'1 second\' for 1 second (Singular test)' do
+                expect(humanize(1)).to eql('1 second')
+            end
+
+            it 'says \'10 seconds\' for 10 second (Plural test)' do
+                expect(humanize(10)).to eql('10 seconds')
+            end
+
+            it 'says \'1 minute\' for 60 seconds' do
+                expect(humanize(60)).to eql('1 minute')
+            end
+
+            it 'says \'1 hour\' for 3600 seconds' do
+                expect(humanize(360_0)).to eql('1 hour')
+            end
+
+            it 'says \'1 year\' for 31536000 seconds' do
+                expect(humanize(315_360_00)).to eql('1 year')
+            end
+
+            it 'says \'1 year, 2 hours and 13 seconds\' for 31543213 seconds' do
+                expect(humanize(315_432_13)).to eql('1 year, 2 hours and 13 seconds')
+            end
+        end
+
+        context 'Using short mode' do
+            it 'says negative for seconds < 0 (Negative value test)' do
+                expect(humanize(-1, 'type' => 'short')).to eql('negative')
+            end
+
+            it 'says now for 0 seconds (Zero second test)' do
+                expect(humanize(0, 'type' => 'short')).to eql('now')
+            end
+
+            it 'says \'1 s\' for 1 second (Singular test)' do
+                expect(humanize(1, 'type' => 'short')).to eql('1 s')
+            end
+
+            it 'says \'10 s\' for 10 second (Plural test)' do
+                expect(humanize(10, 'type' => 'short')).to eql('10 s')
+            end
+
+            it 'says \'1 m\' for 60 seconds' do
+                expect(humanize(60, 'type' => 'short')).to eql('1 m')
+            end
+
+            it 'says \'1 h\' for 3600 seconds' do
+                expect(humanize(360_0, 'type' => 'short')).to eql('1 h')
+            end
+
+            it 'says \'1 y\' for 31536000 seconds' do
+                expect(humanize(315_360_00, 'type' => 'short')).to eql('1 y')
+            end
+
+            it 'says \'1 y, 2 h & 13 s\' for 31543213 seconds' do
+                expect(humanize(315_432_13, 'type' => 'short')).to eql('1 y, 2 h & 13 s')
+            end
+        end
+
+        context 'Using full mode' do
+            it 'says negative for seconds < 0 (Negative value test)' do
+                expect(humanize(-1, 'type' => 'full')).to eql('negative')
+            end
+
+            it 'says now for 0 seconds (Zero second test)' do
+                expect(humanize(0, 'type' => 'full')).to eql('now')
+            end
+
+            it 'says \'0 years, 0 days, 0 hours, 0 minutes and 1 second\' for 1 second (Singular test)' do
+                expect(humanize(1, 'type' => 'full')).to eql('0 years, 0 days, 0 hours, 0 minutes and 1 second')
+            end
+
+            it 'says \'0 years, 0 days, 0 hours, 0 minutes and 10 seconds\' for 10 second (Plural test)' do
+                expect(humanize(10, 'type' => 'full')).to eql('0 years, 0 days, 0 hours, 0 minutes and 10 seconds')
+            end
+
+            it 'says \'0 years, 0 days, 0 hours, 1 minute and 0 seconds\' for 60 seconds' do
+                expect(humanize(60, 'type' => 'full')).to eql('0 years, 0 days, 0 hours, 1 minute and 0 seconds')
+            end
+
+            it 'says \'0 years, 0 days, 1 hour, 0 minutes and 0 seconds\' for 3600 seconds' do
+                expect(humanize(360_0, 'type' => 'full')).to eql('0 years, 0 days, 1 hour, 0 minutes and 0 seconds')
+            end
+
+            it 'says \'1 year, 0 days, 0 hours, 0 minutes and 0 seconds\' for 31536000 seconds' do
+                expect(humanize(315_360_00, 'type' => 'full')).to eql('1 year, 0 days, 0 hours, 0 minutes and 0 seconds')
+            end
+
+            it 'says \'1 year, 0 days, 2 hours, 0 minutes and 13 seconds\' for 31543213 seconds' do
+                expect(humanize(315_432_13, 'type' => 'full')).to eql('1 year, 0 days, 2 hours, 0 minutes and 13 seconds')
+            end
+        end
+    end
 end
 
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human_duration
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
@@ -52,7 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Display elapsed time in a more human readable way.
+description: Human Durartion is a simple ruby gem to convert a number of seconds into
+  a more human readable form.
 email:
 - wolf@tgwolf.com
 executables: []
@@ -67,7 +68,6 @@ files:
 - CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -101,5 +101,6 @@ requirements: []
 rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
-summary: Display elapsed time in a more human readable way.
+summary: Human Durartion is a simple ruby gem to convert a number of seconds into
+  a more human readable form.
 test_files: []

data/Gemfile.lock

@@ -1,35 +0,0 @@
-PATH
-  remote: .
-  specs:
-    human_duration (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  human_duration!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.1