cascade-rb 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c6aadcd330b397cf46bd735ec764579c5a221d
-  data.tar.gz: a3e28fcdd18696b60c7ac067f3cbbfc87fa5acca
+  metadata.gz: 1fed47a0100266f90223d01c1bb3d44b0051793c
+  data.tar.gz: 8eef3a7b5d3ecd9f4da62a863d0b7c980ab1b828
 SHA512:
-  metadata.gz: 3a4a9bd0fb79bbe8e23f7ef0255c5ea0b650018325189ac2204aa2281de0cf75933ab475a18cc7c0c310dc0748c7dd7a84c84f37453a3dec5c9c38a6badd005b
-  data.tar.gz: 556e36c7e5c1d20f2f17fe69c36e9596297820d2c92b6bf8e5c9664d949b9065dea650fbdde1baaf2e1d1e1a816713b0b036c2027d4746db2a1003b16cf875f8
+  metadata.gz: 2a61fe4e44402f142faa7b00dbd8c1dcde6296c75232668eb96fe09ed1de6d8f71bee6c87140febf0a969defbfff24dbcdaf833362c19e79a849599f3f98c395
+  data.tar.gz: 8505f5e2f46df476fc9f75bb31aaffd8307a018ffdd6b9658ee89b591cde724a64e67beb2d44d49a159174a62d655d17a9a2df89e1bcbb62c158d6cf4988428c

data/.hound.yml

@@ -1,2 +1,2 @@
 ruby:
-  config_file: .ruby-style.yml
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  UseCache: false
+  Exclude:
+    - 'vendor/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+script:
+  - bundle exec rake

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in elasticquery.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # [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) [![Codacy Badge](https://api.codacy.com/project/badge/grade/3d27b4bc418341dcb4f704cafebffd4d)](https://www.codacy.com/app/iezakrevsky/cascade)
+[![Build Status](https://travis-ci.com/ignat-z/cascade.svg?branch=master)](https://travis-ci.com/ignat-z/cascade) [![Gem Version](https://badge.fury.io/rb/cascade-rb.svg)](http://badge.fury.io/rb/cascade-rb)
 
 The main goal of this gem is to provide some kind of template for parsing files.
 Usually, file parsing process consists of the following steps:
@@ -15,12 +15,6 @@ Usually, file parsing process consists of the following 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:
 ```
@@ -38,20 +32,6 @@ Require gem files
 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 enumerable object for parsing and run it!
 ```ruby
 Cascade::DataParser.new(data_provider: Csv.open("data_test.csv")).call
@@ -111,11 +91,8 @@ Provide all this stuff into data parser
 ```ruby
 Cascade::DataParser.new(
   data_provider: ParserJSON.new.open("data_test.csv"),
-  row_processor: Cascade::RowProcessor.new(date: DateParser.new),
+  row_processor: Cascade::RowProcessor.new(ext_parsers: { date: DateParser.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/Rakefile

@@ -1,9 +1,12 @@
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'bundler/gem_tasks'
 
 Rake::TestTask.new do |task|
-  task.libs << "lib"
-  task.libs << "spec"
-  task.pattern = "spec/**/*_spec.rb"
+  task.libs << 'lib'
+  task.libs << 'spec'
+  task.pattern = 'spec/**/*_spec.rb'
 end
 
 task default: [:test]

data/cascade.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "cascade/version"
+require 'cascade/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cascade-rb"
+  spec.name          = 'cascade-rb'
   spec.version       = Cascade::VERSION
-  spec.authors       = ["Ignat Zakrevsky"]
-  spec.email         = %w(iezakrevsky@gmail.com)
-  spec.summary       = "Ruby data parser gem."
-  spec.description   = "Highly customizable data parser with a lot of DI"
-  spec.homepage      = "https://github.com/ignat-zakrevsky/cascade"
-  spec.license       = "MIT"
+  spec.authors       = ['Ignat Zakrevsky']
+  spec.email         = %w[iezakrevsky@gmail.com]
+  spec.summary       = 'Ruby data parser gem.'
+  spec.description   = 'Highly customizable data parser with a lot of DI'
+  spec.homepage      = 'https://github.com/ignat-zakrevsky/cascade'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rr"
-  spec.add_development_dependency "shoulda-matchers", "2.8.0"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rr'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'shoulda-matchers', '2.8.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'yard'
 end

data/lib/cascade.rb

@@ -1,11 +1,10 @@
-require "cascade/version"
-require "cascade/columns_matching"
-require "cascade/row_processor"
-require "cascade/helpers/configuration"
+# frozen_string_literal: true
+
+require 'cascade/version'
+require 'cascade/columns_matching'
+require 'cascade/row_processor'
 
 # Base gem module
 module Cascade
-  extend Configuration
-
-  autoload :DataParser, "cascade/data_parser"
+  autoload :DataParser, 'cascade/data_parser'
 end

data/lib/cascade/columns_matching.rb

@@ -1,42 +1,43 @@
-require "yaml"
+# frozen_string_literal: true
+
+require 'yaml'
 require 'forwardable'
-require "cascade/exceptions"
-require "cascade/helpers/configuration"
+require 'cascade/exceptions'
 
 module Cascade
   class ColumnsMatching
     extend Forwardable
-    extend Configuration
 
-    define_setting :mapping_file
+    ROOT_KEY = 'mapping'
 
     def_delegator :supported_keys, :index
 
     def initialize(options = {})
-      @filepath = options[:filepath]
-      @content = options.fetch(:content) { parse_content_file }
+      @content = options.fetch(:content) do
+        parse_content_file(options.fetch(:filepath))
+      end
     end
 
     # Defines set of possible keys that can be used for iterating through
-    # parsed line
+    # the parsed line
     #
-    # @return [Array] of supported keys
+    # @return [Array] of the supported keys
     def supported_keys
       @supported_keys ||= @content.keys
     end
 
     # Presenter for passed key
     #
-    # @return [Symbol] with curresponding value
+    # @return [Symbol] with the corresponding value
     def column_type(key)
       @content[key].to_sym
     end
 
     private
 
-    def parse_content_file
-      content = YAML.load_file(@filepath || self.class.mapping_file)
-      (content && content["mapping"]) || raise(Cascade::WrongMappingFormat.new)
+    def parse_content_file(filepath)
+      content = YAML.load_file(filepath)
+      (content && content[ROOT_KEY]) || raise(Cascade::WrongMappingFormat)
     end
   end
 end

data/lib/cascade/complex_fields.rb

@@ -1,3 +1,5 @@
-require "cascade/complex_fields/currency"
-require "cascade/complex_fields/boolean"
-require "cascade/complex_fields/array_processor"
+# frozen_string_literal: true
+
+require 'cascade/complex_fields/currency'
+require 'cascade/complex_fields/boolean'
+require 'cascade/complex_fields/array_processor'

data/lib/cascade/complex_fields/array_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cascade
   module ComplexFields
     class ArrayProcessor

data/lib/cascade/complex_fields/boolean.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Cascade
   module ComplexFields
     class Boolean
-      TRUE_VALUES = ["True", "true", "x", "+", true]
+      TRUE_VALUES = ['True', 'true', 'x', '+', true].freeze
 
       def call(value)
         TRUE_VALUES.include?(value)

data/lib/cascade/complex_fields/currency.rb

@@ -1,5 +1,7 @@
-require "bigdecimal"
-require "bigdecimal/util"
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'bigdecimal/util'
 
 module Cascade
   module ComplexFields
@@ -12,11 +14,13 @@ module Cascade
       private
 
       def normalized_value(value)
-        String(value).tr(",", ".").tr(" ", "")
+        String(value).tr(',', '.').tr(' ', '')
       end
 
       def valid?(value)
-        true if Float(value) rescue false
+        true if Float(value)
+      rescue StandardError
+        false
       end
     end
   end

data/lib/cascade/concerns/statistics_collectible.rb

@@ -1,4 +1,6 @@
-require "cascade/statistics"
+# frozen_string_literal: true
+
+require 'cascade/statistics'
 
 module Cascade
   module StatisticsCollectible

data/lib/cascade/data_parser.rb

@@ -1,5 +1,7 @@
-require "cascade/columns_matching"
-require "cascade/registry"
+# frozen_string_literal: true
+
+require 'cascade/columns_matching'
+require 'cascade/registry'
 
 module Cascade
   class DataParser

data/lib/cascade/error_handler.rb

@@ -1,12 +1,8 @@
-require "cascade/helpers/configuration"
+# frozen_string_literal: true
 
 module Cascade
   class ErrorHandler
-    extend Configuration
-
-    define_setting :raise_parse_errors, false
-
-    HANDLING_EXCEPTIONS = [IndexError]
+    HANDLING_EXCEPTIONS = [IndexError].freeze
     DEFAULT_ERROR_STORE = lambda do |row, exception|
       @errors ||= []
       @errors << [row, exception.to_s]
@@ -14,6 +10,7 @@ module Cascade
 
     def initialize(options = {})
       @error_store = options.fetch(:error_store) { DEFAULT_ERROR_STORE }
+      @raise_parse_errors = options.fetch(:raise_parse_errors, false)
       @handling_exceptions = options.fetch(:handling_exceptions) do
         HANDLING_EXCEPTIONS
       end
@@ -27,7 +24,7 @@ module Cascade
       yield
     rescue *@handling_exceptions => exception
       @error_store.call(row, exception)
-      raise exception if self.class.raise_parse_errors
+      raise exception if @raise_parse_errors
     end
   end
 end

data/lib/cascade/exceptions.rb

@@ -1,3 +1,5 @@
-require "cascade/exceptions/wrong_mapping_format"
-require "cascade/exceptions/unknown_presenter_type"
-require "cascade/exceptions/unsupported_component"
+# frozen_string_literal: true
+
+require 'cascade/exceptions/wrong_mapping_format'
+require 'cascade/exceptions/unknown_presenter_type'
+require 'cascade/exceptions/unsupported_component'

data/lib/cascade/exceptions/unknown_presenter_type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cascade
   class UnknownPresenterType < ::StandardError; end
 end

data/lib/cascade/exceptions/unsupported_component.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Cascade
   class UnsupportedComponent < ::StandardError
-    MESSAGE = "You should provide data provider that respond to `each` method"
+    MESSAGE = 'You should provide data provider that respond to `each` method'
 
     def initialize(msg = MESSAGE)
       super

data/lib/cascade/exceptions/wrong_mapping_format.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cascade
   class WrongMappingFormat < ::StandardError; end
 end

data/lib/cascade/helpers/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HashRefinements
   refine Hash do
     # Merges the caller into +other_hash+

data/lib/cascade/registry.rb

@@ -1,12 +1,15 @@
-require "cascade/error_handler"
-require "cascade/row_processor"
+# frozen_string_literal: true
+
+require 'cascade/error_handler'
+require 'cascade/row_processor'
 
 module Cascade
   module Registry
     PUTS_DATA_SAVER = ->(*args) { p args }
+    SELF_PROCESSOR = ->(row) { row }
 
     def self.row_processor
-      RowProcessor.new
+      SELF_PROCESSOR
     end
 
     def self.error_handler

data/lib/cascade/row_processor.rb

@@ -1,27 +1,27 @@
-require "cascade/complex_fields"
-require "cascade/exceptions"
-require "cascade/helpers/configuration"
-require "cascade/helpers/hash"
+# frozen_string_literal: true
+
+require 'cascade/complex_fields'
+require 'cascade/exceptions'
+require 'cascade/helpers/hash'
 
 module Cascade
   class RowProcessor
-    extend Configuration
     using HashRefinements
 
-    DEFAULT_PROCESSOR = ->(value) { value && value.to_s.strip }
-
-    define_setting :use_default_presenter, false
-    define_setting :deafult_presenter, -> { DEFAULT_PROCESSOR }
+    DEFAULT_PROCESSOR = ->(value) { value&.to_s&.strip }
 
     def initialize(options = {})
-      @options          = options
-      @columns_matching = options[:columns_matching] || ColumnsMatching.new
+      @options = options
+      @ext_presenters = options[:ext_presenters].to_h
+      @columns_matching = options.fetch(:columns_matching)
+      @use_default_presenter = options.fetch(:use_default_presenter, false)
+      @deafult_presenter = options.fetch(:deafult_presenter, DEFAULT_PROCESSOR)
     end
 
     # Iterates through object using columns values supported keys as keys for
-    # iterating, then parse it by curresponding parser.
+    # iterating, then parse it by the corresponding parser.
     #
-    # @param row [Hash] the object retrieved from CSV
+    # @param row [Hash] the object retrieved from data parser
     # @return [Hash] the object with parsed columns
     def call(row)
       @columns_matching.supported_keys.inject({}) do |result, key|
@@ -37,27 +37,28 @@ module Cascade
 
     def receive_presenter(column_name)
       presenter = presenters[@columns_matching.column_type(column_name)]
-      if presenter.nil? && !self.class.use_default_presenter
-        raise Cascade::UnknownPresenterType.new
+      if presenter.nil? && !@use_default_presenter
+        raise Cascade::UnknownPresenterType
       end
-      presenter || self.class.deafult_presenter
+
+      presenter || @deafult_presenter
     end
 
     def presenters
-      @presenters ||= options.reverse_merge(defined_presenters)
+      @presenters ||= @ext_presenters.reverse_merge(predefined_presenters)
     end
 
     def self_copy
       self.class.new(options)
     end
 
-    def defined_presenters
+    def predefined_presenters
       {
-        string:             DEFAULT_PROCESSOR,
-        currency:           ComplexFields::Currency.new,
-        boolean:            ComplexFields::Boolean.new,
+        string: DEFAULT_PROCESSOR,
+        currency: ComplexFields::Currency.new,
+        boolean: ComplexFields::Boolean.new,
         iterable_recursive: ComplexFields::ArrayProcessor.new(self_copy),
-        recursive:          self_copy
+        recursive: self_copy
       }
     end
   end