slim-attributes 0.6.0 → 0.6.4

data/README

@@ -11,6 +11,8 @@ Measuring with just ActiveRecord code - fetching stuff from the database - we se
 Installation
 ============
 
+Slim attributes works with ruby 1.8.6+ and 1.9.1+.
+
 You're going to need the mysql headers for this to work.
 
 Try:
@@ -41,4 +43,12 @@ The field contents are then instantiated into Ruby strings on demand - ruby stri
 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.
 
-Copyright (c) 2008 Stephen Sykes, released under the MIT license
+
+Credits
+=======
+
+Thanks to IronDigital for the initial port for ruby 1.9.
+Thanks to Greg Hazel for fixing compilation for windows.
+
+
+Copyright (c) 2008-2009 Stephen Sykes, released under the MIT license

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "slim-attributes"
+    s.summary = "Slim-attributes - lazy instantiation of attributes for ActiveRecord"
+    s.email = "sdsykes@gmail.com"
+    s.homepage = "http://github.com/sdsykes/slim-attributes"
+    s.description = "Slim attributes boosts speed in Rails/Mysql ActiveRecord Models by avoiding
+    instantiating Hashes for each result row, and lazily instantiating attributes as needed."
+    s.authors = ["Stephen Sykes"]
+    s.files = FileList["[A-Z]*", "{ext,lib,test}/**/*"]
+    s.extensions = "ext/extconf.rb"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://
+gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 4
+:major: 0
+:minor: 6

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>
@@ -152,14 +157,18 @@ static VALUE set_element(VALUE obj, VALUE name, VALUE val) {
 // []= before calling dup (the original values will be seen in the dup).  This works ok 
 // for active record usage, but perhaps could cause unexpected behaviour if model
 // attributes are dupped by the user after changing them.
-static VALUE dup(VALUE obj) {
+static VALUE slim_dup(VALUE obj) {
   VALUE frh, field_indexes;
   int nf, i;
   char *row_info_space;
 
   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);
@@ -177,8 +186,13 @@ static VALUE dup(VALUE obj) {
 static VALUE has_key(VALUE obj, VALUE name) {
   VALUE field_indexes;
 
+#ifdef RHASH_TBL
+  if (REAL_HASH_EXISTS) return (st_lookup(RHASH_TBL(rb_ivar_get(obj, real_hash_id)), name, 0) ? Qtrue : Qfalse);
+  else return (st_lookup(RHASH_TBL(field_indexes), name, 0) ? Qtrue : Qfalse);
+#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);
+#endif
 }
 
 void Init_slim_attrib_ext() {
@@ -195,7 +209,7 @@ void Init_slim_attrib_ext() {
   rb_define_private_method(cRowHash, "fetch_by_index", (VALUE(*)(ANYARGS))fetch_by_index, 1);
   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))dup, 0);
+  rb_define_method(cRowHash, "dup", (VALUE(*)(ANYARGS))slim_dup, 0);
   rb_define_method(cRowHash, "has_key?", (VALUE(*)(ANYARGS))has_key, 1);  
   // set up some symbols that we will need
   pointers_id = rb_intern("@pointers");

data/test/benchmark.rb

@@ -0,0 +1,34 @@
+# Author: Stephen Sykes
+# http://pennysmalls.com
+
+require 'rubygems'
+require 'active_record'
+require File.dirname(__FILE__) + "/products"
+require File.dirname(__FILE__) + "/slim_db_test_utils"
+
+SlimDbTestUtils.connect_and_create_db
+Product.create_large_product_table
+Product.make_some_products
+
+def do_benchmark(name)
+  start_t = Time.now
+
+  2000.times do |n|
+    product = Product.find(:all)[n % 100]
+    x = product.name
+    y = product.comment
+    z = product.created_at
+  end
+
+  end_t = Time.now
+  time_taken = end_t - start_t
+  puts "#{name}: #{time_taken}s"
+  time_taken
+end
+
+time1 = do_benchmark("Without slim-attributes")
+require 'slim_attributes'
+time2 = do_benchmark("With slim-attributes")
+puts "Diff: #{"%.2f"%(100 - time2 / time1 * 100)}%"
+
+SlimDbTestUtils.remove_db

data/test/database.yml

@@ -0,0 +1,6 @@
+slim_attributes_test:
+  adapter: mysql
+  database: slim_attributes_test
+  username: your_username
+  password: your_password
+  socket: /tmp/mysql.sock

data/test/products.rb

@@ -0,0 +1,40 @@
+# Author: Stephen Sykes
+# http://pennysmalls.com
+
+class Product < ActiveRecord::Base
+  
+  def self.create_product_table
+    ActiveRecord::Base.connection.drop_table(:products) rescue ActiveRecord::StatementInvalid
+    ActiveRecord::Base.connection.create_table(:products) do |t|
+      t.column :name, :string, :limit => 60
+      t.column :created_at, :datetime
+      t.column :number, :integer
+      t.column :nil_test, :string
+      t.column :comment, :text
+    end
+  end
+
+  def self.create_large_product_table
+    ActiveRecord::Base.connection.drop_table(:products) rescue ActiveRecord::StatementInvalid
+    ActiveRecord::Base.connection.create_table(:products) do |t|
+      t.column :name, :string, :limit => 60
+      t.column :created_at, :datetime
+      t.column :number, :integer
+      t.column :nil_test, :string
+      t.column :comment, :text
+      40.times {|n| t.column "test_col_#{n}", :string}
+    end
+  end
+
+
+  def self.make_some_products
+    100.times do |n|
+      Product.create(:name=>"product_#{n}", :number=>n, :comment=>"Made by the test suite")
+    end
+  end
+  
+  def attributes_iv
+    @attributes
+  end
+
+end

data/test/slim_attributes_test.rb

@@ -0,0 +1,169 @@
+# Author: Stephen Sykes
+# http://pennysmalls.com
+
+require 'rubygems'
+require 'active_record'
+require 'active_record/version'
+require 'slim_attributes'
+require 'test/unit'
+require File.dirname(__FILE__) + "/products"
+require File.dirname(__FILE__) + "/slim_db_test_utils"
+
+class SlimAttributesTest < Test::Unit::TestCase
+  def setup
+    SlimDbTestUtils.connect_and_create_db
+    Product.create_product_table
+    Product.make_some_products
+  end
+
+  def test_finds_all
+    items = Product.find(:all)
+    assert items.size == 100, "must find all 100 items"
+  end
+
+  def test_items_have_correct_attributes
+    items = Product.find(:all, :order=>"id")
+    items.each_index do |i|
+      check_attributes_for(items[i], i)
+    end
+  end
+
+  def test_item_attributes_can_be_changed
+    item = Product.find(:first)
+    old_name = item.name.dup
+    item.name << "more"
+    assert_equal old_name + "more", item.name, "change must stick"
+    item.nil_test = "not a nil"
+    assert_equal "not a nil", item.nil_test, "change must stick"
+    item.name = "something else"
+    assert_equal "something else", item.name, "change must stick"
+    item.save
+    item = Product.find(:first)
+    assert_equal "something else", item.name, "change must persist in DB"
+    assert_equal "not a nil", item.nil_test, "change must persist in DB"
+  end
+
+  def test_item_attributes_to_a_works
+    item = Product.find_by_id(1)
+    arr = item.attributes_iv.to_a
+    expected = [["id","1"], ["name", "product_0"], ["number","0"], ["comment","Made by the test suite"], ["created_at", item.created_at_before_type_cast], ["nil_test", nil]]
+    arr.each do |a|
+      assert expected.include?(a), "array must match"
+    end
+  end
+
+  def test_item_can_be_marshalled
+    item = Product.find_by_id(1)
+    mi = Marshal.load(Marshal.dump(item))
+    check_attributes_for(mi, 0)
+  end
+  
+  def test_has_key_and_include
+    item = Product.find_by_id(1)
+    assert item.attributes_iv.has_key?("name"), "must have key name"
+    assert item.attributes_iv.include?("name"), "must have key name"
+    assert !item.attributes_iv.has_key?("name1"), "must not have key name1"
+    assert !item.attributes_iv.include?("name1"), "must not have key name1"
+  end
+
+  def test_keys
+    item = Product.find_by_id(1)
+    assert_equal ["id", "name", "created_at", "number", "comment", "nil_test"].sort, item.attributes_iv.keys.sort, "keys must work"
+  end
+
+  def test_to_hash
+    item = Product.find_by_id(1)
+    expected = {"id"=>"1", "name"=>"product_0", "number"=>"0", "comment"=>"Made by the test suite", "created_at"=>item.created_at_before_type_cast, "nil_test"=>nil}
+    hash = item.attributes_iv.to_hash
+    assert_equal Hash, hash.class, "to_hash must result in a Hash"
+    assert_equal expected, hash, "to_hash must work"
+  end
+  
+  def test_fake_hash_can_be_updated
+    item = Product.find_by_id(1)
+    old_name = item.name
+    item.attributes_iv.update("name"=>"foobar")
+    assert_equal "foobar", item.name, "update must work"
+    item.name_will_change! if ActiveRecord::VERSION::STRING >= "2.1.0"
+    item.save
+    item = Product.find_by_id(1)
+    assert_equal "foobar", item.name, "update must work and stick through db"
+    assert_equal 0, item.number, "other attributes must not be changed in db"
+    item.name = old_name
+    item.save
+  end
+
+  def test_can_assign_to_non_columns_in_hash
+    item = Product.find_by_id(1)
+    fh = item.attributes_iv
+    fh["something"] = 23
+    fh[:symbol] = "23"
+    assert_equal 23, fh["something"], "assignment to non col"
+    assert_equal "23", fh[:symbol], "assignment to non col"
+    assert fh.keys.include?("something"), "keys must include new"
+    assert fh.keys.include?(:symbol), "keys must include new"
+    assert fh.keys.include?("name"), "keys must still include old"
+    assert_equal 23, item.something, "non col becomes accessible with method call"
+  end
+
+  def test_key_can_be_deleted
+    item = Product.find_by_id(1)
+    fh = item.attributes_iv
+    fh.delete("name")
+    assert_nil fh["name"], "name must be nil now"
+    assert_raises(ActiveRecord::MissingAttributeError, "name must raise on method call") {item.name}
+  end
+  
+  def test_gc
+    GC.start
+    assert true, "gc didn't crash"
+  end
+  
+  # rails query cache uses dup
+  def test_dup
+    items = Product.find(:all)
+    attr_dup = items[0].attributes_iv.dup
+    assert_equal "product_0", attr_dup["name"], "name must be correct in dup'd attributes"
+    attr_dup = items[0].attributes_iv.dup
+    assert_equal "product_0", attr_dup["name"], "name must be correct in dup'd attributes 2nd time"
+  end
+
+  def test_cached_result
+    ActiveRecord::Base.connection.cache do
+      item1 = Product.find_by_id(1)
+      item1.name = "foo"
+      item2 = Product.find_by_id(1)
+      assert_equal "product_0", item2.name, "name must be original from cached query"
+      item3 = Product.find_by_id(1)
+      item1.name = "bar"
+      assert_equal "product_0", item3.name, "name must be original from cached query"
+      item2.name << "_test"
+# unmodified rails fails this test, it's ok
+#      check_attributes_for(item3, 0)
+    end
+  end
+  
+  def test_accessing_destroyed_object_attributes
+    item1 = Product.find_by_id(1)
+    assert_equal false, item1.frozen?
+    item1.destroy  # object is frozen
+    assert_equal true, item1.frozen?
+    check_attributes_for(item1, 0)
+    assert_raises(RUBY_VERSION >= "1.9" ? RuntimeError : TypeError) {item1.name = "another product"}
+  end
+
+  def teardown
+    SlimDbTestUtils.remove_db
+  end
+
+  private
+
+  def check_attributes_for(item, i)
+    assert_equal "product_#{i}", item.name, "item name must be right"
+    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 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

data/test/slim_db_test_utils.rb

@@ -0,0 +1,38 @@
+# Author: Stephen Sykes
+# http://pennysmalls.com
+
+module SlimDbTestUtils
+  DB_NAME = "slim_attributes_test"
+
+  def self.db_config
+    @config ||= YAML.load(File.read(File.dirname(__FILE__) + "/database.yml"))
+    @config[DB_NAME]
+  end
+
+  def self.connect_and_create_db
+    connect_with_config(db_config)
+    unless ActiveRecord::Base.connected?  # database did not exist (as expected)
+      connect_with_config(db_config.merge({"database"=>nil}))
+      ActiveRecord::Base.connection.create_database(db_config["database"])
+      connect_with_config(db_config)
+    end
+  end
+  
+  def self.connect_with_config(config)
+    begin
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    rescue Mysql::Error
+    end
+  end
+  
+  def self.remove_db
+    if ActiveRecord::Base.connected?
+      ActiveRecord::Base.connection.execute("DROP DATABASE #{db_config["database"]}")
+    end
+  end
+  
+  def self.import_sql(file)
+    `mysql -p#{db_config["password"]} -u #{db_config["username"]} #{db_config["database"]} < #{File.dirname(__FILE__)}/#{file}`
+  end
+end

metadata

@@ -1,37 +1,45 @@
 --- !ruby/object:Gem::Specification 
 name: slim-attributes
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.6.4
 platform: ruby
 authors: 
 - Stephen Sykes
-autorequire: slim
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-06 00:00:00 +03:00
+date: 2009-07-12 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: 
+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: []
 
 extensions: 
 - ext/extconf.rb
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
-- lib/slim_attributes.rb
+- MIT_LICENCE
+- Rakefile
+- README
+- VERSION.yml
 - ext/extconf.rb
 - ext/slim_attrib_ext.c
-- README
-- MIT_LICENCE
-has_rdoc: false
-homepage: http://slim-attributes.rubyforge.org/
+- lib/slim_attributes.rb
+- test/benchmark.rb
+- test/database.yml
+- test/products.rb
+- test/slim_attributes_test.rb
+- test/slim_db_test_utils.rb
+has_rdoc: true
+homepage: http://github.com/sdsykes/slim-attributes
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -48,10 +56,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: slim-attributes
+rubyforge_project: 
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Slim attributes boosts speed in Rails/Mysql ActiveRecord Models by avoiding instantiating Hashes for each result row, and lazily instantiating attributes as needed
+summary: Slim-attributes - lazy instantiation of attributes for ActiveRecord
 test_files: []