gotsha 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2f8e413b08cc4c531c60d42c0a94d8d2bae874faca37d425fe60812463717d
-  data.tar.gz: 4be2788036a8dd4c6521d760628e121a4f71225a40a846c597e7c5c9f12d269d
+  metadata.gz: 55d7f3b23fbf837a44f3c10ea96f7032191dfba43b8bb93f19ec6dbe7cda27d9
+  data.tar.gz: 279ee3f46b1e4ffe687e5ea74bc7b234b3dde5eb9dbff3665bb4530639872ca6
 SHA512:
-  metadata.gz: fab24bd0facf01de5495f87287b71c15467d4eff740a39eeb4481915f54ca03fa4524202413d4387cae19204f4275e8288f14403df117b4dff1049019b607ef7
-  data.tar.gz: dfb3901e72631f08e605926b8c76000cb1965c01c6898b333194f3c63944ea4585cf2e2236708e553cf28c102f640a7a4c0a726894d9be07804f6688b386d4ec
+  metadata.gz: f138cbd4c7553b59bdf115a3bb293b558400a7688b4d1015061396f02e7cfc59dc9b5c75189c799a77f1f9488f4e190bc48fbb33b67d532f1cbe5f1c14ddb89f
+  data.tar.gz: 31771423505ca2abef9e91371dc2bc8a3ce9ebc5b34e91f56359cadf082934bf5e1b26c833a74db820e06c52a500d6f628d3bc08e88784811e26aef4c47c38a4

data/README.md

@@ -1,6 +1,14 @@
-# Gotsha — your local CI (alpha coming soon)
+# Gotsha — your local testing CI (alpha version)
 Pushing untested commits? Gotsha!
 
+## Installation
+```bash
+gem install gotsha # or add `gem "gotsha"` to you Gemfile and run `bundle install`
+
+gotsha
+```
+Then just follow the prompts — Gotsha will guide you through the setup. It won't take more than 3 minutes!
+
 ## 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/actions/commit.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Commit
+      DESCRIPTION = "creates a dummy commit and runs tests on it"
+
       def call
         BashCommand.silent_run!('git -c core.hooksPath=/dev/null commit --allow-empty -m "Run Gotsha"')
 

data/lib/gotsha/actions/help.rb

@@ -3,8 +3,15 @@
 module Gotsha
   module Actions
     class Help
+      DESCRIPTION = "shows available commands"
+
       def call
-        commands = Gotsha::Actions.constants.map(&:downcase).sort.join("\n")
+        commands = Gotsha::Actions.constants.map do |command|
+          name = command.downcase
+          description = Kernel.const_get("Gotsha::Actions::#{command}::DESCRIPTION")
+
+          "#{name}   # #{description}"
+        end.sort.join("\n")
 
         "Available commands: \n\n#{commands}"
       end

data/lib/gotsha/actions/init.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Init
+      DESCRIPTION = "first setup"
+
       def call
         puts "Creating files..."
 

data/lib/gotsha/actions/show.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Show
+      DESCRIPTION = "shows last commit test results"
+
       def call
         command = BashCommand.silent_run!("git --no-pager notes --ref=gotsha show")
 

data/lib/gotsha/actions/status.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Status
+      DESCRIPTION = "displays last commit tests status"
+
       def call
         last_commit_sha = BashCommand.run!("git --no-pager rev-parse HEAD").text_output
 

data/lib/gotsha/actions/test.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Test
+      DESCRIPTION = "runs and stores tests (don't use this; prefer autorun via hooks, or `gotsha commit`)"
+
       TESTS_PASSED_NOTE_PREFIX = "Tests passed:"
       TESTS_FAILED_NOTE_PREFIX = "Tests failed:"
 

data/lib/gotsha/actions/uninstall.rb

@@ -3,6 +3,8 @@
 module Gotsha
   module Actions
     class Uninstall
+      DESCRIPTION = "removes all Gotsha files and configurations"
+
       def call
         puts "Removing config files..."
 

data/lib/gotsha/user_config.rb

@@ -3,18 +3,22 @@
 module Gotsha
   class UserConfig
     def self.get(key)
-      config = TomlRB.load_file(Config::CONFIG_FILE).transform_keys(&:to_sym)
+      config = new.to_h
 
       ENV["GOTSHA_#{key.to_s.upcase}"] || # this allows changing config via ENV vars
         config[key]
-    rescue Errno::ENOENT
-      nil
     end
 
     def self.blank?
-      TomlRB.load_file(Config::CONFIG_FILE).empty?
+      new.to_h.empty?
+    end
+
+    def to_h
+      TomlRB.load_file(Config::CONFIG_FILE).transform_keys(&:to_sym)
     rescue Errno::ENOENT
-      true
+      {}
+    rescue TomlRB::ParseError => e
+      raise Errors::HardFail, "Syntax error in config file\n\n#{e.message}"
     end
   end
 end

data/lib/gotsha/version.rb

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

data/web/index.html

@@ -4,7 +4,7 @@
   <link rel="icon" href="favicon.ico" />
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1" />
-  <title>Gotsha — your local CI</title>
+  <title>Gotsha — your local testing CI</title>
   <meta name="description" content="Gotsha — sign off your commits locally by running tests & linters and proving it in your PR." />
   <style>
     :root{
@@ -91,46 +91,52 @@
         <!-- Checkmark integrated near 'SHA' -->
         <path class="stroke" d="M660,120 l35,35 70,-80"/>
       </svg>
-      <div class="title">Your local CI</div>
+      <div class="title">Your local testing CI</div>
     </header>
 
     <main>
       <section class="hero" aria-labelledby="hero-title">
         <h1 id="hero-title">Sign-off your commits locally — and let others see it.</h1>
-        <p>Run tests & linters on your machine, store results as Git notes, and let your PR show your tests output. Quickly and automatically.</p>
+        <p>Run tests & linters on your machine, store complete results, and let your PR show your tests output and status. Quickly and automatically.</p>
         <div class="actions">
-          <a class="btn primary" href="https://github.com/melounvitek/gotsha" target="_blank">View more details on Github</a>
+          <a class="btn primary" href="https://github.com/melounvitek/gotsha" target="_blank">More details on Github</a>
           <a class="btn secondary" href="https://github.com/melounvitek/gotsha/pull/35" target="_blank">Demo pull request</a>
         </div>
       </section>
 
-      <section class="grid">
-        <article class="card">
+      <section class="card" id="install" aria-labelledby="install-title">
+        <h2 id="install-title">Install</h3>
+          <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>
+      </section>
+
+      <section class="card">
+          <h2>How does it work?</h2>
+        <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>
         </article>
-        <article class="card">
+        <article>
           <h3>2) Stores test results for commit SHA</h3>
           <p>Test results from every run are attached as <em>Git notes</em> for the recent commit SHA. (Got-SHA... you get it, right?)</p>
         </article>
-        <article class="card">
+        <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>
         </article>
       </section>
 
-          <!--
-      <section class="card" id="install" aria-labelledby="install-title">
-        <h3 id="install-title">Install</h3>
-          <p>Install</p>
-        <pre><code># RubyGems
-gem install gotsha
-
-# Or add to your Gemfile
-gem 'gotsha'</code></pre>
-      </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>)

metadata

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