parse_me 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3@parse_me"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.18 (version)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+if [[ -s Gemfile ]] && {
+  ! builtin command -v bundle >/dev/null ||
+  builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+}
+then
+  printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+  gem install bundler
+fi
+if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+then
+  bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+fi

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parse_me.gemspec
+gemspec
+
+gem "rspec"
+gem "simplecov"
+gem "rake"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Serge Morales
+
+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

@@ -0,0 +1,50 @@
+# ParseMe [![Build Status](https://travis-ci.org/sergelerator/parse_me.png?branch=master)](https://travis-ci.org/sergelerator/parse_me)
+
+The `parse_me` gem aims to provide an easy to use plain text parser. Currently on early development, expect to be able to parse fixed and variable width files with something similar to:
+
+    rules = {
+      name:       { required: true, length: 50 },
+      last_name:  { required: true, length: 50 },
+      age:        { numeric: :integer },
+      email:      { required: true, email: true},
+      last_seen:  { date: "YYYY-MM-DD" }
+    }
+
+    options = {
+      row_delimiter:    "\r\n",  # Defaults to "\n"
+      field_delimiter:  "|"
+    }
+
+    result = ParseMe::VarWidthParser.parse(source_string, rules, options)
+    result.each do |record|
+      record.valid?       # => Runs the validations specified in rules, returns true if all pass
+      record.attributes   # => Returns a Hash with the parsed attributes, using rules' keys
+      record.name         # => Returns the name attribute
+      record.errors       # => Returns a collection of the errors encountered during validation
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'parse_me'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parse_me
+
+## Usage
+
+Usage will be documented on the first Alpha release.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+namespace :spec do
+  desc "Runs all the specs"
+  task :all do
+    system("bundle exec rspec")
+  end
+end
+
+task default: 'spec:all'

data/lib/parse_me/fixed_width_parser.rb

@@ -0,0 +1,11 @@
+require 'parse_me/parsed_object'
+require 'parse_me/input_splitting'
+require 'parse_me/input_splitting/fixed'
+require 'parse_me/input_splitting/var'
+
+module ParseMe
+  class FixedWidthParser
+    extend InputSplitting::Fixed
+    include InputSplitting::Fixed
+  end
+end

data/lib/parse_me/input_splitting/fixed/base.rb

