refactor static analysis checks

Author: DannyBen

.github/workflows/static-analysis.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
       with: 
-        ruby-version: '3.1'
+        ruby-version: '3.2'
         bundler-cache: true
 
     - name: Generate all examples
@@ -39,17 +39,8 @@ jobs:
     - name: Generate all fixtures
       run: bundle exec run fixtures regen
 
-    - name: Run shellcheck tests (examples)
-      run: bundle exec run shellcheck examples
-
-    - name: Run shellcheck tests (fixtures)
-      run: bundle exec run shellcheck fixtures
-
-    - name: Run shfmt tests (examples)
-      run: bundle exec run shfmt examples
-
-    - name: Run shfmt tests (fixtures)
-      run: bundle exec run shfmt fixtures
+    - name: Run shellcheck and shfmt tests
+      run: bundle exec run static
 
   json_schema:
     name: Validate JSON schemas

runfile

@@ -1,7 +1,6 @@
 require 'debug'
 require 'bashly/version'
 require_relative 'support/runfile/example'
-require_relative 'support/runfile/workspace_fixture'
 
 title   'Bashly Developer Toolbelt'
 summary 'Runfile tasks for building the Bashly gem'

support/runfile/example.rb

@@ -3,27 +3,43 @@
 # A helper class used in Runfile to generate example README files
 class Example
   class << self
-    def dirs
-      @dirs ||= Dir['examples/*'].select { |f| File.directory? f }
+    def examples
+      filter_dirs('examples').map { |dir| new dir }
+    end
+
+    def fixtures      
+      filter_dirs('spec/fixtures/workspaces').map { |dir| new dir, type: :fixture }
     end
 
     def all
-      dirs.map { |dir| Example.new dir }
+      examples + fixtures
     end
 
-    def executables
-      all.map(&:executable)
+  private
+
+    def filter_dirs(base_dir)
+      Dir["#{base_dir}/*"].select { |f| File.directory? f }
     end
+
   end
 
-  attr_reader :dir
+  attr_reader :dir, :type
 
-  def initialize(dir)
+  def initialize(dir, type: :example)
     @dir = dir
+    @type = type
+  end
+
+  def inspect
+    %Q[#<Example type=:#{type}, dir="#{dir}">]
   end
 
   def config
-    @config ||= YAML.unsafe_load_file yaml_path
+    @config ||= if File.exist? yaml_path
+      YAML.unsafe_load_file yaml_path
+    else
+      {}
+    end
   end
 
   def yaml
@@ -34,12 +50,27 @@ def yaml_path
     "#{dir}/src/bashly.yml"
   end
 
+  def readme
+    @readme ||= File.exist?(readme_path) ? File.read(readme_path) : ''
+  end
+
   def readme_path
     "#{dir}/README.md"
   end
 
-  def readme
-    File.read readme_path
+  def regenerate_readme
+    raise "#regenerate_readme called on a fixture" if type == :fixture
+    File.write readme_path, generated_readme
+  end
+
+  def executable
+    @executable ||= File.file?(executable_path) ? executable_path : nil
+  end
+
+private
+
+  def executable_path
+    "#{dir}/#{config['name']}"
   end
 
   def test_commands
@@ -72,10 +103,6 @@ def test_output
     result
   end
 
-  def regenerate_readme
-    File.write readme_path, generated_readme
-  end
-
   def generated_readme
     marker = '-----'
     content = readme.split(marker)[0].strip
@@ -135,8 +162,4 @@ def langs
       '.yaml' => 'yaml',
     }
   end
-
-  def executable
-    "#{dir}/#{config['name']}"
-  end
 end

support/runfile/examples.runfile

@@ -5,7 +5,7 @@ usage "regen [FILTER]"
 action :regen do |args|
   # Patch the PATH to allow the extensible example to run properly
   ENV['PATH']="#{Dir.pwd}/examples/extensible:#{ENV['PATH']}"
-  Example.all.each do |example|
+  Example.examples.each do |example|
     if args['FILTER']
       next unless example.dir.include? ENV['FILTER']
     end
@@ -24,7 +24,7 @@ action :readme do |args|
 
   # Patch the PATH to allow the extensible example to run properly
   ENV['PATH']="#{Dir.pwd}/examples/extensible:#{ENV['PATH']}"
-  Example.all.each do |example|
+  Example.examples.each do |example|
     if args['FILTER']
       next unless example.dir.include? args['FILTER']
     end

support/runfile/fixtures.runfile

@@ -56,7 +56,7 @@ action(:invalid) { check_invalid }
 helpers do
   def check_examples
     say "\ngub`Examples`"
-    Example.all.each do |example|
+    Example.examples.each do |example|
       file = example.yaml_path
       schema_check file
     end

support/runfile/schema.runfile

@@ -0,0 +1,46 @@
+summary 'Run shellcheck and shfmt checks on all examples'
+
+help "Run shellcheck and shfmt on all examples or a given example"
+usage "[FILTER]"
+action do |args|
+  blacklist = %w[
+    examples/render-mandoc
+    examples/render-markdown
+    examples/settings
+    spec/fixtures/workspaces/completions-private
+    spec/fixtures/workspaces/custom-paths
+    spec/fixtures/workspaces/import
+    spec/fixtures/workspaces/lib-upgrade
+  ]
+
+  errors = 0
+
+  Example.all.each do |example|
+    if args['FILTER']
+      next unless example.dir.include? args['FILTER']
+    end
+
+    next if blacklist.include? example.dir
+
+    if !example.executable
+      say "nb`WARNING: Skipping #{example.dir}`"
+      next
+    end
+
+    say "\n#{example.executable}"
+    success = system "shellcheck #{example.executable}"
+    say success ? 'g`  ✓ shellcheck`' : '  r`✗ shellcheck`'
+    errors += 1 unless success
+
+    success = system "shfmt -d -i 2 -ci #{example.executable}"
+    say success ? '  g`✓ shfmt`' : '  r`✗ shfmt`'
+    errors += 1 unless success
+  end
+
+  if errors > 0
+    say "\nrb`#{errors} errors found`"
+    exit 1
+  end
+
+  say "\nno errors found"
+end