ice_cube 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b2874169ce6feed9740297977d1dc7a4de82c83
-  data.tar.gz: 6b7c7b5c35167429740adb2f64eced33413b3e93
+  metadata.gz: 39bb12c785e0af4edc922b99cdc1aaabf02cc282
+  data.tar.gz: 4cdf399772a0f10987821ef1f420a62ee1cc3ee8
 SHA512:
-  metadata.gz: 7d9ec04b5840a45acd23ad7f41e44491ff6cb66f85348d32504ec3116955513eb2e4ec3c8e6281c958d2f6957ec7f08ff67e126a4853618fa748da84d5705638
-  data.tar.gz: e47242b8441a7eb029ebd4c128030eb004110d539aed236ad1b55a8c02f378483fdf925c93ccbf4c794dd990d6a5b80bd3f9a1728c4d5c6e8f748c3a1f33cce8
+  metadata.gz: 38b477ae4371d93de536512ee3917cb9eda9865540a1ba51f240b37ee8819bd3ee1a303fd016583f5df57fe6af9360cf4aaed038a5370f6f1690651b96ed8fc5
+  data.tar.gz: e573e3beaae1f23edb49cca2504e133dad770801fbe14e3e9c13ae7889ce482493597406de846443cd2ed5e78e5b6456550421e8d98c016a21f07c8c5c0af6c1

data/lib/ice_cube.rb

@@ -1,5 +1,8 @@
 require 'date'
 require 'ice_cube/deprecated'
+require 'ice_cube/i18n'
+
+IceCube::I18n.detect_backend!
 
 module IceCube
 
@@ -69,7 +72,7 @@ module IceCube
   # Defines the format used by IceCube when printing out Schedule#to_s.
   # Defaults to '%B %e, %Y'
   def self.to_s_time_format
-    @to_s_time_format ||= '%B %e, %Y'
+    IceCube::I18n.t("ice_cube.date.formats.default")
   end
 
   # Sets the format used by IceCube when printing out Schedule#to_s.

data/lib/ice_cube/builders/ical_builder.rb

@@ -32,15 +32,15 @@ module IceCube
 
     def self.ical_utc_format(time)
       time = time.dup.utc
-      "#{time.strftime('%Y%m%dT%H%M%SZ')}" # utc time
+      IceCube::I18n.l(time, format: '%Y%m%dT%H%M%SZ') # utc time
     end
 
     def self.ical_format(time, force_utc)
       time = time.dup.utc if force_utc
       if time.utc?
-        ":#{time.strftime('%Y%m%dT%H%M%SZ')}" # utc time
+        ":#{IceCube::I18n.l(time, format: '%Y%m%dT%H%M%SZ')}" # utc time
       else
-        ";TZID=#{time.strftime('%Z:%Y%m%dT%H%M%S')}" # local time specified
+        ";TZID=#{IceCube::I18n.l(time, format: '%Z:%Y%m%dT%H%M%S')}" # local time specified
       end
     end
 

data/lib/ice_cube/builders/string_builder.rb

@@ -13,14 +13,18 @@ module IceCube
     end
 
     def to_s
-      @types.each_with_object(@base || '') do |(type, segments), str|
+      string = @base || ''
+      @types.each do |type, segments|
         if f = self.class.formatter(type)
-          str << ' ' << f.call(segments)
+          current = f.call(segments)
         else
           next if segments.empty?
-          str << ' ' << self.class.sentence(segments)
+          current = self.class.sentence(segments)
         end
+        f = IceCube::I18n.t('ice_cube.string.format')[type] ? type : 'default'
+        string = IceCube::I18n.t("ice_cube.string.format.#{f}", rest: string, current: current)
       end
+      string
     end
 
     def self.formatter(type)
@@ -34,27 +38,33 @@ module IceCube
 
     module Helpers
 
-      NUMBER_SUFFIX = ['th', 'st', 'nd', 'rd', 'th', 'th', 'th', 'th', 'th', 'th']
-      SPECIAL_SUFFIX = { 11 => 'th', 12 => 'th', 13 => 'th', 14 => 'th' }
-
       # influenced by ActiveSupport's to_sentence
       def sentence(array)
         case array.length
         when 0 ; ''
         when 1 ; array[0].to_s
-        when 2 ; "#{array[0]} and #{array[1]}"
-        else ; "#{array[0...-1].join(', ')}, and #{array[-1]}"
+        when 2 ; "#{array[0]}#{IceCube::I18n.t('ice_cube.array.two_words_connector')}#{array[1]}"
+        else ; "#{array[0...-1].join(IceCube::I18n.t('ice_cube.array.words_connector'))}#{IceCube::I18n.t('ice_cube.array.last_word_connector')}#{array[-1]}"
         end
       end
 
       def nice_number(number)
-        return 'last' if number == -1
-        suffix = SPECIAL_SUFFIX[number] || NUMBER_SUFFIX[number.abs % 10]
-        if number < -1
-          number.abs.to_s << suffix << ' to last'
-        else
-          number.to_s << suffix
-        end
+        literal_ordinal(number) || ordinalize(number)
+      end
+
+      def ordinalize(number)
+        IceCube::I18n.t('ice_cube.integer.ordinal', number: number, ordinal: ordinal(number))
+      end
+
+      def literal_ordinal(number)
+        IceCube::I18n.t("ice_cube.integer.literal_ordinals")[number]
+      end
+
+      def ordinal(number)
+        ord = IceCube::I18n.t("ice_cube.integer.ordinals")[number] ||
+          IceCube::I18n.t("ice_cube.integer.ordinals")[number % 10] ||
+          IceCube::I18n.t('ice_cube.integer.ordinals')[:default]
+        number >= 0 ? ord : IceCube::I18n.t("ice_cube.integer.negative", ordinal: ord)
       end
 
     end

data/lib/ice_cube/i18n.rb

@@ -0,0 +1,24 @@
+module IceCube
+  module I18n
+    def self.t(*args)
+      backend.t(*args)
+    end
+
+    def self.l(*args)
+      backend.l(*args)
+    end
+
+    def self.backend
+      @backend
+    end
+
+    def self.detect_backend!
+      require 'i18n'
+      ::I18n.load_path += Dir[File.expand_path('../../../config/locales/*{rb,yml}', __FILE__)]
+      @backend = ::I18n
+    rescue LoadError
+      require 'ice_cube/null_i18n'
+      @backend = NullI18n
+    end
+  end
+end

data/lib/ice_cube/null_i18n.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+
+module IceCube
+  module NullI18n
+    def self.t(key, options = {})
+      base = key.to_s.split('.').reduce(config) { |hash, current_key| hash[current_key] }
+
+      base = base[options[:count] == 1 ? "one" : "other"] if options[:count]
+
+      if base.is_a?(Hash)
+        return base.each_with_object({}) do |(key, value), hash|
+          hash[key.is_a?(String) ? key.to_sym : key] = value
+        end
+      end
+
+      options.reduce(base) { |result, (find, replace)| result.gsub("%{#{find}}", "#{replace}") }
+    end
+
+    def self.l(date_or_time, options = {})
+      return date_or_time.strftime(options[:format]) if options[:format]
+      date_or_time.strftime(t('ice_cube.date.formats.default'))
+    end
+
+    def self.config
+      @config ||= YAML.load(File.read(File.join(File.dirname(__FILE__), '..', '..', 'config', 'locales', 'en.yml')))['en']
+    end
+  end
+end

data/lib/ice_cube/schedule.rb

@@ -313,11 +313,14 @@ module IceCube
     def to_s
       pieces = []
       rd = recurrence_times_with_start_time - extimes
-      pieces.concat rd.sort.map { |t| t.strftime(IceCube.to_s_time_format) }
+      pieces.concat rd.sort.map { |t| IceCube::I18n.l(t, format: IceCube.to_s_time_format) }
       pieces.concat rrules.map  { |t| t.to_s }
