slim_scrooge 0.1.1 → 1.0.0

data/README.textile

@@ -6,11 +6,13 @@ It's an optimization layer to ensure your application only fetches the database
 
 SlimScrooge implements both lazy loading of attributes fetched from mysql, as well as inline query optimisation, automatically restricting the columns fetched based on what was used during previous passes through the same part of your code.
 
+SlimScrooge is similar to (and is partly derived from) "Scrooge":http://github.com/methodmissing/scrooge but has many fewer lines of code and is faster.
+
 h2. Benchmark
 
 SlimScrooge performs best when the database is not on the same machine as your rails app.  In this case the overhead of fetching unnecessary data from the database can become more important.
 
-I ran a benchmark that consisted of fetching 400 real urls (culled from the log file) from our complex web app.  In this test I found a consistent 12% improvement in performance over plain active record.  Not earth-shattering, but worthwhile.  In future releases I expect further gains.
+I ran a benchmark that consisted of fetching 400 real urls (culled from the log file) from our complex web app.  In this test I found a consistent *12% improvement* in performance over plain active record.  Not earth-shattering, but worthwhile.  In future releases I expect further gains.
 
 h2. Installation
 
@@ -22,11 +24,13 @@ h2. Installation
   sudo gem install slim_scrooge
 </pre>
 
-h3. Requirements
+Then add this to your Rails::Initializer section in environment.rb:
 
-* "Slim-attributes":http://github.com/sdsykes/slim-attributes
+<pre>
+  config.gem 'slim_scrooge'
+</pre>
 
-h3. What it does
+h2. What it does
 
 <pre>
   # 1st request, sql is unchanged but columns accesses are recorded
@@ -46,21 +50,19 @@ h3. What it does
   `brochures`.id FROM `brochures` WHERE (expires_at IS NULL)
 </pre>
 
-h3. Technical discussion
+h2. Technical discussion
 
-SlimScrooge hooks in at just one particular place in the mysql adapter - and that place is the select_all method.  All select queries pass through this method.
+SlimScrooge hooks in at just one particular place in ActiveRecord - and that place is the find_all_by_sql method.  All select queries pass through this method.
 
 SlimScrooge is able to record each call (and where it came from in your code), and to modify queries that do SELECT * FROM en-route to mysql so that they only select the rows that are actually used by that piece of code.
 
 How does SlimScrooge know which columns are actually used?
 
-Enter Slim-attributes.  Slim-attributes also hooks in at one place, the all_hashes method - and in particular it returns a proxy for the hash for each row, and doesn't actually instantiate any ruby objects for the columns in each row until they are needed.
-
-Clearly slim-attributes knows when each column is accessed, and this information can be collected by SlimScrooge for future use.
+It tracks them using a monitored hash - the hash is a subclass of Hash that has is instantiated with a proc for its default value.  In this proc we handle any attributes that were not fetched from the DB - fetching the remaining columns as needed.
 
-In fact for efficiency, column accesses are only recorded when they are for newly accessed columns.  Columns we already know about are accessed completely normally, and slim-attributes provides its usual lazy-loading benefit without any additional overhead.
+In fact for efficiency, column accesses are only recorded when they are for newly accessed columns.  Columns we already know about are accessed completely normally, and there is no additional overhead.
 
-h3. Caveats
+h2. Caveats
 
 It is possible to delete an object and then to try to use its attributes to access another object that perhaps must be also deleted (like the option :dependent=>:destroy in Rails associations).
 
@@ -78,7 +80,6 @@ To run the tests you need to set your database up with appropriate access for th
 
 h2. References
 * "Scrooge":http://github.com/methodmissing/scrooge
-* "Slim-attributes":http://github.com/sdsykes/slim-attributes
 
 h2. Authors
 * Stephen Sykes (sdsykes)

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 0
-:minor: 1
+:minor: 0
+:patch: 0
 :build: 
-:patch: 1
+:major: 1

data/lib/slim_scrooge/callsite.rb

@@ -62,7 +62,9 @@ module SlimScrooge
     end
 
     def scrooge_select_sql(set)
-      set.collect{|name| "#{@quoted_table_name}.#{name}"}.join(ScroogeComma)
+      set.collect do |name|
+        "#{@quoted_table_name}.#{@model_class.connection.quote_column_name(name)}"
+      end.join(ScroogeComma)
     end
   end
 end

data/lib/slim_scrooge/monitored_hash.rb

@@ -2,38 +2,65 @@
 
 module SlimScrooge
   class MonitoredHash < Hash
-    attr_accessor :callsite, :result_set
+    attr_accessor :callsite, :result_set, :monitored_columns
     
-    def self.[](original_hash, callsite, result_set)
-      hash = super(original_hash)
+    def self.[](monitored_columns, unmonitored_columns, callsite)
+      hash = MonitoredHash.new {|hash, key| hash.new_column_access(key)}
+      hash.monitored_columns = monitored_columns
+      hash.merge!(unmonitored_columns)
       hash.callsite = callsite
-      hash.result_set = result_set
       hash
     end
     
-    def [](name)
+    def new_column_access(name)
       if @callsite.columns_hash.has_key?(name)
         @result_set.reload! if @result_set && name != @callsite.primary_key
         Callsites.add_seen_column(@callsite, name)
       end
-      super
+      @monitored_columns[name]
     end
     
     def []=(name, value)
-      if @result_set && @callsite.columns_hash.has_key?(name)
+      if has_key?(name)
+        return super
+      elsif @result_set && @callsite.columns_hash.has_key?(name)
         @result_set.reload!
+        Callsites.add_seen_column(@callsite, name)
       end
-      super
+      @monitored_columns[name] = value
     end
     
     def keys
-      @result_set ? @callsite.columns_hash.keys : super
+      @result_set ? @callsite.columns_hash.keys : super | @monitored_columns.keys
     end
     
     def has_key?(name)
-      @result_set ? @callsite.columns_hash.has_key?(name) : super
+      @result_set ? @callsite.columns_hash.has_key?(name) : super || @monitored_columns.has_key?(name)
     end
     
     alias_method :include?, :has_key?
+    
+    def to_hash
+      @result_set.reload! if @result_set
+      @monitored_columns.merge(self)
+    end
+    
+    # Marshal
+    # Dump a real hash - can't dump a monitored hash due to default proc
+    #
+    def _dump(depth)
+      Marshal.dump(to_hash)
+    end
+    
+    def self._load(str)
+      Marshal.load(str)
+    end
+  end
+end
+
+class Hash
+  alias_method :c_update, :update
+  def update(other_hash, &block)
+    c_update(other_hash.to_hash, &block)
   end
 end

data/lib/slim_scrooge/result_set.rb

@@ -22,8 +22,8 @@ module SlimScrooge
       new_rows = model_class.connection.send(:select, sql, "#{model_class.name} Reload SlimScrooged")
       new_rows.each do |row|
         if old_row = rows_hash[row[callsite.primary_key]]
-          old_row.real_hash.result_set = nil
-          row.each {|col, value| old_row[col] = value}
+          old_row.result_set = nil
+          old_row.monitored_columns.merge!(row)
         end
       end
     end

data/lib/slim_scrooge/slim_scrooge.rb

@@ -1,31 +1,40 @@
 # Author: Stephen Sykes
 
 module SlimScrooge
-  module SelectAll
+  module FindBySql
     def self.included(base)
-      base.alias_method_chain :select_all, :slim_scrooge
+      ActiveRecord::Base.extend ClassMethods
+      class << base
+        alias_method_chain :find_by_sql, :slim_scrooge
+      end
     end
 
-    def select_all_with_slim_scrooge(sql, name = nil)
-      callsite_key = SlimScrooge::Callsites.callsite_key(callsite_hash, sql)
-      if SlimScrooge::Callsites.has_key?(callsite_key)
-        if callsite = SlimScrooge::Callsites[callsite_key]
-          seen_columns = callsite.seen_columns.dup
-          rows = select_all_without_slim_scrooge(callsite.scrooged_sql(seen_columns, sql), name + " SlimScrooged")
-          result_set = SlimScrooge::ResultSet.new(rows.dup, callsite_key, seen_columns)
-          rows.each {|row| row.real_hash = MonitoredHash[{}, callsite, result_set]}
+    module ClassMethods
+      def find_by_sql_with_slim_scrooge(sql)
+        return find_by_sql_without_slim_scrooge(sql) if sql.is_a?(Array) # don't mess with user's custom query
+        callsite_key = SlimScrooge::Callsites.callsite_key(callsite_hash, sql)
+        if SlimScrooge::Callsites.has_key?(callsite_key)      # seen before
+          if callsite = SlimScrooge::Callsites[callsite_key]  # and is scroogeable
+            seen_columns = callsite.seen_columns.dup          # dup so cols aren't changed underneath us
+            rows = connection.select_all(callsite.scrooged_sql(seen_columns, sql), "#{name} Load SlimScrooged")
+            rows.collect! {|row| MonitoredHash[{}, row, callsite]}
+            result_set = SlimScrooge::ResultSet.new(rows.dup, callsite_key, seen_columns)
+            rows.collect! do |row|
+              row.result_set = result_set
+              instantiate(row)
+            end
+          else
+            find_by_sql_without_slim_scrooge(sql)
+          end
+        elsif callsite = SlimScrooge::Callsites.create(sql, callsite_key, name)  # new site that is scroogeable
+          rows = connection.select_all(sql, "#{name} Load SlimScrooged 1st time")
+          rows.collect! {|row| instantiate(MonitoredHash[row, {}, callsite])}
         else
-          select_all_without_slim_scrooge(sql, name)
+          find_by_sql_without_slim_scrooge(sql)
         end
-      elsif callsite = SlimScrooge::Callsites.create(sql, callsite_key, name)
-        rows = select_all_without_slim_scrooge(sql, name + " SlimScrooged 1st time")
-        rows.each {|row| row.real_hash = MonitoredHash[row.to_hash, callsite, nil]}
-        rows
-      else
-        select_all_without_slim_scrooge(sql, name)
       end
     end
   end
 end
 
-ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:include, SlimScrooge::SelectAll)
+ActiveRecord::Base.send(:include, SlimScrooge::FindBySql)

data/lib/slim_scrooge.rb

@@ -1,7 +1,6 @@
 # Author: Stephen Sykes
 
 require 'callsite_hash'
-require 'slim_attributes'
 require 'slim_scrooge/simple_set'
 require 'slim_scrooge/callsites'
 require 'slim_scrooge/callsite'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slim_scrooge
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Stephen Sykes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 +03:00
+date: 2009-11-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency