punching_bag 0.1.0

data/app/models/punch.rb

@@ -0,0 +1,104 @@
+class Punch < ActiveRecord::Base
+
+  belongs_to :punchable, :polymorphic => true
+
+  attr_accessible # none
+
+  before_validation :set_defaults
+  validates :punchable_id, :punchable_type, :starts_at, :ends_at, :average_time, :hits, :presence => true
+
+  default_scope order('punches.average_time DESC')
+  scope :combos, where('punches.hits > 1')
+  scope :jabs, where(:hits => 1)
+  scope :before, lambda{ |time| where('punches.ends_at <= ?', time) }
+  scope :after, lambda{ |*args|
+    time = args.first
+    time.nil?? scoped : where('punches.average_time >= ?', time)
+  }
+  scope :by_timeframe, lambda{ |timeframe, time|
+    where('punches.starts_at >= ? AND punches.ends_at <= ?', time.send("beginning_of_#{timeframe}"), time.send("end_of_#{timeframe}"))
+  }
+  scope :by_day, lambda { |day| by_timeframe(:day, day) }
+  scope :by_month, lambda { |month| by_timeframe(:month, month) }
+  scope :by_year, lambda { |year|
+    year = DateTime.new(year) if year.is_a? Integer
+    by_timeframe(:year, year)
+  }
+
+  def jab?
+    hits == 1
+  end
+
+  def combo?
+    hits > 1
+  end
+
+  def timeframe
+    if starts_at.month != ends_at.month
+      :year
+    elsif starts_at.day != ends_at.day
+      :month
+    elsif starts_at != ends_at
+      :day
+    else
+      :second
+    end
+  end
+
+  def day_combo?
+    timeframe == :day
+  end
+  
+  def month_combo?
+    timeframe == :month
+  end
+  
+  def year_combo?
+    timeframe == :year
+  end
+  
+  def find_combo_for(timeframe)
+    punches = punchable.punches.by_timeframe(timeframe, average_time)
+    punches.combos.first || punches.first
+  end
+  
+  def combine_with(combo)
+    if combo != self
+      combo.starts_at = starts_at if starts_at < combo.starts_at
+      combo.ends_at = ends_at if ends_at > combo.ends_at
+      combo.average_time = PunchingBag.average_time(combo, self)
+      combo.hits += hits
+      self.destroy if combo.save
+    end
+    combo
+  end
+  
+  def combine_by_day
+    unless day_combo? || month_combo? || year_combo?
+      combine_with find_combo_for(:day)
+    end
+  end
+  
+  def combine_by_month
+    unless month_combo? || year_combo?
+      combine_with find_combo_for(:month)
+    end
+  end
+  
+  def combine_by_year
+    unless year_combo?
+      combine_with find_combo_for(:year)
+    end
+  end
+
+  private
+  
+  def set_defaults
+    if date = (self.starts_at ||= DateTime.now)
+      self.ends_at ||= date
+      self.average_time ||= date
+      self.hits ||= 1
+    end
+  end
+
+end

data/lib/generators/punching_bag/punching_bag_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class PunchingBagGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(dirname)
+    sleep 1
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'create_punches_table.rb', 'db/migrate/create_punches_table.rb'
+  end
+end

data/lib/generators/punching_bag/templates/create_punches_table.rb

@@ -0,0 +1,20 @@
+class CreatePunchesTable < ActiveRecord::Migration
+  def self.up
+    create_table :punches do |t|
+      t.integer :punchable_id, :null => false
+      t.string :punchable_type, :null => false, :limit => 20
+      t.datetime :starts_at, :null => false
+      t.datetime :ends_at, :null => false
+      t.datetime :average_time, :null => false
+      t.integer :hits, :null => false, :default=>1
+    end
+    add_index :punches, [:punchable_type, :punchable_id], :name => :punchable_index, :unique => false
+    add_index :punches, :average_time, :unique => false
+  end
+
+  def self.down
+    remove_index :punches, :name => :punchable_index
+    remove_index :punches, :average_time
+    drop_table :punches
+  end
+end 

data/lib/punching_bag.rb

@@ -0,0 +1,25 @@
+module PunchingBag
+  require 'punching_bag/engine' if defined?(Rails)
+  require 'punching_bag/acts_as_punchable'
+  
+  def self.punch(punchable, request=nil)
+    if request.try(:bot?)
+      false
+    else
+      p = Punch.new
+      p.punchable = punchable
+      p.save ? p : false
+    end
+  end
+  
+  def self.average_time(*punches)
+    total_time = 0
+    hits = 0
+    punches.each do |punch|
+      total_time += punch.average_time.to_f * punch.hits
+      hits += punch.hits
+    end
+    Time.zone.at(total_time / hits)
+  end
+  
+end

data/lib/punching_bag/acts_as_punchable.rb

@@ -0,0 +1,31 @@
+module PunchingBag
+  module ActiveRecord
+  
+    module ClassMethods
+      def most_hit(since=nil, limit=5)
+        query = self.scoped.joins(:punches).group(:punchable_type, :punchable_id)
+        query = query.where('punches.average_time >= ?', since) unless since.nil?
+        query.order('SUM(punches.hits) DESC').limit(limit)
+      end
+    end
+    
+    module InstanceMethods
+      def hits(since=nil)
+        self.punches.after(since).sum(:hits)
+      end
+      
+      def punch(request=nil)
+        PunchingBag.punch(self, request)
+      end
+    end
+    
+  end
+end
+
+class ActiveRecord::Base
+  def self.acts_as_punchable
+    extend PunchingBag::ActiveRecord::ClassMethods
+    include PunchingBag::ActiveRecord::InstanceMethods
+    has_many :punches, :as => :punchable
+  end
+end

data/lib/punching_bag/acts_as_taggable_on.rb

@@ -0,0 +1,22 @@
+# Adds methods to enable tracking tags through a common polymorphic association
+module ActsAsTaggableOn
+  class Tag
+    def self.most_hit(since=nil, limit=5)
+      query = Tagging.scoped.
+        joins('INNER JOIN punches ON (taggings.taggable_id = punches.punchable_id AND taggings.taggable_type = punches.punchable_type)').
+        group(:tag_id).
+        order('SUM(punches.hits) DESC').
+        limit(limit)
+      query = query.where('punches.average_time >= ?', since) if since
+      query.map(&:tag)
+    end
+    
+    def hits(since=nil)
+      query = Tagging.scoped.
+        joins('INNER JOIN punches ON (taggings.taggable_id = punches.punchable_id AND taggings.taggable_type = punches.punchable_type)').
+        where(:tag_id => self.id)
+      query = query.where('punches.average_time >= ?', since) if since
+      query.sum('punches.hits')
+    end
+  end
+end

data/lib/punching_bag/engine.rb

@@ -0,0 +1,11 @@
+require 'punching_bag'
+require 'rails'
+require 'active_record'
+
+module PunchingBag
+  class Engine < Rails::Engine
+    initializer 'punching_bag.extend_acts_as_taggable_on' do
+      require 'punching_bag/acts_as_taggable_on' if defined? ActsAsTaggableOn
+    end
+  end
+end

data/lib/punching_bag/version.rb

@@ -0,0 +1,5 @@
+module PunchingBag
+
+  VERSION = '0.1.0'
+
+end

data/lib/tasks/punching_bag.rake

@@ -0,0 +1,29 @@
+namespace :punching_bag do
+
+  desc 'Combine old hit records together to improve performance'
+  task :combine, :by_day_after, :by_month_after, :by_year_after, :needs=>:environment do |t, args|
+    args.with_defaults :by_day_after => 7, :by_month_after => 1, :by_year_after => 1 
+    
+    punchables = Punch.all.map(&:punchable).uniq
+    punchables.each do |punchable|
+      
+      # by_year
+      punchable.punches.before(args[:by_year_after].years.ago).each do |punch|
+        punch.combine_by_year
+      end
+      
+      # by_month
+      punchable.punches.before(args[:by_month_after].months.ago).each do |punch|
+        punch.combine_by_month
+      end
+      
+      # by_day
+      punchable.punches.before(args[:by_day_after].days.ago).each do |punch|
+        punch.combine_by_day
+      end
+      
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: punching_bag
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Crownoble
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: voight_kampff
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+description: PunchingBag is a hit counting and simple trending engine for Ruby on Rails
+email: adam@obledesign.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/models/punch.rb
+- lib/punching_bag/acts_as_punchable.rb
+- lib/punching_bag/version.rb
+- lib/punching_bag/engine.rb
+- lib/punching_bag/acts_as_taggable_on.rb
+- lib/generators/punching_bag/punching_bag_generator.rb
+- lib/generators/punching_bag/templates/create_punches_table.rb
+- lib/punching_bag.rb
+- lib/tasks/punching_bag.rake
+homepage: https://github.com/adamcrown/punching_bag
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.2
+signing_key: 
+specification_version: 3
+summary: PunchingBag hit conter and trending plugin
+test_files: []
+