moments 0.0.1.alpha → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f5c9ac306fade5a3e30cf114c2d8d2c5bd6ddef7
-  data.tar.gz: 01ab04bf9129c934bbcd347a09e71d9681d8ee9d
+SHA256:
+  metadata.gz: 0b85363c9163c9935f75833c74b4e7d587cc70d962ca4f86e14e6d8a3bb14196
+  data.tar.gz: 1a6421e682139a2cefb0b82d12bcd5d08cb2f8220ab20a65f9646938e0ee1653
 SHA512:
-  metadata.gz: d22dbd113c4e13f1efc0b45edc5ef8b1c961bc6400b2c109d659a0d37e8615a011072d42034d71c5dba59c95a9f512fb80aaeff8d6d85c1c4c76bbca0b062d50
-  data.tar.gz: be8882e85ce70577b6ba4cc8d53109e6d7c5e30e06ed345b9d2c2a48d9aadb7d627d0d217356b5254819e8f9ae207b8aca69cfee7aa3cc9b8ecc79c2023baa92
+  metadata.gz: 360367e75466166fc7bb786fa4d0247b23d7ba61b118286bc137c7b697ef25a12bf3d847f0b2907de9a899ee1d3132298b5196ef93387b536e800fca8132c24a
+  data.tar.gz: e374f88fd8029894bdeee1e0ea79ae58188552fe43438dfb56e37335a36121b91c6b14e0d8b7a814ff0901c10c9928916051f1ea38a1b28997bce3ff47f932a9

data/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 100

data/.gitignore

@@ -24,3 +24,5 @@ mkmf.log
 *.iml
 *.ipr
 *.iws
+.idea/
+.ruby-version

data/.rspec

@@ -1,2 +1,2 @@
+--require spec_helper
 --color
---format documentation

data/.rubocop.yml

@@ -0,0 +1,81 @@
+# inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'gemfiles/*.gemfile'
+    - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 100
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Style/FormatString:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/WordArray:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: true
+  EnforcedLastArgumentHashStyle: always_ignore
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.travis.yml

@@ -1,7 +1,12 @@
+sudo: false
+cache: bundler
 language: ruby
 script: "bundle exec rspec"
+before_install:
+  - gem update --system
+  - gem --version
+  - bundle install
 rvm:
-  - 2.1.0
-  - jruby-19mode
-  - ruby-head
-  - jruby-head
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+## [Unreleased](https://github.com/excpt/moments/tree/HEAD)
+
+[Full Changelog](https://github.com/excpt/moments/compare/v0.1.0...HEAD)
+
+**Closed issues:**
+
+- Make a new release [\#7](https://github.com/excpt/moments/issues/7)
+
+**Merged pull requests:**
+
+- Parse string input whenever possible [\#10](https://github.com/excpt/moments/pull/10) ([RomanVanLoo](https://github.com/RomanVanLoo))
+- Add `in_weeks` [\#9](https://github.com/excpt/moments/pull/9) ([RomanVanLoo](https://github.com/RomanVanLoo))
+- Release 0.1.0 [\#8](https://github.com/excpt/moments/pull/8) ([excpt](https://github.com/excpt))
+- Fix `#in_*` for times with miliseconds [\#6](https://github.com/excpt/moments/pull/6) ([AlexWayfer](https://github.com/AlexWayfer))
+- Fix diffs with different timezones, `Date` diffs and `#in_years` [\#5](https://github.com/excpt/moments/pull/5) ([AlexWayfer](https://github.com/AlexWayfer))
+- Add `#in_*` methods, like `#in_seconds` [\#4](https://github.com/excpt/moments/pull/4) ([AlexWayfer](https://github.com/AlexWayfer))
+- Many improvements [\#2](https://github.com/excpt/moments/pull/2) ([AlexWayfer](https://github.com/AlexWayfer))
+
+## [v0.1.0](https://github.com/excpt/moments/tree/v0.1.0) (2020-08-18)
+
+[Full Changelog](https://github.com/excpt/moments/compare/v0.0.2.alpha...v0.1.0)
+
+**Closed issues:**
+
+- Replace Travis CI with another CI [\#3](https://github.com/excpt/moments/issues/3)
+
+## [v0.0.2.alpha](https://github.com/excpt/moments/tree/v0.0.2.alpha) (2014-11-14)
+
+[Full Changelog](https://github.com/excpt/moments/compare/v0.0.1.alpha...v0.0.2.alpha)
+
+## [v0.0.1.alpha](https://github.com/excpt/moments/tree/v0.0.1.alpha) (2014-05-26)
+
+[Full Changelog](https://github.com/excpt/moments/compare/9b7612483150b52000ab4948d5c2217945230a1d...v0.0.1.alpha)
+
+**Closed issues:**
+
+- Test ticket from Code Climate [\#1](https://github.com/excpt/moments/issues/1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,7 +1,10 @@
-# Moments
+# 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.
 
@@ -9,18 +12,40 @@ Handles time differences and calculations.
 
 Add this line to your application's Gemfile:
 
-    gem 'moments'
+```ruby
+gem 'moments'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install moments
+```sh
+$ gem install moments
+```
 
 ## Usage
 
+```ruby
+require 'moments'
+
+t1 = Time.new 2015, 1, 1, 0, 0, 0
+t2 = Time.now # 2020, 8, 6, 19, 29, 6
+
+diff = Moments.difference t1, t2
+
+puts diff.to_hash
+# { years: 5, months: 7, days: 5, hours: 19, minutes: 29, seconds: 6 }
+
+puts diff.in_months
+# 67 (5 * 12 + 7)
+# there are also methods for each component
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/excpt/moments/fork )

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/lib/moments/difference.rb

@@ -1,13 +1,34 @@
+# frozen_string_literal: true
+
+require 'date'
+
 module Moments
+  # Calculates differences between two given Time instances.
   class Difference
+    DATE_PARTS = {
+      years: :year,
+      months: :month,
+      days: :day
+    }.freeze
+
+    TIME_PARTS = {
+      hours: :hour,
+      minutes: :min,
+      seconds: :sec
+    }.freeze
+
+    private_constant :DATE_PARTS, :TIME_PARTS
+
+    # == Parameters:
+    # from::
+    #   A instance of Time
+    # to::
+    #   A instance of Time
     def initialize(from, to)
-      @from = from
-      @to   = to
+      @from = parse_argument from
+      @to = parse_argument to
 
-      if past?
-        message = "Start date (#{from}) must be less or equal than the end date (#{@to})."
-        raise ArgumentError.new(message)
-      end
+      @ordered_from, @ordered_to = [@from, @to].sort
 
       precise_difference
     end
@@ -28,56 +49,121 @@ module Moments
       @from > @to
     end
 
-    def precise_difference
-      seconds = @to.sec - @from.sec
-      minutes = @to.min - @from.min
-      hours   = @to.hour - @from.hour
-      days    = @to.day - @from.day
-      months  = @to.month - @from.month
-      years   = @to.year - @from.year
-
-      if seconds < 0
-        seconds += 60
-        minutes -= 1
-      end
+    def in_seconds
+      @ordered_to.to_i - @ordered_from.to_i
+    end
 
-      if minutes < 0
-        minutes += 60
-        hours   -= 1
-      end
+    def in_minutes
+      in_seconds / 60
+    end
+
+    def in_hours
+      in_minutes / 60
+    end
+
+    def in_days
+      in_hours / 24
+    end
+
+    def in_weeks
+      in_days / 7
+    end
+
+    def in_months
+      months_diff = @ordered_to.month - @ordered_from.month
+      months_diff -= 1 if months_diff.positive? && @ordered_to.mday < @ordered_from.mday
+
+      ((@ordered_to.year - @ordered_from.year) * 12) + months_diff
+    end
 
-      if hours < 0
-        hours += 24
-        days  -= 1
+    def in_years
+      years_diff = @ordered_to.year - @ordered_from.year
+
+      return years_diff unless years_diff.positive?
+      return years_diff if @ordered_to.month > @ordered_from.month
+
+      if (@ordered_to.month < @ordered_from.month) || (@ordered_to.mday < @ordered_from.mday)
+        years_diff -= 1
       end
 
-      if days < 0
-        previous_month_days = (Time.new(@to.year, @to.month, 1) - 1).day
+      years_diff
+    end
 
-        if previous_month_days < @from.day
-          days = previous_month_days + days + (@from.day - previous_month_days)
-        else
-          days = previous_month_days + days
-        end
+    private
+
+    TIME_CLASSES = [Time, DateTime].freeze
 
-        months -= 1
+    private_constant :TIME_CLASSES
+
+    def parse_argument(value)
+      case value
+      when *TIME_CLASSES
+        value.to_time.getutc
+      when Date
+        value.to_time
+      when String
+        begin
+          Time.parse(value).getutc
+        rescue ArgumentError
+          unsupported_format
+        end
+      else
+        unsupported_format
       end
+    end
+
+    def unsupported_format
+      raise ArgumentError, 'Unsupported format'
+    end
+
+    def precise_difference
+      @diff = calculate_diff
+
+      calculate :seconds, :minutes
+      calculate :minutes, :hours
+      calculate :hours, :days, 24
+      calculate_days
+      calculate :months, :years, 12
+
+      @diff
+    end
 
-      if months < 0
-        months += 12
-        years -= 1
+    def calculate_diff
+      are_time_parts = [@from, @to].all? do |value|
+        TIME_CLASSES.any? { |time_class| value.is_a?(time_class) }
       end
 
-      @diff = {
-          years:   years,
-          months:  months,
-          days:    days,
-          hours:   hours,
-          minutes: minutes,
-          seconds: seconds
-      }
+      (are_time_parts ? DATE_PARTS.merge(TIME_PARTS) : DATE_PARTS)
+        .transform_values do |method_name|
+          @ordered_to.public_send(method_name) - @ordered_from.public_send(method_name)
+        end
+    end
+
+    def calculate(attribute, difference, stepping = 60)
+      return unless @diff.key?(attribute) && @diff.key?(difference)
+
+      return if @diff[attribute] >= 0
+
+      @diff[attribute] += stepping
+      @diff[difference] -= 1
     end
 
-    private :precise_difference
+    def calculate_days
+      return if @diff[:days] >= 0
+
+      previous_month_days = (Time.new(@to.year, @to.month, 1) - 1).day
+      @diff[:days] = precise_previous_month_days(
+        @diff[:days], previous_month_days, @from.day
+      )
+      @diff[:months] -= 1
+    end
+
+    def precise_previous_month_days(days, previous, from)
+      if previous < from
+        previous + days + (from - previous)
+      else
+        previous + days
+      end
+    end
   end
-end
+end

data/lib/moments/version.rb

@@ -1,14 +1,23 @@
+# frozen_string_literal: true
+
+# Moments::Version module
 module Moments
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
 
+  # Moments version builder module
   module VERSION
+    # major version
     MAJOR = 0
-    MINOR = 0
-    TINY  = 1
-    PRE   = 'alpha'
+    # minor version
+    MINOR = 2
+    # patch version
+    PATCH = 0
+    # alpha, beta, etc. tag
+    PRE   = nil
 
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+    # Build version string
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end
 end

data/lib/moments.rb

@@ -1,6 +1,9 @@
-require 'moments/version'
-require 'moments/difference'
+# frozen_string_literal: true
 
+require_relative 'moments/version'
+require_relative 'moments/difference'
+
+# Entrypoint for the moments gem
 module Moments
   def self.difference(from, to)
     Moments::Difference.new from, to

data/moments.gemspec

@@ -1,24 +1,25 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'moments/version'
+# frozen_string_literal: true
+
+require_relative 'lib/moments/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "moments"
-  spec.version       = Moments.gem_version
-  spec.authors       = ["Tim Rudat"]
-  spec.email         = ["timrudat@gmail.com"]
-  spec.summary       = %q{Handles time differences and calculations.}
-  spec.description   = %q{}
-  spec.homepage      = "https://github.com/excpt/moments"
-  spec.license       = "MIT"
+  spec.name        = 'moments'
+  spec.version     = Moments.gem_version
+  spec.authors     = ['Tim Rudat']
+  spec.email       = ['timrudat@gmail.com']
+  spec.summary     = 'Handles time differences.'
+  spec.description = ''
+  spec.homepage    = 'https://github.com/excpt/moments'
+  spec.license     = 'MIT'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'github_changelog_generator'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end