activerecord-lazy-attributes 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Moritz Heidkamp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+= activerecord-lazy-attributes
+
+This ActiveRecord extension allows to define attributes to be
+lazy-loaded. It's main purpose is to avoid loading large columns (such
+as BLOBs) with every SELECT.
+
+== Example
+
+  class Image < ActiveRecord::Base
+    attr_lazy :data
+  end
+
+  i = Image.first # this selects all columns except "data"
+  i.data # "data" column is selected separately
+
+== Credit
+
+This is based on
+http://refactormycode.com/codes/219-activerecord-lazy-attribute-loading-plugin-for-rails
+(the code here is the last contribution to this refactoring).
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Moritz Heidkamp. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activerecord-lazy-attributes"
+    gem.summary = %Q{An ActiveRecord extension which allows attributes to be lazy-loaded}
+    gem.description = %Q{A useful ActiveRecord extension to handle columns containing large amounts of data}
+    gem.email = "moritz@twoticketsplease.de"
+    gem.homepage = "http://github.com/DerGuteMoritz/activerecord-lazy-attributes"
+    gem.authors = ["Moritz Heidkamp"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency 'activerecord', '>= 2.3.5'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord-lazy-attributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/activerecord-lazy-attributes.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{activerecord-lazy-attributes}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Moritz Heidkamp"]
+  s.date = %q{2010-02-18}
+  s.description = %q{A useful ActiveRecord extension to handle columns containing large amounts of data}
+  s.email = %q{moritz@twoticketsplease.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "activerecord-lazy-attributes.gemspec",
+     "init.rb",
+     "lib/lazy_attributes.rb",
+     "rails/init.rb",
+     "spec/lazy_attributes_spec.rb",
+     "spec/models/image.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/DerGuteMoritz/activerecord-lazy-attributes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An ActiveRecord extension which allows attributes to be lazy-loaded}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/models/image.rb",
+     "spec/schema.rb",
+     "spec/lazy_attributes_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.5"])
+  end
+end
+

data/init.rb

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

data/lib/lazy_attributes.rb

@@ -0,0 +1,54 @@
+require 'active_record'
+
+module DerGuteMoritz
+  module ActiveRecord
+    module LazyAttributes
+
+      def self.included(base)
+        base.class_eval do
+          class_inheritable_accessor :lazy_attributes
+          class_inheritable_accessor :eager_attributes
+          self.lazy_attributes = []
+          extend ClassMethods
+          metaclass.alias_method_chain :default_select, :lazy_attributes
+        end
+      end
+
+      module ClassMethods
+
+        def attr_lazy(*attrs)
+          normalized_attrs = attrs.map { |a| a.to_s }
+          self.lazy_attributes += normalized_attrs
+          self.eager_attributes = (column_names - lazy_attributes).map { |a| connection.quote_column_name(a) }
+
+          normalized_attrs.each do |attr|
+            define_method attr do
+              write_attribute(attr, connection.select_value('SELECT %s FROM %s WHERE %s = %s' % [connection.quote_column_name(attr), self.class.quoted_table_name, self.class.primary_key, quoted_id])) unless has_attribute?(attr)
+              read_attribute(attr)
+            end
+          end
+
+        end
+
+        private
+        
+        def default_select_with_lazy_attributes(qualified)
+          if lazy_attributes.empty?
+            default_select_without_lazy_attributes(qualified)
+          else
+            if qualified
+              eager_attributes.map { |a| "#{quoted_table_name}.#{a}"  }
+            else
+              eager_attributes
+            end.join(', ')
+          end
+        end
+        
+      end
+      
+    end
+  end
+end
+
+
+ActiveRecord::Base.send :include, DerGuteMoritz::ActiveRecord::LazyAttributes

data/rails/init.rb

@@ -0,0 +1 @@
+require Pathname.new(__FILE__).dirname.join('..', 'init')

data/spec/lazy_attributes_spec.rb

@@ -0,0 +1,26 @@
+root = Pathname.new(__FILE__).dirname
+
+require root.join('spec_helper')
+require root.join('models/image')
+
+describe DerGuteMoritz::ActiveRecord::LazyAttributes do
+
+  before :each do
+    @id = Image.create!(:name => 'an image', :data => 'a lot of data').id
+  end
+
+  it 'should eagerly load attributes not defined lazy' do
+    i = Image.find(@id)
+    i.should have_attribute('name')
+    i.name.should == 'an image'
+  end
+
+  it 'should lazily load attributes defined as lazy' do 
+    i = Image.find(@id)
+    i.should_not have_attribute('data')
+    i.data
+    i.data.should == 'a lot of data'
+    i.should have_attribute('data')
+  end
+  
+end

data/spec/models/image.rb

@@ -0,0 +1,3 @@
+class Image < ActiveRecord::Base
+  attr_lazy :data
+end

data/spec/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define do
+
+  create_table :images do |t|
+    t.text :name
+    t.text :data
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'lazy_attributes'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+  load 'schema.rb'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-lazy-attributes
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Moritz Heidkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+description: A useful ActiveRecord extension to handle columns containing large amounts of data
+email: moritz@twoticketsplease.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- activerecord-lazy-attributes.gemspec
+- init.rb
+- lib/lazy_attributes.rb
+- rails/init.rb
+- spec/lazy_attributes_spec.rb
+- spec/models/image.rb
+- spec/schema.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/DerGuteMoritz/activerecord-lazy-attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An ActiveRecord extension which allows attributes to be lazy-loaded
+test_files: 
+- spec/spec_helper.rb
+- spec/models/image.rb
+- spec/schema.rb
+- spec/lazy_attributes_spec.rb