acts_as_sweepable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Maciej Mensfeld
+
+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/Manifest

@@ -0,0 +1,8 @@
+MIT-LICENSE
+README.md
+Rakefile
+init.rb
+lib/acts_as_sweepable.rb
+spec/acts_as_sweepable_spec.rb
+spec/spec_helper.rb
+Manifest

data/README.md

@@ -0,0 +1,49 @@
+# Acts as Sweepable
+
+## Install
+
+    gem install acts_as_sweepable
+
+and in your Gemfile:
+    
+    gem 'acts_as_sweepable'
+
+## About
+
+Adds a class method called sweep to ActiveRecord - used to remove old elements.
+
+## Example
+
+    # Will remove elements older than 10 days
+    MyClass.sweep('10d')
+
+    # Will remove elements older than 10 hours
+    MyClass.sweep('10h')
+
+    # Will remove elements older than 10 minutes
+    MyClass.sweep('10m')
+
+Params accepted by this method:
+
+* `time_ago` - d(days),h(hours), m(minutes)
+* `conditions` - additional SQL conditions (like WHERE)
+* `created_or_updated` - (default true) - should it use updated_at and created_at to determine if object is old enough or should it use just created_at.
+
+You can also yield a block of code - it will be performed on every object that should be deleted:
+
+    MyClass.sweep('10d') do |el|
+        el.do_smhtng
+    end
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Maciej Mensfeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('acts_as_sweepable', '0.1.0') do |p|
+  p.description    = "Adds a class method called sweep to ActiveRecord - used to remove old elements"
+  p.url            = "https://github.com/mensfeld/acts_as_sweepable"
+  p.author         = "Maciej Mensfeld"
+  p.email          = "maciej@mensfeld.pl"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["rspec >=2.0.0", "active_record"]
+end
+

data/acts_as_sweepable.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_sweepable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Maciej Mensfeld"]
+  s.cert_chain = ["/home/mencio/.cert_keys/gem-public_cert.pem"]
+  s.date = %q{2011-04-09}
+  s.description = %q{Adds a class method called sweep to ActiveRecord - used to remove old elements}
+  s.email = %q{maciej@mensfeld.pl}
+  s.extra_rdoc_files = ["README.md", "lib/acts_as_sweepable.rb"]
+  s.files = ["MIT-LICENSE", "README.md", "Rakefile", "init.rb", "lib/acts_as_sweepable.rb", "spec/acts_as_sweepable_spec.rb", "spec/spec_helper.rb", "Manifest", "acts_as_sweepable.gemspec"]
+  s.homepage = %q{https://github.com/mensfeld/acts_as_sweepable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_sweepable", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_sweepable}
+  s.rubygems_version = %q{1.5.2}
+  s.signing_key = %q{/home/mencio/.cert_keys/gem-private_key.pem}
+  s.summary = %q{Adds a class method called sweep to ActiveRecord - used to remove old elements}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<active_record>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<active_record>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'acts_as_sweepable'
+

data/lib/acts_as_sweepable.rb

@@ -0,0 +1,40 @@
+
+module Acts
+  module AsSweepable
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def sweep(time_ago = nil, conditions = nil, created_or_updated = true)
+        time = case time_ago
+          when /^(\d+)m$/ then Time.now - $1.to_i.minute
+          when /^(\d+)h$/ then Time.now - $1.to_i.hour
+          when /^(\d+)d$/ then Time.now - $1.to_i.day
+          else Time.now - 1.hour
+        end
+
+        statement = "updated_at < '#{time.to_s(:db)}'"
+
+        if created_or_updated
+          statement += " OR created_at < '#{time.to_s(:db)}')"
+          statement = '('+statement
+        end
+
+        conditions = "AND #{conditions} " if conditions
+
+        els = self.where("#{statement} #{conditions}")
+
+        # Run on each block of code
+        els.each {|el| yield el } if block_given?
+
+        self.delete_all "#{statement} #{conditions}"
+      end
+    end
+    
+  end
+end
+
+ActiveRecord::Base.send(:include, Acts::AsSweepable)
+

data/spec/acts_as_sweepable_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+ROOT = File.expand_path(File.dirname(__FILE__))
+
+class CoolElement < ActiveRecord::Base
+end
+
+describe CoolElement do
+  subject { CoolElement }
+
+  before(:each){ CoolElement.destroy_all}
+
+  context "when object is old enough" do
+    it "should be sweeped" do
+      el = subject.create(:created_at => 10.days.ago)
+      subject.sweep('9d')
+      subject.all.count.should eql(0)
+      el = subject.create(:created_at => 10.hours.ago)
+      subject.sweep('9h')
+      subject.all.count.should eql(0)
+      el = subject.create(:created_at => 10.minutes.ago)
+      subject.sweep('9m')
+      subject.all.count.should eql(0)
+      el = subject.create(:created_at => 10.minutes.ago, :updated_at => 1.minutes.ago)
+      subject.sweep('9m')
+      subject.all.count.should eql(0)
+      el = subject.create(:created_at => 1.minutes.ago, :updated_at => 10.minutes.ago)
+      subject.sweep('9m')
+      subject.all.count.should eql(0)
+    end 
+  end
+
+  context "when object is not old enough" do
+    it "should not be sweeped" do
+      el = subject.create(:created_at => 10.days.ago)
+      subject.sweep('11d')
+      subject.all.count.should eql(1)
+      el = subject.create(:created_at => 10.minutes.ago)
+      subject.sweep('11m')
+      subject.all.count.should eql(1)
+      el = subject.create(:created_at => 10.hours.ago)
+      subject.sweep('11h')
+      subject.all.count.should eql(2)
+    end
+  end
+  
+  context "when we add additional parameter" do
+    it "should be used" do
+      el1 = subject.create(:created_at => 10.days.ago, :name => 'First')
+      el2 = subject.create(:created_at => 10.days.ago, :name => 'Second')
+      subject.sweep('9d', 'name LIKE "Second"')
+      subject.all.count.should eql(1)
+      subject.all.first.name.should eql "First"
+    end
+  end
+
+  context "when we use only updated_at" do
+    it "should sweep old objects" do
+      el = subject.create(:updated_at => 10.days.ago)
+      subject.sweep('9d', nil, false)
+      subject.all.count.should eql(0)
+    end
+
+    it "should not sweep recently updated objects" do
+      el = subject.create(:updated_at => 1.days.ago, :created_at => 10.days.ago)
+      subject.sweep('9d', nil, false)
+      subject.all.count.should eql(1)  
+    end
+  end
+
+  context "When we sweep smthg" do
+    it "should be able to perform on each" do
+      2.times { |i| subject.create(:created_at => 10.days.ago, :name => i.to_s) }
+      saved = []
+      subject.sweep('1d') do |el|
+        saved << el.name      
+      end
+      saved.first.to_i.should eql(0)
+      saved.last.to_i.should eql(1)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'sqlite3'
+require 'active_record'
+require 'acts_as_sweepable'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database  => ":memory:"
+)
+
+ActiveRecord::Schema.define do
+    create_table :cool_elements do |table|
+      table.text :name
+      table.timestamps
+    end
+end
+

data.tar.gz.sig

@@ -0,0 +1,2 @@
+����Ӌ"V���Dc��1H)%O�v{�V�6[��Պ�9Y��m�!�b'��.r����znn�1�[��(�i]Bp����"5��bE�����G�HJ�E�W�S�s��|<T�5�?&x�g��dL�Z���W
+����S�M��,��Q��B���+��aHm��C��{��2���߾{�

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_sweepable
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMjCCAhqgAwIBAgIBADANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZtYWNp
+  ZWoxGDAWBgoJkiaJk/IsZAEZFghtZW5zZmVsZDESMBAGCgmSJomT8ixkARkWAnBs
+  MB4XDTExMDQwOTA5NDcyMloXDTEyMDQwODA5NDcyMlowPzEPMA0GA1UEAwwGbWFj
+  aWVqMRgwFgYKCZImiZPyLGQBGRYIbWVuc2ZlbGQxEjAQBgoJkiaJk/IsZAEZFgJw
+  bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0+nG3V4/exIeiJ0IN+
+  wVfq8Utcu4Qpo+58EIVMIu3FiK+8w6MBvatZnUrRu12pqWLw9xrUkCiYeRErD+jF
+  AmdggIM/tu9CcjvURXH7VeTzOVA+pnV+eJWMD61o8HljFVcb/nyEYYVKErtr9/O4
+  QrIGv5lnszq1PMj2sBMy2gOP1YnzawncMLmkpp/T5SU4JZ5gAktGMRVz8RxmZzF5
+  6NVqFLbuqSRSU5U//WJvZVJt8dycCGgQzBM4Vi3nkOWyjIF0BANf1TqnlU2u6s8d
+  UK1AoDZfg5feef5e8eqoomHebX1opNGM/SOQhu3LRgax4rJfnl6VS3I2wighohsf
+  AgcCAwEAAaM5MDcwCQYDVR0TBAIwADAdBgNVHQ4EFgQUGlrWBqxVieAPk7NEzBDp
+  kM+iAMMwCwYDVR0PBAQDAgSwMA0GCSqGSIb3DQEBBQUAA4IBAQAJMoyBaJs8boiz
+  lFpbw6MWjk+7ZhqoHpFrWEV4nzb5GzyHZ7GU/pa1fSEQR0SCs+LnTLQbAYNQyUTT
+  O+UsTuA7xzI//v6cSodv3Q9NbfoDlou74xv1NXorWoosQFMpVWrXv+c/1RqU3cq4
+  WUr+rRiveEXG4tXOwkrpX8KH8xVp2vQZcGw3AXPqhzfqDGzpHd6ws3lk+8HoSrSo
+  2L68tDoxraF2Z2toAg9vfFw1+mOeDk1xVIPVcBy3tJxstHfHGHlQuMiRiDQX2b2D
+  YYU8UWVt2841IwB5Dgl4O+atXhe9ZTBO0W32pl4Bq5CP9lhQRT1KL7sxfznJlF7Y
+  BH3YFsdk
+  -----END CERTIFICATE-----
+
+date: 2011-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Adds a class method called sweep to ActiveRecord - used to remove old elements
+email: maciej@mensfeld.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- lib/acts_as_sweepable.rb
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/acts_as_sweepable.rb
+- spec/acts_as_sweepable_spec.rb
+- spec/spec_helper.rb
+- Manifest
+- acts_as_sweepable.gemspec
+has_rdoc: true
+homepage: https://github.com/mensfeld/acts_as_sweepable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_sweepable
+- --main
+- README.md
+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: "1.2"
+requirements: []
+
+rubyforge_project: acts_as_sweepable
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Adds a class method called sweep to ActiveRecord - used to remove old elements
+test_files: []
+