by_star 2.2.0 → 4.0.0

data/lib/by_star/orm/mongoid/by_star.rb

@@ -1,63 +1,90 @@
-# In keeping with Mongoid standards, this module must be included into your model class, i.e.
-#
-#   include Mongoid::ByStar
-#
-module Mongoid
-  module ByStar
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      include ::ByStar::Base
-
-      def between_times_query(start, finish, options={})
-        start_field = by_star_start_field(options)
-        end_field = by_star_end_field(options)
-
-        scope = by_star_scope(options)
-        scope = if options[:strict] || start_field == end_field
-          scope.gte(start_field => start).lte(end_field => finish)
-        else
-          scope.gt(end_field => start).lt(start_field => finish)
-        end
-        scope = scope.order_by(field => options[:order]) if options[:order]
-        scope
-      end
-
-      def by_star_end_field_with_mongoid(options = {})
-        database_field_name by_star_end_field_without_mongoid(options)
-      end
-      alias_method_chain :by_star_end_field, :mongoid
-
-      def by_star_start_field_with_mongoid(options = {})
-        database_field_name by_star_start_field_without_mongoid(options)
-      end
-      alias_method_chain :by_star_start_field, :mongoid
-
-      protected
-
-      def by_star_default_field
-        :created_at
-      end
-
-      def before_query(time, options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).lte(field => time)
-      end
-
-      def after_query(time, options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).gte(field => time)
-      end
-    end
-
-    def previous(options={})
-      field = self.class.by_star_start_field
-      self.class.by_star_scope(options).lt(field => self.send(field)).desc(field).first
-    end
-
-    def next(options={})
-      field = self.class.by_star_start_field
-      self.class.by_star_scope(options).gt(field => self.send(field)).asc(field).first
-    end
-  end
-end
+# In keeping with Mongoid standards, this module must be included into your model class, i.e.
+#
+#   include Mongoid::ByStar
+#
+module Mongoid
+  module ByStar
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      include ::ByStar::Base
+
+      alias_method :original_by_star_end_field, :by_star_end_field
+      alias_method :original_by_star_start_field, :by_star_start_field
+
+      def by_star_end_field(options = {})
+        database_field_name original_by_star_end_field(options)
+      end
+
+      def by_star_start_field(options = {})
+        database_field_name original_by_star_start_field(options)
+      end
+
+      def by_star_default_field
+        :created_at
+      end
+
+      protected
+
+      def by_star_point_query(scope, field, start_time, end_time)
+        range = start_time..end_time
+        scope.where(field => range)
+      end
+
+      def by_star_span_strict_query(scope, start_field, end_field, start_time, end_time)
+        range = start_time..end_time
+        scope.where(start_field => range).where(end_field => range)
+      end
+
+      def by_star_span_loose_query(scope, start_field, end_field, start_time, end_time, options)
+        index_scope = by_star_eval_index_scope(start_time, end_time, options)
+        scope = scope.gt(end_field => start_time).lt(start_field => end_time)
+        scope = scope.gte(start_field => index_scope) if index_scope
+        scope
+      end
+
+      def by_star_point_overlap_query(scope, field, time)
+        scope.where(field => time)
+      end
+
+      def by_star_span_overlap_query(scope, start_field, end_field, time, options)
+        index_scope = by_star_eval_index_scope(time, time, options)
+        scope = scope.gt(end_field => time).lte(start_field => time)
+        scope = scope.gte(start_field => index_scope) if index_scope
+        scope
+      end
+
+      def by_star_before_query(scope, field, time)
+        scope.lte(field => time)
+      end
+
+      def by_star_after_query(scope, field, time)
+        scope.gte(field => time)
+      end
+
+      def by_star_order(scope, order)
+        scope.order_by(order)
+      end
+
+      def oldest_query(options={})
+        field = by_star_start_field(options)
+        all.reorder(field => :asc).first
+      end
+
+      def newest_query(options={})
+        field = by_star_start_field(options)
+        all.reorder(field => :desc).first
+      end
+    end
+
+    def previous(options={})
+      field = self.class.by_star_start_field(options)
+      self.class.lt(field => self.send(field)).reorder(field => :desc).first
+    end
+
+    def next(options={})
+      field = self.class.by_star_start_field(options)
+      self.class.gt(field => self.send(field)).reorder(field => :asc).first
+    end
+  end
+end

data/lib/by_star/orm/mongoid/reorder.rb

