json_parser 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23023390388f2c93f237ca15e4ac5305ff793322
-  data.tar.gz: '099a4157fc3fd9841d747de641bd3f4a5534f1e6'
+  metadata.gz: 54a56224cff688292d5d7fcedba88d3056155295
+  data.tar.gz: 8ce6c70f4cf77f9c4b9f051a126589958aee78c1
 SHA512:
-  metadata.gz: dd160fd952cd8670ed5bbc50f59e6dadd80e8da0acafc0c18c1ef84ffd1bea3c067329712ad273752928d0985fb4779a7c2256794b6cabc6ea903a138e62ae0a
-  data.tar.gz: b95c9fbe45504f95d2e5e9c8298b105ee2cc572da965b2c1f9c8ef93852e65da2ba49c7ef9c6bf31ec1f7e81df8ab0c18d162cc1ccafcef7ecae57041b413368
+  metadata.gz: afe03643bf563a8c063d59b8f0c87233918a1811feb58eee1549b5006c2ec910c8170761463a6c0756638a2a983d4041ed9968c1ab3af48c49274c6f68b8c099
+  data.tar.gz: 47563cda0362ea10fdf25b3ecf26ef1c370f0cd5ad8161713b7662b3ceede19fa869d0f6face2596bb31efd5490b8e84a1ac11a94e129e81bb501fbf411543dd

data/README.md

@@ -85,8 +85,7 @@ Options
 - type: Type that the value must be cast into ([TypeCast](#typecast))
 - default: Default value (prior to casting and wrapping, see [Default](#default))
 
-TypeCast
---------
+## TypeCast
 The type casting, when the option `type` is passed, is done through the `JsonParser::TypeCast` which can
 be extended
 
@@ -140,8 +139,7 @@ end
 #returns 1050.36
 ```
 
-Default
--------
+## Default
 Default value returned before typecasting or class wrapping
 
 ```ruby

data/lib/json_parser.rb

@@ -5,10 +5,12 @@ require 'sinclair'
 module JsonParser
   extend ActiveSupport::Concern
 
-  autoload :TypeCast,     'json_parser/type_cast'
+  autoload :Builder,      'json_parser/builder'
+  autoload :ClassMethods, 'json_parser/class_methods'
   autoload :Crawler,      'json_parser/crawler'
-  autoload :Wrapper,      'json_parser/wrapper'
+  autoload :Exception,    'json_parser/exception'
   autoload :Fetcher,      'json_parser/fetcher'
-  autoload :ClassMethods, 'json_parser/class_methods'
-  autoload :Builder,      'json_parser/builder'
+  autoload :Reader,       'json_parser/reader'
+  autoload :Wrapper,      'json_parser/wrapper'
+  autoload :TypeCast,     'json_parser/type_cast'
 end

data/lib/json_parser/builder.rb

@@ -1,45 +1,42 @@
 class JsonParser::Builder < Sinclair
 
-  attr_reader :attr_names
+  attr_reader :attr_names, :path, :full_path, :cached
 
-  def initialize(attr_names, clazz, options)
+  def initialize(attr_names, clazz, path: nil, full_path: nil, cached: false, **options)
     super(clazz, {
       after:     false,
-      cached:    false,
       case:      :lower_camel,
       class:     nil,
       compact:   false,
       default:   nil,
       flatten:   false,
-      full_path: nil,
       json:      :json,
-      path:      nil,
       type:      :none
     }.merge(options.symbolize_keys))
 
     @attr_names = attr_names
+    @path = path
+    @full_path = full_path
+    @cached = cached
     init
   end
 
   private
 
-  delegate :path, :full_path, :cached, :compact,
-           :type, :after, to: :options_object
-
   def init
     attr_names.each do |attr|
       add_attr(attr)
     end
   end
 
-  def json_name
-    options[:json]
-  end
-
   def real_path(attribute)
     full_path || [path, attribute].compact.join('.')
   end
 
+  def json_name
+    options[:json]
+  end
+
   def wrapper_clazz
     options[:class]
   end
@@ -48,10 +45,11 @@ class JsonParser::Builder < Sinclair
     options[:case]
   end
 
-  def fetcher_options
+  def fetcher_options(attribute)
     options.slice(:compact, :after, :type, :flatten, :default).merge({
       clazz: wrapper_clazz,
-      case_type: case_type
+      case_type: case_type,
+      path: real_path(attribute)
     })
   end
 
@@ -62,7 +60,7 @@ class JsonParser::Builder < Sinclair
   def attr_fetcher(attribute)
     <<-CODE
       ::JsonParser::Fetcher.new(
-        #{json_name}, '#{real_path(attribute)}', self, #{fetcher_options}
+        #{json_name}, self, #{fetcher_options(attribute)}
       ).fetch
     CODE
   end

data/lib/json_parser/class_methods.rb

@@ -1,10 +1,7 @@
 module JsonParser
   module ClassMethods
-    def json_parse(*attr_names)
-      options = attr_names.extract_options!
-
-      builder = Builder.new(attr_names, self, options)
-      builder.build
+    def json_parse(*attr_names, **options)
+      Builder.new(attr_names, self, options).build
     end
   end
 end

data/lib/json_parser/crawler.rb

@@ -1,52 +1,45 @@
-class JsonParser::Crawler
-  attr_reader :post_process, :path, :case_type, :compact, :default
-
-  def initialize(path, case_type: :lower_camel, compact: false, default: nil, &block)
-    @case_type = case_type
-    @compact = compact
-    @default = default
-    @path = path.map { |p| change_case(p) }
-    @post_process = block
-  end
-
-  def crawl(json, index = 0)
-    return wrap(json) if is_ended?(index)
-    return crawl_array(json, index) if json.is_a? Array
+module JsonParser
+  class Crawler
+    attr_reader :post_process, :path, :case_type, :compact, :default
+
+    def initialize(path:, case_type: :lower_camel, compact: false, default: nil, &block)
+      @case_type = case_type
+      @compact = compact
+      @default = default
+      @path = path
+      @post_process = block
+    end
 
-    crawl(fetch(json, index), index + 1)
-  rescue NoMethodError
-    wrap(default)
-  end
+    def value(json, index = 0)
+      crawl(json, index)
+    rescue Exception::KeyNotFound
+      wrap(default)
+    end
 
-  private
+    private
 
-  def fetch(json, index)
-    key = path[index]
-    json.key?(key) ? json[key] : json[key.to_sym]
-  end
+    def crawl(json, index = 0)
+      return wrap(json) if reader.is_ended?(index)
+      return crawl_array(json, index) if json.is_a?(Array)
 
-  def is_ended?(index)
-    index >= path.size
-  end
+      crawl(reader.read(json, index), index + 1)
+    end
 
-  def wrap(json)
-    post_process.call(json)
-  end
+    def reader
+      @reader ||= JsonParser::Reader.new(
+        path: path,
+        case_type: case_type
+      )
+    end
 
-  def change_case(key)
-    case case_type
-    when :lower_camel
-      key.camelize(:lower)
-    when :upper_camel
-      key.camelize(:upper)
-    when :snake
-      key.underscore
+    def wrap(json)
+      post_process.call(json)
     end
-  end
 
-  def crawl_array(array, index)
-    array.map { |j| crawl(j, index) }.tap do |a|
-      a.compact! if compact
+    def crawl_array(array, index)
+      array.map { |j| value(j, index) }.tap do |a|
+        a.compact! if compact
+      end
     end
   end
 end

data/lib/json_parser/exception.rb

@@ -0,0 +1,3 @@
+module JsonParser::Exception
+  class KeyNotFound < StandardError; end
+end

data/lib/json_parser/fetcher.rb

@@ -5,9 +5,8 @@ class JsonParser::Fetcher
 
   delegate :after, :flatten, to: :options_object
   delegate :wrap, to: :wrapper
-  delegate :crawl, to: :crawler
 
-  def initialize(json, path, instance, options = {})
+  def initialize(json, instance, path:, **options)
     @path = path.to_s.split('.')
     @json = json
     @instance = instance
@@ -15,7 +14,7 @@ class JsonParser::Fetcher
   end
 
   def fetch
-    value = crawl(json)
+    value = crawler.value(json)
     value.flatten! if flatten && value.respond_to?(:flatten!)
     value = instance.send(after, value) if after
     value
@@ -28,13 +27,13 @@ class JsonParser::Fetcher
   end
 
   def buidl_crawler
-    JsonParser::Crawler.new(path, crawler_options) do |value|
+    JsonParser::Crawler.new(crawler_options) do |value|
       wrap(value)
     end
   end
 
   def crawler_options
-    options.slice(:case_type, :compact, :default)
+    options.slice(:case_type, :compact, :default).merge(path: path)
   end
 
   def wrapper

data/lib/json_parser/reader.rb

@@ -0,0 +1,44 @@
+module JsonParser
+  class Reader
+    attr_reader :path, :case_type
+
+    def initialize(path:, case_type:)
+      @case_type = case_type
+      @path = path.map(&self.method(:change_case))
+    end
+
+    def read(json, index)
+      key = path[index]
+
+      check_key!(json, key)
+
+      json.key?(key) ? json[key] : json[key.to_sym]
+    end
+
+    def is_ended?(index)
+      index >= path.size
+    end
+
+    private
+
+    def check_key!(json, key)
+      return if has_key?(json, key)
+      raise Exception::KeyNotFound
+    end
+
+    def has_key?(json, key)
+      json&.key?(key) || json&.key?(key.to_sym)
+    end
+
+    def change_case(key)
+      case case_type
+      when :lower_camel
+        key.camelize(:lower)
+      when :upper_camel
+        key.camelize(:upper)
+      when :snake
+        key.underscore
+      end
+    end
+  end
+end

data/lib/json_parser/version.rb

@@ -1,3 +1,3 @@
 module JsonParser
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

data/spec/fixtures/accounts_missing.json

@@ -8,6 +8,9 @@
           "balance": 1000.00
         }, {
           "type": "checking"
+        }, {
+          "type": "investiment",
+          "balance": null
         }
       ]
     }, {

data/spec/fixtures/complete_person.json

@@ -0,0 +1,9 @@
+{
+  "user": {
+    "name": "Robert",
+    "full_name": "Robert Smith",
+    "LoginName": "robsmith",
+    "birthDate": "03/07/1980",
+    "password_reminder": null
+  }
+}

data/spec/lib/json_parser/builder_spec.rb

@@ -18,7 +18,7 @@ describe JsonParser::Builder do
   let(:instance) { clazz.new(json) }
 
   subject do
-    described_class.new(attr_names, clazz, options)
+    described_class.new(attr_names, clazz, **options)
   end
 
   describe '#build' do
@@ -79,14 +79,6 @@ describe JsonParser::Builder do
           it 'fetches the value within the json' do
             expect(instance.the_name).to eq(name)
           end
-
-          context 'when option key is a string' do
-            let(:options) { { 'full_path' => 'user.name' } }
-
-            it 'fetches the value within the json' do
-              expect(instance.the_name).to eq(name)
-            end
-          end
         end
       end
 
@@ -102,14 +94,6 @@ describe JsonParser::Builder do
         it 'fills the new instance with the information fetched' do
           expect(instance.person.name).to eq(name)
         end
-
-        context 'when option key is a string' do
-          let(:options) { { 'class' => Person } }
-
-          it 'fills the new instance with the information fetched' do
-            expect(instance.person.name).to eq(name)
-          end
-        end
       end
     end
   end

data/spec/lib/json_parser/crawler_spec.rb

@@ -2,15 +2,15 @@ require 'spec_helper'
 
 describe JsonParser::Crawler do
   let(:subject) do
-    described_class.new path, default_options.merge(options), &block
+    described_class.new default_options.merge(options), &block
   end
   let(:block) { proc { |v| v } }
   let(:path) { '' }
-  let(:default_options) { { case_type: :lower_camel} }
+  let(:default_options) { { path: path, case_type: :lower_camel} }
   let(:options) { {} }
   let(:json_file) { 'json_parser.json' }
   let(:json) { load_json_fixture_file(json_file) }
-  let(:value) { subject.crawl(json) }
+  let(:value) { subject.value(json) }
 
   context 'when parsing with a path' do
     let(:path) { %w(user name) }
@@ -20,7 +20,7 @@ describe JsonParser::Crawler do
     end
 
     context 'when calling twice' do
-      before { subject.crawl(json) }
+      before { subject.value(json) }
 
       it 'can still crawl' do
         expect(value).to eq(json['user']['name'])
@@ -52,14 +52,14 @@ describe JsonParser::Crawler do
       let(:json_file) { 'accounts_missing.json' }
 
       it 'returns the missing values as nil' do
-        expect(value).to eq([[1000.0, nil], nil, nil])
+        expect(value).to eq([[1000.0, nil, nil], nil, nil])
       end
 
       context 'when setting a default' do
         let(:options) { { default: 10 } }
 
         it 'returns the missing values as default' do
-          expect(value).to eq([[1000.0, nil], 10, 10])
+          expect(value).to eq([[1000.0, 10, nil], 10, 10])
         end
       end
 
@@ -180,6 +180,27 @@ describe JsonParser::Crawler do
       end
     end
 
+    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) }
+
+      it 'returns the default value' do
+        expect(value).to eq(default_value)
+      end
+
+      context 'when wrapping it with a class' do
+        let(:block) { proc { |v| Person.new(v) } }
+
+        it 'wrap it with the class' do
+          expect(value).to be_a(Person)
+        end
+
+        it 'wraps the default value' do
+          expect(value.name).to eq(default_value)
+        end
+      end
+    end
+
     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) }

data/spec/lib/json_parser/fetcher_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe JsonParser::Fetcher do
   let(:subject) do
-    described_class.new json, path, instance, options
+    described_class.new json, instance, options.merge(path: path)
   end
   let(:path) { '' }
   let(:instance) { JsonParser::Fetcher::Dummy.new }

data/spec/lib/json_parser/reader_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+shared_examples 'reader fetchin value' do
+  it do
+    expect { subject.read(json, index) }.not_to raise_error
+  end
+
+  it do
+    expect(subject.read(json, index)).not_to be_nil
+  end
+
+  it 'returns the evaluated value' do
+    expect(subject.read(json, index)).to eq(expected)
+  end
+
+  context 'and the json has symbolized_keys' do
+    it 'returns the evaluated value' do
+      expect(subject.read(sym_json, index)).to eq(expected)
+    end
+  end
+end
+
+describe JsonParser::Reader do
+  subject do
+    described_class.new(path: path, case_type: case_type)
+  end
+
+  let(:path) { %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(:case_type) { :snake }
+  let(:index) { 0 }
+
+  describe '#read' do
+    context 'when the key is found' do
+      let(:expected) { json['user'] }
+
+      it_behaves_like 'reader fetchin value'
+
+      context 'when the path case is changed' do
+        let(:json) { full_json['user'] }
+        let(:index) { 1 }
+
+        context 'to snake_case' do
+          let(:path) { %w(user FullName) }
+          let(:expected) { json['full_name'] }
+
+          it_behaves_like 'reader fetchin value'
+        end
+
+        context 'to upper_camel' do
+          let(:case_type) { :upper_camel }
+          let(:path) { %w(user login_name) }
+          let(:expected) { json['LoginName'] }
+
+          it_behaves_like 'reader fetchin value'
+        end
+
+        context 'to lower_camel' do
+          let(:case_type) { :lower_camel }
+          let(:path) { %w(user birth_date) }
+          let(:expected) { json['birthDate'] }
+
+          it_behaves_like 'reader fetchin value'
+        end
+      end
+
+      context 'when key is found but value is null' do
+        let(:json) { full_json['user'] }
+        let(:index) { 1 }
+        let(:path) { %w(user password_reminder) }
+
+        it do
+          expect(subject.read(json, index)).to be_nil
+        end
+
+        context 'but keys are symbol' do
+          it do
+            expect(subject.read(sym_json, index)).to be_nil
+          end
+        end
+      end
+
+      context 'when json has both string and symble' do
+        let(:path) { %w(key) }
+        let(:json) { { key: 'symbol', 'key' => 'string' } }
+
+        it 'fetches the string key first' do
+          expect(subject.read(json, index)).to eq('string')
+        end
+      end
+    end
+
+    context 'when the key is missing' do
+      let(:path) { %w(age) }
+
+      it do
+        expect do
+          subject.read(json, index)
+        end.to raise_error(JsonParser::Exception::KeyNotFound)
+      end
+    end
+  end
+
+  describe 'is_ended?' do
+    context 'when index is within path' do
+      let(:index) { 1 }
+
+      it { expect(subject.is_ended?(index)).to be_falsey }
+    end
+
+    context 'when index is outside path' do
+      let(:index) { 2 }
+
+      it { expect(subject.is_ended?(index)).to be_truthy }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_parser
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Bidu Dev's Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-31 00:00:00.000000000 Z
+date: 2018-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,12 +143,15 @@ files:
 - lib/json_parser/builder.rb
 - lib/json_parser/class_methods.rb
 - lib/json_parser/crawler.rb
+- lib/json_parser/exception.rb
 - lib/json_parser/fetcher.rb
+- lib/json_parser/reader.rb
 - lib/json_parser/type_cast.rb
 - lib/json_parser/version.rb
 - lib/json_parser/wrapper.rb
 - spec/fixtures/accounts.json
 - spec/fixtures/accounts_missing.json
+- spec/fixtures/complete_person.json
 - spec/fixtures/json_parser.json
 - spec/fixtures/person.json
 - spec/integration/readme/default_spec.rb
@@ -156,6 +159,7 @@ files:
 - spec/lib/json_parser/builder_spec.rb
 - spec/lib/json_parser/crawler_spec.rb
 - spec/lib/json_parser/fetcher_spec.rb
+- spec/lib/json_parser/reader_spec.rb
 - spec/lib/json_parser/wrapper_spec.rb
 - spec/lib/json_parser_spec.rb
 - spec/spec_helper.rb
@@ -198,6 +202,7 @@ summary: Json Parser
 test_files:
 - spec/fixtures/accounts.json
 - spec/fixtures/accounts_missing.json
+- spec/fixtures/complete_person.json
 - spec/fixtures/json_parser.json
 - spec/fixtures/person.json
 - spec/integration/readme/default_spec.rb
@@ -205,6 +210,7 @@ test_files:
 - spec/lib/json_parser/builder_spec.rb
 - spec/lib/json_parser/crawler_spec.rb
 - spec/lib/json_parser/fetcher_spec.rb
+- spec/lib/json_parser/reader_spec.rb
 - spec/lib/json_parser/wrapper_spec.rb
 - spec/lib/json_parser_spec.rb
 - spec/spec_helper.rb