activerecord-postgres-copy 0.2.2

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/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+gem 'pg'
+gem 'activerecord'

data/Gemfile.lock

@@ -0,0 +1,25 @@
+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)
+    i18n (0.5.0)
+    pg (0.10.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  pg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Diogo Biazus
+
+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.md

@@ -0,0 +1,30 @@
+# activerecord-postgres-copy
+
+This Gem will enable your AR models to use the PostgreSQL COPY command to import/export data in CSV format.
+It's still in its ealry stages of development, *not production ready*.
+
+## Install
+
+    gem install activerecord-postgres-copy
+
+## Usage
+
+The gem will add two aditiontal class methods to ActiveRecord::Base as a monkey patch (I'll change this soon):
+
+* pg_copy_to (description yet to be added)
+* pg_copy_from (description yet to be added)
+
+
+## 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) 2011 Diogo Biazus. 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-postgres-copy"
+    gem.summary = %Q{Put COPY command functionality in ActiveRecord's model class}
+    gem.description = %Q{Now you can use the super fast COPY for import/export data directly from your AR models.}
+    gem.email = "diogob@gmail.com"
+    gem.homepage = "http://github.com/diogob/activerecord-postgres-copy"
+    gem.authors = ["Diogo Biazus"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "activerecord", ">= 3.0.0"
+    # 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-postgres-copy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/activerecord-postgres-copy.gemspec

@@ -0,0 +1,74 @@
+# 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-postgres-copy}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Diogo Biazus"]
+  s.date = %q{2011-02-09}
+  s.description = %q{Now you can use the super fast COPY for import/export data directly from your AR models.}
+  s.email = %q{diogob@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "activerecord-postgres-copy.gemspec",
+     "lib/activerecord-postgres-copy.rb",
+     "lib/activerecord-postgres-copy/base.rb",
+     "spec/fixtures/extra_field.rb",
+     "spec/fixtures/semicolon_with_different_header.csv",
+     "spec/fixtures/semicolon_with_header.csv",
+     "spec/fixtures/tab_only_data.csv",
+     "spec/fixtures/tab_with_different_header.csv",
+     "spec/fixtures/tab_with_error.csv",
+     "spec/fixtures/tab_with_extra_line.csv",
+     "spec/fixtures/tab_with_header.csv",
+     "spec/fixtures/test_model.rb",
+     "spec/pg_copy_from_spec.rb",
+     "spec/pg_copy_to_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/diogob/activerecord-postgres-copy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Put COPY command functionality in ActiveRecord's model class}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/pg_copy_from_spec.rb",
+     "spec/pg_copy_to_spec.rb",
+     "spec/fixtures/test_model.rb",
+     "spec/fixtures/extra_field.rb"
+  ]
+
+  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_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+  end
+end
+

data/lib/activerecord-postgres-copy.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_record'
+require 'activerecord-postgres-copy/base'

data/lib/activerecord-postgres-copy/base.rb

@@ -0,0 +1,36 @@
+module ActiveRecord
+  class Base
+    def self.pg_copy_to path = nil
+      if path
+        raise "You have to choose between exporting to a file or receiving the lines inside a block" if block_given?
+        connection.execute "COPY (#{self.scoped.to_sql}) TO #{sanitize(path)} WITH DELIMITER '\t' CSV HEADER"
+      else
+        connection.execute "COPY (#{self.scoped.to_sql}) TO STDOUT WITH DELIMITER '\t' CSV HEADER"
+        while line = connection.raw_connection.get_copy_data do
+          yield(line) if block_given?
+        end
+      end
+      return self
+    end
+
+    def self.pg_copy_from path_or_io, options = {}
+      options = {:delimiter => "\t"}.merge(options)
+      io = path_or_io.instance_of?(String) ? File.open(path_or_io, 'r') : path_or_io
+      # The first line should be always the HEADER.
+      line = io.gets
+      columns_list = options[:columns] || line.strip.split(options[:delimiter])
+      columns_list = columns_list.map{|c| options[:map][c.to_s] } if options[:map]
+      connection.execute "COPY #{quoted_table_name} (#{columns_list.join(",")}) FROM STDIN WITH DELIMITER '#{options[:delimiter]}' CSV"
+      while line = io.gets do
+        next if line.strip.size == 0
+        if block_given?
+          row = line.strip.split(options[:delimiter])
+          yield(row)
+          line = row.join(options[:delimiter])
+        end
+        connection.raw_connection.put_copy_data line
+      end
+      connection.raw_connection.put_copy_end
+    end
+  end
+end

data/spec/fixtures/extra_field.rb

@@ -0,0 +1,5 @@
+require 'activerecord-postgres-copy'
+
+class ExtraField < ActiveRecord::Base
+end
+

data/spec/fixtures/semicolon_with_different_header.csv

@@ -0,0 +1,2 @@
+cod;info
+1;test data 1

data/spec/fixtures/semicolon_with_header.csv

@@ -0,0 +1,2 @@
+id;data
+1;test data 1

data/spec/fixtures/tab_only_data.csv

@@ -0,0 +1,2 @@
+data
+test data 1

data/spec/fixtures/tab_with_different_header.csv

@@ -0,0 +1,2 @@
+cod	info
+1	test data 1

data/spec/fixtures/tab_with_error.csv

@@ -0,0 +1,3 @@
+id	data
+1;this is a wrong separator
+

data/spec/fixtures/tab_with_extra_line.csv

@@ -0,0 +1,3 @@
+id	data
+1	test data 1
+

data/spec/fixtures/tab_with_header.csv

@@ -0,0 +1,2 @@
+id	data
+1	test data 1

data/spec/fixtures/test_model.rb

@@ -0,0 +1,4 @@
+require 'activerecord-postgres-copy'
+
+class TestModel < ActiveRecord::Base
+end

data/spec/pg_copy_from_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "COPY FROM" do
+  before(:each) do
+    ActiveRecord::Base.connection.execute %{
+      TRUNCATE TABLE test_models;
+      SELECT setval('test_models_id_seq', 1, false);
+}
+  end
+
+  it "should import from file if path is passed without field_map" do
+    TestModel.pg_copy_from File.expand_path('spec/fixtures/tab_with_header.csv')
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should import from IO without field_map" do
+    TestModel.pg_copy_from File.open(File.expand_path('spec/fixtures/tab_with_header.csv'), 'r')
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should import with custom delimiter from path" do
+    TestModel.pg_copy_from File.expand_path('spec/fixtures/semicolon_with_header.csv'), :delimiter => ';'
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should import with custom delimiter from IO" do
+    TestModel.pg_copy_from File.open(File.expand_path('spec/fixtures/semicolon_with_header.csv'), 'r'), :delimiter => ';'
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should import and allow changes in block" do
+    TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_with_header.csv'), 'r')) do |row|
+      row[1] = 'changed this data'
+    end
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'changed this data'}]
+  end
+
+  it "should be able to copy from using custom set of columns" do
+    TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_only_data.csv'), 'r'), :columns => ["data"])
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "default set of columns should be all table columns minus [id, created_at, updated_at]" do
+    ExtraField.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_with_header.csv'), 'r'))
+    ExtraField.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1', 'created_at' => nil, 'updated_at' => nil}]
+  end
+
+  it "should be able to map the header in the file to diferent column names" do
+    TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_with_different_header.csv'), 'r'), :map => {'cod' => 'id', 'info' => 'data'})
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should be able to map the header in the file to diferent column names with custom delimiter" do
+    TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/semicolon_with_different_header.csv'), 'r'), :delimiter => ';', :map => {'cod' => 'id', 'info' => 'data'})
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should ignore empty lines" do
+    TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_with_extra_line.csv'), 'r'))
+    TestModel.order(:id).all.map{|r| r.attributes}.should == [{'id' => 1, 'data' => 'test data 1'}]
+  end
+
+  it "should raise error in malformed files" do
+    lambda do
+      TestModel.pg_copy_from(File.open(File.expand_path('spec/fixtures/tab_with_error.csv'), 'r'))
+    end.should raise_error
+    TestModel.order(:id).all.map{|r| r.attributes}.should == []
+  end
+end
+

data/spec/pg_copy_to_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "COPY TO" do
+  before(:all) do
+    ActiveRecord::Base.connection.execute %{
+      TRUNCATE TABLE test_models;
+      SELECT setval('test_models_id_seq', 1, false);
+}
+    TestModel.create :data => 'test data 1'
+  end
+
+  it "should copy and pass data to block if block is given and no path is passed" do
+    File.open('spec/fixtures/tab_with_header.csv', 'r') do |f|
+      TestModel.pg_copy_to do |row|
+        row.should == f.readline
+      end
+    end
+  end
+
+  it "should copy to disk if block is not given and a path is passed" do
+    TestModel.pg_copy_to '/tmp/export.csv'
+    File.open('spec/fixtures/tab_with_header.csv', 'r') do |fixture|
+      File.open('/tmp/export.csv', 'r') do |result|
+        result.read.should == fixture.read
+      end
+    end
+  end
+
+  it "should raise exception if I pass a path and a block simultaneously" do
+    lambda do
+      TestModel.pg_copy_to('/tmp/bogus_path') do |row|
+      end
+    end.should raise_error
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fixtures/test_model'
+require 'fixtures/extra_field'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.before(:suite) do
+    # we create a test database if it does not exist
+    # I do not use database users or password for the tests, using ident authentication instead
+    begin
+      ActiveRecord::Base.establish_connection(
+        :adapter  => "postgresql",
+        :host     => "localhost",
+        :database => "ar_pg_copy_test"
+      )
+      ActiveRecord::Base.connection.execute %{
+        SET client_min_messages TO warning;
+        DROP TABLE IF EXISTS test_models; 
+        DROP TABLE IF EXISTS extra_fields; 
+        CREATE TABLE test_models (id serial PRIMARY KEY, data text);
+        CREATE TABLE extra_fields (id serial PRIMARY KEY, data text, created_at timestamp, updated_at timestamp);
+}
+    rescue Exception => e
+      puts "RESCUE"
+      ActiveRecord::Base.establish_connection(
+        :adapter  => "postgresql",
+        :host     => "localhost",
+        :database => "postgres"
+      )
+      ActiveRecord::Base.connection.execute "CREATE DATABASE ar_pg_copy_test"
+      retry
+    end
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-postgres-copy
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- Diogo Biazus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-09 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Now you can use the super fast COPY for import/export data directly from your AR models.
+email: diogob@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- activerecord-postgres-copy.gemspec
+- lib/activerecord-postgres-copy.rb
+- lib/activerecord-postgres-copy/base.rb
+- spec/fixtures/extra_field.rb
+- spec/fixtures/semicolon_with_different_header.csv
+- spec/fixtures/semicolon_with_header.csv
+- spec/fixtures/tab_only_data.csv
+- spec/fixtures/tab_with_different_header.csv
+- spec/fixtures/tab_with_error.csv
+- spec/fixtures/tab_with_extra_line.csv
+- spec/fixtures/tab_with_header.csv
+- spec/fixtures/test_model.rb
+- spec/pg_copy_from_spec.rb
+- spec/pg_copy_to_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/diogob/activerecord-postgres-copy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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"
+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: Put COPY command functionality in ActiveRecord's model class
+test_files: 
+- spec/spec_helper.rb
+- spec/pg_copy_from_spec.rb
+- spec/pg_copy_to_spec.rb
+- spec/fixtures/test_model.rb
+- spec/fixtures/extra_field.rb