Add tests

Author: vinistock

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Request a review from @Shopify/ruby-dev-exp when a new PR is created
+* @Shopify/ruby-dev-exp

CODE_OF_CONDUCT.md

@@ -0,0 +1,78 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+
+

Gemfile

@@ -18,4 +18,5 @@ gem "rubocop-sorbet", "~> 0.7", require: false
 gem "sorbet-static-and-runtime"
 gem "tapioca", "~> 0.11", require: false
 
+# TODO: remove this line once we release a Ruby LSP version including the hover extension point
 gem "ruby-lsp", path: "../ruby-lsp"

README.md

@@ -1,28 +1,34 @@
 # RailsRubyLsp
-Short description and motivation.
+
+The RailsRubyLsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features. As long
+as this gem is a part of the project's bundle, the Ruby LSP will automatically load it to provide extra features.
 
 ## Usage
-How to use my plugin.
+
+This gem includes two elements that together allow for more Rails functionality in the editor. The first is a Rails
+engine that automatically exposes some APIs when running the Rails server in development mode. The second is a Ruby LSP
+extension that knows how to connect to the exposed APIs to fetch runtime information from the Rails server.
+
+In order to get the extra functionality in the editor, the Rails server must be running.
+
+Note: the Ruby LSP does not need to be restarted every time the Rails server is booted. If you need to shutdown the
+server, the extra features will simply disappear and come back once the server is running again.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem "rails_ruby_lsp"
 ```
 
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install rails_ruby_lsp
-```
-
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rails_ruby_lsp. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](https://github.com/Shopify/rails_ruby_lsp/blob/main/CODE_OF_CONDUCT.md) code of conduct.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+The gem is available as open source under the terms of the
+[MIT License](https://github.com/Shopify/rails_ruby_lsp/blob/main/LICENSE.txt).

Rakefile

@@ -3,8 +3,17 @@
 require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load "rails/tasks/engine.rake"
 
+load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

lib/rails_ruby_lsp.rb

@@ -5,5 +5,4 @@
 require "rails_ruby_lsp/engine"
 
 module RailsRubyLsp
-  # Your code goes here...
 end

lib/rails_ruby_lsp/engine.rb

@@ -10,7 +10,7 @@ class Engine < ::Rails::Engine
 
     initializer "rails_ruby_lsp.routes" do
       config.after_initialize do |app|
-        if Rails.env.development?
+        if Rails.env.development? || Rails.env.test?
           app.routes.prepend do
             T.bind(self, ActionDispatch::Routing::Mapper)
             mount(RailsRubyLsp::Engine => "/rails_ruby_lsp")

lib/ruby_lsp/hover.rb

@@ -16,7 +16,7 @@ def run(target)
           schema_file = File.join(RailsClient.instance.root, "db", "schema.rb")
           content = +""
           content << "[Schema](file://#{schema_file})\n\n" if File.exist?(schema_file)
-          content << model[:columns].map { |name, type| "**#{name}** | #{type}\n" }.join("\n")
+          content << model[:columns].map { |name, type| "**#{name}**: #{type}\n" }.join("\n")
           content
         end
       end