et-orbi 1.2.1 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e76c51b164aaa3749e6865594a141100e4e6e1e
-  data.tar.gz: dbc982c799a79da7408ed7e7cb9ff9d9481ea91c
+SHA256:
+  metadata.gz: 23ff138170f965f0a2dc35d38aaa08123ddfd97176d76f5e1b2136306eec812e
+  data.tar.gz: 193d8bca6b8cfb34f023aadb504e127fd3f187eb64c10f546327510c8f487e04
 SHA512:
-  metadata.gz: b2780226defd2f1ad6aad04291e6dc77bcf9e56d60c75f2f68ea0471f931bf75f434cf44e52a17d5e41dff79947c571d7179cf70759d0429e3d6631f02f4d996
-  data.tar.gz: 8cad684822abf9f08a3811867a5c0010e24d175527fa65c7f4f67e580fd540b5e798cf94131b95b9942ec239b00c1fccc470a5c8a0cadeacfd4dfa3c8f5299a0
+  metadata.gz: 9a5747b65189567c49a9dda0936bac7d947deaa8a5067ba4d311d1c80032722baae682acfc111488d8c6b3139fa41238dfec645279983449312c6f5aa8881eb9
+  data.tar.gz: 2173668af72a6c2aff4e992201d5c74ffe5f87023f6e52c4c42389c28bb8cab4a231c55142bbc9c12513173260c80bf3b372c0ccad555900f6a7efad01e35482

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 # CHANGELOG.md
 
 
+## et-orbi 1.2.7  released 2022-03-09
+
+- Fix the wday_in_month computation for floraison/fugit#67
+
+
+## et-orbi 1.2.6  released 2021-10-30
+
+- Favour IANA timezone name in EtOrbi.make_time
+
+
+## et-orbi 1.2.5  released 2021-09-18
+
+- Re-use the DateTime.parse result
+
+
+## et-orbi 1.2.4  released 2020-03-18
+
+- Do not call Chronic (even if enabled) from make_from_array, gh-28
+- Be modern, use strftime '%6N', join Ruby 2.x :-)
+
+
+## et-orbi 1.2.3  released 2020-03-06
+
+- Introduce EtOrbi.chronic_enabled = false and EtOrbi.chronic_enabled?, gh-26
+
+
+## et-orbi 1.2.2  released 2019-08-19
+
+- Let EoTime#== accept EoTime or ::Time instances, gh-20, gh-7
+
+
 ## et-orbi 1.2.1  released 2019-05-01
 
 - More US time zone corrections, Vais Salikhov, gh-19

data/CREDITS.md

@@ -1,6 +1,12 @@
 
 # et-orbi credits
 
