cascade-rb 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e7c151d9e2391755cff0beda2f782a240b9d2ad
-  data.tar.gz: cf31282323bff8bc1c8f14125e758dbbd62a55d0
+  metadata.gz: e76a5428ad502dfd46ba38144264758b9db61701
+  data.tar.gz: c806af678c7b76c650100d0468b10894d6fd1e6d
 SHA512:
-  metadata.gz: aa602951882137f43d3ba53173a592a0ff5c62354726ba3b4bca9ee8645aa64e5eb90e712d81b5ded63064fde8399c1b3a87854a9a91d532d1c5de75d0d62f69
-  data.tar.gz: 976a18f137dc262bd9862ef366ca24f93211c40aaeb5b7418045557292ca06c337d7eb4ce2fda0d9c8c029c9df2f4c9a46d6f2e71da2dfd36c22717c2dd017a2
+  metadata.gz: 81b4fee7d44a42ae18deea8c2cb61c7629bd56703350833f9cd0e3e52b01b1809c38e8a4c709d9cdfe7c596c9680e4079fb8c5c18b0cc289d4d118b67e6e0425
+  data.tar.gz: 12fb5bf658fd193b8dd92a45f90b9de140f834f534e3902fe0948f90b7507fdd6bb73a789ce70a9feeb12bed6e4901232eb886855046b22d47b6b77dc9c2af32

data/README.md

@@ -1,8 +1,8 @@
 # [Cascade]
 
-[![Codeship Status for ignat-zakrevsky/cascade](https://codeship.com/projects/d7590880-9943-0132-4aa6-1e41bc68e178/status?branch=master)](https://codeship.com/projects/63625) [![Code Climate](https://codeclimate.com/github/ignat-zakrevsky/cascade/badges/gpa.svg)](https://codeclimate.com/github/ignat-zakrevsky/cascade) [![Test Coverage](https://codeclimate.com/github/ignat-zakrevsky/cascade/badges/coverage.svg)](https://codeclimate.com/github/ignat-zakrevsky/cascade)
+[![Codeship Status for ignat-zakrevsky/cascade](https://codeship.com/projects/d7590880-9943-0132-4aa6-1e41bc68e178/status?branch=master)](https://codeship.com/projects/63625) [![Code Climate](https://codeclimate.com/github/ignat-zakrevsky/cascade/badges/gpa.svg)](https://codeclimate.com/github/ignat-zakrevsky/cascade) [![Test Coverage](https://codeclimate.com/github/ignat-zakrevsky/cascade/badges/coverage.svg)](https://codeclimate.com/github/ignat-zakrevsky/cascade) [![Gem Version](https://badge.fury.io/rb/cascade-rb.svg)](http://badge.fury.io/rb/cascade-rb)
 
-The main aim of this repo is to provide some kind of template for parsers.
+The main aim of this gem is to provide some kind of template for parsing files.
 Usually, parsing file process contains next steps:
 
  1. Retreiving info from file
@@ -15,11 +15,108 @@ Usually, parsing file process contains next steps:
 
 Cascade pretends to simplify main part of this step to save your time.
 
+## Examples
+
+[Minimal working example](https://github.com/ignat-zakrevsky/cascade-example)
+
+[More complicated example](https://github.com/ignat-zakrevsky/cascade-example/tree/json-example)
+
+## Installation
+Install the cascade-rb package from Rubygems:
+```
+gem install cascade-rb
+```
+
+or add it to your Gemfile for Bundler:
+```ruby
+gem 'cascade-rb'
+```
+
 ## Usage
-- Configure database config
-	`cp config/database.yml.sample config/database.yml`
-- Change `./config/columns_match.yml` to correspond your scheme
-- Create necessary ActiveRecord models
-- Add necessary parsers
-- Run it
+Require gem files
+```ruby
+require 'cascade'
+```
+
+Configure it!
+```ruby
+Cascade.configuration do
+  # [Object#call] will be used for undefined fields types
+  Cascade::RowProcessor.deafult_presenter
+  # [Boolean] will throw exception in case of unavailable presenter
+  Cascade::RowProcessor.use_default_presenter
+  # [String] filepath with columns mapping, see below
+  Cascade::ColumnsMatching.mapping_file
+  # [Boolean] will raise fields parsing exceptions
+  Cascade::ErrorHandler.raise_parse_errors
+end
+```
+
+Provide file for parsing and run it!
+```ruby
+Cascade::DataParser.new("data_test.txt").call
+```
+
+## Columns mapping
+Parsing file description should have next structure [(example)](https://github.com/ignat-zakrevsky/cascade-example/blob/master/columns_mapping.yml)
+```yaml
+mapping:
+  name: type
+```
+
+## Columns parsing
+There are several alredy defined fields parsers (types):
+
+- currency
+- boolean
+- country_iso
+- string
+
+Feel free to add new fields parsers and provide it through PR.
 
+## Components replaceability
+There is a lot of DI in this gem, so, you can replace each component of the parser. Let's assume you want to parse JSON files instead of CSV, save this to ActiveRecord model, and you need Date fields parsing, ok!
+Writing new data provider:
+```ruby
+class ParserJSON
+  def open(file)
+    JSON.parse(File.read(file))["rows"]
+  end
+end
+```
+Writing new data saver:
+```ruby
+class PersonDataSaver
+  def call(person_data)
+    Person.create!(person_data)
+  end
+end
+```
+considering that there is no much logic even better
+```ruby
+ PERSON_SAVER = -> (person_data) { Person.create!(person_data) }
+```
+Writing date parser:
+```ruby
+class DateParser
+  def call(value)
+    Date.parse(value)
+  end
+end
+```
+or you can always use lambdas for such logic
+```ruby
+DATE_PARSER = -> (value) { Date.parse(value) }
+```
+Provide all this stuff into data parser
+```ruby
+Cascade::DataParser.new("data_test.json",
+  row_processor: Cascade::RowProcessor.new(date: DateParser.new),
+  data_provider: ParserJSON.new,
+  data_saver: PERSON_SAVER
+ ).call
+```
+And that's all!
+[Example](https://github.com/ignat-zakrevsky/cascade-example/blob/json-example/main.rb)
+## Conventions
+I'm fan of callable object as consequence I prefer #call methods for classes with one responsibility. [Nice video](http://www.rubytapas.com/episodes/35-Callable) that describes benefits of such approach

data/cascade.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ignat Zakrevsky"]
   spec.email         = %w(iezakrevsky@gmail.com)
   spec.summary       = "Ruby data parser gem."
-  spec.description   = "Highly customizable ruby parser with a lot of DI"
+  spec.description   = "Highly customizable data parser with a lot of DI"
   spec.homepage      = "https://github.com/ignat-zakrevsky/cascade"
   spec.license       = "MIT"
 

data/lib/cascade.rb

@@ -1,6 +1,7 @@
 require "cascade/version"
 require "cascade/columns_matching"
 require "cascade/row_processor"
+require "cascade/error_handler"
 require "cascade/helpers/configuration"
 
 # Base gem module

data/lib/cascade/error_handler.rb

@@ -1,5 +1,11 @@
+require "cascade/helpers/configuration"
+
 module Cascade
   class ErrorHandler
+    extend Configuration
+
+    define_setting :raise_parse_errors, false
+
     HANDLING_EXCEPTIONS = [IsoCountryCodes::UnknownCodeError, IndexError]
     DEFAULT_ERROR_STORE = ->(row, reason) do
       @errors ||= []
@@ -8,6 +14,9 @@ module Cascade
 
     def initialize(options = {})
       @error_store = options.fetch(:error_store) { DEFAULT_ERROR_STORE }
+      @handling_exceptions = options.fetch(:handling_exceptions) do
+        HANDLING_EXCEPTIONS
+      end
     end
 
     # Runs passed block with catching throwing errors and storing in ErrorStore
@@ -16,8 +25,9 @@ module Cascade
     # problems with processing
     def with_errors_handling(row)
       yield
-    rescue *HANDLING_EXCEPTIONS => exception
+    rescue *@handling_exceptions => exception
       @error_store.call(row, exception.to_s)
+      raise exception if self.class.raise_parse_errors
     end
   end
 end

data/lib/cascade/helpers/hash.rb

@@ -1,5 +1,9 @@
 class Hash
-  def reverse_merge(other_hash)
-    other_hash.merge(self)
+  unless Hash.instance_methods.include? :reverse_merge
+    # Merges the caller into +other_hash+
+    #
+    def reverse_merge(other_hash)
+      other_hash.merge(self)
+    end
   end
 end

data/lib/cascade/version.rb

@@ -1,4 +1,4 @@
 module Cascade
   # current gem version
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/spec/lib/error_handler_spec.rb

@@ -21,6 +21,14 @@ describe Cascade::ErrorHandler do
       subject.with_errors_handling(row) { raise exception }
       assert_includes @errors, [row, exception.to_s]
     end
+
+    it "raises #{exception} if raise_parse_errors setting is true" do
+      described_class.stub(:raise_parse_errors, true) do
+        assert_raises(exception) do
+          subject.with_errors_handling(row) { raise exception }
+        end
+      end
+    end
   end
 
   describe "DEFAULT_ERROR_STORE" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cascade-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Ignat Zakrevsky
@@ -178,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Highly customizable ruby parser with a lot of DI
+description: Highly customizable data parser with a lot of DI
 email:
 - iezakrevsky@gmail.com
 executables: []
@@ -189,7 +189,6 @@ files:
 - ".hound.yml"
 - ".ruby-style.yml"
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - cascade.gemspec
@@ -276,3 +275,4 @@ test_files:
 - spec/lib/statistics_stores/array_store_spec.rb
 - spec/lib/statistics_stores/counter_store_spec.rb
 - spec/spec_helper.rb
+has_rdoc: