tapioca-compilers-dry_struct 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0840d4fb2c71cdea0fe01b82fab1a0c478823f1e8929d6f1c6d961bb3aca40e1'
-  data.tar.gz: e917669d24d90e8fe6d5fb32edaadd7bc8bf351cb2d276435b137542c63cab8d
+  metadata.gz: 328465f4867f3800e53f085041e812ae8be9e1a079ff239a100c5c9e7de8dec8
+  data.tar.gz: 75b0dae85cdf386ed9abb2b30521722065f300cc51d9e59bdff6e05f8581c08b
 SHA512:
-  metadata.gz: a927c2fa5debbbfb41ed0f49d6dffafffb7aea13f3f3b99a2a0d902b57da9770b02af4a86c6b1c3d8cca95543b0a4809746df733b03b6a96efadc70b2602baaa
-  data.tar.gz: 537998a563c39c7d3b1ccb30f686114a6de4a99bfcf47abc900a24e2e90cbd9b6ed111ca4782a129dc747c2c08841e0965d4df434ac52b2eca12b1018cb39f2c
+  metadata.gz: ae98c1c4e2f935bb64c5523971fd4dee9061022dc1f94558eedb8a917d6efe5db0f88eb983f163f8afd0375d1b1e624d455f76907b783adfc218d571c2272a1f
+  data.tar.gz: 688b11f616071382d840d6bba3576d1674c0003414ad3869dd4b75cb08defef05e698958e13b5bbe2e301295a72fe28d2793d7dc180b3ec1c9ca722cd5563293

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # tapioca-compilers-dry_struct Changelog
 
-## [v0.1.0](https://github.com/YukiJikumaru/tapioca-compilers-dry_struct/compare/v0.0.0...v0.0.1)
+## [v0.0.2](https://github.com/YukiJikumaru/tapioca-compilers-dry_struct/compare/v0.0.1...v0.0.2)
+
+- [Introduct CI(Github Action)]()
+
+## [v0.0.1](https://github.com/YukiJikumaru/tapioca-compilers-dry_struct/compare/v0.0.0...v0.0.1)
 
 - Move dry-monads from runtime_dependency to development_dependency
 

data/README.md

@@ -1,12 +1,59 @@
+# tapioca-compilers-dry_struct
+
+[![Gem Version](https://badge.fury.io/rb/tapioca-compilers-dry_struct.svg)](https://badge.fury.io/rb/tapioca-compilers-dry_struct) ![github action badge](https://github.com/YukiJikumaru/tapioca-compilers-dry_struct/actions/workflows/main.yml/badge.svg)
+
 **[WARNING] THIS APP IS ALPHA VERSION!!!**
 
 This script is a [Tapioca's custom DSL compiler](https://github.com/Shopify/tapioca#writing-custom-dsl-compilers) for [dry-struct](https://dry-rb.org/gems/dry-struct/main/).
 
-# References
+From this ruby code,
 
-https://discourse.dry-rb.org/t/dry-rb-sorbet-can-we-unite/961
+```
+class Example < Dry::Struct
+  attribute  :attr01, Types::String
+  attribute  :attr02, Types::String.optional
+  attribute? :attr03, Types::String
+  attribute  :attr04, Types::Integer
+  attribute  :attr05, Types::Date
+  attribute  :attr06, Types::Array.of(Types::String)
+  attribute  :attr07, Types.Constructor(User)
+  attribute  :attr08, Types::String | Types::Integer
+  attribute  :attr09, Types::Maybe::String
+end
+```
 
-https://github.com/Shopify/tapioca/issues/1210
+the compiler generates a rbi file below.
+
+```
+class Example
+  sig { returns(String) }
+  def attr01; end
+
+  sig { returns(T.nilable(String)) }
+  def attr02; end
+
+  sig { returns(T.nilable(String)) }
+  def attr03; end
+
+  sig { returns(Integer) }
+  def attr04; end
+
+  sig { returns(Date) }
+  def attr05; end
+
+  sig { returns(T::Array[String]) }
+  def attr06; end
+
+  sig { returns(User) }
+  def attr07; end
+
+  sig { returns(T.any(String, Integer)) }
+  def attr08; end
+
+  sig { returns(T.any(Dry::Monads::Maybe::Some, Dry::Monads::Maybe::None)) }
+  def attr09; end
+end
+```
 
 # Installation
 
@@ -22,7 +69,7 @@ And then execute:
 $ bundle
 ```
 
->  all the gem needs to do is to place the DSL compiler inside the lib/tapioca/dsl/compilers folder and it will be automatically discovered and loaded by Tapioca.
+> all the gem needs to do is to place the DSL compiler inside the lib/tapioca/dsl/compilers folder and it will be automatically discovered and loaded by Tapioca.
 >
 > https://github.com/Shopify/tapioca/blob/v0.10.2/README.md#writing-custom-dsl-compilers
 
@@ -47,16 +94,24 @@ bundle exec rake spec
 
 # Environment Variables
 
+You can change behaviours of the compiler by environment variables.
+
 ## DRY_PREFER_PLAIN_TIME
 
 \ | Ruby `Time` is typed as
 ------- | --------
-0(DEFAULT) | `::ActiveSupport::TimeWithZone`
+0 (DEFAULT) | `::ActiveSupport::TimeWithZone`
 1 | `::Time`
 
 ## DRY_USE_EXPERIMENTAL_SHAPE
 
 \ | `Types::Hash.schema(name: Types::String, age: Types::Integer)` is typed as
 ------- | --------
-0(DEFAULT) | `::T::Hash[::T.untyped, ::T.untyped]`
+0 (DEFAULT) | `::T::Hash[::T.untyped, ::T.untyped]`
 1 | `{ name: ::String, age: ::Integer }`
+
+# References
+
+https://discourse.dry-rb.org/t/dry-rb-sorbet-can-we-unite/961
+
+https://github.com/Shopify/tapioca/issues/1210

data/tapioca-compilers-dry_struct.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Yuki Jikumaru"]
   spec.email         = ["jikumaruyuki@gmail.com"]
   spec.license       = "MIT"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
 
   spec.summary       = "Tapioca's custom DSL compiler for dry-struct"
   spec.description   = spec.summary
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "tapioca", ">= 0.10"
   spec.add_runtime_dependency "dry-struct", ">= 1.2"
 
-  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "bundler", ">= 2.0.0"
   spec.add_development_dependency "rake", ">= 12.0"
   spec.add_development_dependency "rspec", ">= 3.10"
   spec.add_development_dependency "dry-monads", ">= 1.2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca-compilers-dry_struct
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yuki Jikumaru
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement