rails-annotate-solargraph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0841b81a947cf88befe6531d7b4c8aabc0f3d1708b12543bf88e56f39835aea0'
+  data.tar.gz: 32e2be64e71eb09976f8babea38ec7fc0f8dc0373970ade0a09c65e36f56cb62
+SHA512:
+  metadata.gz: a485c9e9acb53bd7dec92be97e9f57386ddebe913ead221e7fa00ad8e0f7ec697968dde5195514fef12af9a0d9d674cfd91e6db7a1f8e0c32297d61555892bd9
+  data.tar.gz: 4603a5ff8d88b3e732afa1f2dfb5aa76a2ef01b7b32cde7105d5881bcf60c3db9e2345c43780ef623ef8f0b4e25d71489ee9c5e04a3b24bccd4e886a99a9cfba

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-gemset

@@ -0,0 +1 @@
+rails-annotate-solargraph

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "cSpell.words": [
+    "activerecord",
+    "rakefile",
+    "solargraph",
+    "yieldparam"
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-annotate-solargraph.gemspec
+gemspec
+
+gem 'debug'
+gem 'git'
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"
+gem "solargraph"
+gem "sqlite3", "~> 1.4"

data/Gemfile.lock

@@ -0,0 +1,232 @@
+PATH
+  remote: .
+  specs:
+    rails-annotate-solargraph (0.1.0)
+      rails (>= 5.0, < 8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    e2mmap (0.1.0)
+    erubi (1.10.0)
+    git (1.10.2)
+      rchardet (~> 1.8)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.2)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.2.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rchardet (1.8.0)
+    regexp_parser (2.2.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    solargraph (0.44.3)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    sqlite3 (1.4.2)
+    strscan (3.0.1)
+    thor (1.2.1)
+    tilt (2.0.10)
+    timeout (0.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-20
+  ruby
+
+DEPENDENCIES
+  debug
+  git
+  minitest (~> 5.0)
+  rails-annotate-solargraph!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  solargraph
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mateusz Drewniak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Rails::Annotate::Solargraph
+
+![pipeline status](https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph/badges/main/pipeline.svg)
+
+This gem is inspired by [ctran/annotate_models](https://github.com/ctran/annotate_models).
+
+It automatically generates YARD comments for every model
+in your Rails application. They're formatted in a way to make them easy
+to parse for [Solargraph](https://solargraph.org/) (a great gem that serves
+as a Ruby language server for your IDE).
+
+Here's how you can generate and use these annotations.
+
+![Annotation Generation Gif](readme_assets/annotation_generation_demo.gif)
+
+They're automatically updated and generated when you execute migrations
+in the development environment.
+
+![Automatic Annotations Gif](readme_assets/automatic_annotations_demo.gif)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-annotate-solargraph'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-annotate-solargraph
+
+Then use this command to generate appropriate Rakefiles
+
+    $ rails g annotate:solargraph:install
+
+
+And you're ready to go!
+
+Comments should be automatically added and
+updated once you execute a migration.
+
+## Usage
+
+You can also manually generate or remove annotations.
+
+### Annotate all models
+
+    $ rake annotate:solargraph:generate
+
+### Remove all annotations
+
+    $ rake annotate:solargraph:remove
+
+### Configure
+
+You can change the gem's default configuration like so:
+
+```ruby
+# config/initializers/rails_annotate_solargraph.rb
+
+Rails::Annotate::Solargraph.configure do |conf|
+    conf.annotation_position = :top # `:bottom` by default
+end
+```
+
+## 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.
+
+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 Gitlab at https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/rails/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails/annotate/solargraph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+cd test/rails/annotate/solargraph/rails_7_0
+bundle install

data/lib/generators/annotate/solargraph/install_generator.rb

@@ -0,0 +1,15 @@
+module Annotate
+  module Solargraph
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc 'Generate rails-annotate-solargraph rakefiles.'
+        source_root ::File.expand_path('templates', __dir__)
+
+        # copy rake tasks
+        def copy_tasks
+          template ::Rails::Annotate::Solargraph::RAKEFILE_NAME, ::File.join('lib', 'tasks', ::Rails::Annotate::Solargraph::RAKEFILE_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/generators/annotate/solargraph/templates/rails_annotate_solargraph.rake

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+if ::Rails.env.development?
+  namespace :annotate do
+    namespace :solargraph do
+      desc "Add YARD comments documenting the models' schemas"
+      task generate: :environment do
+        system 'rails runner "p ::Rails::Annotate::Solargraph.generate"'
+      end
+
+      desc "Remove YARD comments documenting the models' schemas"
+      task remove: :environment do
+        system 'rails runner "p ::Rails::Annotate::Solargraph.remove"'
+      end
+    end
+
+    migration_tasks = %w[db:migrate db:migrate:up db:migrate:down db:migrate:reset db:migrate:redo db:rollback]
+    migration_tasks.each do |task|
+      next unless ::Rake::Task.task_defined?(task)
+
+      ::Rake::Task[task].enhance do
+        ::Rake::Task['annotate:solargraph:generate'].invoke
+      end
+    end
+  end
+end

data/lib/rails/annotate/solargraph/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Rails
+  module Annotate
+    module Solargraph
+      class Configuration
+        # @return [Symbol]
+        attr_reader :annotation_position
+
+        ANNOTATION_POSITIONS = ::Set[:bottom, :top].freeze
+
+        def initialize
+          @annotation_position = :bottom
+        end
+
+        # @param val [Symbol]
+        def annotation_position=(val)
+          raise Error, "`annotation_position` is incorrect! Got `#{val.inspect}`, expected a member of `#{ANNOTATION_POSITIONS.inspect}`" \
+           unless ANNOTATION_POSITIONS.include?(val)
+
+          @annotation_position = val
+        end
+      end
+    end
+  end
+end

data/lib/rails/annotate/solargraph/model.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Rails
+  module Annotate
+    module Solargraph
+      class Model
+        ANNOTATION_START = "\n# %%<RailsAnnotateSolargraph:Start>%%"
+        ANNOTATION_END = "%%<RailsAnnotateSolargraph:End>%%\n\n"
+        ANNOTATION_REGEXP = /#{ANNOTATION_START}.*#{ANNOTATION_END}/m.freeze
+        MAGIC_COMMENT_REGEXP = /(^#\s*encoding:.*(?:\n|r\n))|(^# coding:.*(?:\n|\r\n))|(^# -\*- coding:.*(?:\n|\r\n))|(^# -\*- encoding\s?:.*(?:\n|\r\n))|(^#\s*frozen_string_literal:.+(?:\n|\r\n))|(^# -\*- frozen_string_literal\s*:.+-\*-(?:\n|\r\n))/.freeze
+
+        class << self
+          # @param type [Symbol, String, nil]
+          # @return [String]
+          def active_record_type_to_yard(type)
+            case type&.to_sym
+            when :float
+              ::Float.to_s
+            when :integer
+              ::Integer.to_s
+            when :decimal
+              ::BigDecimal.to_s
+            when :datetime, :timestamp, :time
+              ::Time.to_s
+            when :json, :jsonb
+              ::Hash.to_s
+            when :date
+              ::Date.to_s
+            when :text, :string, :binary, :inet, :uuid
+              ::String.to_s
+            when :boolean
+              'Boolean'
+            else
+              ::Object.to_s
+            end
+          end
+        end
+
+        # @return [String]
+        attr_reader :file_name
+
+        # @return [Class]
+        attr_reader :klass
+
+        # @param klass [Class]
+        def initialize(klass)
+          @klass = klass
+          @file_name = ::File.join(::Rails.root, MODEL_DIR, "#{klass.to_s.underscore}.rb")
+        end
+
+        # @param :write [Boolean]
+        # @return [String] New file content.
+        def annotate(write: true)
+          file_content = remove_annotation write: false
+
+          if CONFIG.annotation_position == :top
+            magic_comments = file_content.scan(MAGIC_COMMENT_REGEXP).flatten.compact.join
+            file_content.sub!(MAGIC_COMMENT_REGEXP, '')
+
+            new_file_content = magic_comments + annotation + file_content
+          else
+            new_file_content = file_content + annotation
+          end
+
+          return new_file_content unless write
+          return new_file_content if file_content == new_file_content
+
+          ::File.write @file_name, new_file_content
+          new_file_content
+        end
+
+        # @param :write [Boolean]
+        # @return [String] New file content.
+        def remove_annotation(write: true)
+          file_content = ::File.read(@file_name)
+          new_file_content = file_content.sub(ANNOTATION_REGEXP, '')
+          return new_file_content unless write
+          return new_file_content if file_content == new_file_content
+
+          ::File.write @file_name, new_file_content
+          new_file_content
+        end
+
+        # @return [String]
+        def annotation
+          result = ::String.new
+          result << <<~DOC
+            #{ANNOTATION_START}
+            # @!parse
+            #   class #{@klass} < #{@klass.superclass}
+          DOC
+
+          @klass.attribute_types.each do |name, attr_type|
+            result << <<~DOC
+              #     # Database column `#{@klass.table_name}.#{name}`, type: `#{attr_type.type}`.
+              #     # @param val [#{yard_type attr_type}, nil]
+              #     def #{name}=(val); end
+              #     # Database column `#{@klass.table_name}.#{name}`, type: `#{attr_type.type}`.
+              #     # @return [#{yard_type attr_type}, nil]
+              #     def #{name}; end
+            DOC
+          end
+
+          result << <<~DOC.chomp
+            #   end
+            # #{ANNOTATION_END}
+          DOC
+        end
+
+        private
+
+        # @param attr_type [ActiveModel::Type::Value]
+        # @return [String]
+        def yard_type(attr_type)
+          return attr_type.coder.object_class.to_s if attr_type.respond_to?(:coder) && attr_type.coder.respond_to?(:object_class)
+          return 'Object' if attr_type.respond_to?(:coder) && attr_type.coder.is_a?(::ActiveRecord::Coders::JSON)
+
+          self.class.active_record_type_to_yard(attr_type.type)
+        end
+      end
+    end
+  end
+end

data/lib/rails/annotate/solargraph/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Annotate
+    module Solargraph
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/rails/annotate/solargraph.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'set'
+
+require_relative "solargraph/version"
+require_relative "solargraph/configuration"
+require_relative "solargraph/model"
+
+module Rails
+  module Annotate
+    module Solargraph
+      class Error < ::StandardError; end
+      # @return [String]
+      MODEL_DIR = 'app/models'
+      # @return [String]
+      RAKEFILE_NAME = 'rails_annotate_solargraph.rake'
+      # @return [Configuration]
+      CONFIG = Configuration.new
+
+      class << self
+        # @return [Array<String>] Array of changed files.
+        def generate
+          modify_models :annotate
+        end
+
+        # @return [Array<String>] Array of changed files.
+        def remove
+          modify_models :remove_annotation
+        end
+
+        # @yieldparam [Configuration]
+        def configure
+          yield(CONFIG)
+        end
+
+        alias call generate
+
+        VALID_MODIFICATION_METHODS = ::Set[:annotate, :remove_annotation]
+
+        private
+
+        # @param method [Symbol] Name of the method that will be called on every loaded Model
+        # @return [Array<String>] Array of changed files.
+        def modify_models(method)
+          raise Error, "Invalid method. Got `#{method.inspect}`, but expected a member of `#{VALID_MODIFICATION_METHODS}`" \
+            unless VALID_MODIFICATION_METHODS.include? method
+
+          changed_files = []
+          model_files = ::Dir[::File.join(::Rails.root, MODEL_DIR, '**/*.rb')].map { |file| file.sub("#{::Rails.root}/", '') }.to_set
+
+          ::Rails.application.eager_load!
+          (::ApplicationRecord rescue ::ActiveRecord::Base).subclasses.each do |subclass|
+            subclass_file = ::File.join MODEL_DIR, "#{subclass.to_s.underscore}.rb"
+            next unless model_files.include? subclass_file
+
+            Model.new(subclass).public_send(method)
+            changed_files << subclass_file
+          end
+
+          changed_files
+        end
+      end
+    end
+  end
+end

data/rails-annotate-solargraph.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails/annotate/solargraph/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails-annotate-solargraph"
+  spec.version = Rails::Annotate::Solargraph::VERSION
+  spec.authors = ["Mateusz Drewniak"]
+  spec.email = ["matmg24@gmail.com"]
+
+  spec.summary = "Annotate ActiveRecord models with schema comments formatted in YARD that are compatible with Solargraph."
+  spec.description = "Annotate ActiveRecord models with schema comments formatted in YARD that are compatible with Solargraph."
+  spec.homepage = "https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'rails', ">= 5.0", '< 8.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/rails/annotate/solargraph.rbs

@@ -0,0 +1,8 @@
+module Rails
+  module Annotate
+    module Solargraph
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: rails-annotate-solargraph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: Annotate ActiveRecord models with schema comments formatted in YARD that
+  are compatible with Solargraph.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/annotate/solargraph/install_generator.rb
+- lib/generators/annotate/solargraph/templates/rails_annotate_solargraph.rake
+- lib/rails/annotate/solargraph.rb
+- lib/rails/annotate/solargraph/configuration.rb
+- lib/rails/annotate/solargraph/model.rb
+- lib/rails/annotate/solargraph/version.rb
+- rails-annotate-solargraph.gemspec
+- readme_assets/annotation_generation_demo.gif
+- readme_assets/automatic_annotations_demo.gif
+- sig/rails/annotate/solargraph.rbs
+homepage: https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph
+  source_code_uri: https://gitlab.com/mateuszdrewniak/rails-annotate-solargraph
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Annotate ActiveRecord models with schema comments formatted in YARD that
+  are compatible with Solargraph.
+test_files: []