temporal_scopes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01054fa8697a5d6a48d6cd36198905e919911a2e
+  data.tar.gz: 447d77b095f5c0d98c4972ab4debf32770e85c12
+SHA512:
+  metadata.gz: 395a9c350971e89678b547a9b6397eedc9817637f4c4f5ec98a299352e6acd95eee54ff9fd3723d63fb15dd367da221445b8d7e6b6e55137eca01a97a76560a5
+  data.tar.gz: aa871fb961337b880c652c9aef1507a094904bf5dd85d2ed3d73bf311e193a112dced1e6d392ca4a6876362d8a4da78f74b54c3b36e76832b8ac59dd3f0d9117

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Sebastian Fiedlschuster.
+
+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,82 @@
+# TemporalScopes [![Build Status](https://travis-ci.org/fiedl/temporal_scopes.svg?branch=master)](https://travis-ci.org/fiedl/temporal_scopes)
+
+Providing temporal scopes for an ActiveRecord model to allow queries by time. For example, `MyModel.now.where(...)`, `my_model.archive`, `MyModel.past.where(...)`.
+
+This is done by adding the database columns `valid_from` and `valid_to` to the model's table.
+
+## Usage
+
+### Make an `ActiveRecord` have temporal scopes
+
+```ruby
+class Article < ActiveRecord::Base
+  has_temporal_scopes
+  
+end
+```
+
+### Archive an object
+
+```ruby
+current_article = Article.create(title: 'My new article', body: 'Lorem ipsum')
+
+past_article = Article.create(title: 'My new article', body: 'Lorem ipsum')
+past_article.archive
+
+# or provide a datetime:
+past_article.archive at: 1.hour.ago
+```
+
+### Use temporal scopes for filtering
+
+```ruby
+Article.now                          #  => [current_article]
+Article.past                         #  => [past_article]
+Article.with_past                    #  => [current_article, past_article]
+```
+
+Note that the **default scope** is set to `now`.
+
+```ruby
+Article.all                          #  => [current_article]
+Article.now                          #  => [current_article]
+Article.with_past                    #  => [current_article, past_article]
+Article.without_temporal_condition   #  => [current_article, past_article]
+```
+
+### Documentation
+
+Further [documentation can be found on rubydoc.info](http://rubydoc.info/github/fiedl/temporal_scopes/master/frames).
+
+### Caveats
+
+* There is only one `valid_from` and one `valid_to` time per object. Therefore, you can't keep track of first archiving an object and later un-archiving it. Un-archiving an object loses the information of first archiving it.
+
+## Installation
+
+### Installing the Gem
+
+Add the gem to your `Gemfile`:
+
+```ruby
+# Gemfile
+# ...
+gem 'temporal_scopes'
+```
+
+Then, run `bundle install`.
+
+### Database
+
+Add the columns `valid_from` and `valid_to` to the model you would like to have temporal scopes.
+
+```
+bundle exec rails generate migration add_validity_period_to_articles valid_from:datetime:index valid_to:datetime:index
+bundle exec rake db:migrate
+```
+
+## Author and License
+
+Copyright (c) 2014 Sebastian Fiedlschuster.
+
+Released under the [MIT License](MIT-LICENSE).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TemporalScopes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/tasks/temporal_scopes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :temporal_scopes do
+#   # Task goes here
+# end

data/lib/temporal_scopes/has_temporal_scopes.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+
+module TemporalScopes
+  module HasTemporalScopes
+    
+    def has_temporal_scopes
+      
+      scope :without_temporal_condition, -> { 
+        relation = unscope(where: [:valid_from, :valid_to]) 
+        relation.where_values.delete_if { |query| query.to_sql.include?("\"valid_from\"") || query.to_sql.include?("\"valid_to\"") }
+        relation
+      }
+      
+      scope :now, -> { 
+        without_temporal_condition
+        .where(arel_table[:valid_from].eq(nil).or(arel_table[:valid_from].lteq(Time.zone.now)))
+        .where(arel_table[:valid_to].eq(nil).or(arel_table[:valid_to].gteq(Time.zone.now)))
+      }
+      scope :past, -> { without_temporal_condition.where('valid_to < ?', Time.zone.now) }
+      scope :with_past, -> { without_temporal_condition }
+      
+      default_scope { now }
+      
+      extend ClassMethods
+      include InstanceMethods
+    end
+    
+    module ClassMethods
+    end
+    
+    module InstanceMethods
+      
+      def archive(params = {})
+        unless self.valid_to
+          archive_at = params[:at] || Time.zone.now
+          update_attribute(:valid_to, archive_at)
+        end
+      end
+
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:extend, TemporalScopes::HasTemporalScopes)

data/lib/temporal_scopes/version.rb

@@ -0,0 +1,3 @@
+module TemporalScopes
+  VERSION = "0.0.1"
+end

data/lib/temporal_scopes.rb

@@ -0,0 +1 @@
+require 'temporal_scopes/has_temporal_scopes'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: temporal_scopes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sebastian Fiedlschuster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Providing temporal scopes for an ActiveRecord model to allow queries
+  by time. For example, `MyModel.now.where(...)`, `my_model.archive`, `MyModel.past.where(...)`.
+email:
+- sebastian@fiedlschuster.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/temporal_scopes_tasks.rake
+- lib/temporal_scopes.rb
+- lib/temporal_scopes/has_temporal_scopes.rb
+- lib/temporal_scopes/version.rb
+homepage: https://github.com/fiedl/temporal_scopes
+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: Providing temporal scopes for an ActiveRecord model to allow queries by time.
+  For example, `MyModel.now.where(...)`, `my_model.archive`, `MyModel.past.where(...)`.
+test_files: []
+has_rdoc: