moments 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b85363c9163c9935f75833c74b4e7d587cc70d962ca4f86e14e6d8a3bb14196
-  data.tar.gz: 1a6421e682139a2cefb0b82d12bcd5d08cb2f8220ab20a65f9646938e0ee1653
+  metadata.gz: 77dbf9115233ea35f1e79c6592da59fde4ec415e7b7a74400a9789a407cd3bdf
+  data.tar.gz: fae4d1e2330151cfc27cb64d63bc10a9d5123e0dd6005a6dfebaa4b77038fd32
 SHA512:
-  metadata.gz: 360367e75466166fc7bb786fa4d0247b23d7ba61b118286bc137c7b697ef25a12bf3d847f0b2907de9a899ee1d3132298b5196ef93387b536e800fca8132c24a
-  data.tar.gz: e374f88fd8029894bdeee1e0ea79ae58188552fe43438dfb56e37335a36121b91c6b14e0d8b7a814ff0901c10c9928916051f1ea38a1b28997bce3ff47f932a9
+  metadata.gz: b4e344eafc3286656abb581eef7cffdc21278b58a7b24c62e7e5e3d64bbb28f213e7fd1eb7e518bc10887336deecb6cf63a3ab4754a7712bedf667f68714530a
+  data.tar.gz: 6c0d50f01f547d3a6b219e5f2d2c34cd2ad277f6a4ec17016fc047280f740e9123c00e60a0ae0f06a503d84e78edae22b709d0d0167345a97e801bbed5536fcc

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   Exclude:
     - 'gemfiles/*.gemfile'
     - 'vendor/**/*'
+    - 'spec/**/*'
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,8 +1,25 @@
 # Changelog
 
-## [Unreleased](https://github.com/excpt/moments/tree/HEAD)
+## [v0.3.0](https://github.com/excpt/moments/tree/v0.3.0) (2023-11-29)
 
