cronex 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29978d178bd1bb48a3a10583b197d09a0bd768ea
-  data.tar.gz: 7efd313aecf280cfe7d6817b392cc51e571a7c29
+  metadata.gz: 1ab473d3578046b33ddd723eaca36609b34118dd
+  data.tar.gz: 7246cc710d1ca21a5204bb5011531f56a88b1599
 SHA512:
-  metadata.gz: fa456bfec078001cc6b12cc6c7d950e6dd1b8746d69f7341f3ffa6a2834add6ac72ebdb96364713f9d0818eab7dd1c6e6a857cf281a88c7447b1079ac75b68b6
-  data.tar.gz: b4dd39b0fce8599164262e26000bad29b2eeecfc964e82675f353c6af1a886cec1c7f8ba22a494e195fb5ceaa3182978de2306eff54cc73cbc5f4563e08f4bdf
+  metadata.gz: 6f2f55fec081a1eb1631e597c0156a7f703e56834bf83c1e82b4ada16b2def0b90117f27824066efb4e49e1a98b2a7a423fd3cf9214a47281238df1c2ab0ade8
+  data.tar.gz: 9c0bcdf5a8814ffc8ad7d81d3cb3e939fe2bb94e63f4f7a0284a08a6ef6791f5378a0a2c8e566cefa9d220505985d1433b16dd4852a07b595c3177664771bb00

data/.travis.yml

@@ -1,3 +1,9 @@
 language: ruby
+
+cache: bundler
+
 rvm:
-  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### [0.8.0] - 2019-04-18
+* Add support for timezones
+
 ### [0.7.0] - 2018-11-22
 * Include day of week when day of month is specified
 

data/README.md

@@ -16,6 +16,7 @@ Original Author & Credit: Brady Holt (http://www.geekytidbits.com).
  * Provides casing options (sentence, title, lower)
  * Support for non-standard non-zero-based week day numbers
  * Supports printing to locale specific human readable format
+ * Supports displaying times in specific timezones
 
 For a quick intro to cron see Quartz [Cron Tutorial](http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger).
 
@@ -61,6 +62,12 @@ Or install it yourself as:
     Cronex::ExpressionDescriptor.new('30 2 * 2 1-5', {}, 'fr').description
     => À 2:30 AM, lundi à vendredi, seulement en février
 
+#### Timezones
+
+    Cronex::ExpressionDescriptor.new('0-10 11 * * *', {}, 'en', 'America/Los_Angeles').description
+    => Every minute between 4:00 AM and 4:10 AM # PDT or
+    => Every minute between 3:00 AM and 3:10 AM # PST
+
 See spec tests for more examples.
 
 ### Contributing

data/cronex.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'tzinfo', '~> 1.2.5'
   spec.add_runtime_dependency 'unicode'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rake', '~> 10.1'

data/lib/cronex/description/hours.rb

@@ -1,7 +1,7 @@
 module Cronex
   class HoursDescription < Description
-    def single_item_description(expression)
-      Cronex::Utils.format_time(expression, '0')
+    def single_item_description(expression, timezone = 'UTC')
+      Cronex::Utils.format_time(expression, '0', '', timezone)
     end
 
     def interval_description_format(expression)

data/lib/cronex/exp_descriptor.rb

@@ -16,14 +16,15 @@ module Cronex
   }
 
   class ExpressionDescriptor
-    attr_accessor :expression, :expression_parts, :options, :parsed, :resources
+    attr_accessor :expression, :expression_parts, :options, :parsed, :resources, :timezone
 
-    def initialize(expression, options = {}, locale = nil)
+    def initialize(expression, options = {}, locale = nil, timezone = 'UTC')
       @expression = expression
       @options = CRONEX_OPTS.merge(options)
       @expression_parts = []
       @parsed = false
       @resources = Cronex::Resource.new(locale)
+      @timezone = timezone
     end
 
     def to_hash
@@ -129,19 +130,19 @@ module Cronex
       description = ''
       if [sec_exp, min_exp, hour_exp].all? { |exp| !Cronex::Utils.include_any?(exp, SPECIAL_CHARS) }
         # specific time of day (i.e. 10 14)
-        description += resources.get('at') + ' ' + Cronex::Utils.format_time(hour_exp, min_exp, sec_exp)
+        description += resources.get('at') + ' ' + Cronex::Utils.format_time(hour_exp, min_exp, sec_exp, timezone)
       elsif min_exp.include?('-') && !min_exp.include?('/') && !min_exp.include?(',') && !Cronex::Utils.include_any?(hour_exp, SPECIAL_CHARS)
         # Minute range in single hour (e.g. 0-10 11)
         min_parts = min_exp.split('-')
         description += format(
           resources.get('every_minute_between'),
-          Cronex::Utils.format_time(hour_exp, min_parts[0]),
-          Cronex::Utils.format_time(hour_exp, min_parts[1]))
+          Cronex::Utils.format_time(hour_exp, min_parts[0], '', timezone),
+          Cronex::Utils.format_time(hour_exp, min_parts[1], '', timezone))
       elsif hour_exp.include?(',') && !Cronex::Utils.include_any?(min_exp, SPECIAL_CHARS)
         # Hours list with single minute (e.g. 30 6,14,16)
         hour_parts = hour_exp.split(',')
         description += resources.get('at')
-        h_parts = hour_parts.map { |part| ' ' + Cronex::Utils.format_time(part, min_exp) }
+        h_parts = hour_parts.map { |part| ' ' + Cronex::Utils.format_time(part, min_exp, '', timezone) }
         description += h_parts[0...-1].join(',') + ' ' + resources.get('and') + h_parts.last
       else
         sec_desc = seconds_description(expression_parts)

data/lib/cronex/utils.rb

@@ -1,3 +1,5 @@
+require 'tzinfo'
+
 module Cronex
   module Utils
     extend self
@@ -32,18 +34,14 @@ module Cronex
       end
     end
 
-    def format_time(hour_expression, minute_expression, second_expression = '')
+    def format_time(hour_expression, minute_expression, second_expression = '', timezone = 'UTC')
       hour = integer(hour_expression)
-      period = hour >= 12 ? 'PM' : 'AM'
-      hour -= 12 if hour > 12
       minute = integer(minute_expression)
-      minute = format('%02d', minute)
-      second = ''
-      if present?(second_expression)
-        second = integer(second_expression)
-        second = ':' + format('%02d', second)
-      end
-      format('%s:%s%s %s', hour, minute, second, period)
+      second = second_expression.to_s.empty? ? 0 : integer(second_expression)
+      tz = TZInfo::Timezone.get(timezone)
+      time = tz.utc_to_local(Date.today.to_time + hour * 60 * 60 + minute * 60 + second)
+      format = present?(second_expression) ? '%l:%M:%S %p' : '%l:%M %p'
+      time.strftime(format).lstrip
     end
   end
 end

data/lib/cronex/version.rb

@@ -1,3 +1,3 @@
 module Cronex
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/spec/exp_descriptor_en_spec.rb

@@ -4,8 +4,8 @@ require 'cronex'
 module Cronex
   describe ExpressionDescriptor do
 
-    def desc(expression, opts = {})
-      Cronex::ExpressionDescriptor.new(expression, opts, 'en').description
+    def desc(expression, opts = {}, timezone = 'UTC')
+      Cronex::ExpressionDescriptor.new(expression, opts, 'en', timezone).description
     end
 
     let(:opts) { { zero_based_dow: false } }
@@ -375,7 +375,27 @@ module Cronex
       end
 
       it 'year increments' do
-        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('At 0:00 AM, on day 1 of the month, only in March, every 5 years, starting in 2010')
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('At 12:00 AM, on day 1 of the month, only in March, every 5 years, starting in 2010')
+      end
+    end
+
+    context 'timezone' do
+      it 'minute span' do
+        tz = TZInfo::Timezone.get('America/Los_Angeles')
+        hour = tz.period_for_local(Time.now).zone_identifier.to_s == 'PDT' ? 4 : 3
+        expect(desc('0-10 11 * * *', {}, 'America/Los_Angeles')).to eq("Every minute between #{hour}:00 AM and #{hour}:10 AM")
+      end
+
+      it 'twice a day' do
+        tz = TZInfo::Timezone.get('America/Los_Angeles')
+        hour = tz.period_for_local(Time.now).zone_identifier.to_s == 'PDT' ? 5 : 4
+        expect(desc('0 0,12 * * *', {}, 'America/Los_Angeles')).to eq("At #{hour}:00 PM and #{hour}:00 AM")
+      end
+
+      it 'ahead of GMT' do
+        tz = TZInfo::Timezone.get('Europe/Vienna')
+        hour = tz.period_for_local(Time.now).zone_identifier.to_s == 'CEST' ? 1 : 12
+        expect(desc('0-10 11 * * *', {}, 'Europe/Vienna')).to eq("Every minute between #{hour}:00 PM and #{hour}:10 PM")
       end
     end
   end

data/spec/exp_descriptor_fr_spec.rb

@@ -375,7 +375,7 @@ module Cronex
       end
 
       it 'year increments' do
-        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('À 0:00 AM, le 1 de chaque mois, seulement en mars, tous les 5 ans, commence en 2010')
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('À 12:00 AM, le 1 de chaque mois, seulement en mars, tous les 5 ans, commence en 2010')
       end
     end
   end

data/spec/exp_descriptor_pt_BR_spec.rb

@@ -375,7 +375,7 @@ module Cronex
       end
 
       it 'year increments' do
-        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('Às 0:00 AM, no dia 1 do mês, em março, a cada 5 anos, iniciando em 2010')
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('Às 12:00 AM, no dia 1 do mês, em março, a cada 5 anos, iniciando em 2010')
       end
     end
   end

data/spec/exp_descriptor_ro_spec.rb

@@ -375,7 +375,7 @@ module Cronex
       end
 
       it 'year increments' do
-        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('La 0:00 AM, în a 1-a zi a lunii, numai în martie, la fiecare 5 ani, pornire în 2010')
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('La 12:00 AM, în a 1-a zi a lunii, numai în martie, la fiecare 5 ani, pornire în 2010')
       end
     end
   end

data/spec/exp_descriptor_ru_spec.rb

@@ -375,7 +375,7 @@ module Cronex
       end
 
       it 'year increments' do
-        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('В 0:00 AM, 1 число месяца, только март, каждые 5 лет, начало в 2010')
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('В 12:00 AM, 1 число месяца, только март, каждые 5 лет, начало в 2010')
       end
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: cronex
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Adrian Kazaku
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-23 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
   name: unicode
   requirement: !ruby/object:Gem::Requirement