arstotzka 1.0.4 → 1.1.0

data/lib/arstotzka/fetcher.rb

@@ -6,19 +6,19 @@ module Arstotzka
   # Class responsible for orquestrating the fetch value from the hash
   # and post-processing it
   class Fetcher
-    include Sinclair::OptionsParser
+    include Base
 
     # Creates an instance of Artotzka::Fetcher
     #
     # @param hash [Hash] Hash to be crawled for value
     # @param instance [Object] object whose methods will be called after for processing
-    # @param path [String/Symbol] complete path for fetching the value from hash
-    # @param options [Hash] options that will be passed to {Crawler}, {Wrapper} and {Reader}
-    def initialize(hash, instance, path:, **options)
-      @path = path.to_s.split('.')
+    # @param options_hash [Hash] options that will be passed to {Crawler}, {Wrapper} and {Reader}
+    def initialize(hash, instance, options_hash = {})
+      self.options = options_hash
+
+      @keys = options.path.to_s.split('.')
       @hash = hash
       @instance = instance
-      @options = options
     end
 
     # Crawls the hash for the value
@@ -64,7 +64,7 @@ module Arstotzka
     #   instance = Account.new
     #   fetcher = Arstotzka::Fetcher.new(hash, instance,
     #     path: 'transactions',
-    #     clazz: Transaction,
+    #     klass: Transaction,
     #     after: :filter_income
     #   )
     #
@@ -82,9 +82,8 @@ module Arstotzka
     private
 
     # @private
-    attr_reader :path, :hash, :instance
-
-    delegate :after, :flatten, to: :options_object
+    attr_reader :keys, :hash, :instance, :options
+    delegate :after, :flatten, to: :options
     delegate :wrap, to: :wrapper
 
     # @private
@@ -110,7 +109,7 @@ module Arstotzka
     #
     # @see #crawler
     def crawler_options
-      options.slice(:case_type, :compact, :default).merge(path: path)
+      options.merge(keys: keys)
     end
 
     # @private
@@ -119,18 +118,7 @@ module Arstotzka
     #
     # @return [Arstotzka::Wrapper] the wrapper
     def wrapper
-      @wrapper ||= Arstotzka::Wrapper.new(wrapper_options)
-    end
-
-    # @private
-    #
-    # Hash for wrapper initialization
-    #
-    # @return [Hash]
-    #
-    # @see #wrapper
-    def wrapper_options
-      options.slice(:clazz, :type)
+      @wrapper ||= Arstotzka::Wrapper.new(options)
     end
   end
 end

data/lib/arstotzka/options.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  # @api private
+  #
+  # Class responsible to hold the options
+  class Options < ::OpenStruct
+    DEFAULT_OPTIONS = {
+      json:      :json,
+      path:      nil,
+      full_path: nil,
+      cached:    false,
+      after:     false,
+      case:      :lower_camel,
+      klass:     nil,
+      compact:   false,
+      default:   nil,
+      flatten:   false,
+      type:      :none
+    }.freeze
+
+    # Creates a new instance of Options
+    #
+    # @param options [Hash] options hash
+    #   Options hash will be merged with {DEFAULT_OPTIONS}
+    # @option options [Class] klass class to receive the methods
+    # @option options [String/Symbol] path path of hash attributes to find the root
+    #   where the attribute live (then fetching it using the attribute name)
+    # @option options [String/Symbol] full_path: path of hash attributes to find exacttly where the
+    #   value live (ignoring the attribute name)
+    # @option options [String/Symbol] json: name of the method containing the hash to be crawled
+    # @option options [Boolean] cached: flag if the result should be memorized instead of repeating
+    #   the crawling
+    # @option options [String/Symbol] case:  {Reader} flag definining on which case will
+    #   the keys be defined
+    #   - lower_camel: keys in the hash are lowerCamelCase
+    #   - upper_camel: keys in the hash are UpperCamelCase
+    #   - snake: keys in the hash are snake_case
+    # @option options [Boolean] compact:  {Crawler} flag to apply Array#compact thus
+    #   removing nil results
+    # @option options [Class] klass:  {Fetcher} option thatwhen passed, wraps the result in an
+    #   instance of the given class
+    # @option options [String/Symbol] after:  {Fetcher} option with the name of the method to be
+    #   called once the value is fetched for mapping the value
+    # @option options [Boolean] flatten:  {Fetcher} flag to aplly Array#flatten thus
+    #   avoing nested arrays
+    # @option options [String/Symbol] type:  {Fetcher} option declaring the type of the returned
+    #   value (to use casting)
+    #   - integer
+    #   - string
+    #   - float
+    #
+    # @see Arstotzka::Options::DEFAULT_OPTIONS
+    # @return [Arstotzka::Options]
+    def initialize(options)
+      klass = options.delete(:class)
+      warn ":class has been deprecated, prefer 'expose klass: #{klass}'" if klass
+      options[:klass] ||= klass
+
+      super(DEFAULT_OPTIONS.merge(options))
+    end
+
+    # @private
+    #
+    # Creates a new instance mergin the given hash with @options
+    #
+    # @return Arstotzka::Options
+    def merge(options)
+      self.class.new(to_h.merge(options))
+    end
+  end
+end

data/lib/arstotzka/reader.rb

@@ -3,26 +3,33 @@
 module Arstotzka
   # @api private
   #
-  # Reads a value from a hash using the path as list of keys
+  # Reads a value from a hash using the keys as list of keys
   class Reader
+    include Base
+
     # Creates a new instance of Reader
     #
-    # @param path [Array] path of keys broken down as array
-    # @param case_type [Symbol] Case of the keys
-    #   - lower_camel: keys in the hash are lowerCamelCase
-    #   - upper_camel: keys in the hash are UpperCamelCase
-    #   - snake: keys in the hash are snake_case
-    #
-    # @return [Aristotzka::Reader]
-    def initialize(path:, case_type:)
-      @case_type = case_type
-      @path = path.map(&method(:change_case))
+    # @overload initialize(options_hash={})
+    #   @param options_hash [Hash] options of initialization
+    #   @option options_hash keys [Array] keys of keys broken down as array
+    #   @option options_hash case [Symbol] Case of the keys
+    #     - lower_camel: keys in the hash are lowerCamelCase
+    #     - upper_camel: keys in the hash are UpperCamelCase
+    #     - snake: keys in the hash are snake_case
+    # @overload initialize(options)
+    #   @param options [Arstotzka::Options] options of initialization object
+    #
+    # @return [Arstotzka::Reader]
+    def initialize(options_hash = {})
+      self.options = options_hash
+
+      @keys = options.keys.map(&method(:change_case))
     end
 
     # Reads the value of one key in the hash
     #
     # @param hash [Hash] hash to be read
-    # @param index [Integer] Index of the key (in path) to be used
+    # @param index [Integer] Index of the key (in keys) to be used
     #
     # @return [Object] The value fetched from the hash
     #
@@ -36,25 +43,25 @@ module Arstotzka
     #     ]
     #   }
     #
-    #   reader = Arstotzka::Reader.new(%w(person full_name), case_type: :snake)
+    #   reader = Arstotzka::Reader.new(keys: %w(person full_name), case: :snake)
     #   reader.read(hash, 1) # returns 'John'
     #
     # @example
-    #   reader = Arstotzka::Reader.new(%w(person age), case_type: :upper_camel)
+    #   reader = Arstotzka::Reader.new(keys: %w(person age), case: :upper_camel)
     #   reader.read(hash, 1) # returns 23
     #
     # @example
