text_ferry 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp
+.DS_Store
+bin
+test/sample_data/sample.db
+doc

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,58 @@
+= Text Ferry
+Text Ferry is a super simple DSL for quickly loading CSV text files into a
+database.
+
+== Installation
+    gem install text_ferry
+or in your Gemfile:
+    gem "text_ferry"
+
+== Notes / Use
+Text Ferry relies on Sequel[http://sequel.rubyforge.org/documentation.html] to
+do the heavy lifting. You will need to be familiar with how to define a table
+schema using Sequel. For example, to load a CSV file named "data.csv" that is
+located in a folder named "/my_data":
+
+    loader = TextFerry::Loader.new("sqlite://sample.db", "/my_data")
+    loader.load_table(:data) do
+      primary_key :id
+      String :name
+      String :phone
+    end
+
+This will load data from the CSV file into a database named "sample.db" using
+the given column names and types. Note that if the table already exists in the
+database, it will be dropped and re-created using the given schema.
+
+== 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.
+
+== License
+The MIT License
+
+Copyright © 2011 Bob Nadler, Jr.
+
+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/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rdoc/task'
+
+EXTRA_RDOC_FILES = ['README.rdoc']
+MAIN_RDOC        = 'README.rdoc'
+TEST_FILES       = Dir["test/**/*_test.rb"]
+TITLE            = 'Text Ferry'
+
+task :default => ['test']
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = TEST_FILES
+end
+
+RDoc::Task.new do |t|
+  t.main = MAIN_RDOC
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include(EXTRA_RDOC_FILES, 'lib/**/*.rb')
+  t.options << '-q'
+  t.title = TITLE
+end

data/lib/text_ferry/loader.rb

@@ -0,0 +1,48 @@
+require "csv"
+require "sequel"
+
+module TextFerry
+  # Loads CSV data into a database.
+  class Loader
+    # database_uri::
+    #   A URI that points to a database. See
+    #   http://sequel.rubyforge.org/rdoc/classes/Sequel.html#method-c-connect
+    #   for more info.
+    #
+    # data_path::
+    #   The full path to a folder that contains one or more CSV files.
+    def initialize(database_uri, data_path)
+      @db = Sequel.connect(database_uri)
+      @data_path = data_path
+    end
+
+    # Loads data from a CSV file into the database. Assumes that +table_name+
+    # corresponds to a CSV file in +data_path+. Warning: if the table already
+    # exists, it will be dropped!
+    #
+    # table_name::
+    #   The name of the CSV file to load; will also be used as the table name
+    #   in the database.
+    #
+    # schema::
+    #   A block that specifies the schema of the CSV file / table. See
+    #   http://sequel.rubyforge.org/rdoc/files/doc/schema_modification_rdoc.html
+    #   for more info.
+    def load_table(table_name, &schema)
+      @db.create_table!(table_name, &schema)
+      load_data(table_name)
+    end
+
+    private
+      def fields_for(table_name)
+        @db.schema(table_name).map { |c| c[0] }
+      end
+
+      def load_data(table_name)
+        CSV.table(File.join(@data_path, "#{table_name}.csv")).each do |row|
+          mapping = fields_for(table_name).map { |f| [f, row[f]] }
+          @db[table_name].insert(Hash[mapping])
+        end
+      end
+  end
+end

data/lib/text_ferry/version.rb

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

data/lib/text_ferry.rb

@@ -0,0 +1,2 @@
+require "text_ferry/version"
+require "text_ferry/loader"

data/test/sample_data/routes.csv

@@ -0,0 +1,20 @@
+route_id,agency_id,route_short_name,route_long_name,route_type,route_url,route_color
+1,2,"","Princeton Shuttle",2,"",
+2,2,"","Atlantic City Rail Line",2,"",
+3,2,"","Montclair-Boonton Line",2,"",
+4,2,"","Montclair-Boonton Line",2,"",
+5,2,"","Hudson-Bergen Light Rail",0,"",
+6,2,"","Main/Bergen County Line",2,"",
+7,2,"","Port Jervis Line",2,"",
+8,2,"","Morris & Essex Line",2,"",
+9,2,"","Gladstone Branch",2,"",
+10,2,"MNRG","",2,"",
+11,2,"","Northeast Corridor",2,"",
+12,2,"","North Jersey Coast Line",2,"",
+13,2,"","North Jersey Coast Line",2,"",
+14,2,"","Newark Light Rail",0,"",
+15,2,"","Pascack Valley Line",2,"",
+16,2,"","Princeton Shuttle",2,"",
+17,2,"","Raritan Valley Line",2,"",
+18,2,"","Riverline Light Rail",0,"",
+19,2,"","Meadowlands Rail Line",2,"",

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require "test/unit"
+require "contest"

data/test/text_ferry/loader_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+require "text_ferry"
+
+class LoadTest < Test::Unit::TestCase
+  DATA_PATH = File.join(File.dirname(__FILE__), "..", "sample_data")
+  DB_FILE   = File.join(DATA_PATH, "sample.db")
+  DB        = Sequel.sqlite(DB_FILE)
+
+  setup do
+    @loader = TextFerry::Loader.new("sqlite://#{DB_FILE}", DATA_PATH)
+  end
+
+  test "create a new loader" do
+    assert @loader, "expected to be able to create a new Loader"
+  end
+
+  context "table creation" do
+    test "creates table if it doesn't exist" do
+      load_routes
+      assert DB[:routes].all.length
+    end
+
+    test "drops table if it already exists" do
+      DB.drop_table(:routes) if DB[:routes]
+      DB.create_table :routes do
+        primary_key :id
+      end
+
+      assert_nothing_raised { load_routes }
+    end
+  end
+
+  context "table data" do
+    test "loads all data from csv file" do
+      load_routes
+      assert_equal 19, DB[:routes].all.length
+    end
+  end
+
+  private
+    def load_routes
+      @loader.load_table(:routes) do
+        primary_key :route_id
+        String :route_long_name
+      end
+    end
+end

data/text_ferry.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "text_ferry/version"
+
+Gem::Specification.new do |s|
+  s.name        = "text_ferry"
+  s.version     = TextFerry::VERSION
+  s.authors     = ["Bob Nadler"]
+  s.email       = ["bnadlerjr@gmail.com"]
+  s.homepage    = "https://github.com/bnadlerjr/text_ferry"
+  s.summary     = %q{A DSL for loading CSV text files into a database.}
+  s.description = %q{A DSL for loading CSV text files into a database.}
+
+  s.rubyforge_project = "text_ferry"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "contest", "~> 0.1.3"
+  s.add_development_dependency "rake", "~> 0.9.2"
+  s.add_development_dependency "rdoc", "~> 3.11"
+
+  s.add_runtime_dependency "sequel", "~> 3.28.0"
+  s.add_runtime_dependency "sqlite3", "~> 1.3.4"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: text_ferry
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Bob Nadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: contest
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.11"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.28.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: A DSL for loading CSV text files into a database.
+email: 
+- bnadlerjr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/text_ferry.rb
+- lib/text_ferry/loader.rb
+- lib/text_ferry/version.rb
+- test/sample_data/routes.csv
+- test/test_helper.rb
+- test/text_ferry/loader_test.rb
+- text_ferry.gemspec
+homepage: https://github.com/bnadlerjr/text_ferry
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3922030537894335762
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3922030537894335762
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: text_ferry
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A DSL for loading CSV text files into a database.
+test_files: 
+- test/sample_data/routes.csv
+- test/test_helper.rb
+- test/text_ferry/loader_test.rb