timely 0.4.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad5b5230c51dc3ab72192b82882b333fe9fc72b49fb2e8324881e7a6b7fd269
-  data.tar.gz: 1de47a9da2ee6f3708c049f85fed2654e7ec4900935056f80dbe42db2842cf7b
+  metadata.gz: 5aeec444ee90189672055555263e90807c7f2bad4e366c5e44d74dd4d578cd30
+  data.tar.gz: e5bf46db86fee6448233e03aaba2dfe7dc7f66771f6d82c30db2e231e03b48b9
 SHA512:
-  metadata.gz: 8d9bde900b4005fdcf26cc826e53858eb47067f6ccd6e01c633861efb305970d37ceddfd7bc1d70b2c68bae1a53abccc178ca1b95f20fc5ae5032cc8ef0e3e11
-  data.tar.gz: 8d1145ecf55ee9deb075d459e9f2399ec28bf0da6519f60b47cf1fddd679312383c6df4d9e83d8f6222e2aa89c7791b25927efb1705260e880ad54682b4b8037
+  metadata.gz: a47c451934a28dda82fae5eb78145791b5d8727e371683f506ade5f3ee4f609167bf5bec209c1dd545ae8399fa82df22ec994903df4c000c36b844b8c42255f3
+  data.tar.gz: bc96a85cae09b52d5381a915847c1f76df9613592e632403ca1d69dca74486f7d7bf464b5777d850bb88689cba0ded45101c49503470f2c0e8242d3f09a1f420

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rake
+
+  release:
+    needs: build
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Generate Changelog
+        run: |
+          # Get version from github ref (remove 'refs/tags/' and prefix 'v')
+          version="${GITHUB_REF#refs/tags/v}"
+          npx changelog-parser CHANGELOG.md | jq -cr ".versions | .[] | select(.version == \"$version\") | .body" > ${{ github.workflow }}-CHANGELOG.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: ${{ github.workflow }}-CHANGELOG.txt
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: [build, release]
+    name: Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,19 @@
+name: Build and Test
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: [rails60, rails61]
+        ruby: ["2.6", "2.7", "3.0"]
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

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/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.0.0

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.9.0
+
+* [TT-8614] Update to build with github actions / ruby 3.0 / rails 6.1
+
+## 0.8.0
+
+* [TT-6441] Turns out we don't actually need time difference in QT
+* [TT-6661] Fix issue when detecting intersecting date groups
+
+## 0.7.0
+
+* [TT-6441] Due to TimeDifference being unmaintained bring it into the timely library
+
+## 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
+
 ## 0.4.2
 
 * [TT-5794] Fix belongs_to associations are not explicitly marked optional

data/Gemfile

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

data/README.md

@@ -1,8 +1,7 @@
 # Timely
 
-[![Build Status](https://travis-ci.org/sealink/timely.png?branch=master)](https://travis-ci.org/sealink/timely)
+[![Build Status](https://github.com/sealink/timely/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/timely/actions)
 [![Coverage Status](https://coveralls.io/repos/sealink/timely/badge.png)](https://coveralls.io/r/sealink/timely)
-[![Dependency Status](https://gemnasium.com/sealink/timely.png?travis)](https://gemnasium.com/sealink/timely)
 [![Code Climate](https://codeclimate.com/github/sealink/timely.png)](https://codeclimate.com/github/sealink/timely)
 
 # DESCRIPTION
@@ -59,3 +58,15 @@ some_date.at_time(some_time)    # => Sat May 03 13:40:22 -0500 2008
 some_time.on(some_date)         # => Sat May 03 13:40:22 -0500 2008
 some_date.at(some_time)         # => Sat May 03 13:40:22 -0500 2008
 ```
+
+# Release
+
+To publish a new version of this gem the following steps must be taken.
+
+* Update the version in the following files
+  ```
+    CHANGELOG.md
+    lib/timely/version.rb
+  ````
+* Create a tag using the format v0.1.0
+* Follow build progress in GitHub actions

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/rails60.gemfile

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

data/gemfiles/rails61.gemfile

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

data/lib/timely.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Timely
   require 'time'
   require 'date'

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