arstotzka 1.3.2 → 1.4.0

data/lib/arstotzka/fetcher_builder.rb

@@ -17,7 +17,7 @@ module Arstotzka
   #     end
   #   end
   #
-  #   options =  Arstotzka::Options.new(key: :id, path: :person)
+  #   options = { key: :id, path: :person }
   #   builder = Arstotzka::FetcherBuilder.new(options)
   #   instance = MyModel.new(
   #     person: {
@@ -29,17 +29,11 @@ module Arstotzka
   #
   #   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
+    # @param options [Hash] options (see {Options})
+    def initialize(options = {})
+      @options = options
     end
 
     # Builds a fetcher responsible for fetchin a value
@@ -62,12 +56,12 @@ module Arstotzka
     #     end
     #   end
     #
-    #   options =  Arstotzka::Options.new(
+    #   options = {
     #     key:       :player_ids,
     #     full_path: 'teams.players.person_id',
     #     flatten:   true,
     #     case:      :snake
-    #   )
+    #   }
     #   builder = Arstotzka::FetcherBuilder.new(options)
     #   hash = {
     #     teams: [
@@ -142,9 +136,9 @@ module Arstotzka
     #
     #   instance = StarGazer.new(hash)
     #
-    #   options = Arstotzka::Options.new(
+    #   options = {
     #     key: :stars, klass: Star, after: :only_yellow
-    #   )
+    #   }
     #
     #   builder = Arstotzka::FetcherBuilder.new(options)
     #   fetcher = builder.build(instance)
@@ -156,7 +150,11 @@ module Arstotzka
     #
     # @return Arstotzka::Fetcher
     def build(instance)
-      Fetcher.new(options.merge(instance: instance))
+      fetcher_options = Arstotzka.config.options(
+        options.merge(instance: instance)
+      )
+
+      Fetcher.new(fetcher_options)
     end
 
     private

data/lib/arstotzka/key_reader.rb

@@ -73,8 +73,6 @@ module Arstotzka
     # - 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 key
       @key ||= case options.case

data/lib/arstotzka/method_builder.rb

@@ -23,13 +23,13 @@ module Arstotzka
   #     'cars' => 2.0
   #   )
   #
-  #   options = Arstotzka::Options.new(full_path: 'name.first')
+  #   options = { full_path: 'name.first' }
   #   builder = Arstotzka::MethodBuilder.new([ :first_name ], MyModel, options)
   #   builder.build
   #
   #   instance.first_name # returns 'John'
   #
-  #   options = Arstotzka::Options.new(type: :integer)
+  #   options = { type: :integer }
   #   builder = Arstotzka::MethodBuilder.new([ :age, 'cars' ], MyModel, options)
   #   builder.build
   #
@@ -38,24 +38,18 @@ module Arstotzka
   #
   # @see https://www.rubydoc.info/gems/sinclair Sinclair
   class MethodBuilder < Sinclair
-    include Base
     # Returns new instance of Arstotzka::MethodBuilder
     #
     # @param attr_names [Array<Symbol>] list of attributes to be fetched from the hash/json
     # @param klass [Class] class to receive the methods
     #   (using {https://www.rubydoc.info/gems/sinclair Sinclair})
-    #
-    # @overload initialize(attr_names, klass, options_hash={})
-    #   @param options_hash [Hash] hash containing extra options
-    #
-    # @overload initialize(attr_names, klass, options)
-    #   @param options [Arstotzka::Options] options of initialization object
+    # @param options [Hash] hash containing extra options
     #
     # @see https://www.rubydoc.info/gems/sinclair Sinclair
     # @see Arstotzka::Options
     def initialize(attr_names, klass, options = {})
       super(klass)
-      self.options = options
+      @options = options
 
       @attr_names = attr_names
       init
@@ -65,7 +59,7 @@ module Arstotzka
 
     # @private
     attr_reader :attr_names, :options
-    delegate :path, :full_path, :cached, to: :options
+    delegate to: :options
 
     # @private
     #
@@ -89,23 +83,10 @@ module Arstotzka
     # @see Sinclair
     def add_attr(attribute)
       klass.add_fetcher(attribute, options)
-      add_method attribute, attr_fetcher(attribute), cached: cached
-    end
 
