date_flag 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9106544c22673b2a978bf4704309a8ce953b53ba
+  data.tar.gz: 90341cd241cf7ce6d3c5ced970a1595ce549732c
+SHA512:
+  metadata.gz: 784580c900ddcb3db6e0eb848da662cb1a217f2c41af4b03291c5f3931415af91078a43560e738eb3036c9ac40625a9c888c6087cadfabc53ed7995bd2a51f29
+  data.tar.gz: 59aa706183c4eed6c606ce61d41b9bb02c5443dec6c71ddf8ddec4554843a7f7c2f268f9138884764fbb2b5313f3a19da588ccc60edb9f5fc86e63dbfba42ea6

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org/'
+
+gem 'activerecord', '>= 3.0.0'
+
+group :development do
+  gem 'jeweler'
+  gem 'rdoc'
+  gem 'rails'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,145 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    arel (6.0.3)
+    builder (3.2.2)
+    concurrent-ruby (1.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    erubis (2.7.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    hashie (3.4.3)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rails
+  rdoc
+  sqlite3
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2014 The Working Group Inc.
+
+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,58 @@
+# Simple Date Flag Support for Rails
+
+This is a date flag method for ActiveRecord models and works with Rails 3.x
+or newer.
+
+A date flag is a DATETIME type column that behaves as a boolean. This helps
+when tracking things such as if article is published or if a user is banned
+while preserving information about when that event did or should occur.
+
+Dates can be in the past or in the future and the meaning of the flag is
+subjective.
+
+## Installation
+
+This can be installed as a Ruby gem by adding the following to your `Gemfile`:
+
+    gem 'date_flag'
+
+## Usage
+
+Inside your model if you have a column `banned_at`:
+
+    date_flag :banned_at
+
+This will introduce methods `banned?` for quick testing and `banned!` for
+immediately setting this flag and saving the record. There's also a `banned`
+scope established for that model.
+
+There are several options that can customize the name of the methods:
+
+* `:name` defines the base name for this flag and defaults to the name of the
+column minus the trailing `_at`.
+* `:scope` can be set to a a symbol or string, in which case that's the name of
+the generated scope, to `false` to skip creating the scope.
+* `:inverse` can be set with a symbol or string which will create a scope of
+this name that behaves in the opposite manner to the main scope.
+* `:action` can be set with a symbol or string that defines the name used
+when generating accessor methods.
+* `:inverse_action` can be set with a symbol or string which will create a
+method to unset the flag with the supplied name. If `:inverse` is set, that
+name will be used by default.
+
+These might be used together like this:
+   
+    date_flag :was_published_at,
+      name: :published,
+      scope: :published,
+      inverse: :unpublished,
+      inverse_action: :unpublish!,
+      action: :publish
+
+This results in instance methods `publish!` but the scopes are named
+`published` and `unpublished`. The flag itself is also available via the
+`published?` and `published=` methods.
+
+## License
+
+(C) 2009-2016 Scott Tadman, [The Working Group Inc.](http://twg.ca/)

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task default: :test
+
+desc 'Test the date_flag plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "date_flag"
+  gem.summary = %Q{Date field exension for ActiveRecord}
+  gem.description = %Q{Represents boolean fields as DateTime values to trigger events in the future or record when events happened in the past.}
+  gem.email = 'scott@twg.ca'
+  gem.homepage = "http://github.com/twg/date_flag"
+  gem.authors = [
+    "Scott Tadman <scott@twg.ca>"
+  ]
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1,3 @@
+require 'date_flag'
+
+ActiveRecord::Base.send(:extend, DateFlag)

data/lib/date_flag.rb

@@ -0,0 +1,128 @@
+module DateFlag
+  VERSION = File.read(File.expand_path('../VERSION', File.dirname(__FILE__))).chomp
+
+  # Usage:
+  #
+  # class MyModel < ActiveRecord::Base
+  #   date_flag :flagged_at, action: :flag
+  # end
+  #
+  # m = MyModel.new
+  # m.flagged?     # => false
+  # m.flag!        # Assigns flag_at to current time
+  # m.flag = true  # Same as flag!
+  # m.flagged?     # => true
+
+  def date_flag(field, options =  { })
+    name = (options[:name] ? options[:name] : field.to_s.sub(/_at$/, '')).to_sym
+    action = (options[:action] ? options[:action] : name).to_sym
+
+    scope_name =
+      case (options[:scope])
+      when nil, true
+        name
+      when false
+        false
+      else
+        options[:scope].to_s.to_sym
+      end
+
+    case (scope_name)
+    when false, nil
+      # Skip this operation
+    when :send, :id
+      # TODO: Invalid names, should raise exception or warning
+    else
+      scope scope_name, lambda { |*flag|
+        case (flag.first)
+        when false
+          where(field => nul)
+        when true, nil
+          where.not(field => nil)
+        else
+          # FIX: Escape properly for Postgres/MySQL
+          where([ "#{field}<=?", flag.first ])
+        end
+      }
+    end
+
+    if (options[:inverse])
+      scope options[:inverse], lambda { |*flag|
+        case (flag.first)
+        when false
+          where.not(field => nil)
+        when true, nil
+          where(field => nil)
+        else
+          # FIX: Escape properly for Postgres/MySQL
+          where([ "#{field}>?", flag.first ])
+        end
+      }
+    end
+
+    if (inverse_action = options[:inverse_action] || options[:inverse])
+      define_method(:"#{inverse_action}!") do
+        write_attribute(field, nil)
+        
+        save!
+      end
+    end
+
+    define_method(:"#{name}=") do |value|
+      # The action= mutator method is used to manipulate the trigger time.
+      # Values of nil, false, empty string, '0' or 0 are presumed to be
+      # false and will nil out the time. A DateTime, Date or Time object
+      # will be saved as-is, and anything else will just assign the current
+      # time.
+
+      case (value)
+      when nil, false, '', '0', 0
+        write_attribute(field, nil)
+      when DateTime, Date, Time
+        write_attribute(field, value)
+      else
+        !read_attribute(field) and write_attribute(field, Time.now)
+      end
+    end
+
+    define_method(:"#{name}") do
+      value = read_attribute(field)
+
+      value ? (value <= Time.now) : false
+    end
+
+    define_method(:"#{name}?") do
+      # The name? accessor method will return true if the date is defined
+      # and is prior to the current time, or false otherwise.
+      value = read_attribute(field)
+
+      value ? (value <= Time.now) : false
+    end
+
+    define_method(:"#{action}!") do |*at_time|
+      # The name! method is used to set the trigger time. If the time is
+      # already defined and is in the past, then the time is left unchanged.
+      # If it is undefined or in the future, then the current time is
+      # substituted.
+
+      value = read_attribute(field)
+
+      at_time =
+        case (at_time.first)
+        when false
+          nil
+        else
+          at_time.first || value || Time.now
+        end
+
+      return if (at_time == value)
+
+      write_attribute(field, at_time)
+      save!
+    end
+  end
+end
+
+if (defined?(ActiveRecord))
+  ActiveRecord::Base.extend(DateFlag)
+end

data/test/date_flag_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class DateFlagTest < ActiveSupport::TestCase
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: date_flag
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Scott Tadman <scott@twg.ca>
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-31 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: rdoc
+  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: rails
+  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'
+description: Represents boolean fields as DateTime values to trigger events in the
+  future or record when events happened in the past.
+email: scott@twg.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- lib/date_flag.rb
+- test/date_flag_test.rb
+- test/test_helper.rb
+homepage: http://github.com/twg/date_flag
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Date field exension for ActiveRecord
+test_files: []