skit 0.1.0

data/lib/tapioca/dsl/compilers/skit.rb

@@ -0,0 +1,105 @@
+# typed: ignore
+# frozen_string_literal: true
+
+return unless defined?(Tapioca::Dsl::Compiler)
+return unless defined?(ActiveRecord::Base)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      # `Tapioca::Dsl::Compilers::Skit` decorates RBI files for ActiveRecord models
+      # that use `Skit::Attribute` for typed JSON attributes.
+      #
+      # For example, with the following model:
+      #
+      # ~~~rb
+      # class Address < T::Struct
+      #   const :city, String
+      #   const :zip, T.nilable(String)
+      # end
+      #
+      # class Customer < ActiveRecord::Base
+      #   attribute :address, Skit::Attribute[Address]
+      # end
+      # ~~~
+      #
+      # this compiler will produce an RBI file with the following content:
+      # ~~~rbi
+      # # typed: strong
+      #
+      # class Customer
+      #   sig { returns(Address) }
+      #   def address; end
+      #
+      #   sig { params(value: T.untyped).returns(Address) }
+      #   def address=(value); end
+      # end
+      # ~~~
+      #: [ConstantType = T.class_of(::ActiveRecord::Base)]
+      class Skit < Compiler
+        extend T::Sig
+
+        # @override
+        #: -> void
+        def decorate
+          attributes = constant.attribute_types.select { |_name, type| skit_attribute_type?(type) }
+
+          return if attributes.empty?
+
+          root.create_path(constant) do |klass|
+            attributes.each do |attr_name, type|
+              create_attribute_methods(klass, attr_name, type)
+            end
+          end
+        end
+
+        class << self
+          extend T::Sig
+
+          # @override
+          #: -> Enumerable[Module]
+          def gather_constants
+            descendants = ActiveRecord::Base.descendants.reject(&:abstract_class?)
+
+            descendants.select do |klass|
+              klass.attribute_types.values.any? { |type| skit_attribute_type?(type) }
+            rescue ActiveRecord::StatementInvalid
+              false
+            end
+          end
+
+          #: (untyped type) -> bool
+          def skit_attribute_type?(type)
+            type.is_a?(::Skit::Attribute)
+          end
+        end
+
+        private
+
+        #: (untyped type) -> bool
+        def skit_attribute_type?(type)
+          self.class.skit_attribute_type?(type)
+        end
+
+        #: (RBI::Scope klass, String attr_name, untyped type) -> void
+        def create_attribute_methods(klass, attr_name, type)
+          return unless type.is_a?(::Skit::Attribute)
+
+          type_spec = type.instance_variable_get(:@type_spec)
+          type_string = type_spec.name
+
+          klass.create_method(
+            attr_name,
+            return_type: type_string
+          )
+
+          klass.create_method(
+            "#{attr_name}=",
+            parameters: [create_param("value", type: "T.untyped")],
+            return_type: type_string
+          )
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: skit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Speria, inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Skit provides tools for generating Sorbet T::Struct from JSON Schema,
+  serializing/deserializing between JSON and T::Struct, and integrating with ActiveRecord
+  JSONB columns.
+email:
+- daichi.sakai@speria.jp
+executables:
+- skit
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/skit
+- lib/active_model/validations/skit_validator.rb
+- lib/skit.rb
+- lib/skit/attribute.rb
+- lib/skit/json_schema.rb
+- lib/skit/json_schema/class_name_path.rb
+- lib/skit/json_schema/cli.rb
+- lib/skit/json_schema/code_generator.rb
+- lib/skit/json_schema/config.rb
+- lib/skit/json_schema/definitions/array_property_type.rb
+- lib/skit/json_schema/definitions/const_type.rb
+- lib/skit/json_schema/definitions/enum_type.rb
+- lib/skit/json_schema/definitions/hash_property_type.rb
+- lib/skit/json_schema/definitions/module.rb
+- lib/skit/json_schema/definitions/property_type.rb
+- lib/skit/json_schema/definitions/property_types.rb
+- lib/skit/json_schema/definitions/struct.rb
+- lib/skit/json_schema/definitions/struct_property.rb
+- lib/skit/json_schema/definitions/union_property_type.rb
+- lib/skit/json_schema/naming_utils.rb
+- lib/skit/json_schema/schema_analyzer.rb
+- lib/skit/json_schema/types/const.rb
+- lib/skit/serialization.rb
+- lib/skit/serialization/errors.rb
+- lib/skit/serialization/path.rb
+- lib/skit/serialization/processor/array.rb
+- lib/skit/serialization/processor/base.rb
+- lib/skit/serialization/processor/boolean.rb
+- lib/skit/serialization/processor/date.rb
+- lib/skit/serialization/processor/enum.rb
+- lib/skit/serialization/processor/float.rb
+- lib/skit/serialization/processor/hash.rb
+- lib/skit/serialization/processor/integer.rb
+- lib/skit/serialization/processor/json_schema_const.rb
+- lib/skit/serialization/processor/nilable.rb
+- lib/skit/serialization/processor/simple_type.rb
+- lib/skit/serialization/processor/string.rb
+- lib/skit/serialization/processor/struct.rb
+- lib/skit/serialization/processor/symbol.rb
+- lib/skit/serialization/processor/time.rb
+- lib/skit/serialization/processor/union.rb
+- lib/skit/serialization/registry.rb
+- lib/skit/version.rb
+- lib/tapioca/dsl/compilers/skit.rb
+homepage: https://github.com/speria-jp/skit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/speria-jp/skit
+  source_code_uri: https://github.com/speria-jp/skit
+  bug_tracker_uri: https://github.com/speria-jp/skit/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: JSON Schema and Sorbet T::Struct integration toolkit
+test_files: []