et-orbi 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3ad790bb200e2bb944f6d8b69abb66a3f5563c0d601fd51839c19fa9b2585ed
-  data.tar.gz: 1a9c61b4371a23fb0e4c4db5dfdf5ffb0fd440415f811e232a580e6ce71d37f0
+  metadata.gz: f18b492d498b8c0ff786a9f87e2e37dd71428aaf6ebaa1500b4f6e8fe2c0e200
+  data.tar.gz: 46d56c7b0561c3b8ac26475ad9cc8893501c1c61748c2d1d0497ade0fa08ea51
 SHA512:
-  metadata.gz: 5f6032e29f4f91a638c5d524cd94854128ad9f59d2a017989088dd44c130098bbce44460f0d57396e3dd81a155b770fdcc3454be8069513924aa1dfe1807ea0d
-  data.tar.gz: 2b9b2e1b4dd3c49c103d856509096ca0672c3efff4b9e3d5affb87559de010416c9944de55cd4284a8f3bc949ef2f6251fe0fd56c7a055aa516f63b046a09c28
+  metadata.gz: 1bdc09efbc0dcaf4ed532e4ec42f45a9a74577e6af132590fc78f0557f7aa7669dd8f37eeabda27feee2f65a995bcc36c55c4a9c7fe90b5105585657eb919525
+  data.tar.gz: 7a503eb5a07fe006d43d05a9ace9cc23839e91e6caf710c73afb000726cbee1abda561efd3adb43cd636504f3ae37580274ea80834f9c6f0bcca8091ed55e7dd

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 # CHANGELOG.md
 
 
+## 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

data/CREDITS.md

@@ -1,6 +1,7 @@
 
 # et-orbi credits
 
+* 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

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2017-2019, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2017-2020, 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/README.md

@@ -37,7 +37,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 +69,46 @@ 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 his 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/lib/et-orbi.rb

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

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,8 +21,7 @@ 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
 
@@ -60,6 +68,17 @@ 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 =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et-orbi
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2020-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: time with zones