gotsha 0.1.3.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc53441d5c13c208759724198863f72511910b7ae0cc254c76b379dd2fddd5d
-  data.tar.gz: f5f8defa0dec285e5a2c047c09c57c68d909a2f88f08e56e067ac38f33685bd5
+  metadata.gz: ae454dd9d8275719a0a1e4122be0075a6cdb198e5ce294829993d0b1ac3422da
+  data.tar.gz: b68234f7ebec3d02720f30da620988c7d7b7bf16b53bcba2369711d59ec6ddc7
 SHA512:
-  metadata.gz: d61d8c2d838f5f4c47dd8e14f13ba4a64de2b5382a7e8af52724bafc156eb31d299744598338d1ebf38a449963e85c4a396e209ed2aa929dfe717002fcb87ea4
-  data.tar.gz: bd09d4dd15ace3d90155611a830cf3866907e2d7cee02325f21233e2c2b1fb2711efc1a741a5eb18667362c5d9a908d29801b0470be12574c5097f9abc16c71d
+  metadata.gz: 46efa5956c790a2ab91363ec7ad23fd8713d3945add64766c226e0494f891b637558ba6ddf9219472f9a83957d63e58a346449e755b7bd7b5baf93f7efe955cc
+  data.tar.gz: 4c8d1e824084191a1d592059e01e22b1c80ff50cf397951c600db91713cdf853e9c4847b101a7aec12b1ba1dddb84990f9bab958caff2a5f801aecad9116bb44

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.2.2] - 2025-10-13
+
+- Fix to ensure everything works on Mac as well
+
+## [0.2.1.0] - 2025-10-13
+
+- Better `help` output
+- New command `gotsha configure` (opens config file in ENV EDITOR)
+
 ## [0.1.1] - 2025-10-12
 
 - Some cleanup after verifying the gem is published

data/README.md

@@ -3,12 +3,14 @@ Pushing untested commits? Gotsha!
 
 ## Installation
 ```bash
-gem install gotsha # or add `gem "gotsha"` to you Gemfile and run `bundle install`
+gem install gotsha # or add `gem "gotsha"` to you Gemfile
 
 gotsha
 ```
 Then just follow the prompts — Gotsha will guide you through the setup. It won't take more than 3 minutes!
 
+If you got stuck somewhere, you can always use `gotsha help`.
+
 ## What is it?
 Gotsha is a tiny tool that lets you “sign off” your commit locally: it runs your tests and then stores the test results with the commit SHA (hence the gem name: got-SHA). Your pull request can then be verified against that record, so reviewers know you actually ran the checks before asking for review.
 
@@ -25,3 +27,6 @@ Then, you can see the tests results in a Github action:
 (Screenshots from a real [demo pull request](https://github.com/melounvitek/gotsha/pull/35); check it out!)
 
 Based on your workflow and tests speed, you can configure them to auto-run on every commit, before every push, or just manually. Whenever pushing to remote repository, the Git note (which is what's used to store the test results) gets sent there as well.
+
+## Do you like Gotsha?
+<a href="https://buymeacoffee.com/gotsha">I like coffee!</a>

data/lib/gotsha/action_dispatcher.rb

@@ -4,6 +4,7 @@ module Gotsha
   class ActionDispatcher
     INIT_SETUP_ACTION = "init"
     DEFAULT_ACTION = "help"
+    OPEN_CONFIG_ACTION = "configure"
 
     def self.call(action_name = DEFAULT_ACTION)
       action_name ||= DEFAULT_ACTION
@@ -35,9 +36,11 @@ module Gotsha
       end
 
       return unless UserConfig.get(:autogenerated)
+      return if action_name.to_s == OPEN_CONFIG_ACTION
 
       raise Errors::HardFail,
-            "autogenerated config detected! Please, remove `autogenerated = true` from `.gotsha/config.toml`"
+            "autogenerated config detected! Please, remove `autogenerated = true` from `#{Config::CONFIG_FILE}` " \
+            "(you can run `gotsha configure` to open it)"
     end
 
     def action_class

data/lib/gotsha/actions/configure.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Gotsha
+  module Actions
+    class Configure
+      DESCRIPTION = "opens Gotsha config file"
+
+      def call
+        editor = ENV["EDITOR"]
+
+        raise(Errors::HardFail, "please, set ENV variable `EDITOR` first") unless editor
+
+        if Kernel.system("#{editor} #{Config::CONFIG_FILE}")
+          "done"
+        else
+          raise Errors::HardFail,
+                "something went wrong, please check whether `#{editor}` editor (set in ENV variable `EDITOR`) works"
+        end
+      end
+    end
+  end
+end

data/lib/gotsha/actions/help.rb

@@ -3,17 +3,47 @@
 module Gotsha
   module Actions
     class Help
-      DESCRIPTION = "shows available commands"
+      DESCRIPTION = "shows available commands and some tips"
 
       def call
+        [
+          "help",
+          commands,
+          config_file,
+          contact
+        ].join("\n\n")
+      end
+
+      private
+
+      def commands
         commands = Gotsha::Actions.constants.map do |command|
           name = command.downcase
           description = Kernel.const_get("Gotsha::Actions::#{command}::DESCRIPTION")
 
-          "#{name}   # #{description}"
+          "gotsha #{name}   # #{description}"
         end.sort.join("\n")
 
-        "Available commands: \n\n#{commands}"
+        "Available commands: \n\n#{commands}\n"
+      end
+
+      def config_file
+        [
+          "Config file:",
+          "How and when Gotsha runs tests is configured in `#{Config::CONFIG_FILE}` file, " \
+          "so it's the most important file to check and understand! Luckily, it's brief " \
+          "and contains explaining comments. If you deleted the comments it was originally " \
+          "generated with, or you're not sure how to set it, see " \
+          "https://github.com/melounvitek/gotsha/blob/master/lib/gotsha/templates/config.toml\n"
+        ].join("\n\n")
+      end
+
+      def contact
+        [
+          "Contact:",
+          "Is something not clear? Did you find a bug? Would you use new feature? Let's talk! \n" \
+          "Freel free to email me (vitek@meloun.info), or create an issue (https://github.com/melounvitek/gotsha/issues/)"
+        ]
       end
     end
   end

data/lib/gotsha/actions/test.rb

@@ -26,7 +26,8 @@ module Gotsha
         return if commands.any?
 
         raise(Errors::HardFail,
-              "please, define some test commands in `.gotsha/config.toml`")
+              "please, define some test commands in `#{Config::CONFIG_FILE}` " \
+              "(you can run `gotsha configure` to open it)")
       end
 
       def run_commands!

data/lib/gotsha/bash_command.rb

@@ -1,32 +1,49 @@
 # frozen_string_literal: true
 
 require "pty"
-require "shellwords"
 
 module Gotsha
   class BashCommand
     FORCE_OUTPUT_AFTER = 5
+    MARKER = "__GOTSHA_EXIT__:"
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/MethodLength
     def self.run!(command)
       start_time = Time.now
       UserConfig.get(:verbose) && puts(command)
 
       stdout = +""
+      exit_code = nil
 
-      wrapped = %(script -qefc #{Shellwords.escape(command)} /dev/null)
-
-      io = IO.popen(wrapped, in: File::NULL, err: %i[child out])
-      begin
-        io.each do |line|
-          (UserConfig.get(:verbose) || Time.now - start_time > FORCE_OUTPUT_AFTER) && puts(line)
+      # This block is an ugly workaround to ensure the color output is stored both on Linux and Mac
+      PTY.spawn("bash", "-lc", "#{command}; printf \"\\n#{MARKER}%d\\n\" $?") do |r, _w, pid|
+        r.each do |line|
+          if line.start_with?(MARKER)
+            exit_code = line.sub(MARKER, "").to_i
+            next
+          end
+          puts line if UserConfig.get(:verbose) || Time.now - start_time > FORCE_OUTPUT_AFTER
           stdout << line
         end
+      rescue Errno::EIO
+        # PTY closes when process ends — safe to ignore
       ensure
-        _, status = Process.wait2(io.pid)
+        Process.wait(pid)
       end
 
+      final_code = exit_code || $CHILD_STATUS.exitstatus
+      status = Struct.new(:exitstatus) do
+        def success?
+          exitstatus.zero?
+        end
+      end.new(final_code)
       new(stdout, status)
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/MethodLength
 
     def self.silent_run!(command)
       return run!(command) if UserConfig.get(:verbose)

data/lib/gotsha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gotsha
-  VERSION = "0.1.3.0"
+  VERSION = "0.2.2"
 end

data/lib/gotsha.rb

@@ -5,6 +5,7 @@ require "toml-rb"
 
 require_relative "gotsha/action_dispatcher"
 require_relative "gotsha/actions/commit"
+require_relative "gotsha/actions/configure"
 require_relative "gotsha/actions/help"
 require_relative "gotsha/actions/init"
 require_relative "gotsha/actions/show"

data/web/index.html

@@ -109,15 +109,14 @@
           <p>Gotsha is distrubuted as a Ruby gem, so you need to
             have <strong>Ruby</strong> working in your system. Apart from that, the only
             other dependency is <strong>Git</strong>.</p>
-            <h3>Install gem</h3>
-        <pre><code># Install manually
+        <pre><code># Install manually; language agnostic
 gem install gotsha
 
-# Or via your Gemfile
+# Or install via your Gemfile in Ruby projects
 gem 'gotsha'
 </code></pre>
-            <h3>Run <code>gotsha</code></h3>
-          <p>Then just run <code>gotsha</code> command and follow the prompts — Gotsha will guide you through the setup. It won't take more than 3 minutes!</p>
+          <p>Then just go to your project folder, run <code>gotsha</code> command, and follow the prompts — Gotsha will guide you through the setup. It won't take more than 3 minutes!</p>
+            <p>If you got stuck somewhere, you can always use <code>gotsha help</code>.</p>
       </section>
 
       <section class="card">
@@ -125,6 +124,10 @@ gem 'gotsha'
         <article>
           <h3>1) Runs locally</h3>
           <p>Gotsha runs the project test suite on your machine. This can happen automatically (for every Git commit or push), or manually; right before you ask for review. You can easily configure it whatever way suits your project best.</p>
+            <img
+                style="max-width: 100%; height: auto; display: block; margin: 15px auto;"
+                src="img/commit.png"
+              />
         </article>
         <article>
           <h3>2) Stores test results for commit SHA</h3>
@@ -133,13 +136,28 @@ gem 'gotsha'
         <article>
           <h3>3) Displays results in your GitHub PR</h3>
           <p>Push as usual — the note follows your commit, and tiny Github Action instantly verifies it
