gotsha 0.1.3.0 → 0.2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cc53441d5c13c208759724198863f72511910b7ae0cc254c76b379dd2fddd5d
-  data.tar.gz: f5f8defa0dec285e5a2c047c09c57c68d909a2f88f08e56e067ac38f33685bd5
+  metadata.gz: 6513381251aa65bb231bbb03a6a15b0e13392b2ddcda252adaae3dc9c727ea93
+  data.tar.gz: f395bf9ee7c4aadf18f77e63a8baa10d8ba508f6b9f5d8c0cfadefe8d1dc35e6
 SHA512:
-  metadata.gz: d61d8c2d838f5f4c47dd8e14f13ba4a64de2b5382a7e8af52724bafc156eb31d299744598338d1ebf38a449963e85c4a396e209ed2aa929dfe717002fcb87ea4
-  data.tar.gz: bd09d4dd15ace3d90155611a830cf3866907e2d7cee02325f21233e2c2b1fb2711efc1a741a5eb18667362c5d9a908d29801b0470be12574c5097f9abc16c71d
+  metadata.gz: 8fa73ee5d522b3ead62113aff1d7fbe3bfdb867177ef6e13728104e4ad493d6b3ba99a15209ffbb0c2d558bb76e458e71d0467a84e98defc1e56500988b648c9
+  data.tar.gz: dc935b2b9f4700d68040111b402f182bf93cc88cad473e20ff35a6e1df6059e3125d4c7b79dfc602ad4e69e458123e698edadbeacc9c7e273f287a63177862dc

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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

@@ -9,6 +9,8 @@ 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.
 

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gotsha
-  VERSION = "0.1.3.0"
+  VERSION = "0.2.1.0"
 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
 gem install gotsha
 
 # Or via your Gemfile
 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 a 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,7 +136,21 @@ 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>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotsha
 version: !ruby/object:Gem::Version
-  version: 0.1.3.0
+  version: 0.2.1.0
 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/