ghazel-slim-attributes 0.6.3.1 → 0.7.6.1

data/README

@@ -11,15 +11,16 @@ Measuring with just ActiveRecord code - fetching stuff from the database - we se
 Installation
 ============
 
-You're going to need the mysql headers for this to work.
+Slim attributes works with Rails and Ruby 1.8.x.  Ruby 1.9 is also supported with Rails version 2.3.5 and above.
 
 Try:
-gem install slim-attributes -- --with-mysql-config
+  sudo gem install slim-attributes
 or:
-gem install slim-attributes
+  sudo gem install slim-attributes -- --with-mysql-config
 
-then add this to environment.rb:
-require 'slim_attributes'
+then add this to environment.rb in the Rails::Initializer.run section:
+
+  config.gem 'slim-attributes'
 
 
 Description
@@ -36,9 +37,25 @@ So this is an alternative implementation of all_hashes that returns a 'fake hash
 The field contents are then instantiated into Ruby strings on demand - ruby strings are only made if you need them.  Note that if you always look at all the columns when you fetch data from the database then this won't necessarily be faster that the unpatched mysql adapter.  But it won't be much slower either, and we do expect that most times not all the columns from a result set are accessed.
 
 
-===========
+Bugs
+====
+
+Slim attributes will not work correctly with ruby 1.9.x with versions lower than Rails 2.3.5
+
+
+Warranty
+========
+
+No warranty - this gem has been extensively tested, but not in all environments.  
+We are using it in our production environment with very good results.
+Please report bugs to sdsykes at symbol gmail pip com or via the github issue tracking system.
+
+
+Credits
+=======
 
-No warranty - this gem has been tested, but not in all environments.  However, that said, we are using it in our production environment with good results.
-Please report bugs to sdsykes at symbol gmail pip com.
+Thanks to IronDigital for the initial port for ruby 1.9.
+Thanks to Greg Hazel (ghazel) for fixing compilation for windows.
+Thanks to Nando Vieira (fnando) for adding slim-attributes.rb to avoid the underscore dash confusion.
 
-Copyright (c) 2008 Stephen Sykes, released under the MIT license
+Copyright (c) 2008-2010 Stephen Sykes, released under the MIT license

data/Rakefile

@@ -12,8 +12,16 @@ begin
     s.authors = ["Stephen Sykes"]
     s.files = FileList["[A-Z]*", "{ext,lib,test}/**/*"]
     s.extensions = "ext/extconf.rb"
+    s.rubyforge_project = 'slim-attributes'
   end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://
 gems.github.com"
 end
+
+task :rdoc do
+  `mkdir rdoc`
+  `echo documentation is at http://github.com/sdsykes/slim-attributes > rdoc/README.rdoc`
+end

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:patch: 3
+:patch: 6
 :major: 0
-:minor: 6
+:minor: 7
+:build: 

data/ext/extconf.rb

@@ -1,12 +1,27 @@
-# this code is borrowed from Mysql/Ruby, credit to TOMITA Masahiro
+# this code was originally borrowed from Mysql/Ruby, credit to TOMITA Masahiro
 # it works for me under OS X and Fedora, hope it works for you also
 
 require 'mkmf'
 
-if /mswin32/ =~ RUBY_PLATFORM
+# Improved detection of mysql_config
+# Code from DataObjects do_mysql adapter
+# All instances of mysql_config on PATH ...
+def mysql_config_paths
+  ENV['PATH'].split(File::PATH_SEPARATOR).collect do |path|
+    [ "#{path}/mysql_config", "#{path}/mysql_config5" ].
+      detect { |bin| File.exist?(bin) }
+  end
+end
+
+# The first mysql_config binary on PATH ...
+def default_mysql_config_path
+  mysql_config_paths.compact.first
+end
+
+if RUBY_PLATFORM =~ /mswin|mingw/
   inc, lib = dir_config('mysql')
   exit 1 unless have_library("libmysql")
-elsif mc = with_config('mysql-config') then
+elsif mc = with_config('mysql-config', default_mysql_config_path) then
   mc = 'mysql_config' if mc == true
   cflags = `#{mc} --cflags`.chomp
   exit 1 if $? != 0

data/ext/slim_attrib_ext.c

@@ -2,7 +2,12 @@
 // http://pennysmalls.com
 
 #include "ruby.h"
+
+#ifdef HAVE_RUBY_ST_H
+#include "ruby/st.h"
+#else
 #include "st.h"
+#endif
 
 #include <mysql.h>
 #include <errmsg.h>
@@ -13,7 +18,8 @@
 #define GetCharStarPtr(obj) (Check_Type(obj, T_DATA), (char**)DATA_PTR(obj))
 
 VALUE cRowHash, cClass;
-ID pointers_id, row_info_id, field_indexes_id, real_hash_id, to_hash_id;
+ID pointers_id, row_info_id, field_indexes_id, real_hash_id, to_hash_id, sq_parens_id, 
+   sq_parens_equal_id, has_key_id;
 
 #define MAX_CACHED_COLUMN_IDS 40
 ID column_ids[MAX_CACHED_COLUMN_IDS];
@@ -25,8 +31,8 @@ struct mysql_res {
 };
 
 // row info
-#define SLIM_IS_NULL (char)0x01
-#define SLIM_IS_SET (char)0x02
+#define SLIM_IS_NULL 0x01
+#define SLIM_IS_SET 0x02
 
 #define GET_COL_IV_ID(str, cnum) (cnum < MAX_CACHED_COLUMN_IDS ? column_ids[cnum] : (sprintf(str, "@col_%ld", cnum), rb_intern(str)))
 
