way_of_working 1.0.0 → 2.0.0

data/lib/way_of_working/tasks.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# require 'ndr_dev_support/tasks'
+require 'ndr_dev_support/tasks'
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new

data/lib/way_of_working/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WayOfWorking
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/way_of_working.rb

@@ -1,10 +1,24 @@
 # frozen_string_literal: true
 
-require 'thor'
-require_relative 'way_of_working/cli'
-require_relative 'way_of_working/paths'
-require_relative 'way_of_working/version'
+require 'way_of_working/cli'
+require 'way_of_working/paths'
+require 'zeitwerk'
 
+# Require "internal" plugin(s) here
+require 'way_of_working/readme_badge'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# This is the namespace for everything associated with the Way of Working
 module WayOfWorking
   class Error < StandardError; end
 end
+
+# Automatically load way_of_working plugins.
+Gem::Specification.
+  select { |gemspec| gemspec.name =~ /\Away_of_working-/ }.
+  collect(&:name).uniq. # multiple versions of a single gem may be installed at once
+  each do |name|
+  require "#{name.gsub('-', '/')}/plugin"
+end

data/way_of_working.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").select do |f|
-      f.match(%r{\A(?:(?:exe|lib)/|[^/]+\.(?:gemspec|md|txt))})
+      f.match(%r{\A(?:(?:exe|lib)/|[^/]+\.(?:gemspec|md|tt|txt))})
     end
   end
   spec.bindir = 'exe'
@@ -37,7 +37,10 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'git', '~> 1.13'
+  spec.add_dependency 'nokogiri'
   spec.add_dependency 'rainbow', '~> 3.1'
   spec.add_dependency 'thor', '~> 1.2'
+  spec.add_dependency 'zeitwerk', '~> 2.6.18'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: way_of_working
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Gentry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-description: 
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.18
+description:
 email:
 - 52189+timgentry@users.noreply.github.com
 executables:
@@ -68,26 +110,21 @@ files:
 - lib/tasks/audit_gems.rake
 - lib/way_of_working.rb
 - lib/way_of_working/cli.rb
-- lib/way_of_working/generators/changelog/init.rb
-- lib/way_of_working/generators/code_of_conduct/init.rb
-- lib/way_of_working/generators/decision_record/init.rb
-- lib/way_of_working/generators/decision_record/new.rb
-- lib/way_of_working/generators/linter/exec.rb
-- lib/way_of_working/generators/linter/init.rb
-- lib/way_of_working/generators/rake_tasks/init.rb
+- lib/way_of_working/configuration.rb
 - lib/way_of_working/git/repo_reader.rb
 - lib/way_of_working/git/summary_tag.rb
 - lib/way_of_working/paths.rb
-- lib/way_of_working/sub_command_base.rb
+- lib/way_of_working/readme_badge.rb
+- lib/way_of_working/readme_badge/generators/init.rb
+- lib/way_of_working/readme_badge/github_audit_rule.rb
+- lib/way_of_working/readme_badge/paths.rb
+- lib/way_of_working/readme_badge/templates/README.md
+- lib/way_of_working/readme_badge/templates/docs/way_of_working/readme-badges.md.tt
+- lib/way_of_working/sub_commands/base.rb
+- lib/way_of_working/sub_commands/exec.rb
+- lib/way_of_working/sub_commands/init.rb
+- lib/way_of_working/sub_commands/new.rb
 - lib/way_of_working/tasks.rb
-- lib/way_of_working/templates/.github/linters/.markdown-link-check.json
-- lib/way_of_working/templates/.github/linters/rubocop_defaults.yml
-- lib/way_of_working/templates/.github/workflows/mega-linter.yml
-- lib/way_of_working/templates/.mega-linter.yml
-- lib/way_of_working/templates/.rubocop
-- lib/way_of_working/templates/CODE_OF_CONDUCT.md.tt
-- lib/way_of_working/templates/docs/decisions/README.md
-- lib/way_of_working/templates/docs/decisions/adr-template.md.tt
 - lib/way_of_working/version.rb
 - way_of_working.gemspec
 homepage: https://healthdatainsight.github.io/way_of_working
@@ -99,7 +136,7 @@ metadata:
   homepage_uri: https://healthdatainsight.github.io/way_of_working
   source_code_uri: https://github.com/HealthDataInsight/way_of_working
   changelog_uri: https://github.com/HealthDataInsight/way_of_working/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: RubyGem for the HDI way of working.
 test_files: []

data/lib/way_of_working/generators/changelog/init.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-require 'way_of_working/paths'
-require 'way_of_working/git/repo_reader'
-
-module WayOfWorking
-  module Generators
-    module Changelog
-      # This class fetches the CODE_OF_CONDUCT.md and inserts the contact method
-      class Init < Thor::Group
-        include Thor::Actions
-
-        source_root ::WayOfWorking.source_root
-
-        HEADER_TEXT = <<~TEXT
-          # Changelog
-
-          All notable changes to this project will be documented in this file.
-
-          The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-          and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-        TEXT
-
-        def add_changelog_to_project
-          create_file 'CHANGELOG.md' do
-            HEADER_TEXT + releases + footer
-          end
-        end
-
-        private
-
-        def releases
-          text = "## [Unreleased]\n\n"
-          text += added_change_text(:minor)
-          text += deprecated_removed_fixed_security_text(:minor)
-
-          summary_tags.each do |summary_tag|
-            text += "## [#{summary_tag.version}] - " \
-                    "#{summary_tag.commit_date.strftime('%Y-%m-%d')}\n\n"
-
-            text += added_change_text(summary_tag.change_type)
-            text += deprecated_removed_fixed_security_text(summary_tag.change_type)
-          end
-
-          text
-        end
-
-        def added_change_text(tag_change_type)
-          return '' if tag_change_type == :patch
-
-          change_text('Added', 'Detail new feature(s) here', true) +
-            change_text('Change', 'Detail change(s) in existing functionality here',
-                        tag_change_type == :major)
-        end
-
-        def deprecated_removed_fixed_security_text(tag_change_type)
-          change_text('Deprecated', 'Detail soon-to-be removed features here') +
-            change_text('Removed', 'Detail removed features here', tag_change_type == :major) +
-            change_text('Fixed', 'Detail any bug fixes here', true) +
-            change_text('Security', 'Detail fixes to vulnerabilities here')
-        end
-
-        # This method adds all of the reference style markdown links
-        def footer
-          return '' if summary_tags.empty?
-
-          previous_tag = nil
-          footer_text = ''
-          summary_tags.each do |summary_tag|
-            footer_text += if previous_tag
-                             release_link(summary_tag.name, previous_tag.name, previous_tag.version)
-                           else
-                             release_link(summary_tag.name, 'HEAD', 'Unreleased')
-                           end
-
-            previous_tag = summary_tag
-          end
-
-          footer_text += "[#{previous_tag.version}]: #{url}/releases/tag/#{previous_tag.name}\n"
-
-          footer_text
-        end
-
-        def release_link(start_tag, end_tag, version)
-          "[#{version}]: #{url}/compare/#{start_tag}...#{end_tag}\n"
-        end
-
-        def change_text(type, description, likely = false)
-          text = "### #{type}\n\n- TODO: #{description}"
-          text += ' (if any)' unless likely
-          text += "\n\n"
-          text
-        end
-
-        def repo_reader
-          @repo_reader ||= ::WayOfWorking::Git::RepoReader.new(::Git.open('.'))
-        end
-
-        def summary_tags
-          @summary_tags ||= repo_reader.summary_tags.reverse
-        end
-
-        def url
-          @url ||= repo_reader.likely_upstream_remote_url
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/code_of_conduct/init.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'way_of_working/paths'
-
-module WayOfWorking
-  module Generators
-    module CodeOfConduct
-      # This class fetches the CODE_OF_CONDUCT.md and inserts the contact method
-      class Init < Thor::Group
-        include Thor::Actions
-
-        source_root ::WayOfWorking.source_root
-
-        class_option :contact_method, required: true
-
-        # Use this method to update the cached template when required
-        # def download_and_save_code_of_conduct_template
-        #   code_of_conduct_file = 'lib/way_of_working/templates/CODE_OF_CONDUCT.md.tt'
-
-        #   get 'https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md',
-        #       code_of_conduct_file
-        #   gsub_file code_of_conduct_file, '[INSERT CONTACT METHOD]',
-        #             "<%= options['contact_method'] %>"
-        # end
-
-        def add_code_of_conduct_to_project
-          template 'CODE_OF_CONDUCT.md'
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/decision_record/init.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'way_of_working/paths'
-
-module WayOfWorking
-  module Generators
-    module DecisionRecord
-      # This generator add the MADR files to the doc/decisions folder
-      class Init < Thor::Group
-        include Thor::Actions
-
-        source_root ::WayOfWorking.source_root
-
-        # Templates are from https://github.com/adr/madr/tree/3.0.0/template
-        def create_decision_record_files
-          copy_file 'docs/decisions/README.md'
-
-          # from https://raw.githubusercontent.com/adr/madr/3.0.0/template/adr-template.md
-          @decision_date = '{YYYY-MM-DD when the decision was last updated}'
-          @title = '{short title of solved problem and solution}'
-          template 'docs/decisions/adr-template.md'
-
-          get 'https://raw.githubusercontent.com/adr/madr/3.0.0/template/0000-use-markdown-any-decision-records.md',
-              'docs/decisions/0000-use-markdown-any-decision-records.md'
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/decision_record/new.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'date'
-require 'way_of_working/paths'
-
-module WayOfWorking
-  module Generators
-    module DecisionRecord
-      # This generator add a new MADR decision record to the doc/decisions folder
-      class New < Thor::Group
-        argument :name, type: :string, required: true, desc: 'The title of the decision record'
-
-        include Thor::Actions
-
-        source_root ::WayOfWorking.source_root
-
-        def create_decision_record_file
-          case behavior
-          when :invoke
-            invoke_decision_record_file
-          when :revoke
-            revoke_decision_record_file
-          end
-        end
-
-        private
-
-        def invoke_decision_record_file
-          @decision_date = Date.today.strftime('%Y-%m-%d')
-          @title = name
-
-          # from https://raw.githubusercontent.com/adr/madr/3.0.0/template/adr-template.md
-          template 'docs/decisions/adr-template.md',
-                   "docs/decisions/#{next_decision_number}-#{dashed_name}.md"
-        end
-
-        def revoke_decision_record_file
-          matching_files = Dir.glob("[0-9][0-9][0-9][0-9]-#{dashed_name}.md",
-                                    base: File.join(destination_root, 'docs/decisions'))
-          raise "No matching decision record for '#{dashed_name}'" if matching_files.empty?
-
-          # based on Thor's remove_file
-          path = File.expand_path("docs/decisions/#{matching_files.first}", destination_root)
-
-          say_status :remove, relative_to_original_destination_root(path)
-          return unless !options[:pretend] && (File.exist?(path) || File.symlink?(path))
-
-          require 'fileutils'
-          ::FileUtils.rm_rf(path)
-        end
-
-        def next_decision_number
-          existing_decisions = Dir.glob('[0-9][0-9][0-9][0-9]-*.md',
-                                        base: File.join(destination_root, 'docs/decisions'))
-          last_number = existing_decisions.map do |filename|
-            filename.match(/\A(\d{4})-/)[1].to_i
-          end.max || -1
-          format('%04d', last_number + 1)
-        end
-
-        def dashed_name
-          name.downcase.gsub(/[\s_()]/, '-').gsub(/-+/, '-')
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/linter/exec.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'thor'
-require 'rainbow'
-
-module WayOfWorking
-  module Generators
-    module Linter
-      # This generator runs the linter
-      class Exec < Thor::Group
-        argument :path, type: :string, required: false, desc: 'Optional path of the file to lint'
-
-        desc 'This runs the linter on this project'
-
-        def run_first
-          @start_time = Time.now
-
-          say(Rainbow("Limiting linters to #{path}\n").yellow) if path
-        end
-
-        # Run RuboCop
-        def prep_and_run_rubocop
-          say(Rainbow('Running RuboCop...').yellow)
-
-          @rubocop_ok = run_rubocop(ARGV[2..])
-        end
-
-        # Run MegaLinter
-        def prep_and_run_megalinter
-          command = ['npx', 'mega-linter-runner', '--remove-container']
-          # Configure MegaLinter to only lint a specific file or folder, if defined
-          command.prepend("MEGALINTER_FILES_TO_LINT=\"#{path}\"") if path
-          # We only want reports created in the working directory
-          command.prepend('env', "GITHUB_WORKSPACE=\"#{Dir.pwd}\"")
-
-          say(Rainbow("\nRunning MegaLinter...").yellow)
-
-          @megalinter_ok = run_megalinter(command)
-        end
-
-        # We run this last to enable all the linters to run first
-        def run_last
-          say(Rainbow("\nTotal time taken: #{(Time.now - @start_time).to_i} seconds").yellow)
-
-          if !@rubocop_ok || !@megalinter_ok
-            abort(Rainbow("\nLinter failed!").red)
-          else
-            say(Rainbow("\nLinter Succeeded!").green)
-          end
-        end
-
-        private
-
-        def path_directory
-          return path if File.directory?(path)
-
-          File.dirname(path)
-        end
-
-        def run_rubocop(arguments)
-          # We lazy-load RuboCop so that the task doesn't dramatically impact the
-          # load time of our commands.
-          require 'rubocop'
-
-          cli = RuboCop::CLI.new
-          !cli.run(arguments).nonzero?
-        end
-
-        def run_megalinter(arguments)
-          arguments.prepend('time')
-
-          system(*arguments)
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/linter/init.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'thor'
-require 'way_of_working/paths'
-
-module WayOfWorking
-  module Generators
-    module Linter
-      # This generator add the MADR files to the doc/decisions folder
-      class Init < Thor::Group
-        include Thor::Actions
-
-        source_root ::WayOfWorking.source_root
-
-        # TODO: copy_rubocop_github_workflow_action
-
-        def copy_github_linters_rubocop_config_file
-          copy_file '.github/linters/rubocop_defaults.yml'
-        end
-
-        def copy_github_linters_markdown_link_check_config_file
-          copy_file '.github/linters/.markdown-link-check.json'
-        end
-
-        def copy_megalinter_github_workflow_action
-          copy_file '.github/workflows/mega-linter.yml'
-        end
-
-        def copy_megalinter_dot_file
-          copy_file '.mega-linter.yml'
-        end
-
-        def create_gitignore_if_missing
-          create_file_if_missing '.gitignore'
-        end
-
-        def gitignore_reports_folder
-          append_to_file '.gitignore', "megalinter-reports/\n"
-        end
-
-        def gitignore_rubocop_cached_file
-          append_to_file '.gitignore', ".rubocop-https---*\n"
-        end
-
-        def copy_rubocop_options_file
-          copy_file '.rubocop'
-        end
-
-        private
-
-        def create_file_if_missing(path)
-          path = File.join(destination_root, path)
-          return if behavior == :revoke || File.exist?(path)
-
-          File.open(path, 'w', &:write)
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/generators/rake_tasks/init.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module WayOfWorking
-  module Generators
-    module RakeTasks
-      # This generator installs way of working rake tasks into this project
-      class Init < Thor::Group
-        include Thor::Actions
-
-        RAKEFILE_FILENAME = 'Rakefile'
-        RAILS_LOC = %r{require_relative ["']config/application["']\n}.freeze
-        BUNDLER_LOC = %r{require ["']bundler/gem_tasks["']\n}.freeze
-
-        def add_to_rakefile
-          case rakefile_type
-          when :rails
-            inject_into_file RAKEFILE_FILENAME,
-                             "require 'way_of_working/tasks' if Rails.env.development? " \
-                             "|| Rails.env.test?\n",
-                             after: RAILS_LOC
-          when :bundler
-            inject_into_file RAKEFILE_FILENAME,
-                             "require 'way_of_working/tasks'\n",
-                             after: BUNDLER_LOC
-          when :none
-            create_file RAKEFILE_FILENAME, "\nrequire 'way_of_working/tasks'\n"
-          else
-            append_to_file RAKEFILE_FILENAME, "\nrequire 'way_of_working/tasks'\n"
-          end
-        end
-
-        private
-
-        def rakefile_type
-          content = File.read(File.expand_path(RAKEFILE_FILENAME, destination_root))
-
-          return :rails if content.match?(RAILS_LOC)
-          return :bundler if content.match?(BUNDLER_LOC)
-
-          :other
-        rescue Errno::ENOENT
-          :none
-        end
-      end
-    end
-  end
-end

data/lib/way_of_working/sub_command_base.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'thor'
-
-# This class enables subcommands to work correctly with help. See:
-# https://github.com/rails/thor/wiki/Subcommands#subcommands-that-work-correctly-with-help
-class SubCommandBase < Thor
-  def self.banner(command, _namespace = nil, _subcommand = false)
-    "#{basename} #{subcommand_prefix} #{command.usage}"
-  end
-
-  def self.subcommand_prefix
-    name.gsub(/.*::/, '').gsub(/^[A-Z]/) { |match| match[0].downcase }.
-      gsub(/[A-Z]/) { |match| "-#{match[0].downcase}" }
-  end
-end

data/lib/way_of_working/templates/.github/linters/.markdown-link-check.json

@@ -1,13 +0,0 @@
-{
-    "ignorePatterns": [
-        {
-            "pattern": "^0005-example.md"
-        },
-        {
-            "pattern": "^adr-template.md"
-        }
-    ],
-    "retryOn429": true,
-    "retryCount": 5,
-    "aliveStatusCodes": [ 200, 203 ]
-}