From cae594b95545b4790006ba44d82869a28b95e79d Mon Sep 17 00:00:00 2001
From: Teppei Shintani <teppest1215@gmail.com>
Date: Tue, 11 Jun 2024 09:17:18 +0900
Subject: [PATCH] update

---
 README.md                                     | 50 +++++++++++++++----
 lib/rbs_inline_data/writer.rb                 | 10 ++--
 .../data/lib/rbs_inline_data/parser.rbs       |  1 -
 3 files changed, 43 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 72062fd..91d2195 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,65 @@
 # RbsInlineData
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbs_inline_data`. To experiment with that code, run `bin/console` for an interactive prompt.
+`rbs_inline_data` gem is a tool for generating RBS files corresponding to `Data.define` in the [rbs-inline](https://github.com/soutaro/rbs-inline) syntax.
+This gem is intended to be used together with [rbs-inline](https://github.com/soutaro/rbs-inline).
+
+Here is an example of how to use it:
+
+```rb
+class User
+  Address = Data.define(
+    :city, #:: String
+    :street, #:: String
+  )
+end
+```
+
+This generates the following RBS file:
+
+```rbs
+class User::Address
+  extend Data::_DataClass
+  attr_reader city: String
+  attr_reader street: String
+  def self.new: (*untyped) -> ::User::Address
+              | (**untyped) -> ::User::Address
+              | ...
+end
+```
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add rbs_inline_data --require=false
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install rbs_inline_data
 
 ## Usage
 
-TODO: Write usage instructions here
+To generate RBS files, run the following command:
+
+    # Print generated RBS files
+    $ bundle exec rbs-inline-data lib
+
+    # Save generated RBS files under sig/generated/data
+    $ bundle exec rbs-inline-data lib --output
+
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+Run `rake rbs:setup` to prepare for type checking. Since this project includes implementations using `Data.define`, you can also verify the operation of `rbs-inline-data`.
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbs_inline_data. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rbs_inline_data/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/euglena1215/rbs_inline_data. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/euglena1215/rbs_inline_data/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the RbsInlineData project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbs_inline_data/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the RbsInlineData project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/euglena1215/rbs_inline_data/blob/main/CODE_OF_CONDUCT.md).
diff --git a/lib/rbs_inline_data/writer.rb b/lib/rbs_inline_data/writer.rb
index 7cc9af4..70703ba 100644
--- a/lib/rbs_inline_data/writer.rb
+++ b/lib/rbs_inline_data/writer.rb
@@ -30,9 +30,8 @@ def write(output_path)
 
     #:: (Array[RbsInlineData::Parser::TypedDefinition]) -> String
     def build_rbs(definitions)
-      rbs_text = ""
-      definitions.each do |definition|
-        source = <<~RBS
+      definitions.map do |definition|
+        <<~RBS
           class #{definition.class_name}
             extend Data::_DataClass
             #{definition.fields.map { |field| "attr_reader #{field.field_name}: #{field.type}" }.join("\n  ")}
@@ -41,10 +40,7 @@ def self.new: (*untyped) -> ::#{definition.class_name}
                         | ...
           end
         RBS
-
-        rbs_text += "#{source}\n"
-      end
-      rbs_text
+      end.join("\n")
     end
   end
 end
diff --git a/sig/generated/data/lib/rbs_inline_data/parser.rbs b/sig/generated/data/lib/rbs_inline_data/parser.rbs
index e577d26..da161b6 100644
--- a/sig/generated/data/lib/rbs_inline_data/parser.rbs
+++ b/sig/generated/data/lib/rbs_inline_data/parser.rbs
@@ -15,4 +15,3 @@ class RbsInlineData::Parser::TypedField
               | (**untyped) -> ::RbsInlineData::Parser::TypedField
               | ...
 end
-