gotsha 0.2.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75f5972d5843df96d271b5991679b69fbe8684d35433e7134d247cbdb6b5dcef
-  data.tar.gz: c1af3ac09dc8cf1498da4662d59489e54c703aa6b87a77bf2be45a2a87f57fa8
+  metadata.gz: 0fcd97adf3389ca91dd4a960d384481f31846423bf51eac8ecda8cf4634d8eb8
+  data.tar.gz: f59e613178b3708fe10ea46ec5367459185a3c1786dbad66fb84835ba789e016
 SHA512:
-  metadata.gz: c2acc7f6017de1a52b97d641f21f59777564e2c9e69ceb8a8734f64203b1b0adb403231501e27c5d9a2a8f4e6e6cd71168af260aca9ce153bf2254e88016b986
-  data.tar.gz: eca5075f3bc54971bf47ce44322938f5acc719818f93d50ccb4c87f644823f388bb66fecc40077fed77b1e73bdacaa37123657d2129275c750b48b5dc94914c4
+  metadata.gz: e5cd691e9c3b94e53d4f2772f06716423d941909a65ff21a2a662ef149d2436a70c6af3d6afceca7329f9ad17f30feadccb49ed07034cf02838c6d292f13e0fa
+  data.tar.gz: c9b1fceb52dc6f154cc65d19b6e8fc0fc97128092c2f10b0de96c41844901c491e33c5ccd861bd0b521ec9bf12f22047b44239bf146d6e662faaf5bf1f9ff33d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.1] - 2025-10-18
+
+- Add some non-Ruby test command examples to autogenerated config file. Gotsha is language-agnostic :-).
+
+## [0.3] - 2025-10-18
+
+- Add guide for case when `gotsha config` fails due to missing `ENV['EDITOR']`
+- Enhance help command (hide some internal commands to not confuse users, add `-h` alias for `help`, add the ability to call `gotsha help <command>` AND `gotsha <command> -h`)
+- Change wording and examples in the config file template, to make it less confising for new users
+
 ## [0.2.9] - 2025-10-15
 
 - Add some commented out GT Action code to quickly show how to disable for PR drafts

data/exe/gotsha

@@ -3,10 +3,8 @@
 
 require_relative "../lib/gotsha"
 
-action = ARGV.first
-
 begin
-  message = Gotsha::ActionDispatcher.call(action)
+  message = Gotsha::ActionDispatcher.call(*ARGV)
   puts("\n✓ Gotsha: #{message}\n\n")
   exit 0
 rescue Gotsha::Errors::SoftFail => e

data/lib/gotsha/action_dispatcher.rb

@@ -2,23 +2,26 @@
 
 module Gotsha
   class ActionDispatcher
-    INIT_SETUP_ACTION = "init"
+    SKIP_CONFIG_VERIFICATION_FOR = %w[init configure uninstall].freeze
     DEFAULT_ACTION = "help"
-    OPEN_CONFIG_ACTION = "configure"
-    UNINSTALL_ACTION = "uninstall"
+    HELP_ACTION_SHORTCUT = "-h"
 
-    def self.call(action_name = DEFAULT_ACTION)
+    def self.call(action_name = DEFAULT_ACTION, *args)
       action_name ||= DEFAULT_ACTION
 
-      new.call(action_name)
+      new.call(action_name, *args)
     end
 
-    def call(action_name)
+    def call(action_name, *args)
       @action_name = action_name
 
       verify_configuration!
 
-      action_class.new.call
+      action_class.new.call(*args)
+    rescue ArgumentError
+      return Actions::Help.new.call(action_name) if args == [HELP_ACTION_SHORTCUT]
+
+      raise Errors::HardFail, "too many arguments"
     end
 
     private
@@ -26,9 +29,7 @@ module Gotsha
     attr_reader :action_name
 
     def verify_configuration!
-      return if UserConfig.get(:ci)
-
-      return if [INIT_SETUP_ACTION, UNINSTALL_ACTION].include?(action_name.to_s)
+      return if SKIP_CONFIG_VERIFICATION_FOR.include?(action_name.to_s) || UserConfig.get(:ci)
 
       raise(Errors::HardFail, "config files not found, please run `gotsha init` first") if UserConfig.blank?
 
@@ -39,7 +40,6 @@ 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 `#{Config::CONFIG_FILE}` " \
@@ -47,8 +47,10 @@ module Gotsha
     end
 
     def action_class
-      Kernel.const_get("Gotsha::Actions::#{action_name.capitalize}")
+      Kernel.const_get("Gotsha::Actions::#{action_name.to_s.capitalize}")
     rescue NameError
+      return Gotsha::Actions::Help if action_name.to_s == HELP_ACTION_SHORTCUT
+
       raise Errors::HardFail, "unknown command `#{action_name}`. See available commands via `gotsha help`."
     end
   end

data/lib/gotsha/actions/commit.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Commit
-      DESCRIPTION = "creates a dummy commit and runs tests on it"
+      DESCRIPTION = "creates a dummy commit and runs tests on it (use for manual sign-off, if you disable hooks)"
 
       def call
         BashCommand.silent_run!('git -c core.hooksPath=/dev/null commit --allow-empty -m "Run Gotsha"')

data/lib/gotsha/actions/configure.rb

@@ -8,7 +8,12 @@ module Gotsha
       def call
         editor = ENV["EDITOR"]
 
-        raise(Errors::HardFail, "please, set ENV variable `EDITOR` first") unless editor
+        if editor.to_s.empty?
+          raise(Errors::HardFail,
+                "could not open config file automatically, ENV " \
+                "variable `EDITOR` not set.\n\nPlease, open file" \
+                "`#{Config::CONFIG_FILE}` manually.")
+        end
 
         if Kernel.system("#{editor} #{Config::CONFIG_FILE}")
           "done"

data/lib/gotsha/actions/help.rb

@@ -3,31 +3,52 @@
 module Gotsha
   module Actions
     class Help
-      DESCRIPTION = "shows available commands and some tips"
+      DESCRIPTION = "shows available commands and some tips (has optional <COMMAND> argument)"
+      INTERNAL_ACTIONS = %i[fetch push test].freeze
+
+      def call(action_name = nil)
+        @action_name = action_name
 
-      def call
         [
           "help",
           commands,
+          action_description,
           config_file,
           contact
-        ].join("\n\n")
+        ].compact.join("\n\n")
       end
 
       private
 
       def commands
+        return if @action_name
+
         commands = Gotsha::Actions.constants.map do |command|
           name = command.downcase
+
+          next if INTERNAL_ACTIONS.include?(name)
+
           description = Kernel.const_get("Gotsha::Actions::#{command}::DESCRIPTION")
 
           "gotsha #{name}   # #{description}"
-        end.sort.join("\n")
+        end.compact.sort.join("\n")
 
         "Available commands: \n\n#{commands}\n"
       end
 
+      def action_description
+        return unless @action_name
+
+        description = Kernel.const_get("Gotsha::Actions::#{@action_name.capitalize}::DESCRIPTION")
+
+        "`gotsha #{@action_name}` #{description}"
+      rescue NameError
+        raise Errors::HardFail, "unknown command `#{@action_name}`"
+      end
+
       def config_file
+        return if @action_name
+
         [
           "Config file:",
           "How and when Gotsha runs tests is configured in `#{Config::CONFIG_FILE}` file, " \
@@ -39,6 +60,8 @@ module Gotsha
       end
 
       def contact
+        return if @action_name
+
         [
           "Contact:",
           "Is something not clear? Did you find a bug? Would you use new feature? Let's talk! \n" \

data/lib/gotsha/actions/init.rb

@@ -3,7 +3,7 @@
 module Gotsha
   module Actions
     class Init
-      DESCRIPTION = "first setup"
+      DESCRIPTION = "performs the Gotsha setup (creates few files and changes Git Hooks path)"
 
       def call
         puts "Creating files..."

data/lib/gotsha/actions/test.rb

@@ -26,8 +26,7 @@ module Gotsha
         return if commands.any?
 
         raise(Errors::HardFail,
-              "please, define some test commands in `#{Config::CONFIG_FILE}` " \
-              "(you can run `gotsha configure` to open it)")
+              "no test commands configured, please run `gotsha configure`")
       end
 
       def run_commands!
@@ -70,7 +69,7 @@ module Gotsha
       end
 
       def commands
-        @commands ||= UserConfig.get(:commands) || []
+        @commands ||= (UserConfig.get(:commands) || []).reject(&:empty?)
       end
     end
   end

data/lib/gotsha/templates/config.toml

@@ -9,15 +9,19 @@ autogenerated = true # Remove this line to start using Gotsha
 #
 # Test commands
 # 
-# This is where you define what tests to run and how.
-# Multiple (comma-separated) commands supported, see the
-# commented examples:
+# This is where you define your test commands.
+# A "test command" is any bash command.
+# Multiple (comma-separated) commands supported
 #
 commands = [
-#  "bundle exec rspec --order rand",
-#  "bin/rails t",
-#  "rubocop",
-#  "docker exec -it great-app rspec"
+  # Your first test command goes into the parentheses!
+  "",
+  # See some examples:
+  #  "bin/rails t",
+  #  "docker-compose exec great_app rspec"
+  #  "npm test"
+  #  "npx jest --ci"
+  #  "pytest -q"
 ]
 
 # Git hooks config
@@ -34,7 +38,7 @@ commands = [
 #
 # ```
 #
-post_commit_tests = false # run tests for every commit
+post_commit_tests = true # run tests for every commit
 pre_push_tests = true # run tests on every push
 interrupt_push_on_tests_failure = false # prohibit pushing when tests fail
 

data/lib/gotsha/user_config.rb

@@ -18,7 +18,7 @@ module Gotsha
     rescue Errno::ENOENT
       {}
     rescue TomlRB::ParseError => e
-      raise Errors::HardFail, "Syntax error in config file\n\n#{e.message}"
+      raise Errors::HardFail, "Syntax error in config file. Open it by running `gotsha configure`\n\n#{e.message}"
     end
   end
 end

data/lib/gotsha/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotsha
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Vitek Meloun