typed_attrs 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11ede186057fb2f00a926b578dfa7ea647842bf76a1f3f3904b71b3b7f8cbff1
-  data.tar.gz: 7a1e677adbc23fa563fc600bd842fbe1ba82531c1b5f743f804f32582c2b450e
+  metadata.gz: c4ec7589abe8bedcc01f25d42c9419ae5e1525bbce0ef18d8b1dd119add2d4cb
+  data.tar.gz: a93cc3758a8b571394d285818853131d756fe2a9373d2def2654119e8418ccbd
 SHA512:
-  metadata.gz: 1b1c68d5519e6b4ed951264bbcc60e276c3378e853f448f4cf92d903af0aaa2d967d48954ec392a94aed5b6ad102479cedff76baab530c3eeb1a77cc8fa7a2bf
-  data.tar.gz: 5062ae18a4d829f802b1593f21be45fb98da5258563ecdbfc75641c7de7ab331806360f597a0bd23a73c68cff4e0b49cddde24d766c16bc1c18c32fb68313fb4
+  metadata.gz: efd329de2ce4ae3e5cd7798328030c2ddb48543c37a74469d34fe5cb1cfe77f8f45b267707ec7aa4cba7239a63d6f1c604b23281bbe2aec28f85c3b5f0d23ac7
+  data.tar.gz: 45e46415a3e7aa5145c5442fca8fe2ba4668812f634c2f8b5cc452c18e8e2f5fbf9bfed48cd1be5233f8ca1827094a38388cd223706884b13de65216a45e76aa

data/CHANGELOG.md

@@ -5,9 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.2.0] - 2025-10-11
 
-## [0.1.0] - 2025-01-05
+### Changed
+- **BREAKING**: Changed public API from `TypedAttrs.to_type(Product)` to `T::Attr[Product]`
+  - Users must update attribute definitions: `attribute :field, TypedAttrs.to_type(MyStruct)` → `attribute :field, T::Attr[MyStruct]`
+  - Public API is now under `T::Attr` module while implementation remains in `TypedAttrs` namespace
+
+### Refactored
+- Simplified type class from `TypedAttrs::Types::Type` to `TypedAttrs::Type`
+- Renamed Tapioca DSL compiler from `TypedAttribute` to `TypedAttrs`
+  - File: `lib/tapioca/dsl/compilers/typed_attribute.rb` → `typed_attrs.rb`
+  - Class: `Tapioca::Dsl::Compilers::TypedAttribute` → `TypedAttrs`
+
+## [0.1.0] - 2025-10-10
 
 ### Added
 - Initial release

data/README.md

@@ -37,7 +37,7 @@ end
 
 # Use it as a typed attribute
 class Order < ActiveRecord::Base
-  attribute :product, TypedAttrs.to_type(Product)
+  attribute :product, T::Attr[Product]
 end
 
 # Assign with Hash
@@ -64,7 +64,7 @@ class Color < T::Struct
 end
 
 class Palette < ActiveRecord::Base
-  attribute :colors, TypedAttrs.to_type(T::Array[Color])
+  attribute :colors, T::Attr[T::Array[Color]]
 end
 
 palette = Palette.new
@@ -85,7 +85,7 @@ class BoxSize < T::Struct
 end
 
 class Layout < ActiveRecord::Base
-  attribute :box_sizes, TypedAttrs.to_type(T::Hash[String, BoxSize])
+  attribute :box_sizes, T::Attr[T::Hash[String, BoxSize]]
 end
 
 layout = Layout.new
@@ -127,7 +127,7 @@ class Cat < T::Struct
 end
 
 class PetOwner < ActiveRecord::Base
-  attribute :pet, TypedAttrs.to_type(PetType)
+  attribute :pet, T::Attr[PetType]
 end
 
 owner = PetOwner.new
@@ -152,7 +152,7 @@ class Company < T::Struct
 end
 
 class Employee < ActiveRecord::Base
-  attribute :company, TypedAttrs.to_type(Company)
+  attribute :company, T::Attr[Company]
 end
 
 employee = Employee.new
@@ -174,7 +174,7 @@ class Settings < T::Struct
 end
 
 class User < ActiveRecord::Base
-  attribute :settings, TypedAttrs.to_type(Settings)
+  attribute :settings, T::Attr[Settings]
 end
 
 user = User.new
@@ -200,7 +200,7 @@ class Product < T::Struct
 end
 
 class Order < ActiveRecord::Base
