activerecord-column-reader 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+/test.db

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    activerecord-column-reader (0.0.1)
+      activerecord (~> 3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    json (1.5.1)
+    rake (0.8.7)
+    rdoc (2.4.3)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    sdoc (0.2.20)
+      json (>= 1.1.3)
+      rdoc (= 2.4.3)
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.3)
+  activerecord-column-reader!
+  rake (~> 0.8.7)
+  rspec (~> 2.1.0)
+  sdoc (~> 0.2.20)
+  sqlite3-ruby (~> 1.3.1)

data/README

@@ -0,0 +1,31 @@
+A very simple utility, for when you want to easily read only a single column from an ActiveRecord model.
+
+Usage:
+
+    class Monster < ActiveRecord::Base
+      column_reader :name
+      column_reader :hairyness, :as => :hirsutenesses
+      column_reader :dob
+
+      scope :dangerous, :conditions => {:carnivorous => true}
+    end
+
+At it's simplest, it returns the values of just the given column:
+
+    Monster.names
+    # => ['Graham', 'Mike', 'Fuzzly']
+
+The default accessor is the column name pluralized, but using the :as option, another name can be chosen:
+
+    Monster.hirsutenesses
+    # => ['bald', 'very', 'very']
+
+Scopes are respected:
+
+    Monster.dangerous.names
+    # => ['Fuzzly']
+
+And columns are correctly type cast:
+
+    Monster.dobs:
+    # => [#<Date: 4886491/2,0,2299161>, #<Date: 2886491/2,0,2299161>, #<Date: 3886491/2,0,2299161>]

data/Rakefile

@@ -0,0 +1,124 @@
+require "rubygems"
+require "bundler"
+
+Bundler.setup :development
+
+require "rspec/core/rake_task"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "rake/testtask"
+require "sdoc"
+
+task :default => 'spec'
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+path = File.expand_path("..", __FILE__)
+
+spec = Dir.chdir(path) do
+  Gem::Specification.new do |s|
+
+    # Change these as appropriate
+    s.name              = "activerecord-column-reader"
+    s.version           = "0.0.1"
+    s.summary           = "Simple ActiveRecord optimization"
+    s.author            = "Tom Ward"
+    s.email             = "tom@popdog.net"
+    s.homepage          = "http://tomafro.net"
+
+    s.has_rdoc          = true
+    s.extra_rdoc_files  = %w(README)
+    s.rdoc_options      = %w(--main README)
+
+    # Add any extra files to include in the gem
+    s.files             = `cd #{path} && git ls-files`.split("\n").sort
+
+    # You need to put your code in a directory which can then be added to
+    # the $LOAD_PATH by rubygems. Typically this is lib, but you don't seem
+    # to have that directory. You'll need to set the line below to whatever
+    # directory your code is in. Rubygems is going to assume lib if you leave
+    # this blank.
+    #
+    s.require_paths = ["lib"]
+
+    # Main dependencies
+    s.add_dependency 'activerecord', '~>3.0.3'
+
+    # Development only dependencies
+    s.add_development_dependency 'rspec', '~>2.1.0'
+    s.add_development_dependency 'rake', '~>0.8.7'
+    s.add_development_dependency 'sqlite3-ruby', '~>1.3.1'
+    s.add_development_dependency 'sdoc', '~>0.2.20'
+  end
+end
+
+# Stolen from jeweler
+def prettyify_array(gemspec_ruby, array_name)
+  gemspec_ruby.gsub(/s\.#{array_name.to_s} = \[.+?\]/) do |match|
+    leadin, files = match[0..-2].split("[")
+    leadin + "[\n    #{files.split(",").join(",\n    ")}\n  ]"
+  end
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Generate gemspec"
+task :gemspec do
+  output = spec.to_ruby
+  output = prettyify_array(output, :files)
+  output = prettyify_array(output, :test_files)
+  output = prettyify_array(output, :extra_rdoc_files)
+
+  file = File.expand_path("../#{spec.name}.gemspec", __FILE__)
+  File.open(file, "w") {|f| f << output }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include("README", "lib/**/*.rb")
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options << '--fmt' << 'shtml' # explictly set shtml generator
+  rdoc.template = 'direct' # lighter template used on railsapi.com
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm_f "#{spec.name}.gemspec"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "-f n -c"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+desc 'Tag the repository in git with gem version number'
+task :tag do
+  if `git diff --cached`.empty? && `git diff`.empty?
+    Rake::Task["package"].invoke
+
+    if `git tag`.split("\n").include?("v#{spec.version}")
+      raise "Version #{spec.version} has already been released"
+    end
+    `git add #{File.expand_path("../#{spec.name}.gemspec", __FILE__)}`
+    `git commit -m "Released version #{spec.version}"`
+    `git tag v#{spec.version}`
+    `git push --tags`
+    `git push`
+  else
+    raise "Repository contains uncommitted changes; either commit or stash."
+  end
+end

data/activerecord-column-reader.gemspec

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{activerecord-column-reader}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Ward"]
+  s.date = %q{2011-01-31}
+  s.email = %q{tom@popdog.net}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "README",
+     "Rakefile",
+     "activerecord-column-reader.gemspec",
+     "lib/activerecord-column-reader.rb",
+     "lib/penknife/active_record/column_reader.rb",
+     "spec/penknife/column_reader_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://tomafro.net}
+  s.rdoc_options = ["--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple ActiveRecord optimization}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<sqlite3-ruby>, ["~> 1.3.1"])
+      s.add_development_dependency(%q<sdoc>, ["~> 0.2.20"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<sqlite3-ruby>, ["~> 1.3.1"])
+      s.add_dependency(%q<sdoc>, ["~> 0.2.20"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 3.0.3"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<sqlite3-ruby>, ["~> 1.3.1"])
+    s.add_dependency(%q<sdoc>, ["~> 0.2.20"])
+  end
+end

data/lib/activerecord-column-reader.rb

@@ -0,0 +1 @@
+require 'penknife/active_record/column_reader'

data/lib/penknife/active_record/column_reader.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+
+module Penknife
+  module ActiveRecord
+    module ColumnReader
+      def column_reader(column_name, options = {})
+        name = options.delete(:as) || column_name.to_s.pluralize
+        column = columns_hash[column_name.to_s]
+
+        if type_cast_code = column.type_cast_code('v')
+          type_cast_code = "::#{type_cast_code}"
+        end
+
+        line = __LINE__
+        self.class_eval %{
+          def self.#{name}
+            query = scoped.select(arel_table[:#{column_name}])
+            connection.select_all(query.to_sql).collect do |value|
+              v = value.values.first
+              #{type_cast_code}
+            end
+          end
+        }, __FILE__, line + 1
+      end
+
+      ::ActiveRecord::Base.extend(self)
+    end
+  end
+end

data/spec/penknife/column_reader_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+class Monster < ActiveRecord::Base
+  column_reader :name
+  column_reader :dob, :as => :birth_dates
+  scope :carnivorous, :conditions => {:carnivorous => true}
+end
+
+describe "Penknife::ActiveRecord::ColumnReader" do
+  before :all do
+    @growler = Monster.create! :name => 'Growler', :carnivorous => true, :dob => 5.years.ago.to_date
+    @munchy = Monster.create! :name => 'Munchy', :carnivorous => true, :dob => 12.years.ago
+    @thistletop = Monster.create! :name => 'Thistletop', :carnivorous => false, :dob => 1.years.ago
+  end
+
+  it "returns only specified values" do
+    Monster.names.sort.should eql(['Growler', 'Munchy', 'Thistletop'])
+  end
+
+  it "respects scope" do
+    Monster.carnivorous.names.sort.should eql(['Growler', 'Munchy'])
+  end
+
+  it "casts returned values" do
+    Monster.birth_dates
+  end
+
+  after :all do
+    Monster.destroy_all
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'active_record'
+require 'activerecord-column-reader'
+require 'logger'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => "sqlite3",
+  :database => "test.db"
+})
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table 'monsters', :force => true do |t|
+    t.string   'name'
+    t.date     'dob'
+    t.boolean  'carnivorous'
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-column-reader
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tom Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: sqlite3-ruby
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: sdoc
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 2
+        - 20
+        version: 0.2.20
+  requirement: *id005
+description: 
+email: tom@popdog.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- activerecord-column-reader.gemspec
+- lib/activerecord-column-reader.rb
+- lib/penknife/active_record/column_reader.rb
+- spec/penknife/column_reader_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://tomafro.net
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple ActiveRecord optimization
+test_files: []
+