-      pieces.concat exrules.map { |t| "not #{t.to_s}" }
-      pieces.concat extimes.sort.map { |t| "not on #{t.strftime(IceCube.to_s_time_format)}" }
-      pieces.join(' / ')
+      pieces.concat exrules.map { |t| IceCube::I18n.t('ice_cube.not', target: t.to_s) }
+      pieces.concat extimes.sort.map { |t|
+        target = IceCube::I18n.l(t, format: IceCube.to_s_time_format)
+        IceCube::I18n.t('ice_cube.not_on', target: target)
+      }
+      pieces.join(IceCube::I18n.t('ice_cube.pieces_connector'))
     end
 
     # Serialize this schedule to_ical

data/lib/ice_cube/validations/count.rb

@@ -51,7 +51,7 @@ module IceCube
 
       StringBuilder.register_formatter(:count) do |segments|
         count = segments.first
-        "#{count} #{count == 1 ? 'time' : 'times'}"
+        IceCube::I18n.t('ice_cube.times', count: count)
       end
 
     end

data/lib/ice_cube/validations/daily_interval.rb

@@ -35,7 +35,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Daily' : "Every #{interval} days"
+        builder.base = IceCube::I18n.t('ice_cube.each_day', count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/day.rb

@@ -54,12 +54,13 @@ module IceCube
         validation_days.sort!
         # pick the right shortening, if applicable
         if validation_days == [0, 6]
-          'on Weekends'
+          IceCube::I18n.t('ice_cube.on_weekends')
         elsif validation_days == (1..5).to_a
-          'on Weekdays'
+          IceCube::I18n.t('ice_cube.on_weekdays')
         else
-          segments = validation_days.map { |d| "#{Date::DAYNAMES[d]}s" }
-          "on #{StringBuilder.sentence(segments)}"
+          day_names = ->(d){ "#{IceCube::I18n.t("ice_cube.days_on")[d]}" }
+          segments = validation_days.map(&day_names)
+          IceCube::I18n.t('ice_cube.on_days', days: StringBuilder.sentence(segments))
         end
       end
 

data/lib/ice_cube/validations/day_of_month.rb

@@ -43,9 +43,9 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:day_of_month) do |entries|
-        str = "on the #{StringBuilder.sentence(entries)} "
-        str << (entries.size == 1 ? 'day of the month' : 'days of the month')
-        str
+        sentence = StringBuilder.sentence(entries)
+        str = IceCube::I18n.t('ice_cube.days_of_month', count: entries.size, segments: sentence)
+        IceCube::I18n.t('ice_cube.on', sentence: str)
       end
 
     end

data/lib/ice_cube/validations/day_of_week.rb

@@ -45,7 +45,11 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.piece(:day_of_week) << "#{StringBuilder.nice_number(occ)} #{Date::DAYNAMES[day]}"
+        builder.piece(:day_of_week) << IceCube::I18n.t(
+          'ice_cube.days_of_week',
+          segments: StringBuilder.nice_number(occ),
+          day: IceCube::I18n.t('ice_cube.date.day_names')[day]
+        )
       end
 
       def build_hash(builder)
@@ -62,7 +66,8 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:day_of_week) do |segments|
-        'on the ' + segments.join(' and ')
+        sentence = segments.join(IceCube::I18n.t('ice_cube.array.two_words_connector'))
+        IceCube::I18n.t('ice_cube.on', sentence: sentence)
       end
 
     end

data/lib/ice_cube/validations/day_of_year.rb

@@ -49,9 +49,9 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:day_of_year) do |entries|
-        str = "on the #{StringBuilder.sentence(entries)} "
-        str << (entries.size == 1 ? 'day of the year' : 'days of the year')
-        str
+        str =  StringBuilder.sentence(entries)
+        sentence = IceCube::I18n.t('ice_cube.days_of_year', count: entries.size, segments: str)
+        IceCube::I18n.t('ice_cube.on', sentence: sentence)
       end
 
     end

data/lib/ice_cube/validations/hour_of_day.rb

@@ -44,8 +44,8 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:hour_of_day) do |segments|
-        str = "on the #{StringBuilder.sentence(segments)} "
-        str << (segments.size == 1 ? 'hour of the day' : 'hours of the day')
+        str = StringBuilder.sentence(segments)
+        IceCube::I18n.t('ice_cube.at_hours_of_the_day', count: segments.size, segments: str)
       end
 
     end

data/lib/ice_cube/validations/hourly_interval.rb

@@ -35,7 +35,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Hourly' : "Every #{interval} hours"
+        builder.base = IceCube::I18n.t("ice_cube.each_hour", count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/minute_of_hour.rb

@@ -43,8 +43,8 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:minute_of_hour) do |segments|
-        str = "on the #{StringBuilder.sentence(segments)} "
-        str << (segments.size == 1 ? 'minute of the hour' : 'minutes of the hour')
+        str = StringBuilder.sentence(segments)
+        IceCube::I18n.t('ice_cube.on_minutes_of_hour', count: segments.size, segments: str)
       end
 
     end

data/lib/ice_cube/validations/minutely_interval.rb

@@ -35,7 +35,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Minutely' : "Every #{interval} minutes"
+        builder.base = IceCube::I18n.t('ice_cube.each_minute', count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/month_of_year.rb

@@ -32,7 +32,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.piece(:month_of_year) << Date::MONTHNAMES[month]
+        builder.piece(:month_of_year) << IceCube::I18n.t("ice_cube.date.month_names")[month]
       end
 
       def build_hash(builder)
@@ -44,7 +44,7 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:month_of_year) do |segments|
-        "in #{StringBuilder.sentence(segments)}"
+        IceCube::I18n.t("ice_cube.in", target: StringBuilder.sentence(segments))
       end
 
     end

data/lib/ice_cube/validations/monthly_interval.rb

@@ -34,7 +34,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Monthly' : "Every #{interval} months"
+        builder.base = IceCube::I18n.t('ice_cube.each_month', count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/second_of_minute.rb

@@ -43,8 +43,8 @@ module IceCube
       end
 
       StringBuilder.register_formatter(:second_of_minute) do |segments|
-        str = "on the #{StringBuilder.sentence(segments)} "
-        str << (segments.size == 1 ? 'second of the minute' : 'seconds of the minute')
+        str = StringBuilder.sentence(segments)
+        IceCube::I18n.t('ice_cube.on_seconds_of_minute', count: segments.size, segments: str)
       end
 
     end

data/lib/ice_cube/validations/secondly_interval.rb

@@ -32,7 +32,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Secondly' : "Every #{interval} seconds"
+        builder.base = IceCube::I18n.t("ice_cube.each_second", count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/until.rb

@@ -38,7 +38,8 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.piece(:until) << "until #{time.strftime(IceCube.to_s_time_format)}"
+        date = IceCube::I18n.l(time, format: IceCube.to_s_time_format)
+        builder.piece(:until) << IceCube::I18n.t('ice_cube.until', date: date)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/weekly_interval.rb

@@ -44,7 +44,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Weekly' : "Every #{interval} weeks"
+        builder.base = IceCube::I18n.t('ice_cube.each_week', count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/validations/yearly_interval.rb

@@ -32,7 +32,7 @@ module IceCube
       end
 
       def build_s(builder)
-        builder.base = interval == 1 ? 'Yearly' : "Every #{interval} years"
+        builder.base = IceCube::I18n.t('ice_cube.each_year', count: interval)
       end
 
       def build_hash(builder)

data/lib/ice_cube/version.rb

@@ -1,5 +1,5 @@
 module IceCube
 
-  VERSION = '0.13.0'
+  VERSION = '0.13.1'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ice_cube
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - John Crepezzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: ice_cube is a recurring date library for Ruby.  It allows for quick,
   programatic expansion of recurring date rules.
 email: john@crepezzi.com
@@ -81,6 +95,8 @@ files:
 - lib/ice_cube/errors/count_exceeded.rb
 - lib/ice_cube/errors/until_exceeded.rb
 - lib/ice_cube/flexible_hash.rb
+- lib/ice_cube/i18n.rb
+- lib/ice_cube/null_i18n.rb
 - lib/ice_cube/occurrence.rb
 - lib/ice_cube/parsers/hash_parser.rb
 - lib/ice_cube/parsers/ical_parser.rb
@@ -139,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ice-cube
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby Date Recurrence Library