tapioca 0.4.24 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3346249d6372983bf2f589dc19126ec052dc93701d360e30d5b3f6955ece4f03
-  data.tar.gz: 68857527a145259323b58089e08caf23144fa9bc987de1a40b03ee4d0afa4bcb
+  metadata.gz: 0f8af6316243d26a0446636e00af5c9210296f5e5ac1f6065506af426d72c066
+  data.tar.gz: 7124feeb9e7ecc16c2de3897ae9dd2bd3a432be6295d66ab5c440c4377f6d1e1
 SHA512:
-  metadata.gz: 5d1affdb8f87456291175700165c84a121834abb89dd2bee50fb746926d752f05f1001dda59dad7f3688b081c97d94971829ebef8ea622f05acc2d264cc69632
-  data.tar.gz: 7ba8a6d28322f9155dcd4351b1d68e698038ae322154d71d2fc8c26d06135f816259355584ded1f57b5b1aad96ea364b5e5fad64ddc32bcbe0561ea89b993189
+  metadata.gz: 720a2022478adcffea11b8a52b486dec808544611c9792c8508224c8565a3a4aaaed9f0a512bf51417da1259275ba6dbbd09b318f5e8e438544ae54558e0e028
+  data.tar.gz: 8b5148ed02e2105b0c44134b98c99cb0e2c03144e8eca2293c8cf558b8dcff3141a5812141cb369e83cd830acb847a540f14303d2472ba7877518d4de55545ca

data/Gemfile

@@ -18,21 +18,21 @@ group(:deployment, :development) do
 end
 
 group(:development, :test) do
-  gem("smart_properties", ">= 1.15.0", require: false)
-  gem("frozen_record", ">= 0.17", require: false)
-  gem("sprockets", "~> 3.7", require: false)
-  gem("rails", "~> 5.2", require: false)
-  gem("state_machines", "~> 0.5.0", require: false)
-  gem("activerecord-typedstore", "~> 1.3", require: false)
+  gem("smart_properties", require: false)
+  gem("frozen_record", require: false)
+  gem("sprockets", require: false)
+  gem("rails", require: false)
+  gem("state_machines", require: false)
+  gem("activerecord-typedstore", require: false)
   gem("sqlite3")
-  gem("identity_cache", "~> 1.0", require: false)
+  gem("identity_cache", require: false)
   gem("cityhash", git: "https://github.com/csfrancis/cityhash.git",
                   ref: "3cfc7d01f333c01811d5e834f1495eaa29f87c36", require: false)
-  gem("activemodel-serializers-xml", "~> 1.0", require: false)
-  gem("activeresource", "~> 5.1", require: false)
-  gem("google-protobuf", "~> 3.12.0", require: false)
-  # Fix version to 0.14.1 since it is the last version to support Ruby 2.4
-  gem("shopify-money", "= 0.14.1", require: false)
-  gem("sidekiq", "~> 5.0", require: false) # Version 6 dropped support for Ruby 2.4
-  gem("nokogiri", "1.10.10", require: false) # Lock to last supported for Ruby 2.4
+  gem("activeresource", require: false)
+  gem("google-protobuf", require: false)
+  gem("shopify-money", require: false)
+  gem("sidekiq", require: false)
+  gem("nokogiri", require: false)
+  gem("config", require: false)
+  gem("aasm", require: false)
 end

data/README.md

@@ -117,8 +117,8 @@ This will generate DSL RBIs for specified constants (or for all handled constant
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. 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/tapioca/blob/master/CODE_OF_CONDUCT.md) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. 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/tapioca/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://github.com/Shopify/tapioca/blob/master/LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](https://github.com/Shopify/tapioca/blob/main/LICENSE.txt).

data/Rakefile

@@ -2,7 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
-Dir['tasks/**/*.rake'].each { |t| load t }
+Dir["tasks/**/*.rake"].each { |t| load t }
 
 Rake.application.options.trace = false
 
@@ -10,15 +10,13 @@ Rake::TestTask.new do |t|
   t.libs << "lib"
   t.libs << "spec"
   t.warning = false
-  t.test_files = FileList['spec/**/*_spec.rb']
+  t.test_files = FileList["spec/**/*_spec.rb"]
 end
 
 task(:spec) do
-  begin
-    Rake::Task[:test].execute
-  rescue RuntimeError
-    exit(1)
-  end
+  Rake::Task[:test].execute
+rescue RuntimeError
+  exit(1)
 end
 
 task(default: :spec)

data/exe/tapioca

@@ -1,7 +1,7 @@
 #! /usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'sorbet-runtime'
+require "sorbet-runtime"
 
 begin
   T::Configuration.default_checked_level = :never
@@ -20,4 +20,4 @@ end
 
 require_relative "../lib/tapioca/internal"
 
-Tapioca::Cli::Main.start(ARGV)
+Tapioca::Cli.start(ARGV)

data/lib/tapioca/cli.rb

@@ -1,8 +1,262 @@
 # typed: true
 # frozen_string_literal: true
 
-require 'thor'
+require "thor"
 
 module Tapioca
-  module Cli; end
+  class Cli < Thor
+    include(Thor::Actions)
+
+    class_option :outdir,
+      aliases: ["--out", "-o"],
+      banner: "directory",
+      desc: "The output directory for generated RBI files"
+    class_option :generate_command,
+      aliases: ["--cmd", "-c"],
+      banner: "command",
+      desc: "The command to run to regenerate RBI files"
+    class_option :file_header,
+      type: :boolean,
+      default: true,
+      desc: "Add a \"This file is generated\" header on top of each generated RBI file"
+    class_option :verbose,
+      aliases: ["-V"],
+      type: :boolean,
+      default: false,
+      desc: "Verbose output for debugging purposes"
+
+    map T.unsafe(["--version", "-v"] => :__print_version)
+
+    desc "init", "initializes folder structure"
+    def init
+      create_config
+      create_post_require
+      generate_binstub
+    end
+
+    desc "require", "generate the list of files to be required by tapioca"
+    def require
+      Tapioca.silence_warnings do
+        generator.build_requires
+      end
+    end
+
+    desc "todo", "generate the list of unresolved constants"
+    def todo
+      Tapioca.silence_warnings do
+        generator.build_todos
+      end
+    end
+
+    desc "dsl [constant...]", "generate RBIs for dynamic methods"
+    option :generators,
+      type: :array,
+      aliases: ["--gen", "-g"],
+      banner: "generator [generator ...]",
+      desc: "Only run supplied DSL generators"
+    option :exclude_generators,
+      type: :array,
+      banner: "generator [generator ...]",
+      desc: "Exclude supplied DSL generators"
+    option :verify,
+      type: :boolean,
+      default: false,
+      desc: "Verifies RBIs are up-to-date"
+    option :quiet,
+      aliases: ["-q"],
+      type: :boolean,
+      desc: "Supresses file creation output"
+    def dsl(*constants)
+      Tapioca.silence_warnings do
+        generator.build_dsl(
+          constants,
+          should_verify: options[:verify],
+          quiet: options[:quiet],
+          verbose: options[:verbose]
+        )
+      end
+    end
+
+    desc "gem [gem...]", "generate RBIs from gems"
+    option :all,
+      type: :boolean,
+      default: false,
+      desc: "Regenerate RBI files for all gems"
+    option :prerequire,
+      aliases: ["--pre", "-b"],
+      banner: "file",
+      desc: "A file to be required before Bundler.require is called"
+    option :postrequire,
+      aliases: ["--post", "-a"],
+      banner: "file",
+      desc: "A file to be required after Bundler.require is called"
+    option :exclude,
+      aliases: ["-x"],
+      type: :array,
+      banner: "gem [gem ...]",
+      desc: "Excludes the given gem(s) from RBI generation"
+    option :typed_overrides,
+      aliases: ["--typed", "-t"],
+      type: :hash,
+      banner: "gem:level [gem:level ...]",
+      desc: "Overrides for typed sigils for generated gem RBIs"
+    option :verify,
+      type: :boolean,
+      default: false,
+      desc: "Verifies RBIs are up-to-date"
+    def gem(*gems)
+      Tapioca.silence_warnings do
+        all = options[:all]
+        verify = options[:verify]
+
+        raise MalformattedArgumentError, "Options '--all' and '--verify' are mutually exclusive" if all && verify
+
+        unless gems.empty?
+          raise MalformattedArgumentError, "Option '--all' must be provided without any other arguments" if all
+          raise MalformattedArgumentError, "Option '--verify' must be provided without any other arguments" if verify
+        end
+
+        if gems.empty? && !all
+          generator.sync_rbis_with_gemfile(should_verify: verify)
+        else
+          generator.build_gem_rbis(all ? [] : gems)
+        end
+      end
+    end
+
+    desc "generate [gem...]", "DEPRECATED: generate RBIs from gems"
+    option :prerequire,
+      aliases: ["--pre", "-b"],
+      banner: "file",
+      desc: "A file to be required before Bundler.require is called"
+    option :postrequire,
+      aliases: ["--post", "-a"],
+      banner: "file",
+      desc: "A file to be required after Bundler.require is called"
+    option :exclude,
+      aliases: ["-x"],
+      type: :array,
+      banner: "gem [gem ...]",
+      desc: "Excludes the given gem(s) from RBI generation"
+    option :typed_overrides,
+      aliases: ["--typed", "-t"],
+      type: :hash,
+      banner: "gem:level [gem:level ...]",
+      desc: "Overrides for typed sigils for generated gem RBIs"
+    def generate(*gems)
+      gem_names = if gems.empty?
+        "--all"
+      else
+        gems.join(" ")
+      end
+      deprecation_message = <<~MSG
+        DEPRECATION: The `generate` command will be removed in a future release.
+
+        Start using `bin/tapioca gem #{gem_names}` instead.
+      MSG
+
+      say(deprecation_message, :red)
+      say("")
+
+      Tapioca.silence_warnings do
+        generator.build_gem_rbis(gems)
+      end
+
+      say("")
+      say(deprecation_message, :red)
+    end
+
+    desc "sync", "DEPRECATED: sync RBIs to Gemfile"
+    option :prerequire,
+      aliases: ["--pre", "-b"],
+      banner: "file",
+      desc: "A file to be required before Bundler.require is called"
+    option :postrequire,
+      aliases: ["--post", "-a"],
+      banner: "file",
+      desc: "A file to be required after Bundler.require is called"
+    option :exclude,
+      aliases: ["-x"],
+      type: :array,
+      banner: "gem [gem ...]",
+      desc: "Excludes the given gem(s) from RBI generation"
+    option :typed_overrides,
+      aliases: ["--typed", "-t"],
+      type: :hash,
+      banner: "gem:level [gem:level ...]",
+      desc: "Overrides for typed sigils for generated gem RBIs"
+    option :verify,
+      type: :boolean,
+      default: false,
+      desc: "Verifies RBIs are up-to-date"
+    def sync
+      deprecation_message = <<~MSG
+        DEPRECATION: The `sync` command will be removed in a future release.
+
+        Start using `bin/tapioca gem` instead.
+      MSG
+
+      say(deprecation_message, :red)
+      say("")
+
+      Tapioca.silence_warnings do
+        generator.sync_rbis_with_gemfile(should_verify: options[:verify])
+      end
+
+      say("")
+      say(deprecation_message, :red)
+    end
+
+    desc "--version, -v", "show version"
+    def __print_version
+      puts "Tapioca v#{Tapioca::VERSION}"
+    end
+
+    private
+
+    def create_config
+      create_file(Config::SORBET_CONFIG, skip: true) do
+        <<~CONTENT
+          --dir
+          .
+        CONTENT
+      end
+    end
+
+    def create_post_require
+      create_file(Config::DEFAULT_POSTREQUIRE, skip: true) do
+        <<~CONTENT
+          # typed: true
+          # frozen_string_literal: true
+
+          # Add your extra requires here (`tapioca require` can be used to boostrap this list)
+        CONTENT
+      end
+    end
+
+    def generate_binstub
+      bin_stub_exists = File.exist?("bin/tapioca")
+      installer = Bundler::Installer.new(Bundler.root, Bundler.definition)
+      spec = Bundler.definition.specs.find { |s| s.name == "tapioca" }
+      installer.generate_bundler_executable_stubs(spec, { force: true })
+      if bin_stub_exists
+        shell.say_status(:force, "bin/tapioca", :yellow)
+      else
+        shell.say_status(:create, "bin/tapioca", :green)
+      end
+    end
+
+    no_commands do
+      def self.exit_on_failure?
+        true
+      end
+
+      def generator
+        current_command = T.must(current_command_chain.first)
+        @generator ||= Generator.new(
+          ConfigBuilder.from_options(current_command, options)
+        )
+      end
+    end
+  end
 end

