type_toolkit 0.0.2 → 0.0.3

data/sorbet/rbi/shims/lint_roller.rbi

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LintRoller
+  class Plugin; end
+end

data/sorbet/rbi/shims/minitest.rbi

@@ -0,0 +1,43 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Minitest
+  class Spec < Minitest::Test
+    extend Minitest::Spec::DSL
+
+    include RuboCop::Minitest::AssertOffense
+
+    sig do
+      params(
+        desc: T.anything,
+        block: T.proc.bind(T.self_type).void,
+      ).void
+    end
+    def it(desc = T.unsafe(nil), &block); end
+
+    module DSL
+      has_attached_class!(:out)
+
+      sig do
+        params(
+          desc: T.anything,
+          block: T.proc.bind(T.attached_class).void,
+        ).void
+      end
+      def describe(desc, &block); end
+
+      sig do
+        params(
+          desc: T.anything,
+          block: T.proc.bind(T.attached_class).void,
+        ).void
+      end
+      def it(desc = T.unsafe(nil), &block); end
+
+      sig do
+        params(block: T.proc.bind(T.attached_class).void).void
+      end
+      def before(&block); end
+    end
+  end
+end

data/sorbet/rbi/shims/rubocop_minitest.rbi

@@ -0,0 +1,17 @@
+# typed: true
+# frozen_string_literal: true
+
+module RuboCop
+  module Minitest
+    module AssertOffense
+      sig { params(source: String).void }
+      def assert_offense(source); end
+
+      sig { params(source: String).void }
+      def assert_no_offenses(source); end
+
+      sig { params(source: String).void }
+      def assert_correction(source); end
+    end
+  end
+end

data/sorbet/rbi/todo.rbi

@@ -0,0 +1,5 @@
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for unresolved constants.
+# Please instead update this file by running `bin/tapioca todo`.
+
+# typed: false

data/sorbet/tapioca/config.yml

@@ -0,0 +1,13 @@
+gem:
+  # Add your `gem` command parameters here:
+  #
+  # exclude:
+  # - gem_name
+  # doc: true
+  # workers: 5
+dsl:
+  # Add your `dsl` command parameters here:
+  #
+  # exclude:
+  # - SomeGeneratorName
+  # workers: 5

data/sorbet/tapioca/require.rb

@@ -0,0 +1,5 @@
+# typed: true
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require "minitest/spec"

data/spec/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from: ../.rubocop.yml
+
+Style/MethodCallWithArgsParentheses:
+  inherit_mode:
+    merge:
+      - AllowedPatterns
+      - AllowedMethods
+  AllowedMethods:
+    - assert
+    - refute
+  AllowedPatterns:
+    - "^assert_"
+    - "^refute_"

data/spec/nil_assertions_spec.rb

@@ -0,0 +1,19 @@
+# typed: true
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module TypeToolkit
+  class NilAssertionsTest < Minitest::Spec
+    describe "#not_nil!" do
+      it "returns self on non-nil values" do
+        x = "Hello, world!"
+        assert_same x, x.not_nil!
+      end
+
+      it "raises an error on nil values" do
+        assert_raises(UnexpectedNilError) { nil.not_nil! }
+      end
+    end
+  end
+end

data/spec/rubocop/cop/type_toolkit/dont_expect_unexpected_nil_spec.rb