-    #   reader = Arstotzka::Reader.new(%w(person car_collection model), case_type: :snake)
+    #   reader = Arstotzka::Reader.new(keys: %w(person car_collection model), case: :snake)
     #   reader.read(hash, 1) # raises {Arstotzka::Exception::KeyNotFound}
     #
     # @example
-    #   reader = Arstotzka::Reader.new(%w(person car_collection model), case_type: :lower_camel)
+    #   reader = Arstotzka::Reader.new(keys: %w(person car_collection model), case: :lower_camel)
     #   reader.read(hash, 1) # returns [
     #                        #   { maker: 'Ford', 'model' => 'Model A' },
     #                        #   { maker: 'BMW', 'model' => 'Jetta' }
     #                        # ]
     def read(hash, index)
-      key = path[index]
+      key = keys[index]
 
       check_key!(hash, key)
 
@@ -63,20 +70,20 @@ module Arstotzka
 
     # @private
     #
-    # Checks if index is within path range
+    # Checks if index is within keys range
     #
     # @example
-    #   reader = Arstotzka::Reader.new(%w(person full_name), case_type: :snake)
+    #   reader = Arstotzka::Reader.new(%w(person full_name), case: :snake)
     #   reader.read(hash, 1) # returns false
     #   reader.read(hash, 2) # returns true
     def ended?(index)
-      index >= path.size
+      index >= keys.size
     end
 
     private
 
     # @private
-    attr_reader :path, :case_type
+    attr_reader :keys, :options
 
     # @private
     #
@@ -115,14 +122,16 @@ module Arstotzka
     #
     # Transforms the key to have the correct case
     #
-    # the possible case_types (instance attribute) are
+    # the possible cases (instance attribute) are
     # - lower_camel: for cammel case with first letter lowercase
     # - upper_camel: for cammel case with first letter uppercase
     # - snake: for snake case
     #
     # @param [String] key the key to be transformed
+    #
+    # @return [String] the string transformed
     def change_case(key)
-      case case_type
+      case options.case
       when :lower_camel
         key.camelize(:lower)
       when :upper_camel

data/lib/arstotzka/type_cast.rb

@@ -84,7 +84,7 @@ module Arstotzka
     #     age: '10',
     #   }
     #
-    #   TypeCaseter.new(age: '10').age
+    #   TypeCaster.new(age: '10').age
     def to_integer(value)
       value.to_i if value.present?
     end
@@ -108,7 +108,7 @@ module Arstotzka
     #     payload: { 'key' => 'value' },
     #   }
     #
-    #   model.TypeCaseter.new(hash)
+    #   model.TypeCaster.new(hash)
     #
     #   model.payload # returns '{"key"=>"value"}'
     def to_string(value)
@@ -134,7 +134,7 @@ module Arstotzka
     #     price: '1.75'
     #   }
     #
-    #   TypeCaseter.new(price: '1.75').price # returns 1.75
+    #   TypeCaster.new(price: '1.75').price # returns 1.75
     def to_float(value)
       value.to_f if value.present?
     end

data/lib/arstotzka/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arstotzka
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/lib/arstotzka/wrapper.rb

@@ -6,15 +6,22 @@ module Arstotzka
   # Class responsible for wrapping / parsing a value fetched
   class Wrapper
     include Arstotzka::TypeCast
+    include Base
 
     # Returns a new instance of Wrapper
     #
-    # @param clazz [Class] class to wrap the value
-    # @param type [String/Symbol] type to cast the value. The
-    #   possible type_cast is defined by {TypeCast}
-    def initialize(clazz: nil, type: nil)
-      @clazz = clazz
-      @type = type
+    # @overload initialize(options_hash={})
+    #   @param options_hash [Hash] options of initialization
+    #   @option options_hash klass [Class] class to wrap the value
+    #   @option options_hash type [String/Symbol] type to cast the value. The
+    #     possible type_cast is defined by {TypeCast}
+    #
+    # @overload initialize(options)
+    #   @param options [Arstotzka::Options] options of initialization object
+    #
+    # @return [Arstotzka::Wrapper]
+    def initialize(options = {})
+      self.options = options
     end
 
     # wrap a value
@@ -30,7 +37,7 @@ module Arstotzka
     #     end
     #   end
     #
-    #   wrapper = Arstotzka::Wrapper.new(clazz: Person)
+    #   wrapper = Arstotzka::Wrapper.new(klass: Person)
     #   wrapper.wrap('John') # retruns Person.new('John')
     #
     # @example Casting type
@@ -46,7 +53,7 @@ module Arstotzka
     #     end
     #   end
     #
-    #   wrapper = Arstotzka::Wrapper.new(type: :string, clazz: Request)
+    #   wrapper = Arstotzka::Wrapper.new(type: :string, klass: Request)
     #   request = wrapper.wrap(value)
     #
     #   request.payload  # returns '{"key"=>"value"}'
@@ -58,7 +65,8 @@ module Arstotzka
     private
 
     # @private
-    attr_reader :clazz, :type
+    attr_reader :options
+    delegate :klass, :type, to: :options
 
     # @private
     #
@@ -69,7 +77,7 @@ module Arstotzka
       value = cast(value) if type? && !value.nil?
       return if value.nil?
 
-      clazz ? clazz.new(value) : value
+      klass ? klass.new(value) : value
     end
 
     # @private

data/lib/arstotzka.rb

@@ -5,7 +5,7 @@ require 'active_support/all'
 require 'sinclair'
 
 # Concern that enables the translation of domain though the
-# usage of the class method  `expose`
+# usage of the class method  +expose+
 #
 # @example
 #   json = <<-JSON
@@ -142,7 +142,7 @@ require 'sinclair'
 #
 #   class Collector
 #     expose :finished_games, json: :hash,
-#            flatten: true, class: Collector::Game,
+#            flatten: true, klass: Collector::Game,
 #            after: :filter_finished, compact: true,
 #            full_path: 'collections.games.titles'
 #
@@ -164,6 +164,8 @@ require 'sinclair'
 module Arstotzka
   extend ActiveSupport::Concern
 
+  autoload :Base,         'arstotzka/base'
+  autoload :Options,      'arstotzka/options'
   autoload :Builder,      'arstotzka/builder'
   autoload :ClassMethods, 'arstotzka/class_methods'
   autoload :Crawler,      'arstotzka/crawler'

data/scripts/check_readme.sh

@@ -0,0 +1,6 @@
+#! /bin/bash
+
+PROJECT=arstotzka
+VERSION=$(grep VERSION lib/$PROJECT/version.rb  | sed -e "s/.*'\(.*\)'/\1/g")
+
+grep https://www.rubydoc.info/gems/$PROJECT/$VERSION README.md

data/spec/integration/yard/arstotzka/builder_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Arstotzka::Builder do
   describe 'yard' do
     let!(:instance) { klass.new(hash) }
-    let(:full_options) { described_class::DEFAULT_OPTIONS.merge(options) }
+    let(:options)   { Arstotzka::Options.new(options_hash) }
     let(:hash) do
       {
         'name' => { first: 'John', last: 'Williams' },
@@ -13,12 +13,12 @@ describe Arstotzka::Builder do
         'cars' => 2.0
       }
     end
-    let(:builder) { described_class.new(attributes, klass, full_options) }
+    let(:builder) { described_class.new(attributes, klass, options) }
 
     describe '#first_name' do
-      let(:klass)      { Class.new(MyModel) }
-      let(:attributes) { [:first_name] }
-      let(:options)    { { full_path: 'name.first' } }
+      let(:klass)        { Class.new(MyModel) }
+      let(:attributes)   { [:first_name] }
+      let(:options_hash) { { full_path: 'name.first' } }
 
       before do
         builder.build
@@ -30,9 +30,9 @@ describe Arstotzka::Builder do
     end
 
     describe '#age' do
-      let(:klass)      { Class.new(MyModel) }
-      let(:attributes) { [:age, 'cars'] }
-      let(:options) { { type: :integer } }
+      let(:klass) { Class.new(MyModel) }
+      let(:attributes)   { [:age, 'cars'] }
+      let(:options_hash) { { type: :integer } }
 
       before do
         builder.build
@@ -48,9 +48,9 @@ describe Arstotzka::Builder do
     end
 
     describe '#cars' do
-      let(:klass)      { Class.new(MyModel) }
-      let(:attributes) { [:age, 'cars'] }
-      let(:options) { { type: :integer } }
+      let(:klass) { Class.new(MyModel) }
+      let(:attributes)   { [:age, 'cars'] }
+      let(:options_hash) { { type: :integer } }
 
       before do
         builder.build

data/spec/integration/yard/arstotzka/crawler_spec.rb

@@ -5,11 +5,11 @@ require 'spec_helper'
 describe Arstotzka::Crawler do
   describe 'yard' do
     subject(:crawler) do
-      described_class.new(path: path, **options)
+      described_class.new(keys: keys, **options)
     end
 
     let(:options) { {} }
-    let(:path)    { %w[person information first_name] }
+    let(:keys)    { %w[person information first_name] }
     let(:hash) do
       {
         person: {
@@ -25,15 +25,15 @@ describe Arstotzka::Crawler do
     end
 
     describe '#value' do
-      context 'when hash contains the path' do
+      context 'when hash contains the keys' do
         it 'crawls to find the value' do
           expect(crawler.value(hash)).to eq('John')
         end
       end
 
       context 'when we have an array of arrays' do
-        let(:path)    { %w[companies games hero_name] }
-        let(:options) { { compact: true, case_type: :snake } }
+        let(:keys)    { %w[companies games hero_name] }
+        let(:options) { { compact: true, case: :snake } }
         let(:hash) do
           {
             'companies' => [{
@@ -55,7 +55,7 @@ describe Arstotzka::Crawler do
         end
 
         context 'with default value' do
-          let(:options) { { compact: true, case_type: :snake, default: 'NO HERO' } }
+          let(:options) { { compact: true, case: :snake, default: 'NO HERO' } }
 
           it 'return default value for missed keys' do
             expect(crawler.value(hash)).to eq([['NO HERO', 'Rakhar'], 'NO HERO'])
@@ -64,7 +64,7 @@ describe Arstotzka::Crawler do
 
         context 'when block is given' do
           subject(:crawler) do
-            described_class.new(path: path, **options) { |value| value&.to_sym }
+            described_class.new(keys: keys, **options) { |value| value&.to_sym }
           end
 
           it 'returns the post processed values' do

data/spec/integration/yard/arstotzka/fetcher_spec.rb

@@ -5,13 +5,13 @@ require 'spec_helper'
 describe Arstotzka::Fetcher do
   describe 'yard' do
     describe '#fetch' do
-      subject(:fetcher) { described_class.new(hash, instance, path: path, **options) }
+      subject(:fetcher) { described_class.new(hash, instance, **options) }
 
       let(:instance) { Account.new }
-      let(:path) { 'transactions' }
       let(:options) do
         {
-          clazz: Transaction,
+          path:  'transactions',
+          klass: Transaction,
           after: :filter_income
         }
       end

data/spec/integration/yard/arstotzka/reader_spec.rb

@@ -4,9 +4,9 @@ require 'spec_helper'
 
 describe Arstotzka::Reader do
   describe 'yard' do
-    subject(:reader) { described_class.new(path: path, case_type: case_type) }
+    subject(:reader) { described_class.new(keys: keys, case: case_type) }
 
-    let(:path) { %w[person full_name] }
+    let(:keys)      { %w[person full_name] }
     let(:case_type) { :snake }
 
     describe '#read' do
@@ -27,7 +27,7 @@ describe Arstotzka::Reader do
         end
 
         context 'when key is missing' do
-          let(:path) { %w[person car_collection model] }
+          let(:keys) { %w[person car_collection model] }
 
           it do
             expect do
@@ -39,7 +39,7 @@ describe Arstotzka::Reader do
 
       context 'when using lowerCamel' do
         let(:case_type) { :lower_camel }
-        let(:path) { %w[person car_collection model] }
+        let(:keys)      { %w[person car_collection model] }
 
         it 'fetches the value using lower camel case key' do
           expected = [
@@ -52,7 +52,7 @@ describe Arstotzka::Reader do
 
       context 'when using UpperCamel' do
         let(:case_type) { :upper_camel }
-        let(:path) { %w[person age] }
+        let(:keys) { %w[person age] }
 
         it 'fetches the value using uper camel case key' do
           expect(reader.read(hash, 1)).to eq(23)

data/spec/integration/yard/arstotzka/wrapper_spec.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: truie
 
 describe Arstotzka::Wrapper do
-  subject(:wrapper) { described_class.new(clazz: clazz, type: type) }
+  subject(:wrapper) { described_class.new(klass: klass, type: type) }
 
   let(:type)  { nil }
-  let(:clazz) { nil }
+  let(:klass) { nil }
 
   describe 'yard' do
     describe '#wrap' do
-      context 'when clazz is defined' do
-        let(:clazz) { Person }
+      context 'when klass is defined' do
+        let(:klass) { Person }
         let(:value) { 'john' }
 
-        it 'wraps value with the clazz' do
+        it 'wraps value with the klass' do
           expect(wrapper.wrap(value)).to eq(Person.new(value))
         end
       end
@@ -28,7 +28,7 @@ describe Arstotzka::Wrapper do
 
       context 'when type and class is defined' do
         let(:type)    { :string }
-        let(:clazz)   { Request }
+        let(:klass)   { Request }
         let(:value)   { { 'key' => 'value' } }
         let(:request) { wrapper.wrap(value) }
 

data/spec/lib/arstotzka/builder_spec.rb

@@ -4,10 +4,10 @@ require 'spec_helper'
 
 describe Arstotzka::Builder do
   subject(:builder) do
-    described_class.new(attr_names, clazz, **full_options)
+    described_class.new(attr_names, klass, **full_options)
   end
 
-  let(:clazz) do
+  let(:klass) do
     Class.new.tap do |c|
       c.send(:attr_reader, :json)
       c.send(:define_method, :initialize) do |json = {}|
@@ -21,15 +21,15 @@ describe Arstotzka::Builder do
   let(:attr_name)    { :name }
   let(:attr_names)   { [attr_name] }
   let(:json)         { {} }
-  let(:instance)     { clazz.new(json) }
-  let(:full_options) { described_class::DEFAULT_OPTIONS.merge(options) }
+  let(:instance)     { klass.new(json) }
+  let(:full_options) { Arstotzka::Options::DEFAULT_OPTIONS.merge(options) }
 
   describe '#build' do
     context 'when it is called' do
       it 'adds the reader' do
         expect do
           builder.build
-        end.to add_method(attr_name).to(clazz)
+        end.to add_method(attr_name).to(klass)
       end
     end
 
@@ -78,7 +78,7 @@ describe Arstotzka::Builder do
         end
 
         context 'when defining a fullpath' do
-          let(:options) { { full_path: 'user.name' } }
+          let(:options)   { { full_path: 'user.name' } }
           let(:attr_name) { :the_name }
 
           it 'fetches the value within the json' do
@@ -89,7 +89,7 @@ describe Arstotzka::Builder do
 
       context 'when wrapping with a class' do
         let(:json) { { person: name } }
-        let(:options) { { class: Person } }
+        let(:options)   { { klass: Person } }
         let(:attr_name) { :person }
 
         it do