json_schematize 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cba47a2b20c23bb096ad36a9f71c0ebb8608da8b5ecf42746dcb7c1c223b4aeb
-  data.tar.gz: 227345574280f3dc5de25990b600976393e2bb6f970370b90cf00d1a371913e4
+  metadata.gz: 545006e10e9c73489b4a2db37d7b787a49c4427dd58d541ac938bad4c73954ce
+  data.tar.gz: 38f4d89c9cb2ffc8b9863531d8745eae5acd2b2bc1379ea6e9f459d66550525e
 SHA512:
-  metadata.gz: d53863642a7b6b1fec0e22917508ee6c9a0a8a6452ea36955f3d8349878edf42487d267978d4175f3da72b0fc87651b66f4f4a28a3c1a98b7cc8c61858b0eb1e
-  data.tar.gz: 639c2eabdcabb64fbbcc89aa83e8e6f9e314424d2bcc31a44b710aef887e98fda3a2120edae8952c2ff3d34caacbaf450a5a40ed06417397d68743c7883c9a60
+  metadata.gz: d640bd68de88a3e6e3b4a73fd8688e9c017bbb8948a73abb3a2f4bf36a87c3ba1bd31bb08f052b8fd36bca9a7758f825f32448ae39930610eaae7323ccd336fb
+  data.tar.gz: 344f9dd96df21d5b5f8f8b6daca078281403606c5b75dcc958d999186380e83a56ddb592f071b271656882ad9d4a117ce7211ca050cb901e4f57fbb90fe2355e

data/.circleci/config.yml

@@ -182,8 +182,8 @@ workflows:
       - publish-rubygems:
           requires:
             - required-matrix-tests
-      #     filters:
-      #       branches:
-      #         only:
-      #           - main
+          filters:
+            branches:
+              only:
+                - main
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json_schematize (0.1.0)
+    json_schematize (0.3.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -85,7 +85,14 @@ required -- Default is true. When not set, each instance class can optionally de
 converter -- Proc return is set to the field value. No furter validation is done. Given (value) as a parameter
 array_of_types -- Detailed example above. Set this value to true when the dig param is to an array and you want all values in array to be parsed the given type
 ```
+### Custom Classes
 
+```ruby
+class CustomClasses < JsonSchematize::Generator
+  # JsonSchematize::Boolean can be used as a type when expecting a conversion of possible true or false values converted into a TrueClass or FalseClass
+  add_field name: :internals, type: JsonSchematize::Boolean
+end
+```
 
 ## Development
 

data/json_schematize.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Matt Taylor"]
   spec.email   = ["mattius.taylor@gmail.com"]
 
-  spec.summary     = "Describe the gem here"
-  spec.description = "Describe the gem here"
+  spec.summary     = "This gem gives you the ability to turn API results into a standardized schema's that can be easily grocked"
+  spec.description = "Take standardized API results and turn them into a Schema"
   spec.homepage    = "https://github.com/matt-taylor/json_schematize"
   spec.license     = "MIT"
 

data/lib/json_schematize/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class JsonSchematize::Base
+  def self.acceptable_types
+    raise NoMethodError, "Expected acceptable_values to be defined in parent class"
+  end
+end

data/lib/json_schematize/boolean.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "json_schematize/base"
+
+class JsonSchematize::Boolean < JsonSchematize::Base
+  FALSE_VALUES = ["false", "f", "0", false]
+  TRUE_VALUES = ["true", "t", "1", true]
+
+  def self.new(val)
+    return false if FALSE_VALUES.include?(val)
+    return true if TRUE_VALUES.include?(val)
+
+    raise JsonSchematize::UndefinedBoolean, "#{val} is not a valid #{self.class}"
+  end
+
+  def self.acceptable_types
+    [TrueClass, FalseClass]
+  end
+end

data/lib/json_schematize/field.rb

@@ -36,9 +36,9 @@ class JsonSchematize::Field
 
   def acceptable_value?(transformed_value:, raise_on_error:)
     if array_of_types
-      boolean = transformed_value.all? { |val| @acceptable_types.include?(val.class) }
+      boolean = transformed_value.all? { |val| validate_acceptable_types(val: val) }
     else
-      boolean = @acceptable_types.include?(transformed_value.class)
+      boolean = validate_acceptable_types(val: transformed_value)
     end
 
     if raise_on_error && (boolean==false)
@@ -77,6 +77,18 @@ class JsonSchematize::Field
 
   private
 
+  def validate_acceptable_types(val:)
+    (all_allowed_types + @acceptable_types).include?(val.class)
+  end
+
+  def all_allowed_types
+    @all_allowed_types ||= begin
+      @acceptable_types.map do |t|
+        t.acceptable_types if t.ancestors.include?(JsonSchematize::Base)
+      end.compact.flatten
+    end
+  end
+
   def iterate_array_of_types(value:)
     return raw_converter_call(value: value) unless array_of_types
 

data/lib/json_schematize/generator.rb

@@ -67,9 +67,9 @@ class JsonSchematize::Generator
 
   attr_reader :__raw_params, :raise_on_error
 
-
-  def initialize(raise_on_error: true, **params)
-    @__params = params
+  # stringified_params allows for params with stringed keys
+  def initialize(stringified_params = {}, raise_on_error: true, **params)
+    @__params = stringified_params.empty? ? params : stringified_params
     @raise_on_error = raise_on_error
 
     validate_required!

data/lib/json_schematize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonSchematize
-  VERSION = "0.1.0"
+  VERSION = "0.3.1"
 end

data/lib/json_schematize.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require "json_schematize/version"
+require "json_schematize/base"
+require "json_schematize/boolean"
 require "json_schematize/generator"
+require "json_schematize/version"
 
 module JsonSchematize
   class Error < StandardError; end
@@ -10,4 +12,7 @@ module JsonSchematize
   class InvalidFieldByValidator < InvalidField; end
   class InvalidFieldByType < InvalidField; end
   class InvalidFieldByArrayOfTypes < InvalidField; end
+
+  ## Customized class errors
+  class UndefinedBoolean < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schematize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.0
-description: Describe the gem here
+description: Take standardized API results and turn them into a Schema
 email:
 - mattius.taylor@gmail.com
 executables: []
@@ -88,6 +88,8 @@ files:
 - docker-compose.yml
 - json_schematize.gemspec
 - lib/json_schematize.rb
+- lib/json_schematize/base.rb
+- lib/json_schematize/boolean.rb
 - lib/json_schematize/field.rb
 - lib/json_schematize/field_transformations.rb
 - lib/json_schematize/field_validators.rb
@@ -117,5 +119,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: Describe the gem here
+summary: This gem gives you the ability to turn API results into a standardized schema's
+  that can be easily grocked
 test_files: []