data/lib/tapioca/compilers/dsl/aasm.rb

@@ -0,0 +1,122 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require "active_record"
+  require "aasm"
+rescue LoadError
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::AASM` generate types for AASM state machines.
+      # This gem dynamically defines constants and methods at runtime. For
+      # example, given a class:
+      #
+      #   class MyClass
+      #     include AASM
+      #
+      #     aasm do
+      #       state :sleeping, initial: true
+      #       state :running, :cleaning
+      #
+      #       event :run do
+      #         transitions from: :sleeping, to: :running
+      #       end
+      #     end
+      #   end
+      #
+      # This will result in the following constants being defined:
+      #
+      #   STATE_SLEEPING, STATE_RUNNING, STATE_CLEANING
+      #
+      # and the following methods being defined:
+      #
+      #   sleeping?, running?, cleaning?
+      #   run, run!, run_without_validation!, may_run?
+      #
+      class AASM < Tapioca::Compilers::Dsl::Base
+        extend T::Sig
+
+        # Taken directly from the AASM::Core::Event class, here:
+        # https://github.com/aasm/aasm/blob/0e03746/lib/aasm/core/event.rb#L21-L29
+        EVENT_CALLBACKS =
+          T.let(
+            ["after", "after_commit", "after_transaction", "before", "before_transaction", "ensure", "error",
+             "before_success", "success"].freeze,
+            T::Array[String]
+          )
+
+        sig { override.params(root: RBI::Tree, constant: T.all(::AASM::ClassMethods, Class)).void }
+        def decorate(root, constant)
+          aasm = constant.aasm
+          return if !aasm || aasm.states.empty?
+
+          root.create_path(constant) do |model|
+            # Create all of the constants and methods for each state
+            aasm.states.each do |state|
+              model.create_constant("STATE_#{state.name.upcase}", value: "T.let(T.unsafe(nil), Symbol)")
+              model.create_method("#{state.name}?", return_type: "T::Boolean")
+            end
+
+            # Create all of the methods for each event
+            parameters = [create_rest_param("opts", type: "T.untyped")]
+            aasm.events.each do |event|
+              model.create_method(event.name.to_s, parameters: parameters)
+              model.create_method("#{event.name}!", parameters: parameters)
+              model.create_method("#{event.name}_without_validation!", parameters: parameters)
+              model.create_method("may_#{event.name}?", return_type: "T::Boolean")
+            end
+
+            # Create the overall state machine method, which will return an
+            # instance of the PrivateAASMMachine class.
+            model.create_method(
+              "aasm",
+              parameters: [
+                create_rest_param("args", type: "T.untyped"),
+                create_block_param("block", type: "T.nilable(T.proc.bind(PrivateAASMMachine).void)"),
+              ],
+              return_type: "PrivateAASMMachine",
+              class_method: true
+            )
+
+            # Create a private machine class that we can pass around for the
+            # purpose of binding various procs passed to methods without having
+            # to explicitly bind self in each one.
+            model.create_class("PrivateAASMMachine", superclass_name: "AASM::Base") do |machine|
+              machine.create_method(
+                "event",
+                parameters: [
+                  create_param("name", type: "T.untyped"),
+                  create_opt_param("options", default: "nil", type: "T.untyped"),
+                  create_block_param("block", type: "T.proc.bind(PrivateAASMEvent).void"),
+                ]
+              )
+
+              # Create a private event class that we can pass around for the
+              # purpose of binding all of the callbacks without having to
+              # explicitly bind self in each one.
+              machine.create_class("PrivateAASMEvent", superclass_name: "AASM::Core::Event") do |event|
+                EVENT_CALLBACKS.each do |method|
+                  event.create_method(
+                    method,
+                    parameters: [
+                      create_block_param("block", type: "T.proc.bind(#{constant.name}).void"),
+                    ]
+                  )
+                end
+              end
+            end
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          T.cast(ObjectSpace.each_object(::AASM::ClassMethods), T::Enumerable[Module])
+        end
+      end
+    end
+  end
+end