-  attribute :product, TypedAttrs.to_type(Product)
+  attribute :product, T::Attr[Product]
   validates :product, typed_attrs: true
 end
 
@@ -227,7 +227,7 @@ class Article < T::Struct
 end
 
 class Post < ActiveRecord::Base
-  attribute :article, TypedAttrs.to_type(Article)
+  attribute :article, T::Attr[Article]
   validates :article, typed_attrs: true
 end
 
@@ -305,12 +305,12 @@ end
 # Ruby:     Company.new(name: "Acme", address: Address.new(...))
 
 # Array type - stored as JSON array
-attribute :colors, TypedAttrs.to_type(T::Array[Color])
+attribute :colors, T::Attr[T::Array[Color]]
 # Database: [{ "name": "Red", "hex": "#FF0000" }, ...]
-# Ruby:     [Color.new(name: "Red", hex: "#FF0000"), ...]
+# Ruby:     [Color.new(name: "Red", hex: "#FF0000"], ...]
 
 # Hash type - stored as JSON object
-attribute :sizes, TypedAttrs.to_type(T::Hash[String, BoxSize])
+attribute :sizes, T::Attr[T::Hash[String, BoxSize]]
 # Database: { "small": { "width": 100, "height": 50 }, ... }
 # Ruby:     { "small" => BoxSize.new(width: 100, height: 50), ... }
 ```

data/lib/active_model/validations/typed_attrs_validator.rb

@@ -36,12 +36,12 @@ module ActiveModel
         end
       end
 
-      sig { params(record: T.untyped, attribute: T.any(String, Symbol)).returns(T.nilable(TypedAttrs::Types::Type)) }
+      sig { params(record: T.untyped, attribute: T.any(String, Symbol)).returns(T.nilable(TypedAttrs::Type)) }
       def get_typed_attribute_type(record, attribute)
         return nil unless record.class.respond_to?(:attribute_types)
 
         attribute_type = record.class.attribute_types[attribute.to_s]
-        attribute_type.is_a?(TypedAttrs::Types::Type) ? attribute_type : nil
+        attribute_type.is_a?(TypedAttrs::Type) ? attribute_type : nil
       end
     end
   end

data/lib/tapioca/dsl/compilers/{typed_attribute.rb → typed_attrs.rb}

@@ -9,7 +9,7 @@ require "tapioca/dsl"
 module Tapioca
   module Dsl
     module Compilers
-      class TypedAttribute < Tapioca::Dsl::Compiler
+      class TypedAttrs < Tapioca::Dsl::Compiler
         extend T::Sig
 
         ConstantType = type_member { { fixed: T.class_of(ActiveRecord::Base) } }
@@ -46,7 +46,7 @@ module Tapioca
 
         class << self
           def typed_attribute_type?(type)
-            type.is_a?(TypedAttrs::Types::Type)
+            type.is_a?(::TypedAttrs::Type)
           end
         end
 
@@ -60,12 +60,12 @@ module Tapioca
         sig { params(klass: RBI::Scope, attr_name: String, type: ActiveModel::Type::Value).void }
         def create_attribute_methods(klass, attr_name, type)
           case type
-          when TypedAttrs::Types::Type
+          when ::TypedAttrs::Type
             create_type_attribute_methods(klass, attr_name, type)
           end
         end
 
-        sig { params(klass: RBI::Scope, attr_name: String, type: TypedAttrs::Types::Type).void }
+        sig { params(klass: RBI::Scope, attr_name: String, type: ::TypedAttrs::Type).void }
         def create_type_attribute_methods(klass, attr_name, type)
           type_spec = type.instance_variable_get(:@type_spec)
           type_string = type_spec.name

data/lib/typed_attrs/type.rb

@@ -0,0 +1,49 @@
+# typed: strict
+# frozen_string_literal: true
+
+module TypedAttrs
+  class Type < ActiveModel::Type::Value
+    include TypeHelpers
+    extend T::Sig
+
+    sig { params(type_spec: T.untyped).void }
+    def initialize(type_spec)
+      super()
+      @type_spec = type_spec
+
+      registry = T.let(TypeProcessors.default_registry, TypeProcessors::Registry)
+      @processor = T.let(registry.serializer_for(type_spec), TypeProcessors::Base)
+    end
+
+    sig { returns(TypeProcessors::Base) }
+    attr_reader :processor
+
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def cast(value)
+      return nil if value.nil?
+
+      @processor.deserialize(value)
+    end
+
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def serialize(value)
+      return nil if value.nil?
+
+      serialized = @processor.serialize(value)
+      ActiveSupport::JSON.encode(serialized)
+    end
+
+    sig { params(value: T.untyped).returns(T.untyped) }
+    def deserialize(value)
+      return nil if value.nil?
+
+      data = if value.is_a?(String)
+               ActiveSupport::JSON.decode(value)
+             else
+               value
+             end
+
+      @processor.deserialize(data)
+    end
+  end
+end

data/lib/typed_attrs/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module TypedAttrs
-  VERSION = "0.1.0"
+  VERSION = "0.2.2"
 end

data/lib/typed_attrs.rb

@@ -23,7 +23,7 @@ require_relative "typed_attrs/type_processors/struct"
 require_relative "typed_attrs/type_processors/array"
 require_relative "typed_attrs/type_processors/hash"
 require_relative "typed_attrs/type_processors/discriminated_union"
-require_relative "typed_attrs/types/type"
+require_relative "typed_attrs/type"
 require_relative "typed_attrs/discriminated_union"
 require_relative "active_model/validations/typed_attrs_validator"
 
@@ -95,9 +95,16 @@ module TypedAttrs
       )
     end
   end
+end
+
+# Add T::Attr as the public API for typed attributes
+module T
+  module Attr
+    extend T::Sig
 
-  sig { params(type_spec: T.untyped).returns(Types::Type) }
-  def self.to_type(type_spec)
-    Types::Type.new(type_spec)
+    sig { params(type_spec: T.untyped).returns(TypedAttrs::Type) }
+    def self.[](type_spec)
+      TypedAttrs::Type.new(type_spec)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typed_attrs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Speria
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  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: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -64,9 +50,10 @@ files:
 - LICENSE
 - README.md
 - lib/active_model/validations/typed_attrs_validator.rb
-- lib/tapioca/dsl/compilers/typed_attribute.rb
+- lib/tapioca/dsl/compilers/typed_attrs.rb
 - lib/typed_attrs.rb
 - lib/typed_attrs/discriminated_union.rb
+- lib/typed_attrs/type.rb
 - lib/typed_attrs/type_helpers.rb
 - lib/typed_attrs/type_processors.rb
 - lib/typed_attrs/type_processors/array.rb
@@ -85,17 +72,16 @@ files:
 - lib/typed_attrs/type_processors/struct.rb
 - lib/typed_attrs/type_processors/symbol.rb
 - lib/typed_attrs/type_processors/time.rb
-- lib/typed_attrs/types/type.rb
 - lib/typed_attrs/version.rb
 homepage: https://github.com/speria-jp/typed_attrs
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/speria-jp/typed_attrs
-  source_code_uri: https://github.com/speria-jp/typed_attrs.git
-  changelog_uri: https://github.com/speria-jp/typed_attrs/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/speria-jp/typed_attrs
+  changelog_uri: https://github.com/speria-jp/typed_attrs/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/speria-jp/typed_attrs/issues
-  documentation_uri: https://github.com/speria-jp/typed_attrs/blob/master/README.md
+  documentation_uri: https://github.com/speria-jp/typed_attrs/blob/main/README.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -111,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Type-safe ActiveRecord attributes using Sorbet T::Struct
 test_files: []

data/lib/typed_attrs/types/type.rb

@@ -1,51 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module TypedAttrs
-  module Types
-    class Type < ActiveModel::Type::Value
-      include TypeHelpers
-      extend T::Sig
-
-      sig { params(type_spec: T.untyped).void }
-      def initialize(type_spec)
-        super()
-        @type_spec = type_spec
-
-        registry = T.let(TypeProcessors.default_registry, TypeProcessors::Registry)
-        @processor = T.let(registry.serializer_for(type_spec), TypeProcessors::Base)
-      end
-
-      sig { returns(TypeProcessors::Base) }
-      attr_reader :processor
-
-      sig { params(value: T.untyped).returns(T.untyped) }
-      def cast(value)
-        return nil if value.nil?
-
-        @processor.deserialize(value)
-      end
-
-      sig { params(value: T.untyped).returns(T.untyped) }
-      def serialize(value)
-        return nil if value.nil?
-
-        serialized = @processor.serialize(value)
-        ActiveSupport::JSON.encode(serialized)
-      end
-
-      sig { params(value: T.untyped).returns(T.untyped) }
-      def deserialize(value)
-        return nil if value.nil?
-
-        data = if value.is_a?(String)
-                 ActiveSupport::JSON.decode(value)
-               else
-                 value
-               end
-
-        @processor.deserialize(data)
-      end
-    end
-  end
-end