loady 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf18fef23de1f5e6fdaf2105cd8fb869f1c34242
-  data.tar.gz: dc657ab3d90455b7e4aa7d590b65ca50e6587cc5
+  metadata.gz: ecc3df9a14b6e88e79402ef6f27f4f5fa9a451bf
+  data.tar.gz: 2d3fed1bdaed9630f5f518eeeab491fbf4aa041d
 SHA512:
-  metadata.gz: c4d2a56c7ce7798837c3eb97994b0d8d0d2ae876e266ba9cc5d98dabe8242a428d93bec1db1809589fb882e6535efbacb1f11374138c9581e8bc9d5a239f6201
-  data.tar.gz: 5bd7240dbfbcb811af20be78f60078b35bfe2e7930b3fe1fbb5656f044bf748832bf671b4c91fa050a9b203d7981d13a839ed08f7377638173aaeab78bb587b2
+  metadata.gz: f0f459bcfacda6e99aeef4a7850e07db3722506c9142ac56f19a16db97e2f71486ebdc80487d47fc1e5639f16c6cb085526672d672bac99121bed08f5073e75f
+  data.tar.gz: 21b249d660c826e3ccfeb4503681bb40105c7ff97e7bccd6f37091a0ba539d3f95656a45b524727a10727f55537f4eeea9f39ccfb92e00e37e8ec63e732ef73a

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tee Parham
+
+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

