duration-formatter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 362806d4fd1479a215136e54b869b3ef3eac6a11
-  data.tar.gz: 88d3b15b77583f7ed31b10eedd2e620b1503a12d
+  metadata.gz: 719df39ecfaa4879706be6e1c4ab68cdb7a9b7df
+  data.tar.gz: 6212e2a572bc0a72cde231bf1aa6db37a543e19f
 SHA512:
-  metadata.gz: 6abdb35148cd2b78f9c362617ad8adb0e3eec2636523e692d3f74881de61edb54a473b05da6070acaa01755a61304e426bb71230f1773affe9aca4b660f9014a
-  data.tar.gz: a3432217d85e8454b7a5d7b451ba3eef7f058ea20bdb4da1a79b1a159b4f64ddf1a063db675bec408103af8708bafecf46b9a6e12acc5707ab2ea3fc2b2038db
+  metadata.gz: b73e3c5dfa20f653f594dae622379e892dc59638ae928bfa7f80f02f6d2e661113665c70ebbfe1fe07037b4cc34ce96384b77006c7fce5f0a7f67c135fcc9b5b
+  data.tar.gz: 60734ab1ff638952b4f9e62832cc561085b63a1e91aaf6fc74eaeb580d04b45d46f91034dab7f591eb5bed403065510bb3e38bf83ecd5f6171d5f508c1e3245a

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2.1
+
+addons:
+  code_climate:
+    repo_token: 6f0d10c80bdb323106984d5efade7844ddcc1f83439f3c2cb59046e1b643fb50

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    duration-formatter (0.0.1)
-      ruby-duration (>= 3.2)
+    duration-formatter (0.1.1)
+      ruby-duration (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,10 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
+    docile (1.1.5)
     ffi (1.9.10)
     formatador (0.2.5)
     guard (2.12.7)
@@ -46,6 +49,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    rake (10.4.2)
     rb-fsevent (0.9.5)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -54,6 +58,11 @@ GEM
       i18n
       iso8601
     shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     thor (0.19.1)
     thread_safe (0.3.5)
@@ -64,10 +73,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codeclimate-test-reporter (~> 0.4)
   duration-formatter!
   guard (~> 2.12)
   guard-minitest (~> 2.4)
-  rb-fsevent (~> 0.9)
+  rake (~> 10.4)
 
 BUNDLED WITH
    1.10.3

data/README.md

@@ -0,0 +1,56 @@
+#duration-formatter
+
+A simple gem to parse minutes into a readable format using [ruby-duration](https://github.com/peleteiro/ruby-duration).
+
+[![Gem Version](https://badge.fury.io/rb/duration-formatter.svg)](http://badge.fury.io/rb/duration-formatter) [![Code Climate](https://codeclimate.com/github/richardvenneman/duration-formatter/badges/gpa.svg)](https://codeclimate.com/github/richardvenneman/duration-formatter) [![Dependency Status](https://gemnasium.com/richardvenneman/duration-formatter.svg)](https://gemnasium.com/richardvenneman/duration-formatter) [![Test Coverage](https://codeclimate.com/github/richardvenneman/duration-formatter/badges/coverage.svg)](https://codeclimate.com/github/richardvenneman/duration-formatter/coverage) [![Build Status](http://img.shields.io/travis/richardvenneman/duration-formatter.svg)](https://travis-ci.org/richardvenneman/duration-formatter)
+
+## Installation
+
+Add it to your Gemfile with:
+
+```ruby
+gem 'duration-formatter'
+```
+
+Run the `bundle install` in your terminal command to install it.
+
+## Usage
+
+The gem exposes a class `FormattedDuration` which takes the passed minutes to determine the format. Calling `format` on the instance  returns the formatted duration. Examples:
+
+```ruby
+# Full units
+FormattedDuration.new(10080).format # => 1 week
+FormattedDuration.new(1440).format # => 1 day
+FormattedDuration.new(240).format # => 4 hours
+FormattedDuration.new(20).format # => 20 minutes
+
+# Composition
+FormattedDuration.new(15840).format # => 1 week, 4 days
+FormattedDuration.new(1450).format # => 1 day, 10 minutes
+FormattedDuration.new(241).format # => 4 hours, 1 minute
+```
+
+You can also force a constraint upon the format.
+
+```
+FormattedDuration.new(1440, :hours).format # => 24 hours
+FormattedDuration.new(11520, :days).format # => 15 days
+```
+
+## TODO
+
+This gem is a work-in-progress. Planned features:
+
+1. Seconds support
+2. Support “half” units, e.g. 90 minutes becomes 1½ hours
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- Report bugs
+- Fix bugs and submit pull requests
+- Write, clarify, or fix documentation
+- Suggest or add new features
+- Write missing tests

data/duration-formatter.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'ruby-duration', '~> 3.2'
 
+  s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'guard', '~> 2.12'
   s.add_development_dependency 'guard-minitest', '~> 2.4'
-  s.add_development_dependency 'rb-fsevent', '~> 0.9'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
 end

data/lib/duration_formatter/version.rb

@@ -1,3 +1,3 @@
 module DurationFormatter
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/formatted_duration.rb

@@ -1,6 +1,7 @@
 require 'ruby-duration'
 
 class FormattedDuration
+  WEEKS_FORMAT = '%w %~w'
   DAYS_FORMAT = '%d %~d'
   HOURS_FORMAT = '%h %~h'
   MINUTES_FORMAT = '%m %~m'
@@ -9,13 +10,16 @@ class FormattedDuration
     @minutes = minutes % 60
     @hours = minutes / 60
     @days = @hours / 24
+    @weeks = @days / 7
   end
 
   def format
+    weekless_days = @days % 7
     dayless_hours = @hours % 24
     output = []
 
-    output << Duration.new(days: @days).format(DAYS_FORMAT) if @days != 0
+    output << Duration.new(weeks: @weeks).format(WEEKS_FORMAT) if @weeks != 0
+    output << Duration.new(days: weekless_days).format(DAYS_FORMAT) if weekless_days != 0
     output << Duration.new(hours: dayless_hours).format(HOURS_FORMAT) if dayless_hours != 0
     output << Duration.new(minutes: @minutes).format(MINUTES_FORMAT) if @minutes != 0
 

data/test/lib/formatted_duration_test.rb

@@ -1,6 +1,13 @@
 require 'test_helper'
 
 class FormattedDurationTest < Minitest::Test
+  def test_weeks_only_duration
+    text = '1 week'
+    output = FormattedDuration.new(10080).format
+
+    assert_equal text, output
+  end
+
   def test_days_only_duration
     text = '1 day'
     output = FormattedDuration.new(1440).format
@@ -22,6 +29,13 @@ class FormattedDurationTest < Minitest::Test
     assert_equal text, output
   end
 
+  def test_weeks_and_days_duration
+    text = '1 week, 4 days'
+    output = FormattedDuration.new(15840).format
+
+    assert_equal text, output
+  end
+
   def test_days_and_hours_duration
     text = '1 day, 4 hours'
     output = FormattedDuration.new(1680).format

data/test/test_helper.rb

@@ -1,3 +1,10 @@
+# Coverage
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
+
+# Source files
 require './lib/formatted_duration'
+
+# Support
 require 'minitest/autorun'
 require 'minitest/pride'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duration-formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Richard Venneman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-duration
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.4'
 description: |-
   A simple gem to parse minutes into a readable format using
                      ruby-duration.
@@ -74,9 +88,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
+- README.md
 - Rakefile
 - duration-formatter.gemspec
 - lib/duration-formatter.rb