fixed_width_file_parser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59078b301af3aef44e9855d8d06a4a0d554a7ec4
-  data.tar.gz: fa56e8c90146151dba6d45f1925f10e68409feff
+  metadata.gz: 1ed5236150765f850f0ef121969ead2690e2902a
+  data.tar.gz: 8b192816560cebe723d2273234f13c47c7fc46b6
 SHA512:
-  metadata.gz: 37ea2200ebea71049b61aca3ceaebfa6f8890893ed49dd98a9401b1893aa122209e12386c12c70ab2a71c02c0f1a88f30c2f137e07c2e3078bdc72c995759e9c
-  data.tar.gz: 0bc5c285b39f7182b94964359403eda95f03c96a286001a849a323425ea2bae159ec3e8b5fb70f2e0bf8894643bf8b4de9ef969b6cf7dbbdc35e7fc1dbe56a5a
+  metadata.gz: 3dc0f28edf26041202972b8a7beff261a05069470c268cadec1941a3bf58d7a624beb3f7544513e71c1ef267b8144d993517e7eff81c843cb2936cb44a3ea485
+  data.tar.gz: 1f52e50aa212549daa08b685d2383f97312aa6ffb74d19523b6a90897ec6c2ae97db136fcb0f90c620bffcfe78a91112b58bf93c663d4132fe2db19af00febb0

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.ruby-version
 /.yardoc
 /Gemfile.lock
 /_yardoc/

data/.ruby-gemset

@@ -0,0 +1 @@
+fixed_width_file_parser

data/.travis.yml

@@ -2,6 +2,9 @@ language: ruby
 rvm:
   - 2.2.2
 
+after_script:
+  - bundle exec codeclimate-test-reporter
+
 addons:
   code_climate:
     repo_token: 189bae4a1eece160ea8b6b996a2f3b2b2ba6ded05f1fd89359176debd7d75e72

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Jim Smith
+
+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

@@ -26,21 +26,34 @@ gem install fixed_width_file_parser
 
 ## Usage
 
-In order to parse a fixed width file, you need to define the fields (and their positions) as well as the filepath, and then pass those to a block that will yield the data for each row.
+In order to parse a fixed width file, you need to define the fields and their positions.
+Call parse with a filepath or an opened IO object, and pass those to a block that will yield the data for each row.
 
 ```ruby
-filepath = 'path/to/file.txt'
 fields = [
   { name: 'first_name', position: 0..10 },
   { name: 'middle_initial', position: 11 },
   { name: 'last_name', position: 12..25 }
 ]
 
+filepath = 'path/to/file.txt'
+
 FixedWidthFileParser.parse(filepath, fields) do |row|
   puts row[:first_name]
   puts row[:middle_initial]
   puts row[:last_name]
 end
+
+# or, from an input stream:
+
+file = StringIO.new(sftp.file.open(filename).read, 'rb')
+
+FixedWidthFileParser.parse(file, fields) do |row|
+  puts row[:first_name]
+  puts row[:middle_initial]
+  puts row[:last_name]
+end
+
 ```
 
 ### Tips
@@ -60,6 +73,14 @@ fields = [
 |---|---|---|
 |force_utf8_encoding|true|Force UTF-8 encoding on lines being parsed. This alleviates `invalid byte sequence in UTF-8` errors thrown when trying to split a string with invalid UTF characters. For more information, view this [article](https://robots.thoughtbot.com/fight-back-utf-8-invalid-byte-sequences).|
 
+e.g.
+
+```
+FixedWidthFileParser.parse(filepath, fields, force_utf8_encoding: false) do |row| 
+  puts row 
+end
+```
+
 
 ## Development
 
@@ -70,7 +91,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 1. Fork it ( https://github.com/elevatorup/fixed_width_file_parser/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Create a new Pull Request

data/lib/fixed_width_file_parser.rb

@@ -24,8 +24,8 @@ module FixedWidthFileParser
     # Set options, or use default
     force_utf8_encoding = options.fetch(:force_utf8_encoding, true)
 
-    # Verify `filepath` is a String
-    raise '`filepath` must be a String' unless filepath.is_a?(String)
+    # Verify `filepath` is a String or IO object
+    raise '`filepath` must be a String' unless filepath.is_a?(String) || filepath.respond_to?(:readline)
 
     # Verify `fields` is an array
     if fields.is_a?(Array)
@@ -47,7 +47,11 @@ module FixedWidthFileParser
 
     GC.start
 
-    file = File.open(filepath)
+    if filepath.respond_to? :readline
+      file = filepath
+    else
+      file = File.open(filepath)
+    end
 
     until file.eof?
       line = file.readline

data/lib/fixed_width_file_parser/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module FixedWidthFileParser
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixed_width_file_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jim Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,8 +75,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console