timely 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e311a6b7b3b8f1c2c118f67e3cddc6ef7592091514c64f99c7a8d1f46f617d7a
-  data.tar.gz: ae6d6fa3c929fe97a63ed3e907544e97cafb38d2dc768f95d5cea00057d07864
+  metadata.gz: 6fd5bf30099265da88c4957079fd58a4db290fac8cd4ad239ddb395be546d5d3
+  data.tar.gz: d263dca100292aae36f54b22cc2f3b1eebc1c1df0274fc3ef730ce991fc94c4a
 SHA512:
-  metadata.gz: 4f0f48ab52cb955cd0dcc13b89138cc72dc5b444f87589173d346595d822bb12c205a5c93a27c34e5a5ea765807d521931823bd331c4baefa30a48a34e516829
-  data.tar.gz: 7013bcafe2fbed12b92caf1fc9da3b07292050fd643cd05a975495674cf5fbd206c815a4d9e65dafbbc25d2af8fb0c646f40a4cf839e4e8a03c08b1b795ec5d6
+  metadata.gz: 784aede0c406afe8e0213f275150ee3bba930969c28acf9ac2e992a96ce42c7f30e042a6e0ae9779dc17f86e6a7744c4b0a07bf72e1d326d6e6176b3ac4b28c4
+  data.tar.gz: a780a85c02adcf074c53376c7995739d609329256b76c370966bedaccf953e0e3cb7607cb0d381873a8a4585b48505c8d2d04f68bebdc94f0b49c947bab84d28

data/.rubocop.yml

@@ -1,8 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - lib/timely/temporal_patterns/*.rb
+
 Metrics/LineLength:
-  Max: 80
+  Max: 200
 
 Style/Documentation:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
-  Enabled: false # Using Ruby 2.4 doesn't need it
+  Enabled: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -1,14 +1,8 @@
 language: ruby
 rvm:
-  - 2.4
-  - 2.5
   - 2.6
 matrix:
   fast_finish: true
-  exclude:
-    - rvm: 2.4
-      gemfile: gemfiles/rails6.gemfile
-
 before_install:
   - gem install bundler
 script: bundle exec rake spec

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.6.0
+
+* [TT-6402] Require date group weekdays bit field to be not null/nil
+            IMPORTANT: Rails projects must add a migration to make this field not null!
+* [TT-6401] Remove Rails 3 support, unused methods
+
 ## 0.5.0
 
 * [TT-6193] Date group scopes for more efficient searches/restrictions

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/Rakefile

@@ -1,12 +1,14 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 desc 'Default: run specs.'
-task :default => :spec
+task default: :spec
 
 require 'rspec/core/rake_task'
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.pattern = './spec/**/*_spec.rb' # don't need this, it's default.
   # Put spec opts in a file named .rspec in root
 end

data/gemfiles/rails5.gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
-gemspec :path => '../'
+gemspec path: '../'
 
 group :development, :test do
-  gem 'activerecord', '~> 5.0'
+  gem 'activerecord', '~> 5.2'
 end

data/gemfiles/rails6.gemfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
-gemspec :path => '../'
+gemspec path: '../'
 
 group :development, :test do
   gem 'activerecord', '~> 6.0.0.rc1'

data/lib/timely/date.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 module Timely
   module Date
     def at_time(hour = nil, minute = nil, second = nil)
       if hour.is_a?(::Time)
         time = hour
-        hour, minute, second = time.hour, time.min, time.sec
+        hour = time.hour
+        minute = time.min
+        second = time.sec
       end
 
       ::Time.local(year, month, day, hour, minute, second)
     end
 
-    alias_method :at, :at_time
+    alias at at_time
 
     # returns true if date between from and to
     # however if from and/or to are nil, it ignores that query