-              and makes the tests result visible to reviewers. <a target="_blank" href="https://gotsha.org/failed_build.png">Check it out</a>; it even persist all the colors!</p>
+              and makes the tests result visible to reviewers.
+          <img
+              style="max-width: 100%; height: auto; display: block; margin: 15px auto;"
+              src="img/push.png"
+            />
+
+          <img
+              style="max-width: 100%; height: auto; width: 71%; display: block; margin: 15px auto;"
+              src="img/gh_action.png"
+            />
+
+          <img
+              style="max-width: 100%; height: auto; display: block; margin: 15px auto;"
+              src="img/commit_checked.png"
+            />
         </article>
       </section>
 
 
       <p class="foot">
           © <span id="y"></span> <a target="_blank" href="https://x.com/melounvitek">Vítek Meloun</a> (<a target="_blank" href="mailto:vitek@meloun.info">vitek@meloun.info</a>)
+          <script type="text/javascript" src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js" data-name="bmc-button" data-slug="gotsha" data-color="#FFDD00" data-emoji="" data-font="Cookie" data-text="Buy me a coffee" data-outline-color="#000000" data-font-color="#000000" data-coffee-color="#ffffff" ></script>
         </p>
     </main>
   </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotsha
 version: !ruby/object:Gem::Version
-  version: 0.1.3.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Vitek Meloun
@@ -44,6 +44,7 @@ files:
 - lib/gotsha.rb
 - lib/gotsha/action_dispatcher.rb
 - lib/gotsha/actions/commit.rb
+- lib/gotsha/actions/configure.rb
 - lib/gotsha/actions/help.rb
 - lib/gotsha/actions/init.rb
 - lib/gotsha/actions/show.rb
@@ -61,6 +62,10 @@ files:
 - lib/gotsha/version.rb
 - sig/gotsha.rbs
 - web/favicon.ico
+- web/img/commit.png
+- web/img/commit_checked.png
+- web/img/gh_action.png
+- web/img/push.png
 - web/index.html
 - web/logo.png
 homepage: https://www.gotsha.org/