by_star 2.2.1 → 3.0.0

data/lib/by_star/orm/active_record/by_star.rb

@@ -1,69 +1,61 @@
-module ByStar
-  module ActiveRecord
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      include ::ByStar::Base
-
-      # Returns all records between a given start and finish time.
-      #
-      # Currently only supports Time objects.
-      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.where("#{start_field} >= ? AND #{end_field} <= ?", start, finish)
-        else
-          scope.where("#{end_field} > ? AND #{start_field} < ?", start, finish)
-        end
-        scope = scope.order(options[:order]) if options[:order]
-        scope
-      end
-
-      def between(*args)
-        ActiveSupport::Deprecation.warn 'ByStar `between` method will be removed in v3.0.0. Please use `between_times`'
-        between_times(*args)
-      end
-
-      protected
-
-      def by_star_default_field
-        "#{self.table_name}.created_at"
-      end
-
-      def before_query(time, options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).where("#{field} <= ?", time)
-      end
-
-      def after_query(time, options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).where("#{field} >= ?", time)
-      end
-
-      def oldest_query(options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).reorder("#{field} ASC").first
-      end
-
-      def newest_query(options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).reorder("#{field} DESC").first
-      end
-    end
-
-    def previous(options={})
-      field = self.class.by_star_start_field
-      value = self.send(field.split(".").last)
-      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} < ?", value).reorder("#{field} DESC").first
-    end
-
-    def next(options={})
-      field = self.class.by_star_start_field
-      value = self.send(field.split(".").last)
-      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} > ?", value).reorder("#{field} ASC").first
-    end
-  end
-end
+module ByStar
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      include ::ByStar::Base
+
+      protected
+
+      def by_star_default_field
+        "#{self.table_name}.created_at"
+      end
+
+      def by_star_point_query(scope, field, start_time, end_time)
+        scope.where("#{field} >= ? AND #{field} <= ?", start_time, end_time)
+      end
+
+      def by_star_span_strict_query(scope, start_field, end_field, start_time, end_time)
+        scope.where("#{start_field} >= ? AND #{start_field} <= ? AND #{end_field} >= ? AND #{end_field} <= ?", start_time, end_time, start_time, end_time)
+      end
+
+      def by_star_span_overlap_query(scope, start_field, end_field, start_time, end_time, options)
+        scope.where("#{end_field} > ? AND #{start_field} < ?", start_time, end_time)
+      end
+
+      def by_star_before_query(scope, field, time)
+        scope.where("#{field} <= ?", time)
+      end
+
+      def by_star_after_query(scope, field, time)
+        scope.where("#{field} >= ?", time)
+      end
+
+      def by_star_order(scope, order)
+        scope.order(order)
+      end
+
+      def oldest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).reorder("#{field} ASC").first
+      end
+
+      def newest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).reorder("#{field} DESC").first
+      end
+    end
+
+    def previous(options={})
+      field = self.class.by_star_start_field(options)
+      value = self.send(field.split(".").last)
+      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} < ?", value).reorder("#{field} DESC").first
+    end
+
+    def next(options={})
+      field = self.class.by_star_start_field(options)
+      value = self.send(field.split(".").last)
+      self.class.by_star_scope(options.merge(scope_args: self)).where("#{field} > ?", value).reorder("#{field} ASC").first
+    end
+  end
+end

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

@@ -1,73 +1,76 @@
-# 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
-
-      def oldest_query(options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).order_by(field => :asc).first
-      end
-
-      def newest_query(options={})
-        field = by_star_start_field(options)
-        by_star_scope(options).order_by(field => :desc).first
-      end
-    end
-
-    def previous(options={})
-      field = self.class.by_star_start_field
-      self.class.by_star_scope(options.merge(scope_args: self)).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.merge(scope_args: self)).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_overlap_query(scope, start_field, end_field, start_time, end_time, options)
+        scope.gt(end_field => start_time).lt(start_field => end_time)
+      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)
+        by_star_scope(options).all.reorder(field => :asc).first
+      end
+
+      def newest_query(options={})
+        field = by_star_start_field(options)
+        by_star_scope(options).all.reorder(field => :desc).first
+      end
+    end
+
+    def previous(options={})
+      field = self.class.by_star_start_field(options)
+      self.class.by_star_scope(options.merge(scope_args: self)).lt(field => self.send(field)).reorder(field => :desc).first
+    end
+
+    def next(options={})
+      field = self.class.by_star_start_field(options)
+      self.class.by_star_scope(options.merge(scope_args: self)).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.1'
-end
+module ByStar
+  VERSION = '3.0.0'
+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: 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 scope: ->{ where(day_of_month: 1) }
+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 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
+
+  default_scope ->{ order_by(day_of_month: :asc) }
+end