timely 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad5b5230c51dc3ab72192b82882b333fe9fc72b49fb2e8324881e7a6b7fd269
-  data.tar.gz: 1de47a9da2ee6f3708c049f85fed2654e7ec4900935056f80dbe42db2842cf7b
+  metadata.gz: e311a6b7b3b8f1c2c118f67e3cddc6ef7592091514c64f99c7a8d1f46f617d7a
+  data.tar.gz: ae6d6fa3c929fe97a63ed3e907544e97cafb38d2dc768f95d5cea00057d07864
 SHA512:
-  metadata.gz: 8d9bde900b4005fdcf26cc826e53858eb47067f6ccd6e01c633861efb305970d37ceddfd7bc1d70b2c68bae1a53abccc178ca1b95f20fc5ae5032cc8ef0e3e11
-  data.tar.gz: 8d1145ecf55ee9deb075d459e9f2399ec28bf0da6519f60b47cf1fddd679312383c6df4d9e83d8f6222e2aa89c7791b25927efb1705260e880ad54682b4b8037
+  metadata.gz: 4f0f48ab52cb955cd0dcc13b89138cc72dc5b444f87589173d346595d822bb12c205a5c93a27c34e5a5ea765807d521931823bd331c4baefa30a48a34e516829
+  data.tar.gz: 7013bcafe2fbed12b92caf1fc9da3b07292050fd643cd05a975495674cf5fbd206c815a4d9e65dafbbc25d2af8fb0c646f40a4cf839e4e8a03c08b1b795ec5d6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 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/lib/timely/rails/date_group.rb

@@ -7,6 +7,32 @@ module Timely
     validates_presence_of :start_date, :end_date
     validate :validate_date_range!
 
+    scope :covering_date, lambda { |date|
+      # Suitable for use with joins/merge!
+      where(arel_table[:start_date].lteq(date)).where(arel_table[:end_date].gteq(date))
+    }
+
+    scope :within_range, lambda { |date_range|
+      # 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 :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))
+    }
+
+    scope :applying_for_duration, lambda { |date_range|
+      weekdays_int = Timely::WeekDays.from_range(date_range).weekdays_int
+      within_range(date_range).for_any_weekdays(weekdays_int)
+    }
+
     def includes_date?(date)
       date >= start_date && date <= end_date && weekdays.applies_for_date?(date)
     end

data/lib/timely/version.rb

@@ -1,3 +1,3 @@
 module Timely
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/timely/week_days.rb

@@ -2,6 +2,16 @@ module Timely
   class WeekDays
     WEEKDAY_KEYS = %i[sun mon tue wed thu fri sat]
 
+    def self.from_range(date_range)
+      dates = Array(date_range)
+      return ALL_WEEKDAYS if dates.count >= WEEKDAY_KEYS.count
+
+      new(dates.each_with_object({}) { |date, result|
+        # e.g. {3: true, 5: true}
+        result[date.to_date.wday] = true
+      })
+    end
+
     # Create a new Weekdays object
     # weekdays can be in three formats
     # integer representing binary string

data/spec/date_group_spec.rb

@@ -1,5 +1,7 @@
 require "spec_helper"
-describe Timely::DateGroup do
+
+
+RSpec.describe Timely::DateGroup do
   before do
     @date_group = Timely::DateGroup.new(
       :start_date => '2000-01-01', :end_date => '2000-01-03', :weekdays => %w(1 1 1 1 1 1 1)
@@ -24,3 +26,58 @@ describe Timely::DateGroup do
     expect(@date_group.applicable_for_duration?(Timely::DateRange.new('2012-01-01'.to_date, '2012-01-03'.to_date))).to be true
   end
 end
+
+
+RSpec.describe 'Timely::DateGroup.for_any_weekdays' do
+  let(:date_range) { ('2019-10-17'.to_date)..('2019-10-18'.to_date) }
+  let(:weekdays_int) { Timely::WeekDays.from_range(date_range).weekdays_int }
+
+  let(:special_group) {
+    Timely::DateGroup.create(start_date: date_range.first, end_date: date_range.last).tap { |date_group|
+      date_group.update_column(:weekdays_bit_array, nil)
+    }.reload
+  }
+
+  let!(:date_groups) { [
+    Timely::DateGroup.create(start_date: date_range.first, end_date: date_range.last, weekdays: { thu: true }),
+    Timely::DateGroup.create(start_date: date_range.first, end_date: date_range.last, weekdays: { mon: true }),
+    special_group,
+  ] }
+
+  RSpec.shared_examples 'finds expected date groups' do
+    it 'finds expected date groups' do
+      includes_date_groups.each do |date_group|
+        expect(date_group.includes_date?(date_range.first)).to eq(true)
+      end
+      expected_groups.each do |date_group|
+        expect(scoped_result).to include(date_group)
+      end
+      absent_groups.each do |date_group|
+        expect(date_group.includes_date?(date_range.first)).to eq(false)
+        expect(scoped_result).not_to include(date_group)
+      end
+    end
+  end
+
+  context '#within_range' do
+    let(:scoped_result) { Timely::DateGroup.within_range(date_range).to_a }
+    let(:expected_groups) { [ date_groups[0], date_groups[1], date_groups[2] ] }
+    let(:absent_groups) { [ ] }
+    let(:includes_date_groups) { [] }
+    it_behaves_like 'finds expected date groups'
+  end
+
+  let(:includes_date_groups) { expected_groups }
+  let(:expected_groups) { [ date_groups[0], date_groups[2] ] }
+  let(:absent_groups) { [ date_groups[1] ] }
+
+  context '#for_any_weekdays' do
+    let(:scoped_result) { Timely::DateGroup.for_any_weekdays(weekdays_int).to_a }
+    it_behaves_like 'finds expected date groups'
+  end
+
+  context '#applying_for_duration' do
+    let(:scoped_result) { Timely::DateGroup.applying_for_duration(date_range).to_a }
+    it_behaves_like 'finds expected date groups'
+  end
+end

data/spec/support/coverage_loader.rb

@@ -1,4 +1,4 @@
 require 'simplecov-rcov'
 require 'coveralls'
 require 'coverage/kit'
-Coverage::Kit.setup(minimum_coverage: 68.3)
+Coverage::Kit.setup(minimum_coverage: 69.15)

data/spec/week_days_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Timely::WeekDays do
+RSpec.describe Timely::WeekDays do
   before do
     @weekdays = Timely::WeekDays.new(:tue => true, :thu => true)
   end
@@ -49,3 +49,26 @@ describe Timely::WeekDays do
     expect(Timely::WeekDays.new(%w(1 1 1 1 1 0 1)).all_days?).to be false
   end
 end
+
+RSpec.describe 'Timely::WeekDays.from_range' do
+  {
+    'single date as string': { date_range: '2019-10-17',         expected_weekdays: [ :thu ] },
+    'single date as object': { date_range: '2019-10-17'.to_date, expected_weekdays: [ :thu ] },
+    'range with strings':    {
+      date_range: '2019-10-17'..'2019-10-18',
+      expected_weekdays: [ :thu, :fri ],
+    },
+    'range with objects':    {
+      date_range: ('2019-10-17'.to_date)..('2019-10-18'.to_date),
+      expected_weekdays: [ :thu, :fri ],
+    },
+  }.each do |type, data|
+    it "#{type} has correct weekdays and applies for dates" do
+      weekdays = Timely::WeekDays.from_range(data[:date_range])
+      expect(weekdays.weekdays).to eq(data[:expected_weekdays])
+      Array(data[:date_range]).each do |date|
+        expect(weekdays.applies_for_date?(date.to_date)).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timely
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Michael Noack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler