arstotzka 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a819ccb4eab671027d924859a3406ed34c119992
-  data.tar.gz: cb6617c7d4a846b7e7398d0eb68d3cbe9996f24c
+  metadata.gz: f6434b65a0dc88484fb45965e6c0700978300f24
+  data.tar.gz: e91d322f0ad668991927080809a0ba63430814ac
 SHA512:
-  metadata.gz: 999acf4da93d2c838bbf8d557f482db6b6bb001ad70ce55235eac8a486ca1f0c91609c0eb7c95f4afe92e3dc120b0e1d14ceffc6eee2b967b99aca10d59b1597
-  data.tar.gz: 5008b64f5c6bd7698ba26e61e8932562f4778a8fa3cd95547aa6a286e5af7cfa3b1177ca7907339b62c10fcdc2b1878818bd394c311f91a22744b5534cc14cdd
+  metadata.gz: 5bd3079f38a8f38d95ef74521273f02dc9c40add3c81315d5bde04382fd75f02b017663cca973ed99a17681d9bf6bf509f9df9b79977edf9ab62f29fbccd1291
+  data.tar.gz: 8929be5f4f9fae35d4ad87f54b3a60d7a361877c975e04dadbeebb553a5d0888fbb0f0167e00d1c72bd9e308eacd54176041e9b4c8848d029ebfd4addb2bda19

data/.circleci/config.yml

@@ -2,13 +2,24 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.4.1
+      - image: darthjee/circleci_ruby_240:0.1.0
     steps:
       - checkout
-      - run: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-      - run: chmod +x ./cc-test-reporter
-      - run: ./cc-test-reporter before-build
-      - run: bundle install
-      - run: bundle exec rspec
-      - run: rubocop
-      - run: ./cc-test-reporter after-build --exit-code $?
+      - run:
+          name: Prepare Coverage Test Report
+          command: cc-test-reporter before-build
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: RSpec
+          command: bundle exec rspec
+      - run:
+          name: Rubocop
+          command: rubocop
+      - run:
+          name: Coverage Test Report
+          command: cc-test-reporter after-build --exit-code $?
+      - run:
+          name: Yardstick coverage check
+          command: bundle exec rake verify_measurements

data/.gitignore

@@ -2,3 +2,6 @@ coverage
 Gemfile.lock
 .yardoc
 doc
