arstotzka 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a4b941b1b173ae1f57c979ab7b58771a675dc297184cecb936c4e3e5854de5c
-  data.tar.gz: 4dcc0ad6c185c423aa7cb9376ebc47f392a9fb7eccb5753f0448817a1337dc10
+  metadata.gz: fc52a24a605aeff67f5a310bf8e6bc7dbe300374ba03678ef4abe68f05ae4f4e
+  data.tar.gz: 37ec2565487d9b560d1da8571b12dc6d562a888366e8d8ecb368089ddbf2cb33
 SHA512:
-  metadata.gz: 55402898468c8a5f593abfba401cf36a76e08771b4b98c6d1240af8224f54d141e13f6c19033befee4a9244289bee3b2aebf0f682a874090162c7fb529aaf63b
-  data.tar.gz: 064e5a70a830ea70ff8d1dc544f36f81ebd88c8ce4df77efad625a1e4d9d67d8b5245b5dc8f851c9fc7ccd8dff5ef7eb9a83ad702556a494ed7084fdae08515f
+  metadata.gz: 995a859fdd57fc6a32cff22aec0ae542b22148de6ab5a16497e62acec94249e7c56e61e39b8ca336ed2383ebae8ec0efee3e8f8d4fd18366795a66cf88ce6baf
+  data.tar.gz: 55376d536beeb947697540cbdd3a8909b17e85d86beb5cde27d0535975ce59380cf49503d3eabbf3e7af7ae51b6eb77d8c1fce6c3dadc3f8c2b2212b65a1ee36

data/README.md

@@ -19,7 +19,7 @@ JSON keys)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/arstotzka/1.3.1
+https://www.rubydoc.info/gems/arstotzka/1.3.2
 
 Instalation
 ---------------

data/config/yardstick.yml

@@ -25,6 +25,9 @@ rules:
       - Arstotzka::Exception::FetcherBuilderNotFound#klass
       - Arstotzka::Fetcher#options
       - Arstotzka::FetcherBuilder#options
+      - Arstotzka::KeyReader#base_key
+      - Arstotzka::KeyReader#hash
+      - Arstotzka::KeyReader#options
       - Arstotzka::HashReader#options
       - Arstotzka::MethodBuilder#attr_names
       - Arstotzka::MethodBuilder#options
@@ -40,6 +43,9 @@ rules:
       - Arstotzka::Exception::FetcherBuilderNotFound#klass
       - Arstotzka::Fetcher#options
       - Arstotzka::FetcherBuilder#options
+      - Arstotzka::KeyReader#base_key
+      - Arstotzka::KeyReader#hash
+      - Arstotzka::KeyReader#options
       - Arstotzka::HashReader#options
       - Arstotzka::MethodBuilder#attr_names
       - Arstotzka::MethodBuilder#options

data/lib/arstotzka.rb

@@ -172,6 +172,7 @@ module Arstotzka
   autoload :Exception,      'arstotzka/exception'
   autoload :Fetcher,        'arstotzka/fetcher'
   autoload :FetcherBuilder, 'arstotzka/fetcher_builder'
+  autoload :KeyReader,      'arstotzka/key_reader'
   autoload :HashReader,     'arstotzka/hash_reader'
   autoload :MethodBuilder,  'arstotzka/method_builder'
   autoload :Options,        'arstotzka/options'