@@ -0,0 +1,23 @@
+# Backport of `reorder` method from Origin 2.1.0+
+if defined?(Origin::Optional) && !Origin::Optional.method_defined?(:reorder)
+  module Origin
+    module Optional
+
+      # Instead of merging the order criteria, use this method to completely
+      # replace the existing ordering with the provided.
+      #
+      # @example Replace the ordering.
+      #   optional.reorder(name: :asc)
+      #
+      # @param [ Array, Hash, String ] spec The sorting specification.
+      #
+      # @return [ Optional ] The cloned optional.
+      #
+      # @since 2.1.0
+      def reorder(*spec)
+        options.delete(:sort)
+        order_by(*spec)
+      end
+    end
+  end
+end

data/lib/by_star/version.rb

@@ -1,3 +1,3 @@
-module ByStar
-  VERSION = '2.2.0'
-end
+module ByStar
+  VERSION = '4.0.0'
+end

data/lib/by_star.rb

@@ -1,15 +1,18 @@
-require 'by_star/kernel'
-require 'by_star/normalization'
-require 'by_star/between'
-require 'by_star/directional'
-require 'by_star/base'
-
-if defined?(ActiveRecord)
-  require 'by_star/orm/active_record/by_star'
-  ActiveRecord::Base.send :include, ByStar::ActiveRecord
-  ActiveRecord::Relation.send :extend, ByStar::ActiveRecord::ClassMethods
-end
-
-if defined?(Mongoid)
-  require 'by_star/orm/mongoid/by_star'
-end
+require 'by_star/kernel/in_time_zone'
+require 'by_star/kernel/time'
+require 'by_star/kernel/date'
+require 'by_star/normalization'
+require 'by_star/between'
+require 'by_star/directional'
+require 'by_star/base'
+
+if defined?(ActiveRecord)
+  require 'by_star/orm/active_record/by_star'
+  ActiveRecord::Base.send :include, ByStar::ActiveRecord
+  ActiveRecord::Relation.send :extend, ByStar::ActiveRecord::ClassMethods
+end
+
+if defined?(Mongoid)
+  require 'by_star/orm/mongoid/reorder'
+  require 'by_star/orm/mongoid/by_star'
+end

data/spec/database.yml

@@ -1,15 +1,15 @@
-sqlite:
-  adapter: sqlite3
-  database: by_star.sqlite3
-
-postgres:
-  adapter: postgresql
-  database: by_star_test
-  username: postgres
-  min_messages: warning
-
-mysql:
-  adapter: mysql2
-  database: by_star_test
-  username: root
-  encoding: utf8
+sqlite:
+  adapter: sqlite3
+  database: by_star.sqlite3
+
+postgres:
+  adapter: postgresql
+  database: by_star_test
+  username: <%= ENV.fetch("USER") || "postgres" %>
+  min_messages: warning
+
+mysql:
+  adapter: mysql2
+  database: by_star_test
+  username: root
+  encoding: utf8

data/spec/fixtures/active_record/models.rb

@@ -1,10 +1,12 @@
-class Post < ActiveRecord::Base
-end
-
-class Appointment < ActiveRecord::Base
-  by_star_field scope: ->{ where(day_of_month: 1) }
-end
-
-class Event < ActiveRecord::Base
-  by_star_field :start_time, :end_time, offset: 3.hours
-end
+class Post < ActiveRecord::Base
+end
+
+class Appointment < ActiveRecord::Base
+  by_star_field index_scope: ->(start){ start - 5.days }
+end
+
+class Event < ActiveRecord::Base
+  by_star_field :start_time, :end_time, offset: 3.hours
+
+  default_scope ->{ order('day_of_month ASC') }
+end

data/spec/fixtures/active_record/schema.rb

@@ -1,19 +1,19 @@
-ActiveRecord::Schema.define do
-  self.verbose = false
-
-  create_table :posts, :force => true do |t|
-    t.timestamps
-    t.integer :day_of_month
-  end
-
-  create_table :events, :force => true do |t|
-    t.timestamps
-    t.datetime :start_time, :end_time
-    t.integer  :day_of_month
-  end
-
-  create_table :appointments, :force => true do |t|
-    t.timestamps
-    t.integer :day_of_month
-  end
-end
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, force: true do |t|
+    t.timestamps
+    t.integer :day_of_month
+  end
+
+  create_table :events, force: true do |t|
+    t.timestamps
+    t.datetime :start_time, :end_time
+    t.integer  :day_of_month
+  end
+
+  create_table :appointments, force: true do |t|
+    t.timestamps
+    t.integer :day_of_month
+  end
+end

data/spec/fixtures/mongoid/models.rb

@@ -1,29 +1,31 @@
-class Post
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  include Mongoid::ByStar
-
-  field :day_of_month,        type: Integer
-end
-
-class Appointment
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  include Mongoid::ByStar
-
-  field :day_of_month,        type: Integer
-
-  by_star_field scope: ->{ where(day_of_month: 1) }
-end
-
-class Event
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  include Mongoid::ByStar
-
-  field :st, as: :start_time, type: Time
-  field :end_time,            type: Time
-  field :day_of_month,        type: Integer
-
-  by_star_field :start_time, :end_time, offset: 3.hours
-end
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::ByStar
+
+  field :day_of_month,        type: Integer
+end
+
+class Appointment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::ByStar
+
+  field :day_of_month,        type: Integer
+
+  by_star_field index_scope: ->(start){ start - 5.days }
+end
+
+class Event
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::ByStar
+
+  field :st, as: :start_time, type: Time
+  field :end_time,            type: Time
+  field :day_of_month,        type: Integer
+
+  by_star_field :start_time, :end_time, offset: 3.hours
+
+  default_scope ->{ order_by(day_of_month: :asc) }
+end

data/spec/fixtures/shared/seeds.rb

@@ -1,26 +1,36 @@
-%w(2013-11-01
-   2013-11-30
-   2013-12-01
-   2013-12-05
-   2013-12-08
-   2013-12-16
-   2013-12-22
-   2013-12-25
-   2013-12-28
-   2013-12-31
-   2014-01-01
-   2014-01-01
-   2014-01-05
-   2014-01-10
-   2014-01-12
-   2014-01-20
-   2014-02-01
-   2014-02-15
-   2014-03-01
-   2014-03-15
-   2014-04-01
-   2014-04-15).map{|d| Time.zone.parse(d) + 17.hours }.each do |d|
-  Post.create!(:created_at => d, day_of_month: d.day)
-  Appointment.create!(:created_at => d, day_of_month: d.day)
-  Event.create!(:created_at => d, :start_time => d - 5.days, :end_time => d + 5.days, day_of_month: d.day)
-end
+%w(2013-11-01
+   2013-11-30
+   2013-12-01
+   2013-12-05
+   2013-12-08
+   2013-12-16
+   2013-12-22
+   2013-12-25
+   2013-12-28
+   2013-12-31
+   2014-01-01
+   2014-01-01
+   2014-01-05
+   2014-01-10
+   2014-01-12
+   2014-01-20
+   2014-02-01
+   2014-02-15
+   2014-03-01
+   2014-03-15
+   2014-04-01
+   2014-04-15).map{|d| Time.zone.parse(d) + 17.hours }.each_with_index do |d, index|
+  Post.create!(created_at: d, updated_at: d + index.days, day_of_month: d.day)
+  Appointment.create!(created_at: d, day_of_month: d.day)
+  Event.create!(created_at: d, start_time: d - 5.days, end_time: d + 5.days, day_of_month: d.day)
+end
+
+# Sydney timezone specific records
+%w(
+  2020-04-05
+  2020-10-04
+).map{|d| Date.parse(d) }.each do |d|
+  [1, 4, 5, 10].each do |h|
+    Event.create!(start_time: d + h.hour, end_time: d + h.hour + 30.minutes, created_at: Date.parse('2011-01-01').in_time_zone)
+  end
+end

data/spec/gemfiles/Gemfile.rails

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', github: 'rails', branch: "main"

data/spec/gemfiles/Gemfile.rails32

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 3.2.0'
+gem 'pg',           '~> 0.11'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails40

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 4.0.0'
+gem 'pg',           '~> 0.11'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails41

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 4.1.0'
+gem 'pg',           '~> 0.11'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails42

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 4.2.0'
+gem 'pg',           '~> 0.15'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails50

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 5.0.0'
+gem 'pg',           '~> 0.18'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails51

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 5.1.0'
+gem 'pg',           '~> 0.18'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails52

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 5.2.0'
+gem 'pg',           '~> 0.18'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails60

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 6.0'
+gem 'pg'
+gem 'mongoid'

data/spec/gemfiles/Gemfile.rails61

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord', '~> 6.1'
+gem 'pg'
+gem 'mongoid'