+pkg
+measurement
+**/*.swp

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-25 18:12:13 +0000 using RuboCop version 0.58.0.
+# on 2019-03-07 08:37:15 +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
@@ -9,5 +9,8 @@
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
-  Exclude:
-    - 'lib/arstotzka/builder.rb'
+  Max: 7
+
+# Offense count: 46
+RSpec/NestedGroups:
+  Max: 5

data/.yardopts

@@ -0,0 +1 @@
+--private --no-private

data/Dockerfile

@@ -0,0 +1,8 @@
+FROM darthjee/ruby_240:0.2.2
+
+USER app
+COPY ./ /home/app/app/
+
+RUN gem uninstall bundler
+RUN gem install bundler -v '1.17.3'
+RUN bundle install

data/README.md

@@ -37,7 +37,7 @@ Instalation
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/arstotzka/
+https://www.rubydoc.info/gems/arstotzka/1.0.4
 
 Getting Started
 ---------------
@@ -156,8 +156,7 @@ end
     ]
   )
 
-  object.balance
-#returns 1050.36
+  object.total_money # returns 1050.36
 ```
 
 ## Default

data/Rakefile

@@ -2,6 +2,8 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yardstick/rake/measurement'
+require './config/yardstick'
 
 RSpec::Core::RakeTask.new
 

data/arstotzka.gemspec

@@ -19,14 +19,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '~> 5.x'
-  spec.add_runtime_dependency 'sinclair', '>= 1.1.1'
+  spec.add_runtime_dependency 'sinclair',      '>= 1.1.1'
+
+  spec.add_development_dependency 'bundler',       '~> 1.17.x'
+  spec.add_development_dependency 'pry-nav',       '~> 0.2.4'
+  spec.add_development_dependency 'rake',          '>= 12.3.1'
+  spec.add_development_dependency 'rspec',         '>= 3.8'
+  spec.add_development_dependency 'rubocop',       '0.58.1'
+  spec.add_development_dependency 'rubocop-rspec', '1.30.0'
+  spec.add_development_dependency 'simplecov',     '~> 0.16.x'
+  spec.add_development_dependency 'yard',          '>= 0.9.18'
+  spec.add_development_dependency 'yardstick',     '>= 0.9.9'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'pry-nav'
-  spec.add_development_dependency 'rake', '>= 12.3.1'
-  spec.add_development_dependency 'rspec', '>= 3.7'
-  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'safe_attribute_assignment'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'yard'
 end

data/config/yardstick.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+require 'yaml'
+
+options = YAML.load_file('config/yardstick.yml')
+
+Yardstick::Rake::Measurement.new(:yardstick_measure, options) do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+Yardstick::Rake::Verify.new(:verify_measurements, options)

data/config/yardstick.yml

@@ -0,0 +1,69 @@
+threshold: 100
+require_exact_threshold: false
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: true
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude:
+      - Arstotzka::Builder#attr_names
+      - 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::Fetcher#hash
+      - Arstotzka::Fetcher#instance
+      - Arstotzka::Reader#path
+      - Arstotzka::Reader#case_type
+      - Arstotzka::Reader#change_case
+      - Arstotzka::Wrapper#clazz
+      - Arstotzka::Wrapper#type
+  Summary::Presence:
+    enabled: true
+    exclude:
+      - Arstotzka::Builder#attr_names
+      - 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::Fetcher#hash
+      - Arstotzka::Fetcher#instance
+      - Arstotzka::Reader#path
+      - Arstotzka::Reader#case_type
+      - Arstotzka::Reader#change_case
+      - Arstotzka::Wrapper#clazz
+      - Arstotzka::Wrapper#type
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []

data/docker-compose.yml

@@ -1,18 +1,23 @@
-version: '2'
+version: '3'
 services:
   base: &base
-    image: ruby:2.4.0
-    working_dir: /home/app/arstotzka
+    image: arstotzka
+    working_dir: /home/app/app
     volumes:
-      - .:/home/app/arstotzka
-      - arstotzka_gems_2_4_0:/usr/local/bundle
+      - .:/home/app/app
 
-  #################### CONTAINERS ####################
+  base_build:
+    <<: *base
+    build: .
+    command: echo done
 
   arstotzka:
     <<: *base
     container_name: arstotzka
-    command: /bin/bash -c 'bundle install && bundle exec rspec'
+    depends_on: [base_build]
+    command: /bin/bash -c 'rspec'
 
-volumes:
-  arstotzka_gems_2_4_0:
+  test_all:
+    <<: *base
+    depends_on: [base_build]
+    command: /bin/bash -c 'rspec && yard && rake yardstick_measure && rake verify_measurements'

data/lib/arstotzka/builder.rb

@@ -4,6 +4,8 @@ module Arstotzka
   # Class responsible to orchestrate the addtion of method that will
   # crawl the hash for value
   #
+  # @api private
+  #
   # @example
   #   class MyModel
   #     attr_reader :json
@@ -48,6 +50,7 @@ module Arstotzka
       type:      :none
     }.freeze
 
+    # 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
@@ -89,26 +92,71 @@ module Arstotzka
 
     private
 
+    # @private
     attr_reader :attr_names, :json_name, :path, :full_path, :cached
 
+    # @private
+    #
+    # Initialize methods list
+    #
+    # @return nil
     def init
       attr_names.each do |attr|
         add_attr(attr)
       end
     end
 
+    # @private
+    #
+    # builds the complete key path to fetch value
+    #
+    # @param [String/Symbol] attribute name of the method / attribute
+    #
+    # @return [String] the keys path
     def real_path(attribute)
       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
+    #
+    # @param [String/Symbol] attribute name of the method / attribute
+    #
+    # @return [Hash] options
+    #
+    # @see Arstotzka::Fetcher
     def fetcher_options(attribute)
       options.slice(:compact, :after, :type, :flatten, :default).merge(
         clazz: wrapper_clazz,
@@ -117,10 +165,27 @@ module Arstotzka
       )
     end
 
+    # @private
+    #
+    # Add method to the list of methods to be built
+    #
+    # @param [String/Symbol] attribute name of method / attribute
+    #
+    # @return nil
+    #
+    # @see Sinclair
     def add_attr(attribute)
       add_method attribute, (cached ? cached_fetcher(attribute) : attr_fetcher(attribute)).to_s
     end
 
+    # Returns the code needed to initialize fetcher
+    #
+    # @param [String/Symbol] attribute name of method / attribute
+    #
+    # @return [String] code
+    #
+    # @see Sinclair
+    # @see Artotzka::Fetcher
     def attr_fetcher(attribute)
       <<-CODE
       ::Arstotzka::Fetcher.new(
@@ -129,6 +194,13 @@ module Arstotzka
       CODE
     end
 
+    # Returns the code needed to initialize a fetche and cache it
+    #
+    # @param [String/Symbol] attribute name of method / attribute
+    #
+    # @return [String] code
+    #
+    # @see #attr_fetcher
     def cached_fetcher(attribute)
       <<-CODE
       @#{attribute} ||= #{attr_fetcher(attribute)}

data/lib/arstotzka/class_methods.rb

@@ -4,7 +4,12 @@ module Arstotzka
   # As Arstotzka extends ActiveSupport::Concern, Arstotzka::ClassMethods define
   # methods that will be available when defining a class that includes Arstotka
   module ClassMethods
-    # expose a field from the json/hash as a method
+    private
+
+    # @api public
+    # @!visibility public
+    #
+    # Expose a field from the json/hash as a method
     #
     # @example
     #   class MyModel
@@ -30,9 +35,11 @@ module Arstotzka
     #   instance.age        # returns 20
     #   instance.cars       # returns 2
     #
+    # @return nil
+    #
     # @see Builder Arstotzka::Builder
     # @see
-    #   https://www.rubydoc.info/gems/activesupport/5.0.0.1/ActiveSupport/Concern
+    #   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)

data/lib/arstotzka/crawler.rb

@@ -2,6 +2,9 @@
 
 module Arstotzka
   # Crawl a hash through the path of keys
+  #
+  # @api private
+  #
   # @example
   #   crawler = Arstotzka::Crawler.new(%w(person information first_name))
   #   hash = {
@@ -13,6 +16,8 @@ module Arstotzka
   #   }
   #   crawler.value(hash) # returns 'John'
   class Crawler
+    # 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
@@ -29,9 +34,7 @@ module Arstotzka
       @post_process = block || proc { |value| value }
     end
 
-    # crawls into the hash looking for all keys in the given path
-    # returning the final value
-    #
+    # Crawls into the hash looking for all keys in the given path
     # @overload value(hash)
     # @return [Object] value fetched from the last Hash#fetch call using the last part
     #   of path
@@ -91,8 +94,33 @@ module Arstotzka
 
     private
 
+    # @private
     attr_reader :post_process, :path, :case_type, :compact, :default
 
+    # Fetch the value from hash by crawling the keys
+    #
+    # The crawling is similar to fetching values in a chain
+    # <code>
+    # { a: { b: 10 } }.fetch(:a).fetch(:b)
+    # </code>
+    # with added features like accessing string and
+    # symbol keys alike, wrapping the values in new objects,
+    # post processing the values, treating arrays as collection
+    # of hashes, etc...
+    #
+    # Once the value is found (with final key), it is wrapped
+    #
+    # If value found in any step (except finel step) and this
+    # is an Array, then next interations will happen with it
+    # element of the array, returning an array of results
+    #
+    # @param [Hash] hash the hash to be crawled
+    # @param [Integer] index the index of the key to be used in the current iteration
+    #
+    # @return [Object] value found at the lest key after transformation
+    #
+    # @see #wrap
+    # @see #crawl_array
     def crawl(hash, index = 0)
       return wrap(hash) if reader.ended?(index)
       return crawl_array(hash, index) if hash.is_a?(Array)
@@ -100,6 +128,11 @@ module Arstotzka
       crawl(reader.read(hash, index), index + 1)
     end
 
+    # @private
+    #
+    # Builds a hash reader
+    #
+    # @return [Arstotzka::Reader] Object responsible for extracting values out of the hash
     def reader
       @reader ||= Arstotzka::Reader.new(
         path: path,
@@ -107,10 +140,28 @@ module Arstotzka
       )
     end
 
-    def wrap(hash)
-      post_process.call(hash)
+    # @private
+    #
+    # Wrap value with final calls
+    #
+    # The final value can be wrapped in a class, or processed
+    # via instance method call
+    #
+    # @param [Object] value the value to be wrapped
+    # @return [Object] the post-processed / wraped value
+    def wrap(value)
+      post_process.call(value)
     end
 
+    # @private
+    #
+    # Iterate over array applying #crawl over each element
+    #
+    # @param [Array] array the array of hashes be crawled
+    # @param [Integer] index the index of the key to be used in the current iteration
+    #
+    # @return [Array] the new array with the individual values returned
+    # @see #crawl
     def crawl_array(array, index)
       array.map { |j| value(j, index) }.tap do |a|
         a.compact! if compact

data/lib/arstotzka/fetcher.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 module Arstotzka
+  # @api private
+  #
   # Class responsible for orquestrating the fetch value from the hash
   # and post-processing it
   class Fetcher
     include Sinclair::OptionsParser
 
+    # 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
@@ -17,8 +21,12 @@ module Arstotzka
       @options = options
     end
 
-    # Crawls the hash for the value, applying then the final transformations on the final
-    # result (collection not value)
+    # Crawls the hash for the value
+    #
+    # After the crawling, final transformation is applied on
+    # the final result (collection not value)
+    #
+    # @return [Object] The final value found and transformed
     #
     # @example
     #   class Transaction
@@ -73,33 +81,54 @@ module Arstotzka
 
     private
 
+    # @private
     attr_reader :path, :hash, :instance
 
     delegate :after, :flatten, to: :options_object
     delegate :wrap, to: :wrapper
 
+    # @private
+    #
+    # Returns an instance of Aristotzka::Craler
+    #
+    # craler will be responsible to crawl the hash for
+    # the final return
+    #
+    # @return [Arstotzka::Crawler] the crawler object
     def crawler
-      @crawler ||= buidl_crawler
-    end
-
-    def buidl_crawler
-      Arstotzka::Crawler.new(crawler_options) do |value|
-        wrap(value)
-      end
+      @crawler ||=
+        Arstotzka::Crawler.new(crawler_options) do |value|
+          wrap(value)
+        end
     end
 
+    # @private
+    #
+    # Hash for crawler initialization
+    #
+    # @return [Hash]
+    #
+    # @see #crawler
     def crawler_options
       options.slice(:case_type, :compact, :default).merge(path: path)
     end
 
+    # @private
+    #
+    # Wrapper responsible for wrapping the value found
+    #
+    # @return [Arstotzka::Wrapper] the wrapper
     def wrapper
-      @wrapper ||= build_wrapper
-    end
-
-    def build_wrapper
-      Arstotzka::Wrapper.new(wrapper_options)
+      @wrapper ||= Arstotzka::Wrapper.new(wrapper_options)
     end
 
+    # @private
+    #
+    # Hash for wrapper initialization
+    #
+    # @return [Hash]
+    #
+    # @see #wrapper
     def wrapper_options
       options.slice(:clazz, :type)
     end