camel_snake_struct 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987bc380d252b4990ae2007fcf0d5d75dcb1eb56a9f680eb043a3b6e7e65fa0c
-  data.tar.gz: 1ac44036b2c851c8f98c3bef57c20ab3cf1e6d557b675c2a48465a6b8e3be5ee
+  metadata.gz: 19cacf8a8dd3f5e1758672ed4ba28f90784c0017cf65bd39947293eab12d86a6
+  data.tar.gz: b4282acdaad784ebc5f7cf4aea44af63cccf5ef23e1c86cc8b6b876b9afcf8d1
 SHA512:
-  metadata.gz: c64e7b0995a1098f8a932fa80f6c488ab1c75ce6dbcbaeaa181981442fb147c599b49e9a4b156fcb9930ca044d34fa92b795499594f99c1cc678259185fbe103
-  data.tar.gz: e8f184b499b1fbff46d2d22ff86459cc7c46b8f38369d7e28fc7af4cf5b3d07caef7115bacc3daa375fa452e503cb91bb2701ec1041515eb6242a463cc50c81e
+  metadata.gz: 200e79a30d0e957e8833d757a6ea342bd79778459a7cfad2ac20c6e07859cf556c00092c8f0050325535e8982a6a7ae15f174e9a413bb1182bd0ca206684bad2
+  data.tar.gz: d5229f7d105c08f93b869acd0d33875026788a09133a227a82ba006f2b99ddc782b4d856fbd49fbf2d5069b4a3ef933d352e3111f6a45b5ce7656e60a1a791ac

data/.gitignore

@@ -10,4 +10,6 @@
 # rspec failure tracking
 .rspec_status
 vendor/bundle
-gems.locked
+gems.locked
+Gemfile.lock
+.ruby-version

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
     - 'vendor/**/*'
 
@@ -19,3 +19,15 @@ Metrics/MethodLength:
 
 Metrics/ClassLength:
   Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Bundler/GemFilename:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.0
+* Learning Structs store meta data about the shape of the hash from the examples provided. This can be used with tapioca custom DSL compilers to generate sorbet types
+
+# 0.2.1
+* activesupport < 8.0
+
 # 0.2.0
 * Add support to check if key is set
 

data/README.md

@@ -67,6 +67,18 @@ puts result3.date.timezone # nil
 puts result3.date.unix_time # nil
 ```
 
+Learning Structs store meta data about the shape of the hash from the examples provided.
+This can be used with tapioca custom DSL compilers to generate sorbet types
+
+```ruby
+MyLoadedStruct = Class.new(CamelSnakeStruct)
+MyLoadedStruct.example('data' => [{ 'name' => 'Jeff' }], 'errors' => [], 'date' => { 'timezone' => 'UTC', 'unixTime' => 0})
+
+puts MyLoadedStruct.types_meta_data
+# {"data"=>#<struct CamelSnakeStruct::Type__Meta__Data class_types=#<Set: {MyLoadedStruct::Datum}>, array=true>, "errors"=>#<struct CamelSnakeStruct::Type__Meta__Data class_types=#<Set: {}>, array=true>, "date"=>#<struct CamelSnakeStruct::Type__Meta__Data class_types=#<Set: {MyLoadedStruct::Date}>, array=false>}
+```
+
+
 ### Limitations
 
 * Expects to receive a hash

data/bin/rake

@@ -9,8 +9,8 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 

data/bin/rspec

@@ -9,7 +9,7 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
                                            Pathname.new(__FILE__).realpath)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)

data/bin/rubocop

@@ -9,7 +9,7 @@
 #
 
 require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../gems.rb",
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
                                            Pathname.new(__FILE__).realpath)
 
 bundle_binstub = File.expand_path("../bundle", __FILE__)

data/camel_snake_struct.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "camel_snake_struct"
-  spec.version       = "0.2.0"
+  spec.version       = "0.3.0"
   spec.authors       = ["Grant Petersen-Speelman"]
   spec.email         = ["grant@nexl.io"]
 
@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency 'activesupport', '>= 3.2', '< 7.0'
+  spec.add_dependency 'activesupport', '>= 3.2', '< 8.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/camel_snake_struct.rb

@@ -1,11 +1,20 @@
+require "active_support"
 require 'active_support/core_ext/string'
 
 class CamelSnakeStruct
   def self.example(data)
+    raise ArgumentError, "Examples are for Learning Structs" if self == CamelSnakeStruct
+
     new_example = new(data)
     walk_example(new_example)
   end
 
+  Type__Meta__Data = Struct.new(:class_types, :array) do
+    def classes
+      class_types.to_a
+    end
+  end
+
   def self.walk_example(new_example)
     new_example.send(:_method_to_key).keys.each do |m_name|
       result = new_example.public_send(m_name)
@@ -14,9 +23,25 @@ class CamelSnakeStruct
       elsif result.is_a?(Array) && result.first.is_a?(CamelSnakeStruct)
         walk_example(result.first)
       end
+
+      store_meta_data(new_example.class, m_name, result)
     end
   end
 
+  def self.store_meta_data(example_class, m_name, result)
+    types_meta_data = (example_class.types_meta_data[m_name] ||= Type__Meta__Data.new(Set.new, false))
+    if result.is_a?(Array)
+      types_meta_data.array = true
+      result.map(&:class).each { |c| types_meta_data.class_types << c }
+    else
+      types_meta_data.class_types << result.class
+    end
+  end
+
+  def self.types_meta_data
+    @types_meta_data ||= {}
+  end
+
   def initialize(hash)
     @_raw_hash = hash&.to_h || {}
     @_method_to_key = @_raw_hash.keys.each_with_object({}) do |key, mapping|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camel_snake_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Grant Petersen-Speelman
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-06 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 description: Easily access camelCased hashes in a ruby friendly way
 email:
 - grant@nexl.io
@@ -41,6 +41,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
+- Gemfile
 - README.md
 - Rakefile
 - bin/console
@@ -49,7 +50,6 @@ files:
 - bin/rubocop
 - bin/setup
 - camel_snake_struct.gemspec
-- gems.rb
 - lib/camel_snake_struct.rb
 homepage: https://github.com/NEXL-LTS/camel_snake_struct-ruby
 licenses: []
@@ -57,7 +57,8 @@ metadata:
   homepage_uri: https://github.com/NEXL-LTS/camel_snake_struct-ruby
   source_code_uri: https://github.com/NEXL-LTS/camel_snake_struct-ruby
   changelog_uri: https://github.com/NEXL-LTS/camel_snake_struct/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -72,8 +73,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Easily access camelCased hashes in a ruby friendly way
 test_files: []