cache_column 0.1.1 → 0.1.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 [name of plugin creator]
+Copyright (c) 2010 Brian Malinconico
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Manifest

@@ -2,6 +2,8 @@ MIT-LICENSE
 Manifest
 README.rdoc
 Rakefile
+generators/cache_column/cache_column_generator.rb
+generators/cache_column/templates/cache_column_migration.rb.erb
 init.rb
 install.rb
 lib/cache_column.rb

data/README.rdoc

@@ -6,10 +6,56 @@ First add the following code to set-up the before_save filter and include the re
 
   has_cached_columns
   
-Next add a cache column
+Next, we need to set-up the columns that hold our cached values. This is accomplished through a migration
+
+  script/generate cache_column OBJECT/TABLENAME feild:type
+  
+For example
+  script/generate cache_column listing high_price:float low_price:float number_of_price_points:integer
+  
+The above migration will add cache columns of the defined time to the listings table.
+
+Now we need to add our cache column deffinations to the model. 
+ 
+The general format is
   cache_column :column_name, options
   
-=== Valid Options
+So for our example we want to add
+  cache_column :high_price
+  cache_column :low_price
+  cache_column :number_of_price_points 
+  
+Now this dosn't do much so far other then map the virtual attribute
+  Object.high_price
+to the database field
+  Ojbect.high_price_cache
+  
+No big deal, but the point is to store complex functions in the database. Lets say the high price attribute isn't so strait forward, and is calculated in the find_high_price function
+
+  def find_high_price
+    sleep(10)
+    return '10.05'
+  end
+  
+We can now tell the gem to update the cached value every time the object is saved by changing the cache_column deffination to
+
+  cache_column :high_price, :on_save => :recheck, :action => :find_high_price
+
+Its fairly self explanitory, but this just tells the gem to recheck the price stored in high_price_cache when the model is saved (or touched). The stored value is retreived from the function named in the :action key
+
+There are a few other options like
+  cache_column :high_price, :on_save => :blank
+and
+  cache_column :high_price, :on_save => :recheck, :action => :find_high_price, :update_validation => :high_price_changed
+  
+The :on_save => :blank just clears the value when it gets saved... not sure what the point of that is yet.
+
+:update_validation should be set to the name of a function, if that function returns false then the cache column will not be updated.
+
+I would love feedback, and bugs reports. 
 
+== Limitations / Bugs
+*Its my first gem.... so sorry for everything I've done wrong :)
+*It dosn't store variables yet... Mabey next version. Till then use sanitize
 
-Copyright (c) 2010 [name of plugin creator], released under the MIT license
+Copyright (c) 2010 Brian Malinconico, released under the MIT license

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('cache_column', '0.1.1') do |p|
+Echoe.new('cache_column', '0.1.2') do |p|
   p.description    = "Utilize the database to cache complex operations."
   p.url            = "http://github.com/arjes/Cache-Column"
   p.author         = "Brian Malinconico"

data/cache_column.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cache_column}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Malinconico"]
-  s.date = %q{2010-08-13}
+  s.date = %q{2010-08-21}
   s.description = %q{Utilize the database to cache complex operations.}
   s.email = %q{arjesins@gmail.com}
   s.extra_rdoc_files = ["README.rdoc", "lib/cache_column.rb", "lib/tasks/cache_column.rake"]
-  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "init.rb", "install.rb", "lib/cache_column.rb", "lib/tasks/cache_column.rake", "test/cache_column_test.rb", "test/test_helper.rb", "uninstall.rb", "cache_column.gemspec"]
+  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "generators/cache_column/cache_column_generator.rb", "generators/cache_column/templates/cache_column_migration.rb.erb", "init.rb", "install.rb", "lib/cache_column.rb", "lib/tasks/cache_column.rake", "test/cache_column_test.rb", "test/test_helper.rb", "uninstall.rb", "cache_column.gemspec"]
   s.homepage = %q{http://github.com/arjes/Cache-Column}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Cache_column", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/generators/cache_column/cache_column_generator.rb

@@ -0,0 +1,33 @@
+class CacheColumnGenerator < Rails::Generator::NamedBase
+  attr_accessor :cached_columns, :migration_name
+
+  def initialize(args, options = {})
+    super
+    @class_name = args[0]
+    @cached_columns = []
+    args[1..-1].each do |arg|
+      col_name, col_type = arg.split(':')
+      col_type ||= 'string'
+      @cached_columns.push({:name => col_name, :type => col_type})
+    end
+  end
+
+  def manifest
+    file_name = generate_file_name
+    @migration_name = file_name.camelize
+    record do |m|
+      m.migration_template "cache_column_migration.rb.erb",
+                           File.join('db', 'migrate'),
+                           :migration_file_name => file_name
+    end
+  end
+
+  private
+
+  def generate_file_name
+    names = @cached_columns.map{|a| a[:name].underscore }
+    names = names[0..-2] + ["and", names[-1]] if names.length > 1
+    "add_cache_column#{(names.length > 1) ? 's' : ''}_#{names.join("_")}_to_#{@class_name.underscore}"
+  end
+
+end

data/generators/cache_column/templates/cache_column_migration.rb.erb

@@ -0,0 +1,13 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% cached_columns.each do |attachment| -%>
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment[:name] %>_cache, :<%= attachment[:type] %>
+<% end -%>
+  end
+
+  def self.down
+<% cached_columns.each do |attachment| -%>
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment[:name] %>_cache
+<% end -%>
+  end
+end

data/init.rb

@@ -1,3 +1,3 @@
 # Include hook code here
 require 'cache_column'
-ActiveRecord::Base.send :include, CacheColumn
+

data/lib/cache_column.rb

@@ -30,6 +30,7 @@ module CacheColumn
 
       cached_columns.each do |key,params|
         next if params[:update_validation].present? and self.respond_to?(params[:update_validation]) and self.send("#{params[:update_validation]}") == false
+        next if params[:on_save].blank?
 
         if params[:on_save] == :blank
           new_value = ""
@@ -39,10 +40,10 @@ module CacheColumn
           set = true
         end
 
-        self.send("cache_#{key}=".to_sym, new_value) if set == true
+        self["#{key}_cache".to_sym] = new_value if set == true
       end
 
-      self.cache_updated_at = Time.now if self.respond_to?(:cached_updated_at)
+      #self.cache_updated_at = Time.now if self.respond_to?(:cached_updated_at)
     end
   
   
@@ -58,15 +59,17 @@ module CacheColumn
     end
   
     def method_missing(method, *arguments, &block)
-      if self.respond_to?("cache_#{method}".to_sym)
-        return self.send("cache_#{method}".to_sym, *arguments)
-      elsif self.respond_to?("cache_#{method.to_s.chop}")
-        return self.send("cache_#{method.to_s.chop}".to_sym)
+      cached_columns = self.class.instance_variable_get('@cached_columns')
+      
+      if cached_columns.keys.include?(method) #then its a getter
+        return self["#{method}_cache".to_sym]
+      elsif method.to_s[-1,1] == '=' and cached_columns.keys.include?(method.to_s.chop.to_sym) and cached_columns[method.to_s.chop.to_sym][:action].blank? #then its a setter
+        return self["#{method.to_s.chop}_cache".to_sym] = arguments[0]
+      else
+        super
       end
-      super
     end
   end
 end
 
-
-
+ActiveRecord::Base.send :include, CacheColumn

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cache_column
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Brian Malinconico
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-13 00:00:00 -04:00
+date: 2010-08-21 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,8 @@ files:
 - Manifest
 - README.rdoc
 - Rakefile
+- generators/cache_column/cache_column_generator.rb
+- generators/cache_column/templates/cache_column_migration.rb.erb
 - init.rb
 - install.rb
 - lib/cache_column.rb