acts_as_daterange 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b73444d2249e280d38d31b6f85adf1125c1b143
+  data.tar.gz: ef339bf722d67ad32a4820b44ccbe1d0f1d17b4c
+SHA512:
+  metadata.gz: 39c486c508d7e92a1339c7925b0bffc703a8a5cf327cda755a505c410568d89bb17e4fed5663d7ce98336f8dc8972b8e7e31de9db92cff65edec8d9ca2b94aaa
+  data.tar.gz: 6a9e429b000b308b8f9d84673d3c8497cfcf00db59a9bc3710eace1127003ddc1d4c4964f7f9a92d04d810bf70728b0c22aaabfcba7259f36793836bd9c8aeb1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gilad Zohari
+
+MIT License
+
+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,78 @@
+# ActsAsDaterange
+
+This is home to the acts_as_daterange GEM.
+It adds the 'acts_as_daterange' directive to ActiveRecord models, and adds methods, scopes and validations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_daterange'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_daterange
+
+## Usage
+
+Given an AR model, for example Coupon, with start_date and end_date fields:
+```ruby
+class Coupon < ActiveRecord::Base
+  attr_accessible :start_date, :end_date
+  acts_as_daterange
+end
+
+> @coupon = Coupon.create start_date: 3.hours.ago, end_date: 3.hours.from_now
+```
+
+methods:
+```ruby
+> @coupon.active_now?
+> @coupon.started?
+> @coupon.ended?
+```
+
+scopes:
+```ruby
+> Coupon.active_now
+> Coupon.inactive_now
+> Coupon.active_at Date.today
+> Coupon.inactive_at 5.hours.ago
+```
+
+validations:
+```ruby
+> @coupon = Coupon.create start_date: 3.hours.from_now, end_date: 3.hours.ago
+> @coupon.errors[:end_date]
+=> must be after start_date
+```
+
+Notice that:
+- start_date=nil means started? == true always
+- and end_date=nil means that ended? == false always
+
+```ruby
+> Coupon.new.started?
+=> true
+> Coupon.new.ended?
+=> false
+```
+
+You can also override the field names:
+```ruby
+acts_as_daterange :started_at, :ended_at
+#  or
+acts_as_daterange start_date: :started_at, end_date: :ended_at
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/acts_as_daterange.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_daterange/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_daterange"
+  spec.version       = ActsAsDaterange::VERSION
+  spec.authors       = ["Gilad Zohari"]
+  spec.email         = [""]
+  spec.description   = %q{adds daterange to AR models}
+  spec.summary       = %q{adds daterange to AR models}
+  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_runtime_dependency 'activerecord', '>= 3.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "rspec"
+end

data/lib/acts_as_daterange/daterange.rb

@@ -0,0 +1,78 @@
+module Daterange
+  extend ActiveSupport::Concern
+  included do
+    class_attribute :daterange_config
+    validate :daterange_period
+  end
+
+  module ClassMethods
+    def expire_column
+      daterange_config[:expire_column]
+    end
+
+    def start_column
+      daterange_config[:start_column]
+    end
+
+    def active_at(time)
+      where("(#{start_column} IS NULL OR #{start_column} <= :time) AND 
+            (#{expire_column} IS NULL OR #{expire_column} > :time)",
+            time: time)
+    end
+
+    def inactive_at(time)
+      where("#{start_column} > :time OR #{expire_column} < :time",
+            time: time)
+    end
+
+    def active_now
+      active_at(Time.now)
+    end
+
+    def inactive_now
+      inactive_at(Time.now)
+    end
+  end
+
+  def expire_column
+    self.class.expire_column
+  end
+
+  def start_column
+    self.class.start_column
+  end
+
+  def expire
+    write_attribute(start_column, nil)
+    write_attribute(expire_column, Time.now)
+  end
+
+  def expire!
+    update_attribute(start_column, nil)
+    update_attribute(expire_column, Time.now)
+  end
+
+  def active_now?
+    started? and not ended?
+  end
+
+  private
+
+    def daterange_period
+      errors[start_column] << "must be present" if !self[start_column]
+      errors[expire_column] << "be present" if !self[expire_column]
+      if self[expire_column] < self[start_column]
+        errors[expire_column] << "must be after #{start_column}"
+      end
+    end
+
+    def started?
+      start_col = read_attribute(start_column)
+      start_col.nil? || start_col < Time.now
+    end
+
+    def ended?
+      expire_col = read_attribute(expire_column)
+      expire_col && expire_col < Time.now
+    end
+end

data/lib/acts_as_daterange/version.rb

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

data/lib/acts_as_daterange.rb

@@ -0,0 +1,38 @@
+require "acts_as_daterange/version"
+require 'active_record'
+require 'active_support/concern'
+require 'acts_as_daterange/daterange'
+
+class ActiveRecord::Base
+  extend ActsAsDaterange
+end
+
+module ActsAsDaterange
+  #  use default start_date, end_date
+  #  acts_as_daterange
+
+  #  set your own custom start_date and end_date
+  #  acts_as_daterange :started_at, :ended_at
+  #  or
+  #  acts_as_daterange start_date: :started_at, end_date: :ended_at
+  def acts_as_expirable(*args, start_date: nil, end_date: nil)
+    include Daterange
+
+    if args.present?
+      if start_date || end_date || args.count != 2
+        raise ArgumentError.new("ActsAsDaterange: must have both start_date and end_date")  
+      end
+      start_column,expire_column = args
+    elsif start_date || end_date
+      if !start_date || !end_date
+        raise ArgumentError.new("ActsAsDaterange: must have both start_date and end_date")
+      end
+      start_column,expire_column = start_date, end_date
+    end
+      
+    self.daterange_config = {
+      start_column: start_column || 'start_date',
+      expire_column: expire_column || 'end_date'
+    }
+  end
+end

data/spec/daterange_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+describe Daterange do
+    before do 
+      setup
+    end
+
+  describe 'default daterange' do
+    it 'validates daterange' do
+      expect { TestDefaultDaterange.create!(title: "That Time-Turner, it was driving me mad. I've handed it in", start_date: Time.now + 2.day, end_date: Time.now + 1.days) }.to raise_error(ActiveRecord::RecordInvalid)
+    end
+
+    describe '.expire' do
+      let(:record) { TestDefaultDaterange.create!(title: 'right now!', start_date: Time.now - 100.day, end_date: Time.now + 100.days) }
+      it "expires record" do
+        expect(record).to be_active_now
+        record.expire
+        expect(record).to_not be_active_now
+      end
+
+      it "doesn't commit the update" do
+        expect(record).to be_active_now
+        record.expire
+        record.reload
+        expect(record).to be_active_now
+      end
+    end
+    describe '.expire!' do
+      let(:record) { TestDefaultDaterange.create!(title: 'right now!', start_date: Time.now - 100.day, end_date: Time.now + 100.days) }
+      it "commits the expiration" do
+        expect(record).to be_active_now
+        record.expire!
+        expect(record).to_not be_active_now
+        record.reload
+        expect(record).to_not be_active_now
+      end
+    end
+
+    context "future daterange" do
+      before do 
+        TestDefaultDaterange.create!(title: 'future', start_date: Time.now + 1.day, end_date: Time.now + 2.days)
+      end
+      let(:future_daterange) { TestDefaultDaterange.first }
+      it "isn't .active_now?" do 
+        expect(future_daterange).to_not be_active_now
+      end
+      it "is #inactive_now" do
+        expect(TestDefaultDaterange.inactive_now.count).to eq 1
+      end
+      it "isn't #active_now" do
+        expect(TestDefaultDaterange.active_now).to be_empty
+      end
+      it "isn't #inactive_at tomorrow" do
+        expect(TestDefaultDaterange.inactive_at(Time.now + 1.day)).to be_empty
+      end
+      it "is #active_at tomorrow" do
+        expect(TestDefaultDaterange.active_at(Time.now + 1.day).count).to eq 1
+      end
+    end
+
+    context "active daterange" do
+      before do
+        TestDefaultDaterange.create!(title: 'right now!', start_date: Time.now - 100.day, end_date: Time.now + 100.days)
+      end
+      let(:active_daterange) { TestDefaultDaterange.first }
+      it "is .active_now?" do 
+        expect(active_daterange).to be_active_now
+      end
+      it "is #active_now" do
+        expect(TestDefaultDaterange.active_now.count).to eq 1
+      end
+      it "isn't #inactive_now" do
+        expect(TestDefaultDaterange.inactive_now).to be_empty
+      end
+      it "is #inactive_at tomorrow" do
+        expect(TestDefaultDaterange.inactive_at(Time.now + 200.day).count).to eq 1
+      end
+      it "isn't #active_at tomorrow" do
+        expect(TestDefaultDaterange.active_at(Time.now + 200.day)).to be_empty
+      end
+    end
+
+    context "expired daterange" do
+      before do
+        TestDefaultDaterange.create!(title: 'old news buddy!', start_date: Time.now - 100.day, end_date: Time.now - 99.days)
+      end
+      it "is #inactive_now" do
+        expect(TestDefaultDaterange.inactive_now.count).to eq 1
+      end
+      it "isn't #active_now" do
+        expect(TestDefaultDaterange.active_now).to be_empty
+      end
+    end
+  end
+
+  describe 'custom daterange' do
+    it 'has active items' do
+      TestCustomDaterange.create!(title: "i'm special me", promotion_start: Time.now - 2.day, promotion_expire: Time.now + 9.days)
+      expect(TestCustomDaterange.active_now.count).to eq 1
+      expect(TestCustomDaterange.inactive_now.count).to eq 0
+    end
+    it 'has inactive items' do
+      TestCustomDaterange.create!(title: "i'm special me", promotion_start: Time.now - 12.day, promotion_expire: Time.now - 9.days)
+      expect(TestCustomDaterange.active_now.count).to eq 0
+      expect(TestCustomDaterange.inactive_now.count).to eq 1
+    end
+    it 'validates daterange' do
+      expect { TestCustomDaterange.create!(title: "That Time-Turner, it was driving me mad. I've handed it in", promotion_start: Time.now + 2.day, promotion_expire: Time.now + 1.days) }.to raise_error(ActiveRecord::RecordInvalid)
+    end
+
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+# 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
+require 'acts_as_daterange'
+require 'acts_as_daterange/daterange'
+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
+
+def setup
+   ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => ':memory:'
+  )
+
+  ActiveRecord::Schema.define do
+    create_table :test_default_dateranges, force: true do |t|
+      t.column :title, :string
+      t.column :start_date, :datetime
+      t.column :end_date, :datetime
+    end
+
+    create_table :test_custom_dateranges, force: true do |t|
+      t.column :title, :string
+      t.column :promotion_start, :datetime
+      t.column :promotion_expire, :datetime
+    end
+  end
+end
+
+class TestDefaultDaterange < ActiveRecord::Base
+  acts_as_expirable
+end
+
+class TestCustomDaterange < ActiveRecord::Base
+  acts_as_expirable :promotion_start, :promotion_expire
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_daterange
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gilad Zohari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: adds daterange to AR models
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_daterange.gemspec
+- lib/acts_as_daterange.rb
+- lib/acts_as_daterange/daterange.rb
+- lib/acts_as_daterange/version.rb
+- spec/daterange_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.8
+signing_key: 
+specification_version: 4
+summary: adds daterange to AR models
+test_files:
+- spec/daterange_spec.rb
+- spec/spec_helper.rb