arstotzka 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c670a2581e68a1b7e54d5451b6b425fde3cde0db
-  data.tar.gz: 0f2d973a287534f68be841ebcbb63fc0e5f5babb
+  metadata.gz: a819ccb4eab671027d924859a3406ed34c119992
+  data.tar.gz: cb6617c7d4a846b7e7398d0eb68d3cbe9996f24c
 SHA512:
-  metadata.gz: 1826c6c9b9017ce2f302ed930856acb4889eede6a203b25dc1674f1dfe545bae8407acbfaad4cee294782e2afaa11aca50ee39f95700756d6e62ab8cbf18bdc9
-  data.tar.gz: 29f5570b7d161c62069512a9605fde0424c6ac9083ad7dc15d25b6a36e86afe747b6e3ad0abefd1a8d908c86b2b9df34415ea23543d8f2744286a017727ea012
+  metadata.gz: 999acf4da93d2c838bbf8d557f482db6b6bb001ad70ce55235eac8a486ca1f0c91609c0eb7c95f4afe92e3dc120b0e1d14ceffc6eee2b967b99aca10d59b1597
+  data.tar.gz: 5008b64f5c6bd7698ba26e61e8932562f4778a8fa3cd95547aa6a286e5af7cfa3b1177ca7907339b62c10fcdc2b1878818bd394c311f91a22744b5534cc14cdd

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-22 21:24:28 +0000 using RuboCop version 0.58.0.
+# on 2018-07-25 18:12:13 +0000 using RuboCop version 0.58.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,10 +11,3 @@
 Metrics/ParameterLists:
   Exclude:
     - 'lib/arstotzka/builder.rb'
-
-# Offense count: 1
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/arstotzka.rb'

data/README.md

@@ -12,7 +12,9 @@ that tries to crawl through a hash and has to constantly check for nil values or
 also, this concern, like openstruct, allow the json to be manipulated as an object, but
 avoids method missing by aways having the declarated methods, even if that means nil return
 
-Json Parser is also usefull when you need keys case changed or data type cast
+Arstotzka is also usefull when you need keys case changed or data type cast as it was developed
+to be a bridge between a rails application and a Java API (Java APIs use cameCase for
+JSON keys)
 
 Instalation
 ---------------

data/lib/arstotzka.rb

@@ -4,6 +4,163 @@ require 'active_support'
 require 'active_support/all'
 require 'sinclair'
 
+# Concern that enables the translation of domain though the
+# usage of the class method  `expose`
+#
+# @example
+#   json = <<-JSON
+#     {
+#       "person": {
+#         "fullName": "Kelly Khan",
+#         "age": 32,
+#         "gender": "woman"
+#       },
+#       "collections": {
+#         "cars": [{
+#           "maker": "Volkswagen",
+#           "model": "Jetta",
+#           "units": [{
+#             "nickName": "Betty",
+#             "year": 2013
+#           }, {
+#             "nickName": "Roger",
+#             "year": 2014
+#           }]
+#         }, {
+#           "maker": "Ferrari",
+#           "model": "Ferrari X1",
+#           "units": [{
+#             "nickName": "Geronimo",
+#             "year": 2014
+#           }]
+#         }, {
+#           "maker": "Fiat",
+#           "model": "Uno",
+#           "units": [{
+#             "year": 1998
+#           }]
+#         }],
+#         "games":[{
+#           "producer": "Lucas Pope",
+#           "titles": [{
+#             "name": "papers, please",
+#             "played": "10.2%"
+#           }, {
+#             "name": "TheNextBigThing",
+#             "played": "100%"
+#           }]
+#         }, {
+#           "producer": "Nintendo",
+#           "titles": [{
+#             "name": "Zelda",
+#             "played": "90%"
+#           }]
+#         }, {
+#           "producer": "BadCompany"
+#         }]
+#       }
+#     }
+#   JSON
+#
+#   hash = JSON.parse(json)
+#
+# @example
+#   class Collector
+#     include Arstotzka
+#
+#     MALE  = 'male'
+#     FEMALE= 'female'
+#
+#     attr_reader :hash
+#
+#     expose :full_name, :age, path: :person, json: :hash
+#     expose :gender, path: :person, type: :gender, cached: true, json: :hash
+#
+#     def initialize(hash = {})
+#       @hash = hash
+#     end
+#   end
+#
+#   module Arstotzka
+#     module TypeCast
+#       def to_gender(value)
+#         case value
+#         when 'man'
+#           Collector::MALE
+#         when 'woman'
+#           Collector::FEMALE
+#         else
+#           raise 'invalid gender'
+#         end
+#       end
+#     end
+#   end
+#
+#   collector = Collector.new(hash)
+#   collector.full_name # returns 'Kelly Khan'
+#   collector.age       # returns 32
+#   collector.gender    # returns Collector::FEMALE
+#
+#   hash['person']['fullName'] = 'Robert'
+#   collector.full_name # returns 'Robert'
+#
+#   hash['person']['gender'] = 'man'
+#   collector.gender    # returns Collector::FEMALE as it was cached
+#
+# @example
+#   class Collector
+#     expose :car_names, flatten: true, compact: false, json: :hash,
+#            default: 'MissingName',
+#            full_path: 'collections.cars.units.nick_name'
+#   end
+#
+#   collector = Collector.new(hash)
+#   collector.car_names # returns [
+#                       #   'Betty', 'Roger',
+#                       #   'Geronimo', 'MissingName'
+#                       # ]
+#
+# @example
+#   class Collector
+#     class Game
+#       include Arstotzka
+#
+#       attr_reader :json
+#
+#       expose :name
+#       expose :played, type: :float
+#
+#       def initialize(json)
+#         @json = json
+#       end
+#
+#       def finished?
+#         played > 85.0
+#       end
+#     end
+#   end
+#
+#   class Collector
+#     expose :finished_games, json: :hash,
+#            flatten: true, class: Collector::Game,
+#            after: :filter_finished, compact: true,
+#            full_path: 'collections.games.titles'
+#
+#     private
+#
+#     def filter_finished(games)
+#       games.select(&:finished?)
+#     end
+#   end
+#
+#   collector = Collector.new(hash)
+#   collector.finished_games # returns [
+#                            #   Collector::Game.new(name: "TheNextBigThing", played: 100.0),
+#                            #   Collector::Game.new(name: "Zelda", played: 90.0)
+#                            # ]
+#
+# @see Arstotzka::Builder
+# @see Arstotzka::ClassMethods
 module Arstotzka
   extend ActiveSupport::Concern
 

data/lib/arstotzka/builder.rb

@@ -19,12 +19,14 @@ module Arstotzka
   #     'cars' => 2.0
   #   )
   #
-  #   builder = Arstotzka::Builder.new([ :first_name ], MyModel, full_path: 'name.first')
+  #   options = Arstotzka::Builder::DEFAULT_OPTIONS.merge(full_path: 'name.first')
+  #   builder = Arstotzka::Builder.new([ :first_name ], MyModel, options)
   #   builder.build
   #
   #   instance.first_name # returns 'John'
   #
-  #   builder = Arstotzka::Builder.new([ :age, :cars ], MyModel, type: :integer)
+  #   options = Arstotzka::Builder::DEFAULT_OPTIONS.merge(type: :integer)
+  #   builder = Arstotzka::Builder.new([ :age, :cars ], MyModel, options)
   #   builder.build
   #
   #   instance.age  # returns 20
@@ -33,13 +35,16 @@ module Arstotzka
   # @see https://www.rubydoc.info/gems/sinclair Sinclair
   class Builder < Sinclair
     DEFAULT_OPTIONS = {
+      json:     :json,
+      path:     nil,
+      full_path: nil,
+      cached: false,
       after:     false,
       case:      :lower_camel,
       class:     nil,
-      compact:   false,
-      default:   nil,
+      compact: false,
+      default: nil,
       flatten:   false,
-      json:      :json,
       type:      :none
     }.freeze
 
@@ -71,10 +76,8 @@ module Arstotzka
     #   - integer
     #   - string
     #   - float
-    def initialize(attr_names, clazz,
-                   json: :json, path: nil, full_path: nil, cached: false,
-                   **options)
-      super(clazz, DEFAULT_OPTIONS.merge(options.symbolize_keys))
+    def initialize(attr_names, clazz, json:, path:, full_path:, cached:, **options)
+      super(clazz, options)
 
       @attr_names = attr_names
       @path = path

data/lib/arstotzka/class_methods.rb

@@ -35,6 +35,7 @@ module Arstotzka
     #   https://www.rubydoc.info/gems/activesupport/5.0.0.1/ActiveSupport/Concern
     #   ActiveSupport::Concern
     def expose(*attr_names, **options)
+      options = Builder::DEFAULT_OPTIONS.merge(options.symbolize_keys)
       Builder.new(attr_names, self, options).build
     end
   end

data/lib/arstotzka/version.rb

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

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

@@ -5,6 +5,7 @@ require 'spec_helper'
 describe Arstotzka::Builder do
   describe 'yard' do
     let!(:instance) { klass.new(hash) }
+    let(:full_options) { described_class::DEFAULT_OPTIONS.merge(options) }
     let(:hash) do
       {
         'name' => { first: 'John', last: 'Williams' },
@@ -12,10 +13,12 @@ describe Arstotzka::Builder do
         'cars' => 2.0
       }
     end
+    let(:builder) { described_class.new(attributes, klass, full_options) }
 
     describe '#first_name' do
-      let(:klass)    { Class.new(MyModel) }
-      let(:builder)  { described_class.new([:first_name], klass, full_path: 'name.first') }
+      let(:klass)      { Class.new(MyModel) }
+      let(:attributes) { [:first_name] }
+      let(:options)    { { full_path: 'name.first' } }
 
       before do
         builder.build
@@ -27,8 +30,9 @@ describe Arstotzka::Builder do
     end
 
     describe '#age' do
-      let(:klass)    { Class.new(MyModel) }
-      let(:builder)  { described_class.new([:age, 'cars'], klass, type: :integer) }
+      let(:klass)      { Class.new(MyModel) }
+      let(:attributes) { [:age, 'cars'] }
+      let(:options) { { type: :integer } }
 
       before do
         builder.build
@@ -44,8 +48,9 @@ describe Arstotzka::Builder do
     end
 
     describe '#cars' do
-      let(:klass)    { Class.new(MyModel) }
-      let(:builder)  { described_class.new([:age, 'cars'], klass, type: :integer) }
+      let(:klass)      { Class.new(MyModel) }
+      let(:attributes) { [:age, 'cars'] }
+      let(:options) { { type: :integer } }
 
       before do
         builder.build

data/spec/integration/yard/arstotzka_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Arstotzka do
+  describe :yard do
+    subject { Collector.new(hash) }
+
+    let(:hash) { JSON.parse json }
+    let(:json) do
+      <<-JSON
+        {
+          "person": {
+            "fullName": "Kelly Khan",
+            "age": 32,
+            "gender": "woman"
+          },
+          "collections": {
+            "cars": [{
+              "maker": "Volkswagen",
+              "model": "Jetta",
+              "units": [{
+                "nickName": "Betty",
+                "year": 2013
+              }, {
+                "nickName": "Roger",
+                "year": 2014
+              }]
+            }, {
+              "maker": "Ferrari",
+              "model": "Ferrari X1",
+              "units": [{
+                "nickName": "Geronimo",
+                "year": 2014
+              }]
+            }, {
+              "maker": "Fiat",
+              "model": "Uno",
+              "units": [{
+                "year": 1998
+              }]
+            }],
+            "games":[{
+              "producer": "Lucas Pope",
+              "titles": [{
+                "name": "papers, please",
+                "played": "10.2%"
+              }, {
+                "name": "TheNextBigThing",
+                "played": "100%"
+              }]
+            }, {
+              "producer": "Nintendo",
+              "titles": [{
+                "name": "Zelda",
+                "played": "90%"
+              }]
+            }, {
+              "producer": "BadCompany"
+            }]
+          }
+        }
+      JSON
+    end
+
+    describe '#full_name' do
+      it 'returns the full_name' do
+        expect(subject.full_name).to eq('Kelly Khan')
+      end
+
+      it 'does not cache name' do
+        expect do
+          hash['person']['fullName'] = 'Robert'
+        end.to change(subject, :full_name).to('Robert')
+      end
+    end
+
+    describe '#age' do
+      it 'returns the age' do
+        expect(subject.age).to eq(32)
+      end
+    end
+
+    describe '#gender' do
+      it 'returns person gender' do
+        expect(subject.gender).to eq(Collector::FEMALE)
+      end
+
+      it 'does caches gender' do
+        expect do
+          hash['person']['gender'] = 'man'
+        end.not_to change(subject, :gender)
+      end
+    end
+
+    describe '#car_names' do
+      it 'returns the nick names of the cars' do
+        expect(subject.car_names).to eq(%w[Betty Roger Geronimo MissingName])
+      end
+    end
+
+    describe '#finished_games' do
+      it 'returns the finished games' do
+        expected = [
+          Collector::Game.new(name: 'TheNextBigThing', played: 100.0),
+          Collector::Game.new(name: 'Zelda', played: 90.0)
+        ]
+        expect(subject.finished_games).to eq(expected)
+      end
+    end
+  end
+end

data/spec/lib/arstotzka/builder_spec.rb

@@ -12,15 +12,16 @@ describe Arstotzka::Builder do
     end
   end
 
-  let(:options) { {} }
-  let(:name) { 'Robert' }
-  let(:attr_name) { :name }
-  let(:attr_names) { [attr_name] }
-  let(:json) { {} }
-  let(:instance) { clazz.new(json) }
+  let(:options)      { {} }
+  let(:name)         { 'Robert' }
+  let(:attr_name)    { :name }
+  let(:attr_names)   { [attr_name] }
+  let(:json)         { {} }
+  let(:instance)     { clazz.new(json) }
+  let(:full_options) { described_class::DEFAULT_OPTIONS.merge(options) }
 
   subject do
-    described_class.new(attr_names, clazz, **options)
+    described_class.new(attr_names, clazz, **full_options)
   end
 
   describe '#build' do

data/spec/spec_helper.rb

@@ -13,7 +13,6 @@ support_files = File.expand_path('spec/support/**/*.rb')
 Dir[support_files].sort.each { |file| require file }
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.filter_run_excluding :integration unless ENV['ALL']

data/spec/support/models/collector.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Collector
+  include Arstotzka
+
+  MALE = 'male'
+  FEMALE = 'female'
+
+  attr_reader :hash
+
+  expose :full_name, :age, path: :person, json: :hash
+  expose :gender, path: :person, type: :gender, cached: true, json: :hash
+  expose :car_names, flatten: true, compact: false, json: :hash,
+                     default: 'MissingName',
+                     full_path: 'collections.cars.units.nick_name'
+  expose :finished_games, json: :hash,
+                          flatten: true, class: Collector::Game,
+                          after: :filter_finished, compact: true,
+                          full_path: 'collections.games.titles'
+
+  def initialize(hash = {})
+    @hash = hash
+  end
+
+  private
+
+  def filter_finished(games)
+    games.select(&:finished?)
+  end
+end
+
+module Arstotzka
+  module TypeCast
+    def to_gender(value)
+      case value
+      when 'man'
+        Collector::MALE
+      when 'woman'
+        Collector::FEMALE
+      else
+        raise 'invalid gender'
+      end
+    end
+  end
+end

data/spec/support/models/collector/game.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Collector
+  class Game
+    include Arstotzka
+
+    attr_reader :json
+
+    expose :name
+    expose :played, type: :float
+
+    def initialize(json)
+      @json = json
+    end
+
+    def ==(other)
+      return false if other.class != self.class
+      name == other.name && played == other.played
+    end
+
+    def finished?
+      played > 85.0
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arstotzka
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-22 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -193,6 +193,7 @@ files:
 - spec/integration/yard/arstotzka/fetcher_spec.rb
 - spec/integration/yard/arstotzka/reader_spec.rb
 - spec/integration/yard/arstotzka/wrapper_spec.rb
+- spec/integration/yard/arstotzka_spec.rb
 - spec/lib/arstotzka/builder_spec.rb
 - spec/lib/arstotzka/crawler_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
@@ -207,6 +208,8 @@ files:
 - spec/support/models/arstotzka/fetcher/dummy.rb
 - spec/support/models/arstotzka/type_cast.rb
 - spec/support/models/arstotzka/wrapper/dummy.rb
+- spec/support/models/collector.rb
+- spec/support/models/collector/game.rb
 - spec/support/models/game.rb
 - spec/support/models/house.rb
 - spec/support/models/my_model.rb
@@ -253,6 +256,7 @@ test_files:
 - spec/integration/yard/arstotzka/fetcher_spec.rb
 - spec/integration/yard/arstotzka/reader_spec.rb
 - spec/integration/yard/arstotzka/wrapper_spec.rb
+- spec/integration/yard/arstotzka_spec.rb
 - spec/lib/arstotzka/builder_spec.rb
 - spec/lib/arstotzka/crawler_spec.rb
 - spec/lib/arstotzka/fetcher_spec.rb
@@ -267,6 +271,8 @@ test_files:
 - spec/support/models/arstotzka/fetcher/dummy.rb
 - spec/support/models/arstotzka/type_cast.rb
 - spec/support/models/arstotzka/wrapper/dummy.rb
+- spec/support/models/collector.rb
+- spec/support/models/collector/game.rb
 - spec/support/models/game.rb
 - spec/support/models/house.rb
 - spec/support/models/my_model.rb