steep-activesupport-4 1.9.3

data/guides/src/nil-optional/nil-optional.md

@@ -0,0 +1,195 @@
+# nil and Optional Types
+
+`nil`s have been the most common source of the errors you see when testing and after the deployment of your apps.
+
+```
+NoMethodError (undefined method `save!' for nil:NilClass)
+```
+
+Steep/RBS provides *optional types* to help you identify the problems while you are coding.
+
+## Preventing `nil` problems
+
+Technically, there is only one way to prevent `nil` problems – test everytime if the value is `nil` before calling methods with the receiver.
+
+```rb
+if account
+  account.save!
+end
+```
+
+Using the `if` statement is the most popular way to ensure the value is not `nil`. But you can do it with safe-navigation-operators, case-when (or case-in), and `#try` method.
+
+```rb
+account&.save!
+
+case account
+when Account
+  account.save!
+end
+
+account.try {|account| account.save! }
+```
+
+It's simple, but not easy to do in your code.
+
+**You may forget testing.** This happens easily. You don't notice that you forget until you deploy the code into production and it crashes after loading an account that is old and satisfies complicated conditions that leads it to be `nil`.
+
+**You may add redundant guards.** This won't get your app crash, but it will make understanding your code more difficult. It adds unnecessary noise that tells your teammates this can be `nil` in some place, and results in another redundant guard.
+
+The `nil` problems can be solved by a tool that tells you:
+
+* If the value can be `nil` or not, and
+* You forget testing the value before using the value
+
+RBS has a language construct to do this called optional types and Steep implements analysis to let you know if you forget testing the value.
+
+## Optional types
+
+Optional types in RBS are denoted with a suffix `?` – Type?. It means the value of the type may be `nil`.
+
+```
+Integer?            # Integer or nil
+Array[Account]?     # An array of Account or nil
+```
+
+Note that optional types can be included in other types as:
+
+```
+Array[Account?]
+```
+
+The value of the type above is always an array, but the element may be `nil`.
+
+In other words, a non optional type in RBS means the value cannot be `nil`.
+
+```
+Integer            # Integer, cannot be nil
+Array[Account]     # An array, cannot be nil
+```
+
+Let's see how Steep reports errors on optional and non-optional types.
+
+```rb
+account = Account.find(1)
+account.save!
+```
+
+Assume the type of `account` is `Account` (non optional type), the code type checks successfully. There is no chance to be `nil` here. The `save!` method call never results in a `NoMethodError`.
+
+```rb
+account = Account.find_by(email: "soutaro@squareup.com")
+account.save!
+```
+
+Steep reports a `NoMethod` error on the `save!` call. Because the value of the `account` may be `nil`, depending on the actual records in the `accounts` table. You cannot call the `save!` method without checking if the `account` is `nil`.
+
+You cannot assign `nil` to a local variable with non-optional types.
+
+```rb
+# @type var account: Account
+
+account = nil
+account = Account.find_by(email: "soutaro@squareup.com")
+```
+
+Because the type of `account` is declared Account, non-optional type, it cannot be `nil`. And Steep detects a type error if you try to assign `nil`. Same for assigning an optional type value at the last line.
+
+# Unwrapping optional types
+
+There are several ways to unwrap optional types. The most common one is using if.
+
+```rb
+account = Account.find_by(id: 1)
+if account
+  account.save!
+end
+```
+
+The *if* statement tests if `account` is `nil`. Inside the then clause, `account` cannot be `nil`. Then Steep type checks the code.
+
+This works for *else* clause of *unless*.
+
+```rb
+account = Account.find_by(id: 1)
+unless account
+  # Do something
+else
+  account.save!
+end
+```
+
+This also type checks successfully.
+
+Steep supports `nil?` predicate too.
+
+```rb
+unless (account = Account.find_by(id: 1)).nil?
+  account.save!
+end
+```
+
+This assumes the `Account` class doesn't have a custom `nil?` method, but keeps the built-in `nil?` or equivalent.
+
+The last one is using safe-nevigation-navigator. It checks if the receiver is `nil` and calls the method if it is not. Otherwise just evaluates to `nil`.
+
+```rb
+account = Account.find_by(id: 1)
+account&.save!
+```
+
+This is a shorthand for the case you don't do any error handling case if it is `nil`.
+
+## What should I do for the case of `nil`?
+
+There is no universal answer for this question. You may just stop the execution of the method by returning. You may want to insert a new account to ensure the record exists. Raising an exception with a detailed error message will help troubleshooting.
+
+It depends on what the program is expected to do. Steep just checks if accessing `nil` may happen or not. The developers only know how to handle the `nil` cases.
+
+# Handling unwanted `nil`s
+
+When you start using Steep, you may see many unwanted `nil`s. This typically happens when you want to use Array methods, like `first` or `sample`.
+
+```rb
+account = accounts.first
+account.save!
+```
+
+It returns `nil` if the array is empty. Steep cannot detect if the array is empty or not, and it conservatively assumes the return value of the methods may be `nil`. While you know the `account` array is not empty, Steep infer the `first` method may return `nil`.
+
+This is one of the most frequently seen sources of unwanted `nil`s.
+
+## Raising an error
+
+In this case, you have to add an extra code to let Steep unwrap it.
+
+```rb
+account = accounts.first or raise
+account.save!
+```
+
+My recommendation is to raise an exception, `|| raise` or `or raise`. It raises an exception in the case of `nil`, and Steep unwraps the type of the `account` variable.
+
+Exceptions are better than other control flow operators – `return`/`break`/`next`. It doesn't affect the control flow until it actually happens during execution, and the type checking result other than the unwrapping is changed.
+
+An `#raise` call without argument is my favorite. It's short. It's uncommon in the Ruby code and it can tell the readers that something unexpected is happening.
+
+But of course, you can add some message:
+
+```rb
+account = accounts.first or raise("accounts cannot be empty")
+account.save!
+```
+
+## Type assertions
+
+You can also use a type assertion, that is introduced in Steep 1.3.
+
+```rb
+account = accounts.first #: Account
+account.save!
+```
+
+It tells Steep that the right hand side of the assignment is `Account`. That overwrites the type checking algorithm, and the developer is responsible for making sure the value cannot be `nil`.
+
+Note: Nothing happens during the execution. It just works for Steep and Ruby doesn't do any extra type checking on it. I recommend using the `or raise` idiom for most of the cases.

data/lib/steep/annotation_parser.rb

@@ -0,0 +1,199 @@
+module Steep
+  class AnnotationParser
+    VAR_NAME = /[a-z][A-Za-z0-9_]*/
+    METHOD_NAME = Regexp.union(
+      /[^.:\s]+/
+    )
+    CONST_NAME = Regexp.union(
+      /(::)?([A-Z][A-Za-z0-9_]*::)*[A-Z][A-Za-z0-9_]*/
+    )
+    DYNAMIC_NAME = /(self\??\.)?#{METHOD_NAME}/
+    IVAR_NAME = /@[^:\s]+/
+
+    attr_reader :factory
+
+    def initialize(factory:)
+      @factory = factory
+    end
+
+    class SyntaxError < StandardError
+      attr_reader :source
+      attr_reader :location
+
+      def initialize(source:, location:, exn: nil, message: nil)
+        @source = source
+        @location = location
+
+        if exn
+          message =
+            case exn
+            when RBS::ParsingError
+              Diagnostic::Signature::SyntaxError.parser_syntax_error_message(exn)
+            else
+              exn.message
+            end
+        end
+
+        super message
+      end
+    end
+
+    TYPE = /(?<type>.*)/
+    COLON = /\s*:\s*/
+
+    PARAM = /[A-Z][A-Za-z0-9_]*/
+    TYPE_PARAMS = /(\[(?<params>#{PARAM}(,\s*#{PARAM})*)\])?/
+
+    def parse_type(match, name = :type, location:)
+      string = match[name] or raise
+      st, en = match.offset(name)
+      st or raise
+      en or raise
+      loc = RBS::Location.new(location.buffer, location.start_pos + st, location.start_pos + en)
+
+      type =
+        begin
+          RBS::Parser.parse_type(string)
+        rescue RBS::ParsingError => exn
+          raise SyntaxError.new(source: string, location: loc, exn: exn)
+        end or raise
+
+      unless (type.location || raise).source == string.strip
+        raise SyntaxError.new(source: string, location: loc, message: "Failed to parse a type in annotation")
+      end
+
+      factory.type(type)
+    end
+
+    def keyword_subject_type(keyword, name)
+      /@type\s+#{keyword}\s+(?<name>#{name})#{COLON}#{TYPE}/
+    end
+
+    def keyword_and_type(keyword)
+      /@type\s+#{keyword}#{COLON}#{TYPE}/
+    end
+
+    def parse(src, location:)
+      case src
+      when keyword_subject_type("var", VAR_NAME)
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          name = match[:name] or raise
+
+          AST::Annotation::VarType.new(name: name.to_sym,
+                                       type: parse_type(match, location: location),
+                                       location: location)
+        end
+
+      when keyword_subject_type("method", METHOD_NAME)
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          name = match[:name] or raise
+          type = match[:type] or raise
+
+          method_type = factory.method_type(RBS::Parser.parse_method_type(type) || raise)
+
+          AST::Annotation::MethodType.new(name: name.to_sym,
+                                          type: method_type,
+                                          location: location)
+        end
+
+      when keyword_subject_type("const", CONST_NAME)
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          name = match[:name] or raise
+          type = parse_type(match, location: location)
+
+          AST::Annotation::ConstType.new(name: RBS::TypeName.parse(name), type: type, location: location)
+        end
+
+      when keyword_subject_type("ivar", IVAR_NAME)
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          name = match[:name] or raise
+          type = parse_type(match, location: location)
+
+          AST::Annotation::IvarType.new(name: name.to_sym,
+                                         type: type,
+                                         location: location)
+        end
+
+      when keyword_and_type("return")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+          AST::Annotation::ReturnType.new(type: type, location: location)
+        end
+
+      when keyword_and_type("block")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+          AST::Annotation::BlockType.new(type: type, location: location)
+        end
+
+      when keyword_and_type("self")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+          AST::Annotation::SelfType.new(type: type, location: location)
+        end
+
+      when keyword_and_type("instance")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+          AST::Annotation::InstanceType.new(type: type, location: location)
+        end
+
+      when keyword_and_type("module")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+          AST::Annotation::ModuleType.new(type: type, location: location)
+        end
+
+      when keyword_and_type("break")
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type = parse_type(match, location: location)
+
+          AST::Annotation::BreakType.new(type: type, location: location)
+        end
+
+      when /@dynamic\s+(?<names>(#{DYNAMIC_NAME}\s*,\s*)*#{DYNAMIC_NAME})/
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          names = (match[:names] || raise).split(/\s*,\s*/)
+
+          AST::Annotation::Dynamic.new(
+            names: names.map {|name|
+              case
+              when name.delete_prefix!("self.")
+                AST::Annotation::Dynamic::Name.new(name: name.to_sym, kind: :module)
+              when name.delete_prefix!("self?.")
+                AST::Annotation::Dynamic::Name.new(name: name.to_sym, kind: :module_instance)
+              else
+                AST::Annotation::Dynamic::Name.new(name: name.to_sym, kind: :instance)
+              end
+            },
+            location: location
+          )
+        end
+
+      when /@implements\s+(?<name>#{CONST_NAME})#{TYPE_PARAMS}$/
+        Regexp.last_match.yield_self do |match|
+          match or raise
+          type_name = RBS::TypeName.parse(match[:name] || raise)
+          params = match[:params]&.yield_self {|params| params.split(/,/).map {|param| param.strip.to_sym } } || []
+
+          name = AST::Annotation::Implements::Module.new(name: type_name, args: params)
+          AST::Annotation::Implements.new(name: name, location: location)
+        end
+      end
+
+    rescue RBS::ParsingError => exn
+      raise SyntaxError.new(source: src, location: location, exn: exn)
+    end
+  end
+end

data/lib/steep/ast/annotation/collection.rb

@@ -0,0 +1,172 @@
+module Steep
+  module AST
+    module Annotation
+      class Collection
+        attr_reader :annotations
+        attr_reader :factory
+        attr_reader :context
+
+        attr_reader :var_type_annotations
+        attr_reader :const_type_annotations
+        attr_reader :ivar_type_annotations
+        attr_reader :method_type_annotations
+        attr_reader :block_type_annotation
+        attr_reader :return_type_annotation
+        attr_reader :self_type_annotation
+        attr_reader :instance_type_annotation
+        attr_reader :module_type_annotation
+        attr_reader :implement_module_annotation
+        attr_reader :dynamic_annotations
+        attr_reader :break_type_annotation
+
+        def initialize(annotations:, factory:, context:)
+          @annotations = annotations
+          @factory = factory
+          @context = context
+
+          @var_type_annotations = {}
+          @method_type_annotations = {}
+          @const_type_annotations = {}
+          @ivar_type_annotations = {}
+          @dynamic_annotations = []
+
+          annotations.each do |annotation|
+            case annotation
+            when VarType
+              var_type_annotations[annotation.name] = annotation
+            when MethodType
+              method_type_annotations[annotation.name] = annotation
+            when BlockType
+              @block_type_annotation = annotation
+            when ReturnType
+              @return_type_annotation = annotation
+            when SelfType
+              @self_type_annotation = annotation
+            when ConstType
+              @const_type_annotations[annotation.name] = annotation
+            when InstanceType
+              @instance_type_annotation = annotation
+            when ModuleType
+              @module_type_annotation = annotation
+            when Implements
+              @implement_module_annotation = annotation
+            when IvarType
+              @ivar_type_annotations[annotation.name] = annotation
+            when Dynamic
+              @dynamic_annotations << annotation
+            when BreakType
+              @break_type_annotation = annotation
+            else
+              raise "Unexpected annotation: #{annotation.inspect}"
+            end
+          end
+        end
+
+        def absolute_type(type)
+          if type
+            factory.absolute_type(type, context: context)
+          end
+        end
+
+        def var_type(lvar: nil, ivar: nil, const: nil)
+          case
+          when lvar
+            absolute_type(var_type_annotations[lvar]&.type)
+          when ivar
+            absolute_type(ivar_type_annotations[ivar]&.type)
+          when const
+            absolute_type(const_type_annotations[const]&.type)
+          end
+        end
+
+        def method_type(name)
+          if (a = method_type_annotations[name])
+            a.type.map_type {|type| absolute_type(type) }
+          end
+        end
+
+        def block_type
+          absolute_type(block_type_annotation&.type)
+        end
+
+        def return_type
+          absolute_type(return_type_annotation&.type)
+        end
+
+        def self_type
+          absolute_type(self_type_annotation&.type)
+        end
+
+        def instance_type
+          absolute_type(instance_type_annotation&.type)
+        end
+
+        def module_type
+          absolute_type(module_type_annotation&.type)
+        end
+
+        def break_type
+          absolute_type(break_type_annotation&.type)
+        end
+
+        def lvar_types
+          var_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[Symbol, Types::t]
+            hash[name] = var_type(lvar: name) || raise
+          end
+        end
+
+        def ivar_types
+          ivar_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[Symbol, Types::t]
+            hash[name] = var_type(ivar: name) || raise
+          end
+        end
+
+        def const_types
+          const_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[RBS::TypeName, Types::t]
+            hash[name] = var_type(const: name) || raise
+          end
+        end
+
+        def instance_dynamics
+          dynamic_annotations.flat_map do |annot|
+            annot.names.select(&:instance_method?).map(&:name)
+          end
+        end
+
+        def module_dynamics
+          dynamic_annotations.flat_map do |annot|
+            annot.names.select(&:module_method?).map(&:name)
+          end
+        end
+
+        def merge_block_annotations(annotations)
+          if annotations.context != context || annotations.factory != factory
+            raise "Cannot merge another annotation: self=#{self}, other=#{annotations}"
+          end
+
+          retained_annotations = self.annotations.reject do |annotation|
+            annotation.is_a?(BlockType) || annotation.is_a?(BreakType)
+          end
+
+          self.class.new(
+            annotations: retained_annotations + annotations.annotations,
+            factory: factory,
+            context: context
+          )
+        end
+
+        def any?(&block)
+          annotations.any?(&block)
+        end
+
+        def size
+          annotations.size
+        end
+
+        def include?(obj)
+          annotations.include?(obj)
+        end
+      end
+    end
+  end
+end

data/lib/steep/ast/annotation.rb

@@ -0,0 +1,137 @@
+module Steep
+  module AST
+    module Annotation
+      module Located
+        attr_reader :location
+
+        def line
+          location&.start_line
+        end
+      end
+
+      class Named
+        include Located
+
+        attr_reader :name
+        attr_reader :type
+
+        def initialize(name:, type:, location: nil)
+          @name = name
+          @type = type
+          @location = location
+        end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            other.name == name &&
+            other.type == type
+        end
+      end
+
+      class Typed
+        include Located
+
+        attr_reader :type
+
+        def initialize(type:, location: nil)
+          @type = type
+          @location = location
+        end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            other.type == type
+        end
+      end
+
+      class ReturnType < Typed; end
+      class BlockType < Typed; end
+      class SelfType < Typed; end
+      class InstanceType < Typed; end
+      class ModuleType < Typed; end
+      class BreakType < Typed; end
+
+      class MethodType < Named; end
+      class VarType < Named; end
+      class ConstType < Named; end
+      class IvarType < Named; end
+
+      class Implements
+        class Module
+          attr_reader :name
+          attr_reader :args
+
+          def initialize(name:, args:)
+            @name = name
+            @args = args
+          end
+
+          def ==(other)
+            other.is_a?(Module) && other.name == name && other.args == args
+          end
+
+          alias eql? ==
+
+          def hash
+            self.class.hash ^ name.hash ^ args.hash
+          end
+        end
+
+        include Located
+
+        attr_reader :name
+
+        def initialize(name:, location: nil)
+          @location = location
+          @name = name
+        end
+
+        def ==(other)
+          other.is_a?(Implements) && other.name == name
+        end
+      end
+
+      class Dynamic
+        class Name
+          attr_reader :kind
+          attr_reader :name
+          attr_reader :location
+
+          def initialize(name:, kind:, location: nil)
+            @name = name
+            @kind = kind
+            @location = location
+          end
+
+          def instance_method?
+            kind == :instance || kind == :module_instance
+          end
+
+          def module_method?
+            kind == :module || kind == :module_instance
+          end
+
+          def ==(other)
+            other.is_a?(Name) &&
+              other.name == name &&
+              other.kind == kind
+          end
+        end
+
+        include Located
+
+        attr_reader :names
+
+        def initialize(names:, location: nil)
+          @location = location
+          @names = names
+        end
+
+        def ==(other)
+          other.is_a?(Dynamic) &&
+            other.names == names
+        end
+      end
+    end
+  end
+end