data/lib/timely/date_chooser.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module Timely
   class DateChooser
     # Where is this used... so far only in one place, _date_range.html.haml
     # May be good to refactor this as well, after the class behaviour is refactored.
     INTERVALS = [
-      {:code => 'week', :name => 'week(s)', :description =>
-          'Weekdays selected will be chosen every {{n}} weeks for the date range'},
-      {:code => 'week_of_month', :name => 'week of month', :description =>
-          'Weekdays selected will be chosen in their {{ord}} occurance every month,
+      { code: 'week', name: 'week(s)', description: 'Weekdays selected will be chosen every {{n}} weeks for the date range' },
+      { code: 'week_of_month', name: 'week of month', description:           'Weekdays selected will be chosen in their {{ord}} occurance every month,
           e.g. if wednesday and thursday are selected, the first wednesday and
           first thursday are selected. Note: this may mean the booking is copied
-          to Thursday 1st and Wednesday 7th'}
-    ]
+          to Thursday 1st and Wednesday 7th' }
+    ].freeze
 
-    attr_accessor  :multiple_dates, :from, :to, :select, :dates, :interval, :weekdays
+    attr_accessor :multiple_dates, :from, :to, :select, :dates, :interval, :weekdays
 
     def initialize(options)
       @multiple_dates = options[:multiple_dates] || false
@@ -28,8 +28,8 @@ module Timely
 
     def process_date(date)
       case date
-      when Date; date
-      when NilClass; nil
+      when Date then date
+      when NilClass then nil
       when String
         date !~ /[^[:space:]]/ ? nil : date.to_date
       end
@@ -53,7 +53,7 @@ module Timely
     #          so every friday and saturday each fornight
     def choose_dates
       # Not multiple dates - just return the From date.
-      return [@from] if !@multiple_dates
+      return [@from] unless @multiple_dates
 
       # Multiple dates - return the array, adjusted as per input
       all_days = (@from..@to).to_a
@@ -66,21 +66,21 @@ module Timely
         days = @specific_dates.gsub(/\s/, '').split(',')
         days.map(&:to_date)
       when 'weekdays'
-        raise DateChooserException, "No days of the week selected" if @weekdays.weekdays.empty?
-        raise DateChooserException, "No weekly interval selected" if @interval && @interval.empty?
+        raise DateChooserException, 'No days of the week selected' if @weekdays.weekdays.empty?
+        raise DateChooserException, 'No weekly interval selected' if @interval&.empty?
 
         all_days.select do |date|
-          if @weekdays.has_day?(date.wday)
-            case @interval[:unit]
-            when 'week'
-              # 0 = first week, 1 = second week, 2 = third week, etc.
-              nth_week = (date - @from).to_i / 7
-              # true every 2nd week (0, 2, 4, 6, etc.)
-              (nth_week % @interval[:level].to_i).zero?
-            when 'week_of_month'
-              week = @interval[:level].to_i
-              (date.mday > (week-1)*7 && date.mday <= week*7)
-            end
+          next unless @weekdays.has_day?(date.wday)
+
+          case @interval[:unit]
+          when 'week'
+            # 0 = first week, 1 = second week, 2 = third week, etc.
+            nth_week = (date - @from).to_i / 7
+            # true every 2nd week (0, 2, 4, 6, etc.)
+            (nth_week % @interval[:level].to_i).zero?
+          when 'week_of_month'
+            week = @interval[:level].to_i
+            (date.mday > (week - 1) * 7 && date.mday <= week * 7)
           end
         end
       else
@@ -89,15 +89,14 @@ module Timely
     end
 
     private
+
     def validate
-      if !@from
-        raise DateChooserException, "A Start Date is required"
-      elsif @multiple_dates
-        @to ||= @from
-        raise DateChooserException, "Start Date is after End Date" if @from > @to
-      end
+      raise DateChooserException, 'A Start Date is required' unless @from
+      raise DateChooserException, 'Start Date is after End Date' if @multiple_dates && @to && @from > @to
+
+      @to ||= @from if @multiple_dates
     end
   end
 
-  class DateChooserException < Exception; end
+  class DateChooserException < RuntimeError; end
 end

data/lib/timely/date_range.rb

@@ -1,4 +1,4 @@
-require 'date' # Ensure Date class is loaded for old rubies (1.8)
+# frozen_string_literal: true
 
 module Timely
   class DateRange < ::Range
@@ -15,14 +15,14 @@ module Timely
         super(args.first.to_date, args.last.to_date)
       end
     end
-    alias_method :start_date, :first
-    alias_method :end_date, :last
+    alias start_date first
+    alias end_date last
 
     def self.validate_range(first, last)
-      raise ArgumentError, "Date range missing start date" if first.nil?
-      raise ArgumentError, "Date range missing end date" if last.nil?
-      raise ArgumentError, "Start date is not a date" unless first.is_a? Date
-      raise ArgumentError, "End date is not a date" unless last.is_a? Date
+      raise ArgumentError, 'Date range missing start date' if first.nil?
+      raise ArgumentError, 'Date range missing end date' if last.nil?
+      raise ArgumentError, 'Start date is not a date' unless first.is_a? Date
+      raise ArgumentError, 'End date is not a date' unless last.is_a? Date
     end
 
     def self.from_params(start_date, duration = nil)
@@ -33,19 +33,18 @@ module Timely
     end
 
     def intersecting_dates(date_range)
-      start_of_intersection = [self.start_date, date_range.first].max
-      end_of_intersection = [self.end_date, date_range.last].min
-      intersection = if end_of_intersection >= start_of_intersection
-        (start_of_intersection..end_of_intersection)
-      else
-        []
-      end
+      r_start = [start_date, date_range.first].max
+      r_end = [end_date, date_range.last].min
+
+      return [] if r_end < r_start
+
+      r_start..r_end
     end
 
     def number_of_nights
       ((last - first) + 1).to_i
     end
-    alias_method :duration, :number_of_nights
+    alias duration number_of_nights
 
     def to_s(fmt = '%b %Y', date_fmt = '%Y-%m-%d')
       Timely::DateRange.to_s(first, last, fmt, date_fmt)
@@ -65,21 +64,20 @@ module Timely
             "#{first.strftime(month_fmt)} to #{last.strftime(month_fmt)}"
           end
         else
-          "#{first.strftime(fmt)} to #{last.strftime(fmt)}#{" (inclusive)" if is_date}"
+          "#{first.strftime(fmt)} to #{last.strftime(fmt)}#{' (inclusive)' if is_date}"
         end
       elsif first
         "on or after #{first.strftime(fmt)}"
       elsif last
         "on or before #{last.strftime(fmt)}"
       else
-        "no date range"
+        'no date range'
       end
     end
 
-
     private
 
-    def self.default_date_format
+    private_class_method def self.default_date_format
       # ::Date as we want Ruby's Date not Timely::Date
       date_format = ::Date::DATE_FORMATS[:short] if ::Date.const_defined?('DATE_FORMATS')
       date_format || '%Y-%m-%d'

data/lib/timely/date_time.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Timely
   module DateTime
     def on_date(date)
-      self.change(:year => date.year, :month => date.month, :day => date.day)
+      change(year: date.year, month: date.month, day: date.day)
     end
   end
 end

data/lib/timely/rails/calendar_tag.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module Timely
   # Uses Date.current to be more accurate for Rails applications
   def self.current_date
     ::Date.respond_to?(:current) ? ::Date.current : ::Date.today
   end
 
-
   module ActionViewHelpers
     module FormTagHelper
       def calendar_tag(name, value = Timely.current_date, *args)
@@ -24,11 +25,10 @@ module Timely
         options[:size] ||= 10
         options[:maxlength] ||= 10
 
-        tag(:input, options.merge(:name => name, :type => 'text', :value => value)).html_safe
+        tag(:input, options.merge(name: name, type: 'text', value: value)).html_safe
       end
     end
 
-
     module DateHelper
       def calendar(object_name, method, options = {})
         value = options[:object] || Timely.current_date

data/lib/timely/rails/date.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class Date
   def to_time_in_time_zone
-    (Time.zone || ActiveSupport::TimeZone["UTC"]).local(self.year, self.month, self.day)
+    (Time.zone || ActiveSupport::TimeZone['UTC']).local(year, month, day)
   end
 end

data/lib/timely/rails/date_group.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Timely
   class DateGroup < ActiveRecord::Base
-    belongs_to :season, :class_name => 'Timely::Season', optional: true
+    belongs_to :season, class_name: 'Timely::Season', optional: true, inverse_of: :date_groups
 
     weekdays_field :weekdays
 
+    validates :weekdays_bit_array, presence: true
     validates_presence_of :start_date, :end_date
     validate :validate_date_range!
 
@@ -16,16 +19,12 @@ module Timely
       # IMPORTANT: Required for correctness in case of string param.
       dates = Array(date_range)
       scope = covering_date(dates.first)
-      if dates.first != dates.last
-        scope = scope.or(covering_date(dates.last))
-      end
+      scope = scope.or(covering_date(dates.last)) if dates.first != dates.last
       scope
     }
 
     scope :for_any_weekdays, lambda { |weekdays_int|
-      weekdays_int = weekdays_int.to_i
-      where((arel_table[:weekdays_bit_array] & weekdays_int).not_eq(0))
-      .or(where(weekdays_bit_array: nil))
+      where((arel_table[:weekdays_bit_array] & weekdays_int.to_i).not_eq(0))
     }
 
     scope :applying_for_duration, lambda { |date_range|
@@ -43,7 +42,7 @@ module Timely
       elsif weekdays.all_days?
         true
       else
-        date_range.intersecting_dates(start_date..end_date).any?{|d| weekdays.applies_for_date?(d)}
+        date_range.intersecting_dates(start_date..end_date).any? { |d| weekdays.applies_for_date?(d) }
       end
     end
 
@@ -70,30 +69,31 @@ module Timely
       date_groups = []
       Array.wrap(patterns).each do |pattern|
         if pattern.frequency.unit == :weeks
-          weekdays = pattern.intervals.map { |i| i.first_datetime.wday }.inject({}) do |hash, wday|
+          weekdays = pattern.intervals.map { |i| i.first_datetime.wday }.each_with_object({}) do |wday, hash|
             hash[wday] = 1
-            hash
           end
           date_groups << DateGroup.new(
-            :start_date => pattern.first_datetime.to_date,
-            :end_date => pattern.last_datetime.to_date,
-            :weekdays => weekdays)
+            start_date: pattern.first_datetime.to_date,
+            end_date: pattern.last_datetime.to_date,
+            weekdays: weekdays
+          )
         elsif pattern.frequency.unit == :days && pattern.frequency.duration == 1.day
           date_groups << DateGroup.new(
-            :start_date => pattern.first_datetime.to_date,
-            :end_date => pattern.last_datetime.to_date,
-            :weekdays => 127)
+            start_date: pattern.first_datetime.to_date,
+            end_date: pattern.last_datetime.to_date,
+            weekdays: 127
+          )
         else
           pattern.datetimes.each do |datetimes|
             datetimes.group_by(&:week).values.each do |dates|
-              weekdays = dates.map(&:wday).inject({}) do |hash, wday|
+              weekdays = dates.map(&:wday).each_with_object({}) do |wday, hash|
                 hash[wday] = 1
-                hash
               end
               date_groups << DateGroup.new(
-                :start_date => dates.min.to_date.beginning_of_week,
-                :end_date => dates.max.to_date.end_of_week,
-                :weekdays => weekdays)
+                start_date: dates.min.to_date.beginning_of_week,
+                end_date: dates.max.to_date.end_of_week,
+                weekdays: weekdays
+              )
             end
           end
         end
@@ -104,9 +104,9 @@ module Timely
     private
 
     def validate_date_range!
-      if start_date && end_date && (start_date > end_date)
-        raise ArgumentError, "Incorrect date range #{start_date} is before #{end_date}"
-      end
+      return unless start_date && end_date && start_date > end_date
+
+      raise ArgumentError, "Incorrect date range #{start_date} is before #{end_date}"
     end
   end
 end

data/lib/timely/rails/date_range_validity_module.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 module Timely
   module DateRangeValidityModule
     def self.included(base)
       base.class_eval do
-        validates :from, :to, :presence => true
+        validates :from, :to, presence: true
       end
     end
 
     def validity_range
-      (from .. to)
+      (from..to)
     end
 
     def correctness_of_date_range
