fixed_width_file_parser 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a18ff4c3a7378536cc1b8a24dcc46397e9d2153b
-  data.tar.gz: faf99597df832a4e34870111334bd980c485a06e
+  metadata.gz: 59078b301af3aef44e9855d8d06a4a0d554a7ec4
+  data.tar.gz: fa56e8c90146151dba6d45f1925f10e68409feff
 SHA512:
-  metadata.gz: 8fbaad05477bd91aff65e0d41cdace701bd20d71bf57e4c24f85a89d36d8774f3f6891df85290d6f989a34985158397adaaf9d423b44dd507520414218693f09
-  data.tar.gz: de10641a19c7d39f04dc8cb988b927a109a19f62a99b099eedf2f8d41b0b3fb7d6fe18ec538e55e125e5a7b2190690ff61467f871e56a57f3a6d22a736cae7bd
+  metadata.gz: 37ea2200ebea71049b61aca3ceaebfa6f8890893ed49dd98a9401b1893aa122209e12386c12c70ab2a71c02c0f1a88f30c2f137e07c2e3078bdc72c995759e9c
+  data.tar.gz: 0bc5c285b39f7182b94964359403eda95f03c96a286001a849a323425ea2bae159ec3e8b5fb70f2e0bf8894643bf8b4de9ef969b6cf7dbbdc35e7fc1dbe56a5a

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
   - 2.2.2
+
+addons:
+  code_climate:
+    repo_token: 189bae4a1eece160ea8b6b996a2f3b2b2ba6ded05f1fd89359176debd7d75e72

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fixed_width_file_parser.gemspec

data/README.md

@@ -14,11 +14,15 @@ gem 'fixed_width_file_parser'
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install fixed_width_file_parser
+```
+gem install fixed_width_file_parser
+```
 
 ## Usage
 
@@ -31,9 +35,8 @@ fields = [
   { name: 'middle_initial', position: 11 },
   { name: 'last_name', position: 12..25 }
 ]
-options = {}
 
-FixedWidthFileParser.parse(filepath, fields, options) do |row|
+FixedWidthFileParser.parse(filepath, fields) do |row|
   puts row[:first_name]
   puts row[:middle_initial]
   puts row[:last_name]
@@ -41,7 +44,16 @@ end
 ```
 
 ### Tips
-If you need to parse a fixed width file that has the last field set as a variable width field, you can set the position similar to `position: 20..-1`. Setting the end of the range as `-1` will read to the end of that line.
+If you need to parse a fixed width file that has the last field set as a variable width field, you can set the position similar to `position: 12..-1`. Setting the end of the range as `-1` will read to the end of that line.
+
+```ruby
+filepath = 'path/to/file.txt'
+fields = [
+  { name: 'first_name', position: 0..10 },
+  { name: 'middle_initial', position: 11 },
+  { name: 'last_name', position: 12..-1 }
+]
+```
 
 ## Options
 |Name|Default Value|Description|

data/Rakefile

@@ -1,4 +1,5 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
 
 Dir.glob('lib/tasks/**/*.rake').each(&method(:import))
 

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "fixed_width_file_parser"
+require 'bundler/setup'
+require 'fixed_width_file_parser'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "fixed_width_file_parser"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/fixed_width_file_parser.gemspec

@@ -1,23 +1,25 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fixed_width_file_parser/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fixed_width_file_parser"
+  spec.name          = 'fixed_width_file_parser'
   spec.version       = FixedWidthFileParser::VERSION
-  spec.authors       = ["Jim Smith"]
-  spec.email         = ["jim@jimsmithdesign.com"]
+  spec.authors       = ['Jim Smith']
+  spec.email         = ['jim@jimsmithdesign.com']
 
-  spec.summary       = "Parse fixed width files easily and efficiently."
-  spec.homepage      = "https://github.com/elevatorup/fixed_width_file_parser"
+  spec.summary       = 'Parse fixed width files easily and efficiently.'
+  spec.homepage      = 'https://github.com/elevatorup/fixed_width_file_parser'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/fixed_width_file_parser/version.rb

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

data/lib/fixed_width_file_parser.rb

@@ -1,4 +1,5 @@
-require "fixed_width_file_parser/version"
+# frozen_string_literal: true
+require 'fixed_width_file_parser/version'
 
 module FixedWidthFileParser
   # Parse a fixed width file, yielding the proper data for each line based on the fields passed in
@@ -8,32 +9,28 @@ module FixedWidthFileParser
   # @yield [Hash] Yields a hash object based on the fields provided.
   #
   # @example
-    # filepath = 'path/to/file'
-    # fields = [
-    #   { name: 'first_name', position: 0..10 },
-    #   { name: 'middle_initial', position: 11 },
-    #   { name: 'last_name', position: 12..25 }
-    # ]
-    #
-    # FixedWidthFileParser.parse(filepath, fields) do |row|
-    #   puts row
-    # end
+  # filepath = 'path/to/file'
+  # fields = [
+  #   { name: 'first_name', position: 0..10 },
+  #   { name: 'middle_initial', position: 11 },
+  #   { name: 'last_name', position: 12..25 }
+  # ]
+  #
+  # FixedWidthFileParser.parse(filepath, fields) do |row|
+  #   puts row
+  # end
 
   def self.parse(filepath, fields, options = {})
     # Set options, or use default
     force_utf8_encoding = options.fetch(:force_utf8_encoding, true)
 
     # Verify `filepath` is a String
-    unless filepath.is_a?(String)
-      raise '`filepath` must be a String'
-    end
+    raise '`filepath` must be a String' unless filepath.is_a?(String)
 
     # Verify `fields` is an array
     if fields.is_a?(Array)
       # Verify fields is not emtpy
-      if fields.empty?
-        raise '`fields` must contain at least 1 item'
-      end
+      raise '`fields` must contain at least 1 item' if fields.empty?
     else
       raise '`fields` must be an Array'
     end
@@ -52,22 +49,20 @@ module FixedWidthFileParser
 
     file = File.open(filepath)
 
-    while !file.eof?
+    until file.eof?
       line = file.readline
       # If the current line is blank, skip to the next line
       # chomp to remove "\n" and "\r\n"
       next if line.chomp.empty?
 
       # Force UTF8 encoding if force_utf8_encoding is true (defaults to true)
-      if force_utf8_encoding
-        # Handle UTF Invalid Byte Sequence Errors
-        # e.g. https://robots.thoughtbot.com/fight-back-utf-8-invalid-byte-sequences
-        line = line.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-      end
+      # Handle UTF Invalid Byte Sequence Errors
+      # e.g. https://robots.thoughtbot.com/fight-back-utf-8-invalid-byte-sequences
+      line = line.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '') if force_utf8_encoding
 
       line_fields = {}
       fields.each do |field|
-        line_fields[field[:name].to_sym] = line[ field[:position] ].nil? ? nil :  line[ field[:position] ].strip
+        line_fields[field[:name].to_sym] = line[field[:position]].nil? ? nil : line[field[:position]].strip
       end
 
       yield(line_fields)
@@ -77,63 +72,4 @@ module FixedWidthFileParser
 
     file.close
   end
-
-  def self.parse_in_batches(filepath, fields, options = {})
-    # Set options, or use default
-    batch_size = options.fetch(:batch_size, 1000)
-    force_utf8_encoding = options.fetch(:force_utf8_encoding, true)
-
-    # Verify `filepath` is a String
-    unless filepath.is_a?(String)
-      raise '`filepath` must be a String'
-    end
-
-    # Verify `fields` is an array
-    if fields.is_a?(Array)
-      # Verify fields is not emtpy
-      if fields.empty?
-        raise '`fields` must contain at least 1 item'
-      end
-    else
-      raise '`fields` must be an Array'
-    end
-
-    # Verify each field has a `name` and `position`
-    unless fields.all? { |item| item.key?(:name) && item.key?(:position) }
-      raise 'Each field hash must include a `name` and a `position`'
-    end
-
-    # Verify that each `position` is either a Range or an Integer
-    unless fields.all? { |item| item[:position].is_a?(Range) || item[:position].is_a?(Integer) }
-      raise "Each field's `position` must be a Range or an Integer"
-    end
-
-    GC.start
-
-    File.open(filepath) do |file|
-      file.lazy.drop(1).each_slice(batch_size) do |lines|
-        lines.each do |line|
-          # If the current line is blank, skip to the next line
-          # chomp to remove "\n" and "\r\n"
-          next if line.chomp.empty?
-
-          # Force UTF8 encoding if force_utf8_encoding is true (defaults to true)
-          if force_utf8_encoding
-            # Handle UTF Invalid Byte Sequence Errors
-            # e.g. https://robots.thoughtbot.com/fight-back-utf-8-invalid-byte-sequences
-            line = line.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-          end
-
-          line_fields = {}
-          fields.each do |field|
-            line_fields[field[:name].to_sym] = line[ field[:position] ].nil? ? nil :  line[ field[:position] ].strip
-          end
-
-          yield(line_fields)
-        end
-
-        GC.start
-      end
-    end
-  end
 end

data/lib/tasks/rspec.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixed_width_file_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Jim Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: 
 email:
 - jim@jimsmithdesign.com
@@ -90,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Parse fixed width files easily and efficiently.