json_parser 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa3db49e4e788b1d0842fc1a76177a420dddea7a
-  data.tar.gz: 2e53eee8b60b49d2c789adc5da2aa415b83528c9
+  metadata.gz: e1c0ec98b84cd4dbc53f82baaa96fc9afd618e38
+  data.tar.gz: 78537b728d6fa5882fa5c269a275e1b7ab7814ea
 SHA512:
-  metadata.gz: c501a429649f8578db081111b1db7d07475f31645764277aed8f02ec834cece16b739fe5f5769ec41dfe46c02cd58db7e147fcf361a82114f616fa60b04c7264
-  data.tar.gz: bdf68e4a5fb504178908b51bbc992028b0442c4f9009db32c1e85c6f9de29cc13aeb676529e07c9937691708b150364a094dfc9316e959b4c6807cafc5520a56
+  metadata.gz: f6d2d5d2de986c62f3756c508b315d2406925f67f77d76e66c40d69304a386dc52392c10928a9e2360ea7db3143929e8bc0c3c327814f1a3f3f3761a60d44b42
+  data.tar.gz: a8dd328d05d745eec9a79ba26fdd5978aff4fe9c831164e0cddfeccf961ba3851f629702ea683bb58c0470fe48b45a2b503406e489aac021e4ca9cb1a21426f6

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    json_parser (1.0.0)
+    json_parser (1.1.0)
       activesupport
+      concern_builder
 
 GEM
   remote: https://rubygems.org/
@@ -13,6 +14,8 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    concern_builder (0.0.1)
+      activesupport
     diff-lcs (1.2.5)
     docile (1.1.5)
     i18n (0.7.0)

data/README.md

@@ -1,2 +1,52 @@
-# json_parser
-Hash/Json Parser 
+Json Parser
+========
+
+This project allows for a quick hash / json data fetching in order to avoid code
+that tries to crawl through a hash and has to constantly check for nil values or missing keys
+
+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
+
+Getting started
+---------------
+1. Add JsonParser to your `Gemfile` and `bundle install`:
+
+    ```ruby
+    gem 'json_parser'
+    ```
+
+2. Include in a class that you want to wrap a json/hash
+  ```ruby
+  class Parser
+    include JsonParser
+
+    attr_reader :json
+
+    def initialize(json)
+      @json = json
+    end
+  end
+  ```
+
+3. Declare the keys you want to crawl
+  ```ruby
+  class Parser
+    json_parse :id, :dog_name, cached: true
+    json_parse :age, type: :integer
+  end
+  ```
+
+Options
+-------
+- path: path where to find the sub hash that contains the key (empty by default)
+- json: method that contains the hash to be parsed (json by default)
+- full_path: full path to fetch the value (empty by default)
+- cached: indicator that once the value has been fetched, it should be cached (false by default)
+- class: class to be used when wrapping the final value
+- compact: indicator telling to ignore nil values inside array (false by default)
+- flatten: indicator telling that to flattern the resulting array (false by default)
+- after: name of a method to be called after with the resulting value
+- case: case of the keys from the json (camel by default)
+- type: Type that the value must be cast into

data/json_parser.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'concern_builder'
 
   spec.add_development_dependency 'safe_attribute_assignment'
   spec.add_development_dependency "bundler", "~> 1.6"

data/lib/json_parser.rb

@@ -1,11 +1,11 @@
 require 'active_support'
 require 'active_support/all'
+require 'concern_builder'
 
 module JsonParser
   extend ActiveSupport::Concern
 
-  require 'concerns/type_cast'
-  require 'concerns/options_parser'
+  require 'json_parser/type_cast'
   require 'json_parser/version'
   require 'json_parser/crawler'
   require 'json_parser/wrapper'

data/lib/json_parser/class_methods/builder.rb

@@ -1,24 +1,7 @@
-class JsonParser::ClassMethods::Builder
-  include OptionsParser
-
-  attr_reader :attr_names, :methods_def
+class JsonParser::ClassMethods::Builder < ConcernBuilder
 
   delegate :path, :cached, :compact, :type, :after, to: :options_object
 
-  def initialize(attr_names, instance, options)
-    @attr_names = attr_names
-    @instance = instance
-    @options = options
-    @methods_def = []
-    init
-  end
-
-  def build
-    methods_def.each do |method_def|
-      @instance.module_eval(method_def, __FILE__, __LINE__ + 1)
-    end
-  end
-
   private
 
   def init

data/lib/json_parser/crawler.rb

@@ -1,5 +1,5 @@
 class JsonParser::Crawler
-  include OptionsParser
+  include ConcernBuilder::OptionsParser
 
   attr_reader :post_process, :path
 

data/lib/json_parser/fetcher.rb

@@ -1,5 +1,5 @@
 class JsonParser::Fetcher
-  include OptionsParser
+  include ConcernBuilder::OptionsParser
 
   attr_reader :path, :json, :instance
 

data/lib/{concerns → json_parser}/type_cast.rb

@@ -1,4 +1,4 @@
-module TypeCast
+module JsonParser::TypeCast
   extend ActiveSupport::Concern
 
   def to_integer(value)

data/lib/json_parser/version.rb

@@ -1,3 +1,3 @@
 module JsonParser
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/json_parser/wrapper.rb

@@ -1,6 +1,6 @@
 class JsonParser::Wrapper
-  include OptionsParser
-  include TypeCast
+  include ConcernBuilder::OptionsParser
+  include JsonParser::TypeCast
 
   delegate :clazz, :type, to: :options_object
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bidu Dev's Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concern_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: safe_attribute_assignment
   requirement: !ruby/object:Gem::Requirement
@@ -110,13 +124,12 @@ files:
 - README.md
 - Rakefile
 - json_parser.gemspec
-- lib/concerns/options_parser.rb
-- lib/concerns/type_cast.rb
 - lib/json_parser.rb
 - lib/json_parser/class_methods.rb
 - lib/json_parser/class_methods/builder.rb
 - lib/json_parser/crawler.rb
 - lib/json_parser/fetcher.rb
+- lib/json_parser/type_cast.rb
 - lib/json_parser/version.rb
 - lib/json_parser/wrapper.rb
 - spec/fixtures/json_parser.json

data/lib/concerns/options_parser.rb

@@ -1,9 +0,0 @@
-module OptionsParser
-  extend ActiveSupport::Concern
-
-  attr_reader :options
-
-  def options_object
-    @options_object ||= OpenStruct.new options
-  end
-end