date_range_solr_query 0.0.1.beta1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+notifications:
+  email: false
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in date_range_solr_query.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2012-2013.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+[![Build Status](https://travis-ci.org/jkeck/date_range_solr_query.png?branch=master)](https://travis-ci.org/jkeck/date_range_solr_query)
+
+# DateRangeSolrQuery
+
+Given a start date, end date, and solr field this gem will return a string that can be sent to Solr as a range query.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'date_range_solr_query'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_range_solr_query
+
+## Usage
+
+There are 3 options accepted on initialization: start_date, end_date, and field.
+
+You can pass dates in the format of YYYY, YYYY-MM, or YYYY-MM-DD as the start_date and/or end_date and get the correctly formatted date range query.  Below you will find various examples.
+
+### Start Dates Only
+
+    DateRangeSolrQuery.new(:start_date => "2013").range_query
+    => "[2013-01-01T00:00:00Z TO 2013-12-31T23:59:59Z]"
+
+    DateRangeSolrQuery.new(:start_date => "2013-01").range_query
+    => "[2013-01-01T00:00:00Z TO 2013-01-31T23:59:59Z]"
+
+    DateRangeSolrQuery.new(:start_date => "2013-03-21").range_query
+    => "[2013-03-21T00:00:00Z TO 2013-03-21T23:59:59Z]"
+    
+    
+### Start and End Dates
+
+    DateRangeSolrQuery.new(:start_date => "2013", :end_date => "2014").range_query
+    => "[2013-01-01T00:00:00Z TO 2014-12-31T23:59:59Z]"
+
+    DateRangeSolrQuery.new(:start_date => "2013-01", :end_date => "2013-03").range_query
+    => "[2013-01-01T00:00:00Z TO 2013-03-31T23:59:59Z]"
+
+    DateRangeSolrQuery.new(:start_date => "2013-03-21", :end_date => "2013-05-12").range_query
+    => "[2013-03-21T00:00:00Z TO 2013-05-12T23:59:59Z]"
+
+
+### Mixed Formats
+
+    DateRangeSolrQuery.new(:start_date => "2013-01", :end_date => "2013-03-12").range_query
+    => "[2013-01-01T00:00:00Z TO 2013-03-12T23:59:59Z]"
+    
+### Field Option
+
+    DateRangeSolrQuery.new(:start_date => "2013", :field => "search_date").range_query
+    => "search_date:[2013-01-01T00:00:00Z TO 2013-12-31T23:59:59Z]"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/date_range_solr_query.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_range_solr_query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_range_solr_query"
+  spec.version       = DateRangeSolrQuery::VERSION
+  spec.authors       = ["Jessie Keck"]
+  spec.email         = ["jessie.keck@gmail.com"]
+  spec.description   = %q{Generates a date range query to send to Solr.}
+  spec.summary       = %q{Given a start date, end date, and solr field this gem will return a string that can be sent to Solr as a range query.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "activesupport"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/date_range_solr_query.rb

@@ -0,0 +1,137 @@
+require "date_range_solr_query/version"
+require "active_support/core_ext"
+require "date"
+
+class DateRangeSolrQuery
+  attr_reader :start_date, :end_date, :range_query
+  def initialize(options={})
+    @options = options
+    @_start = @options[:start_date]
+    @_end = @options[:end_date] || ""
+  end
+  
+  def range_query
+    [@options[:field], "[#{start_date} TO #{end_date}]"].compact.join(":")
+  end
+  
+  def start_date
+    "#{DateTime.parse(simple_start).strftime("%Y-%m-%d")}T00:00:00Z"
+  end
+  
+  def end_date
+    "#{(DateTime.parse(simple_end)).strftime("%Y-%m-%d")}T23:59:59Z"
+  end
+  
+  private
+
+  def start_year
+    case
+      when full_date_search?
+        DateTime.parse(@_start).strftime("%Y")
+      when year_and_month_search?
+        DateTime.parse("#{@_start}-01").strftime("%Y")
+      when year_only_search?
+        DateTime.parse("#{@_start}-01-01").strftime("%Y")
+    end
+  end
+  
+  def end_year
+    return start_year if single_date_search?
+    case
+      when full_end_date?
+        DateTime.parse(@_end).strftime("%Y")
+      when end_year_and_month_date?
+        DateTime.parse("#{@_end}-01").strftime("%Y")
+      when end_year_only_date?
+        DateTime.parse("#{@_end}-01-01").strftime("%Y")
+    end
+  end
+  
+  def start_month
+    case
+      when full_date_search?
+        DateTime.parse(@_start).strftime("%m")
+      when year_and_month_search?
+        DateTime.parse("#{@_start}-01").strftime("%m")
+      when year_only_search?
+        DateTime.parse("#{@_start}-01-01").strftime("%m")
+      end
+  end
+  
+  def end_month
+    case
+      when full_end_date?
+        DateTime.parse(@_end).strftime("%m")
+      when end_year_and_month_date?
+        DateTime.parse("#{@_end}-01").strftime("%m")
+      when (end_year_only_date? or year_only_search?)
+        # this should always be Dec. 31st
+        "12"
+      else
+        start_month
+    end
+  end
+  
+  def start_day
+    case
+      when full_date_search?
+        DateTime.parse(@_start).strftime("%d")
+      when year_and_month_search?
+        DateTime.parse("#{@_start}-01").strftime("%d")
+      when year_only_search?
+        DateTime.parse("#{@_start}-01-01").strftime("%d")
+    end
+  end
+  
+  def end_day
+    return (DateTime.parse(simple_start)).strftime("%d") if (single_date_search? and full_date_search?)
+    case
+      when full_end_date?
+        (DateTime.parse(@_end)).strftime("%d")
+      when (end_year_and_month_date? or year_only_search? or year_and_month_search?)
+        # this ensures we get the last day of the month.
+        ((DateTime.parse("#{end_year}-#{end_month}-01") + 1.month) - 1.day).strftime("%d")
+      when end_year_only_date?
+        # this should always be Dec. 31st
+        "31"
+    end
+  end
+  
+  def simple_start
+    "#{start_year}-#{start_month}-#{start_day}"
+  end
+  
+  def simple_end
+    "#{end_year}-#{end_month}-#{end_day}"
+  end
+  
+  def single_date_search?
+    @_start and @_end.blank?
+  end
+
+  def year_only_search?
+    @_start.strip =~ /^\d{4}$/
+  end
+
+  def year_and_month_search?
+    @_start.strip =~ /^\d{4}-\d{2}$/
+  end  
+  
+  def full_date_search?
+    @_start.strip =~ /^\d{4}-\d{2}-\d{2}$/
+  end
+  
+  
+  def end_year_only_date?
+    !@_end.blank? and @_end.strip =~ /^\d{4}$/
+  end
+  
+  def end_year_and_month_date?
+    !@_end.blank? and @_end.strip =~ /^\d{4}-\d{2}$/
+  end
+  
+  def full_end_date?
+    !@_end.blank? and @_end.strip =~ /^\d{4}-\d{2}-\d{2}$/
+  end
+  
+end

data/lib/date_range_solr_query/version.rb

@@ -0,0 +1,3 @@
+class DateRangeSolrQuery
+  VERSION = "0.0.1.beta1"
+end

data/spec/lib/date_range_solr_query_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+require "date_range_solr_query"
+
+describe DateRangeSolrQuery do
+  describe "field option" do
+    it "should take a field as an option to the query" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03-21", :field => "my_search_field").range_query
+      range_query.should match /^my_search_field:\[2013-03-21.*/
+    end
+    it "should only return a range when no field options is provided" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03-21").range_query
+      range_query.should match /^\[2013-03-21.* TO 2013-03-21.*\]$/
+    end
+  end
+  
+  describe "searching by one date" do
+    it "should search w/i a single date when only 1 full date is given" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03-21").range_query
+      range_query.should match /\[2013-03-21.* TO 2013-03-21.*\]/
+    end
+    
+    it "should search w/i a month when a single year and month is given" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03").range_query
+      range_query.should match /\[2013-03-01.* TO 2013-03-31.*\]/
+    end
+    
+    it "should add the appopriate ranges for a single year" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013").range_query
+      range_query.should match /\[2013-01-01.* TO 2013-12-31.*\]/
+    end
+  end
+  
+  describe "searching a range of dates" do
+    it "should search w/i the appropriate dates" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03-21", :end_date => "2014-08-12").range_query
+      range_query.should match /\[2013-03-21.* TO 2014-08-12.*\]/
+    end
+    
+    it "should search from the beginning of the first given month to the end of the last given month" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03", :end_date => "2014-08").range_query
+      range_query.should match /\[2013-03-01.* TO 2014-08-31.*\]/
+    end
+    
+    it "should search from the beginning of the first given year to the end of the last given year" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013", :end_date => "2014").range_query
+      range_query.should match /\[2013-01-01.* TO 2014-12-31.*\]/
+    end
+    
+    describe "mixed formats" do
+      it "should handle mixed month and year ranges" do
+        range_query = DateRangeSolrQuery.new(:start_date => "2013-02", :end_date => "2014").range_query
+        range_query.should match /\[2013-02-01.* TO 2014-12-31.*\]/
+      end
+      
+      it "should handle mixed full and month ranges" do
+        range_query = DateRangeSolrQuery.new(:start_date => "2013-02", :end_date => "2014-04-15").range_query
+        range_query.should match /\[2013-02-01.* TO 2014-04-15.*\]/
+      end
+    end
+  end
+  
+  describe "date oddities" do
+    it "should handle the end of the month dates properly" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-02", :end_date => "2014-04").range_query
+      range_query.should match /\[2013-02-01.* TO 2014-04-30.*\]/
+    end
+    it "should handle when the end date is nil" do
+      range_query = DateRangeSolrQuery.new(:start_date => "2013-03", :end_date => nil).range_query
+      range_query.should match /\[2013-03-01.* TO 2013-03-31.*\]/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: date_range_solr_query
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- Jessie Keck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates a date range query to send to Solr.
+email:
+- jessie.keck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- date_range_solr_query.gemspec
+- lib/date_range_solr_query.rb
+- lib/date_range_solr_query/version.rb
+- spec/lib/date_range_solr_query_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Given a start date, end date, and solr field this gem will return a string
+  that can be sent to Solr as a range query.
+test_files:
+- spec/lib/date_range_solr_query_spec.rb
+- spec/spec_helper.rb