+* phibid, for https://github.com/floraison/fugit/issues/67
+* Peter Goldstein, https://github.com/petergoldstein GHA 3.3 j9.3, gh-32
+* harsha-flipp (https://github.com/harsha-flipp) https://github.com/floraison/fugit/issues/63
+* adank92 (https://github.com/adank92) https://github.com/ondrejbartas/sidekiq-cron/issues/276 gh-28
+* Stan Hu (https://github.com/stanhu) Chronic toubles, gh-24, gh-26, etc
+* d-m-u (https://github.com/d-m-u) EoTime#==(Time), gh-20, gh-7
 * Vais Salikhov (https://github.com/vais) missing US timezone aliases, gh-18 gh-19
 * Wenhui Wang https://github.com/w11th .parse vs Chronic+ActiveSupport, fugit 11
 * Marcel https://github.com/MTRNord "Mitteleuropaeische Sommerzeit", gh-15

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2017-2019, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2017-2022, John Mettraux, jmettraux+flor@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -31,7 +31,7 @@ build: gemspec_validate
 	mv $(NAME)-$(VERSION).gem pkg/
 
 push: build
-	gem push pkg/$(NAME)-$(VERSION).gem
+	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
 
 spec:
 	bundle exec rspec

data/README.md

@@ -1,8 +1,7 @@
 
 # et-orbi
 
-[![Build Status](https://secure.travis-ci.org/floraison/et-orbi.svg)](http://travis-ci.org/floraison/et-orbi)
-[![Build status](https://ci.appveyor.com/api/projects/status/6tbo9lk9qdor8ipl?svg=true)](https://ci.appveyor.com/project/jmettraux/et-orbi)
+[![tests](https://github.com/floraison/et-orbi/workflows/test/badge.svg)](https://github.com/floraison/et-orbi/actions)
 [![Gem Version](https://badge.fury.io/rb/et-orbi.svg)](http://badge.fury.io/rb/et-orbi)
 [![Join the chat at https://gitter.im/floraison/fugit](https://badges.gitter.im/floraison/fugit.svg)](https://gitter.im/floraison/fugit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -16,6 +15,8 @@ require 'et-orbi'
 
 EtOrbi.now
   # => #<EtOrbi::EoTime:0x007f94d94 ...>
+EtOrbi.now('Asia/Singapore')
+  # => #<EtOrbi::EoTime:0x39c96e48 @time=nil, @zone=#<TZInfo::DataTimezone: Asia/Singapore>...>
 EtOrbi.parse('2017-12-13 13:00:00 America/Jamaica')
   # => #<EtOrbi::EoTime:0x007f94d90 @zone=#<TZInfo::DataTimezone: America/Jamaica>...>
 EtOrbi.make_time(Time.now)
@@ -37,7 +38,7 @@ EtOrbi.parse('1970-01-01 03:00:00 Europe/Moscow')
 ```
 
 More about `EtOrbi::EoTime` instances:
-```
+```ruby
 eot = EtOrbi::EoTime.new(0, 'Europe/Moscow')
 
 eot.to_local_time.class  # => Time
@@ -69,6 +70,52 @@ EtOrbi.platform_info
     # astz: ActiveSupport provided Time.zone
 ```
 
+### Chronic integration
+
+By default, et-orbi relies on [Chronic](https://github.com/mojombo/chronic) to parse strings like "tomorrow" or "friday 1pm", if `Chronic` is present.
+
+```ruby
+EtOrbi.parse('tomorrow')
+  # => #<EtOrbi::EoTime:0x007fbc6aa8a560
+  #      @seconds=1575687600.0,
+  #      @zone=#<TZInfo::TimezoneProxy: Asia/Tokyo>,
+  #      @time=nil>
+EtOrbi.parse('tomorrow').to_s
+  # => "2019-12-07 12:00:00 +0900"
+```
+
+This is a poor design choice I replicated from [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler).
+
+Of course this leads to [issues](https://gitlab.com/gitlab-org/gitlab/issues/37014).
+
+It's probably better to have Chronic do its work outside of et-orbi, like in:
+```ruby
+EtOrbi.parse(Chronic.parse('tomorrow').to_s).to_s
+  # => "2019-12-07 12:00:00 +0900"
+```
+
+If one has Chronic present in their project but doesn't want it to interfere with et-orbi, it can be disabled at `parse` call:
+```ruby
+EtOrbi.parse('tomorrow')
+  # => #<EtOrbi::EoTime:0x007ffb5b2a2390
+  #      @seconds=1575687600.0,
+  #      @zone=#<TZInfo::TimezoneProxy: Asia/Tokyo>,
+  #      @time=nil>
+EtOrbi.parse('tomorrow', enable_chronic: false)
+  # ArgumentError: No time information in "tomorrow"
+  #   from /home/jmettraux/w/et-orbi/lib/et-orbi/make.rb:31:in `rescue in parse'
+```
+or at the et-orbi level:
+```ruby
+irb(main):007:0> EtOrbi.chronic_enabled = false
+  # => false
+irb(main):008:0> EtOrbi.chronic_enabled?
+  # => false
+EtOrbi.parse('tomorrow')
+  # ArgumentError: No time information in "tomorrow"
+  #   from /home/jmettraux/w/et-orbi/lib/et-orbi/make.rb:31:in `rescue in parse'
+```
+
 ### Rails?
 
 If Rails is present, `Time.zone` is provided and EtOrbi will use it, unless `ENV['TZ']` is set to a valid timezone name. Setting `ENV['TZ']` to nil can give back precedence to `Time.zone`.

data/et-orbi.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux+flor@gmail.com' ]
-  s.homepage = 'http://github.com/floraison/et-orbi'
+  s.homepage = 'https://github.com/floraison/et-orbi'
   s.license = 'MIT'
   s.summary = 'time with zones'
 

data/lib/et-orbi/make.rb

@@ -1,6 +1,15 @@
 
 module EtOrbi
 
+  @chronic_enabled = true
+    #
+  def self.chronic_enabled?
+    @chronic_enabled
+  end
+  def self.chronic_enabled=(b)
+    @chronic_enabled = b
+  end
+
   class << self
 
     def now(zone=nil)
@@ -12,28 +21,29 @@ module EtOrbi
 
       str, str_zone = extract_zone(str)
 
-      if defined?(::Chronic) && t = ::Chronic.parse(str, opts)
-
+      if t = chronic_parse(str, opts)
         str = [ t.strftime('%F %T'), str_zone ].compact.join(' ')
       end
 
-      begin
-        DateTime.parse(str)
-      rescue
-        fail ArgumentError, "No time information in #{str.inspect}"
-      end
-      #end if RUBY_VERSION < '1.9.0'
-      #end if RUBY_VERSION < '2.0.0'
-        #
-        # is necessary since Time.parse('xxx') in Ruby < 1.9 yields `now`
+      dt =
+        begin
+          DateTime.parse(str)
+        rescue
+          fail ArgumentError, "No time information in #{str.inspect}"
+        end
+        #end if RUBY_VERSION < '1.9.0'
+        #end if RUBY_VERSION < '2.0.0'
+          #
+          # is necessary since Time.parse('xxx') in Ruby < 1.9 yields `now`
 
       zone =
         opts[:zone] ||
         get_tzone(str_zone) ||
         determine_local_tzone
 
-      local = Time.parse(str)
-      secs = zone.local_to_utc(local).to_f
+      #local = Time.parse(str)
+      #secs = zone.local_to_utc(local).to_f
+      secs = zone.local_to_utc(dt).to_time.to_f
 
       EoTime.new(secs, zone)
     end
@@ -60,13 +70,24 @@ module EtOrbi
 
     protected
 
+    def chronic_parse(str, opts)
+
+      return false unless defined?(::Chronic)
+      return false unless opts.fetch(:enable_chronic) { self.chronic_enabled? }
+
+      os = opts
+        .select { |k, _| Chronic::Parser::DEFAULT_OPTIONS.keys.include?(k) }
+
+      ::Chronic.parse(str, os)
+    end
+
     def make_from_time(t, zone)
 
       z =
         zone ||
         get_as_tzone(t) ||
-        get_tzone(t.zone) ||
-        get_local_tzone(t)
+        get_local_tzone(t) ||
+        get_tzone(t.zone)
 
       z ||= t.zone
         # pass the abbreviation anyway,
@@ -86,10 +107,9 @@ module EtOrbi
 
     def make_from_array(a, zone)
 
-      t = Time.utc(*a)
-      s = t.strftime("%Y-%m-%d %H:%M:%S.#{'%06d' % t.usec}")
-
-      make_from_string(s, zone)
+      parse(
+        Time.utc(*a).strftime('%Y-%m-%d %H:%M:%S.%6N'), # not a Chronic string
+        zone: zone, enable_chronic: false)
     end
 
     def make_from_string(s, zone)

data/lib/et-orbi/time.rb

@@ -205,11 +205,24 @@ module EtOrbi
 
     def ==(o)
 
-      o.is_a?(EoTime) &&
-      o.seconds == @seconds &&
-      (o.zone == @zone || o.zone.current_period == @zone.current_period)
+      if o.is_a?(EoTime)
+        o.seconds == @seconds &&
+        (o.zone == @zone || o.zone.current_period == @zone.current_period)
+      elsif o.is_a?(::Time)
+        (to_f * 1000).to_i == (o.to_f * 1000).to_i
+      else
+        false
+      end
     end
-    #alias eql? == # FIXME see Object#== (ri)
+
+    # Nota Bene:
+    #
+    # Unlike ==, the equal? method should never be overridden by subclasses
+    # as it is used to determine object identity (that is, a.equal?(b) if and
+    # only if a is the same object as b)
+    #
+    # The eql? method returns true if obj and other refer to the same hash key.
+    # This is used by Hash to test members for equality.
 
     def >(o); @seconds > _to_f(o); end
     def >=(o); @seconds >= _to_f(o); end
@@ -283,7 +296,7 @@ module EtOrbi
 
     def to_time_s
 
-      strftime("%H:%M:%S.#{'%06d' % usec}")
+      strftime('%H:%M:%S.%6N')
     end
 
     def inc(t, dir=1)
@@ -313,7 +326,8 @@ module EtOrbi
 
     def wday_in_month
 
-      [ count_weeks(-1), - count_weeks(1) ]
+      [ count_weeks(EtOrbi.make_time(strftime('%F 12:00:00 %/Z')), -1),
+        - count_weeks(EtOrbi.make_time(strftime('%F 12:00:00 %/Z')) , 1) ]
     end
 
     def rweek
@@ -372,10 +386,11 @@ module EtOrbi
       @time ||= @zone.utc_to_local(utc)
     end
 
-    def count_weeks(dir)
+    def count_weeks(start, dir)
 
       c = 0
-      t = self
+      t = start
+
       until t.month != self.month
         c += 1
         t += dir * (7 * 24 * 3600)
@@ -414,7 +429,7 @@ module EtOrbi
 
       fail ArgumentError(
         "Comparison of EoTime with #{o.inspect} failed"
-      ) unless o.is_a?(EoTime) || o.is_a?(Time)
+      ) unless o.respond_to?(:to_f)
 
       o.to_f
     end

data/lib/et-orbi/zones.rb

@@ -13,7 +13,7 @@ module EtOrbi
           (?![-+])
             |Z
         )
-      }x
+      }x.freeze
 
     # https://en.wikipedia.org/wiki/ISO_8601
     # Postel's law applies

data/lib/et-orbi.rb

@@ -13,6 +13,6 @@ require 'et-orbi/zone'
 
 module EtOrbi
 
-  VERSION = '1.2.1'
+  VERSION = '1.2.7'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et-orbi
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.7
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -73,15 +73,15 @@ files:
 - lib/et-orbi/zones.rb
 - lib/et_orbi.rb
 - lib/etorbi.rb
-homepage: http://github.com/floraison/et-orbi
+homepage: https://github.com/floraison/et-orbi
 licenses:
 - MIT
 metadata:
-  changelog_uri: http://github.com/floraison/et-orbi/blob/master/CHANGELOG.md
-  documentation_uri: http://github.com/floraison/et-orbi
-  bug_tracker_uri: http://github.com/floraison/et-orbi/issues
-  homepage_uri: http://github.com/floraison/et-orbi
-  source_code_uri: http://github.com/floraison/et-orbi
+  changelog_uri: https://github.com/floraison/et-orbi/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/floraison/et-orbi
+  bug_tracker_uri: https://github.com/floraison/et-orbi/issues
+  homepage_uri: https://github.com/floraison/et-orbi
+  source_code_uri: https://github.com/floraison/et-orbi
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -97,8 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: time with zones