Merge pull request #503 from seejohnrun/install-standard

Install standard

Author: seejohnrun

.standard_todo.yml

@@ -0,0 +1,12 @@
+# Auto generated files with errors to ignore.
+# Remove from this list as you refactor files.
+---
+ignore:
+- lib/ice_cube/parsers/yaml_parser.rb:
+  - Security/YAMLLoad
+- lib/ice_cube/rule.rb:
+  - Security/YAMLLoad
+- spec/examples/serialization_spec.rb:
+  - Security/YAMLLoad
+- spec/examples/to_yaml_spec.rb:
+  - Security/YAMLLoad

Gemfile

@@ -1,11 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 compatible_rails_versions = [
-  '>= 3.0.0',
-  ('<5' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2'))
+  ">= 3.0.0",
+  ("<5" if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2"))
 ].compact
 
-gem 'activesupport', (ENV['RAILS_VERSION'] || compatible_rails_versions), require: false
-gem 'i18n', require: false
-gem 'tzinfo', require: false # only needed explicitly for RAILS_VERSION=3
+gem "activesupport", (ENV["RAILS_VERSION"] || compatible_rails_versions), require: false
+gem "i18n", require: false
+gem "tzinfo", require: false # only needed explicitly for RAILS_VERSION=3

README.md

@@ -2,6 +2,7 @@
 
 [![Tests](https://github.com/seejohnrun/ice_cube/workflows/Tests/badge.svg)](https://github.com/seejohnrun/ice_cube/actions?query=workflow%3ATests)
 [![Gem Version](https://badge.fury.io/rb/ice_cube.svg)](http://badge.fury.io/rb/ice_cube)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 ```bash
 gem install ice_cube

Rakefile

@@ -1,6 +1,7 @@
 require "rspec/core/rake_task"
 require "bundler/gem_tasks"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
-task :build => :spec
-task :default => :spec
+task build: :spec
+task default: :spec

ice_cube.gemspec

@@ -1,23 +1,23 @@
-# encoding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ice_cube/version'
+require "ice_cube/version"
 
 Gem::Specification.new do |s|
-  s.name          = 'ice_cube'
-  s.summary       = 'Ruby Date Recurrence Library'
-  s.description   = 'ice_cube is a recurring date library for Ruby.  It allows for quick, programatic expansion of recurring date rules.'
-  s.author        = 'John Crepezzi'
-  s.email         = '[email protected]'
-  s.homepage      = 'http://seejohnrun.github.com/ice_cube/'
-  s.license       = 'MIT'
+  s.name = "ice_cube"
+  s.summary = "Ruby Date Recurrence Library"
+  s.description = "ice_cube is a recurring date library for Ruby.  It allows for quick, programatic expansion of recurring date rules."
+  s.author = "John Crepezzi"
+  s.email = "[email protected]"
+  s.homepage = "http://seejohnrun.github.com/ice_cube/"
+  s.license = "MIT"
 
-  s.version       = IceCube::VERSION
-  s.platform      = Gem::Platform::RUBY
-  s.files         = Dir['lib/**/*.rb', 'config/**/*.yml']
-  s.test_files    = Dir.glob('spec/*.rb')
-  s.require_paths = ['lib']
+  s.version = IceCube::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.files = Dir["lib/**/*.rb", "config/**/*.yml"]
+  s.test_files = Dir.glob("spec/*.rb")
+  s.require_paths = ["lib"]
 
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec', '> 3')
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec", "> 3")
+  s.add_development_dependency("standard")
 end

lib/ice_cube.rb

@@ -1,71 +1,70 @@
-require 'date'
-require 'ice_cube/deprecated'
+require "date"
+require "ice_cube/deprecated"
 
 module IceCube
+  autoload :VERSION, "ice_cube/version"
 
-  autoload :VERSION, 'ice_cube/version'
+  autoload :TimeUtil, "ice_cube/time_util"
+  autoload :FlexibleHash, "ice_cube/flexible_hash"
+  autoload :I18n, "ice_cube/i18n"
 
-  autoload :TimeUtil, 'ice_cube/time_util'
-  autoload :FlexibleHash, 'ice_cube/flexible_hash'
-  autoload :I18n, 'ice_cube/i18n'
+  autoload :Rule, "ice_cube/rule"
+  autoload :Schedule, "ice_cube/schedule"
+  autoload :Occurrence, "ice_cube/occurrence"
 
-  autoload :Rule, 'ice_cube/rule'
-  autoload :Schedule, 'ice_cube/schedule'
-  autoload :Occurrence, 'ice_cube/occurrence'
+  autoload :IcalBuilder, "ice_cube/builders/ical_builder"
+  autoload :HashBuilder, "ice_cube/builders/hash_builder"
+  autoload :StringBuilder, "ice_cube/builders/string_builder"
 
-  autoload :IcalBuilder, 'ice_cube/builders/ical_builder'
-  autoload :HashBuilder, 'ice_cube/builders/hash_builder'
-  autoload :StringBuilder, 'ice_cube/builders/string_builder'
+  autoload :HashParser, "ice_cube/parsers/hash_parser"
+  autoload :YamlParser, "ice_cube/parsers/yaml_parser"
+  autoload :IcalParser, "ice_cube/parsers/ical_parser"
 
-  autoload :HashParser, 'ice_cube/parsers/hash_parser'
-  autoload :YamlParser, 'ice_cube/parsers/yaml_parser'
-  autoload :IcalParser, 'ice_cube/parsers/ical_parser'
+  autoload :CountExceeded, "ice_cube/errors/count_exceeded"
+  autoload :UntilExceeded, "ice_cube/errors/until_exceeded"
 
-  autoload :CountExceeded, 'ice_cube/errors/count_exceeded'
-  autoload :UntilExceeded, 'ice_cube/errors/until_exceeded'
+  autoload :ValidatedRule, "ice_cube/validated_rule"
+  autoload :SingleOccurrenceRule, "ice_cube/single_occurrence_rule"
 
-  autoload :ValidatedRule, 'ice_cube/validated_rule'
-  autoload :SingleOccurrenceRule, 'ice_cube/single_occurrence_rule'
-
-  autoload :SecondlyRule, 'ice_cube/rules/secondly_rule'
-  autoload :MinutelyRule, 'ice_cube/rules/minutely_rule'
-  autoload :HourlyRule, 'ice_cube/rules/hourly_rule'
-  autoload :DailyRule, 'ice_cube/rules/daily_rule'
-  autoload :WeeklyRule, 'ice_cube/rules/weekly_rule'
-  autoload :MonthlyRule, 'ice_cube/rules/monthly_rule'
-  autoload :YearlyRule, 'ice_cube/rules/yearly_rule'
+  autoload :SecondlyRule, "ice_cube/rules/secondly_rule"
+  autoload :MinutelyRule, "ice_cube/rules/minutely_rule"
+  autoload :HourlyRule, "ice_cube/rules/hourly_rule"
+  autoload :DailyRule, "ice_cube/rules/daily_rule"
+  autoload :WeeklyRule, "ice_cube/rules/weekly_rule"
+  autoload :MonthlyRule, "ice_cube/rules/monthly_rule"
+  autoload :YearlyRule, "ice_cube/rules/yearly_rule"
 
   module Validations
-    autoload :FixedValue, 'ice_cube/validations/fixed_value'
-    autoload :ScheduleLock, 'ice_cube/validations/schedule_lock'
-
-    autoload :Count, 'ice_cube/validations/count'
-    autoload :Until, 'ice_cube/validations/until'
-
-    autoload :SecondlyInterval, 'ice_cube/validations/secondly_interval'
-    autoload :MinutelyInterval, 'ice_cube/validations/minutely_interval'
-    autoload :DailyInterval, 'ice_cube/validations/daily_interval'
-    autoload :WeeklyInterval, 'ice_cube/validations/weekly_interval'
-    autoload :MonthlyInterval, 'ice_cube/validations/monthly_interval'
-    autoload :YearlyInterval, 'ice_cube/validations/yearly_interval'
-    autoload :HourlyInterval, 'ice_cube/validations/hourly_interval'
-
-    autoload :HourOfDay, 'ice_cube/validations/hour_of_day'
-    autoload :MonthOfYear, 'ice_cube/validations/month_of_year'
-    autoload :MinuteOfHour, 'ice_cube/validations/minute_of_hour'
-    autoload :SecondOfMinute, 'ice_cube/validations/second_of_minute'
-    autoload :DayOfMonth, 'ice_cube/validations/day_of_month'
-    autoload :DayOfWeek, 'ice_cube/validations/day_of_week'
-    autoload :Day, 'ice_cube/validations/day'
-    autoload :DayOfYear, 'ice_cube/validations/day_of_year'
+    autoload :FixedValue, "ice_cube/validations/fixed_value"
+    autoload :ScheduleLock, "ice_cube/validations/schedule_lock"
+
+    autoload :Count, "ice_cube/validations/count"
+    autoload :Until, "ice_cube/validations/until"
+
+    autoload :SecondlyInterval, "ice_cube/validations/secondly_interval"
+    autoload :MinutelyInterval, "ice_cube/validations/minutely_interval"
+    autoload :DailyInterval, "ice_cube/validations/daily_interval"
+    autoload :WeeklyInterval, "ice_cube/validations/weekly_interval"
+    autoload :MonthlyInterval, "ice_cube/validations/monthly_interval"
+    autoload :YearlyInterval, "ice_cube/validations/yearly_interval"
+    autoload :HourlyInterval, "ice_cube/validations/hourly_interval"
+
+    autoload :HourOfDay, "ice_cube/validations/hour_of_day"
+    autoload :MonthOfYear, "ice_cube/validations/month_of_year"
+    autoload :MinuteOfHour, "ice_cube/validations/minute_of_hour"
+    autoload :SecondOfMinute, "ice_cube/validations/second_of_minute"
+    autoload :DayOfMonth, "ice_cube/validations/day_of_month"
+    autoload :DayOfWeek, "ice_cube/validations/day_of_week"
+    autoload :Day, "ice_cube/validations/day"
+    autoload :DayOfYear, "ice_cube/validations/day_of_year"
   end
 
   # Define some useful constants
   ONE_SECOND = 1
   ONE_MINUTE = ONE_SECOND * 60
-  ONE_HOUR =   ONE_MINUTE * 60
-  ONE_DAY =    ONE_HOUR   * 24
-  ONE_WEEK =   ONE_DAY    * 7
+  ONE_HOUR = ONE_MINUTE * 60
+  ONE_DAY = ONE_HOUR * 24
+  ONE_WEEK = ONE_DAY * 7
 
   # Defines the format used by IceCube when printing out Schedule#to_s.
   # Defaults to '%B %e, %Y'

lib/ice_cube/builders/hash_builder.rb

@@ -1,9 +1,7 @@
 module IceCube
-
   class HashBuilder
-
     def initialize(rule = nil)
-      @hash = { :validations => {}, :rule_type => rule.class.name }
+      @hash = {validations: {}, rule_type: rule.class.name}
     end
 
     def validations
@@ -21,7 +19,5 @@ def validations_array(type)
     def to_hash
       @hash
     end
-
   end
-
 end

lib/ice_cube/builders/ical_builder.rb

@@ -1,8 +1,6 @@
 module IceCube
-
   class IcalBuilder
-
-    ICAL_DAYS = ['SU', 'MO', 'TU', 'WE', 'TH', 'FR', 'SA']
+    ICAL_DAYS = ["SU", "MO", "TU", "WE", "TH", "FR", "SA"]
 
     def initialize
       @hash = {}
@@ -19,41 +17,41 @@ def [](key)
     # Build for a single rule entry
     def to_s
       arr = []
-      if freq = @hash.delete('FREQ')
-        arr << "FREQ=#{freq.join(',')}"
+      if (freq = @hash.delete("FREQ"))
+        arr << "FREQ=#{freq.join(",")}"
       end
       arr.concat(@hash.map do |key, value|
         if value.is_a?(Array)
-          "#{key}=#{value.join(',')}"
+          "#{key}=#{value.join(",")}"
         end
       end.compact)
-      arr.join(';')
+      arr.join(";")
     end
 
     def self.ical_utc_format(time)
       time = time.dup.utc
-      IceCube::I18n.l(time, format: '%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?
-        ":#{IceCube::I18n.l(time, format: '%Y%m%dT%H%M%SZ')}" # utc time
+        ":#{IceCube::I18n.l(time, format: "%Y%m%dT%H%M%SZ")}" # utc time
       else
-        ";TZID=#{IceCube::I18n.l(time, format: '%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
 
     def self.ical_duration(duration)
-      hours = duration / 3600; duration %= 3600
-      minutes = duration / 60; duration %= 60
-      repr = ''
+      hours = duration / 3600
+      duration %= 3600
+      minutes = duration / 60
+      duration %= 60
+      repr = ""
       repr << "#{hours}H" if hours > 0
       repr << "#{minutes}M" if minutes > 0
       repr << "#{duration}S" if duration > 0
       "PT#{repr}"
     end
-
   end
-
 end

lib/ice_cube/builders/string_builder.rb

@@ -1,7 +1,5 @@
 module IceCube
-
   class StringBuilder
-
     attr_writer :base
 
     def initialize
@@ -13,15 +11,15 @@ def piece(type, prefix = nil, suffix = nil)
     end
 
     def to_s
-      string = @base || ''
+      string = @base || ""
       @types.each do |type, segments|
-        if f = self.class.formatter(type)
+        if (f = self.class.formatter(type))
           current = f.call(segments)
         else
           next if segments.empty?
           current = self.class.sentence(segments)
         end
-        f = IceCube::I18n.t('ice_cube.string.format')[type] ? type : 'default'
+        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
@@ -37,14 +35,13 @@ def self.register_formatter(type, &formatter)
     end
 
     module Helpers
-
       # influenced by ActiveSupport's to_sentence
       def sentence(array)
         case array.length
-        when 0 ; ''
-        when 1 ; array[0].to_s
-        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]}"
+        when 0 then ""
+        when 1 then array[0].to_s
+        when 2 then "#{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
 
@@ -53,7 +50,7 @@ def nice_number(number)
       end
 
       def ordinalize(number)
-        IceCube::I18n.t('ice_cube.integer.ordinal', number: number, ordinal: ordinal(number))
+        IceCube::I18n.t("ice_cube.integer.ordinal", number: number, ordinal: ordinal(number))
       end
 
       def literal_ordinal(number)
@@ -63,14 +60,11 @@ def literal_ordinal(number)
       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]
+          IceCube::I18n.t("ice_cube.integer.ordinals")[:default]
         number >= 0 ? ord : IceCube::I18n.t("ice_cube.integer.negative", ordinal: ord)
       end
-
     end
 
     extend Helpers
-
   end
-
 end

lib/ice_cube/deprecated.rb

@@ -1,13 +1,12 @@
 module IceCube
   module Deprecated
-
     # Define a deprecated alias for a method
     # @param [Symbol] name - name of method to define
     # @param [Symbol] replacement - name of method to replace (alias)
     def deprecated_alias(name, replacement)
       # Create a wrapped version
       define_method(name) do |*args, &block|
-        warn "IceCube: #{self.class}##{name} is deprecated (use #{replacement})", caller[0]
+        warn "IceCube: #{self.class}##{name} is deprecated (use #{replacement})", caller(1..1).first
         send replacement, *args, &block
       end
     end
@@ -21,15 +20,15 @@ def deprecated(name, replacement)
       alias_method old_name, name
       # And replace it with a wrapped version
       define_method(name) do |*args, &block|
-        warn "IceCube: #{self.class}##{name} is deprecated (use #{replacement})", caller[0]
+        warn "IceCube: #{self.class}##{name} is deprecated (use #{replacement})", caller(1..1).first
         send old_name, *args, &block
       end
     end
 
     def self.schedule_options(schedule, options)
       if options[:start_date_override]
         warn "IceCube: :start_date_override option is deprecated " \
-             "(use a block: `{|s| s.start_time = override }`)", caller[0]
+             "(use a block: `{|s| s.start_time = override }`)", caller(1..1).first
         schedule.start_time = options[:start_date_override]
       end
     end