add json parser #140
add json parser #140
Conversation
| module Decanter | ||
| module Parser | ||
| class JsonParser < ValueParser | ||
|
|
There was a problem hiding this comment.
Since json is not a native Ruby data type, there is no specific allowed types. Instead all values passed to this parser will be parsed by JSON.parse(val), unless they are nil or blank strings.
| class JsonParser < ValueParser | ||
|
|
||
| parser do |val, options| | ||
| raise Decanter::ParseError.new 'Expects a JSON string' if val.is_a?(Array) || val.is_a?(Hash) |
There was a problem hiding this comment.
JSON.parse only accepts string type as an argument
There was a problem hiding this comment.
Forgive my ignorance here – does ActiveRecord require that the input to create/update is a hash? Or will it accept a serialized JSON string?
There was a problem hiding this comment.
What's the benefit of checking for an Array or a Hash as opposed to is_a? String?
There was a problem hiding this comment.
-
I'm having a hard time finding exact documentation, but I don't think there is a specific requirement for it to be hash. Mainly because JSON can be an array, hash, string
-
I think I had it this way just for readability as to avoid
unless, but looking at it again I'm not sure that's any more readable. I think I'll change it tounless is_a? String
This line in particular is difficult since JSON can be many things. I almost decided to remove this entirely, but wanted to keep some error message here. I could make an argument for having no error message here, but that felt wrong?
I leaned into the fact the client will send it as a string, I will check that, and then the code on line 8 will parse it to become a JSON object for Rails to use
There was a problem hiding this comment.
From some quick testing in the console, it looks like JSON.parse throws an error for anything that's not a string (including booleans, integers, etc).
Because of that, to me the most readable option seems like unless is_a? String, but I also wonder if a readable alternative could be rescuing from a JSON.parse error to tell the dev that the value is not valid JSON.
lib/decanter/version.rb
Outdated
| @@ -1,3 +1,3 @@ | |||
| module Decanter | |||
| VERSION = '4.0.1'.freeze | |||
| VERSION = '4.0.2'.freeze | |||
There was a problem hiding this comment.
Not 100% sure on versioning semantics for minor feature. I suppose this could be 4.1?
There was a problem hiding this comment.
This is a backwards compatible feature, which warrants a minor bump (i.e., 4.1.0)
|
I had trouble updating the versioning for this. I updated |
| @@ -0,0 +1,12 @@ | |||
| module Decanter | |||
| module Parser | |||
| class JsonParser < ValueParser | |||
There was a problem hiding this comment.
I believe this should inherit from HashParser
See https://github.com/LaunchPadLab/decanter#custom-parser-base-classes
There was a problem hiding this comment.
Ah, that doesn't account for the fact that it could be an array. NVM!
There was a problem hiding this comment.
Yea it turns out that JSON is anything lol
| class JsonParser < ValueParser | ||
|
|
||
| parser do |val, options| | ||
| raise Decanter::ParseError.new 'Expects a JSON string' if val.is_a?(Array) || val.is_a?(Hash) |
There was a problem hiding this comment.
What's the benefit of checking for an Array or a Hash as opposed to is_a? String?
Items Addressed
jsonto be passed to Decanter without a custom parser.jsonorjsonbjsonblob data sent over from UI to a Rails JSON API. It is column specific.Author Checklist
version.rbfollowing versioning guidelines