cascade-rb 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcc191b61c12c0765f47269758020be4aee60980
-  data.tar.gz: b5112f6db4896cf045c1b000c895c6b570ffb59b
+  metadata.gz: e76a5428ad502dfd46ba38144264758b9db61701
+  data.tar.gz: c806af678c7b76c650100d0468b10894d6fd1e6d
 SHA512:
-  metadata.gz: dd6417644ca77d59c98ef1a90328753ac78e1e446fd598a4ac8325370adf7a96b3df37e2ef2dd1b77cc5348b9b4f86b44e7ce35f86908870e66e9df419eb9e17
-  data.tar.gz: 72ecd47503ee586f47f1ca5727ad500e36be2c12bed35a8fef63eb6d521f81733275a12e7952ea00fcf1d49c04f85dff901ad39c1c5844bce94209ec541ed65e
+  metadata.gz: 81b4fee7d44a42ae18deea8c2cb61c7629bd56703350833f9cd0e3e52b01b1809c38e8a4c709d9cdfe7c596c9680e4079fb8c5c18b0cc289d4d118b67e6e0425
+  data.tar.gz: 12fb5bf658fd193b8dd92a45f90b9de140f834f534e3902fe0948f90b7507fdd6bb73a789ce70a9feeb12bed6e4901232eb886855046b22d47b6b77dc9c2af32

data/README.md

@@ -15,9 +15,11 @@ Usually, parsing file process contains next steps:
 
 Cascade pretends to simplify main part of this step to save your time.
 
-## Example 
+## Examples
 
-[Working Example](https://github.com/ignat-zakrevsky/cascade-example)
+[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:
@@ -31,7 +33,7 @@ gem 'cascade-rb'
 ```
 
 ## Usage
-Require gem files 
+Require gem files
 ```ruby
 require 'cascade'
 ```
@@ -39,8 +41,14 @@ require 'cascade'
 Configure it!
 ```ruby
 Cascade.configuration do
-  Cascade::RowProcessor.use_default_presenter = false # will throw exception in case of unavailable presenter
-  Cascade::ColumnsMatching.mapping_file = "columns_mapping.yml" # file with columns mapping, see below 
+  # [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
 ```
 
@@ -52,12 +60,22 @@ 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: 
+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 and save this to ActiveRecord model, ok!
+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
@@ -78,10 +96,25 @@ considering that there is no much logic even better
 ```ruby
  PERSON_SAVER = -> (person_data) { Person.create!(person_data) }
 ```
-Provide it for data providing for data parser
+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", data_saver: PERSON_SAVER,
-  data_provider: ParserJSON.new).call
+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)

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.4"
+  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.4
+  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: []
@@ -275,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: