jenna_time 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3c2f2346a27a8505e941c6b7e0b228dde7b8144
+  data.tar.gz: 8282c541b306470e29d1d3800502d49dc75f190c
+SHA512:
+  metadata.gz: 7181552ea07f88be1399103741e03fc3e8001b457460969f18f0fd61bdbb6694357cca05f23cab04f23b7d97c58608815a6784a7f3b26f32260cf47e5e5c9113
+  data.tar.gz: 2c26f042c7ff11e14d8401281dc1524c1d394fea623e6de1811db6fde2484d0a9aa6c1f7ecc491552dbd05d686cd6999ab7adf73b397af6943cb6f2447cf9d08

data/README.md

@@ -0,0 +1,53 @@
+## About
+
+This gem will display the distance between two Ruby datetime objects in the form of a very short textual description.
+
+## JennaTime Gem
+
+```
+require 'jenna_time'
+include JennaTime
+JennaTime::duration(Time.now()-10)
+# => "10s"
+```
+
+## API
+
+* JennaTime::duration(starttime,endtime) - outputs the time distance in a shorthand format between starttime and endtime
+* JennaTime::duration(endtime) - outputs the time distance in a shorthand format between Time.now() and endtime
+
+## Description
+
+It follows the following rules:
+
+* 0 (no difference)                                                         # => __''__
+* 1 <-> 59 secs                                                             # => __[1-59]s__
+* 60 secs <-> 1 min, 29 secs                                                # => __1m__
+* 1 min, 30 secs <-> 44 mins, 29 secs                                       # => __[2..44]m__
+* 44 mins, 30 secs <-> 89 mins, 29 secs                                     # => __~1h__
+* 89 mins, 30 secs <-> 23 hrs, 59 mins, 29 secs                             # => __~[2..24]h__
+* 23 hrs, 59 mins, 30 secs <-> 41 hrs, 59 mins, 29 secs                     # => __~1d__
+* 41 hrs, 59 mins, 30 secs  <-> 29 days, 23 hrs, 59 mins, 29 secs           # => __[2..29]d__
+* 29 days, 23 hrs, 59 mins, 30 secs <-> 44 days, 23 hrs, 59 mins, 29 secs   # => __1mo__
+* 44 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs   # => __2mo__
+* 59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec                    # => __[2..12]mo__
+* 1 yr <-> 1 yr, 3 months                                                   # => __1y__
+* 1 yr, 3 months <-> 1 yr, 9 months                                         # => __1y__
+* 1 yr, 9 months <-> 2 yr minus 1 sec                                       # => __~2y__
+* 2 yrs <-> max time or date                                                # => __[years]y__
+
+It abbreviates the time so 'less than a minute' becomes '<1m' and 'about 1 year' becomes '~1y'.
+
+If there are less than 60 seconds left then it will display in the format of '36s'.
+
+If starttime is greater than endtime then it will express the time distance in the same way, except there will be a negative sign at the start, e.g. '-30s', '-~1yr'.
+
+## License
+
+The 'Jenna Time' gem is available to everyone under the terms of the MIT open source licence.
+Take a look at the LICENSE file in the code.
+
+Copyright (c) 2016 BBC
+
+
+

data/lib/jenna_time.rb

@@ -0,0 +1,38 @@
+require 'action_view'
+require 'active_support/core_ext/object/acts_like'
+include ActionView::Helpers::DateHelper
+require 'date'
+
+module JennaTime
+  def self.duration(starttime, endtime=Time.now())
+    remaining_seconds = Integer(endtime.to_time - starttime.to_time)
+    if remaining_seconds == 0
+      return ""
+    end
+    if(remaining_seconds <= -1)
+      sign = "-"
+    else
+      sign = ""
+    end
+    if remaining_seconds > -59 and remaining_seconds < 59
+      remaining_seconds.to_s + "s"
+    else
+      wordy_time = ActionView::Helpers::DateHelper.distance_of_time_in_words(starttime, endtime)
+
+      approximation = ""
+      if wordy_time =~ /.*about.*/ or
+         wordy_time =~ /.*almost.*/
+        approximation = "~"
+      end
+
+      wordy_time =~ /(\d+)\s(.)/
+      number = $1
+      unit = $2
+      
+      if wordy_time =~ /.*month.*/
+        unit = "mo"  
+      end
+      "#{approximation}#{sign}#{number}#{unit}"
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: jenna_time
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- BBC
+- Jenna Brown
+- David Craddock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A gem to display the distance between two datetimes in a compact string
+  format
+email:
+- david.craddock@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jenna_time.rb
+homepage: https://github.com/bbc/jenna_time
+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.6.4
+signing_key: 
+specification_version: 4
+summary: Jenna Time Distance Format
+test_files: []