has_metrics 0.0.1 → 0.0.2

data/has_metrics.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/has_metrics/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Allan Grant"]
   gem.email         = ["allan@allangrant.net"]
-  gem.description   = %q{Memoization into activerecord.}
+  gem.description   = %q{Calculate metrics and store them in the DB.}
   gem.summary       = %q{Calculate "metrics" (any expensive methods) on ActiveRecord entries and memoize them to an automagical table.}
   gem.homepage      = "http://github.com/allangrant/has_metrics"
 
@@ -15,9 +15,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = HasMetrics::VERSION
 
-  gem.add_dependency("activerecord")
-  gem.add_development_dependency("rake")
-  gem.add_development_dependency("shoulda")
-  # gem.add_development_dependency("mocha")
-  gem.add_development_dependency("sqlite3")
+  gem.add_dependency "activerecord"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "shoulda"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "pry"
 end

data/lib/has_metrics/metrics.rb

@@ -53,9 +53,14 @@ module Metrics
           result = instance_exec(&block)
           result = nil if result.is_a?(Float) && !result.finite?
           begin
-            metrics.update_attributes(name => result, datestamp_column => Time.zone.now)
-          rescue NoMethodError
-            # This happens if the migrations haven't run yet.  We should still calculate & return the metric.
+            metrics.send "#{name}=", result
+            metrics.send "#{datestamp_column}=", Time.now
+          rescue NoMethodError => e
+            raise e unless e.name == "#{name}=".to_sym
+            # This happens if the migrations haven't run yet for this metric. We should still calculate & return the metric.
+          end
+          unless changed?
+            metrics.save
           end
           result
         end
@@ -88,7 +93,8 @@ module Metrics
         :datetime
       when @float_metrics && @float_metrics.include?(column)
         :float
-      else :integer
+      else
+        :integer
       end
     end
     
@@ -145,7 +151,7 @@ module Metrics
         raise "Cannot determine if there were extra columns for has_metric when using the table itself for storing the metric!  Remove any columns manually"
         [] # We wont know what columns are excessive if the source changed
       else
-        (columns.map(&:name) - %w(id created_at updated_at)).map - required_columns   
+        (columns.map(&:name) - %w(id created_at updated_at)) - required_columns   
       end
       
     end

data/lib/has_metrics/segmentation.rb

@@ -0,0 +1,36 @@
+# include Segmentation
+module Segmentation
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  # CLASS METHODS ADDED
+  module ClassMethods
+    def segment_by category, &definition
+      (@segment_categories ||= []) << category.to_sym
+      define_method("segment_by_#{category}", definition)
+      if respond_to?(:has_metric)
+        has_metric "by_#{category}" do
+          send("segment_by_#{category}")
+        end
+      end
+    end
+    def segment_categories
+      @segment_categories
+    end
+    def update_segments!
+      puts "Updating all segments on #{name}: #{segment_categories.join(', ')}"
+      all.each do |object|
+        segment_categories.each do |category|
+          object.update_segment!(category)
+        end
+      end
+    end
+  end # END OF CLASS METHODS
+
+  # INSTANCE METHODS ADDED
+  def update_segment!(category)
+    update_attribute("by_#{category}", send("segment_by_#{category}"))
+  end
+  # END OF INSTANCE METHODS
+end

data/lib/has_metrics/version.rb

@@ -1,3 +1,3 @@
 module HasMetrics
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/has_metrics.rb

@@ -1,6 +1,10 @@
 require "has_metrics/version"
 require "has_metrics/metrics"
+require "has_metrics/segmentation"
 
 module HasMetrics
-  
+  def self.included(base)
+    base.send :include, Metrics
+    base.send :include, Segmentation
+  end
 end

data/test/functional/metrics_test.rb

@@ -1,23 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3",
-  :database => File.expand_path(File.dirname(__FILE__) + "/../test.db"))
-
-class CreateTestTables < ActiveRecord::Migration
-  def self.up
-    create_table "users", :force => true do |t|
-      t.string   "name"
-    end
-    create_table "user_metrics", :force => true
-  end
-  
-  def self.down
-    drop_table "users"
-    drop_table "user_metrics"    
-  end
-end
-
-
 class User < ActiveRecord::Base
   include Metrics
   has_metric :name_length do
@@ -25,16 +7,12 @@ class User < ActiveRecord::Base
   end
 end
 
-
 class MetricsTest < Test::Unit::TestCase
   context "when defining metrics" do
     setup do
-      root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-      
-      CreateTestTables.up
-      User.update_all_metrics!
-      @user_name =
+      CreateTestTables.up(:user)
       @user = User.create(:name => "Fuzz")
+      User.update_all_metrics!
     end
     
     should "create rows for the metrics" do
@@ -47,12 +25,27 @@ class MetricsTest < Test::Unit::TestCase
       assert_equal 16, @user.name_length_squared
     end
 
-    should "they should calculate their block when called" do
+    should "calculate their block when called" do
       assert_equal "Fuzz", @user.name
       assert_equal 4, @user.name_length
+
       @user.name = "Bib"
-      assert_equal 3, @user.name_length
+
+      # since 20 hours hasn't passed, the value is pulled from cache, not recalculated
+      assert_equal 4, @user.name_length
+      # (true) forces it to recalculate right away
+      assert_equal 3, @user.name_length(true)
+      
+      # since it wasn't saved, it's the same in the DB
       assert_equal 4, User.find_by_name("Fuzz").name_length
+      
+      @user.save
+      assert_equal 3, @user.name_length(true)
+      assert_equal 3, User.find_by_name("Bib").name_length      
+    end
+    
+    should "have their values precomputed" do
+      assert_equal({4=>1}, UserMetrics.count(:group => :name_length))
     end
   end
 end

data/test/functional/segmentation_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+
+class Post < ActiveRecord::Base
+  include Metrics
+  include Segmentation
+
+  segment_by :name_length do
+    case name.length
+    when 0..6
+      "short"
+    when 7
+      "seven"
+    else
+      "long"
+    end
+  end
+end
+
+class SegmentationTest < Test::Unit::TestCase
+  context "when defining segments" do
+    setup do
+      CreateTestTables.up(:post)
+
+      Post.create(:name => "Shorty")
+      Post.create(:name => "Seven!!")
+      Post.create(:name => "Really long")
+      Post.update_all_metrics!
+    end
+  
+    should "segment properly" do
+      assert_equal({'short'=>1, 'seven'=>1, 'long'=>1}, PostMetrics.count(:group => :by_name_length))
+    end
+  end
+end

data/test/test_helper.rb

@@ -5,6 +5,24 @@ $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'shoulda'
 # require 'mocha'
-require 'activerecord'
+require 'active_record'
 require 'sqlite3'
-require 'has_metrics/metrics'
+require 'has_metrics'
+require 'pry'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => File.expand_path(File.dirname(__FILE__) + "/../test.db"))
+
+
+class CreateTestTables < ActiveRecord::Migration
+  def self.up(model = :user)
+    create_table "#{model}s", :force => true do |t|
+      t.string   "name"
+    end
+    create_table "#{model}_metrics", :force => true
+  end
+  
+  def self.down(model = :user)
+    drop_table "#{model}s"
+    drop_table "#{model}_metrics"    
+  end
+end

metadata

@@ -1,89 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: has_metrics
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Allan Grant
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-07 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-  prerelease: false
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rake
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: shoulda
-  type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-description: Memoization into activerecord.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Calculate metrics and store them in the DB.
+email:
 - allan@allangrant.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -92,43 +106,44 @@ files:
 - has_metrics.gemspec
 - lib/has_metrics.rb
 - lib/has_metrics/metrics.rb
+- lib/has_metrics/segmentation.rb
 - lib/has_metrics/version.rb
+- test.db
 - test/functional/metrics_test.rb
+- test/functional/segmentation_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/allangrant/has_metrics
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -764161358984080823
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -764161358984080823
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Calculate "metrics" (any expensive methods) on ActiveRecord entries and memoize them to an automagical table.
-test_files: 
+summary: Calculate "metrics" (any expensive methods) on ActiveRecord entries and memoize
+  them to an automagical table.
+test_files:
 - test/functional/metrics_test.rb
+- test/functional/segmentation_test.rb
 - test/test_helper.rb