arstotzka 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6434b65a0dc88484fb45965e6c0700978300f24
-  data.tar.gz: e91d322f0ad668991927080809a0ba63430814ac
+  metadata.gz: 74d1946cebd9e40fa273fc644a478e809ce9d888
+  data.tar.gz: 66abec44e1e8090d5507c8f4c59532dce3e8be03
 SHA512:
-  metadata.gz: 5bd3079f38a8f38d95ef74521273f02dc9c40add3c81315d5bde04382fd75f02b017663cca973ed99a17681d9bf6bf509f9df9b79977edf9ab62f29fbccd1291
-  data.tar.gz: 8929be5f4f9fae35d4ad87f54b3a60d7a361877c975e04dadbeebb553a5d0888fbb0f0167e00d1c72bd9e308eacd54176041e9b4c8848d029ebfd4addb2bda19
+  metadata.gz: 931eb74bb1e15412c7927c613204dbac3d48dc1ca6f3d81d58c941540ccf23ed530a19c4f8b1214ef06ba0f878d44e5e28cc6b55f3a32c0930123336d4fe3b43
+  data.tar.gz: fac8783602cc90be4933d9dce2f2fe5b6e24fd284ec2c53925ee75cd5cb5895aa62a1de5a40acdef5e158c66cc174df8fe3390ebfacacd7460f5d39c705830f6

data/.circleci/config.yml

@@ -23,3 +23,6 @@ jobs:
       - run:
           name: Yardstick coverage check
           command: bundle exec rake verify_measurements
+      - run:
+          name: Check version documentation
+          command: scripts/check_readme.sh

data/.rubocop.yml

@@ -10,3 +10,6 @@ Metrics/BlockLength:
 
 Metrics/LineLength:
   Max: 100
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,15 +1,17 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-03-07 08:37:15 +0000 using RuboCop version 0.58.1.
+# on 2019-03-11 11:14:54 +0000 using RuboCop version 0.58.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 7
+
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/lib/arstotzka/options_spec.rb'
 
 # Offense count: 46
 RSpec/NestedGroups:

data/README.md

