by_star 3.0.0 → 4.0.1

data/Rakefile

@@ -1,18 +1,18 @@
-require 'bundler'
-require 'rspec/core/rake_task'
-
-Bundler::GemHelper.install_tasks
-RSpec::Core::RakeTask.new(:spec)
-
-def orm_test(orm)
-  RSpec::Core::RakeTask.new(orm) do |task|
-    task.pattern = "./spec/{unit,integration/#{orm}}/{,/*/**}/*_spec.rb"
-  end
-end
-
-namespace :spec do
-  orm_test 'active_record'
-  orm_test 'mongoid'
-end
-
-task default: :spec
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+def orm_test(orm)
+  RSpec::Core::RakeTask.new(orm) do |task|
+    task.pattern = "./spec/{unit,integration/#{orm}}/{,/*/**}/*_spec.rb"
+  end
+end
+
+namespace :spec do
+  orm_test 'active_record'
+  orm_test 'mongoid'
+end
+
+task default: :spec

data/UPGRADING

@@ -1,6 +1,4 @@
-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.
+Upgrading ByStar
+----------------
+
+* 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.

data/by_star.gemspec

@@ -1,34 +1,34 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/by_star/version", __FILE__)
-
-Gem::Specification.new do |s|
-  s.name        = "by_star"
-  s.version     = ByStar::VERSION
-  s.authors     = ["Ryan Bigg", "Johnny Shields"]
-  s.email       = ["radarlistener@gmail.com"]
-  s.homepage    = "http://github.com/radar/by_star"
-  s.summary     = "ActiveRecord and Mongoid extension for easier date scopes and time ranges"
-  s.description = "ActiveRecord and Mongoid extension for easier date scopes and time ranges"
-
-  s.required_ruby_version = '>= 2.0.0'
-
-  s.post_install_message = File.read('UPGRADING') if File.exists?('UPGRADING')
-
-  s.add_dependency "activesupport", "> 3"
-
-  s.add_development_dependency "chronic"
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "sqlite3"
-  s.add_development_dependency "activerecord"
-  s.add_development_dependency "mongoid"
-  s.add_development_dependency "pg"
-  s.add_development_dependency "mysql2", "~> 0.3.10"
-  s.add_development_dependency "rspec-rails", "~> 3.1"
-  s.add_development_dependency "timecop", "~> 0.3"
-  s.add_development_dependency "pry"
-
-  s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-end
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/by_star/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "by_star"
+  s.version     = ByStar::VERSION
+  s.authors     = ["Ryan Bigg", "Johnny Shields"]
+  s.email       = ["radarlistener@gmail.com"]
+  s.homepage    = "http://github.com/radar/by_star"
+  s.summary     = "ActiveRecord and Mongoid extension for easier date scopes and time ranges"
+  s.description = "ActiveRecord and Mongoid extension for easier date scopes and time ranges"
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.post_install_message = File.read('UPGRADING') if File.exist?('UPGRADING')
+
+  s.add_dependency "activesupport", ">= 3.2.0"
+
+  s.add_development_dependency "chronic"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "mongoid"
+  s.add_development_dependency "pg"
+  s.add_development_dependency "mysql2"
+  s.add_development_dependency "rspec-rails", "~> 3.1"
+  s.add_development_dependency "timecop", "~> 0.3"
+  s.add_development_dependency "pry"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+end

data/cleaner.rb

@@ -1,25 +1,25 @@
-files = Dir["**/*"]
-ignored_files = [
-  /log\/.*/,
-]
-
-files.delete_if do |file|
-  if File.directory?(file)
-    true
-  else
-    ignored_files.any? do |condition|
-      if condition.is_a?(String)
-        file == condition
-      else
-        condition.match(file)
-      end
-    end || false
-  end
-end
-
-for file in files - ignored_files
-  if File.file?(file)
-    lines = File.readlines(file).map { |line| line.gsub(/^\s+$/, "\n") }
-    File.open(file, "w+") { |f| f.write(lines.join) }
-  end
+files = Dir["**/*"]
+ignored_files = [
+  /log\/.*/,
+]
+
+files.delete_if do |file|
+  if File.directory?(file)
+    true
+  else
+    ignored_files.any? do |condition|
+      if condition.is_a?(String)
+        file == condition
+      else
+        condition.match(file)
+      end
+    end || false
+  end
+end
+
+for file in files - ignored_files
+  if File.file?(file)
+    lines = File.readlines(file).map { |line| line.gsub(/^\s+$/, "\n") }
+    File.open(file, "w+") { |f| f.write(lines.join) }
+  end
 end

data/lib/by_star/base.rb

@@ -1,68 +1,69 @@
-module ByStar
-
-  module Base
-
-    include ByStar::Between
-    include ByStar::Directional
-
-    def by_star_field(*args)
-      options = args.extract_options!
-      @by_star_start_field ||= args[0]
-      @by_star_end_field   ||= args[1]
-      @by_star_offset      ||= options[:offset]
-      @by_star_scope       ||= options[:scope]
-    end
-
-    def by_star_offset(options = {})
-      (options[:offset] || @by_star_offset || 0).seconds
-    end
-
-    def by_star_start_field(options={})
-      field = options[:field] ||
-          options[:start_field] ||
-          @by_star_start_field ||
-          by_star_default_field
-      field.to_s
-    end
-
-    def by_star_end_field(options={})
-      field = options[:field] ||
-          options[:end_field] ||
-          @by_star_end_field ||
-          by_star_start_field
-      field.to_s
-    end
-
-    def by_star_scope(options={})
-      scope = options[:scope] || @by_star_scope || self
-      if scope.is_a?(Proc)
-        if scope.arity == 0
-          return instance_exec(&scope)
-        elsif options[:scope_args]
-          return instance_exec(*Array(options[:scope_args]), &scope)
-        else
-          raise 'ByStar :scope Proc requires :scope_args to be specified.'
-        end
-      else
-        return scope
-      end
-    end
-
-    protected
-
-    # Wrapper function which extracts time and options for each by_star query.
-    # Note the following syntax examples are valid:
-    #
-    #   Post.by_month                   # defaults to current time
-    #   Post.by_month(2, year: 2004)    # February, 2004
-    #   Post.by_month(Time.now)
-    #   Post.by_month(Time.now, field: "published_at")
-    #   Post.by_month(field: "published_at")
-    #
-    def with_by_star_options(*args, &block)
-      options = args.extract_options!.symbolize_keys!
-      time = args.first || Time.zone.now
-      block.call(time, options)
-    end
-  end
-end
+module ByStar
+
+  module Base
+
+    include ByStar::Between
+    include ByStar::Directional
+
+    def by_star_field(*args)
+      options = args.extract_options!
+      @by_star_start_field ||= args[0]
+      @by_star_end_field   ||= args[1]
+      @by_star_offset      ||= options[:offset]
+      @by_star_scope       ||= options[:scope]
+      @by_star_index_scope ||= options[:index_scope]
+    end
+
+    def by_star_offset(options = {})
+      (options[:offset] || @by_star_offset || 0).seconds
+    end
+
+    def by_star_start_field(options={})
+      field = options[:field] ||
+          options[:start_field] ||
+          @by_star_start_field ||
+          by_star_default_field
+      field.to_s
+    end
+
+    def by_star_end_field(options={})
+      field = options[:field] ||
+          options[:end_field] ||
+          @by_star_end_field ||
+          by_star_start_field
+      field.to_s
+    end
+
+    protected
+
+    # Wrapper function which extracts time and options for each by_star query.
+    # Note the following syntax examples are valid:
+    #
+    #   Post.by_month                   # defaults to current time
+    #   Post.by_month(2, year: 2004)    # February, 2004
+    #   Post.by_month(Time.now)
+    #   Post.by_month(Time.now, field: "published_at")
+    #   Post.by_month(field: "published_at")
+    #
+    def with_by_star_options(*args, &block)
+      options = args.extract_options!.symbolize_keys!
+      time = args.first || Time.zone.now
+      block.call(time, options)
+    end
+
+    def by_star_eval_index_scope(start_time, end_time, options)
+      value = options[:index_scope] || @by_star_index_scope
+      value = value.call(start_time, end_time, options) if value.is_a?(Proc)
+      case value
+        when nil, false then nil
+        when Time, DateTime, Date then value.in_time_zone
+        when ActiveSupport::Duration then start_time - value
+        when Numeric then start_time - value.seconds
+        when :beginning_of_day
+          offset = options[:offset] || 0
+          (start_time - offset).beginning_of_day + offset
+        else raise 'ByStar :index_scope option value is not a supported type.'
+      end
+    end
+  end
+end

data/lib/by_star/between.rb

@@ -1,156 +1,185 @@
-module ByStar
-
-  module Between
-
-    def between_times(*args)
-      options = args.extract_options!.symbolize_keys!
-
-      start_time, end_time = case args[0]
-                               when Array, Range then [args[0].first, args[0].last]
-                               else args[0..1]
-                             end
-
-      offset = (options[:offset] || 0).seconds
-      start_time += offset if start_time
-      end_time   += offset if end_time
-
-      start_field = by_star_start_field(options)
-      end_field = by_star_end_field(options)
-      scope = by_star_scope(options)
-
-      scope = if !start_time && !end_time
-                scope # do nothing
-              elsif !end_time
-                by_star_after_query(scope, start_field, start_time)
-              elsif !start_time
-                by_star_before_query(scope, start_field, end_time)
-              elsif start_field == end_field
-                by_star_point_query(scope, start_field, start_time, end_time)
-              elsif options[:strict]
-                by_star_span_strict_query(scope, start_field, end_field, start_time, end_time)
-              else
-                by_star_span_overlap_query(scope, start_field, end_field, start_time, end_time, options)
-              end
-
-      scope = by_star_order(scope, options[:order]) if options[:order]
-
-      scope
-    end
-
-    def by_day(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.time(time)
-        between_times(time.beginning_of_day, time.end_of_day, options)
-      end
-    end
-
-    def by_week(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.week(time, options)
-        start_day = Array(options[:start_day])
-        between_times(time.beginning_of_week(*start_day), time.end_of_week(*start_day), options)
-      end
-    end
-
-    def by_cweek(*args)
-      with_by_star_options(*args) do |time, options|
-        by_week(ByStar::Normalization.cweek(time, options), options)
-      end
-    end
-
-    def by_weekend(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.week(time, options)
-        between_times(time.beginning_of_weekend, time.end_of_weekend, options)
-      end
-    end
-
-    def by_fortnight(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.fortnight(time, options)
-        between_times(time.beginning_of_fortnight, time.end_of_fortnight, options)
-      end
-    end
-
-    def by_month(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.month(time, options)
-        between_times(time.beginning_of_month, time.end_of_month, options)
-      end
-    end
-
-    def by_calendar_month(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.month(time, options)
-        start_day = Array(options[:start_day])
-        between_times(time.beginning_of_calendar_month(*start_day), time.end_of_calendar_month(*start_day), options)
-      end
-    end
-
-    def by_quarter(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.quarter(time, options)
-        between_times(time.beginning_of_quarter, time.end_of_quarter, options)
-      end
-    end
-
-    def by_year(*args)
-      with_by_star_options(*args) do |time, options|
-        time = ByStar::Normalization.year(time, options)
-        between_times(time.beginning_of_year, time.end_of_year, options)
-      end
-    end
-
-    def today(options={})
-      by_day(Time.zone.now, options)
-    end
-
-    def yesterday(options={})
-      by_day(Time.zone.now.yesterday, options)
-    end
-
-    def tomorrow(options={})
-      by_day(Time.zone.now.tomorrow, options)
-    end
-
-    def past_day(options={})
-      between_times(Time.zone.now - 1.day, Time.zone.now, options)
-    end
-
-    def past_week(options={})
-      between_times(Time.zone.now - 1.week, Time.zone.now, options)
-    end
-
-    def past_fortnight(options={})
-      between_times(Time.zone.now - 2.weeks, Time.zone.now, options)
-    end
-
-    def past_month(options={})
-      between_times(Time.zone.now - 1.month, Time.zone.now, options)
-    end
-
-    def past_year(options={})
-      between_times(Time.zone.now - 1.year, Time.zone.now, options)
-    end
-
-    def next_day(options={})
-      between_times(Time.zone.now, Time.zone.now + 1.day, options)
-    end
-
-    def next_week(options={})
-      between_times(Time.zone.now, Time.zone.now  + 1.week, options)
-    end
-
-    def next_fortnight(options={})
-      between_times(Time.zone.now, Time.zone.now + 2.weeks, options)
-    end
-
-    def next_month(options={})
-      between_times(Time.zone.now, Time.zone.now + 1.month, options)
-    end
-
-    def next_year(options={})
-      between_times(Time.zone.now, Time.zone.now + 1.year, options)
-    end
-  end
-end
+module ByStar
+
+  module Between
+
+    def between_times(*args)
+      options = args.extract_options!.symbolize_keys!
+
+      start_time, end_time = ByStar::Normalization.extract_range(args)
+      offset = options[:offset] || 0
+
+      if start_time.is_a?(Date)
+        start_time = ByStar::Normalization.apply_offset_start(start_time.in_time_zone, offset)
+      elsif start_time
+        start_time += offset.seconds
+      end
+
+      if end_time.is_a?(Date)
+        end_time = ByStar::Normalization.apply_offset_end(end_time.in_time_zone, offset)
+      elsif end_time
+        end_time += offset.seconds
+      end
+
+      start_field = by_star_start_field(options)
+      end_field = by_star_end_field(options)
+
+      scope = self
+      scope = if !start_time && !end_time
+                scope # do nothing
+              elsif !end_time
+                by_star_after_query(scope, start_field, start_time)
+              elsif !start_time
+                by_star_before_query(scope, start_field, end_time)
+              elsif start_field == end_field
+                by_star_point_query(scope, start_field, start_time, end_time)
+              elsif options[:strict]
+                by_star_span_strict_query(scope, start_field, end_field, start_time, end_time)
+              else
+                by_star_span_loose_query(scope, start_field, end_field, start_time, end_time, options)
+              end
+
+      scope = by_star_order(scope, options[:order]) if options[:order]
+      scope
+    end
+
+    def between_dates(*args)
+      options = args.extract_options!
+      start_date, end_date = ByStar::Normalization.extract_range(args)
+      start_date = ByStar::Normalization.date(start_date)
+      end_date   = ByStar::Normalization.date(end_date)
+      between_times(start_date, end_date, options)
+    end
+
+    def at_time(*args)
+      with_by_star_options(*args) do |time, options|
+        start_field = by_star_start_field(options)
+        end_field = by_star_end_field(options)
+
+        scope = self
+        scope = if start_field == end_field
+                  by_star_point_overlap_query(scope, start_field, time)
+                else
+                  by_star_span_overlap_query(scope, start_field, end_field, time, options)
+                end
+        scope = by_star_order(scope, options[:order]) if options[:order]
+        scope
+      end
+    end
+
+    def by_day(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.date(time)
+        between_dates(date, date, options)
+      end
+    end
+
+    def by_week(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.week(time, options)
+        start_day = Array(options[:start_day])
+        between_dates(date.beginning_of_week(*start_day), date.end_of_week(*start_day), options)
+      end
+    end
+
+    def by_cweek(*args)
+      with_by_star_options(*args) do |time, options|
+        by_week(ByStar::Normalization.cweek(time, options), options)
+      end
+    end
+
+    def by_weekend(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.week(time, options)
+        between_dates(date.beginning_of_weekend, date.end_of_weekend, options)
+      end
+    end
+
+    def by_fortnight(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.fortnight(time, options)
+        between_dates(date.beginning_of_fortnight, date.end_of_fortnight, options)
+      end
+    end
+
+    def by_month(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.month(time, options)
+        between_dates(date.beginning_of_month, date.end_of_month, options)
+      end
+    end
+
+    def by_calendar_month(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.month(time, options)
+        start_day = Array(options[:start_day])
+        between_dates(date.beginning_of_calendar_month(*start_day), date.end_of_calendar_month(*start_day), options)
+      end
+    end
+
+    def by_quarter(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.quarter(time, options)
+        between_dates(date.beginning_of_quarter, date.end_of_quarter, options)
+      end
+    end
+
+    def by_year(*args)
+      with_by_star_options(*args) do |time, options|
+        date = ByStar::Normalization.year(time, options)
+        between_dates(date.beginning_of_year, date.to_date.end_of_year, options)
+      end
+    end
+
+    def today(options = {})
+      by_day(Date.current, options)
+    end
+
+    def yesterday(options = {})
+      by_day(Date.yesterday, options)
+    end
+
+    def tomorrow(options = {})
+      by_day(Date.tomorrow, options)
+    end
+
+    def past_day(options = {})
+      between_times(Time.current - 1.day, Time.current, options)
+    end
+
+    def past_week(options = {})
+      between_times(Time.current - 1.week, Time.current, options)
+    end
+
+    def past_fortnight(options = {})
+      between_times(Time.current - 2.weeks, Time.current, options)
+    end
+
+    def past_month(options = {})
+      between_times(Time.current - 1.month, Time.current, options)
+    end
+
+    def past_year(options = {})
+      between_times(Time.current - 1.year, Time.current, options)
+    end
+
+    def next_day(options = {})
+      between_times(Time.current, Time.current + 1.day, options)
+    end
+
+    def next_week(options = {})
+      between_times(Time.current, Time.current  + 1.week, options)
+    end
+
+    def next_fortnight(options = {})
+      between_times(Time.current, Time.current + 2.weeks, options)
+    end
+
+    def next_month(options = {})
+      between_times(Time.current, Time.current + 1.month, options)
+    end
+
+    def next_year(options = {})
+      between_times(Time.current, Time.current + 1.year, options)
+    end
+  end
+end