@@ -1,11 +1,13 @@
-[![Gem Version](https://badge.fury.io/rb/loady.png)](http://badge.fury.io/rb/loady)
-[![Build Status](https://api.travis-ci.org/teeparham/loady.png)](https://travis-ci.org/teeparham/loady)
-[![Code Climate](https://codeclimate.com/github/teeparham/loady.png)](https://codeclimate.com/github/teeparham/loady)
-[![Coverage Status](https://coveralls.io/repos/teeparham/loady/badge.png)](https://coveralls.io/r/teeparham/loady)
+# Loady
 
-# Loady - A file loader with simple logging
+[![Gem Version](http://img.shields.io/gem/v/loady.svg)](http://rubygems.org/gem/loady)
+[![Build Status](http://img.shields.io/travis/teeparham/loady.svg)](https://travis-ci.org/teeparham/loady)
+[![Code Climate](http://img.shields.io/codeclimate/github/teeparham/loady.svg)](https://codeclimate.com/github/teeparham/loady)
+[![Coverage Status](http://img.shields.io/coveralls/teeparham/loady.svg)](https://coveralls.io/r/teeparham/loady)
 
-Loady is a simple file reader and logger. Use it to quickly load any delimited file, continue on error rows, and do basic logging.
+Loady is a simple file reader and logger. Use it to read any delimited file. Loady makes it easy to conveniently convert input fields to an attribute hash, continue on error rows, and do basic logging.
+
+Loady was initially created to load hundreds of millions of rows from CSV files that had various data errors.
 
 It works with MRI ruby 1.9.3+. It uses ruby's CSV library to parse rows.
 
@@ -64,3 +66,21 @@ Loady.read "/your/file.tab", col_sep: "\t"  do |row|
 end
 ```
 
+### Collect log messages in memory
+
+`Loady::MemoryLoader` is a class that collects log messages in memory.
+
+``` ruby
+memory_logger = Loady::MemoryLogger.new
+
+Loady.read "/your/file.csv", logger: memory_logger do |row|
+  # do things
+end
+
+memory_logger.messages
+=> [
+    'Line 123: Something bad happened.', 
+    'Line 456: Exception of some sort.',
+    'Finished. Loaded 9998 rows. 2 unprocessed rows.'
+   ]
+```

data/lib/loady/attribute_array.rb

@@ -9,15 +9,15 @@ module Loady
     # options:
     #   strip: false    -- default = true
     #                   -- array values must be strings if :strip is true
-    def to_attributes(names, options={})
+    def to_attributes(names, options = {})
       options = { strip: true }.merge(options)
 
       attr_hash = {}
 
       names.each_with_index do |name, i|
         attr_hash[name] = 
-          if i < self.size && self[i]
-            options[:strip] ? self[i].strip : self[i]
+          if i < size && self[i]
+            options[:strip] ? self[i].to_s.strip : self[i]
           end
       end
 

data/lib/loady/csv_loader.rb

@@ -14,18 +14,18 @@ module Loady
     #   logger: Logger.new('/somewhere/file.log')  -- default = Logger.new(STDOUT)
     #   plus any valid options you can pass to CSV.new:
     #     see http://www.ruby-doc.org/stdlib/libdoc/csv/rdoc/classes/CSV.html#M000190
-    def read(filename, options={}, &block)
+    def read(filename, options = {}, &block)
       @logger = options.delete(:logger) || default_logger
 
-      f = File.new(filename)
-      f.autoclose = true
-      f.gets if options.delete(:skip_first_row)
+      file = File.new(filename)
+      file.autoclose = true
+      file.gets if options.delete(:skip_first_row)
 
-      f.each do |line|
+      file.each do |line|
         readline line, options, &block
       end        
 
-      @logger.info "Finished. Loaded #@success rows. #@warning unprocessed rows."
+      @logger.info "Finished. Loaded #{@success} rows. #{@warning} unprocessed rows."
     end
 
     class << self
@@ -46,7 +46,7 @@ module Loady
       end
     rescue Exception => ex
       @warning += 1
-      @logger.warn "#{ex.to_s.gsub("line 1", "line #@line_number")}\n#{line}"
+      @logger.warn "#{ex.to_s.gsub("line 1", "line #{@line_number}")}\n#{line}"
     end
 
     def default_logger

data/lib/loady/memory_logger.rb

@@ -2,7 +2,7 @@ module Loady
   class MemoryLogger
     attr_reader :messages
 
-    def initialize(options={})
+    def initialize(options = {})
       @messages = []
     end
 
@@ -10,7 +10,7 @@ module Loady
       @messages << message
     end
 
-    alias_method :warn, :info
-    alias_method :error, :info
+    alias warn info
+    alias error info
   end
 end

data/lib/loady/version.rb

@@ -1,3 +1,3 @@
 module Loady
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,83 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: loady
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: CSV file loader with simple logging
+        version: '5.2'
+description: File loader with simple logging
 email:
 - tee@neighborland.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
+- LICENSE.txt
 - README.md
-- Rakefile
 - lib/loady.rb
 - lib/loady/attribute_array.rb
 - lib/loady/csv_loader.rb
 - lib/loady/memory_logger.rb
 - lib/loady/version.rb
-- loady.gemspec
-- test/csv/file1.csv
-- test/csv/file2.csv
-- test/csv/file3.dat
-- test/test_attribute_array.rb
-- test/test_csv_loader.rb
-- test/test_helper.rb
-- test/test_memory_logger.rb
 homepage: http://github.com/teeparham/loady
 licenses:
 - MIT
@@ -98,15 +86,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: CSV file loader with simple logging
-test_files:
-- test/csv/file1.csv
-- test/csv/file2.csv
-- test/csv/file3.dat
-- test/test_attribute_array.rb
-- test/test_csv_loader.rb
-- test/test_helper.rb
-- test/test_memory_logger.rb
+summary: File loader with simple logging
+test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,8 +0,0 @@
-pkg/*
-*.gem
-.bundle
-.idea
-Gemfile.lock
-*#
-.#*
-*~

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.0

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-group :test do
-  gem 'coveralls', require: false
-end
-
-gemspec

data/Rakefile

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

data/loady.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-require "./lib/loady/version"
-
-Gem::Specification.new do |s|
-  s.name        = "loady"
-  s.version     = Loady::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Tee Parham"]
-  s.email       = %w(tee@neighborland.com)
-  s.homepage    = "http://github.com/teeparham/loady"
-  s.summary     = %q{CSV file loader with simple logging}
-  s.description = %q{CSV file loader with simple logging}
-  s.license     = "MIT"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = []
-  s.require_paths = %w(lib)
-
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
-end

data/test/csv/file1.csv

@@ -1,11 +0,0 @@
-monkey name,best year
-Bubbles,2000
-Grape Ape,1975
-Albert,1948
-Koko,1971
-Curious George,1941
-Clyde,1975
-Bear,1980
-Mighty Joe Young,1998
-Donkey Kong,1981
-King Kong,1933

data/test/csv/file2.csv

@@ -1,15 +0,0 @@
-"Bubbles","2000"
-"Grape Ape",1975
-Albert,1948,note: everything is read as a string whether it is quoted or not
-Koko,1971
-Curious George,1941
-blah.......,
-",,,,,,,,,,,,,,,,,,,,this is a bad row because of the quote
-",,,,,,,,,,,",,,/"\",,,,,,this is a bad row too
-
-"          blank rows are skipped, this is bad though
-
-Bear,1980,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,"this is ok"
-Mighty Joe Young
-Donkey Kong,1981
-King Kong,1933

data/test/csv/file3.dat

@@ -1,11 +0,0 @@
-monkey name	best year
-Bubbles	2000
-Grape Ape	1975
-Albert	1948
-Koko	1971
-Curious George	1941
-Clyde	1975
-Bear	1980
-Mighty Joe Young	1998
-Donkey Kong	1981
-King Kong	1933

data/test/test_attribute_array.rb

@@ -1,33 +0,0 @@
-require 'test_helper'
-
-class AttributeArrayTest < MiniTest::Spec
-  it "respond to to_attributes" do
-    aa = Loady::AttributeArray.new
-    assert aa.respond_to? :to_attributes
-  end
-
-  it "initialize with Array" do
-    aa = Loady::AttributeArray.new([1,2])
-    assert_equal [1,2], aa
-  end
-
-  describe "#to_attributes" do
-    it "return named attributes" do
-      row = Loady::AttributeArray.new(['Bubbles  ', '2000', ' King Kong '])
-      attrs = row.to_attributes [:name, :year, :mom]
-      assert_equal attrs.size, 3
-      assert_equal attrs[:name], 'Bubbles'
-      assert_equal attrs[:year], '2000'
-      assert_equal attrs[:mom], 'King Kong'
-    end
-
-    it "return named attributes when missing values" do
-      row = Loady::AttributeArray.new(['Bubbles  ', '2000'])
-      attrs = row.to_attributes [:name, :year, :mom]
-      assert_equal attrs.size, 3
-      assert_equal attrs[:name], 'Bubbles'
-      assert_equal attrs[:year], '2000'
-      assert_nil attrs[:mom]
-    end
-  end
-end

data/test/test_csv_loader.rb

@@ -1,62 +0,0 @@
-require 'test_helper'
-
-class CsvLoaderTest < MiniTest::Spec
-  it "delegate Loady.csv to instance #read" do
-    Loady::CsvLoader.any_instance.expects :read
-    Loady.csv("file")
-  end
-
-  it "delegate Loady.read to instance #read" do
-    Loady::CsvLoader.any_instance.expects :read
-    Loady.read("file")
-  end
-
-  it "delegate #read to instance #read" do
-    Loady::CsvLoader.any_instance.expects :read
-    Loady::CsvLoader.read("file")
-  end
-
-  it "read file1" do
-    monkeys = []
-
-    Loady.read "test/csv/file1.csv", skip_first_row: true do |row|
-      monkeys << { name: row[0], year: row[1] }
-    end
-
-    assert_equal monkeys.count, 10, "total rows read"
-    assert_equal monkeys[0][:name], "Bubbles", "first row name"
-    assert_equal monkeys[0][:year], "2000", "first row year"
-    assert_equal monkeys[9][:name], "King Kong", "last row name"
-    assert_equal monkeys[9][:year], "1933", "last row year"
-  end
-
-  it "read file2 with logger using named attributes" do
-    logger = Logger.new("/dev/null")
-    monkeys = []
-
-    Loady.read "test/csv/file2.csv", logger: logger do |row|
-      monkeys << row.to_attributes([:name, :year])
-    end
-
-    assert_equal monkeys.count, 10, "total rows read"
-    assert_equal monkeys[0][:name], "Bubbles", "first row name"
-    assert_equal monkeys[0][:year], "2000", "first row year"
-    assert_equal monkeys[9][:name], "King Kong", "last row name"
-    assert_equal monkeys[9][:year], "1933", "last row year"
-  end
-
-  it "read file3, a tab-delimited file" do
-    monkeys = []
-
-    Loady.read "test/csv/file3.dat", skip_first_row: true, col_sep: "\t" do |row|
-      monkeys << { name: row[0], year: row[1] }
-    end
-
-    assert_equal monkeys.count, 10, "total rows read"
-    assert_equal monkeys[0][:name], "Bubbles", "first row name"
-    assert_equal monkeys[0][:year], "2000", "first row year"
-    assert_equal monkeys[9][:name], "King Kong", "last row name"
-    assert_equal monkeys[9][:year], "1933", "last row year"
-  end
-       
-end

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-require 'coveralls'
-Coveralls.wear!
-
-require 'minitest/autorun'
-require 'mocha/setup'
-require 'loady'

data/test/test_memory_logger.rb

@@ -1,28 +0,0 @@
-require 'test_helper'
-
-class MemoryLoggerTest < MiniTest::Spec
-  describe "memory logger" do
-    before do
-      @logger = Loady::MemoryLogger.new
-    end
-
-    it "have no messages" do
-      assert_empty @logger.messages
-    end
-
-    it "log warning" do
-      @logger.warn "message"
-      assert_equal "message", @logger.messages.first
-    end
-
-    it "log info" do
-      @logger.info "message"
-      assert_equal "message", @logger.messages.first
-    end
-
-    it "log error" do
-      @logger.error "message"
-      assert_equal "message", @logger.messages.first
-    end
-  end
-end