arstotzka 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc52a24a605aeff67f5a310bf8e6bc7dbe300374ba03678ef4abe68f05ae4f4e
-  data.tar.gz: 37ec2565487d9b560d1da8571b12dc6d562a888366e8d8ecb368089ddbf2cb33
+  metadata.gz: 3343d391090a1c5e806d56c9eb97790a79a04fbc24b707384a71024c3f894879
+  data.tar.gz: da14356086e54f211d32a0725de04bd8ba01a2bb7c767ced8e17519f47f6fb37
 SHA512:
-  metadata.gz: 995a859fdd57fc6a32cff22aec0ae542b22148de6ab5a16497e62acec94249e7c56e61e39b8ca336ed2383ebae8ec0efee3e8f8d4fd18366795a66cf88ce6baf
-  data.tar.gz: 55376d536beeb947697540cbdd3a8909b17e85d86beb5cde27d0535975ce59380cf49503d3eabbf3e7af7ae51b6eb77d8c1fce6c3dadc3f8c2b2212b65a1ee36
+  metadata.gz: 4dabdf1acd44e98e8884a0106d84bd6e1f6e3cd33940b0a777049f66d58529757223dbf28e50ff6717764fe025905bf3d3b5d5a38ee710357fc891b3e6c6de61
+  data.tar.gz: ed2fcefdd16da6ac23e8439a84f8158ad271da23385e6560f97197eafc1ba15b6d3a6150be56493767a4f06a19b82b6790386343a409f9b51d76afb3987fc966

data/.circleci/config.yml

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

data/Dockerfile

@@ -1,6 +1,26 @@
-FROM darthjee/ruby_gems:0.0.2
+FROM darthjee/ruby_gems:0.1.0 as base
+FROM darthjee/scripts:0.0.2 as scripts
+
+######################################
+
+FROM base as builder
 
-USER app
 COPY --chown=app ./ /home/app/app/
+COPY --chown=app:app --from=scripts /home/scripts/ ./
+
+ENV HOME_DIR /home/app
+RUN /bin/bash bundle_builder.sh
 
-RUN bundle install
+#######################
+#FINAL IMAGE
+FROM base
+
+USER root
+
+COPY --chown=app:app --from=builder /home/app/bundle/gems /usr/local/bundle/gems
+COPY --chown=app:app --from=builder /home/app/bundle/cache /usr/local/bundle/cache
+COPY --chown=app:app --from=builder /home/app/bundle/specifications /usr/local/bundle/specifications
+COPY --chown=app:app --from=builder /home/app/bundle/bin /usr/local/bundle/bin
+COPY --chown=app:app --from=builder /home/app/bundle/extensions /usr/local/bundle/extensions
+
+USER app

data/README.md

@@ -19,7 +19,7 @@ JSON keys)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/arstotzka/1.3.2
+https://www.rubydoc.info/gems/arstotzka/1.4.0
 
 Instalation
 ---------------
@@ -97,13 +97,19 @@ Options
 - after: Name of a method to be called after on the values returned
 - after_each: Name of a method to be called after each result
 - cached: Indicator that, once the value has been fetched, it should be cached (false by default)
+  - false : no cache
+  - true : simple cache where nil values are not considerated cached
+  - :full : full cache where even nil values are cached
 - case: Case of the keys from the json (lower_camel by default)
+  - :snake : snakecase (eg. `the_key`)
+  - :lower_camel : lower cammel case (eg. `theKey`)
+  - :upper_camel : upper cammel case (eg. `TheKey`)
 - compact: Indicator telling to ignore nil values inside array (false by default)
 - default: Default value (prior to casting and wrapping, see [Default](#default))
 - flatten: Indicator telling that to flattern the resulting array (false by default)
 - full_path: Full path to fetch the value (empty by default)
 - klass: Class to be used when wrapping the final value
-- json: Method that contains the hash to be parsed (json by default)
+- json: Method that contains the hash to be parsed (`:json` by default)
 - path: Path where to find the sub hash that contains the key (empty by default)
 - type: Type that the value must be cast into ([TypeCast](#typecast))
 
@@ -195,3 +201,42 @@ star_gazer.favorite_star.name # returns "Sun"
 star_gazer.favorite_star.class # returns Star
 ```
 
+Configuration
+-------------
+Arstotzka can be configured changing the default options
+
+```ruby
+class Restaurant
+  include Arstotzka
+
+  expose :dishes, path: 'restaurant.complete_meals'
+
+  def initialize(hash)
+    @hash = hash
+  end
+end
+
+hash = {
+  restaurant: {
+    complete_meals: {
+      dishes: %w[
+        Goulash
+        Spaghetti
+        Pizza
+      ]
+    }
+  }
+}
+
+restaurant = Restaurant.new(hash)
+restaurant.dishes # raises NoMethodError as json method is
+                  # is not defined in Restaurant
+
+Arstotzka.configure { json :@hash }
+
+restaurant.dishes # returns nil as default case is lower_camel
+
+Arstotzka.configure { |c| c.case :snake }
+
+restaurant.dishes # return %s[Goulash Spaghetti Pizza]
+```

data/arstotzka.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_runtime_dependency 'activesupport', '~> 5.x'
-  gem.add_runtime_dependency 'sinclair',      '>= 1.2.1'
+  gem.add_runtime_dependency 'sinclair',      '>= 1.4.0'
 
   gem.add_development_dependency 'bundler',       '~> 1.16.1'
   gem.add_development_dependency 'pry-nav',       '~> 0.2.4'

data/config/yardstick.yml

@@ -24,6 +24,8 @@ rules:
       - Arstotzka::Exception::FetcherBuilderNotFound#attribute
       - Arstotzka::Exception::FetcherBuilderNotFound#klass
       - Arstotzka::Fetcher#options
+      - Arstotzka::Fetcher::Cache#block
+      - Arstotzka::Fetcher::Cache#options
       - Arstotzka::FetcherBuilder#options
       - Arstotzka::KeyReader#base_key
       - Arstotzka::KeyReader#hash
@@ -42,6 +44,9 @@ rules:
       - Arstotzka::Exception::FetcherBuilderNotFound#attribute
       - Arstotzka::Exception::FetcherBuilderNotFound#klass
       - Arstotzka::Fetcher#options
+      - Arstotzka::Fetcher::Cache#block
+      - Arstotzka::Fetcher::Cache#options
+      - Arstotzka::Fetcher::Cache#initialize
       - Arstotzka::FetcherBuilder#options
       - Arstotzka::KeyReader#base_key
       - Arstotzka::KeyReader#hash

data/lib/arstotzka.rb

@@ -164,7 +164,10 @@ require 'sinclair'
 # @see Arstotzka::MethodBuilder
 # @see Arstotzka::ClassMethods
 module Arstotzka
+  require 'arstotzka/config'
+
   extend ActiveSupport::Concern
+  extend Sinclair::Configurable
 
   autoload :Base,           'arstotzka/base'
   autoload :ClassMethods,   'arstotzka/class_methods'
@@ -179,4 +182,6 @@ module Arstotzka
   autoload :Reader,         'arstotzka/reader'
   autoload :TypeCast,       'arstotzka/type_cast'
   autoload :Wrapper,        'arstotzka/wrapper'
+
+  configurable_by Arstotzka::Config
 end

data/lib/arstotzka/base.rb

@@ -18,7 +18,7 @@ module Arstotzka
     # @return [Arstotzka::Options]
     def options=(options)
       @options = if options.is_a?(Hash)
-                   Options.new(options)
+                   Arstotzka.config.options(options)
                  else
                    options
                  end

data/lib/arstotzka/class_methods.rb

@@ -100,8 +100,7 @@ module Arstotzka
     #   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)
-      MethodBuilder.new(attr_names.map(&:to_sym), self, options).build
+      MethodBuilder.new(attr_names.map(&:to_sym), self, options_hash).build
     end
 
     # @private

data/lib/arstotzka/config.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  # @api public
+  #
+  # Arstotzka configuration
+  #
+  # Configuration is
+  #
+  # @see https://www.rubydoc.info/gems/sinclair/1.4.0/Sinclair/Config Sinclair::Config
+  #
+  # @example (see #options)
+  class Config < Sinclair::Config
+    DEFAULT_CONFIGS = {
+      after:      false,
+      after_each: nil,
+      cached:     false,
+      case:       :lower_camel,
+      compact:    false,
+      default:    nil,
+      flatten:    false,
+      json:       :json,
+      klass:      nil,
+      type:       :none
+    }.freeze
+
+    add_configs DEFAULT_CONFIGS
+
+    # @api private
+    #
+    # Returns a new instance of {Options}
+    #
+    # the new instance will have it's values as a merge
+    # from configuration and given options_hash
+    #
+    # @param options_hash [Hash] options override
+    #
+    # @return [Options]
+    #
+    # @example Generating options
+    #   Arstotzka.configure do |config|
+    #     config.case :snake
+    #   end
+    #
+    #   config = Arstotzka.config
+    #   options = config.options(klass: Person)
+    #
+    #   options.to_h
+    #   # returns
+    #   # {
+    #   #   after:      false,
+    #   #   after_each: nil,
+    #   #   cached:     false,
+    #   #   case:       :snake,
+    #   #   compact:    false,
+    #   #   default:    nil,
+    #   #   flatten:    false,
+    #   #   json:       :json,
+    #   #   klass:      Person,
+    #   #   type:       :none
+    #   # }
+    def options(options_hash = {})
+      Options.new(
+        to_hash.symbolize_keys.merge(
+          options_hash.symbolize_keys
+        )
+      )
+    end
+  end
+end

data/lib/arstotzka/fetcher.rb

@@ -8,15 +8,17 @@ module Arstotzka
   class Fetcher
     include Base
 
+    autoload :Cache, 'arstotzka/fetcher/cache'
+
     # Creates an instance of Artotzka::Fetcher
     #
     # @overload iniitalize(options_hash = {})
     #   @param options_hash [Hash] options for {Crawler}, {Wrapper},
-    #   {Reader} and {HashReader}
+    #   {Reader}, {Cache} and {HashReader}
     #
     # @overload iniitalize(options)
     #   @param options [Arstotzka::Options] options for {Crawler}, {Wrapper},
-    #   {Reader} and {HashReader}
+    #   {Reader}, {Cache} and {HashReader}
     def initialize(options_hash = {})
       self.options = options_hash
     end
@@ -82,10 +84,9 @@ module Arstotzka
     #                 #   Transaction.new(value: 50.23, type: 'income')
     #                 # ]
     def fetch
-      value = crawler.value(hash)
-      value.flatten! if flatten && value.is_a?(Array)
-      value = instance.send(after, value) if after
-      value
+      Cache.new(options) do
+        fetch_value
+      end.fetch
     end
 
     # Checks if other equals self
@@ -110,6 +111,20 @@ module Arstotzka
     delegate :wrap, to: :wrapper
     delegate :hash, to: :hash_reader
 
+    # @private
+    #
+    # fetch value from Hash
+    #
+    # Value is fetched trhough the usage of {Crawler},
+    # and wrapped with {Wrapper}
+    #
+    # @return [Object]
+    def fetch_value
+      value = crawler.value(hash)
+      value.flatten! if flatten && value.is_a?(Array)
+      after ? instance.send(after, value) : value
+    end
+
     # @private
     #
     # Returns an instance of Aristotzka::Craler
@@ -131,7 +146,7 @@ module Arstotzka
     #
     # @return [Arstotzka::Wrapper] the wrapper
     def wrapper
-      @wrapper ||= Wrapper.new(options.merge(instance: instance))
+      @wrapper ||= Wrapper.new(options)
     end
 
     # @api private

data/lib/arstotzka/fetcher/cache.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  class Fetcher
+    # @api private
+    #
+    # Class responsible for reading instance variables
+    # when cached option is given.
+    #
+    # When the "cache" is not accepted, block will be called
+    # to determinate the value to be returned also caching
+    # it in an instance variable
+    class Cache
+      include Base
+
+      # @param block [Proc] block to be executed in case
+      #   variable is not cached
+      #
+      # @overload initialize(options, &block)
+      #   @param options [Arstotzka::Options] options passed
+      #   as options object
+      #
+      # @overload initialize(options_hash, &block)
+      #   @param options_hash [Hash] opttions passed as hash
+      def initialize(options_hash = {}, &block)
+        self.options = options_hash
+        @block = block
+      end
+
+      # Fetches value from instance or block
+      #
+      # When cached option is given, fetches value
+      # from cache, and in case of failure, retrieves
+      # value from block given in the initialization
+      #
+      # @yield runs the block given in the initialization
+      #   when the value was not found in the cache
+      #
+      # @return [Object]
+      #
+      # @example Without cache option
+      #   settings = { min: 1, max: 100 }
+      #   instance = Object.new
+      #
+      #   options = Arstotzka::Options.new(
+      #     key: :x, instance: instance
+      #   )
+      #
+      #   cache = Arstotzka::Fetcher::Cache.new do
+      #     (settings[:min]..settings[:max]).sum
+      #   end
+      #
+      #   cache.fetch # returns 5050
+      #   settings[:max] = 10
+      #   cache.fetch # returns 555
+      #
+      # @example With simple cache option
+      #   settings = { calculate: false, min: 1, max: 100 }
+      #   instance = Object.new
+      #
+      #   options = Arstotzka::Options.new(
+      #     key: :x, instance: instance, cached: true
+      #   )
+      #
+      #   cache = Arstotzka::Fetcher::Cache.new do
+      #     if settings[:calculate]
+      #       (settings[:min]..settings[:max]).sum
+      #     end
+      #   end
+      #
+      #   cache.fetch # returns nil (which is not considered cache)
+      #   settings[:calculate] = true
+      #   cache.fetch # returns 5050
+      #   settings[:max] = 10
+      #   cache.fetch # returns 5050 from cache
+      #
+      # @example With full cache option
+      #   settings = { calculate: false, min: 1, max: 100 }
+      #   instance = Object.new
+      #
+      #   options = Arstotzka::Options.new(
+      #     key: :x, instance: instance, cached: :full
+      #   )
+      #
+      #   cache = Arstotzka::Fetcher::Cache.new do
+      #     if settings[:calculate]
+      #       (settings[:min]..settings[:max]).sum
+      #     end
+      #   end
+      #
+      #   cache.fetch # returns nil
+      #   settings[:calculate] = true
+      #   cache.fetch # returns nil from cache
+      def fetch
+        if cached
+          fetch_with_cache
+        else
+          block.call
+        end
+      end
+
+      private
+
+      attr_reader :block, :options
+      delegate :cached, :key, :instance, to: :options
+
+      # @private
+      #
+      # Checks and retrieve value from cache
+      #
+      # when the value is not found in cache,
+      # block is called and it's value is cached
+      # and returned
+      #
+      # @return [Object]
+      def fetch_with_cache
+        if cached?
+          fetch_from_cache
+        else
+          instance.instance_variable_set("@#{key}", block.call)
+        end
+      end
+
+      # @private
+      #
+      # Returns the value from the instance variable (cache)
+      #
+      # the instance variable name is the same name of
+      # options.key (which is the same name of the method
+      # created in the instance by {MethodBuilder}
+      #
+      # @return [Object]
+      def fetch_from_cache
+        instance.instance_variable_get("@#{key}")
+      end
+
+      # @private
+      #
+      # Checks if value is present on cache
+      #
+      # The presence depends on the type of the cache
+      # - +true+ : nil values are considered not cached
+      # - +:full+ : nil instance variables are considered cached
+      #   values
+      def cached?
+        if cached == :full
+          instance.instance_variable_defined?("@#{key}")
+        else
+          instance.instance_variable_get("@#{key}")
+        end
+      end
+    end
+  end
+end