by_star 3.0.0 → 4.0.0

data/spec/unit/normalization_spec.rb

@@ -4,7 +4,66 @@ describe ByStar::Normalization do
 
   let(:options){ {} }
 
-  shared_examples_for 'time normalization from string' do
+  shared_examples_for 'date normalization from string' do
+
+    context 'when Chronic is defined' do
+
+      context 'date String' do
+        let(:input){ '2014-01-01' }
+        it { should eq Date.parse('2014-01-01') }
+      end
+
+      context 'time String' do
+        let(:input){ '2014-01-01 15:00:00' }
+        it { should eq Date.parse('2014-01-01') }
+      end
+
+      context 'natural language String' do
+        let(:input){ 'tomorrow at 3:30 pm' }
+        it { should eq Date.parse('2014-01-02') }
+      end
+    end
+
+    context 'when Chronic is not defined' do
+
+      before { hide_const('Chronic') }
+
+      context 'date String' do
+        let(:input){ '2014-01-01' }
+        it { should eq Date.parse('2014-01-01') }
+      end
+
+      context 'time String' do
+        let(:input){ '2014-01-01 15:00:00' }
+        it { should eq Date.parse('2014-01-01') }
+      end
+
+      context 'natural language String' do
+        let(:input){ 'tomorrow at noon' }
+        it { expect{ subject }.to raise_error(ByStar::ParseError, "Cannot parse String #{input.inspect}") }
+      end
+    end
+  end
+
+  shared_examples_for 'date normalization from time value' do
+    context 'Date' do
+      let(:input){ Date.parse('2014-01-01') }
+      it { expect eq Date.parse('2014-01-01') }
+    end
+
+    context 'DateTime' do
+      let(:input){ Date.parse('2014-01-01').to_datetime }
+      it { expect eq Date.parse('2014-01-01') }
+    end
+
+    context 'Time' do
+      let(:input){ Date.parse('2014-01-01') }
+      it { expect eq Date.parse('2014-01-01') }
+    end
+  end
+
+  describe '#time' do
+    subject { ByStar::Normalization.time(input) }
 
     context 'when Chronic is defined' do
 
@@ -43,9 +102,7 @@ describe ByStar::Normalization do
         it { expect{ subject }.to raise_error(ByStar::ParseError, "Cannot parse String #{input.inspect}") }
       end
     end
-  end
 
-  shared_examples_for 'time normalization from date/time' do
     context 'Date' do
       let(:input){ Date.parse('2014-01-01') }
       it { expect eq Time.zone.parse('2014-01-01 00:00:00') }
@@ -62,16 +119,10 @@ describe ByStar::Normalization do
     end
   end
 
-  describe '#time' do
-    subject { ByStar::Normalization.time(input) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
-  end
-
   describe '#week' do
     subject { ByStar::Normalization.week(input, options) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from string'
+    it_behaves_like 'date normalization from time value'
 
     context 'Integer -1' do
       let(:input){ -1 }
@@ -80,12 +131,12 @@ describe ByStar::Normalization do
 
     context 'Integer 0' do
       let(:input){ 0 }
-      it { expect eq Time.zone.parse('2014-01-01 00:00:00') }
+      it { expect eq Date.parse('2014-01-01') }
     end
 
     context 'Integer 20' do
       let(:input){ 20 }
-      it { expect eq Time.zone.parse('2014-05-21 00:00:00') }
+      it { expect eq Date.parse('2014-05-21') }
     end
 
     context 'Integer 53' do
@@ -98,20 +149,20 @@ describe ByStar::Normalization do
 
       context 'Integer 0' do
         let(:input){ 0 }
-        it { expect eq Time.zone.parse('2011-01-01 00:00:00') }
+        it { expect eq Date.parse('2011-01-01') }
       end
 
       context 'Integer 20' do
         let(:input){ 20 }
-        it { expect eq Time.zone.parse('2011-05-21 00:00:00') }
+        it { expect eq Date.parse('2011-05-21') }
       end
     end
   end
 
   describe '#cweek' do
     subject { ByStar::Normalization.cweek(input, options) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from string'
+    it_behaves_like 'date normalization from time value'
 
     context 'Integer 9' do
       let(:input){ 0 }
@@ -120,12 +171,12 @@ describe ByStar::Normalization do
 
     context 'Integer 1' do
       let(:input){ 1 }
-      it { expect eq Time.zone.parse('2014-01-01 00:00:00') }
+      it { expect eq Date.parse('2014-01-01') }
     end
 
     context 'Integer 21' do
       let(:input){ 21 }
-      it { expect eq Time.zone.parse('2014-05-21 00:00:00') }
+      it { expect eq Date.parse('2014-05-21') }
     end
 
     context 'Integer 54' do
@@ -138,29 +189,29 @@ describe ByStar::Normalization do
 
       context 'Integer 1' do
         let(:input){ 1 }
-        it { expect eq Time.zone.parse('2011-01-01 00:00:00') }
+        it { expect eq Date.parse('2011-01-01') }
       end
 
       context 'Integer 21' do
         let(:input){ 21 }
-        it { expect eq Time.zone.parse('2011-05-21 00:00:00') }
+        it { expect eq Date.parse('2011-05-21') }
       end
     end
   end
 
   describe '#fortnight' do
     subject { ByStar::Normalization.fortnight(input, options) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from string'
+    it_behaves_like 'date normalization from time value'
 
     context 'Integer 0' do
       let(:input){ 0 }
-      it { expect eq Time.zone.parse('2014-01-01 00:00:00') }
+      it { expect eq Date.parse('2014-01-01') }
     end
 
     context 'Integer 26' do
       let(:input){ 26 }
-      it { expect eq Time.zone.parse('2014-12-31 00:00:00') }
+      it { expect eq Date.parse('2014-12-31') }
     end
 
     context 'out of range' do
@@ -173,38 +224,38 @@ describe ByStar::Normalization do
 
       context 'Integer 0' do
         let(:input){ 0 }
-        it { expect eq Time.zone.parse('2011-01-01 00:00:00') }
+        it { expect eq Date.parse('2011-01-01') }
       end
 
       context 'Integer 26' do
         let(:input){ 26 }
-        it { expect eq Time.zone.parse('2011-12-31 00:00:00') }
+        it { expect eq Date.parse('2011-12-31') }
       end
     end
   end
 
   describe '#month' do
     subject { ByStar::Normalization.month(input, options) }
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from time value'
 
     context 'month abbr String' do
       let(:input){ 'Feb' }
-      it { expect eq Time.zone.parse('2014-02-01 00:00:00') }
+      it { expect eq Date.parse('2014-02-01') }
     end
 
     context 'month full String' do
       let(:input){ 'February' }
-      it { expect eq Time.zone.parse('2014-02-01 00:00:00') }
+      it { expect eq Date.parse('2014-02-01') }
     end
 
     context 'number String' do
       let(:input){ '2' }
-      it { expect eq Time.zone.parse('2014-02-01 00:00:00') }
+      it { expect eq Date.parse('2014-02-01') }
     end
 
     context 'Integer' do
       let(:input){ 2 }
-      it { expect eq Time.zone.parse('2014-02-01 00:00:00') }
+      it { expect eq Date.parse('2014-02-01') }
     end
 
     context 'out of range' do
@@ -217,39 +268,39 @@ describe ByStar::Normalization do
 
       context 'month abbr String' do
         let(:input){ 'Dec' }
-        it { expect eq Time.zone.parse('2011-12-01 00:00:00') }
+        it { expect eq Date.parse('2011-12-01') }
       end
 
       context 'Integer 12' do
         let(:input){ 10 }
-        it { expect eq Time.zone.parse('2011-10-01 00:00:00') }
+        it { expect eq Date.parse('2011-10-01') }
       end
     end
   end
 
   describe '#quarter' do
     subject { ByStar::Normalization.quarter(input, options) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from string'
+    it_behaves_like 'date normalization from time value'
 
     context 'Integer 1' do
       let(:input){ 1 }
-      it { expect eq Time.zone.parse('2014-01-01 00:00:00') }
+      it { expect eq Date.parse('2014-01-01') }
     end
 
     context 'Integer 2' do
       let(:input){ 2 }
-      it { expect eq Time.zone.parse('2014-04-01 00:00:00') }
+      it { expect eq Date.parse('2014-04-01') }
     end
 
     context 'Integer 3' do
       let(:input){ 3 }
-      it { expect eq Time.zone.parse('2014-07-01 00:00:00') }
+      it { expect eq Date.parse('2014-07-01') }
     end
 
     context 'Integer 4' do
       let(:input){ 4 }
-      it { expect eq Time.zone.parse('2014-10-01 00:00:00') }
+      it { expect eq Date.parse('2014-10-01') }
     end
 
     context 'with year option' do
@@ -257,7 +308,7 @@ describe ByStar::Normalization do
 
       context 'Integer 3' do
         let(:input){ 3 }
-        it { expect eq Time.zone.parse('2011-07-01 00:00:00') }
+        it { expect eq Date.parse('2011-07-01') }
       end
     end
 
@@ -269,37 +320,65 @@ describe ByStar::Normalization do
 
   describe '#year' do
     subject { ByStar::Normalization.year(input, options) }
-    it_behaves_like 'time normalization from string'
-    it_behaves_like 'time normalization from date/time'
+    it_behaves_like 'date normalization from string'
+    it_behaves_like 'date normalization from time value'
 
     context 'Integer 69' do
       let(:input){ 69 }
-      it { expect eq Time.zone.parse('2069-01-01 00:00:00') }
+      it { expect eq Date.parse('2069-01-01') }
     end
 
     context 'Integer 99' do
       let(:input){ 99 }
-      it { expect eq Time.zone.parse('1999-01-01 00:00:00') }
+      it { expect eq Date.parse('1999-01-01') }
     end
 
     context 'Integer 2001' do
       let(:input){ 1 }
-      it { expect eq Time.zone.parse('2001-01-01 00:00:00') }
+      it { expect eq Date.parse('2001-01-01') }
     end
 
     context 'String 01' do
       let(:input){ '01' }
-      it { expect eq Time.zone.parse('2001-01-01 00:00:00') }
+      it { expect eq Date.parse('2001-01-01') }
     end
 
     context 'String 70' do
       let(:input){ '70' }
-      it { expect eq Time.zone.parse('1970-01-01 00:00:00') }
+      it { expect eq Date.parse('1970-01-01') }
     end
 
     context 'String 2001' do
       let(:input){ '2001' }
-      it { expect eq Time.zone.parse('2001-01-01 00:00:00') }
+      it { expect eq Date.parse('2001-01-01') }
     end
   end
+
+  describe '#time_in_units' do
+    subject { ByStar::Normalization.time_in_units(input) }
+
+    context 'when less than a day' do
+      let(:input) { 34876 }
+      it { is_expected.to eq(days: 0, hour: 9, min: 41, sec: 16) }
+    end
+
+    context 'when more than a day' do
+      let(:input) { 97532 }
+      it { is_expected.to eq(days: 1, hour: 3, min: 5, sec: 32) }
+    end
+  end
+
+  describe '#apply_offset_start' do
+    subject { ByStar::Normalization.apply_offset_start(input, offset) }
+    let(:input) { Time.zone.parse('2020-04-05 00:00:00') }
+    let(:offset) { 5.hours }
+    it { is_expected.to eq Time.zone.parse('2020-04-05 05:00:00') }
+  end
+
+  describe '#apply_offset_end' do
+    subject { ByStar::Normalization.apply_offset_end(input, offset) }
+    let(:input) { Time.zone.parse('2020-10-04 00:00:00') }
+    let(:offset) { 5.hours }
+    it { is_expected.to eq Time.zone.parse('2020-10-05 04:59:59') }
+  end
 end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: by_star
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Ryan Bigg
 - Johnny Shields
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -113,16 +113,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.10
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.10
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/mysql.yml"
+- ".github/workflows/postgresql.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -187,6 +189,7 @@ files:
 - lib/by_star/between.rb
 - lib/by_star/directional.rb
 - lib/by_star/kernel/date.rb
+- lib/by_star/kernel/in_time_zone.rb
 - lib/by_star/kernel/time.rb
 - lib/by_star/normalization.rb
 - lib/by_star/orm/active_record/by_star.rb
@@ -198,14 +201,20 @@ files:
 - spec/fixtures/active_record/schema.rb
 - spec/fixtures/mongoid/models.rb
 - spec/fixtures/shared/seeds.rb
-- spec/gemfiles/Gemfile.master
+- spec/gemfiles/Gemfile.rails
+- spec/gemfiles/Gemfile.rails32
 - spec/gemfiles/Gemfile.rails40
 - spec/gemfiles/Gemfile.rails41
 - spec/gemfiles/Gemfile.rails42
 - spec/gemfiles/Gemfile.rails50
 - spec/gemfiles/Gemfile.rails51
+- spec/gemfiles/Gemfile.rails52
+- spec/gemfiles/Gemfile.rails60
+- spec/gemfiles/Gemfile.rails61
 - spec/integration/active_record/active_record_spec.rb
 - spec/integration/mongoid/mongoid_spec.rb
+- spec/integration/shared/at_time.rb
+- spec/integration/shared/between_dates.rb
 - spec/integration/shared/between_times.rb
 - spec/integration/shared/by_calendar_month.rb
 - spec/integration/shared/by_cweek.rb
@@ -217,10 +226,10 @@ files:
 - spec/integration/shared/by_week.rb
 - spec/integration/shared/by_weekend.rb
 - spec/integration/shared/by_year.rb
+- spec/integration/shared/index_scope_parameter.rb
 - spec/integration/shared/offset_parameter.rb
 - spec/integration/shared/order_parameter.rb
 - spec/integration/shared/relative.rb
-- spec/integration/shared/scope_parameter.rb
 - spec/spec_helper.rb
 - spec/unit/kernel_date_spec.rb
 - spec/unit/kernel_time_spec.rb
@@ -233,9 +242,7 @@ post_install_message: |
   Upgrading ByStar
   ----------------
 
-  * Chronic gem (used for time string parsing) has been removed as a hard dependency for ByStar,
-  however it is still supported. If you would like to use Chronic with ByStar, please explicitly
-  include `gem chronic` into your Gemfile.
+  * As of version 4.0.0, ByStar changes the way it handles `Date` arg to the `#between_times` method. If a `Date` is given as the second (end) arg, the query will use `Date.end_of_day` to include all time values which fall inside that date.
 rdoc_options: []
 require_paths:
 - lib
@@ -250,9 +257,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ActiveRecord and Mongoid extension for easier date scopes and time ranges
 test_files:
@@ -261,14 +267,20 @@ test_files:
 - spec/fixtures/active_record/schema.rb
 - spec/fixtures/mongoid/models.rb
 - spec/fixtures/shared/seeds.rb
-- spec/gemfiles/Gemfile.master
+- spec/gemfiles/Gemfile.rails
+- spec/gemfiles/Gemfile.rails32
 - spec/gemfiles/Gemfile.rails40
 - spec/gemfiles/Gemfile.rails41
 - spec/gemfiles/Gemfile.rails42
 - spec/gemfiles/Gemfile.rails50
 - spec/gemfiles/Gemfile.rails51
+- spec/gemfiles/Gemfile.rails52
+- spec/gemfiles/Gemfile.rails60
+- spec/gemfiles/Gemfile.rails61
 - spec/integration/active_record/active_record_spec.rb
 - spec/integration/mongoid/mongoid_spec.rb
+- spec/integration/shared/at_time.rb
+- spec/integration/shared/between_dates.rb
 - spec/integration/shared/between_times.rb
 - spec/integration/shared/by_calendar_month.rb
 - spec/integration/shared/by_cweek.rb
@@ -280,10 +292,10 @@ test_files:
 - spec/integration/shared/by_week.rb
 - spec/integration/shared/by_weekend.rb
 - spec/integration/shared/by_year.rb
+- spec/integration/shared/index_scope_parameter.rb
 - spec/integration/shared/offset_parameter.rb
 - spec/integration/shared/order_parameter.rb
 - spec/integration/shared/relative.rb
-- spec/integration/shared/scope_parameter.rb
 - spec/spec_helper.rb
 - spec/unit/kernel_date_spec.rb
 - spec/unit/kernel_time_spec.rb

data/spec/gemfiles/Gemfile.master

@@ -1,6 +0,0 @@
-source 'http://rubygems.org'
-
-gemspec path: '../../'
-
-gem 'activerecord', github: 'rails'
-gem 'mongoid',      github: 'mongoid'

data/spec/integration/shared/scope_parameter.rb

@@ -1,73 +0,0 @@
-require 'spec_helper'
-
-shared_examples_for 'scope parameter' do
-
-  describe ':scope' do
-
-    it 'should memoize the scope variable' do
-      expect(Event.instance_variable_get(:@by_star_scope)).to be_nil
-      expect(Post.instance_variable_get(:@by_star_scope)).to be_nil
-      expect(Appointment.instance_variable_get(:@by_star_scope)).to be_a Proc
-    end
-
-    context 'between_times with default scope' do
-      subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01')) }
-      it { expect(subject.count).to eql(3) }
-    end
-
-    context 'between_times with scope override as a query criteria' do
-      subject { Appointment.between_times(Date.parse('2013-12-01')..Date.parse('2014-02-01'), scope: Appointment.unscoped) }
-      it { expect(subject.count).to eql(14) }
-    end
-
-    context 'between_times with scope override as a Lambda' do
-      subject { Appointment.between_times([Date.parse('2013-12-01'), Date.parse('2014-02-01')], scope: ->{ unscoped }) }
-      it { expect(subject.count).to eql(14) }
-    end
-
-    context 'between_times with scope override as a Lambda' do
-      subject { Appointment.between_times(Date.parse('2013-12-01')..Date.parse('2014-02-01'), scope: ->(x){ unscoped }) }
-      it{ expect{ subject }.to raise_error(RuntimeError, 'ByStar :scope Proc requires :scope_args to be specified.') }
-    end
-
-    context 'between_times with scope override as a Proc with arguments' do
-      subject { Appointment.between_times(Date.parse('2013-12-01'), Date.parse('2014-02-01'), scope: Proc.new{ unscoped }) }
-      it { expect(subject.count).to eql(14) }
-    end
-
-    context 'between_times with scope override as a Proc with arguments' do
-      subject { Appointment.between_times([Date.parse('2013-12-01'), Date.parse('2014-02-01')], scope: Proc.new{|x,y| unscoped }) }
-      it{ expect{ subject }.to raise_error(RuntimeError, 'ByStar :scope Proc requires :scope_args to be specified.') }
-    end
-
-    context 'by_month with default scope' do
-      subject { Appointment.by_month(Date.parse('2014-01-01')) }
-      it { expect(subject.count).to eql(2) }
-    end
-
-    context 'by_month with scope override as a query criteria' do
-      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: Appointment.unscoped) }
-      it { expect(subject.count).to eql(6) }
-    end
-
-    context 'by_month with scope override as a Lambda' do
-      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: ->{ unscoped }) }
-      it { expect(subject.count).to eql(6) }
-    end
-
-    context 'by_month with scope override as a Lambda with arguments' do
-      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: ->(x){ unscoped }) }
-      it{ expect{ subject }.to raise_error(RuntimeError, 'ByStar :scope Proc requires :scope_args to be specified.') }
-    end
-
-    context 'by_month with scope override as a Proc' do
-      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: Proc.new{ unscoped }) }
-      it { expect(subject.count).to eql(6) }
-    end
-
-    context 'by_month with scope override as a Proc with arguments' do
-      subject { Appointment.by_month(Date.parse('2014-01-01'), scope: Proc.new{|x| unscoped }) }
-      it{ expect{ subject }.to raise_error(RuntimeError, 'ByStar :scope Proc requires :scope_args to be specified.') }
-    end
-  end
-end