rbs-src 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76ab3d8f7dcde911852a0703e6439f7d3169d96a232e75c7f59b96f82ab40f89
-  data.tar.gz: a0d55fd33ccdfe73ac01249761809ccbb8a5f0a0787b811bbc208c197c8219e0
+  metadata.gz: e7ade9d16159cd243f1f3849c3cecf99ff9e9bcb8988380778a19d56ab09f0e1
+  data.tar.gz: 85bd20a7118741b61d5e0186893a8f990a8f257c03a19fbc3a3410f056cb1257
 SHA512:
-  metadata.gz: 790e7db58006f2d72714db5f74b50e7690184197da889bd2c0e02f3865f6ad9325a56c89d86c5904ea3971ac06254f810a2b3f0a62ec46fad085a5c8eda9ad0d
-  data.tar.gz: 4cfd4d0df57c79f8dd50c00299c003f603f564977714375113de22df482300b6364b43e6a0917f36a0c68411ffa735a76e0e4f4f85fffbf8aeb450bf2582ad17
+  metadata.gz: 0c238d9c2c9a514bd62259176db2790507dc9543e9b0bd93d5530956d722158dc0f1bfd6f63ee5db037e0f3f89e581446f7935349d4336b4934c8aed774514cd
+  data.tar.gz: 177efc73a82a9de0bb01ed8155db0f843acaeedfb37bffb82e3de05db9140f21893e8ef1f0d47694e183d1eda9f0184d9b887e443ad9ba31f2eaf23274e7800f

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rbs-src (0.4.0)
+    rbs-src (0.6.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

@@ -19,8 +19,38 @@ module Rbs
         repository_root.join(repository_dir, name, version)
       end
 
-      def rbs_path
-        rbs_prefix + "#{name}-#{version}"
+      def rbs_path(suffix = version)
+        rbs_prefix + "#{name}-#{suffix}"
+      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", "checkout", commit, chdir: repository_root)
       end
 
       def clone(runner, repository_url:, commit:)
@@ -36,6 +66,9 @@ module Rbs
       end
 
       def link
+        Pathname.glob(rbs_path("*").to_s).each do |path|
+          File.unlink(path.to_s)
+        end
         File.symlink(repository_path.relative_path_from(rbs_path.parent), rbs_path)
       end
     end

data/lib/rbs/src/version.rb

@@ -2,6 +2,6 @@
 
 module Rbs
   module Src
-    VERSION = "0.4.0"
+    VERSION = "0.6.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: '04470595f7a634757e160f61aafeb50536322bba'
+  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

@@ -19,11 +19,15 @@ module Rbs
       def repository_path: () -> Pathname
 
       # The path of the directory in the `#rbs_prefix` that contains the RBS files of the gem
-      def rbs_path: () -> Pathname
+      def rbs_path: (?String suffix) -> Pathname
 
       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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
-dependencies: []
+date: 2023-09-14 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