periodic_counter 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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.markdown

@@ -0,0 +1,43 @@
+PeriodicCounter
+===============
+
+Maintains period fields on any counter column in your database
+
+Requirements
+------------
+
+<pre>
+sudo gem install periodic_template
+</pre>
+
+Create columns
+--------------
+
+You should already have a counter column defined that is being incremented by something (let's call the column X).
+
+Define period columns using this format: <code>X\_last\_week</code> or <code>X\_last\_6\_hours</code>.
+
+The period name should follow the format of [ActiveSupport's time extensions](http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Numeric/Time.html).
+
+Also add an <code>X_data</code> varchar column with a length of 2048.
+
+Create configuration
+--------------------
+
+Create a file, <code>config/counters.yml</code>:
+
+<pre>
+my_table_name:
+  - my_counter
+</pre>
+
+The plugin assumes that the <code>config</code> directory also houses your <code>database.yml</code> file.
+
+Create cron entry
+-----------------
+
+Add the following command to your crontab at a period of your choosing:
+
+<pre>
+cd /path/to/your/app && RAILS_ENV=production periodic_counter
+</pre>

data/Rakefile

@@ -0,0 +1,23 @@
+require "#{File.dirname(__FILE__)}/require"
+Require.rakefile!
+
+# You can delete this after you use it
+desc "Rename project"
+task :rename do
+  name = ENV['NAME'] || File.basename(Dir.pwd)
+  begin
+    dir = Dir['**/gem_template*']
+    from = dir.pop
+    if from
+      rb = from.include?('.rb')
+      to = File.dirname(from) + "/#{name}#{'.rb' if rb}"
+      FileUtils.mv(from, to)
+    end
+  end while dir.length > 0
+  Dir["**/*"].each do |path|
+    next if path.include?('Rakefile')
+    if File.file?(path)
+      `sed -i "" 's/gem_template/#{name}/g' #{path}`
+    end
+  end
+end

data/bin/periodic_counter

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.bin!
+
+PeriodicCounter.new(
+  ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development',
+  Dir.pwd
+)

data/lib/periodic_counter.rb

@@ -0,0 +1,84 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.lib!
+
+class PeriodicCounter
+  
+  def initialize(environment, root)
+    @db, @log, @mail = ActiveWrapper.setup(
+      :base => root,
+      :env => environment
+    )
+    @db.establish_connection
+    
+    @tables = ActiveRecord::Base.connection.tables.inject({}) do |hash, table|
+      hash[table] = ActiveRecord::Base.connection.columns(table).collect(&:name)
+      hash
+    end
+    
+    if File.exists?(counters_yml = "#{root}/config/counters.yml")
+      @counters = YAML::load(File.open(counters_yml))
+    else
+      raise "#{counters_yml} not found"
+    end
+    
+    @counters.each do |table, counters|
+      columns = @tables[table]
+      if columns
+        columns.each do |column|
+          if counters.include?(column)
+            # Find period columns
+            period = columns.select do |col|
+              col =~ /^#{column}/ &&
+              col != column &&
+              !col.include?('_data')
+            end
+            # Grab all records
+            select_columns = [ 'id', column, "#{column}_data" ]
+            select_columns += period
+            records = ActiveRecord::Base.connection.select_all <<-SQL
+              SELECT #{select_columns.join(', ')}
+              FROM #{table}
+            SQL
+            records.each do |record|
+              id = record.delete('id')
+              data = YAML::load(record["#{column}_data"] || '') || {}
+              count = record.delete(column).to_i
+              # Set period counters
+              period.each do |col|
+                computed_at = data["#{col}_at"] || Time.now.utc
+                duration = column_to_period_integer(col)
+                time_since_compute = Time.now.utc - computed_at
+                starting_value = data[col].to_i
+                if (time_since_compute - duration) >= 0
+                  record[col] = count - starting_value
+                  data[col] = count
+                  data["#{col}_at"] = Time.now.utc
+                else
+                  data[col] ||= count
+                  data["#{col}_at"] ||= Time.now.utc
+                end
+              end
+              # Update record
+              record["#{column}_data"] = "'#{YAML::dump(data)}'"
+              set = record.collect { |col, value| "#{col} = #{value || 0}" }
+              ActiveRecord::Base.connection.update <<-SQL
+                UPDATE #{table}
+                SET #{set.join(', ')}
+                WHERE id = #{id}
+              SQL
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  def column_to_period_integer(column)
+    column = column.split('_')[-2..-1]
+    column[0] = column[0].to_i
+    if column[0] == 0
+      column[0] = 1
+    end
+    eval(column.join('.'))
+  end
+end

data/require.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+gem 'require'
+require 'require'
+
+Require do
+  gem(:active_wrapper, '=0.2.7') { require 'active_wrapper' }
+  gem :require, '=0.2.7'
+  gem(:rake, '=0.8.7') { require 'rake' }
+  gem :rspec, '=1.3.0'
+  
+  gemspec do
+    author 'Winton Welsh'
+    dependencies do
+      gem :active_wrapper
+      gem :require
+    end
+    email 'mail@wintoni.us'
+    name 'periodic_counter'
+    homepage "http://github.com/winton/#{name}"
+    summary "Maintains period fields on any counter column in your database"
+    version '0.1.0'
+  end
+  
+  bin { require 'lib/periodic_counter' }
+  
+  lib do
+    gem :active_wrapper
+    require 'yaml'
+  end
+  
+  rakefile do
+    gem(:active_wrapper)
+    gem(:rake) { require 'rake/gempackagetask' }
+    gem(:rspec) { require 'spec/rake/spectask' }
+    require 'require/tasks'
+  end
+  
+  spec_helper do
+    gem(:active_wrapper)
+    require 'require/spec_helper'
+    require 'lib/periodic_counter'
+    require 'pp'
+  end
+  
+  spec_rakefile do
+    gem(:rake)
+    gem(:active_wrapper) { require 'active_wrapper/tasks' }
+  end
+end

data/spec/Rakefile

@@ -0,0 +1,10 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.spec_rakefile!
+
+begin
+  ActiveWrapper::Tasks.new(
+    :base => File.dirname(__FILE__),
+    :env => ENV['ENV']
+  )
+rescue Exception
+end

data/spec/config/counters.yml

@@ -0,0 +1,2 @@
+counters:
+  - counter

data/spec/config/database.yml.example

@@ -0,0 +1,6 @@
+test:
+  adapter: mysql
+  database: gem_template
+  username: root
+  password: 
+  host: localhost

data/spec/db/migrate/001_counters.rb

@@ -0,0 +1,14 @@
+class Counters < ActiveRecord::Migration
+  def self.up
+    create_table :counters do |t|
+      t.integer :counter
+      t.integer :counter_last_day
+      t.integer :counter_last_2_days
+      t.string :counter_data, :limit => 2048
+    end
+  end
+
+  def self.down
+    drop_table :counters
+  end
+end