acts_as_expirable 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b899168c5eb93007211f94db8bb907b43eb629c9
-  data.tar.gz: a0975e616f04ec8409f158d007ecbf958ac86ead
+  metadata.gz: 45f75fd75552f99c578b3da1af5ca12835d028b2
+  data.tar.gz: ede4bdd74972e87c869d509d71d816bbe8bcf4b4
 SHA512:
-  metadata.gz: 751c14d25cfd54b0484ef5782412ebfadf8981918fc7070da93a7894e214cf3826b07ef8cf022d24f409e813e1d26e46cc2fbef94263f3515368f368555591fb
-  data.tar.gz: 9d45a7a348d6a0c3dec36704cd2bbf8864a0cc31b9ae682c537254427dd5150b60d625c09c9935b6d4529a46abe07762f27babd81c13568ef43b796864c71956
+  metadata.gz: 9da3266d44de4c31fc8a607ab4af0119cf1b77ea6616df8aa7a3a57d2d8086a3074621034dadb662d2c0e3d97ca90b2acd74e5632b349d0a3cc7e07393c0bdbb
+  data.tar.gz: 12f5cea4de035042e16a6dad5aa1c6c16c05a8d287761520eec94f6122452d7aaef22387c9140f54e42a5fec71451050380a8f8287c333e6890406808422a4b0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) {{year}} {{fullname}}
+
+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,26 @@
+Acts As Expirable
+=================
+
+`acts_as_expirable` is an ActiveRecord mixin that enables simple handling of expiring records. It gives you `expired` and `unexpired` scopes as well as global handling of all expirable classes.
+
+## Usage
+
+```
+class SomeModel < ActiveRecord::Base
+  acts_as_expirable
+end
+```
+
+## Configuration Options
+
+To add configuration options, simply add a Hash of options to the `acts_as_expirable` call:
+
+```
+...
+acts_as_expirable column: 'some_timestamp', default: ->(r) { Time.now + 1.day }
+```
+
+### Options
+
+* `column` - the name of the ORM's field that you want to treat as the expiry time.
+* `default` - a default value to set on create if the expiry field is not yet set. Can be a value or a proc, yielding the record instance.

data/Rakefile

@@ -7,6 +7,7 @@ task :default => :test
 desc 'Test the acts_as_expirable plugin.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
+  t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
 end

data/acts_as_expirable.gemspec

@@ -11,7 +11,9 @@ Gem::Specification.new do |gem|
   gem.homepage = 'http://github.com/chingor13/acts_as_expirable'
   gem.license = 'MIT'
 
-  gem.add_runtime_dependency 'rails', '>= 3.0'
+  gem.add_runtime_dependency 'activerecord', '>= 3.0'
+  gem.add_runtime_dependency 'activesupport', '>= 3.0'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'mysql2', '~> 0.3.7'
 

data/lib/acts_as_expirable/expirable.rb

@@ -1,72 +1,41 @@
 module ActsAsExpirable
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
+  extend ActiveSupport::Concern
 
-  def self.cleanup!
-    expirable_classes.each do |klass|
-      klass.unscoped.destroy_expired
+  module ClassMethods
+    def acts_as_expirable(options = {})
+      include Expirable
+      self.acts_as_expirable_configuration = options.reverse_merge({
+        column: "expires_at"
+      })
     end
   end
 
-  def self.expirable_classes
-    @expirable_classes ||= []
-  end
-
-  def self.register_expirable(klass)
-    @expirable_classes ||= []
-    @expirable_classes << klass
-  end
+  module Expirable
+    extend ActiveSupport::Concern
 
-  module ClassMethods
-    def acts_as_expirable(options = {})
+    included do
       ActsAsExpirable.register_expirable(self)
+      class_attribute :acts_as_expirable_configuration
+      scope :expired, -> { where(["#{acts_as_expirable_configuration[:column]} <= ?", Time.now]) }
+      scope :unexpired, -> { where(["#{acts_as_expirable_configuration[:column]} IS NULL OR #{acts_as_expirable_configuration[:column]} > ?", Time.now]) }
+      delegate :expiry_column, to: :class
+      before_validation :set_expiry_default, on: :create
+    end
 
-      configuration = { :column => "expires_at" }
-      configuration.update(options) if options.is_a?(Hash)
-
-      class_eval %{
-        include ActsAsExpirable::InstanceMethods
-
-        scope :expired, where('#{configuration[:column]} <= UTC_TIMESTAMP()')
-        scope :unexpired, where('#{configuration[:column]} IS NULL OR #{configuration[:column]} > UTC_TIMESTAMP()')
-
-        class << self
-          def expiry_column
-            '#{configuration[:column]}'
-          end
-
-          def destroy_expired
-            expired.destroy_all
-          end
-
-          def delete_expired
-            expired.delete_all
-          end
-
-          def default_scope
-            unexpired
-          end
-        end
-      }
-
-      case configuration[:default]
-      when Proc
-        before_validation configuration[:default], :on => :create do
-          write_attribute(configuration[:column], configuration[:default].call(self)) if read_attribute(configuration[:column]).nil?
-          true
-        end
-      when NilClass
-      else
-        before_validation :on => :create do
-          write_attribute(configuration[:column], configuration[:default]) if read_attribute(configuration[:column]).nil?
-          true
-        end
+    module ClassMethods
+      def expiry_column
+        acts_as_expirable_configuration[:column]
+      end
+
+      def destroy_expired
+        expired.destroy_all
+      end
+
+      def delete_expired
+        expired.delete_all
       end
     end
-  end
 
-  module InstanceMethods
     def expire
       write_attribute(self.class.expiry_column, Time.now)
     end
@@ -80,5 +49,36 @@ module ActsAsExpirable
       return false if expire_time.nil?
       expire_time <= Time.now
     end
+
+    protected
+
+    def set_expiry_default
+      default = acts_as_expirable_configuration[:default]
+      return true if default.nil?
+
+      # set the value if the current value is not set
+      if read_attribute(acts_as_expirable_configuration[:column]).nil?
+        write_attribute(acts_as_expirable_configuration[:column],
+          default.respond_to?(:call) ? default.call(self) : default
+        )
+      end
+      true
+    end
+  end
+
+  def self.cleanup!
+    expirable_classes.each do |klass|
+      klass.unscoped.destroy_expired
+    end
   end
+
+  def self.expirable_classes
+    @expirable_classes ||= []
+  end
+
+  def self.register_expirable(klass)
+    @expirable_classes ||= []
+    @expirable_classes << klass
+  end
+
 end

data/lib/acts_as_expirable/version.rb

@@ -1,3 +1,6 @@
 module ActsAsExpirable
-  VERSION = "0.0.3"
+  MAJOR = 0
+  MINOR = 1
+  BUILD = 0
+  VERSION = [MAJOR, MINOR, BUILD].join(".")
 end

data/lib/acts_as_expirable.rb

@@ -1,2 +1,4 @@
+require 'active_record'
+require 'active_support/concern'
 require 'acts_as_expirable/expirable'
 ActiveRecord::Base.send(:include, ActsAsExpirable)

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.require(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+ActiveRecord::Schema.verbose = false
+
+def setup_db
+  ActiveRecord::Schema.define(version: 1) do
+    create_table :names do |t|
+      t.column :name, :string
+      t.column :expires_at, :datetime
+    end
+
+    create_table :tokens do |t|
+      t.column :token, :string
+      t.column :good_until, :datetime
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Name < ActiveRecord::Base
+  def self.table_name
+    "names"
+  end
+end
+
+class ExpirableName < Name
+  acts_as_expirable
+end
+
+class ExpirableNameDefault < Name
+  acts_as_expirable default: "2014-02-03 09:00:45 UTC"
+end
+
+class Token < ActiveRecord::Base
+  acts_as_expirable column: :good_until, default: ->(r) { Time.now + 1.day }
+end

data/test/unit/expirable_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+class ExpirableTest < Test::Unit::TestCase
+
+  def setup
+    super
+    setup_db
+    Name.create(name: "expired record", expires_at: Time.now - 1.hour)
+    Name.create(name: "future expired record", expires_at: Time.now + 2.hours)
+    Name.create(name: "doesn't expire", expires_at: nil)
+
+    Token.create(token: "expired", good_until: Time.now - 2.days)
+  end
+
+  def teardown
+    teardown_db
+    super
+  end
+
+  def test_class_registration
+    assert_equal([ExpirableName, ExpirableNameDefault, Token], ActsAsExpirable.expirable_classes)
+  end
+
+  def test_default_value
+    assert name = ExpirableNameDefault.create(name: "foo")
+    assert name.expires_at, "expires_at should be set"
+    assert_equal Time.parse("2014-02-03 09:00:45 UTC"), name.expires_at
+  end
+
+  def test_default_value_lambda
+    assert token = Token.create(token: "foo")
+    assert token.good_until
+    assert (Time.now.to_i + 1.day) - token.good_until.to_i <= 1, "should be set to nowish"
+  end
+
+  def test_expired
+    assert_equal(1, ExpirableName.expired.count)
+  end
+
+  def test_unexpired
+    assert_equal(2, ExpirableName.unexpired.count)
+  end
+
+  def test_destroy_all
+    count = ExpirableName.count
+    ExpirableName.destroy_expired
+    assert_equal count - 1, ExpirableName.count
+  end
+
+  def test_destroy_all_special_column
+    count = Token.count
+    Token.destroy_expired
+    assert_equal count - 1, Token.count
+  end
+
+  def test_cleanup
+    name_count = ExpirableName.count
+    token_count = Token.count
+
+    ActsAsExpirable.cleanup!
+
+    assert_equal name_count - 1, ExpirableName.count
+    assert_equal token_count - 1, Token.count
+  end
+
+  def test_expired
+    name = ExpirableName.find_by_name("expired record")
+    assert name.expired?
+  end
+
+  def test_expiring
+    name = ExpirableName.find_by_name("doesn't expire")
+    assert !name.expired?
+
+    # doesn't actually write
+    name.expire
+    assert name.expired?
+
+    name.reload
+    assert !name.expired?
+    name.expire!
+
+    name.reload
+    assert name.expired?
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_expirable
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeff Ching
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -24,6 +24,34 @@ dependencies:
     - - '>='
       - !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: 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
@@ -61,11 +89,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - acts_as_expirable.gemspec
 - lib/acts_as_expirable.rb
 - lib/acts_as_expirable/expirable.rb
 - lib/acts_as_expirable/version.rb
+- test/test_helper.rb
+- test/unit/expirable_test.rb
 homepage: http://github.com/chingor13/acts_as_expirable
 licenses:
 - MIT
@@ -90,4 +122,6 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Basic expiry for Rails.
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/unit/expirable_test.rb