-[Full Changelog](https://github.com/excpt/moments/compare/v0.1.0...HEAD)
+[Full Changelog](https://github.com/excpt/moments/compare/v0.2.0...v0.3.0)
+
+**Implemented enhancements:**
+
+- Precision? [\#11](https://github.com/excpt/moments/issues/11)
+
+**Closed issues:**
+
+- Add documentation for new precision parameter [\#13](https://github.com/excpt/moments/issues/13)
+
+**Merged pull requests:**
+
+- A few enhancements [\#15](https://github.com/excpt/moments/pull/15) ([Kris-LIBIS](https://github.com/Kris-LIBIS))
+- Intruduce optional mode parameter [\#12](https://github.com/excpt/moments/pull/12) ([excpt](https://github.com/excpt))
+
+## [v0.2.0](https://github.com/excpt/moments/tree/v0.2.0) (2022-05-29)
+
+[Full Changelog](https://github.com/excpt/moments/compare/v0.1.0...v0.2.0)
 
 **Closed issues:**
 

data/README.md

@@ -1,11 +1,5 @@
 # Moments [![Gem Version](https://badge.fury.io/rb/moments.svg)](http://badge.fury.io/rb/moments)
 
-[![Codeship Status for excpt/moments](https://codeship.com/projects/54ff9970-675f-0132-a1ba-760b27c1e7ed/status?branch=master)](https://codeship.com/projects/53081)
-[![Build Status](https://travis-ci.org/excpt/moments.svg?branch=master)](https://travis-ci.org/excpt/moments)
-[![Code Climate](https://codeclimate.com/github/excpt/moments.png)](https://codeclimate.com/github/excpt/moments)
-[![Test Coverage](https://codeclimate.com/github/excpt/moments/badges/coverage.svg)](https://codeclimate.com/github/excpt/moments)
-[![Dependency Status](https://gemnasium.com/excpt/moments.svg)](https://gemnasium.com/excpt/moments)
-
 Handles time differences and calculations.
 
 ## Installation
@@ -44,6 +38,25 @@ puts diff.to_hash
 puts diff.in_months
 # 67 (5 * 12 + 7)
 # there are also methods for each component
+
+from = Time.new(2022, 8, 4, 15, 52, 25, '-06:00')
+to = Time.new(2022, 8, 18, 15, 52, 31, '-06:00')
+
+difference = Moments.difference(from, to, :precise).in_minutes
+# returns: 20_160.1
+# supports: in_weeks, in_days, in_hours, in_minutes
+
+ago = Moments.ago t1
+
+puts ago.to_hash
+# { years: 5, months: 7, days: 5, hours: 19, minutes: 29, seconds: 6 }
+
+puts ago.humanized
+# 5 years, 7 months, 5 days, 19 hours, 29 minutes and 6 seconds
+
+# #humanized takes care of signularity and omits 0 values
+puts Moments.difference(t1, Time.new(2015, 2, 1, 19, 0, 1)).humanized
+# 1 month, 19 hours and 1 second
 ```
 
 ## Contributing

data/lib/moments/difference.rb

@@ -21,12 +21,15 @@ module Moments
 
     # == Parameters:
     # from::
-    #   A instance of Time
+    #   An instance of Time
     # to::
-    #   A instance of Time
-    def initialize(from, to)
+    #   An instance of Time
+    # precise::
+    #   Option to return minutes, hours, days, years as decimals intead of integer
+    def initialize(from, to, mode = :normal)
       @from = parse_argument from
       @to = parse_argument to
+      @precise = mode == :precise
 
       @ordered_from, @ordered_to = [@from, @to].sort
 
@@ -54,19 +57,19 @@ module Moments
     end
 
     def in_minutes
-      in_seconds / 60
+      in_seconds / (@precise ? 60.0 : 60)
     end
 
     def in_hours
-      in_minutes / 60
+      in_minutes / (@precise ? 60.0 : 60)
     end
 
     def in_days
-      in_hours / 24
+      in_hours / (@precise ? 24.0 : 24)
     end
 
     def in_weeks
-      in_days / 7
+      in_days / (@precise ? 7.0 : 7)
     end
 
     def in_months
@@ -89,6 +92,16 @@ module Moments
       years_diff
     end
 
+    def humanized
+      diff_parts = to_hash.each_with_object([]) do |(unit, quantity), parts|
+        parts << "#{quantity} #{quantity == 1 ? unit.to_s[0..-2] : unit}" if quantity.positive?
+      end
+      last_part = diff_parts.pop
+      return last_part if diff_parts.empty?
+
+      [diff_parts.join(', '), last_part].join(' and ')
+    end
+
     private
 
     TIME_CLASSES = [Time, DateTime].freeze

data/lib/moments/version.rb

@@ -11,7 +11,7 @@ module Moments
     # major version
     MAJOR = 0
     # minor version
-    MINOR = 2
+    MINOR = 3
     # patch version
     PATCH = 0
     # alpha, beta, etc. tag

data/lib/moments.rb

@@ -5,7 +5,11 @@ require_relative 'moments/difference'
 
 # Entrypoint for the moments gem
 module Moments
-  def self.difference(from, to)
-    Moments::Difference.new from, to
+  def self.difference(from, to, mode = :normal)
+    Moments::Difference.new from, to, mode
+  end
+
+  def self.ago(from, mode = :normal)
+    Moments::Difference.new from, Time.now, mode
   end
 end

data/moments.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'timecop'
 end

data/spec/lib/moments/difference_precision_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+describe Moments::Difference do
+  # Thu, 04 Aug 2022 15:52:25 MDT -06:00
+  let(:from) { Time.new(2022, 8, 4, 15, 52, 25, '-06:00') }
+  # Thu, 18 Aug 2022 15:52:31 MDT -06:00
+  let(:to) { Time.new(2022, 8, 18, 15, 52, 31, '-06:00') }
+
+  describe 'minutes' do
+    context 'precision' do
+      subject { Moments.difference(from, to, :precise).in_minutes }
+
+      it { should eq 20_160.1 }
+    end
+  end
+
+  describe 'hours' do
+    context 'precision' do
+      subject { Moments.difference(from, to, :precise).in_hours }
+
+      it { should eq 336.001666666666667 }
+    end
+  end
+
+  describe 'days' do
+    context 'precision' do
+      subject { Moments.difference(from, to, :precise).in_days }
+
+      it { should eq 14.000069444444444 }
+    end
+  end
+
+  describe 'weeks' do
+    context 'precision' do
+      subject { Moments.difference(from, to, :precise).in_weeks }
+
+      it { should eq 2.0000099206349207 }
+    end
+  end
+end

data/spec/lib/moments/difference_spec.rb

@@ -807,4 +807,39 @@ describe Moments::Difference do
       it { is_expected.to eq 1 }
     end
   end
+
+  context '#humanized' do
+    subject { Moments::Difference.new(from, to).humanized }
+
+    let (:from) { Time.utc 2020, 1, 1, 0, 0, 0 }
+
+    {
+      [2021, 1, 1, 0, 0, 0] => '1 year',
+      [2020, 2, 1, 0, 0, 0] => '1 month',
+      [2020, 1, 2, 0, 0, 0] => '1 day',
+      [2020, 1, 1, 1, 0, 0] => '1 hour',
+      [2020, 1, 1, 0, 1, 0] => '1 minute',
+      [2020, 1, 1, 0, 0, 1] => '1 second',
+      [2022, 1, 1, 0, 0, 0] => '2 years',
+      [2020, 4, 1, 0, 0, 0] => '3 months',
+      [2020, 1, 5, 0, 0, 0] => '4 days',
+      [2020, 1, 1, 5, 0, 0] => '5 hours',
+      [2020, 1, 1, 0, 6, 0] => '6 minutes',
+      [2020, 1, 1, 0, 0, 7] => '7 seconds',
+      [2021, 2, 1, 0, 0, 0] => '1 year and 1 month',
+      [2021, 1, 2, 0, 0, 0] => '1 year and 1 day',
+      [2021, 1, 1, 1, 0, 0] => '1 year and 1 hour',
+      [2021, 1, 1, 0, 1, 0] => '1 year and 1 minute',
+      [2021, 1, 1, 0, 0, 1] => '1 year and 1 second',
+      [2021, 2, 2, 0, 0, 0] => '1 year, 1 month and 1 day',
+      [2021, 2, 1, 1, 0, 0] => '1 year, 1 month and 1 hour',
+      [2022, 4, 5, 5, 6, 7] => '2 years, 3 months, 4 days, 5 hours, 6 minutes and 7 seconds'
+    }.each do |time_array, string|
+      context "with #{string}" do
+        let (:to) { Time.utc *time_array }
+
+        it { is_expected.to eq string}
+      end
+    end
+  end
 end

data/spec/lib/moments_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'timecop'
+
 describe Moments do
   describe '#difference' do
     subject { Moments.difference(from, to) }
@@ -9,4 +11,39 @@ describe Moments do
 
     it { is_expected.to be_a Moments::Difference }
   end
+
+  describe '#ago' do
+    subject { Moments.ago(from) }
+
+    before do
+      Timecop.freeze(to)
+    end
+
+    after do
+      Timecop.return
+    end
+
+    let(:from) { Time.utc 2010, 1, 1, 0, 0, 0 }
+    let(:to)   { Time.utc 2016, 6, 5, 3, 2, 1 }
+
+    it { is_expected.to be_a Moments::Difference }
+
+    context '#to_hash' do
+
+      subject { Moments.ago(from).to_hash }
+      let (:expected_result) do
+        {
+          years: 6,
+          months: 5,
+          days: 4,
+          hours: 3,
+          minutes: 2,
+          seconds: 1
+        }
+      end
+
+      it { is_expected.to eq expected_result}
+    end
+
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moments
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tim Rudat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-29 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: ''
 email:
 - timrudat@gmail.com
@@ -101,6 +115,7 @@ files:
 - lib/moments/difference.rb
 - lib/moments/version.rb
 - moments.gemspec
+- spec/lib/moments/difference_precision_spec.rb
 - spec/lib/moments/difference_spec.rb
 - spec/lib/moments_spec.rb
 - spec/spec_helper.rb
@@ -124,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Handles time differences.