fixed_width_file_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3455ef0663d655e5f0e6961429d6a3aa69eae6a0
+  data.tar.gz: fdf7ab1baa2f5047f8d9720b42c659a0c9276dba
+SHA512:
+  metadata.gz: 8ed8bf0c4ff9214fb096c43c0df00f2b2a446232a4459538f947f6fbd8d903921375a1c5e161072cc7eff82486821a3321e348e1f3c06fc6954d16d39f8fab46
+  data.tar.gz: f5808f8824d113cde29ecb1b24503050cbe39550ce47b8cb9a7ed9952c3095219b516d11800dacc4b7ade542643d9a29fa931734869f7beb3e9eaa4d405ffeba

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# FixedWidthFileParser
+
+FixedWidthFileParser is used to parse fixed width files. Crazy right?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fixed_width_file_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ 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.
+
+```ruby
+filepath = 'path/to/file.txt'
+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[:first_name]
+  puts row[:middle_initial]
+  puts row[:last_name]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/elevatorup/fixed_width_file_parser/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixed_width_file_parser.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+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.version       = FixedWidthFileParser::VERSION
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/lib/fixed_width_file_parser/version.rb

@@ -0,0 +1,3 @@
+module FixedWidthFileParser
+  VERSION = "0.1.0"
+end

data/lib/fixed_width_file_parser.rb

@@ -0,0 +1,63 @@
+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
+  #
+  # @param filepath [String] The path to the file to be parsed.
+  # @param fields [Array(Hash{name => String, position => Range|Integer})] An array of field hashes, each containing a `name` and a `position`.
+  # @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
+
+  def self.parse(filepath, fields)
+    # 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
+
+    file = File.open(filepath)
+
+    while !file.eof?
+      line = file.readline
+
+      line_fields = {}
+      fields.each do |field|
+        line_fields[field[:name].to_sym] = line[ field[:position] ].strip
+      end
+
+      yield(line_fields)
+    end
+
+    file.close
+  end
+end

data/lib/tasks/rspec.rake

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fixed_width_file_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixed_width_file_parser.gemspec
+- lib/fixed_width_file_parser.rb
+- lib/fixed_width_file_parser/version.rb
+- lib/tasks/rspec.rake
+homepage: https://github.com/elevatorup/fixed_width_file_parser
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Parse fixed width files easily and efficiently.
+test_files: []