workroom 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3583c94db1c58b26989df8e310ae2550460fd54fda21ba4bcad2837ee758b738
-  data.tar.gz: c3de17570cc26d2c477af06bac848e523b9d862024e2d26a042fb4876fec82ad
+  metadata.gz: cbab7dff475bb494c5bc1d94872f6a64278078a56c89b5db0cf1a39dfda25d59
+  data.tar.gz: 1d6f8ca33e27a3d85844b193630971f8358444cbbffcc47015e3c18a03d7a3b5
 SHA512:
-  metadata.gz: 6435ed5642829932a7ce87b506655140cfc7418180a47e9695d8b33ae4be39f1c603115a2fef4538c456563412b3e1b62a9bf100ecbfecc74755a81842f8fa1f
-  data.tar.gz: e55f11b6f8cdb53343991f4b21cbbbd056a4ae6f718516346586a1943f34bbedc61638a6c5af744f2dfe6df9506014cc468e47bcabdd38e29a913d95601f7447
+  metadata.gz: 45e1ab6a3b868f79514a8418cb721182d7b28f5e5a920a77761ff86cbd6329513e737776b8c6f08d05b868b37c6f15ce951e50ff81c39f100863ec4a3d8e4903
+  data.tar.gz: cc00a9e83bc839c9e6183cd445306c297133af448bfcc2e9510cd51655e09e1b987df13ef0723ec09aa66bc9b198fb9ed6587eee32c3f098dc07040225d24472

data/README.md

@@ -85,7 +85,13 @@ Place an executable script at `scripts/workroom_setup` in your project. It will
 
 ### Teardown script
 
-Place an executable script at `scripts/workroom_teardown` in your project. It will run after a workroom is deleted.
+Place an executable script at `scripts/workroom_teardown` in your project. It will run inside the workroom directory before it is deleted.
+
+### Environment variables
+
+The following environment variables are available to setup and teardown scripts:
+
+- `WORKROOM_PARENT_DIR` - The absolute path to the parent project directory. Since scripts run inside the workroom directory, this lets you reference files in the original project root.
 
 ## Rails integration
 

data/lib/workroom/commands.rb

@@ -64,8 +64,7 @@ module Workroom
 
     desc 'list|l|ls', 'List all workrooms for the current project'
     def list
-      data = config.read
-      project_path, project = find_project(data)
+      project_path, project = config.find_current_project
 
       # Inside a workroom
       if project && Pathname.pwd.to_s != project_path
@@ -87,13 +86,12 @@ module Workroom
       end
 
       # Neither — list all workrooms grouped by parent
-      projects_with_workrooms = data.select { |_, p| p['workrooms']&.any? }
-      if projects_with_workrooms.empty?
+      if config.projects_with_workrooms.empty?
         say 'No workrooms found.'
         return
       end
 
-      projects_with_workrooms.each do |path, proj|
+      config.projects_with_workrooms.each do |path, proj|
         say "#{display_path(path)}:"
         inside path do
           list_workrooms(proj['workrooms'], proj['vcs'])
@@ -106,13 +104,14 @@ module Workroom
     method_option :confirm, type: :string,
                             desc: 'Skip confirmation if value matches the workroom name'
     def delete(name = nil)
+      check_not_in_workroom!
+
       if !name
         interactive_delete
         return
       end
 
       @name = name
-      check_not_in_workroom!
       validate_name!
 
       if !options[:pretend]
@@ -141,13 +140,14 @@ module Workroom
       def run_setup_script
         return if !setup_script.exist?
 
+        parent_dir = Pathname.pwd.to_s
         inside workroom_path do
-          run_user_script :setup, setup_script_to_run.to_s
+          run_user_script :setup, setup_script_to_run.to_s, parent_dir
         end
       end
 
       def setup_script
-        @setup_script ||= workroom_path.join('scripts', 'workroom_setup')
+        @setup_script ||= Pathname.pwd.join('scripts', 'workroom_setup')
       end
 
       def setup_script_to_run
@@ -157,7 +157,10 @@ module Workroom
       def run_teardown_script
         return if !teardown_script.exist?
 
-        run_user_script :teardown, teardown_script_to_run.to_s
+        parent_dir = Pathname.pwd.to_s
+        inside workroom_path do
+          run_user_script :teardown, teardown_script_to_run.to_s, parent_dir
+        end
       end
 
       def teardown_script
@@ -168,7 +171,7 @@ module Workroom
         teardown_script
       end
 
-      def run_user_script(type, command)
+      def run_user_script(type, command, parent_dir)
         return if behavior != :invoke
 
         destination = relative_to_original_destination_root(destination_root, false)
@@ -177,7 +180,10 @@ module Workroom
 
         return if options[:pretend]
 
-        result, status = Open3.capture2e(command)
+        result, status = Open3.capture2e({
+                                           'WORKROOM_NAME' => name,
+                                           'WORKROOM_PARENT_DIR' => parent_dir
+                                         }, command)
 
         instance_variable_set :"@#{type}_result", result
 
@@ -294,10 +300,7 @@ module Workroom
       end
 
       def interactive_delete
-        check_not_in_workroom!
-
-        data = config.read
-        _, project = find_project(data)
+        _, project = config.find_current_project
 
         if !project || !project['workrooms'] || project['workrooms'].empty?
           say 'No workrooms found for this project.'
@@ -329,10 +332,10 @@ module Workroom
         @name = selected_name
         @workroom_path = nil
 
+        run_teardown_script
         delete_workroom
         cleanup_directory if jj?
         update_config(:remove)
-        run_teardown_script
 
         say "Workroom '#{name}' deleted successfully.", :green
 
@@ -460,20 +463,6 @@ module Workroom
         print_table rows, indent: 2
       end
 
-      # Find the project for the current directory. If pwd is a project in the config, return it
-      # directly. Otherwise, check if pwd is a workroom path under any project.
-      def find_project(data)
-        pwd = Pathname.pwd.to_s
-        return [pwd, data[pwd]] if data.key?(pwd)
-
-        data.each do |project_path, project|
-          workrooms = project['workrooms'] || {}
-          return [project_path, project] if workrooms.any? { |_, info| info['path'] == pwd }
-        end
-
-        [pwd, nil]
-      end
-
       def workroom_warnings(name, info, stored_vcs)
         warnings = []
         warnings << 'directory not found' if !Dir.exist?(info['path'])

data/lib/workroom/config.rb

@@ -40,6 +40,25 @@ module Workroom
       end
     end
 
+    # Find the project for the current directory. If pwd is a project in the config, return it
+    # directly. Otherwise, check if pwd is a workroom path under any project.
+    def find_current_project
+      data = read
+      pwd = Pathname.pwd.to_s
+      return [pwd, data[pwd]] if data.key?(pwd)
+
+      data.each do |project_path, project|
+        workrooms = project['workrooms'] || {}
+        return [project_path, project] if workrooms.any? { |_, info| info['path'] == pwd }
+      end
+
+      [pwd, nil]
+    end
+
+    def projects_with_workrooms
+      @projects_with_workrooms ||= read.select { |_, p| p['workrooms']&.any? }
+    end
+
     def workrooms_dir
       Pathname.new(File.expand_path(read['workrooms_dir'] || DEFAULT_WORKROOMS_DIR))
     end

data/lib/workroom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Workroom
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workroom
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Joel Moss