@@ -0,0 +1,51 @@
+module ParseMe
+  module InputSplitting
+    module Fixed
+      module Base
+        # Boolean check, validates the presence of a length rule for every attribute in the @rules
+        def valid_length_rules?
+          @rules and get_length_rules.reduce(true, :&) and valid_row_labels?
+        end
+
+        # Maps the length rules to an array
+        def get_length_rules
+          @length_rules ||= (labeled_rows? ? @rules.values.map(&:values).flatten : @rules.values).map{|a| a[:length]}
+        end
+
+        # Returns the fixed width of a file
+        def file_width
+          raise Exception.new("File width can't be properly calculated if length rules are invalid") unless valid_length_rules?
+          @file_width ||= (labeled_rows? ? @rules.first[1].values : @rules.values).map{|a| a[:length]}.reduce(0, :+) + label_length
+        end
+
+        # Creates the template string used to unpack a record
+        def unpack_pattern label = nil
+          (labeled_rows? ? "A#{label_length}" : '') + length_rules_for(label).map{|l| "A#{l}"}.join
+        end
+
+        # Splits the input into lines, uses the file width for this.
+        def split_input
+          @split_input ||= @source.delete("\n").scan(/.{#{file_width}}/)
+        end
+
+        # Gets the list of attributes specified in @rules. Can optionally retrieve them from a labeled set of rules, the optional label argument should be supplied when the labeled_rows option is set.
+        def attributes label = nil
+          (labeled_rows? ? @rules[label] : @rules).keys
+        end
+
+        # Decodes the supplied string and returns the attributes hash
+        def member str
+          unpacked = str.unpack unpack_pattern
+          Hash[attributes.zip unpacked]
+        end
+
+        # Maps a collection of attributes in the form of hashes.
+        def collection
+          split_input.map do |str|
+            labeled_rows? ? labeled_member(str, label_for(str)) : member(str)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parse_me/input_splitting/fixed/labels.rb

@@ -0,0 +1,53 @@
+module ParseMe
+  module InputSplitting
+    module Fixed
+      module Labels
+        # Boolean check for the parse option `:labeled_rows`
+        def labeled_rows?
+          @labeled_rows ||= @options[:labeled_rows]
+        end
+
+        # Boolean validation check, returns a truth value if all of the labels specified in the @rules are of the same length.
+        def valid_row_labels?
+          return true unless labeled_rows?
+          label_lengths.first == label_lengths.last
+        end
+
+        # Returns an array with the length rules in a given @rules configuration hash.
+        # If the label does not exist (or if the `labeled_rows?` switch is turned off)
+        # this method falls back to fetching the rules of the root @rules hash.
+        def length_rules_for label
+          (@rules[label] || @rules).values.map{|a| a[:length]}
+        end
+
+        # Gets an array with the labels specified in @rules.
+        def labels
+          @labels ||= @rules.keys.map(&:to_s).sort_by{|label| label.length }
+        end
+
+        # Returns an array with the lengths of the labels specified in @rules
+        def label_lengths
+          @label_lengths ||= labels.map(&:length).map(&:to_i)
+        end
+
+        # Returns the length of the labels used in the file
+        def label_length
+          @label_length ||= labeled_rows? ? label_lengths.first : 0
+        end
+
+        # Returns the label for a given string
+        def label_for str
+          str[0...label_length]
+        end
+
+        # Returns a Hash with the data from *str* formatted as an attribute list,
+        # with the keys being attribute names, and the values being the attribute
+        # values for that key.
+        def labeled_member str, label
+          (unpacked = str.unpack unpack_pattern(label)).shift
+          Hash[attributes(label).zip unpacked].merge({__label: label})
+        end
+      end
+    end
+  end
+end

data/lib/parse_me/input_splitting/fixed.rb

@@ -0,0 +1,40 @@
+require 'parse_me/input_splitting/fixed/labels'
+require 'parse_me/input_splitting/fixed/base'
+
+module ParseMe
+  module InputSplitting
+    module Fixed
+      def self.included(base)
+        base.instance_eval do
+          include Base
+          include Labels
+        end
+      end
+
+      def self.extended(base)
+        base.instance_eval do
+          extend Base
+          extend Labels
+        end
+      end
+
+      def parse source, rules, options = {}
+        @options = options
+        @options[:labeled_rows] ||= false
+        @options[:row_delimiter] ||= "\n"
+
+        @rules = rules
+        @source = source
+
+        unless valid_length_rules?
+          raise Exception.new('Fixed size file input requires a length rule for every attribute')
+        end
+
+        collection.map do |record|
+          ParsedObject.new(record, @rules)
+        end
+      end
+
+    end
+  end
+end

data/lib/parse_me/input_splitting.rb

@@ -0,0 +1,7 @@
+require 'parse_me/input_splitting/fixed'
+require 'parse_me/input_splitting/var'
+
+module ParseMe
+  module InputSplitting
+  end
+end

data/lib/parse_me/parsed_object.rb

@@ -0,0 +1,67 @@
+require 'parse_me/transformations'
+require 'parse_me/validations'
+
+module ParseMe
+  class ParsedObject
+    include ParseMe::Validations
+    include ParseMe::Transformations
+
+    attr_reader :attributes, :record_label, :rules, :errors
+
+    def initialize(attributes, rules = {})
+      @attributes = attributes
+      @record_label = @attributes.delete(:__label) if @attributes[:__label]
+      @rules = record_label ? rules[record_label] : rules
+      @errors = []
+
+      apply_validations
+      apply_transformations
+    end
+
+    def method_missing(name, *args, &b)
+      @attributes[name] || super
+    end
+
+    def transformations
+      @transformations ||= ParseMe::Transformations.public_instance_methods
+    end
+
+    def validation_rules
+      @validation_rules ||= ParseMe::Validations.public_instance_methods
+    end
+
+    def apply_transformations
+      rules.each do |attr, set|
+        (set.keys & transformations).each do |transformation|
+          transform(attr, transformation, set[transformation])
+        end
+      end
+    end
+
+    def transform(attr, transformation, val)
+      @attributes[attr] = method(transformation).call(@attributes[attr], val)
+    end
+
+    def apply_validations
+      rules.each do |attr, set|
+        (set.keys & validation_rules).each do |validation|
+          validate(attr, validation, set[validation])
+        end
+      end
+    end
+
+    def validate(attr, validation, val)
+      unless method(validation).call(@attributes[attr], val)
+        add_error("#{validation} validation failed for '#{attr}' => '#{val}'")
+      end
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def add_error msg
+      errors << msg
+    end
+  end
+end

data/lib/parse_me/transformations.rb

@@ -0,0 +1,9 @@
+module ParseMe
+  module Transformations
+    def ghost_decimal_scale(input, rule_value)
+      raise Exception("ghost_decimal_scale should be able to ve converted to int") unless (val = rule_value.to_i)
+
+      input.to_f / (10**val)
+    end
+  end
+end

data/lib/parse_me/validations.rb

@@ -0,0 +1,11 @@
+module ParseMe
+  module Validations
+    def length input, rule_value
+      input.to_s.length <= rule_value.to_i
+    end
+
+    def required input, rule_value
+      (not rule_value) || ((!input.nil?) && (input.to_s.strip.length > 0))
+    end
+  end
+end

data/lib/parse_me/var_width_parser.rb

@@ -0,0 +1,6 @@
+require 'parse_me/parsed_object'
+
+module ParseMe
+  class VarWidthParser
+  end
+end

data/lib/parse_me/version.rb

@@ -0,0 +1,3 @@
+module ParseMe
+  VERSION = "0.0.2"
+end

data/lib/parse_me.rb

@@ -0,0 +1,8 @@
+require "parse_me/version"
+require "parse_me/fixed_width_parser"
+require "parse_me/var_width_parser"
+require "parse_me/parsed_object"
+require "parse_me/transformations"
+
+module ParseMe
+end

data/parse_me.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parse_me/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "parse_me"
+  gem.version       = ParseMe::VERSION
+  gem.authors       = ["Serge Morales"]
+  gem.email         = ["i.serge23@gmail.com"]
+  gem.description   = "Plain text file parser"
+  gem.summary       = "Parse your fixed or variable width plain text files using your own custom layouts, easily validate and retrieve your data."
+  gem.homepage      = "https://github.com/sergelerator/parse_me"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end