-    # Returns the code needed to initialize fetcher
-    #
-    # @param [String,Symbol] attribute name of method / attribute
-    #
-    # @return [String] method code
-    #
-    # @see Sinclair
-    # @see Artotzka::Fetcher
-    def attr_fetcher(attribute)
-      <<-CODE
-        begin
-          self.class.fetcher_for(:#{attribute}, self).fetch
-        end
-      CODE
+      add_method attribute do
+        self.class.fetcher_for(attribute, self).fetch
+      end
     end
   end
 end

data/lib/arstotzka/options.rb

@@ -5,8 +5,7 @@ module Arstotzka
   #
   # Class responsible to hold the options
   #
-  # Options is initialized and merged with {DEFAULT_OPTIONS}
-  # when using {ClassMethods#expose}
+  # Options is initialized when using {ClassMethods#expose}
   #
   # @example Using options klass and after
   #   class Customer
@@ -245,27 +244,10 @@ module Arstotzka
   #                      #   Linda Ariel
   #                      # ]
   class Options < ::OpenStruct
-    DEFAULT_OPTIONS = {
-      after:      false,
-      after_each: nil,
-      cached:     false,
-      case:       :lower_camel,
-      compact:    false,
-      default:    nil,
-      flatten:    false,
-      full_path:  nil,
-      json:       :json,
-      klass:      nil,
-      path:       nil,
-      type:       :none
-    }.freeze
-
     # Creates a new instance of Options
     #
     # @param options [Hash] options hash
-    #
-    #   Options hash are initialized and merged with {DEFAULT_OPTIONS}
-    #   when using {ClassMethods#expose}
+    #   Options hash are initialized when using {ClassMethods#expose}
     #
     # @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
@@ -304,7 +286,7 @@ module Arstotzka
       warn ":class has been deprecated, prefer 'expose klass: #{klass}'" if klass
       options[:klass] ||= klass
 
-      super(DEFAULT_OPTIONS.merge(options))
+      super(options)
     end
 
     # @private

data/lib/arstotzka/version.rb

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

data/scripts/rubycritic.sh

@@ -4,7 +4,7 @@ DIFF_LIST=$(git diff --name-only $CIRCLE_SHA1 $(git merge-base $CIRCLE_SHA1 orig
 
 if [ ! -z "$DIFF_LIST" ]; then
   mkdir -p tmp/rubycritic/compare
-  bundle exec rubycritic --format console --branch origin/master -t 0 $DIFF_LIST
+  bundle exec rubycritic --format console --branch origin/master -t 0 --maximum-decrease 1 $DIFF_LIST
 else
   echo "No changes detected. Skipping rubycritic..."
 fi

data/spec/integration/readme/arstotzka/config_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::Config do
+  describe 'readme' do
+    subject(:restaurant) { Restaurant.new(hash) }
+
+    let(:hash) do
+      {
+        restaurant: {
+          complete_meals: {
+            dishes: %w[
+              Goulash
+              Spaghetti
+              Pizza
+            ]
+          }
+        }
+      }
+    end
+
+    after { Arstotzka.reset_config }
+
+    it 'does not find the values' do
+      expect { restaurant.dishes }.to raise_error(NoMethodError)
+    end
+
+    context 'when configuring json to be instance_variable' do
+      before do
+        Arstotzka.configure { json :@hash }
+      end
+
+      it do
+        expect(restaurant.dishes).to be_nil
+      end
+
+      context 'when setting default case to snake' do
+        before do
+          Arstotzka.configure { |c| c.case :snake }
+        end
+
+        it do
+          expect(restaurant.dishes)
+            .to eq(%w[
+                     Goulash Spaghetti Pizza
+                   ])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::Config do
+  describe 'yard' do
+    subject(:config) { Arstotzka.config }
+
+    describe '#options' do
+      let(:overrides) { { klass: Person } }
+
+      let(:expected) do
+        {
+          after:      false,
+          after_each: nil,
+          cached:     false,
+          case:       :snake,
+          compact:    false,
+          default:    nil,
+          flatten:    false,
+          json:       :json,
+          klass:      Person,
+          type:       :none
+        }
+      end
+
+      before do
+        Arstotzka.configure do |config|
+          config.case :snake
+        end
+      end
+
+      after { Arstotzka.reset_config }
+
+      it 'configure options to use snake case' do
+        expect(config.options(overrides).to_h).to eq(expected)
+      end
+    end
+  end
+end

data/spec/integration/yard/arstotzka/fetcher/cache_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::Fetcher::Cache do
+  describe 'yard' do
+    let(:instance) { Object.new }
+
+    let(:options) do
+      Arstotzka::Options.new(
+        options_hash.merge(key: :x, instance: instance)
+      )
+    end
+
+    describe '#fetch' do
+      describe 'without cache option' do
+        subject(:cache) do
+          described_class.new do
+            (settings[:min]..settings[:max]).sum
+          end
+        end
+
+        let(:options_hash) { {} }
+        let(:settings)     { { min: 1, max: 100 } }
+
+        it 'retrieves value from block' do
+          expect(cache.fetch).to eq(5050)
+        end
+
+        it 'retrieves every time' do
+          cache.fetch
+          settings[:max] = 10
+          expect(cache.fetch).to eq(55)
+        end
+      end
+
+      describe 'with simple cache option' do
+        subject(:cache) do
+          described_class.new(options) do
+            (settings[:min]..settings[:max]).sum if settings[:calculate]
+          end
+        end
+
+        let(:options_hash) { { cached: true } }
+        let(:settings)     { { calculate: false, min: 1, max: 100 } }
+
+        it 'returns nil on first attempt' do
+          expect(cache.fetch).to be_nil
+        end
+
+        it 'recalculates when cache is nil' do
+          cache.fetch
+          settings[:calculate] = true
+
+          expect(cache.fetch).to eq(5050)
+        end
+
+        it ' does not recalculates when cache is not nil' do
+          cache.fetch
+          settings[:calculate] = true
+          cache.fetch
+          settings[:max] = 10
+
+          expect(cache.fetch).to eq(5050)
+        end
+      end
+
+      describe 'with full cache option' do
+        subject(:cache) do
+          described_class.new(options) do
+            (settings[:min]..settings[:max]).sum if settings[:calculate]
+          end
+        end
+
+        let(:options_hash) { { cached: :full } }
+        let(:settings)     { { calculate: false, min: 1, max: 100 } }
+
+        it 'returns nil on first attempt' do
+          expect(cache.fetch).to be_nil
+        end
+
+        it 'does not recalculate when cache is nil' do
+          cache.fetch
+          settings[:calculate] = true
+
+          expect(cache.fetch).to be_nil
+        end
+      end
+    end
+  end
+end

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

@@ -7,12 +7,11 @@ describe Arstotzka::FetcherBuilder do
     describe '#build' do
       subject(:builder) { described_class.new(options) }
 
-      let(:options)  { Arstotzka::Options.new(options_hash) }
       let(:fetcher)  { builder.build(instance) }
       let(:instance) { MyModel.new(hash) }
 
-      context 'with sample usage' do
-        let(:options_hash) { { key: :id, path: :person } }
+      describe 'Building a simple fetcher' do
+        let(:options) { { key: :id, path: :person } }
 
         let(:hash) do
           {
@@ -27,8 +26,8 @@ describe Arstotzka::FetcherBuilder do
         end
       end
 
-      context 'with passing full path' do
-        let(:options_hash) do
+      describe 'Builder a fetcher using full path' do
+        let(:options) do
           {
             key:       :player_ids,
             full_path: 'teams.players.person_id',
@@ -62,7 +61,7 @@ describe Arstotzka::FetcherBuilder do
         end
       end
 
-      context 'when filtering the result' do
+      describe 'Post processing results' do
         let(:instance) { StarGazer.new(hash) }
         let(:hash) do
           {
@@ -75,15 +74,16 @@ describe Arstotzka::FetcherBuilder do
             ]
           }
         end
-        let(:options_hash) do
+        let(:options) do
           { key: :stars, klass: Star, after: :only_yellow }
         end
 
         it 'builds a fetcher capable of fetching and filtering value' do
-          expect(fetcher.fetch).to eq([
-                                        Star.new(name: 'Sun', color: 'yellow'),
-                                        Star.new(name: 'HB0124-C', color: 'yellow')
-                                      ])
+          expect(fetcher.fetch)
+            .to eq([
+                     Star.new(name: 'Sun', color: 'yellow'),
+                     Star.new(name: 'HB0124-C', color: 'yellow')
+                   ])
         end
       end
     end