seeding_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01a703ee260dde1c9a61e85b2120628812041361
+  data.tar.gz: 9fc2986bd93be82be7fb7da99cef1932d43ec107
+SHA512:
+  metadata.gz: 15e476c55dec624377745ad0a3a14e274812f349a7a464b16eb1746b0da50f9f0833f26dd08d471737fd027235208b797f053261309106c88673cf8962c4360b
+  data.tar.gz: 47d6cfb73b7ab92867b3d288908718a18d5f0d2e74f332e313eff06dd311480ac57b9c76f73699a793c68baa03bbeab1904745aea45dbe0f469f16e5be33b652

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seeding_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Norman Clarke and FlexMinder
+
+MIT License
+
+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,38 @@
+# SeedingUtils
+
+Some Postgres-specific database seeding utilities we use at FlexMinder.
+
+It mainly provides a wrapper around Postgres's COPY functionality to allow you
+to cache largish seed datasets so that recreating a schema with seed data
+during early application development is runs more quickly.
+
+In our use case, we need to load US ZIP code and other geolocation data, and
+our initial data seeding takes 3-5 minutes. With the caching functionality
+provided by this gem, we reduce that to about 30 seconds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seeding_utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seeding_utils
+
+## Usage
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/seeding_utils.rb

@@ -0,0 +1,75 @@
+require "seeding_utils/version"
+require 'pathname'
+
+module SeedingUtils
+
+  extend self
+
+  # Expects a proc that when called, returns a raw PG connection.
+  # For example:
+  #
+  #     SeedingUtils.connection = -> {ActiveRecord::Base.connection.raw_connection}
+  # or:
+  #     SeedingUtils.connection = -> {PG::Connection.open dbname: 'foo'}
+  def connect(callable)
+    @connection_callable = callable
+  end
+
+  # @return PG::Connection
+  def connection
+    @connection_callable.call
+  end
+
+  class Table
+
+    attr_accessor :name, :quoted_name
+
+    def initialize(name)
+      @conn = SeedingUtils.connection
+      self.name = name
+      self.quoted_name = PG::Connection.quote_ident(name)
+    end
+
+    def seed(cache_file = nil, &block)
+      path = Pathname(cache_file.to_s)
+      return seed_uncached(&block) if cache_file.nil?
+      if path.file?
+        puts %{-- Loading #{name} seeds from cache}
+        @conn.exec %{DELETE FROM #{quoted_name}}
+        load path.open 'r:binary'
+      elsif block_given?
+        seed_uncached(&block)
+        path.open 'w:binary' do |io|
+          dump(io)
+        end
+      end
+    end
+
+    def seed_uncached(&block)
+      puts %{-- Loading #{name} seeds without cache}
+      yield
+    end
+
+
+    # Expects an open IO object for writing.
+    def dump(io)
+      @conn.exec %{COPY #{quoted_name} TO STDOUT WITH (FORMAT 'binary')}
+      while row = @conn.get_copy_data do
+        io.write(row)
+      end
+      io.rewind
+      return io
+    end
+
+    # Expects an open IO object for reading.
+    def load(io)
+      @conn.exec %{DELETE FROM #{quoted_name}}
+      @conn.exec %{COPY #{quoted_name} FROM STDIN WITH (FORMAT 'binary')}
+      while data = io.read(256)
+        @conn.put_copy_data(data)
+      end
+      @conn.put_copy_end
+    end
+  end
+
+end

data/lib/seeding_utils/version.rb

@@ -0,0 +1,3 @@
+module SeedingUtils
+  VERSION = "0.0.1"
+end

data/seeding_utils.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seeding_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seeding_utils"
+  spec.version       = SeedingUtils::VERSION
+  spec.authors       = ["Norman Clarke"]
+  spec.email         = ["norman@njclarke.com"]
+  spec.description   = %q{Seeding Utils for Postgres.}
+  spec.summary       = %q{Some database seeding utilities for Postgres.}
+  spec.homepage      = "https://github.com/flexminder/seeding_utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg", "~> 0.16.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/seeding_utils_test.rb

@@ -0,0 +1,49 @@
+require 'bundler/setup'
+require 'pg'
+require 'test/unit'
+require 'seeding_utils'
+
+connection = nil
+SeedingUtils.connect -> {
+  connection ||= PG::Connection.open dbname: 'test_seeding_utils'
+}
+
+
+class SeedingUtilsTest < Test::Unit::TestCase
+
+  def setup
+    @conn = SeedingUtils.connection
+    @conn.exec <<-END
+      SET client_min_messages TO 'warning';
+      DROP TABLE IF EXISTS people;
+      CREATE TABLE people (
+        id INTEGER PRIMARY KEY,
+        name VARCHAR(255) NOT NULL
+      );
+      INSERT INTO people (id, name) VALUES (1, 'John Doe');
+      INSERT INTO people (id, name) VALUES (2, 'Juan Fulano');
+    END
+  end
+
+  def test_should_dump_copy_data
+    table = SeedingUtils::Table.new 'people'
+    io = StringIO.new('', 'r+:binary')
+    assert_equal 0, io.size
+    table.dump(io)
+    assert io.size > 0
+    data = io.read.force_encoding 'BINARY'
+    assert_match 'Juan Fulano', data
+  end
+
+  def test_should_read_copy_data
+    table = SeedingUtils::Table.new 'people'
+    io = StringIO.new('', 'r+:binary')
+    table.dump(io)
+    @conn.exec 'DELETE FROM people'
+    result = @conn.exec 'SELECT COUNT(*) FROM people'
+    assert_equal "0", result.getvalue(0, 0)
+    table.load(io)
+    result = @conn.exec 'SELECT COUNT(*) FROM people'
+    assert_equal "2", result.getvalue(0, 0)
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: seeding_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Seeding Utils for Postgres.
+email:
+- norman@njclarke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seeding_utils.rb
+- lib/seeding_utils/version.rb
+- seeding_utils.gemspec
+- test/seeding_utils_test.rb
+homepage: https://github.com/flexminder/seeding_utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Some database seeding utilities for Postgres.
+test_files:
+- test/seeding_utils_test.rb
+has_rdoc: