arstotzka 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 74d1946cebd9e40fa273fc644a478e809ce9d888
-  data.tar.gz: 66abec44e1e8090d5507c8f4c59532dce3e8be03
+SHA256:
+  metadata.gz: 3d37d619db8888a43c76400066d7657b53bbf94297e2be0f900fd7f1c391d080
+  data.tar.gz: 98d542ee52adac431bfe9acfcbc4a1bdd6cfdc002647b594b0f4fedfe371a208
 SHA512:
-  metadata.gz: 931eb74bb1e15412c7927c613204dbac3d48dc1ca6f3d81d58c941540ccf23ed530a19c4f8b1214ef06ba0f878d44e5e28cc6b55f3a32c0930123336d4fe3b43
-  data.tar.gz: fac8783602cc90be4933d9dce2f2fe5b6e24fd284ec2c53925ee75cd5cb5895aa62a1de5a40acdef5e158c66cc174df8fe3390ebfacacd7460f5d39c705830f6
+  metadata.gz: 94dcbbed1f5665dab68a52f82222016aad12c68aca3f6676bbf95727f2131bd94c48217e584a245342519ac7c3da887852f85ca3300bf9b5c2a12b2e9d6847e1
+  data.tar.gz: cc368f423651b046af8965f8ca5fc34efbfc8e026c5f894d615621d597360009f713a81554b57e5d8361559f4cf013909be0411ee47bce5a2259f25eef3a8851

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_240:0.1.0
+      - image: darthjee/circleci_ruby_gems:0.0.1
     steps:
       - checkout
       - run:

data/Dockerfile

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

data/README.md

@@ -38,7 +38,7 @@ gem 'arstotzka'
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/arstotzka/1.1.0
+https://www.rubydoc.info/gems/arstotzka/1.2.0
 
 Getting Started
 ---------------

data/arstotzka.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '~> 5.x'
   spec.add_runtime_dependency 'sinclair',      '>= 1.1.1'
 
-  spec.add_development_dependency 'bundler',       '~> 1.17.x'
+  spec.add_development_dependency 'bundler',       '~> 1.16.1'
   spec.add_development_dependency 'pry-nav',       '~> 0.2.4'
   spec.add_development_dependency 'rake',          '>= 12.3.1'
   spec.add_development_dependency 'rspec',         '>= 3.8'

data/config/yardstick.yml

@@ -19,30 +19,30 @@ rules:
   ReturnTag:
     enabled: true
     exclude:
-      - Arstotzka::Builder#attr_names
-      - Arstotzka::Builder#options
-      - Arstotzka::Builder#json_name
       - Arstotzka::Crawler#post_process
       - Arstotzka::Crawler#options
-      - Arstotzka::Fetcher#keys
-      - Arstotzka::Fetcher#hash
       - Arstotzka::Fetcher#instance
       - Arstotzka::Fetcher#options
+      - Arstotzka::Fetcher#hash
+      - Arstotzka::FetcherBuilder#options
+      - Arstotzka::MethodBuilder#attr_names
+      - Arstotzka::MethodBuilder#options
+      - Arstotzka::Options#keys
       - 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::Crawler#post_process
       - Arstotzka::Crawler#options
-      - Arstotzka::Fetcher#keys
-      - Arstotzka::Fetcher#hash
       - Arstotzka::Fetcher#instance
       - Arstotzka::Fetcher#options
+      - Arstotzka::Fetcher#hash
+      - Arstotzka::FetcherBuilder#options
+      - Arstotzka::MethodBuilder#attr_names
+      - Arstotzka::MethodBuilder#options
+      - Arstotzka::Options#keys
       - Arstotzka::Reader#keys
       - Arstotzka::Reader#options
       - Arstotzka::Wrapper#options

data/lib/arstotzka.rb

@@ -159,19 +159,20 @@ require 'sinclair'
 #                            #   Collector::Game.new(name: "Zelda", played: 90.0)
 #                            # ]
 #
-# @see Arstotzka::Builder
+# @see Arstotzka::MethodBuilder
 # @see Arstotzka::ClassMethods
 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'
-  autoload :Exception,    'arstotzka/exception'
-  autoload :Fetcher,      'arstotzka/fetcher'
-  autoload :Reader,       'arstotzka/reader'
-  autoload :Wrapper,      'arstotzka/wrapper'
-  autoload :TypeCast,     'arstotzka/type_cast'
+  autoload :Base,           'arstotzka/base'
+  autoload :ClassMethods,   'arstotzka/class_methods'
+  autoload :Crawler,        'arstotzka/crawler'
+  autoload :Exception,      'arstotzka/exception'
+  autoload :Fetcher,        'arstotzka/fetcher'
+  autoload :FetcherBuilder, 'arstotzka/fetcher_builder'
+  autoload :MethodBuilder,  'arstotzka/method_builder'
+  autoload :Options,        'arstotzka/options'
+  autoload :Reader,         'arstotzka/reader'
+  autoload :TypeCast,       'arstotzka/type_cast'
+  autoload :Wrapper,        'arstotzka/wrapper'
 end

data/lib/arstotzka/class_methods.rb

@@ -4,6 +4,32 @@ module Arstotzka
   # As Arstotzka extends ActiveSupport::Concern, Arstotzka::ClassMethods define
   # methods that will be available when defining a class that includes Arstotka
   module ClassMethods
+    # @api private
+    #
+    # Create builder that will be used to create Fetchers
+    #
+    # @param attribute [Symbol,String] attribute key
+    # @param options [Arstotzka::Options] fetcher options
+    #
+    # @return [Artotzka::FetcherBuilder]
+    def add_fetcher(attribute, options)
+      fetcher_builders[attribute.to_sym] = FetcherBuilder.new(options.merge(key: attribute))
+    end
+
+    # @api private
+    #
+    # Return the fetcher for an attribute and instance
+    #
+    # a new fetcher is built everytime this method is called
+    #
+    # @param attribute [Symbol,String] Name of method that will use this Fetcher
+    # @param instance [Object] instance that will contain the Hash needed by fetcher
+    #
+    # @return [Arstotzka::Fetcher]
+    def fetcher_for(attribute, instance)
+      fetcher_builders[attribute.to_sym].build(instance)
+    end
+
     private
 
     # @api public
@@ -37,13 +63,23 @@ module Arstotzka
     #
     # @return [Array<Sinclair::MethodDefinition>]
     #
-    # @see Builder Arstotzka::Builder
+    # @see MethodBuilder Arstotzka::MethodBuilder
     # @see
     #   https://www.rubydoc.info/gems/activesupport/5.2.2/ActiveSupport/Concern
     #   ActiveSupport::Concern
     def expose(*attr_names, **options_hash)
       options = Options.new(options_hash.symbolize_keys)
-      Builder.new(attr_names, self, options).build
+      MethodBuilder.new(attr_names, self, options).build
+    end
+
+    # @private
+    # @api private
+    #
+    # Map of FetcherBuilders
+    #
+    # @return [Hash<FetcherBuilder>]
+    def fetcher_builders
+      @fetcher_builders ||= {}
     end
   end
 end

data/lib/arstotzka/crawler.rb

@@ -5,8 +5,8 @@ module Arstotzka
   #
   # @api private
   #
-  # @example
-  #   crawler = Arstotzka::Crawler.new(keys: %w(person information first_name))
+  # @example Simple usage
+  #   crawler = Arstotzka::Crawler.new(full_path: 'person.information.first_name')
   #   hash = {
   #     person: {
   #       'information' => {
@@ -45,21 +45,13 @@ module Arstotzka
     # @return [Object] value fetched from the last Hash#fetch call using the last part
     #   of keys
     #
-    # @example
-    #   crawler = Arstotzka::Crawler.new(keys: %w(person information first_name))
-    #   hash = {
-    #     person: {
-    #       'information' => {
-    #         'firstName' => 'John'
-    #       }
-    #     }
-    #   }
-    #   crawler.value(hash) # returns 'John'
+    # @example (see Arstotzka::Crawler)
     #
-    # @example
+    # @example Passing compact and case options
     #   crawler = Arstotzka::Crawler.new(
-    #     keys: %w(companies games hero),
-    #     compact: true, case: :snake
+    #     full_path: 'companies.games.hero',
+    #     compact:   true,
+    #     case:      :snake
     #   )
     #   games_hash = {
     #     'companies' => [{
@@ -77,18 +69,19 @@ module Arstotzka
     #
     #   crawler.value(games_hash) # returns [['Rakhar']]
     #
-    # @example
+    # @example Passing default option
     #   crawler = Arstotzka::Crawler.new(
-    #     keys: %w(companies games hero),
+    #     full_path: 'companies.games.hero',
     #     compact: true, case: :snake, default: 'NO HERO'
     #   )
     #
     #   crawler.value(games_hash) # returns [['NO HERO', 'Rakhar'], 'NO HERO']
     #
-    # @example
+    # @example Passing a post processor block
     #   crawler = Arstotzka::Crawler.new(
-    #     keys: %w(companies games hero),
-    #     compact: true, case: :snake
+    #     full_path: 'companies.games.hero',
+    #     compact:   true,
+    #     case: :    snake
     #   ) { |value| value.&to_sym }
     #
     #   crawler.value(games_hash) # returns [[:Rakhar]]
@@ -102,7 +95,7 @@ module Arstotzka
 
     # @private
     attr_reader :post_process, :options
-    delegate :keys, :compact, :default, to: :options
+    delegate :compact, :default, to: :options
 
     # Fetch the value from hash by crawling the keys
     #

data/lib/arstotzka/fetcher.rb

@@ -10,14 +10,16 @@ module Arstotzka
 
     # 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 options_hash [Hash] options that will be passed to {Crawler}, {Wrapper} and {Reader}
-    def initialize(hash, instance, options_hash = {})
+    #
+    # @overload iniitalize(instance,  options_hash = {})
+    #   @param options_hash [Hash] options for {Crawler}, {Wrapper} and {Reader}
+    #
+    # @overload iniitalize(instance,  options)
+    #   @param options [Arstotzka::Options] options for {Crawler}, {Wrapper} and {Reader}
+    def initialize(instance, options_hash = {})
       self.options = options_hash
 
-      @keys = options.path.to_s.split('.')
-      @hash = hash
       @instance = instance
     end
 
@@ -28,7 +30,7 @@ module Arstotzka
     #
     # @return [Object] The final value found and transformed
     #
-    # @example
+    # @example Fetching with wrapping and processing
     #   class Transaction
     #     attr_reader :value, :type
     #
@@ -43,8 +45,14 @@ module Arstotzka
     #   end
     #
     #   class Account
+    #     def initialize(json = {})
+    #       @json = json
+    #     end
+    #
     #     private
     #
+    #     attr_reader :json
+    #
     #     def filter_income(transactions)
     #       transactions.select(&:positive?)
     #     end
@@ -61,8 +69,10 @@ module Arstotzka
     #       { value: 101.00,  type: 'outcome' }
     #     ]
     #   }
+    #
     #   instance = Account.new
-    #   fetcher = Arstotzka::Fetcher.new(hash, instance,
+    #
+    #   fetcher = Arstotzka::Fetcher.new(instance,
     #     path: 'transactions',
     #     klass: Transaction,
     #     after: :filter_income
@@ -82,10 +92,14 @@ module Arstotzka
     private
 
     # @private
-    attr_reader :keys, :hash, :instance, :options
+    attr_reader :instance, :options
     delegate :after, :flatten, to: :options
     delegate :wrap, to: :wrapper
 
+    def hash
+      @hash ||= instance.send(:eval, options.json.to_s)
+    end
+
     # @private
     #
     # Returns an instance of Aristotzka::Craler
@@ -96,29 +110,18 @@ module Arstotzka
     # @return [Arstotzka::Crawler] the crawler object
     def crawler
       @crawler ||=
-        Arstotzka::Crawler.new(crawler_options) do |value|
+        Crawler.new(options) do |value|
           wrap(value)
         end
     end
 
-    # @private
-    #
-    # Hash for crawler initialization
-    #
-    # @return [Hash]
-    #
-    # @see #crawler
-    def crawler_options
-      options.merge(keys: keys)
-    end
-
     # @private
     #
     # Wrapper responsible for wrapping the value found
     #
     # @return [Arstotzka::Wrapper] the wrapper
     def wrapper
-      @wrapper ||= Arstotzka::Wrapper.new(options)
+      @wrapper ||= Wrapper.new(options)
     end
   end
 end

data/lib/arstotzka/fetcher_builder.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  # @api private
+  #
+  # Class responsible for building fetcher that will be used
+  # to create instance fetchers
+  #
+  # @example Building a simple fetcher
+  #   class MyModel
+  #     include Arstotzka
+  #
+  #     attr_reader :json
+  #
+  #     def initialize(json)
+  #       @json = json
+  #     end
+  #   end
+  #
+  #   options =  Arstotzka::Options.new(key: :id, path: :person)
+  #   builder = Arstotzka::FetcherBuilder.new(options)
+  #   instance = MyModel.new(
+  #     person: {
+  #       id: 101
+  #     }
+  #   )
+  #
+  #   fetcher = builder.build(instance)
+  #
+  #   fetcher.fetch  # returns 101
+  class FetcherBuilder
+    include Base
+
+    # Creates an instance of Artotzka::FetcherBuilder
+    #
+    # @overload initialize(options_hash = {})
+    #   @param options_hash [Hash] options (see {Options})
+    #
+    # @overload initialize(options)
+    #   @param options [Arstotzka::Options] options
+    def initialize(options_hash = {})
+      self.options = options_hash
+    end
+
+    # Builds a fetcher responsible for fetchin a value
+    #
+    # @param instance [Object] object that includes Arstotzka
+    #
+    #   instance should be able to provide the hash where values
+    #   will be fetched from
+    #
+    # @example (see Arstotzka::FetcherBuilder)
+    #
+    # @example Building a fetcher using full path
+    #   class MyModel
+    #     include Arstotzka
+    #
+    #     attr_reader :json
+    #
+    #     def initialize(json)
+    #       @json = json
+    #     end
+    #   end
+    #
+    #   options =  Arstotzka::Options.new(
+    #     key:       :player_ids,
+    #     full_path: 'teams.players.person_id',
+    #     flatten:   true,
+    #     case:      :snake
+    #   )
+    #   builder = Arstotzka::FetcherBuilder.new(options)
+    #   hash = {
+    #     teams: [
+    #       {
+    #         name: 'Team War',
+    #         players: [
+    #           { person_id: 101 },
+    #           { person_id: 102 }
+    #         ]
+    #       }, {
+    #         name: 'Team not War',
+    #         players: [
+    #           { person_id: 201 },
+    #           { person_id: 202 }
+    #         ]
+    #       }
+    #     ]
+    #   }
+    #   instance = MyModel.new(hash)
+    #
+    #   fetcher = builder.build(instance)
+    #
+    #   fetcher.fetch  # returns [101, 102, 201, 202]
+    #
+    # @example Post processing results
+    #   class StarGazer
+    #     include Arstotzka
+    #
+    #     attr_reader :json
+    #
+    #     def initialize(json = {})
+    #       @json = json
+    #     end
+    #
+    #     private
+    #
+    #     def only_yellow(stars)
+    #       stars.select(&:yellow?)
+    #     end
+    #   end
+    #
+    #   class Star
+    #     attr_reader :name, :color
+    #
+    #     def initialize(name:, color: 'yellow')
+    #       @name = name
+    #       @color = color
+    #     end
+    #
+    #     def yellow?
+    #       color == 'yellow'
+    #     end
+    #   end
+    #
+    #   hash = {
+    #     teams: [
+    #       {
+    #         name: 'Team War',
+    #         players: [
+    #           { person_id: 101 },
+    #           { person_id: 102 }
+    #         ]
+    #       }, {
+    #         name: 'Team not War',
+    #         players: [
+    #           { person_id: 201 },
+    #           { person_id: 202 }
+    #         ]
+    #       }
+    #     ]
+    #   }
+    #
+    #   instance = StarGazer.new(hash)
+    #
+    #   options = Arstotzka::Options.new(
+    #     key: :stars, klass: Star, after: :only_yellow
+    #   )
+    #
+    #   builder = Arstotzka::FetcherBuilder.new(options)
+    #   fetcher = builder.build(instance)
+    #
+    #   fetcher.fetch # returns [
+    #                 #   Star.new(name: 'Sun', color: 'yellow'),
+    #                 #   Star.new(name: 'HB0124-C', color: 'yellow'),
+    #                 # ]
+    #
+    # @return Arstotzka::Fetcher
+    def build(instance)
+      Fetcher.new(instance, options)
+    end
+
+    private
+
+    # @private
+    attr_reader :options
+  end
+end