parxer 0.1.1

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.12.5
+deploy:
+  provider: rubygems
+  api_key:
+    secure: wKW5LVpI/tvuXAJjWc3P6g9K1qlIphBm5xNaSZVVm8C3o7MMypsPLX7+U3Bhz23mgkyBI5JSUx46a7fNm2xeKdXKZ5g5i72zpxJ0g7NbD3kTg5iZdYIJw75qQKoMMdYEAwZa6ojVtFQV8r9kcC/nKrULruy7t2wC9eIJ4WeLo7IsU5McdAcT8c177p8YdS/Yh+V0wNu62rto8FByz9yvgyzXYAmKQ1Dni9xMttvC2bTAtnBO9/ghUQl0qNbqpJD7QZAockomB8uPqhcIjAdg5KNVsa7HZCvPXKn453oWVXFsXoZqFTMftU/cknbf+Gip0+KVMUHcW1Dqq5PAvEiTp46KtJEFWLKwMPl0QSgN3/5DM3zbLQIXFGcJkbrMno1BUlHdUVB6TZ9B7Owx37khOw1TEdvf1ROuV6qCn266hs7xxKdLMpD3keD6ONYzyxFBOXGsuSAin5BvRc9LwR44PRdFgHH7GvpgxX1ajujmNH2cfdabmsLsYEqee4ZIA2K7ZybLv1SvMEvfUau1O3Ahg/1xgHHPB0iYfu0CdqAUquzXcpyX1hce1ANqljCVBG8YhOfunNxTJ43vnE6L02PxOqQMah3rE47oeFyiGHokKNJg9NJwpTlXgucdOUogtoSXoYBGUA81TdqaJBcD2QOVAZlguuNLiXcPVwFyGTjsL54=
+  gem: parxer
+  on:
+    tags: true
+    repo: platanus/parxer

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.1
+
+##### Fixed
+
+* Travis config
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2017 Platanus
+
+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,140 @@
+# Parxer
+
+ruby gem to parse data from different source types
+
+## Installation
+
+```bash
+$ gem install parxer
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "parxer"
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+Imagine you have an `xls` file like this:
+
+<img src="./docs/images/superheroes-xls.png" />
+
+To parse this file you need to:
+
+### 1 - Define your Parser using the DSL:
+
+```ruby
+class SuperheroesParser < Parxer::XlsParser
+  validate_file(:rows_count, max: 50) # Define file validators
+
+  column(:name, name: "Name") do # Map column names to attributes
+    validate(:presence) # Add column validator
+    format_with do
+      value.upcase # Define custom formatters
+    end
+  end
+
+  column(:real_name, name: "Real Name")
+
+  column(:super_power, name: "Super Power") do
+    validate(:presence)
+  end
+
+  column(:publisher, name: "Publisher") do
+    validate(:inclusion, in: ["Marvel", "DC"])
+  end
+
+  column(:age, name: "Alive") do
+    validate(:presence)
+    validate(:number)
+    format_with(:number, integer: true) # Use Parxer's formatter
+  end
+
+  column(:is_alive, name: "Alive", format: :boolean) do
+    validate(:presence)
+  end
+
+  # Define validators to run after attribute validators
+  validate_row(:odd_chars, if_valid: [:name, :real_name]) do
+    (row.name + row.real_name).delete(" ").size.odd?
+  end
+
+  # Define callbacks
+  after_parse_row do
+    row.add_attribute(:full_name) # Add attributes dynamically
+    row.full_name = "#{row.name} (#{row.real_name})" unless row.errors?
+  end
+end
+```
+
+### 2 - Initialize your parser:
+
+```ruby
+parser = SuperheroesParser.new
+```
+
+### 3 - Use your parser:
+
+```ruby
+result = parser.run("/some_path/superhero.xls"); #=> #<Enumerator: ...>
+```
+
+Now, if you iterate through each row of the enumerator you will get something like this:
+
+<img src="./docs/images/parxer-response.png" />
+
+As you can see...
+
+1. Attributes like `name` or `is_alive` have been formatted.
+2. Errors in the rows are accessible through the `errors` attribute.
+3. `idx` attribute is the row number.
+4. the custom `full_name` attribute was added as a part of the response.
+
+Some useful methods you can use are:
+
+**In parser context:**
+
+- `parser.valid_file?`
+- `parser.file_error`
+- `parser.run`
+
+**In row (`row = result.next`) context:**
+
+- `row.errors?`
+- `row.errors`
+- `row.attribute_error?(:some_attribute_name)`
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/my_gem/spec/` directory.
+
+## 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
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/parxer/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Parxer is maintained by [platanus](http://platan.us).
+
+## License
+
+Parxer is © 2017 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+task default: :spec
+RSpec::Core::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "parxer"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/parxer.rb

@@ -0,0 +1,10 @@
+require "parxer/version"
+require "require_all"
+require "active_support/all"
+require "roo"
+require "roo-xls"
+
+require_rel "parxer"
+
+module Parxer
+end

data/lib/parxer/collections/attributes.rb

@@ -0,0 +1,16 @@
+module Parxer
+  class Attributes < Array
+    def add_attribute(id, name: nil)
+      if find_attribute(id)
+        raise Parxer::AttributesError.new("trying to add attribute with existent id")
+      end
+
+      self << Parxer::Attribute.new(id, name: name)
+      last
+    end
+
+    def find_attribute(attribute_id)
+      find { |attribute| attribute.id == attribute_id.to_sym }
+    end
+  end
+end

data/lib/parxer/collections/callbacks.rb

@@ -0,0 +1,22 @@
+module Parxer
+  class Callbacks < Array
+    CALLBACK_TYPES = %i{after_parse_row}
+
+    def add_callback(type, action, config = {})
+      if !CALLBACK_TYPES.include?(type.to_sym)
+        raise Parxer::CallbacksError.new("invalid '#{type}' callback type")
+      end
+
+      if !action.is_a?(Proc) && !action.is_a?(Symbol)
+        raise Parxer::CallbacksError.new("action param must by a Proc or symbol method name")
+      end
+
+      self << Parxer::Callback.new(type: type, action: action, config: config || {})
+      last
+    end
+
+    def by_type(type)
+      select { |callback| callback.type == type.to_sym }
+    end
+  end
+end

data/lib/parxer/collections/row_errors.rb

@@ -0,0 +1,19 @@
+module Parxer
+  class RowErrors < Hash
+    def add_error(attribute_name, error)
+      self[attribute_name.to_sym] = error
+    end
+
+    def attribute_error?(attribute_name)
+      !!attribute_error(attribute_name)
+    end
+
+    def attribute_error(attribute_name)
+      self[attribute_name.to_sym]
+    end
+
+    def errors?
+      any?
+    end
+  end
+end

data/lib/parxer/collections/validators.rb

@@ -0,0 +1,34 @@
+module Parxer
+  class Validators < Array
+    def add_validator(validator_name, config = {}, &block)
+      validator = validator_instance(validator_name, config, &block)
+
+      if find_validator(validator.id)
+        raise Parxer::ValidatorError.new("trying to add validator with existent id")
+      end
+
+      self << validator
+      last
+    end
+
+    private
+
+    def find_validator(validator_id)
+      find { |validator| validator.id.to_sym == validator_id.to_sym }
+    end
+
+    def validator_instance(validator_name, config = {}, &block)
+      config[:id] = validator_name
+      validator_class = infer_validator_class(validator_name)
+      config[:condition_proc] = block if validator_class == Parxer::Validator::Custom
+      validator_class.new(config)
+    end
+
+    def infer_validator_class(validator_name)
+      return Parxer::Validator::Custom if validator_name.blank?
+      "Parxer::Validator::#{validator_name.to_s.camelize}".constantize
+    rescue NameError
+      Parxer::Validator::Custom
+    end
+  end
+end

data/lib/parxer/dsl/dsl.rb

@@ -0,0 +1,92 @@
+module Parxer
+  module Dsl
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def in_context
+        current_method = caller_locations(1, 1)[0].label.to_sym
+        validate_context!(current_method)
+        current_context << current_method
+        yield
+      ensure
+        current_context.pop
+      end
+
+      def validate_context!(current_method)
+        dependencies = ctx_dependencies_map[current_method]
+
+        if current_context != dependencies
+          msg = if dependencies.any?
+                  "'#{current_method}' needs to run inside '#{dependencies.last}' block"
+                else
+                  "'#{current_method}' can't run inside '#{current_context.last}' block"
+                end
+
+          raise Parxer::DslError.new(msg)
+        end
+      end
+
+      def method_aliases
+        @method_aliases ||= {}
+      end
+
+      def ctx_dependencies_map
+        {
+          add_parser_option: [],
+          validate_file: [],
+          validate_row: [],
+          column: [],
+          after_parse_row: [],
+          validate: [:column],
+          format_with: [:column]
+        }
+      end
+
+      def current_context
+        @current_context ||= []
+      end
+
+      def column(id, config, &block)
+        in_context do
+          formatter_name = config.delete(:format)
+          @current_attr = attributes.add_attribute(id, name: config.delete(:name))
+          format_with(formatter_name) if formatter_name
+          block&.call
+        end
+      ensure
+        @current_attr = nil
+      end
+
+      def validate(validator_name, config = {}, &block)
+        in_context { @current_attr.add_validator(validator_name, config, &block) }
+      end
+
+      def validate_file(validator_name, config = {}, &block)
+        in_context { add_validator(validator_name, config, &block) }
+      end
+
+      def validate_row(validator_name, config = {}, &block)
+        in_context { add_row_validator(validator_name, config, &block) }
+      end
+
+      def format_with(*params, &block)
+        in_context do
+          formatter_name = !params.first.is_a?(Hash) ? params.first : :custom
+          config = (params.first.is_a?(Hash) ? params.first : params.second) || {}
+          @current_attr.add_formatter(formatter_name, config, &block)
+        end
+      end
+
+      def after_parse_row(callback_method = nil, &block)
+        in_context do
+          action = callback_method || block
+          parser_callbacks.add_callback(:after_parse_row, action)
+        end
+      end
+
+      def add_parser_option(key, value)
+        in_context { add_config_option(key, value) }
+      end
+    end
+  end
+end

data/lib/parxer/formatters/base_formatter.rb

@@ -0,0 +1,39 @@
+module Parxer
+  module Formatter
+    class Base
+      include Parxer::Context
+
+      attr_reader :config
+
+      def initialize(config = {})
+        @context = config.delete(:context)
+        @config = config
+      end
+
+      def apply
+        v = context.value.to_s
+
+        if v.blank?
+          return default_value if default_value?
+          return nil
+        end
+
+        format_value(v)
+      end
+
+      def format_value(_v)
+        raise Parxer::FormatterError.new("'format_value' method not implemented")
+      end
+
+      private
+
+      def default_value?
+        !!default_value
+      end
+
+      def default_value
+        config[:default]
+      end
+    end
+  end
+end