@@ -3,6 +3,7 @@ Arstotzka
 [![Code Climate](https://codeclimate.com/github/darthjee/arstotzka/badges/gpa.svg)](https://codeclimate.com/github/darthjee/arstotzka)
 [![Test Coverage](https://codeclimate.com/github/darthjee/arstotzka/badges/coverage.svg)](https://codeclimate.com/github/darthjee/arstotzka/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/arstotzka/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/arstotzka)
+[![Gem Version](https://badge.fury.io/rb/arstotzka.svg)](https://badge.fury.io/rb/arstotzka)
 
 ![arstotzka](https://raw.githubusercontent.com/darthjee/arstotzka/master/arstotzka.jpg)
 
@@ -21,72 +22,71 @@ Instalation
 1. Add Arstotzka to your `Gemfile` and `bundle install`:
   - Install it
 
-  ```ruby
-    gem install arstotzka
-  ```
+```ruby
+  gem install arstotzka
+```
 
-  - Or add Arstotka to you `Gemfile` and `bundle install`
+- Or add Arstotka to you `Gemfile` and `bundle install`
 
-  ```ruby
-  gem 'arstotzka'
-  ```
+```ruby
+gem 'arstotzka'
+```
 
-  ```bash
-    bundle install arstotzka
-  ```
+```bash
+  bundle install arstotzka
+```
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/arstotzka/1.0.4
+https://www.rubydoc.info/gems/arstotzka/1.1.0
 
 Getting Started
 ---------------
 1. Include in a class that you want to wrap a json/hash
-  ```ruby
-  class MyParser
-    include Arstotzka
-  ```
+
+```ruby
+class MyParser
+  include Arstotzka
+end
+```
 
 2. Declare the keys you want to crawl
-  ```ruby
-  class MyParser
-    include Arstotzka
 
-    expose :id
-    expose :name, :age, path: :person
+```ruby
+class MyParser
+  include Arstotzka
+
+  expose :id
+  expose :name, :age, path: :person
 
-    attr_reader :json
+  attr_reader :json
 
-    def initialize(json = {})
-      @json = json
-    end
+  def initialize(json = {})
+    @json = json
   end
+end
 
-  ```
+```
 
-  and let it fetch values from your hash
+and let it fetch values from your hash
 
 
-  ```ruby
-  object = MyParser.new(
-    id: 10,
+```ruby
+MyParser.new(
+  id: 10,
+  age: 22
+  person: {
+    name: 'Robert',
     age: 22
-    person: {
-      name: 'Robert',
-      age: 22
-    }
-  )
-
-  object.name
-  #returns 'Robert'
-  ```
+  }
+)
+```
 
-  this is usefull when trying to fetch data from hashes missing nodes
+this is usefull when trying to fetch data from hashes missing nodes
 
-  ```ruby
-  MyParser.new.name
-  #returns nil
-  ```
+```ruby
+MyParser.new.name # returns nil
+```
 
 3. fully customise the way you crawl / fetch the information with [Options](#options)
 
@@ -98,7 +98,7 @@ Options
 - json: method that contains the hash to be parsed (json by default)
 - full_path: full path to fetch the value (empty by default)
 - cached: indicator that once the value has been fetched, it should be cached (false by default)
-- class: class to be used when wrapping the final value
+- klass: class to be used when wrapping the final value
 - compact: indicator telling to ignore nil values inside array (false by default)
 - flatten: indicator telling that to flattern the resulting array (false by default)
 - after: name of a method to be called after with the resulting value
@@ -143,20 +143,20 @@ end
 ```
 
 ```ruby
-  object = MyParser.new(
-    accounts: [
-      { balance: '$ 1000.50', type: 'checking' },
-      { balance: '$ 150.10', type: 'savings' },
-      { balance: '$ -100.24', type: 'checking' }
-    ],
-    loans: [
-      { value: '$ 300.50', bank: 'the_bank' },
-      { value: '$ 150.10', type: 'the_other_bank' },
-      { value: '$ 100.24', type: 'the_same_bank' }
-    ]
-  )
-
-  object.total_money # returns 1050.36
+object = MyParser.new(
+  accounts: [
+    { balance: '$ 1000.50', type: 'checking' },
+    { balance: '$ 150.10', type: 'savings' },
+    { balance: '$ -100.24', type: 'checking' }
+  ],
+  loans: [
+    { value: '$ 300.50', bank: 'the_bank' },
+    { value: '$ 150.10', type: 'the_other_bank' },
+    { value: '$ 100.24', type: 'the_same_bank' }
+  ]
+)
+
+object.total_money # returns 1050.36
 ```
 
 ## Default
@@ -175,7 +175,7 @@ class StarGazer
   include Arstotzka
 
   expose :favorite_star, full_path: 'universe.star',
-         default: { name: 'Sun' }, class: ::Star
+         default: { name: 'Sun' }, klass: ::Star
 
   attr_reader :json
 
@@ -186,14 +186,11 @@ end
 
 ```
 
-
 ```ruby
 star_gazer = StarGazer.new
 
-star_gazer.favorite_star.name
-#returns "Sun"
+star_gazer.favorite_star.name # returns "Sun"
 
-star_gazer.favorite_star.class
-#returns Star
+star_gazer.favorite_star.class # returns Star
 ```
 

data/config/yardstick.yml

@@ -20,44 +20,32 @@ rules:
     enabled: true
     exclude:
       - Arstotzka::Builder#attr_names
+      - Arstotzka::Builder#options
       - Arstotzka::Builder#json_name
-      - Arstotzka::Builder#path
-      - Arstotzka::Builder#full_path
-      - Arstotzka::Builder#cached
       - Arstotzka::Crawler#post_process
-      - Arstotzka::Crawler#path
-      - Arstotzka::Crawler#case_type
-      - Arstotzka::Crawler#compact
-      - Arstotzka::Crawler#default
-      - Arstotzka::Fetcher#path
+      - Arstotzka::Crawler#options
+      - Arstotzka::Fetcher#keys
       - Arstotzka::Fetcher#hash
       - Arstotzka::Fetcher#instance
-      - Arstotzka::Reader#path
-      - Arstotzka::Reader#case_type
-      - Arstotzka::Reader#change_case
-      - Arstotzka::Wrapper#clazz
-      - Arstotzka::Wrapper#type
+      - Arstotzka::Fetcher#options
+      - Arstotzka::Reader#keys
+      - Arstotzka::Reader#options
+      - Arstotzka::Wrapper#options
   Summary::Presence:
     enabled: true
     exclude:
       - Arstotzka::Builder#attr_names
+      - Arstotzka::Builder#options
       - Arstotzka::Builder#json_name
-      - Arstotzka::Builder#path
-      - Arstotzka::Builder#full_path
-      - Arstotzka::Builder#cached
       - Arstotzka::Crawler#post_process
-      - Arstotzka::Crawler#path
-      - Arstotzka::Crawler#case_type
-      - Arstotzka::Crawler#compact
-      - Arstotzka::Crawler#default
-      - Arstotzka::Fetcher#path
+      - Arstotzka::Crawler#options
+      - Arstotzka::Fetcher#keys
       - Arstotzka::Fetcher#hash
       - Arstotzka::Fetcher#instance
-      - Arstotzka::Reader#path
-      - Arstotzka::Reader#case_type
-      - Arstotzka::Reader#change_case
-      - Arstotzka::Wrapper#clazz
-      - Arstotzka::Wrapper#type
+      - Arstotzka::Fetcher#options
+      - Arstotzka::Reader#keys
+      - Arstotzka::Reader#options
+      - Arstotzka::Wrapper#options
   Summary::Length:
     enabled: true
     exclude: []

data/lib/arstotzka/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  # @api private
+  #
+  # Common code to be used by classes
+  module Base
+    private
+
+    # Sets the @options object
+    #
+    # @overload options=(options_hash={})
+    #   @param options_hash [Hash] options
+    #
+    # @overload options=(options)
+    #   @param options [Arstotzka::Options] options object
+    #
+    # @return [Arstotzka::Options]
+    def options=(options)
+      @options = if options.is_a?(Hash)
+                   Options.new(options)
+                 else
+                   options
+                 end
+    end
+  end
+end

data/lib/arstotzka/builder.rb

@@ -21,13 +21,13 @@ module Arstotzka
   #     'cars' => 2.0
   #   )
   #
-  #   options = Arstotzka::Builder::DEFAULT_OPTIONS.merge(full_path: 'name.first')
+  #   options = Arstotzka::Options.new(full_path: 'name.first')
   #   builder = Arstotzka::Builder.new([ :first_name ], MyModel, options)
   #   builder.build
   #
   #   instance.first_name # returns 'John'
   #
-  #   options = Arstotzka::Builder::DEFAULT_OPTIONS.merge(type: :integer)
+  #   options = Arstotzka::Options.new(type: :integer)
   #   builder = Arstotzka::Builder.new([ :age, :cars ], MyModel, options)
   #   builder.build
   #
@@ -36,64 +36,34 @@ module Arstotzka
   #
   # @see https://www.rubydoc.info/gems/sinclair Sinclair
   class Builder < Sinclair
-    DEFAULT_OPTIONS = {
-      json:     :json,
-      path:     nil,
-      full_path: nil,
-      cached: false,
-      after:     false,
-      case:      :lower_camel,
-      class:     nil,
-      compact: false,
-      default: nil,
-      flatten:   false,
-      type:      :none
-    }.freeze
-
+    include Base
     # Returns new instance of Arstotzka::Builder
+    #
     # @param attr_names [Array] list of attributes to be fetched from the hash/json
     # @param clazz [Class] class to receive the methods
-    # @param path [String/Symbol] path of hash attributes to find the root
-    #   where the attribute live (then fetching it using the attribute name)
-    # @param full_path [String/Symbol] path of hash attributes to find exacttly where the
-    #   value live (ignoring the attribute name)
-    # @param cached [Boolean] flag if the result should be memorized instead of repeating
-    #   the crawling
-    # @param json [String/Symbol] name of the method containing the Hash/json to be crawled
-    # @param options [Hash] hash containing extra options
-    # @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] class:  {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
-    def initialize(attr_names, clazz, json:, path:, full_path:, cached:, **options)
-      super(clazz, options)
+    #   (using {https://www.rubydoc.info/gems/sinclair Sinclair})
+    #
+    # @overload initialize(attr_names, clazz, options_hash={})
+    #   @param options_hash [Hash] hash containing extra options
+    #
+    # @overload initialize(attr_names, clazz, options)
+    #   @param options [Arstotzka::Options] options of initialization object
+    #
+    # @see https://www.rubydoc.info/gems/sinclair Sinclair
+    # @see Arstotzka::Options
+    def initialize(attr_names, clazz, options = {})
+      super(clazz)
+      self.options = options
 
       @attr_names = attr_names
-      @path = path
-      @full_path = full_path
-      @cached = cached
-      @json_name = json
       init
     end
 
     private
 
     # @private
-    attr_reader :attr_names, :json_name, :path, :full_path, :cached
+    attr_reader :attr_names, :options
+    delegate :json_name, :path, :full_path, :cached, to: :options
 
     # @private
     #
@@ -117,37 +87,6 @@ module Arstotzka
       full_path || [path, attribute].compact.join('.')
     end
 
-    # @private
-    #
-    # Fetch class to wrap resulting value
-    #
-    # after fetching the value, when wrapper_clazz returns
-    # a Class object, the value will be wrapped with
-    # +wrapper_clazz.new(value)+
-    #
-    # @return [Class] the class to wrap the resulting value
-    #
-    # @see Arstotzka::Wrapper
-    def wrapper_clazz
-      options[:class]
-    end
-
-    # @private
-    #
-    # Fetches the case of the keys
-    #
-    # case types can be
-    #   - 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 [Symbol/String] defined case_type
-    #
-    # @see Arstotzka::Reader
-    def case_type
-      options[:case]
-    end
-
     # @private
     #
     # Options needed by fetcher
@@ -158,9 +97,7 @@ module Arstotzka
     #
     # @see Arstotzka::Fetcher
     def fetcher_options(attribute)
-      options.slice(:compact, :after, :type, :flatten, :default).merge(
-        clazz: wrapper_clazz,
-        case_type: case_type,
+      options.to_h.slice(:klass, :case, :compact, :after, :type, :flatten, :default).merge(
         path: real_path(attribute)
       )
     end
@@ -178,6 +115,10 @@ module Arstotzka
       add_method attribute, (cached ? cached_fetcher(attribute) : attr_fetcher(attribute)).to_s
     end
 
+    def json_name
+      options.json
+    end
+
     # Returns the code needed to initialize fetcher
     #
     # @param [String/Symbol] attribute name of method / attribute

data/lib/arstotzka/class_methods.rb

@@ -35,14 +35,14 @@ module Arstotzka
     #   instance.age        # returns 20
     #   instance.cars       # returns 2
     #
-    # @return nil
+    # @return [Array<Sinclair::MethodDefinition>]
     #
     # @see Builder Arstotzka::Builder
     # @see
     #   https://www.rubydoc.info/gems/activesupport/5.2.2/ActiveSupport/Concern
     #   ActiveSupport::Concern
-    def expose(*attr_names, **options)
-      options = Builder::DEFAULT_OPTIONS.merge(options.symbolize_keys)
+    def expose(*attr_names, **options_hash)
+      options = Options.new(options_hash.symbolize_keys)
       Builder.new(attr_names, self, options).build
     end
   end

data/lib/arstotzka/crawler.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Arstotzka
-  # Crawl a hash through the path of keys
+  # Crawl a hash through the keys of keys
   #
   # @api private
   #
   # @example
-  #   crawler = Arstotzka::Crawler.new(%w(person information first_name))
+  #   crawler = Arstotzka::Crawler.new(keys: %w(person information first_name))
   #   hash = {
   #     person: {
   #       'information' => {
@@ -16,31 +16,37 @@ module Arstotzka
   #   }
   #   crawler.value(hash) # returns 'John'
   class Crawler
+    include Base
+
     # Creates a new instance of Crawler
     #
-    # @param path [Array] path of keys to be crawled
-    # @param case_type [Symbol] case type of the keys
-    #   - snake: snake_cased keys
-    #   - lower_camel: lowerCamelCased keys
-    #   - upper_camel: UperCamelCased keys
-    # @param compact [Boolean] flag signallying if nil values should be removed of an array
-    # @param default [Object] default value to be returned when failing to fetch a value
     # @param block [Proc] block to be ran over the fetched value before returning it
-    def initialize(path:, case_type: :lower_camel, compact: false, default: nil, &block)
-      @case_type = case_type
-      @compact = compact
-      @default = default
-      @path = path
+    #
+    # @overload initialize(options_hash={}, &block)
+    #   @param options [Hash] options of initialization
+    #   @option options keys [Array] keys of keys to be crawled
+    #   @option options case [Symbol] case type of the keys
+    #     - snake: snake_cased keys
+    #     - lower_camel: lowerCamelCased keys
+    #     - upper_camel: UperCamelCased keys
+    #   @option options compact [Boolean] flag signallying if nil values should be removed of array
+    #   @option options default [Object] default value to be returned when failing to fetch a value
+    #
+    # @overload initialize(options, &block)
+    #   @param options [Arstotzka::Options] options of initialization object
+    def initialize(options = {}, &block)
+      self.options = options
+
       @post_process = block || proc { |value| value }
     end
 
-    # Crawls into the hash looking for all keys in the given path
-    # @overload value(hash)
+    # Crawls into the hash looking for all keys in the given keys
+    #
     # @return [Object] value fetched from the last Hash#fetch call using the last part
-    #   of path
+    #   of keys
     #
     # @example
-    #   crawler = Arstotzka::Crawler.new(%w(person information first_name))
+    #   crawler = Arstotzka::Crawler.new(keys: %w(person information first_name))
     #   hash = {
     #     person: {
     #       'information' => {
@@ -52,8 +58,8 @@ module Arstotzka
     #
     # @example
     #   crawler = Arstotzka::Crawler.new(
-    #     %w(companies games hero),
-    #     compact: true, case_type: :snake
+    #     keys: %w(companies games hero),
+    #     compact: true, case: :snake
     #   )
     #   games_hash = {
     #     'companies' => [{
@@ -73,16 +79,16 @@ module Arstotzka
     #
     # @example
     #   crawler = Arstotzka::Crawler.new(
-    #     %w(companies games hero),
-    #     compact: true, case_type: :snake, default: 'NO HERO'
+    #     keys: %w(companies games hero),
+    #     compact: true, case: :snake, default: 'NO HERO'
     #   )
     #
     #   crawler.value(games_hash) # returns [['NO HERO', 'Rakhar'], 'NO HERO']
     #
     # @example
     #   crawler = Arstotzka::Crawler.new(
-    #     %w(companies games hero),
-    #     compact: true, case_type: :snake
+    #     keys: %w(companies games hero),
+    #     compact: true, case: :snake
     #   ) { |value| value.&to_sym }
     #
     #   crawler.value(games_hash) # returns [[:Rakhar]]
@@ -95,7 +101,8 @@ module Arstotzka
     private
 
     # @private
-    attr_reader :post_process, :path, :case_type, :compact, :default
+    attr_reader :post_process, :options
+    delegate :keys, :compact, :default, to: :options
 
     # Fetch the value from hash by crawling the keys
     #
@@ -134,10 +141,7 @@ module Arstotzka
     #
     # @return [Arstotzka::Reader] Object responsible for extracting values out of the hash
     def reader
-      @reader ||= Arstotzka::Reader.new(
-        path: path,
-        case_type: case_type
-      )
+      @reader ||= Arstotzka::Reader.new(options)
     end
 
     # @private