@@ -0,0 +1,194 @@
+# typed: true
+# frozen_string_literal: true
+
+require "spec_helper"
+require "rubocop"
+require "rubocop/minitest/assert_offense"
+require "rubocop-type_toolkit"
+
+module RuboCop
+  module Cop
+    module TypeToolkit
+      class DontExpectUnexpectedNilSpec < ::Minitest::Spec
+        CONSTANT_NAMES = [
+          "UnexpectedNilError",
+          "::UnexpectedNilError",
+          "TypeToolkit::UnexpectedNilError",
+          "::TypeToolkit::UnexpectedNilError",
+        ].freeze
+
+        include RuboCop::Minitest::AssertOffense
+
+        before do
+          @cop = DontExpectUnexpectedNil.new
+        end
+
+        describe "assert_raises" do
+          CONSTANT_NAMES.each do |constant_name|
+            arrows_______ = "^" * constant_name.size
+
+            describe constant_name do
+              it "adds offense with a { } block" do
+                assert_offense(<<~RUBY)
+                  assert_raises(#{constant_name}) { foo }
+                  ^^^^^^^^^^^^^^#{arrows_______}^ #{assert_raises_message}
+                RUBY
+              end
+
+              it "adds offense with a do ... end block" do
+                assert_offense(<<~RUBY)
+                  assert_raises(#{constant_name}) do
+                  ^^^^^^^^^^^^^^#{arrows_______}^ #{assert_raises_message}
+                    foo
+                  end
+                RUBY
+              end
+
+              it "adds offense when passed among other arguments" do
+                assert_offense(<<~RUBY)
+                  assert_raises(ArgumentError, #{constant_name}) { foo }
+                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^#{arrows_______}^ #{assert_raises_message}
+                RUBY
+
+                assert_offense(<<~RUBY)
+                  assert_raises(#{constant_name}, ArgumentError) { foo }
+                  ^^^^^^^^^^^^^^#{arrows_______}^^^^^^^^^^^^^^^^ #{assert_raises_message}
+                RUBY
+              end
+            end
+          end
+
+          it "does not add offense when assert_raises is used with a different error" do
+            assert_no_offenses(<<~RUBY)
+              assert_raises(ArgumentError) { foo }
+            RUBY
+          end
+        end
+
+        describe "rescue" do
+          CONSTANT_NAMES.each do |constant_name|
+            arrows_______ = "^" * constant_name.size
+
+            describe constant_name do
+              it "adds offense" do
+                assert_offense(<<~RUBY)
+                  begin
+                    foo
+                  rescue #{constant_name}
+                         #{arrows_______} #{rescue_message}
+                    bar
+                  end
+                RUBY
+              end
+
+              it "adds offense when among other exceptions" do
+                assert_offense(<<~RUBY)
+                  begin
+                    foo
+                  rescue #{constant_name}, ArgumentError
+                         #{arrows_______} #{rescue_message}
+                    bar
+                  end
+                RUBY
+              end
+            end
+          end
+
+          it "does not add offense when rescuing other exceptions" do
+            assert_no_offenses(<<~RUBY)
+              begin
+                foo
+              rescue ArgumentError
+                bar
+              end
+            RUBY
+          end
+        end
+
+        describe "raise" do
+          CONSTANT_NAMES.each do |constant_name|
+            arrows_______ = "^" * constant_name.size
+
+            describe constant_name do
+              it "adds offense" do
+                assert_offense(<<~RUBY)
+                  raise #{constant_name}
+                  ^^^^^^#{arrows_______} #{raise_message}
+                RUBY
+              end
+
+              it "adds offense with a message" do
+                assert_offense(<<~RUBY)
+                  raise #{constant_name}, "message"
+                  ^^^^^^#{arrows_______}^^^^^^^^^^^ #{raise_message}
+                RUBY
+              end
+
+              it "adds offense with .new" do
+                assert_offense(<<~RUBY)
+                  raise #{constant_name}.new
+                  ^^^^^^#{arrows_______}^^^^ #{raise_message}
+                RUBY
+              end
+
+              it "adds offense with .new and a message" do
+                assert_offense(<<~RUBY)
+                  raise #{constant_name}.new, "message"
+                  ^^^^^^#{arrows_______}^^^^^^^^^^^^^^^ #{raise_message}
+                RUBY
+              end
+            end
+          end
+
+          it "does not add offense when raising other exceptions" do
+            assert_no_offenses(<<~RUBY)
+              raise ArgumentError
+            RUBY
+          end
+        end
+
+        describe "other usages of UnexpectedNilError" do
+          CONSTANT_NAMES.each do |constant_name|
+            arrows_______ = "^" * constant_name.size
+
+            it "adds offense when using #{constant_name}" do
+              assert_offense(<<~RUBY)
+                x = #{constant_name}
+                    #{arrows_______} #{general_usage_message}
+              RUBY
+            end
+          end
+
+          it "does not add offense when using other constants" do
+            assert_no_offenses(<<~RUBY)
+              x = ArgumentError
+              x = ::ArgumentError
+            RUBY
+          end
+        end
+
+        private
+
+        def assert_raises_message
+          "TypeToolkit/DontExpectUnexpectedNil: It is always a mistake for `not_nil!` to be called on nil, " \
+            "so tests should not expect any code to raise `UnexpectedNilError`. " \
+            "Change your code to gracefully handle `nil` instead."
+        end
+
+        def rescue_message
+          "TypeToolkit/DontExpectUnexpectedNil: It is always a mistake for `not_nil!` to be called on nil, " \
+            "so you should never try to rescue `UnexpectedNilError` specifically. " \
+            "Change your code to gracefully handle `nil` instead."
+        end
+
+        def raise_message
+          "TypeToolkit/DontExpectUnexpectedNil: `UnexpectedNilError` should only ever be raised by `NilClass#not_nil!`."
+        end
+
+        def general_usage_message
+          "TypeToolkit/DontExpectUnexpectedNil: `UnexpectedNilError` should only ever be used by `#not_nil!`."
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "type_toolkit"
+
+require "minitest/autorun"
+require "minitest/spec"

data/spec/type_toolkit_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+module TypeToolkit
+  class TypeToolkitSpec < Minitest::Spec
+    it "has a version number" do
+      refute_nil ::TypeToolkit::VERSION
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: type_toolkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alexander Momchilov
@@ -19,13 +19,77 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".ruby-version"
 - README.md
 - Rakefile
+- config/default.yml
+- lib/rubocop-type_toolkit.rb
+- lib/rubocop/cop/type_toolkit/dont_expect_unexpected_nil.rb
 - lib/type_toolkit.rb
+- lib/type_toolkit/ext/nil_assertions.rb
 - lib/type_toolkit/version.rb
 - sig/type_toolkit.rbs
+- sorbet/config
+- sorbet/rbi/annotations/.gitattributes
+- sorbet/rbi/annotations/minitest.rbi
+- sorbet/rbi/annotations/rainbow.rbi
+- sorbet/rbi/gems/.gitattributes
+- sorbet/rbi/gems/ast@2.4.3.rbi
+- sorbet/rbi/gems/benchmark@0.5.0.rbi
+- sorbet/rbi/gems/date@3.5.1.rbi
+- sorbet/rbi/gems/erb@6.0.1.rbi
+- sorbet/rbi/gems/erubi@1.13.1.rbi
+- sorbet/rbi/gems/io-console@0.8.2.rbi
+- sorbet/rbi/gems/json@2.18.1.rbi
+- sorbet/rbi/gems/language_server-protocol@3.17.0.5.rbi
+- sorbet/rbi/gems/lint_roller@1.1.0.rbi
+- sorbet/rbi/gems/logger@1.7.0.rbi
+- sorbet/rbi/gems/minitest@5.27.0.rbi
+- sorbet/rbi/gems/netrc@0.11.0.rbi
+- sorbet/rbi/gems/parallel@1.27.0.rbi
+- sorbet/rbi/gems/parser@3.3.10.2.rbi
+- sorbet/rbi/gems/pp@0.6.3.rbi
+- sorbet/rbi/gems/prettyprint@0.2.0.rbi
+- sorbet/rbi/gems/prism@1.9.0.rbi
+- sorbet/rbi/gems/psych@5.3.1.rbi
+- sorbet/rbi/gems/racc@1.8.1.rbi
+- sorbet/rbi/gems/rainbow@3.1.1.rbi
+- sorbet/rbi/gems/rake@13.3.1.rbi
+- sorbet/rbi/gems/rbi@0.3.9.rbi
+- sorbet/rbi/gems/rbs@4.0.0.dev.5.rbi
+- sorbet/rbi/gems/rdoc@7.2.0.rbi
+- sorbet/rbi/gems/regexp_parser@2.11.3.rbi
+- sorbet/rbi/gems/reline@0.6.3.rbi
+- sorbet/rbi/gems/require-hooks@0.2.2.rbi
+- sorbet/rbi/gems/rexml@3.4.4.rbi
+- sorbet/rbi/gems/rubocop-ast@1.49.0.rbi
+- sorbet/rbi/gems/rubocop-minitest@0.38.2.rbi
+- sorbet/rbi/gems/rubocop-rake@0.7.1.rbi
+- sorbet/rbi/gems/rubocop-shopify@2.18.0.rbi
+- sorbet/rbi/gems/rubocop@1.84.2.rbi
+- sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi
+- sorbet/rbi/gems/spoom@1.7.11.rbi
+- sorbet/rbi/gems/stringio@3.2.0.rbi
+- sorbet/rbi/gems/tapioca@0.17.10.rbi
+- sorbet/rbi/gems/thor@1.5.0.rbi
+- sorbet/rbi/gems/tsort@0.2.0.rbi
+- sorbet/rbi/gems/unicode-display_width@3.2.0.rbi
+- sorbet/rbi/gems/unicode-emoji@4.2.0.rbi
+- sorbet/rbi/gems/yard-sorbet@0.9.0.rbi
+- sorbet/rbi/gems/yard@0.9.38.rbi
+- sorbet/rbi/shims/lint_roller.rbi
+- sorbet/rbi/shims/minitest.rbi
+- sorbet/rbi/shims/rubocop_minitest.rbi
+- sorbet/rbi/todo.rbi
+- sorbet/tapioca/config.yml
+- sorbet/tapioca/require.rb
+- spec/.rubocop.yml
+- spec/nil_assertions_spec.rb
+- spec/rubocop/cop/type_toolkit/dont_expect_unexpected_nil_spec.rb
+- spec/spec_helper.rb
+- spec/type_toolkit_spec.rb
 homepage: https://github.com/Shopify/type_kit
 licenses: []
 metadata: