rbs-src 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f00b3f9d5db76fd52097440453dc502f298da9a4f9bd2b3c852786064c3cb4
-  data.tar.gz: 6094fd8f39dc65932db88c76046d934c6b30a65620d3a27033bbf879f629d084
+  metadata.gz: 49e3f5f4a8aee7ee558855e658b47e01e4f17d3a24eaf0c167c26812e7fa4195
+  data.tar.gz: 062ac2a5b37770592afa3c07c23c32b18259c679c6eae8de8b0f58dff4140928
 SHA512:
-  metadata.gz: 8cb34af3adfb39bb9772da48d6730dda31922a67fec6197ec630aad849b1f6c7e8b1f90f29ddd0805d83bdbd0a2304ccc3ce69118a4a4552b90d8199f4c3f270
-  data.tar.gz: 925593e54d59dd10de6c2275348b8bb98aa454548405a9b372fcd6b11886b530850954674718acdbac843438a63f63d90571ff4bfa8ca8c02ed0b8b4c1f363dd
+  metadata.gz: cc36bedb368b369bc005a879486d1c70f684fb7bba77bcd6825324240a4b343441aacf6649cd1832cd50868b369dc6c9421c2080534bb4d9cbcd2dffd8a0b0c1
+  data.tar.gz: 1bf8e0cd1e0c87a5b595e478fe18a7e99f9bc3a3336bfb62baa6bdf0347b2f29cf2718d8c36ffbd581e0e6a4e4d57bcd19a4220d681f42ceb3bbd00603704496

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rbs-src (0.3.0)
+    rbs-src (0.5.0)
+      rainbow (~> 3.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -43,6 +43,8 @@ Load gem dependencies from `rbs_collection.lock.yaml` and set up all repositorie
 
     $ rbs-src setup
 
+If the git repository content is edited, it runs `git stash` and `git reset --hard`.
+
 #### For Steep users
 
 You need to edit your Steepfile to let the type checker stop using rbs-collection.
@@ -78,6 +80,18 @@ The command will clone the git repository for `active_emoji-0.0` and make a syml
 You can add directories in the repository for `active_emoji-0.0` and start writing RBS files through the symlink.
 Once you finished the edit, you can push the RBS files to upstream!
 
+### rbs-src status
+
+The command checks the status of all git repositories.
+
+    $ rbs-src status
+    [ok] activesupport tmp/rbs-src/activesupport-7.0
+    [dirty] rainbow tmp/rbs-src/rainbow-3.0
+    [commit_mismatch] ast tmp/rbs-src/ast-2.4
+
+You may want to delete the repositories to reset, but use this command to ensure you don't have uncommitted changes.
+(Note `rbs-src status` doesn't check if you pushed the commits to remotes.)
+
 ## 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.

data/lib/rbs/src/cli.rb

@@ -67,6 +67,67 @@ module Rbs
           end
 
           0
+
+        when "status"
+          rbs_collection_lock_path = RBS::Collection::Config.to_lockfile_path(RBS::Collection::Config::PATH)
+          repository_prefix = Pathname("tmp/rbs-src")
+
+          OptionParser.new do |opts|
+            opts.on("--rbs-collection-lock=PATH", "The path to rbs_collection.lock.yaml (default: #{rbs_collection_lock_path})") { rbs_collection_lock_path = Pathname(_1) }
+            opts.on("--repo-prefix=PREFIX", "The location to put repository in (default: #{repository_prefix})") { repository_prefix = Pathname(_1) }
+
+            opts.banner = <<~BANNER
+              Usage: rbs-src status
+
+              Prints the status of git repositories.
+
+              Example:
+                  $ rbs-src status [GEMs...]
+
+              Options:
+            BANNER
+          end.parse!(argv)
+
+          unless argv.empty?
+            gems = Set.new(argv)
+          end
+
+          repository_prefix.mkpath
+
+          lockfile = RBS::Collection::Config::Lockfile.from_lockfile(
+            lockfile_path: rbs_collection_lock_path,
+            data: YAML.safe_load(rbs_collection_lock_path.read)
+          )
+
+          loader = LockfileLoader.new(
+            lockfile: lockfile,
+            repository_prefix: repository_prefix,
+            rbs_prefix: rbs_prefix
+          )
+
+          non_ok_count = 0
+
+          runner = CommandRunner.new(stdout: stdout)
+
+          loader.each_gem do |gem, repo, commit|
+            if !gems || gems.include?(gem.name)
+              status = gem.status(runner, commit: commit)
+              case status
+              when :ok
+                string = Rainbow("ok").blue
+              when :dirty
+                string = Rainbow("dirty").red
+              when :commit_mismatch
+                non_ok_count = non_ok_count + 1
+                string = Rainbow("commit_mismatch").yellow
+              end
+
+              stdout.puts "[#{string}] #{gem.name} #{gem.repository_root}"
+            end
+          end
+
+          non_ok_count == 0 ? 0 : 1
+
         when "setup"
           rbs_collection_lock_path = RBS::Collection::Config.to_lockfile_path(RBS::Collection::Config::PATH)
           repository_prefix = Pathname("tmp/rbs-src")
@@ -78,19 +139,18 @@ module Rbs
             opts.on("--rbs-prefix=PREFIX", "The location to put symlinks in (default: #{rbs_prefix})") { rbs_prefix = Pathname(_1) }
 
             opts.banner = <<~BANNER
-            Usage: rbs-src setup [options]
+              Usage: rbs-src setup [options]
 
-            Set up git repositories and symlinks in rbs_collection.yaml.
+              Set up git repositories and symlinks in rbs_collection.yaml.
 
-            Example:
-                $ rbs-src setup
-
-            Options:
-          BANNER
+              Example:
+                  $ rbs-src setup
 
+              Options:
+            BANNER
           end.parse!(argv)
 
-          rbs_prefix.mkpath
+          repository_prefix.mkpath
           rbs_prefix.mkpath
 
           lockfile = RBS::Collection::Config::Lockfile.from_lockfile(
@@ -108,10 +168,12 @@ module Rbs
 
           loader.each_gem do |gem, repo, commit|
             runner.push "Setting up #{gem.name}-#{gem.version}" do
-              runner.push "Cloning git repository into #{gem.repository_root}" do
-                if gem.repository_root.directory?
-                  runner.puts "Skipping already exist"
-                else
+              if gem.repository_root.directory?
+                runner.push "Checking out commit in #{gem.repository_root}" do
+                  gem.checkout(runner, repository_url: repo, commit: commit)
+              end
+              else
+                runner.push "Cloning git repository into #{gem.repository_root}" do
                   gem.clone(runner, repository_url: repo, commit: commit)
                 end
               end
@@ -159,7 +221,7 @@ module Rbs
         else
           puts "Unknown command: #{command}"
           puts
-          puts "  known commands: setup, link"
+          puts "  known commands: setup, status, link"
           1
         end
       end

data/lib/rbs/src/command_runner.rb

@@ -38,6 +38,17 @@ module Rbs
         end
       end
 
+      def query?(*command, chdir: Pathname.pwd)
+        # @type var out: String
+        # @type var status: Process::Status
+
+        out, status = Open3.capture2e(*command, chdir: chdir)
+
+        if status.success?
+          out
+        end
+      end
+
       def query!(*command, chdir: Pathname.pwd)
         # @type var out: String
         # @type var status: Process::Status

data/lib/rbs/src/gem.rb

@@ -23,12 +23,42 @@ module Rbs
         rbs_prefix + "#{name}-#{version}"
       end
 
+      def status(runner, commit:)
+        unless runner.query!("git", "status", "-s", "-z", chdir: repository_root).split("\0").empty?
+          return :dirty
+        end
+
+        if runner.query!("git", "rev-parse", "HEAD", chdir: repository_root).chomp != commit
+          return :commit_mismatch
+        end
+
+        :ok
+      end
+
+      def checkout(runner, repository_url:, commit:)
+        unless runner.query!("git", "status", "-s", "-z", chdir: repository_root).split("\0").empty?
+          runner.puts "📣 Stashing uncommited changes... Restore the changes by: `git stash pop`"
+          runner.execute!("git", "stash", "-u", "-m", "Stash by rbs-src on #{name}-#{version}", chdir: repository_root)
+        end
+
+        return if runner.query!("git", "rev-parse", "HEAD", chdir: repository_root).chomp == commit
+
+        unless runner.query?("git", "cat-file", "-e", commit, chdir: repository_root)
+          runner.puts "💾 Fetching from #{repository_url}..."
+          runner.execute!("git", "remote", "set-url", "origin", repository_url, chdir: repository_root)
+          runner.execute!("git", "fetch", "origin", chdir: repository_root)
+        end
+
+        runner.puts "💪 Checking out the commit #{commit}..."
+        runner.execute!("git", "reset", "--hard", commit, chdir: repository_root)
+      end
+
       def clone(runner, repository_url:, commit:)
         runner.puts "git clone..."
         runner.execute!("git", "clone", "--filter=blob:none", "--sparse", repository_url, repository_root.to_s)
         dirs = runner.query!("git", "ls-tree", "-d", "--name-only", "-z", "HEAD", chdir: repository_root).split("\0")
         dirs.delete(repository_dir.to_s)
-        runner.execute!("git", "sparse-checkout", "set", *dirs, repository_dir.join(name, version).to_s, chdir: repository_root)
+        runner.execute!("git", "sparse-checkout", "set", *dirs, repository_dir.join(name).to_s, chdir: repository_root)
         if commit
           runner.puts "git checkout..."
           runner.execute!("git", "checkout", commit, chdir: repository_root)

data/lib/rbs/src/version.rb

@@ -2,6 +2,6 @@
 
 module Rbs
   module Src
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/rbs/src.rb

@@ -4,6 +4,7 @@ require_relative "src/version"
 
 require "rbs"
 require "open3"
+require "rainbow"
 
 require "rbs/src/gem"
 require "rbs/src/lockfile_loader"

data/rbs_collection.lock.yaml

@@ -2,7 +2,7 @@
 sources:
 - type: git
   name: ruby/gem_rbs_collection
-  revision: 9330d49993d18362cce9190b9596f03d1f4915f8
+  revision: 306d1aec19defeb177e217d8aad9812a52bcd5eb
   remote: https://github.com/ruby/gem_rbs_collection.git
   repo_dir: gems
 path: ".gem_rbs_collection"
@@ -47,6 +47,14 @@ gems:
   version: '0'
   source:
     type: stdlib
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 306d1aec19defeb177e217d8aad9812a52bcd5eb
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
 - name: rbs
   version: 3.1.2
   source:

data/sig/open3.rbs

@@ -0,0 +1,4 @@
+module Open3
+  def self.capture2e: (*String, ?chdir: Pathname) -> [String, Process::Status]
+                    | (Hash[String, String] env, *String, ?chdir: Pathname) -> [String, Process::Status]
+end

data/sig/rbs/command_runner.rbs

@@ -14,6 +14,8 @@ module Rbs
       def execute!: (*String, ?chdir: Pathname) -> void
 
       def query!: (*String, ?chdir: Pathname) -> String
+
+      def query?: (*String, ?chdir: Pathname) -> String?
     end
   end
 end

data/sig/rbs/gem.rbs

@@ -23,7 +23,11 @@ module Rbs
 
       def clone: (CommandRunner, repository_url: String, commit: String?) -> void
 
+      def checkout: (CommandRunner, repository_url: String, commit: String) -> void
+
       def link: () -> void
+
+      def status: (CommandRunner, commit: String) -> (:ok | :dirty | :commit_mismatch)
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rbs-src
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
 description: rbs-src
 email:
 - matsumoto@soutaro.com
@@ -34,6 +48,7 @@ files:
 - lib/rbs/src/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
+- sig/open3.rbs
 - sig/rbs/cli.rbs
 - sig/rbs/command_runner.rbs
 - sig/rbs/gem.rbs
@@ -62,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: rbs-src