@@ -98,7 +104,7 @@ static VALUE fetch_by_index(VALUE obj, VALUE index) {
   long col_number = FIX2LONG(index);
   unsigned int length;
   row_info = GetCharPtr(rb_ivar_get(obj, row_info_id)) + col_number;  // flags for this column
-  if (*row_info == SLIM_IS_NULL) return Qnil;  // return nil if null from db
+  if (*row_info & SLIM_IS_NULL) return Qnil;  // return nil if null from db
   col_id = GET_COL_IV_ID(col_name, col_number);
   if (*row_info == SLIM_IS_SET) return rb_ivar_get(obj, col_id);  // was made to a string already
   pointers = GetCharStarPtr(rb_ivar_get(obj, pointers_id));  // find the data and make ruby string
@@ -113,12 +119,16 @@ static VALUE fetch_by_index(VALUE obj, VALUE index) {
 // This is the [] method of the row data object.
 // It checks for a real hash, but if none exists it will call fetch_by_index
 static VALUE slim_fetch(VALUE obj, VALUE name) {
-  VALUE field_indexes, hash_lookup;
+  VALUE field_indexes, hash_lookup, real_hash;
   
-  if (REAL_HASH_EXISTS) return rb_hash_aref(rb_ivar_get(obj, real_hash_id), name);
+  if (REAL_HASH_EXISTS) return rb_funcall(rb_ivar_get(obj, real_hash_id), sq_parens_id, 1, name);
 
   hash_lookup = rb_hash_aref(field_indexes, name);
-  if (NIL_P(hash_lookup)) return Qnil;
+  if (NIL_P(hash_lookup)) {
+    real_hash = rb_ivar_get(obj, real_hash_id);
+    if (NIL_P(real_hash)) return Qnil;
+    return rb_funcall(real_hash, sq_parens_id, 1, name);
+  }
   return fetch_by_index(obj, hash_lookup);
 }
 
@@ -131,10 +141,10 @@ static VALUE set_element(VALUE obj, VALUE name, VALUE val) {
   char col_name[16];
   ID col_id;
 
-  if (REAL_HASH_EXISTS) return rb_hash_aset(rb_ivar_get(obj, real_hash_id), name, val);
+  if (REAL_HASH_EXISTS) return rb_funcall(rb_ivar_get(obj, real_hash_id), sq_parens_equal_id, 2, name, val);
   
   hash_lookup = rb_hash_aref(field_indexes, name);  
-  if (NIL_P(hash_lookup)) return rb_hash_aset(rb_funcall(obj, to_hash_id, 0), name, val);
+  if (NIL_P(hash_lookup)) return rb_funcall(rb_funcall(obj, to_hash_id, 0), sq_parens_equal_id, 2, name, val);
   col_number = FIX2LONG(hash_lookup);
   col_id = GET_COL_IV_ID(col_name, col_number);
   rb_ivar_set(obj, col_id, val);
@@ -159,7 +169,11 @@ static VALUE slim_dup(VALUE obj) {
 
   if (REAL_HASH_EXISTS) return rb_obj_dup(rb_ivar_get(obj, real_hash_id));
 
+#ifdef RHASH_SIZE
+  nf = RHASH_SIZE(field_indexes);
+#else
   nf = RHASH(field_indexes)->tbl->num_entries;
+#endif
   row_info_space = ruby_xmalloc(nf);  // dup needs its own set of flags
   if (!row_info_space) rb_raise(rb_eNoMemError, "out of memory");
   memcpy(row_info_space, GetCharPtr(rb_ivar_get(obj, row_info_id)), nf);
@@ -175,10 +189,20 @@ static VALUE slim_dup(VALUE obj) {
 // Calls to model property methods in AR cause a call to has_key?, so it
 // is implemented here in C for speed.
 static VALUE has_key(VALUE obj, VALUE name) {
-  VALUE field_indexes;
+  VALUE field_indexes, real_hash;
 
+#ifdef RHASH_TBL
+  if (REAL_HASH_EXISTS) return (st_lookup(RHASH_TBL(rb_ivar_get(obj, real_hash_id)), name, 0) ? Qtrue : Qfalse);
+  else if (st_lookup(RHASH_TBL(field_indexes), name, 0)) return Qtrue;
+#else
   if (REAL_HASH_EXISTS) return (st_lookup(RHASH(rb_ivar_get(obj, real_hash_id))->tbl, name, 0) ? Qtrue : Qfalse);
-  else return (st_lookup(RHASH(field_indexes)->tbl, name, 0) ? Qtrue : Qfalse);
+  else if (st_lookup(RHASH(field_indexes)->tbl, name, 0)) return Qtrue;
+#endif
+  else {
+    real_hash = rb_ivar_get(obj, real_hash_id);
+    if (NIL_P(real_hash)) return Qfalse;
+    return rb_funcall(real_hash, has_key_id, 1, name);
+  }
 }
 
 void Init_slim_attrib_ext() {
@@ -196,13 +220,17 @@ void Init_slim_attrib_ext() {
   rb_define_method(cRowHash, "[]", (VALUE(*)(ANYARGS))slim_fetch, 1);
   rb_define_method(cRowHash, "[]=", (VALUE(*)(ANYARGS))set_element, 2);
   rb_define_method(cRowHash, "dup", (VALUE(*)(ANYARGS))slim_dup, 0);
-  rb_define_method(cRowHash, "has_key?", (VALUE(*)(ANYARGS))has_key, 1);  
+  rb_define_method(cRowHash, "has_key?", (VALUE(*)(ANYARGS))has_key, 1);
+  
   // set up some symbols that we will need
   pointers_id = rb_intern("@pointers");
   row_info_id = rb_intern("@row_info");
   field_indexes_id = rb_intern("@field_indexes");
   real_hash_id = rb_intern("@real_hash");
   to_hash_id = rb_intern("to_hash");
+  sq_parens_id = rb_intern("[]");
+  sq_parens_equal_id = rb_intern("[]=");
+  has_key_id = rb_intern("has_key?");
   for(i=0; i < MAX_CACHED_COLUMN_IDS; i++) {
     sprintf(col_name, "@col_%d", i);
     column_ids[i] = rb_intern(col_name);

data/lib/slim-attributes.rb

@@ -0,0 +1 @@
+require 'slim_attributes'

data/lib/slim_attributes.rb

@@ -9,6 +9,8 @@ require 'slim_attrib_ext'
 
 class Mysql::Result
   class RowHash
+    attr_accessor :real_hash
+
     def marshal_dump
       to_hash
     end
@@ -28,8 +30,8 @@ class Mysql::Result
     # This should be the exception though, and the efficiencies of using slim-attributes
     # are lost when this happens.
     def to_hash
-      return @real_hash if @real_hash
-      @real_hash = {}
+      return @real_hash unless @field_indexes
+      @real_hash ||= {}
       @field_indexes.each_pair {|name, index| @real_hash[name] = fetch_by_index(index)}
       @field_indexes = nil
       @real_hash
@@ -46,7 +48,7 @@ class Mysql::Result
       to_hash.freeze
       regular_freeze
     end
-    
+
     def method_missing(name, *args, &block)
       to_hash.send(name, *args, &block)
     end

data/test/slim_attributes_test.rb

@@ -4,7 +4,7 @@
 require 'rubygems'
 require 'active_record'
 require 'active_record/version'
-require 'slim_attributes'
+require File.dirname(__FILE__) + '/../lib/slim_attributes'
 require 'test/unit'
 require File.dirname(__FILE__) + "/products"
 require File.dirname(__FILE__) + "/slim_db_test_utils"
@@ -16,6 +16,11 @@ class SlimAttributesTest < Test::Unit::TestCase
     Product.make_some_products
   end
 
+  def test_slim_attributes_is_proxying_results
+    x = Product.find(:first)
+    assert_equal Mysql::Result::RowHash, x.instance_variable_get(:@attributes).class
+  end
+
   def test_finds_all
     items = Product.find(:all)
     assert items.size == 100, "must find all 100 items"
@@ -138,7 +143,10 @@ class SlimAttributesTest < Test::Unit::TestCase
       item1.name = "bar"
       assert_equal "product_0", item3.name, "name must be original from cached query"
       item2.name << "_test"
-# unmodified rails fails this test - but does it matter either way?
+# unmodified rails fails this test because the attributes are not dupped, only the
+# hash containing them is
+# but this test is useful - it shows that the rowhash has not been made
+# into a real hash before dup in called in the query cache code
       check_attributes_for(item3, 0)
     end
   end
@@ -149,7 +157,7 @@ class SlimAttributesTest < Test::Unit::TestCase
     item1.destroy  # object is frozen
     assert_equal true, item1.frozen?
     check_attributes_for(item1, 0)
-    assert_raises(TypeError) {item1.name = "another product"}
+    assert_raises(RUBY_VERSION >= "1.9" ? RuntimeError : TypeError) {item1.name = "another product"}
   end
 
   def teardown
@@ -163,7 +171,7 @@ class SlimAttributesTest < Test::Unit::TestCase
     assert_equal i, item.number, "item number must be right"
     assert_equal i + 1, item.id, "item id must be right"
     assert_equal "Made by the test suite", item.comment, "item comment must be right"
-    assert ((1.minute.ago)..(Time.now)) === item.created_at, "item created_at must be reasonable"
+    assert item.created_at <= Time.now && item.created_at > Time.now - 30, "item created_at must be reasonable"
     assert_nil item.nil_test, "nil_test must be nil"
   end
 end

metadata

@@ -1,7 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: ghazel-slim-attributes
 version: !ruby/object:Gem::Version 
-  version: 0.6.3.1
+  hash: 109
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 6
+  - 1
+  version: 0.7.6.1
 platform: ruby
 authors: 
 - Stephen Sykes
@@ -9,11 +16,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -07:00
+date: 2009-12-23 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Slim attributes boosts speed in Rails/Mysql ActiveRecord Models by avoiding instantiating Hashes for each result row, and lazily instantiating attributes as needed.
+description: |-
+  Slim attributes boosts speed in Rails/Mysql ActiveRecord Models by avoiding
+      instantiating Hashes for each result row, and lazily instantiating attributes as needed.
 email: sdsykes@gmail.com
 executables: []
 
@@ -23,11 +32,12 @@ extra_rdoc_files:
 - README
 files: 
 - MIT_LICENCE
-- Rakefile
 - README
+- Rakefile
 - VERSION.yml
 - ext/extconf.rb
 - ext/slim_attrib_ext.c
+- lib/slim-attributes.rb
 - lib/slim_attributes.rb
 - test/benchmark.rb
 - test/database.yml
@@ -36,30 +46,40 @@ files:
 - test/slim_db_test_utils.rb
 has_rdoc: true
 homepage: http://github.com/sdsykes/slim-attributes
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.2.0
+rubyforge_project: slim-attributes
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Slim-attributes - lazy instantiation of attributes for ActiveRecord
-test_files: []
-
+test_files: 
+- test/benchmark.rb
+- test/products.rb
+- test/slim_attributes_test.rb
+- test/slim_db_test_utils.rb