activerecord-time-scope 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 893d1a58b0e6307c6131616ea70208b1ba41d56e
+  data.tar.gz: 5768fa3193147764439c093653462d94bc69ade3
+SHA512:
+  metadata.gz: 63af485ae9c2a98acee8337f7b2fd6ad9276796b3380036764e150b126b423799aa8a79756c02951e6608ccc04376d3ecbfa7b6f765fba80d4ebdd50c4f2a3fb
+  data.tar.gz: 44fec36195a17d594a01831577811533494108348cee91293847124c7477629e4c3971169c2d509aa23ca2572fd80d4c15ef38a328a8258eae153d0cdc8c83e1

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/log/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+## Misc
+Gemfile.lock
+gemfiles/*.lock
+.ruby-version
+.ruby-gemset
+.rvmrc

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+env:
+  -
+  - ACTIVE_RECORD_VERSION=3.2.0
+  - ACTIVE_RECORD_VERSION=4.0.0
+  - ACTIVE_RECORD_VERSION=4.1.0
+  - ACTIVE_RECORD_VERSION=4.2.0
+  - ACTIVE_RECORD_VERSION=4.2.0.beta1
+
+script: "bundle exec rake spec"
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "activerecord", "~> #{ENV['ACTIVE_RECORD_VERSION']}" if ENV['ACTIVE_RECORD_VERSION'].to_s != ''
+
+gem "sqlite3"
+gem 'database_cleaner'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daisuke Taniwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# activerecord-time-scope
+
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Build Status][build-image]][build-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Code Climate][gpa-image]][gpa-link]
+
+Add various time-related scopes for ActiveRecord!
+
+## Installation
+
+Add the activerecord-time-scope gem to your Gemfile.
+
+```ruby
+gem "activerecord-time-scope"
+```
+
+And run `bundle install`.
+
+## Usage
+
+### Time
+
+This gem automatically create scopes for time-related columns of your ActiveRecord model such as 'created_at'.
+
+```ruby
+class Foo < ActiveRecord::Base
+end
+```
+
+Then,
+
+```ruby
+Foo.created_before 3.days.ago
+Foo.created_after 3.days.ago
+Foo.created_within 3.days.ago, 3.days.from_now
+```
+
+Any columns with `_at`, `_on`, `_time` and `_date` postfix are considered as time-related columns.
+
+### Time Range
+
+If you want scopes for time ranges, you can create it manually.
+
+```
+class Round < ActiveRecord::Base
+  create_time_range_scope :run, :start_at, :end_at
+end
+```
+
+Then,
+
+```
+Round.run_before 3.days.ago
+Round.run_after 3.days.ago
+Round.run_within 3.days.ago, 3.days.from_now
+```
+
+will be available for the class!
+
+## TODO
+
+- Handle overwrapped cases
+- Include equal operators
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.
+
+
+
+
+[gem-image]:   https://badge.fury.io/rb/activerecord-time-scope.svg
+[gem-link]:    http://badge.fury.io/rb/activerecord-time-scope
+[build-image]: https://secure.travis-ci.org/dtaniwaki/activerecord-time-scope.png
+[build-link]:  http://travis-ci.org/dtaniwaki/activerecord-time-scope
+[deps-image]:  https://gemnasium.com/dtaniwaki/activerecord-time-scope.svg
+[deps-link]:   https://gemnasium.com/dtaniwaki/activerecord-time-scope
+[cov-image]:   https://coveralls.io/repos/dtaniwaki/activerecord-time-scope/badge.png
+[cov-link]:    https://coveralls.io/r/dtaniwaki/activerecord-time-scope
+[gpa-image]:   https://codeclimate.com/github/dtaniwaki/activerecord-time-scope.png
+[gpa-link]:    https://codeclimate.com/github/dtaniwaki/activerecord-time-scope
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/activerecord-time-scope.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/active_record/time_scope/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "activerecord-time-scope"
+  gem.version     = ActiveRecord::TimeScope::VERSION
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Daisuke Taniwaki"]
+  gem.email       = ["daisuketaniwaki@gmail.com"]
+  gem.homepage    = "https://github.com/dtaniwaki/activerecord-time-scope"
+  gem.summary     = "Time-Related Scope for ActiveRecord"
+  gem.description = "Time-Related Scope for ActiveRecord"
+  gem.license     = "MIT"
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "activerecord", ">= 3.2"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 3.0"
+  gem.add_development_dependency "coveralls"
+end

data/lib/active_record/time_scope.rb

@@ -0,0 +1,42 @@
+require 'active_record/time_scope/time_proxy'
+require 'active_record/time_scope/time_range_proxy'
+
+module ActiveRecord
+  module TimeScope
+    TIME_POSTFIX_REGEXP = /_(at|on|time|date)$/
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def inherited(subclass)
+        super
+        if subclass.table_exists?
+          subclass.column_names.each do |cn|
+            verb = cn.sub TIME_POSTFIX_REGEXP, ''
+            next if verb == cn
+            subclass.create_time_scope verb, cn
+          end
+        end
+      end
+
+      def create_time_scope(verb, name)
+        model = self
+        name = "#{table_name}.#{name}"
+        scope "#{verb}_before", ->(time, opts = {}){ TimeProxy.new(model, name).before(time, opts) }
+        scope "#{verb}_after", ->(time, opts = {}){ TimeProxy.new(model, name).after(time, opts) }
+        scope "#{verb}_within", ->(from, to, from_opts = {}, to_opts = {}){ TimeProxy.new(model, name).within(from, to, from_opts, to_opts) }
+      end
+
+      def create_time_range_scope(verb, from_name, to_name)
+        model = self
+        from_name = "#{table_name}.#{from_name}"
+        to_name = "#{table_name}.#{to_name}"
+        model.scope "#{verb}_before", ->(time, opts = {}){ TimeRangeProxy.new(model, from_name, to_name).before(time, opts) }
+        scope "#{verb}_after", ->(time, opts = {}){ TimeRangeProxy.new(model, from_name, to_name).after(time, opts) }
+        scope "#{verb}_within", ->(from, to, from_opts = {}, to_opts = {}){ TimeRangeProxy.new(model, from_name, to_name).within(from, to, from_opts, to_opts) }
+      end
+    end
+  end
+end

data/lib/active_record/time_scope/scope_proxy.rb

@@ -0,0 +1,10 @@
+module ActiveRecord
+  module TimeScope
+    class ScopeProxy
+      def new(*args)
+        @proxies ||= {}
+        @proxies[args] ||= super(*args)
+      end
+    end
+  end
+end

data/lib/active_record/time_scope/time_proxy.rb

@@ -0,0 +1,28 @@
+require_relative 'scope_proxy'
+
+module ActiveRecord
+  module TimeScope
+    class TimeProxy < ScopeProxy
+      def initialize(model, column_name)
+        @model = model
+        @column_name = column_name
+      end
+
+      def before(time, opts = {})
+        operator = opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("#{@column_name} #{operator} ?", time)
+      end
+
+      def after(time, opts = {})
+        operator = opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("? #{operator} #{@column_name}", time)
+      end
+
+      def within(from, to, from_opts = {}, to_opts = {})
+        from_operator = from_opts[:include_equal].to_s != '' ? '=<' : '<'
+        to_operator = to_opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("? #{from_operator} #{@column_name} AND #{@column_name} #{to_operator} ?", from, to)
+      end
+    end
+  end
+end

data/lib/active_record/time_scope/time_range_proxy.rb

@@ -0,0 +1,29 @@
+require_relative 'scope_proxy'
+
+module ActiveRecord
+  module TimeScope
+    class TimeRangeProxy < ScopeProxy
+      def initialize(model, column_name1, column_name2)
+        @model = model
+        @column_name1 = column_name1
+        @column_name2 = column_name2
+      end
+
+      def before(time, opts = {})
+        operator = opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("#{@column_name1} #{operator} ? AND #{@column_name2} #{operator} ?", time, time)
+      end
+
+      def after(time, opts = {})
+        operator = opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("? #{operator} #{@column_name1} AND ? #{operator} #{@column_name2}", time, time)
+      end
+
+      def within(from, to, from_opts = {}, to_opts = {})
+        from_operator = from_opts[:include_equal].to_s != '' ? '=<' : '<'
+        to_operator = to_opts[:include_equal].to_s != '' ? '=<' : '<'
+        @model.where("? #{from_operator} #{@column_name1} AND #{@column_name2} #{to_operator} ?", from, to)
+      end
+    end
+  end
+end

data/lib/active_record/time_scope/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module TimeScope
+    VERSION = ::File.read(::File.expand_path('../../../../VERSION', __FILE__)).to_s.strip
+  end
+end

data/lib/activerecord-time-scope.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+require 'active_record/time_scope.rb'
+
+ActiveRecord::Base.send :include, ActiveRecord::TimeScope
+

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+
+require 'database_cleaner'
+
+require 'activerecord-time-scope'
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+RSpec.configure do |c|
+  c.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+  c.before :example do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.start
+  end
+  c.after :example do
+    DatabaseCleaner.clean
+  end
+end
+

data/spec/support/tmp_model.rb

@@ -0,0 +1,23 @@
+def create_tmp_model(_model_name, _table_name = 'tmp', _columns = {}, &_block)
+  if ActiveRecord::Base.connection.table_exists? _table_name
+    ActiveRecord::Migration.drop_table _table_name
+  end
+  begin
+    Object.send :remove_const, _model_name
+  rescue NameError
+  end
+
+  ActiveRecord::Migration.create_table _table_name do |t|
+    _columns.each do |name, type|
+      t.column name, type
+    end
+  end
+  Object.class_eval <<-EOS
+    class #{_model_name} < ActiveRecord::Base
+      self.table_name = '#{_table_name}'
+    end
+  EOS
+  klass = Object.const_get _model_name
+  klass.class_exec(&_block) unless _block.nil?
+  klass
+end

data/spec/time_scope/time_range_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+RSpec.describe "time_range_spec" do
+  klass = create_tmp_model "Test2Class", "test2_classes", foo_at: :datetime, bar_at: :datetime do
+    create_time_range_scope :wow, :foo_at, :bar_at
+  end
+
+  describe "::wow_before" do
+    subject { klass.__send__("wow_before", time) }
+    let(:time) { DateTime.now }
+    context "foo & bar < time" do
+      let!(:model) { klass.create! foo_at: time - 2.days, bar_at: time - 1.days }
+      it { is_expected.to eq [model] }
+    end
+    context "time < foo & bar" do
+      let!(:model) { klass.create! foo_at: time + 1.days, bar_at: time + 2.days }
+      it { is_expected.to eq [] }
+    end
+    context "foo < time < bar" do
+      let!(:model) { klass.create! foo_at: time - 1.days, bar_at: time + 1.days }
+      it { is_expected.to eq [] }
+    end
+  end
+  describe "::wow_after" do
+    subject { klass.__send__("wow_after", time) }
+    let(:time) { DateTime.now }
+    context "foo & bar < time" do
+      let!(:model) { klass.create! foo_at: time - 2.days, bar_at: time - 1.days }
+      it { is_expected.to eq [] }
+    end
+    context "time < foo & bar" do
+      let!(:model) { klass.create! foo_at: time + 1.days, bar_at: time + 2.days }
+      it { is_expected.to eq [model] }
+    end
+    context "foo < time < bar" do
+      let!(:model) { klass.create! foo_at: time - 1.days, bar_at: time + 1.days }
+      it { is_expected.to eq [] }
+    end
+  end
+  describe "::wow_within" do
+    subject { klass.__send__("wow_within", time - 2.days, time + 2.days) }
+    let(:time) { DateTime.now }
+    context "time - 2.days < foo & bar < time + 2.days" do
+      let!(:model) { klass.create! foo_at: time - 1.days, bar_at: time + 1.days }
+      it { is_expected.to eq [model] }
+    end
+    context "time - 2.days < foo < time + 2.days < bar" do
+      let!(:model) { klass.create! foo_at: time + 1.days, bar_at: time + 3.days }
+      it { is_expected.to eq [] }
+    end
+    context "foo < time - 2.days < bar < time + 2.days" do
+      let!(:model) { klass.create! foo_at: time - 3.days, bar_at: time - 1.days }
+      it { is_expected.to eq [] }
+    end
+    context "foo < time - 2.days < time + 2.days < bar" do
+      let!(:model) { klass.create! foo_at: time - 3.days, bar_at: time + 3.days }
+      it { is_expected.to eq [] }
+    end
+    context "time - 2.days < time + 2.days < foo & bar" do
+      let!(:model) { klass.create! foo_at: time + 3.days, bar_at: time + 4.days }
+      it { is_expected.to eq [] }
+    end
+    context "foo & bar < time - 2.days < time + 2.days" do
+      let!(:model) { klass.create! foo_at: time - 4.days, bar_at: time - 3.days }
+      it { is_expected.to eq [] }
+    end
+  end
+end

data/spec/time_scope/time_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe "time_range_spec" do
+  klass = create_tmp_model "TestClass", "test_classes", foo_at: :datetime, bar_on: :date, xxx_time: :datetime, yyy_date: :date, zzz: :date do
+    create_time_scope :www, :zzz
+  end
+
+  describe "::create_time_scope" do
+    subject { klass }
+    it do
+      is_expected.to respond_to :www_before
+      is_expected.to respond_to :www_after
+      is_expected.to respond_to :www_within
+    end
+  end
+  describe "::inherited" do
+    subject { klass }
+    it do
+      %w(foo bar xxx yyy).each do |verb|
+        is_expected.to respond_to "#{verb}_before"
+        is_expected.to respond_to "#{verb}_after"
+        is_expected.to respond_to "#{verb}_within"
+      end
+    end
+  end
+  describe "::foo_before" do
+    subject { klass.foo_before(time) }
+    let(:time) { DateTime.now }
+    context "foo < time" do
+      let!(:model) { klass.create! foo_at: time + 1.days }
+      it { is_expected.to eq [] }
+    end
+    context "time < foo" do
+      let!(:model) { klass.create! foo_at: time - 1.days }
+      it { is_expected.to eq [model] }
+    end
+  end
+  describe "::foo_after" do
+    subject { klass.foo_after(time) }
+    let(:time) { DateTime.now }
+    context "foo < time" do
+      let!(:model) { klass.create! foo_at: time + 1.days }
+      it { is_expected.to eq [model] }
+    end
+    context "time < foo" do
+      let!(:model) { klass.create! foo_at: time - 1.days }
+      it { is_expected.to eq [] }
+    end
+  end
+  describe "::foo_within" do
+    subject { klass.foo_within(time - 2.days, time + 2.days) }
+    let(:time) { DateTime.now }
+    context "foo < -2 days < +2 days" do
+      let!(:model) { klass.create! foo_at: time - 3.days }
+      it { is_expected.to eq [] }
+    end
+    context "-2 days < foo < +2 days" do
+      let!(:model) { klass.create! foo_at: time }
+      it { is_expected.to eq [model] }
+    end
+    context "-2 days < +2 days < foo" do
+      let!(:model) { klass.create! foo_at: time + 3.days }
+      it { is_expected.to eq [] }
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-time-scope
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daisuke Taniwaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Time-Related Scope for ActiveRecord
+email:
+- daisuketaniwaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- activerecord-time-scope.gemspec
+- lib/active_record/time_scope.rb
+- lib/active_record/time_scope/scope_proxy.rb
+- lib/active_record/time_scope/time_proxy.rb
+- lib/active_record/time_scope/time_range_proxy.rb
+- lib/active_record/time_scope/version.rb
+- lib/activerecord-time-scope.rb
+- spec/spec_helper.rb
+- spec/support/tmp_model.rb
+- spec/time_scope/time_range_spec.rb
+- spec/time_scope/time_spec.rb
+homepage: https://github.com/dtaniwaki/activerecord-time-scope
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Time-Related Scope for ActiveRecord
+test_files:
+- spec/spec_helper.rb
+- spec/support/tmp_model.rb
+- spec/time_scope/time_range_spec.rb
+- spec/time_scope/time_spec.rb