data/lib/arstotzka/key_reader.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Arstotzka
+  # @api private
+  #
+  # Class responsible for reading values from a hash
+  class KeyReader
+    include Base
+
+    # Creates a new instance of Reader
+    #
+    # @param [Hash] hash Hash where the key will be found
+    # @param [String] base_key The key to be checked
+    #   (before case change)
+    def initialize(hash, base_key, options_hash = {})
+      self.options = options_hash
+
+      @hash     = hash
+      @base_key = base_key
+    end
+
+    # Reads value from hash key
+    #
+    # @raise Arstotzka::Exception::KeyNotFound
+    #
+    # @return [Object]
+    #
+    # @example Simple usage
+    #   hash = { theKey: 'value' }
+    #   key  = { 'the_key' }
+    #   reader = Arstotzka::KeyReader.new(hash, key)
+    #
+    #   reader.read # returns 'value'
+    #
+    # @example
+    #   hash = { 'the_key' => 'value' }
+    #   key  = 'TheKey'
+    #   reader = Arstotzka::KeyReader.new(hash, key)
+    #
+    #   reader.read # returns 'value'
+    #
+    def read
+      raise Exception::KeyNotFound unless key?
+
+      hash.key?(key) ? hash[key] : hash[key.to_sym]
+    end
+
+    private
+
+    attr_reader :hash, :base_key, :options
+
+    # @private
+    #
+    # Checks if hash contains or not the key
+    #
+    # The check first happens using String key and,
+    # in case of not found, searches as symbol
+    #
+    # @return [Boolean]
+    #
+    # @see #check_key!
+    def key?
+      return unless hash
+      hash.key?(key) || hash.key?(key.to_sym)
+    end
+
+    # @private
+    #
+    # Transforms the key to have the correct case
+    #
+    # the possible cases (instance attribute) are
+    # - lower_camel: for cammel case with first letter lowercase
+    # - 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
+               when :lower_camel
+                 base_key.camelize(:lower)
+               when :upper_camel
+                 base_key.camelize(:upper)
+               when :snake
+                 base_key.underscore
+               end
+    end
+  end
+end

data/lib/arstotzka/reader.rb

@@ -23,7 +23,7 @@ module Arstotzka
     def initialize(options_hash = {})
       self.options = options_hash
 
-      @keys = options.keys.map(&method(:change_case))
+      @keys = options.keys
     end
 
     # Reads the value of one key in the hash
@@ -63,9 +63,7 @@ module Arstotzka
     def read(hash, index)
       key = keys[index]
 
-      check_key!(hash, key)
-
-      hash.key?(key) ? hash[key] : hash[key.to_sym]
+      KeyReader.new(hash, key, options).read
     end
 
     # @private
@@ -84,61 +82,5 @@ module Arstotzka
 
     # @private
     attr_reader :keys, :options
-
-    # @private
-    #
-    # Checks if a hash contains or not the key
-    #
-    # if the key is not found, an execption is raised
-    #
-    # @raise Arstotzka::Exception::KeyNotFound
-    #
-    # @return [NilClass]
-    #
-    # @see #key?
-    def check_key!(hash, key)
-      return if key?(hash, key)
-      raise Exception::KeyNotFound
-    end
-
-    # @private
-    #
-    # Checks if a hash contains or not the key
-    #
-    # The check first happens using String key and,
-    # in case of not found, searches as symbol
-    #
-    # @param [Hash] hash Hash where the key will be found
-    # @param [String] key The key to be checked
-    #
-    # @return [Boolean]
-    #
-    # @see #check_key!
-    def key?(hash, key)
-      hash&.key?(key) || hash&.key?(key.to_sym)
-    end
-
-    # @private
-    #
-    # Transforms the key to have the correct case
-    #
-    # the possible cases (instance attribute) are
-    # - lower_camel: for cammel case with first letter lowercase
-    # - 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 change_case(key)
-      case options.case
-      when :lower_camel
-        key.camelize(:lower)
-      when :upper_camel
-        key.camelize(:upper)
-      when :snake
-        key.underscore
-      end
-    end
   end
 end

