rails-tc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4de7e0ef2d8cbd984d8f7a39bd4485b5ea8b7175febb6b7e6598499b5943e8
+  data.tar.gz: 555d73a67397784495b845ccf3a6ddc28c99f6e0f3aaaf568215f2438f266f09
+SHA512:
+  metadata.gz: beddf0019850cc3dcff8dd0704bce524712ad90c816db5b2fae450ada4cccb3422e6fc9fb3a88134efb2edff999feeab76f2a68608893dd0730debd0501357bc
+  data.tar.gz: 51ed684438b851e66c18ffba0b14924a4e1fa5f24595850a86c407cc216cbcf279643a67ead893ce0836fe4af1de9199dda37afcf8a2de83c7c07dbbc774f00a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:3.0.2
+
+before_script:
+  - gem install bundler -v 2.2.25
+  - bundle install
+
+example_job:
+  script:
+    - bundle exec rake

data/.idea/workspace.xml

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="70f1023d-93df-464d-ae60-42cd1388a1e4" name="Changes" comment="">
+      <change afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.gitlab-ci.yml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.rspec" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/.rubocop.yml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/CHANGELOG.md" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/Gemfile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/LICENSE.txt" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/Rakefile" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/bin/console" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/bin/setup" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/command_runner.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/railtie.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/rubocop.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/tasks/tc.rake" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/type_checker.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/type_checker_error.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/rails/tc/version.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/rails-tc.gemspec" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/spec/rails/tc_spec.rb" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/spec/spec_helper.rb" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Ruby File" />
+      </list>
+    </option>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="GitSEFilterConfiguration">
+    <file-type-list>
+      <filtered-out-file-type name="LOCAL_BRANCH" />
+      <filtered-out-file-type name="REMOTE_BRANCH" />
+      <filtered-out-file-type name="TAG" />
+      <filtered-out-file-type name="COMMIT_BY_MESSAGE" />
+    </file-type-list>
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="22oxrhkAKjljfVppUYbrdhBm39d" />
+  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">
+    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
+    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
+    <property name="WebServerToolWindowFactoryState" value="false" />
+    <property name="last.edited.regexp" value="  * def (0.9)" />
+    <property name="last_opened_file_path" value="$PROJECT_DIR$/../fa-x" />
+    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
+    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
+    <property name="vue.rearranger.settings.migration" value="true" />
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="70f1023d-93df-464d-ae60-42cd1388a1e4" name="Changes" comment="" />
+      <created>1640517942267</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1640517942267</updated>
+      <workItem from="1640517945803" duration="6297000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-tc.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Oskar Kirmis
+
+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,39 @@
+# Rails::Tc
+
+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/rails/tc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-tc'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-tc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 GitHub at https://github.com/[USERNAME]/rails-tc.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails/tc"
+
+# 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
+
+# Do any other automated setup that you need to do here

data/lib/rails/tc/command_runner.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Rails
+  module Tc
+    module CommandRunner
+      def self.init
+        `bundle exec srb init 2>&1`
+      end
+
+      def self.generate
+        system "bundle exec tapioca gem"
+        system "bundle exec tapioca dsl"
+      end
+
+      def self.type_check
+        `bundle exec srb tc 2>&1`
+      end
+
+      def self.add_development_gem(gem)
+        system "bundle add #{gem} --group development" unless gem_installed?(gem)
+      end
+
+      def self.add_runtime_gem(gem)
+        system "bundle add #{gem}" unless gem_installed?(gem)
+      end
+
+      def self.gem_installed?(gem)
+        `bundle show`.scan(/^\s*\*\s*([^\s]+).*/).map(&:first).include? gem
+      end
+    end
+  end
+end

data/lib/rails/tc/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rails
+  module Tc
+    class Railtie < Rails::Railtie
+      railtie_name :tc
+
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/rails/tc/rubocop.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Rails
+  module Tc
+    module Rubocop
+      class InvalidConfigError < StandardError; end
+
+      ACCESSOR_GROUPING_PATH = "Style/AccessorGrouping"
+
+      def self.patch_configuration
+        rubocop_path = Rails.root.join(".rubocop.yml").to_s
+
+        return unless File.exist?(rubocop_path)
+
+        config = YAML.safe_load(File.read(rubocop_path))
+        raise InvalidConfigError.new("Invalid rubocop config") unless config.is_a?(Hash)
+
+        modified = false
+
+        if config.fetch(ACCESSOR_GROUPING_PATH, {}).fetch("Enabled", true)
+          config[ACCESSOR_GROUPING_PATH] = { "Enabled" => false }
+          modified = true
+        end
+
+        if modified
+          File.open(rubocop_path, "w") { |f| f.write YAML.dump(config) }
+          puts "Rubocop configuration patched"
+        else
+          puts "Rubocop configuration unchanged"
+        end
+      rescue
+        puts "Unable to patch Rubocop configuration"
+      end
+    end
+  end
+end

data/lib/rails/tc/tasks/tc.rake

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+namespace :tc do
+  desc "Setup type checking for the project"
+  task install: :environment do
+    Rails::Tc::CommandRunner.add_development_gem "sorbet"
+    Rails::Tc::CommandRunner.add_development_gem "tapioca"
+    Rails::Tc::CommandRunner.add_runtime_gem "sorbet-runtime"
+
+    Rails::Tc::CommandRunner.init unless Rails::Tc::TypeChecker.set_up?
+    Rails::Tc::CommandRunner.generate
+    Rails::Tc::Rubocop.patch_configuration
+  end
+
+  desc "Check types in the project"
+  task check: :environment do
+    checker = Rails::Tc::TypeChecker.new([], ["*/**/*.rbi"])
+
+    if checker.errors.empty?
+      puts "Good job, no errors"
+    else
+      checker.errors.each do |error|
+        puts error.to_s
+        puts "\n\n"
+      end
+
+      puts "Found #{checker.errors.size} errors"
+      Kernel.exit(-1)
+    end
+  end
+end

data/lib/rails/tc/type_checker.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "./type_checker_error"
+require_relative "./command_runner"
+
+module Rails
+  module Tc
+    class TypeChecker
+      ERROR_LINE_REGEX = %r{^([^:]+):([0-9]+): (.*) https://srb\.help/([0-9]+)$}.freeze
+
+      def self.set_up?
+        File.exist?(Rails.root.join("sorbet/config"))
+      end
+
+      def initialize(ignored_errors = [], ignored_patterns = [])
+        @ignored_errors = ignored_errors
+        @ignored_patterns = ignored_patterns
+      end
+
+      def errors
+        @errors ||= run
+      end
+
+      protected
+
+      def run
+        errors = []
+        current = T.let(nil, T.nilable(TypeCheckerError))
+
+        CommandRunner.type_check.split("\n", -1).each do |line|
+          result = line.scan ERROR_LINE_REGEX
+
+          if result.any?
+            current = TypeCheckerError.new(
+              result.first[0],
+              result.first[1].to_i,
+              result.first[3].to_i,
+              result.first[2]
+            )
+
+            errors.push current
+          elsif result.empty? && !current.nil? && line.start_with?("  ")
+            current.notes.push line
+          end
+        end
+
+        errors.reject do |error|
+          @ignored_errors.include?(error.code) ||
+            @ignored_patterns.any? { |pattern| File.fnmatch?(pattern, error.filename) }
+        end
+      end
+    end
+  end
+end

data/lib/rails/tc/type_checker_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rails
+  module Tc
+    class TypeCheckerError
+      attr_reader :filename, :message, :line, :code, :notes
+
+      def initialize(filename, line, code, message)
+        @filename = filename
+        @line = line
+        @code = code
+        @message = message
+        @notes = []
+      end
+
+      def to_s
+        "#{filename}:#{line}: #{message} https://srb.help/#{code}\n#{notes.join("\n")}"
+      end
+    end
+  end
+end

data/lib/rails/tc/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module Tc
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/tc.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "tc/version"
+require_relative "tc/type_checker"
+require_relative "tc/type_checker_error"
+require_relative "tc/command_runner"
+require_relative "tc/rubocop"
+require_relative "tc/railtie"

data/rails-tc.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails/tc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-tc"
+  spec.version       = Rails::Tc::VERSION
+  spec.authors       = ["Oskar Kirmis"]
+  spec.email         = ["oskar.kirmis@posteo.de"]
+
+  spec.summary       = "Type checking package for Rails using sorbet, tapioca and some magic to hide external errors."
+  spec.description   = "rails-tc bundles everything required to properly setup type checking with sorbet in rails projects"
+  spec.homepage      = "https://git.iftrue.de/okirmis/rails-tc"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: rails-tc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oskar Kirmis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-26 00:00:00.000000000 Z
+dependencies: []
+description: rails-tc bundles everything required to properly setup type checking
+  with sorbet in rails projects
+email:
+- oskar.kirmis@posteo.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".idea/workspace.xml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails/tc.rb
+- lib/rails/tc/command_runner.rb
+- lib/rails/tc/railtie.rb
+- lib/rails/tc/rubocop.rb
+- lib/rails/tc/tasks/tc.rake
+- lib/rails/tc/type_checker.rb
+- lib/rails/tc/type_checker_error.rb
+- lib/rails/tc/version.rb
+- rails-tc.gemspec
+homepage: https://git.iftrue.de/okirmis/rails-tc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://git.iftrue.de/okirmis/rails-tc
+  source_code_uri: https://git.iftrue.de/okirmis/rails-tc
+  changelog_uri: https://git.iftrue.de/okirmis/rails-tc
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Type checking package for Rails using sorbet, tapioca and some magic to hide
+  external errors.
+test_files: []