rasti-model 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9eccfccf07cf4cdd8918d8767ec7f350b50cb6455b684e1684b6726cd6b6c0
-  data.tar.gz: 144268df7baa226b9cdfa622994ce32cb523aebf586c75bfa9c2c25c6e782613
+  metadata.gz: efc4252fe73eba82ba9eb35be17934864d7384a01428355706c401def3abb613
+  data.tar.gz: 2906e648b0c76fb766024a168a3c7cd09d2661a15283c5f3e6341ebe0f167c10
 SHA512:
-  metadata.gz: 6a61d5e9030e0752b1080f91e7c65b7259100efba579219b9707e8efa8637ecba183ab574c0816daa7fb9caa3e5ba91a346156e40bec5000d919c35ee54f7ae0
-  data.tar.gz: 5096b2f80d1e42ba42387be5ecfcae690c02944619f62ae6ca26632380d64511e4badbca3e2add39f5f9d7b9e19413cd60d1754a62b2727a72348394037f28a7
+  metadata.gz: '08942eb37b0335bae2cc80f1cf17692cd9d736e6801d93b285be8fa34c1500d76e3129557425b858f47c449ba4e6a2e9588e3efd38793da3b0f9949a99a0a8a3'
+  data.tar.gz: 1cd16e7e5ce96a2ab0d7bd2c9ba22917451ceb90d7009e6c02d3c488d823a2712d7eaadd50597e9e4a4d81256d1b0ecbad17f872c76909ddcf41b332797060fa

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ '**' ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test:
+
+    name: Tests
+    runs-on: ubuntu-22.04
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', 'jruby-9.2.9.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,7 +1,7 @@
 # Rasti::Model
 
 [![Gem Version](https://badge.fury.io/rb/rasti-model.svg)](https://rubygems.org/gems/rasti-model)
-[![Build Status](https://travis-ci.org/gabynaiman/rasti-model.svg?branch=master)](https://travis-ci.org/gabynaiman/rasti-model)
+[![CI](https://github.com/gabynaiman/rasti-model/actions/workflows/ci.yml/badge.svg)](https://github.com/gabynaiman/rasti-model/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/gabynaiman/rasti-model/badge.svg?branch=master)](https://coveralls.io/github/gabynaiman/rasti-model?branch=master)
 [![Code Climate](https://codeclimate.com/github/gabynaiman/rasti-model.svg)](https://codeclimate.com/github/gabynaiman/rasti-model)
 
@@ -35,6 +35,9 @@ end
 point = Point.new x: 1, y: 2
 point.x # => 1
 point.y # => 2
+
+# Unexpected attributes
+Point.new z: 3 # => Rasti::Model::UnexpectedAttributesError: Unexpected attributes: z
 ```
 
 ### Typed models
@@ -77,6 +80,54 @@ country.name # => 'Argentina'
 country.cities # => [City[name: "Buenos Aires"], City[name: "Córdoba"], City[name: "Rosario"]]
 
 country.to_h # => attributes
+
+# Attribute filtering
+country.to_h(only: [:name]) # => {name: "Argentina"}
+country.to_h(except: [:cities]) # => {name: "Argentina"}
+```
+
+### Default values
+```ruby
+class User < Rasti::Model
+  attribute :name, T::String
+  attribute :admin, T::Boolean, default: false
+  attribute :created_at, T::Time, default: ->(m) { Time.now }
+end
+
+user = User.new name: 'John'
+user.admin # => false
+user.created_at # => 2026-01-02 23:19:15 -0300
+```
+
+### Merging models
+```ruby
+point_1 = Point.new x: 1, y: 2
+point_2 = point_1.merge x: 10
+point_2.to_h # => {x: 10, y: 2}
+```
+
+### Custom attribute options
+You can add custom metadata to attributes that can be used later (e.g., for UI generation):
+
+```ruby
+class User < Rasti::Model
+  attribute :name, T::String, description: 'The user full name'
+end
+
+attribute = User.attributes.first
+attribute.option(:description) # => 'The user full name'
+```
+
+These options are also included in the schema representation.
+
+### Equality
+```ruby
+point_1 = Point.new x: 1, y: 2
+point_2 = Point.new x: 1, y: 2
+point_3 = Point.new x: 2, y: 1
+
+point_1 == point_2 # => true
+point_1 == point_3 # => false
 ```
 
 ### Error handling
@@ -86,8 +137,41 @@ TypedPoint = Rasti::Model[x: T::Integer, y: T::Integer]
 point = TypedPoint.new x: true
 point.x # => Rasti::Types::CastError: Invalid cast: true -> Rasti::Types::Integer
 point.y # => Rasti::Model::NotAssignedAttributeError: Not assigned attribute y
+
+# Bulk validation
+point = TypedPoint.new x: 'invalid', y: 'invalid'
+point.cast_attributes! # => Rasti::Types::CompoundError: x: ["Invalid cast: \"invalid\" -> Rasti::Types::Integer"], y: ["Invalid cast: \"invalid\" -> Rasti::Types::Integer"]
+```
+
+### Model Schema
+It is possible to obtain a serializable representation of the model structure (schema).
+
+```ruby
+Point = Rasti::Model[x: T::Integer, y: T::Integer]
+Point.to_schema
+# => {
+#      model: "Point",
+#      attributes: [
+#        {name: :x, type: :integer},
+#        {name: :y, type: :integer}
+#      ]
+#    }
+```
+
+#### Custom type serializers
+You can register custom serializers for your types to be used in the schema generation:
+
+```ruby
+Rasti::Model::Schema.register_type_serializer(MyCustomType, :custom)
+
+# Or with a block for more details
+Rasti::Model::Schema.register_type_serializer(MyCustomType) do |type|
+  {type: :custom, details: type.some_info}
+end
 ```
 
+Also, if a type responds to `to_schema`, it will be used.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/gabynaiman/rasti-model.

data/lib/rasti/model/attribute.rb

@@ -18,6 +18,10 @@ module Rasti
         options.fetch(:default)
       end
 
+      def option(name)
+        options[name]
+      end
+
       def to_s
         "#{self.class}[name: #{name.inspect}, type: #{type.inspect}, options: #{options.inspect}]"
       end

data/lib/rasti/model/schema.rb

@@ -0,0 +1,83 @@
+module Rasti
+  class Model
+    module Schema
+      class << self
+
+        def register_type_serializer(type, serialized_type=nil, &block)
+          type_serializers[type] = block || serialized_type
+        end
+
+        def serialize(model_class)
+          attributes = model_class.attributes.map do |attribute|
+            serialize_attribute(attribute).merge(name: attribute.name)
+          end
+
+          {
+            model: model_class.name || model_class.to_s,
+            attributes: attributes
+          }
+        end
+
+        private
+
+        def type_serializers
+          @type_serializers ||= {}
+        end
+
+        def serialize_attribute(attribute)
+          serialization = serialize_type(attribute.type)
+          
+          options = attribute.send(:options)
+          serialization[:options] = options unless options.empty?
+          
+          serialization
+        end
+
+        def serialize_type(type)
+          if type.nil?
+            return {type: :any}
+          end
+
+          if (serializer = type_serializers[type])
+            return serializer.is_a?(Proc) ? serializer.call(type) : {type: serializer}
+          end
+
+          if type.respond_to? :to_schema
+            return type.to_schema
+          end
+
+          if type.is_a?(Class)
+            if type <= Types::String
+              {type: :string}
+            elsif type <= Types::Integer
+              {type: :integer}
+            elsif type <= Types::Float
+              {type: :float}
+            elsif type <= Types::Boolean
+              {type: :boolean}
+            elsif type <= Types::Symbol
+              {type: :symbol}
+            elsif type <= Types::Regexp
+              {type: :regexp}
+            else
+              {type: :unknown, details: type.name || type.to_s}
+            end
+          elsif type.is_a?(Types::Time)
+            {type: :time, format: type.format}
+          elsif type.respond_to?(:values)
+            {type: :enum, values: type.values}
+          elsif type.is_a?(Types::Array)
+            {type: :array, items: serialize_type(type.type)}
+          elsif type.is_a?(Types::Hash)
+            {type: :hash, key_type: serialize_type(type.key_type), value_type: serialize_type(type.value_type)}
+          elsif type.is_a?(Types::Model)
+            {type: :model, model: type.model.name || type.model.to_s, schema: serialize(type.model)}
+          else
+            {type: :unknown, details: type.to_s}
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/rasti/model/version.rb

@@ -1,5 +1,5 @@
 module Rasti
   class Model
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/rasti/model.rb

@@ -32,6 +32,10 @@ module Rasti
         name || self.superclass.name
       end
 
+      def to_schema
+        Schema.serialize self
+      end
+
       def to_s
         "#{model_name}[#{attribute_names.join(', ')}]"
       end

data/spec/model_spec.rb

@@ -257,6 +257,16 @@ describe Rasti::Model do
     point_2.y.must_equal 2
   end
 
+  it 'Custom attribute options' do
+    model = Class.new(Rasti::Model) do
+      attribute :text, T::String, description: 'Test description'
+    end
+
+    attribute = model.attributes.first
+    attribute.option(:description).must_equal 'Test description'
+    attribute.option(:undefined).must_be_nil
+  end
+
   it 'to_s' do
     Position.to_s.must_equal 'Position[type, point]'
 
@@ -280,4 +290,80 @@ describe Rasti::Model do
     error.message.must_equal 'Attribute x already exists'
   end
 
+  describe 'Schema' do
+
+    it 'Simple' do
+      model = Rasti::Model[id: T::Integer, name: T::String]
+
+      model.to_schema.must_equal({
+        model: model.to_s,
+        attributes: [
+          {name: :id, type: :integer},
+          {name: :name, type: :string}
+        ]
+      })
+    end
+
+    it 'Complex' do
+      address_class = Rasti::Model[street: T::String, number: T::Integer]
+
+      model = Rasti::Model[
+        id: T::Integer, 
+        tags: T::Array[T::String], 
+        address: T::Model[address_class], 
+        metadata: T::Hash[T::Symbol, T::String],
+        status: T::Enum['active', 'inactive'],
+        created_at: T::Time['%Y-%m-%d']
+      ]
+
+      model.to_schema.must_equal({
+        model: model.to_s,
+        attributes: [
+          {name: :id, type: :integer},
+          {name: :tags, type: :array, items: {type: :string}},
+          {name: :address, type: :model, model: address_class.to_s, schema: {
+            model: address_class.to_s,
+            attributes: [
+              {name: :street, type: :string},
+              {name: :number, type: :integer}
+            ]
+          }},
+          {name: :metadata, type: :hash, key_type: {type: :symbol}, value_type: {type: :string}},
+          {name: :status, type: :enum, values: ['active', 'inactive']},
+          {name: :created_at, type: :time, format: '%Y-%m-%d'}
+        ]
+      })
+    end
+
+    it 'With options' do
+      model = Class.new(Rasti::Model) do
+        attribute :text, T::String, description: 'Basic text'
+      end
+
+      model.to_schema.must_equal({
+        model: model.to_s,
+        attributes: [
+          {name: :text, type: :string, options: {description: 'Basic text'}}
+        ]
+      })
+    end
+
+    it 'Type with to_schema' do
+      custom_type = Object.new
+      custom_type.define_singleton_method :to_schema do
+        {type: :custom, details: 'custom details'}
+      end
+
+      model = Rasti::Model[attr: custom_type]
+
+      model.to_schema.must_equal({
+        model: model.to_s,
+        attributes: [
+          {name: :attr, type: :custom, details: 'custom details'}
+        ]
+      })
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rasti-model
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Gabriel Naiman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2026-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_require
@@ -150,10 +150,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -162,6 +162,7 @@ files:
 - lib/rasti/model.rb
 - lib/rasti/model/attribute.rb
 - lib/rasti/model/errors.rb
+- lib/rasti/model/schema.rb
 - lib/rasti/model/version.rb
 - rasti-model.gemspec
 - spec/coverage_helper.rb
@@ -171,7 +172,7 @@ homepage: https://github.com/gabynaiman/rasti-model
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,8 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Domain models with typed attributes
 test_files:

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.2.9.0
-  - ruby-head
-  - jruby-head
-
-matrix:
-  fast_finish: true
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head