arstotzka 1.0.4 → 1.1.0

data/spec/lib/arstotzka/crawler_spec.rb

@@ -7,28 +7,28 @@ describe Arstotzka::Crawler do
     described_class.new default_options.merge(options), &block
   end
 
-  let(:block) { proc { |v| v } }
-  let(:path) { '' }
-  let(:default_options) { { path: path, case_type: :lower_camel } }
-  let(:options) { {} }
-  let(:json_file) { 'arstotzka.json' }
-  let(:json) { load_json_fixture_file(json_file) }
-  let(:value) { crawler.value(json) }
+  let(:block)           { proc { |v| v } }
+  let(:keys)            { '' }
+  let(:default_options) { { keys: keys, case: :lower_camel } }
+  let(:options)         { {} }
+  let(:json_file)       { 'arstotzka.json' }
+  let(:json)            { load_json_fixture_file(json_file) }
+  let(:value)           { crawler.value(json) }
 
   context 'when no block is given' do
     subject(:crawler) do
       described_class.new default_options.merge(options)
     end
 
-    let(:path) { %w[user name] }
+    let(:keys) { %w[user name] }
 
     it 'retrieves attribute from base json' do
       expect(value).to eq(json['user']['name'])
     end
   end
 
-  context 'when parsing with a path' do
-    let(:path) { %w[user name] }
+  context 'when parsing with a keys' do
+    let(:keys) { %w[user name] }
 
     it 'retrieves attribute from base json' do
       expect(value).to eq(json['user']['name'])
@@ -44,7 +44,7 @@ describe Arstotzka::Crawler do
   end
 
   context 'when crawler finds a nil attribute' do
-    let(:path) { %w[car model] }
+    let(:keys) { %w[car model] }
 
     it 'returns nil' do
       expect(value).to be_nil
@@ -57,7 +57,7 @@ describe Arstotzka::Crawler do
 
   context 'when there is an array of arrays' do
     let(:json_file) { 'accounts.json' }
-    let(:path) { %w[banks accounts balance] }
+    let(:keys)      { %w[banks accounts balance] }
 
     it 'returns the values as array of arrays' do
       expect(value).to eq([[1000.0, 1500.0], [50.0, -500.0]])
@@ -90,7 +90,7 @@ describe Arstotzka::Crawler do
 
   context 'when json is empty' do
     let(:json) { nil }
-    let(:path) { %w[car model] }
+    let(:keys) { %w[car model] }
 
     it 'returns nil' do
       expect(value).to be_nil
@@ -101,8 +101,8 @@ describe Arstotzka::Crawler do
     end
   end
 
-  context 'with an snake case path' do
-    let(:path) { ['has_money'] }
+  context 'with an snake case keys' do
+    let(:keys) { ['has_money'] }
 
     it 'returns camel cased value' do
       expect(value).to eq(json['hasMoney'])
@@ -110,7 +110,7 @@ describe Arstotzka::Crawler do
   end
 
   context 'when dealing with json inside arrays' do
-    let(:path) { %w[animals race species name] }
+    let(:keys) { %w[animals race species name] }
     let(:expected) do
       ['European squid', 'Macaque monkey', 'Mexican redknee tarantula']
     end
@@ -161,7 +161,7 @@ describe Arstotzka::Crawler do
   context 'with default option' do
     let(:default_value) { 'NotFound' }
     let(:options) { { default: default_value } }
-    let(:path) { %w[projects name] }
+    let(:keys)    { %w[projects name] }
 
     context 'when there is a key missing' do
       it 'returns the default value' do
@@ -183,7 +183,7 @@ describe Arstotzka::Crawler do
 
     context 'when the key is not missing but the value is nil' do
       let(:json_file) { 'person.json' }
-      let(:path) { %w[user name] }
+      let(:keys)      { %w[user name] }
 
       it { expect(value).to be_nil }
 
@@ -202,7 +202,7 @@ describe Arstotzka::Crawler do
 
     context 'when the key last key is missing but the value is nil' do
       let(:json_file) { 'person.json' }
-      let(:path) { %w[user nick_name] }
+      let(:keys)      { %w[user nick_name] }
 
       it 'returns the default value' do
         expect(value).to eq(default_value)
@@ -223,8 +223,8 @@ describe Arstotzka::Crawler do
 
     context 'when the node is missing but default has the same node' do
       let(:default_value) { { node: { value: 1 } } }
-      let(:path) { %w[node node node] }
-      let(:json) { {} }
+      let(:keys)          { %w[node node node] }
+      let(:json)          { {} }
 
       it 'does not crawl through default value' do
         expect(value).to eq(default_value)
@@ -234,8 +234,8 @@ describe Arstotzka::Crawler do
 
   context 'when using a snake case' do
     let(:json) { { snake_cased: 'snake', snakeCased: 'Camel' }.stringify_keys }
-    let(:path) { ['snake_cased'] }
-    let(:options) { { case_type: :snake } }
+    let(:keys)    { ['snake_cased'] }
+    let(:options) { { case: :snake } }
 
     it 'fetches from snake cased fields' do
       expect(value).to eq('snake')
@@ -244,8 +244,8 @@ describe Arstotzka::Crawler do
 
   context 'when using a upper camel case' do
     let(:json) { { UpperCase: 'upper', upperCase: 'lower' }.stringify_keys }
-    let(:path) { ['upper_case'] }
-    let(:options) { { case_type: :upper_camel } }
+    let(:keys)    { ['upper_case'] }
+    let(:options) { { case: :upper_camel } }
 
     it 'fetches from upper camel cased fields' do
       expect(value).to eq('upper')
@@ -254,14 +254,14 @@ describe Arstotzka::Crawler do
 
   context 'when using a symbol keys' do
     let(:json) { load_json_fixture_file('arstotzka.json').symbolize_keys }
-    let(:path) { ['id'] }
+    let(:keys) { ['id'] }
 
     it 'fetches from symbol keys' do
       expect(value).to eq(json[:id])
     end
 
     context 'when crawler finds a nil attribute' do
-      let(:path) { %w[car model] }
+      let(:keys) { %w[car model] }
 
       it 'returns nil' do
         expect(value).to be_nil
@@ -274,7 +274,7 @@ describe Arstotzka::Crawler do
   end
 
   context 'when using key with false value' do
-    let(:path) { ['has_money'] }
+    let(:keys) { ['has_money'] }
 
     before do
       json['hasMoney'] = false

data/spec/lib/arstotzka/fetcher_spec.rb

@@ -7,10 +7,10 @@ describe Arstotzka::Fetcher do
     described_class.new json, instance, options.merge(path: path)
   end
 
-  let(:path) { '' }
+  let(:path)     { '' }
   let(:instance) { Arstotzka::Fetcher::Dummy.new }
-  let(:json) { load_json_fixture_file('arstotzka.json') }
-  let(:value) { fetcher.fetch }
+  let(:json)     { load_json_fixture_file('arstotzka.json') }
+  let(:value)    { fetcher.fetch }
 
   context 'when fetching with no options' do
     let(:options) { {} }
@@ -74,19 +74,19 @@ describe Arstotzka::Fetcher do
 
   describe 'after option' do
     let(:instance) { MyParser.new(json) }
-    let(:json) { [100, 250, -25] }
-    let(:options) { { after: :sum } }
+    let(:json)     { [100, 250, -25] }
+    let(:options)  { { after: :sum } }
 
     it 'applies after call ' do
       expect(fetcher.fetch).to eq(325)
     end
   end
 
-  describe 'clazz options' do
+  describe 'klass options' do
     let(:path) { 'name' }
-    let(:name) { 'Robert' }
-    let(:json) { { name: name } }
-    let(:options) { { clazz: wrapper } }
+    let(:name)    { 'Robert' }
+    let(:json)    { { name: name } }
+    let(:options) { { klass: wrapper } }
     let(:wrapper) { Person }
 
     it 'wraps the result in an object' do

data/spec/lib/arstotzka/options_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka::Options do
+  subject(:options) { described_class.new(options_hash) }
+
+  context 'when initializing without options' do
+    let(:options_hash) { {} }
+
+    describe '#after' do
+      it do
+        expect(options.after).to be_falsey
+      end
+    end
+
+    describe '#cached' do
+      it do
+        expect(options.cached).to be_falsey
+      end
+    end
+
+    describe '#case' do
+      it 'returns default case' do
+        expect(options.case).to eq(:lower_camel)
+      end
+    end
+
+    describe '#compact' do
+      it do
+        expect(options.compact).to be_falsey
+      end
+    end
+
+    describe '#default' do
+      it do
+        expect(options.default).to be_nil
+      end
+    end
+
+    describe '#flatten' do
+      it do
+        expect(options.flatten).to be_falsey
+      end
+    end
+
+    describe '#full_path' do
+      it do
+        expect(options.full_path).to be_nil
+      end
+    end
+
+    describe '#json' do
+      it 'returns default json option' do
+        expect(options.json).to eq(:json)
+      end
+    end
+
+    describe '#klass' do
+      it do
+        expect(options.klass).to be_nil
+      end
+    end
+
+    describe '#path' do
+      it do
+        expect(options.path).to be_nil
+      end
+    end
+
+    describe '#type' do
+      it 'returns none' do
+        expect(options.type).to eq(:none)
+      end
+    end
+  end
+
+  context 'when initializing with options' do
+    let(:options_hash) do
+      {
+        after:     :method_call,
+        cached:    true,
+        case:      :snake,
+        compact:   true,
+        default:   10,
+        flatten:   true,
+        full_path: 'key.sub.fetch',
+        json:      :hash,
+        klass:     Star,
+        path:      'key.sub',
+        type:      :integer
+      }
+    end
+
+    describe '#cached' do
+      it do
+        expect(options.cached).to be_truthy
+      end
+    end
+
+    describe '#after' do
+      it 'returns method name' do
+        expect(options.after).to eq(:method_call)
+      end
+    end
+
+    describe '#case' do
+      it 'returns defined snake case' do
+        expect(options.case).to eq(:snake)
+      end
+    end
+
+    describe '#compact' do
+      it do
+        expect(options.compact).to be_truthy
+      end
+    end
+
+    describe '#default' do
+      it 'returns defined default value' do
+        expect(options.default).to eq(10)
+      end
+    end
+
+    describe '#flatten' do
+      it do
+        expect(options.flatten).to be_truthy
+      end
+    end
+
+    describe '#full_path' do
+      it 'returns defined full path' do
+        expect(options.full_path).to eq('key.sub.fetch')
+      end
+    end
+
+    describe '#json' do
+      it 'returns defined json option' do
+        expect(options.json).to eq(:hash)
+      end
+    end
+
+    describe '#klass' do
+      it 'returns defined class' do
+        expect(options.klass).to eq(Star)
+      end
+    end
+
+    describe '#path' do
+      it 'returns defined path' do
+        expect(options.path).to eq('key.sub')
+      end
+    end
+
+    describe '#type' do
+      it 'returns defined path' do
+        expect(options.type).to eq(:integer)
+      end
+    end
+  end
+
+  describe '#klass' do
+    before do
+      allow_any_instance_of(described_class)
+        .to receive(:warn)
+    end
+
+    context 'when initializing with old class key' do
+      let(:options_hash) { { class: Star } }
+
+      it 'returns the configured class' do
+        expect(options.klass).to eq(Star)
+      end
+
+      it 'raises a warn' do
+        expect(options).to have_received(:warn)
+      end
+    end
+
+    context 'when initializing with old class key and klass' do
+      let(:options_hash) { { class: Star, klass: Game } }
+
+      it 'returns the configured class' do
+        expect(options.klass).to eq(Game)
+      end
+
+      it 'raises a warn' do
+        expect(options).to have_received(:warn)
+      end
+    end
+  end
+
+  describe '#merge' do
+    let(:options_hash) { { json: :hash, default: 10 } }
+
+    it do
+      expect(options.merge(default: 10)).to be_a(described_class)
+    end
+
+    it 'overrides values' do
+      expect(options.merge(default: 10).default).to eq(10)
+    end
+
+    it 'keeps not overriten value' do
+      expect(options.merge(default: 10).json).to eq(:hash)
+    end
+  end
+end

data/spec/lib/arstotzka/reader_spec.rb

@@ -24,16 +24,16 @@ end
 
 describe Arstotzka::Reader do
   subject(:reader) do
-    described_class.new(path: path, case_type: case_type)
+    described_class.new(keys: keys, case: case_type)
   end
 
-  let(:path) { %w[user full_name] }
+  let(:keys)      { %w[user full_name] }
   let(:json_file) { 'complete_person.json' }
   let(:full_json) { load_json_fixture_file(json_file) }
-  let(:json) { full_json }
-  let(:sym_json) { json.symbolize_keys }
+  let(:json)      { full_json }
+  let(:sym_json)  { json.symbolize_keys }
   let(:case_type) { :snake }
-  let(:index) { 0 }
+  let(:index)     { 0 }
 
   describe '#read' do
     context 'when the key is found' do
@@ -41,12 +41,12 @@ describe Arstotzka::Reader do
 
       it_behaves_like 'reader fetchin value'
 
-      context 'when the path case is changed' do
-        let(:json) { full_json['user'] }
+      context 'when the keys case is changed' do
+        let(:json)  { full_json['user'] }
         let(:index) { 1 }
 
         context 'with snake_case type' do
-          let(:path) { %w[user FullName] }
+          let(:keys) { %w[user FullName] }
           let(:expected) { json['full_name'] }
 
           it_behaves_like 'reader fetchin value'
@@ -54,7 +54,7 @@ describe Arstotzka::Reader do
 
         context 'with upper_camel type' do
           let(:case_type) { :upper_camel }
-          let(:path) { %w[user login_name] }
+          let(:keys)     { %w[user login_name] }
           let(:expected) { json['LoginName'] }
 
           it_behaves_like 'reader fetchin value'
@@ -62,7 +62,7 @@ describe Arstotzka::Reader do
 
         context 'with lower_camel type' do
           let(:case_type) { :lower_camel }
-          let(:path) { %w[user birth_date] }
+          let(:keys)     { %w[user birth_date] }
           let(:expected) { json['birthDate'] }
 
           it_behaves_like 'reader fetchin value'
@@ -72,7 +72,7 @@ describe Arstotzka::Reader do
       context 'when key is found but value is null' do
         let(:json) { full_json['user'] }
         let(:index) { 1 }
-        let(:path) { %w[user password_reminder] }
+        let(:keys)  { %w[user password_reminder] }
 
         it do
           expect(reader.read(json, index)).to be_nil
@@ -86,7 +86,7 @@ describe Arstotzka::Reader do
       end
 
       context 'when json has both string and symble' do
-        let(:path) { %w[key] }
+        let(:keys) { %w[key] }
         let(:json) { { key: 'symbol', 'key' => 'string' } }
 
         it 'fetches the string key first' do
@@ -96,7 +96,7 @@ describe Arstotzka::Reader do
     end
 
     context 'when the key is missing' do
-      let(:path) { %w[age] }
+      let(:keys) { %w[age] }
 
       it do
         expect do
@@ -107,13 +107,13 @@ describe Arstotzka::Reader do
   end
 
   describe 'ended?' do
-    context 'when index is within path' do
+    context 'when index is within keys' do
       let(:index) { 1 }
 
       it { expect(reader).not_to be_ended(index) }
     end
 
-    context 'when index is outside path' do
+    context 'when index is outside keys' do
       let(:index) { 2 }
 
       it { expect(reader).to be_ended(index) }

data/spec/lib/arstotzka/wrapper_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe Arstotzka::Wrapper do
   let(:options) { {} }
   let(:subject) { described_class.new options }
-  let(:hash) { { a: 1 } }
+  let(:hash)    { { a: 1 } }
 
   describe '#wrap' do
     let(:value) { hash }
@@ -25,8 +25,8 @@ describe Arstotzka::Wrapper do
       end
     end
 
-    context 'with clazz otpion' do
-      let(:options) { { clazz: OpenStruct } }
+    context 'with klass otpion' do
+      let(:options) { { klass: OpenStruct } }
 
       it 'creates new instance from given class' do
         expect(result).to be_a(OpenStruct)
@@ -50,10 +50,10 @@ describe Arstotzka::Wrapper do
     end
 
     context 'with type otpion' do
-      let(:type) { :integer }
-      let(:value) { '1' }
+      let(:type)    { :integer }
+      let(:value)   { '1' }
       let(:options) { { type: type } }
-      let(:cast) { result }
+      let(:cast)    { result }
 
       it_behaves_like 'casts basic types'
 
@@ -75,8 +75,8 @@ describe Arstotzka::Wrapper do
           expect(result).to be_nil
         end
 
-        context 'when passing clazz parameter' do
-          let(:options) { { type: type, clazz: Arstotzka::Wrapper::Dummy } }
+        context 'when passing klass parameter' do
+          let(:options) { { type: type, klass: Arstotzka::Wrapper::Dummy } }
 
           it do
             expect(result).to be_nil
@@ -92,8 +92,8 @@ describe Arstotzka::Wrapper do
                         float: NilClass,
                         string: String
 