-      if (from.present? && to.present?)
-        errors.add(:base, "Invalid Date Range. From date should be less than or equal to To date") if from > to
-      end
+      return unless from.present? && to.present? && from > to
+
+      errors.add(:base, 'Invalid Date Range. From date should be less than or equal to To date')
     end
 
     def validity_range_to_s
       "#{from.to_s(:short)} ~ #{to.to_s(:short)}"
     end
-    
+
     def valid_on?(date)
       validity_range.include?(date)
     end

data/lib/timely/rails/date_time.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsCoreExtensions
   module DateTime
     def advance_considering_calendar(units, num_units)
@@ -5,11 +7,11 @@ module RailsCoreExtensions
       when :seconds, :minutes, :hours, :days, :weeks, :months, :years
         advance(units => num_units)
       when :calendar_days
-        advance(:days => num_units - 1).end_of_day
+        advance(days: num_units - 1).end_of_day
       when :calendar_months
-        advance(:months => num_units - 1).end_of_month
+        advance(months: num_units - 1).end_of_month
       when :calendar_years
-        advance(:years => num_units - 1).end_of_year
+        advance(years: num_units - 1).end_of_year
       end
     end
   end

data/lib/timely/rails/extensions.rb

@@ -1,55 +1,30 @@
+# frozen_string_literal: true
+
 module Timely
   module Extensions
     # Add a WeekDays attribute
     #
     # By default it will use attribute_bit_array as db field, but this can
     # be overridden by specifying :db_field => 'somthing_else'
-    def weekdays_field(attribute, options={})
+    def weekdays_field(attribute, options = {})
       db_field = options[:db_field] || attribute.to_s + '_bit_array'
-      self.composed_of(attribute,
-        :class_name => "::Timely::WeekDays",
-        :mapping    => [[db_field, 'weekdays_int']],
-        :converter  => Proc.new {|field| ::Timely::WeekDays.new(field)}
-      )
+      composed_of(attribute,
+                  class_name: '::Timely::WeekDays',
+                  mapping: [[db_field, 'weekdays_int']],
+                  converter: proc { |field| ::Timely::WeekDays.new(field) })
     end
 
     def acts_as_seasonal
-      belongs_to :season, :class_name => 'Timely::Season', optional: true
+      belongs_to :season, class_name: 'Timely::Season', optional: true
       accepts_nested_attributes_for :season
       validates_associated :season
 
-      if ::ActiveRecord::VERSION::MAJOR >= 3
-        scope :season_on, lambda { |*args|
-          date = args.first || ::Date.current # Can't assign in block in Ruby 1.8
-          joins(:season => :date_groups).where("date_groups.start_date <= ? AND date_groups.end_date >= ?", date, date)
-        }
-
-        scope :available_from, lambda { |*args|
-          date = args.first || ::Date.current # Can't assign in block in Ruby 1.8
-          where("boundary_end >= ?", date)
-        }
-      else
-        named_scope :season_on, lambda { |*args|
-          date = args.first || ::Date.current # Can't assign in block in Ruby 1.8
-          {
-            :joins => {:season => :date_groups},
-            :conditions => ["date_groups.start_date <= ? AND date_groups.end_date >= ?", date, date]
-          }
-        }
-
-        named_scope :available_from, lambda { |*args|
-          date = args.first || ::Date.current # Can't assign in block in Ruby 1.8
-          {:conditions => ["boundary_end >= ?", date]}
-        }
-      end
-
       before_save do |object|
-        if object.season
-          object.boundary_start = object.season.boundary_start
-          object.boundary_end   = object.season.boundary_end
-        end
+        next unless object.season
+
+        object.boundary_start = object.season.boundary_start
+        object.boundary_end   = object.season.boundary_end
       end
     end
   end
 end
-

data/lib/timely/rails/period.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Timely
   class Period
     attr_reader :number, :units
 
-    UNITS = [
-      :seconds,
-      :minutes,
-      :hours,
-      :days,
-      :weeks,
-      :months,
-      :years,
-      :calendar_days,
-      :calendar_months,
-      :calendar_years
-    ]
+    UNITS = %i[
+      seconds
+      minutes
+      hours
+      days
+      weeks
+      months
+      years
+      calendar_days
+      calendar_months
+      calendar_years
+    ].freeze
 
     def initialize(number, units)
       @number = number