boole_time 0.1.0

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

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Pete Browne
+
+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,86 @@
+# BooleTime
+
+ActiveRecord plugin for creating a boolean virtual attribute and scopes from
+a date or datetime column.
+
+## Getting Started
+
+```ruby
+# Gemfile
+gem 'boole_time'
+```
+
+```bash
+$ bundle install
+$ rails generate model Post published_at:datetime
+# Or any model with a datetime column
+```
+
+```ruby
+# app/models/post.rb
+class Post < ActiveRecord::Base
+  boole_time :published_at
+end
+
+# elsewhere
+post = Post.new
+post.published = true
+post.published_at
+# => (Time.now)
+post.published = false
+post.published_at
+# => nil
+```
+
+## Documentation
+
+BooleTime considers a datetime attribute truthy if it is in the past.
+If the attribute is nil or in the future, it is considered false:
+
+```ruby
+post = Post.new
+post.published
+# => false
+post.published_at = 2.weeks.ago
+post.published
+# => true
+post.published_at = 2.weeks.from_now
+post.published
+# => false
+# Time travel to 3 weeks from now...
+post.published
+# => true
+```
+
+### Other Methods
+
+BooleTime also adds some query methods along with a negative version of the virtual attribute:
+
+```ruby
+post.published
+# => false
+post.published?
+# => false
+post.unpublished
+# => true
+post.unpublished?
+# => true
+```
+
+### Scopes
+
+BooleTime automatically adds named scopes that correspond to the positive and negative versions of the virtual attribute:
+
+```ruby
+Post.create published_at: nil
+Post.create published_at: 2.weeks.ago
+Post.create published_at: 2.weeks.from_now
+Post.published
+# => [#<Post id: 2, published_at: "(2 weeks ago)">]
+Post.unpublished
+# => [#<Post id: 1, published_at: nil>, #<Post id: 3, published_at: "(2 weeks from now)">]
+```
+
+## Copyright
+
+Copyright (c) 2012 [Pete Browne](http://petebrowne.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/boole_time.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/boole_time/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Pete Browne']
+  gem.email         = ['me@petebrowne.com']
+  gem.description   = %q{ActiveRecord plugin for creating a boolean virtual attribute from
+a datetime column.}
+  gem.summary       = %q{ActiveRecord plugin for creating a boolean virtual attribute and scopes from
+a date or datetime column.}
+  gem.homepage      = 'http://github.com/petebrowne/boole_time'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'boole_time'
+  gem.require_paths = ['lib']
+  gem.version       = BooleTime::VERSION
+
+  gem.add_development_dependency 'rspec',        '~> 2.11'
+  gem.add_development_dependency 'timecop',      '~> 0.4'
+  gem.add_development_dependency 'activerecord', '~> 3.2'
+  gem.add_development_dependency 'sqlite3',      '~> 1.3'
+end

data/lib/boole_time.rb

@@ -0,0 +1,76 @@
+require 'boole_time/version'
+
+module BooleTime
+  TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON'].freeze
+
+  # Creates a boolean attribute that corresponds to a date or date_time
+  # attribute. For instance:
+  #
+  #   class Post < ActiveRecord::Base
+  #     boole_time :published_at
+  #   end
+  #
+  # Generates these methods:
+  #
+  #   post.published = true
+  #   # sets published_at to Time.now
+  #   post.published
+  #   # => true
+  #   post.published = false
+  #   # sets published_at to nil
+  #   post.published?
+  #   # => false
+  #
+  def boole_time(*fields)
+    options = fields.extract_options!
+    mixin   = generated_feature_methods
+
+    fields.each do |field|
+      name        = options[:name]        || field.to_s.sub(/_(at|on)\z/, '')
+      negative    = options[:negative]    || "un#{name}"
+      true_scope  = options[:true_scope]  || name
+      false_scope = options[:false_scope] || negative
+
+      unless options[:scopes] == false
+        # Define truthy scope
+        scope(true_scope, Proc.new {
+          where(arel_table[field].lt(Time.now))
+        }) unless options[:true_scope] == false
+
+        # Define falsy scope
+        scope(false_scope, Proc.new {
+          field_attr = arel_table[field]
+          where(field_attr.eq(nil).or(field_attr.gt(Time.now)))
+        }) unless options[:false_scope] == false
+      end
+
+      # Define writer method
+      mixin.redefine_method(:"#{name}=") do |value|
+        if TRUE_VALUES.include?(value)
+          __send__(:"#{field}=", Time.now) unless __send__(name)
+        else
+          __send__(:"#{field}=", nil) if __send__(name)
+        end
+      end
+
+      # Define reader and query methods
+      mixin.redefine_method(name) do
+        value = __send__(field)
+        value.present? && value < Time.now
+      end
+      mixin.redefine_method(:"#{name}?") { __send__(name) }
+
+      # Define negative reader and query methods
+      unless options[:negative] == false
+        mixin.redefine_method(negative)        { !__send__(name) }
+        mixin.redefine_method(:"#{negative}?") { !__send__(name) }
+      end
+    end
+  end
+end
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.extend BooleTime
+elsif defined?(Rails)
+  require 'boole_time/railtie'
+end

data/lib/boole_time/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module BooleTime
+  class Railtie < Rails::Railtie
+    initializer 'boole_time' do
+      ActiveRecord::Base.extend BooleTime
+    end
+  end
+end

data/lib/boole_time/version.rb

@@ -0,0 +1,3 @@
+module BooleTime
+  VERSION = '0.1.0'
+end

data/spec/boole_time_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe BooleTime do
+  context 'when the time is nil' do
+    subject(:post) { Post.new published_at: nil }
+
+    its(:published)    { should be_false }
+    its(:published?)   { should be_false }
+    its(:unpublished)  { should be_true }
+    its(:unpublished?) { should be_true }
+
+    context 'when set to true' do
+      before { post.published = true }
+      its(:published_at) { should eq(Time.now) }
+    end
+
+    context 'when set to false' do
+      before { post.published = false }
+      its(:published_at) { should be_nil }
+    end
+  end
+
+  context 'when the time is in the future' do
+    subject(:post) { Post.new published_at: 2.weeks.from_now }
+
+    its(:published)    { should be_false }
+    its(:published?)   { should be_false }
+    its(:unpublished)  { should be_true }
+    its(:unpublished?) { should be_true }
+
+    context 'when set to true' do
+      before { post.published = true }
+      its(:published_at) { should eq(Time.now) }
+    end
+
+    context 'when set to false' do
+      before { post.published = false }
+      its(:published_at) { should eq(2.weeks.from_now) }
+    end
+  end
+
+  context 'when the time is in the past' do
+    subject(:post) { Post.new published_at: 2.weeks.ago }
+
+    its(:published)    { should be_true }
+    its(:published?)   { should be_true }
+    its(:unpublished)  { should be_false }
+    its(:unpublished?) { should be_false }
+
+    context 'when set to true' do
+      before { post.published = true }
+      its(:published_at) { should eq(2.weeks.ago) }
+    end
+
+    context 'when set to false' do
+      before { post.published = false }
+      its(:published_at) { should be_nil }
+    end
+  end
+
+  context 'with various times' do
+    subject { Post }
+
+    before do
+      @post_1 = Post.create published_at: nil
+      @post_2 = Post.create published_at: 2.weeks.ago
+      @post_3 = Post.create published_at: 2.weeks.from_now
+    end
+
+    after { Post.delete_all }
+
+    its(:published)   { should match_array([@post_2]) }
+    its(:unpublished) { should match_array([@post_1, @post_3]) }
+  end
+
+  context 'without scopes' do
+    subject { Post }
+    it { should_not respond_to(:subscribed) }
+    it { should_not respond_to(:unsubscribed) }
+  end
+
+  context 'without negatives' do
+    subject { Post.new }
+    it { should_not respond_to(:unsubscribed) }
+    it { should_not respond_to(:unsubscribed?) }
+  end
+
+  context 'with a custom name' do
+    subject { Post.new }
+    it { should respond_to(:trashed=) }
+    it { should respond_to(:trashed) }
+    it { should respond_to(:trashed?) }
+  end
+
+  context 'with a custom negative name' do
+    subject { Post.new }
+    it { should respond_to(:treasured) }
+    it { should respond_to(:treasured?) }
+  end
+
+  context 'with custom scope names' do
+    subject { Post }
+    it { should respond_to(:with_comments_open) }
+    it { should respond_to(:with_comments_closed) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+require 'boole_time'
+require 'timecop'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts do |t|
+    t.datetime :published_at
+    t.datetime :deleted_at
+    t.date     :subscribed_on
+    t.date     :comments_closed_on
+  end
+end
+
+class Post < ActiveRecord::Base
+  boole_time :published_at
+  boole_time :deleted_at, name: 'trashed', negative: 'treasured'
+  boole_time :subscribed_on, scopes: false, negative: false
+  boole_time :comments_closed_on, true_scope: 'with_comments_closed', false_scope: 'with_comments_open'
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Timecop.freeze
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: boole_time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Pete Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: ! 'ActiveRecord plugin for creating a boolean virtual attribute from
+
+  a datetime column.'
+email:
+- me@petebrowne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- boole_time.gemspec
+- lib/boole_time.rb
+- lib/boole_time/railtie.rb
+- lib/boole_time/version.rb
+- spec/boole_time_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/petebrowne/boole_time
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin for creating a boolean virtual attribute and scopes from
+  a date or datetime column.
+test_files:
+- spec/boole_time_spec.rb
+- spec/spec_helper.rb