data/lib/arstotzka/version.rb

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::KeyReader do
+  describe 'yard' do
+    describe '#read' do
+      describe 'Simple Usage' do
+        subject(:reader) { described_class.new hash, key }
+
+        let(:key)  { 'the_key' }
+        let(:hash) { { theKey: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+
+      describe 'Specifying snakecase' do
+        subject(:reader) { described_class.new hash, key, case: :snake }
+
+        let(:key)  { 'TheKey' }
+        let(:hash) { { 'the_key' => 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+    end
+  end
+end

data/spec/lib/arstotzka/key_reader_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::KeyReader do
+  subject(:reader) { described_class.new hash, key, options }
+
+  let(:key) { 'key' }
+
+  describe '#read' do
+    context 'when no options are given' do
+      let(:options) { {} }
+
+      context 'when hash keys are symbols' do
+        let(:hash) { { key: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+
+      context 'when hash keys are strings' do
+        let(:hash) { { 'key' => 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+
+      context 'when key is snake_case and hash keys are camelcase' do
+        let(:key)  { 'the_key' }
+        let(:hash) { { theKey: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+    end
+
+    context 'when case options are given' do
+      context 'when key is camelcase and hash keys are snake_case and case option is snake' do
+        let(:options) { { case: :snake } }
+        let(:key)     { 'theKey' }
+        let(:hash)    { { the_key: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+
+      context 'when key is snakecase and hash keys are lower camelcase and case option is lower' do
+        let(:options) { { case: :lower_camel } }
+        let(:key)     { 'the_key' }
+        let(:hash)    { { theKey: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+
+      context 'when key is snakecase and hash keys are upper camelcase and case option is upper' do
+        let(:options) { { case: :upper_camel } }
+        let(:key)     { 'the_key' }
+        let(:hash)    { { TheKey: 'value' } }
+
+        it 'reads the value' do
+          expect(reader.read).to eq('value')
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arstotzka
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Darthjee
@@ -225,6 +225,7 @@ files:
 - lib/arstotzka/fetcher.rb
 - lib/arstotzka/fetcher_builder.rb
 - lib/arstotzka/hash_reader.rb
+- lib/arstotzka/key_reader.rb
 - lib/arstotzka/method_builder.rb
 - lib/arstotzka/options.rb
 - lib/arstotzka/reader.rb
@@ -245,6 +246,7 @@ files:
 - spec/integration/yard/arstotzka/fetcher_builder_spec.rb
 - spec/integration/yard/arstotzka/fetcher_spec.rb
 - spec/integration/yard/arstotzka/hash_reader_spec.rb
+- spec/integration/yard/arstotzka/key_reader_spec.rb
 - spec/integration/yard/arstotzka/method_builder_spec.rb
 - spec/integration/yard/arstotzka/options_spec.rb
 - spec/integration/yard/arstotzka/reader_spec.rb
@@ -255,6 +257,7 @@ files:
 - spec/lib/arstotzka/fetcher_builder_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
 - spec/lib/arstotzka/hash_reader_spec.rb
+- spec/lib/arstotzka/key_reader_spec.rb
 - spec/lib/arstotzka/method_builder_spec.rb
 - spec/lib/arstotzka/options_spec.rb
 - spec/lib/arstotzka/reader_spec.rb
@@ -330,6 +333,7 @@ test_files:
 - spec/integration/yard/arstotzka/fetcher_builder_spec.rb
 - spec/integration/yard/arstotzka/fetcher_spec.rb
 - spec/integration/yard/arstotzka/hash_reader_spec.rb
+- spec/integration/yard/arstotzka/key_reader_spec.rb
 - spec/integration/yard/arstotzka/method_builder_spec.rb
 - spec/integration/yard/arstotzka/options_spec.rb
 - spec/integration/yard/arstotzka/reader_spec.rb
@@ -340,6 +344,7 @@ test_files:
 - spec/lib/arstotzka/fetcher_builder_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
 - spec/lib/arstotzka/hash_reader_spec.rb
+- spec/lib/arstotzka/key_reader_spec.rb
 - spec/lib/arstotzka/method_builder_spec.rb
 - spec/lib/arstotzka/options_spec.rb
 - spec/lib/arstotzka/reader_spec.rb