domainic-type 0.1.0.alpha.3.2.0 → 0.1.0.alpha.3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24abfbef9f478a43dce3382a737ceec2ea4310f69454d5d3e8903699f97454a0
-  data.tar.gz: aaede220a86b78362f4dd2a8e51ffdb320ba7352a88b4980dec244e7452662fc
+  metadata.gz: e864e12054b6928f12f7465eace3657aaa736e264a1655e7838ec4f2e658ebed
+  data.tar.gz: ac7c71c1bd2c2f992bb6aca1306291838a4b7eabc77326130db553de8a9dc18f
 SHA512:
-  metadata.gz: 22de008f6805303b6540c879a35a11366c41e49be7dc7ca76347436afaedf256e5b19d8de9242e0351ab0ba78bb6eebf6ad3a202c105b1523ba414836e3a5c64
-  data.tar.gz: 1eb03da0104dcd61ca5149471ae71f774206f342e01d23e73e71917db7189610346d7432d6f9ef9c0ef5a3f92767ec048905adb2004578d99fc7be82faf6c2b6
+  metadata.gz: 6029d7d12cb562dd7f2688472f0da97bcb548c544f163cf5215736d82ee0927e6f2c4ff87cc0d1818eefe722d10ac0ee2dd4ebccabff45412793340928e63cb8
+  data.tar.gz: 7ba6d7e41e431f2dd401bffecd60701a9dfeab35eeea3bef9085e97941d1b8327ddfd7cbe5febc577a0e1b3cce49147f6b686b56f1f6251257836d58327d198d

data/.yardopts

@@ -0,0 +1,11 @@
+--title Domainic::Type
+--readme README.md
+--no-private
+--protected
+--markup markdown
+--markup-provider redcarpet
+--embed-mixins
+--tag rbs
+--hide-tag rbs
+--files CHANGELOG.md,LICENSE,docs/USAGE.md
+'lib/**/*.rb'

data/README.md

@@ -2,30 +2,86 @@
 
 [![Domainic::Type Version](https://img.shields.io/gem/v/domainic-type?style=for-the-badge&logo=rubygems&logoColor=white&logoSize=auto&label=Gem%20Version)](https://rubygems.org/gems/domainic-type)
 [![Domainic::Type License](https://img.shields.io/github/license/domainic/domainic?logo=opensourceinitiative&logoColor=white&logoSize=auto&style=for-the-badge)](./LICENSE)
-[![Domainic::Type Open Issues](https://img.shields.io/github/issues-search/domainic/domainic?label=open%20issues&logo=github&logoSize=auto&query=is%3Aopen%20label%3Adomainic-type&color=red&style=for-the-badge)](https://github.com/domainic/domainic/issues?q=state%3Aopen%20label%3Adomainic-type%20)
+[![Domainic::Type Docs](https://img.shields.io/badge/rubydoc-blue?style=for-the-badge&logo=readthedocs&logoColor=white&logoSize=auto&label=docs)](https://rubydoc.info/gems/domainic-type/0.1.0)
+[![Domainic::Type Open Issues](https://img.shields.io/github/issues-search/domainic/domainic?query=state%3Aopen%20label%3Adomainic-type&color=red&style=for-the-badge&logo=github&logoColor=white&logoSize=auto&label=issues)](https://github.com/domainic/domainic/issues?q=state%3Aopen%20label%3Adomainic-type%20)
 
 > [!IMPORTANT]  
 > We're running an experiment with Domainic::Type! Help us explore flexible type validation in Ruby by trying our
-> [alpha release](../docs/experiments/domainic-type-alpha-3/README.md). Your feedback is invaluable for shaping
-> the future of domain-driven design in Ruby.
+> [alpha release](https://github.com/domainic/domainic/wiki/experiments-domainic-type-alpha-3). Your feedback is
+> invaluable for shaping the future of domain-driven design in Ruby.
 
-A flexible type validation system for Ruby, offering composable, readable type constraints with elegant error messages.
+A flexible type validation system for Ruby that brings the power of composable constraints and crystal-clear error
+messages to your domain models. Domainic::Type provides a rich set of built-in types that know how to validate
+themselves, intelligently handle various formats, and tell you exactly what's wrong when validation fails.
 
-Stop wrestling with complex type validations and unclear error messages. Domainic::Type brings type validation to Ruby
-that is both powerful and delightful to use. Build composable type constraints with crystal-clear error messages that
-actually tell you what went wrong. From simple type checks to complex collection validations, make your types work for
-you, not against you!
+This is particularly useful when building domain-driven applications, where strong type validation and clear error
+handling are essential. Instead of writing repetitive validation code and complex error messages, let Domainic::Type
+bring type safety to your Ruby code in a way that feels natural and expressive.
+
+## Quick Start
+
+```ruby
+require 'domainic/type/definitions'
+include Domainic::Type::Definitions
+
+# Type validation with clear error messages
+username = _String
+  .being_lowercase
+  .being_alphanumeric
+  .having_size_between(3, 20)
+
+username.validate!("ABC123")
+# => TypeError: Expected String(being lowercase), got String(not lowercase)
+
+# Rich collection validation
+admin_list = _Array
+  .of(_String)
+  .being_distinct
+  .being_ordered
+  .excluding("root")
+
+admin_list.validate!(["admin", "admin", "user"])
+# => TypeError: Expected Array(being distinct), got Array(containing duplicates)
+
+# Strong type constraints
+config = _Hash
+  .of(_Symbol => _String)
+  .containing_keys(:host, :port)
+
+config.validate!({ host: 123 })
+# => TypeError: Expected Hash(having values of String), got Hash(having values of Integer)
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'domainic-type', '~> 0.1.0.alpha.3'
+gem 'domainic-type'
 ```
 
 Or install it yourself as:
 
 ```bash
-gem install domainic-type --pre
+gem install domainic-type
 ```
+
+## Documentation
+
+For detailed usage instructions and examples, see [USAGE.md](./docs/USAGE.md).
+
+## Contributing
+
+We welcome contributions! Please see our
+[Contributing Guidelines](https://github.com/domainic/domainic/wiki/CONTRIBUTING) for:
+
+* Development setup and workflow
+* Code style and documentation standards
+* Testing requirements
+* Pull request process
+
+Before contributing, please review our [Code of Conduct](https://github.com/domainic/domainic/wiki/CODE_OF_CONDUCT).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](./LICENSE).