-        context 'when passing clazz parameter' do
-          let(:options) { { type: type, clazz: Arstotzka::Wrapper::Dummy } }
+        context 'when passing klass parameter' do
+          let(:options) { { type: type, klass: Arstotzka::Wrapper::Dummy } }
 
           it_behaves_like 'a result that is type cast',
                           integer: NilClass,
@@ -102,10 +102,10 @@ describe Arstotzka::Wrapper do
         end
       end
 
-      context 'when passing clazz parameter' do
+      context 'when passing klass parameter' do
         let(:value) { 1 }
-        let(:options) { { type: type, clazz: Arstotzka::Wrapper::Dummy } }
-        let(:cast) { result.value }
+        let(:options) { { type: type, klass: Arstotzka::Wrapper::Dummy } }
+        let(:cast)    { result.value }
 
         it_behaves_like 'casts basic types'
 

data/spec/lib/arstotzka_spec.rb

@@ -33,7 +33,7 @@ describe Arstotzka do
   end
 
   context 'when caching the value' do
-    let(:attribute) { :age }
+    let(:attribute)  { :age }
     let!(:old_value) { json['age'] }
 
     before do
@@ -91,7 +91,7 @@ describe Arstotzka do
   end
 
   context 'when wrapping it with a class and caching' do
-    let(:attribute) { :old_house }
+    let(:attribute)  { :old_house }
     let!(:old_value) { json['oldHouse'] }
 
     it 'returns an onject wrap' do

data/spec/support/models/arstotzka/dummy.rb

@@ -9,10 +9,10 @@ module Arstotzka
     expose :name, path: 'user'
     expose :father_name, full_path: 'father.name'
     expose :age, cached: true
-    expose :house, class: ::House
-    expose :old_house, class: ::House, cached: true
-    expose :games, class: ::Game
-    expose :games_filtered, class: ::Game, after: :filter_games, full_path: 'games'
+    expose :house, klass: ::House
+    expose :old_house, klass: ::House, cached: true
+    expose :games, klass: ::Game
+    expose :games_filtered, klass: ::Game, after: :filter_games, full_path: 'games'
 
     def initialize(json)
       @json = json

data/spec/support/models/collector.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './collector/game'
+
 class Collector
   include Arstotzka
 
@@ -14,7 +16,7 @@ class Collector
                      default: 'MissingName',
                      full_path: 'collections.cars.units.nick_name'
   expose :finished_games, json: :hash,
-                          flatten: true, class: Collector::Game,
+                          flatten: true, klass: Collector::Game,
                           after: :filter_finished, compact: true,
                           full_path: 'collections.games.titles'
 

data/spec/support/models/star_gazer.rb

@@ -4,7 +4,7 @@ class StarGazer
   include Arstotzka
 
   expose :favorite_star, full_path: 'universe.star',
-                         default: { name: 'Sun' }, class: ::Star
+                         default: { name: 'Sun' }, klass: ::Star
 
   attr_reader :json
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arstotzka
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,15 +203,18 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/arstotzka.rb
+- lib/arstotzka/base.rb
 - lib/arstotzka/builder.rb
 - lib/arstotzka/class_methods.rb
 - lib/arstotzka/crawler.rb
 - lib/arstotzka/exception.rb
 - lib/arstotzka/fetcher.rb
+- lib/arstotzka/options.rb
 - lib/arstotzka/reader.rb
 - lib/arstotzka/type_cast.rb
 - lib/arstotzka/version.rb
 - lib/arstotzka/wrapper.rb
+- scripts/check_readme.sh
 - spec/fixtures/accounts.json
 - spec/fixtures/accounts_missing.json
 - spec/fixtures/arstotzka.json
@@ -230,6 +233,7 @@ files:
 - spec/lib/arstotzka/builder_spec.rb
 - spec/lib/arstotzka/crawler_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
+- spec/lib/arstotzka/options_spec.rb
 - spec/lib/arstotzka/reader_spec.rb
 - spec/lib/arstotzka/wrapper_spec.rb
 - spec/lib/arstotzka_spec.rb
@@ -298,6 +302,7 @@ test_files:
 - spec/lib/arstotzka/builder_spec.rb
 - spec/lib/arstotzka/crawler_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
+- spec/lib/arstotzka/options_spec.rb
 - spec/lib/arstotzka/reader_spec.rb
 - spec/lib/arstotzka/wrapper_spec.rb
 - spec/lib/arstotzka_spec.rb