sequel_fast_columns 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) 2010 Roland Swingler
+
+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,27 @@
+= Sequel fast columns
+
+Sequel's Dataset#columns method runs the dataset's query method and uses the
+keys from the first row as the column names. This can be very slow for some
+queries. This extension gets the columns from those specified in the query
+wherever possible, avoiding this performance hit.
+
+To use just:
+
+    require 'sequel'
+    require 'sequel/fast_columns'
+
+and carry on as normal.
+
+== 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 Roland Swingler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sequel_fast_columns"
+    gem.summary = %Q{A non-db-query implementation of Dataset#columns}
+    gem.description = %Q{A non-db-query implementation of Dataset#columns}
+    gem.email = "roland.swingler@gmail.com"
+    gem.homepage = "http://github.com/knaveofdiamonds/sequel_fast_columns"
+    gem.authors = ["Roland Swingler"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 = "sequel_fast_columns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/sequel/fast_columns.rb

@@ -0,0 +1,64 @@
+module Sequel
+  class Dataset
+    def columns
+      return @columns if @columns
+      @columns = if opts[:select] 
+        if opts[:select].map(&:class).any? {|x| x == Sequel::LiteralString } ||
+            (opts[:joins] && opts[:select].any? {|x| x == :* })
+          query_db_for_columns
+        else
+          opts[:select].map do |column|
+            case column
+            when Sequel::SQL::AliasedExpression
+              column.aliaz.to_sym
+            when Sequel::SQL::QualifiedIdentifier
+              column_name_from_symbol column.column
+            when Sequel::SQL::ColumnAll
+              get_all_columns(column.table)
+            when Symbol
+              column_name_from_symbol column
+            when Sequel::SQL::Expression
+              column.to_s(db).to_sym
+            else
+              column.to_s.to_sym
+            end
+          end.flatten
+        end
+      else
+        if opts[:joins]
+          query_db_for_columns
+        else
+          get_all_columns opts[:from]
+        end
+      end
+    end
+
+    private
+
+    def get_all_columns(table)
+      table = table.first if table.kind_of? Array
+      if table.kind_of?(Symbol)
+        db.schema(table).map {|c| c.first }
+      else
+        query_db_for_columns
+      end
+    end
+
+    def column_name_from_symbol(column)
+      if column == :*
+        get_all_columns opts[:from]
+      else
+        t, col, aliaz = split_symbol(column)
+        aliaz ? aliaz.to_sym : col.to_sym
+      end
+    end
+
+    # This is the original Sequel Method
+    def query_db_for_columns
+      ds = unfiltered.unordered.clone(:distinct => nil, :limit => 1)
+      ds.each{break}
+      @columns = ds.instance_variable_get(:@columns)
+      @columns || []
+    end
+  end
+end

data/lib/sequel_fast_columns.rb

@@ -0,0 +1 @@
+require 'sequel/fast_columns'

data/spec/sequel_fast_columns_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Fast column queries" do
+  before :each do
+    @dataset = TEST_DB[:a]
+    @dataset.should_not_receive(:unfiltered)
+  end
+
+  it "should just return the selected column symbols" do
+    @dataset.select(:foo).columns.should == [:foo]
+  end
+
+  it "should return the column name from symbols with __" do
+    @dataset.select(:a__foo).columns.should == [:foo]
+  end
+
+  it "should return the aliased column name from symbols with ___" do
+    @dataset.select(:a__foo___baz).columns.should == [:baz]
+    @dataset.select(:foo___baz).columns.should == [:baz]
+  end
+
+  it "should return the aliased column name from aliased expressions" do
+    @dataset.select(:foo.as(:baz)).columns.should == [:baz]
+  end
+
+  it "should return the column name from qualified expressions" do
+    @dataset.select(:foo.qualify(:b)).columns.should == [:foo]
+  end
+
+  it "should return the column name from qualified aliased expressions" do
+    @dataset.select(:a__foo.as(:bar)).columns.should == [:bar]
+    @dataset.select(:foo.qualify(:a).as(:bar)).columns.should == [:bar]
+  end
+
+  it "should return the columns from the schema if no columns specified" do
+    @dataset.columns.should == [:id, :foo]
+  end
+
+  it "should return all columns from the schema if :* specified" do
+    @dataset.select(:*).columns.should == [:id, :foo]
+  end
+
+  it "should return all columns from the schema if qualfied :* specified" do
+    @dataset.select(:*.qualify(:a)).columns.should == [:id, :foo]
+  end
+
+  it "should return the value as the column" do
+    @dataset.select("hello", 1).columns.should == [:hello, :"1"]
+  end
+
+  it "should return the SQL for the column for unaliased calculated values" do
+    # doesn't work with Sqlite
+    # @dataset.select(:sum[:foo]).columns.should == [:"SUM(`foo`)"]
+  end
+end
+
+describe "Falling back to database query" do
+  it "should return all columns when select_append is used" do
+    TEST_DB[:a].select_append(:foo).columns.should == [:id, :foo, :foo]
+  end
+
+  it "should fall back to querying the db if the dataset is derived" do
+    TEST_DB[TEST_DB[:a]].columns.should == [:id, :foo]
+  end
+
+  it "should fall back if unqualfied * is used and there are joins" do
+    # Again can't get this working with sqlite.
+    # TEST_DB.join(:b, :id => :id).columns.should == [:id, :foo, :id, :bar]
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'sequel'
+require 'sequel_fast_columns'
+
+require 'spec'
+require 'spec/autorun'
+
+TEST_DB = Sequel.sqlite
+TEST_DB.create_table(:a) do
+  integer :id
+  integer :foo
+end
+
+TEST_DB.create_table(:b) do
+  integer :id
+  integer :bar
+end
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_fast_columns
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roland Swingler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A non-db-query implementation of Dataset#columns
+email: roland.swingler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sequel/fast_columns.rb
+- lib/sequel_fast_columns.rb
+- spec/sequel_fast_columns_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/knaveofdiamonds/sequel_fast_columns
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A non-db-query implementation of Dataset#columns
+test_files: 
+- spec/sequel_fast_columns_spec.rb
+- spec/spec_helper.rb