data/spec/integration/active_record/active_record_spec.rb

@@ -1,53 +1,41 @@
-require 'spec_helper'
-Dir[File.dirname(__FILE__) + '/../shared/*.rb'].each {|file| require file }
-
-describe ActiveRecord do
-  before(:all) do
-    ActiveRecord::Base.default_timezone = :utc
-    # ActiveRecord::Base.logger = Logger.new(STDOUT)
-
-    db_config = YAML::load_file(File.dirname(__FILE__) + '/../../database.yml')
-    if db_config.has_key?('sqlite') && db_config['sqlite'].has_key?('database')
-      db_config['sqlite']['database'] = File.dirname(__FILE__) + '/../../tmp/' + db_config['sqlite']['database']
-    end
-
-    ActiveRecord::Base.configurations = db_config
-    ActiveRecord::Base.establish_connection(ENV['DB'] || 'sqlite')
-    load File.dirname(__FILE__) + '/../../fixtures/active_record/schema.rb'
-    load File.dirname(__FILE__) + '/../../fixtures/active_record/models.rb'
-    load File.dirname(__FILE__) + '/../../fixtures/shared/seeds.rb'
-
-    ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/../../tmp/activerecord.log')
-  end
-
-  it_behaves_like 'by day'
-  it_behaves_like 'by direction'
-  it_behaves_like 'by fortnight'
-  it_behaves_like 'by month'
-  it_behaves_like 'by calendar month'
-  it_behaves_like 'by quarter'
-  it_behaves_like 'by week'
-  it_behaves_like 'by weekend'
-  it_behaves_like 'by year'
-  it_behaves_like 'relative'
-  it_behaves_like 'offset parameter'
-  it_behaves_like 'scope parameter'
-
-  it 'should be able to order the result set' do
-    scope = Post.by_year(Time.zone.now.year, :order => 'created_at DESC')
-    scope.order_values.should == ['created_at DESC']
-  end
-
-  describe '#between_times' do
-    subject { Post.between_times(Time.parse('2014-01-01'), Time.parse('2014-01-06')) }
-    it { should be_a(ActiveRecord::Relation) }
-    its(:count) { should eq 3 }
-  end
-
-  describe '#between' do
-    subject { Post.between(Time.parse('2014-01-01'), Time.parse('2014-01-06')) }
-    it 'should be an alias of #between_times' do
-      subject.count.should eq 3
-    end
-  end
-end if testing_active_record?
+require 'spec_helper'
+Dir[File.dirname(__FILE__) + '/../shared/*.rb'].each {|file| require file }
+
+describe ActiveRecord do
+  before(:all) do
+    ActiveRecord::Base.default_timezone = :utc
+    # ActiveRecord::Base.logger = Logger.new(STDOUT)
+    database_file = File.dirname(__FILE__) + '/../../database.yml'
+    parsed_config = ERB.new(File.read(database_file)).result
+    db_config = YAML.safe_load(parsed_config)
+    if db_config.has_key?('sqlite') && db_config['sqlite'].has_key?('database')
+      db_config['sqlite']['database'] = File.dirname(__FILE__) + '/../../tmp/' + db_config['sqlite']['database']
+    end
+
+    ActiveRecord::Base.configurations = db_config
+    ActiveRecord::Base.establish_connection(ENV['DB'].try(:to_sym) || :sqlite)
+    load File.dirname(__FILE__) + '/../../fixtures/active_record/schema.rb'
+    load File.dirname(__FILE__) + '/../../fixtures/active_record/models.rb'
+    load File.dirname(__FILE__) + '/../../fixtures/shared/seeds.rb'
+
+    ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/../../tmp/activerecord.log')
+  end
+
+  it_behaves_like 'between_times'
+  it_behaves_like 'between_dates'
+  it_behaves_like 'at_time'
+  it_behaves_like 'offset parameter'
+  it_behaves_like 'order parameter'
+  it_behaves_like 'index_scope parameter'
+  it_behaves_like 'by day'
+  it_behaves_like 'by direction'
+  it_behaves_like 'by fortnight'
+  it_behaves_like 'by month'
+  it_behaves_like 'by calendar month'
+  it_behaves_like 'by quarter'
+  it_behaves_like 'by week'
+  it_behaves_like 'by cweek'
+  it_behaves_like 'by weekend'
+  it_behaves_like 'by year'
+  it_behaves_like 'relative'
+end if testing_active_record?