camel_snake_struct 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84c35d8e18c588469d3a51f4de2cf83a161bb86bbc542c19ffe11ff3f4eee21d
-  data.tar.gz: 301b56ed4e1b4e8c667ca9e14aea4f637af26d54520eef448498076b876654ac
+  metadata.gz: 7f4978b18cb18f1bd33284ad21a540552ef8a558fcdcff4fb0296c0f2d1c444f
+  data.tar.gz: a830f31ca20fcff51e85832afa26e5cfa6c02d0a52d080427223c6e3bdd16342
 SHA512:
-  metadata.gz: f06b0d2ab615183f5b006832d18c1fcc53d0d34e749aca28bf811df24a20e4e789059f82fb12ed7bc15ea489d72e8d508a9f876f712bd8af37b1e9601bad060f
-  data.tar.gz: 4931234a2ad68b760f50c5303b2b02838af23cd67e57a90fe4089c2a96fc55fb4aec22522b0c9d78b195ee0a0b63489f34b97248422cef11d022c52ba7df43c2
+  metadata.gz: 309e7c1c9df867de7930257defd3588433f12248bc43e448f38c8132d66b20d34ebeb41ea58b9198414ed81769467853e98ddec1ed90319c3ea16d31db1cc2a3
+  data.tar.gz: aa718371a22f920b35ad630f344d4bae3ed07081bd8a85771bf37c3b059f541985ea646d375c2df7a2e7bc0c1f9781602cbdaf99421c09dff3c92c9994c3fa62

data/.gitignore

@@ -11,4 +11,5 @@
 .rspec_status
 vendor/bundle
 gems.locked
+Gemfile.lock
 .ruby-version

data/.rubocop.yml

@@ -20,6 +20,12 @@ Metrics/MethodLength:
 Metrics/ClassLength:
   Max: 200
 
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
 Gemspec/RequiredRubyVersion:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.3.1
+* handle situation where the key of the hash will not make a valid method, EG { "2020-01-02 19:00:00 UTC" => [""] } 
+
+# 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
 

data/README.md

@@ -67,6 +67,61 @@ 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>}
+```
+
+```ruby
+# typed: true
+
+module Tapioca
+  module Compilers
+    class CamelSnakeStructCompiler < Tapioca::Dsl::Compiler
+      extend T::Sig
+
+      ConstantType = type_member {{ fixed: T.class_of(CamelSnakeStruct) }}
+
+      sig { override.returns(T::Enumerable[Module]) }
+      def self.gather_constants
+        all_classes.select do |c| 
+          c < ::CamelSnakeStruct && !c.types_meta_data.empty?
+        end
+      end
+
+      sig { override.void }
+      def decorate
+        root.create_path(constant) do |klass|
+          constant.types_meta_data.each do |name, meta_data|
+            classes = meta_data.classes.to_a.map{|a| [TrueClass,FalseClass].include?(a) ? "T::Boolean" : a.to_s }.uniq
+            return_type = if classes.size == 1
+              classes.first.to_s
+            else
+              "T.any(#{classes.join(', ')})"
+            end
+            if meta_data.array
+              klass.create_method(name.to_s, parameters: [], return_type: "T::Array[#{return_type}]")
+            elsif return_type == 'NilClass' || return_type == 'String'
+              klass.create_method(name.to_s, parameters: [], return_type: 'T.nilable(String)')
+            else
+              klass.create_method(name.to_s, parameters: [], return_type: return_type)
+            end
+            klass.create_method("#{name}?", parameters: [], return_type: 'T::Boolean')
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+
 ### Limitations
 
 * Expects to receive a hash

data/bin/rake

@@ -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/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.1"
+  spec.version       = "0.3.1"
   spec.authors       = ["Grant Petersen-Speelman"]
   spec.email         = ["grant@nexl.io"]
 

data/lib/camel_snake_struct.rb

@@ -3,10 +3,18 @@ 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)
@@ -15,15 +23,33 @@ 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|
-      normalize_key = key.gsub('@', '').gsub('.', '_')
-      mapping[normalize_key] = key
-      mapping[normalize_key.underscore] = key
+      if key =~ /^[A-Za-z]/
+        normalize_key = key.gsub('@', '').gsub(/\.|\s/, '_')
+        mapping[normalize_key] = key
+        mapping[normalize_key.underscore] = key
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camel_snake_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Grant Petersen-Speelman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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: []