Module: DocOpsLab::Dev

Defined in:

lib/docopslab/dev.rb,
lib/docopslab/dev/help.rb,
lib/docopslab/dev/paths.rb,
lib/docopslab/dev/tasks.rb,
lib/docopslab/dev/linters.rb,
lib/docopslab/dev/version.rb,
lib/docopslab/dev/checkers.rb,
lib/docopslab/dev/sync_ops.rb,
lib/docopslab/dev/git_hooks.rb,
lib/docopslab/dev/file_utils.rb,
lib/docopslab/dev/log_parser.rb,
lib/docopslab/dev/initializer.rb,
lib/docopslab/dev/spell_check.rb,
lib/docopslab/dev/config_manager.rb,
lib/docopslab/dev/script_manager.rb,
lib/docopslab/dev/tool_execution.rb,
lib/docopslab/dev/auto_fix_asciidoc.rb

Defined Under Namespace

Modules: AutoFixAsciidoc, Checkers, ConfigManager, FileUtilities, GitHooks, Help, Initializer, Linters, LogParser, Paths, ScriptManager, SpellCheck, SyncOps, ToolExecution Classes: Tasks

Constant Summary

GEM_ROOT =

begin
  spec = Gem::Specification.find_by_name('docopslab-dev')
  if spec
    spec.gem_dir
  else # Fallback for development
    File.expand_path('../../../', __dir__)
  end
end

MANIFEST_PATH =

Path constants Project paths (local/runtime)

'.config/docopslab-dev.yml'

CONFIG_VENDOR_DIR =

Paths.config_vendor_dir

HOOKS_DIR =

'.git/hooks'

CONFIG_PATHS =

Runtime/generated config files (merged from base + local)

Paths::CONFIG_FILES

RUBOCOP_CONFIG_PATH =

Shorthand for rubocop (most commonly referenced)

MANIFEST_DEF_PATH =

Gem source paths (assets bundled with gem)

File.join(GEM_ROOT, 'specs', 'data', 'default-manifest.yml')

TOOLS_DEF_PATH =

File.join(GEM_ROOT, 'specs', 'data', 'tools.yml')

CONFIG_PACKS_SOURCE_DIR =

Paths.gem_config_packs

SCRIPTS_SOURCE_DIR =

Paths.gem_scripts

HOOKS_SOURCE_DIR =

Paths.gem_hooks

TEMPLATES_DIR =

File.join(GEM_ROOT, 'assets', 'templates')

GITIGNORE_STUB_SOURCE_PATH =

File.join(TEMPLATES_DIR, 'gitignore')

GEMFILE_STUB_SOURCE_PATH =

File.join(TEMPLATES_DIR, 'Gemfile')

RAKEFILE_STUB_SOURCE_PATH =

File.join(TEMPLATES_DIR, 'Rakefile')

VERSION =

'0.1.0'

RUBY_TARGET =

'3.2.7'

Class Attribute Summary

• .manifest ⇒ Object

  Returns the value of attribute manifest.

• .tools_data ⇒ Object

  Returns the value of attribute tools_data.

Class Method Summary

• .bootstrap_project ⇒ Object
• .check_config_structure ⇒ Object
• .check_hook_updates ⇒ Object
• .check_ruby_version ⇒ Object
• .check_standard_rake_tasks ⇒ Object
• .create_gitignore_stub ⇒ Object
• .create_project_manifest ⇒ Object

  Initialization.

• .docker_available? ⇒ Boolean
• .file_matches_ignore_pattern?(file, pattern) ⇒ Boolean
• .find_asciidoc_files ⇒ Object
• .find_shell_scripts ⇒ Object
• .gem_sourced_locally? ⇒ Boolean
• .generate_htmlproofer_config ⇒ Object
• .generate_vale_config(style_override: nil) ⇒ Object

  Special Runtime Config Handling.

• .get_path_config(tool_slug) ⇒ Object
• .get_tool_entry(tool_slug) ⇒ Object
• .get_tool_files(tool_slug) ⇒ Object
• .get_tool_metadata(tool_slug) ⇒ Object
• .git_tracked_or_staged?(file) ⇒ Boolean
• .image_available? ⇒ Boolean
• .install_missing_hooks ⇒ Object
• .install_vale_styles ⇒ Object
• .lab_dev_mode? ⇒ Boolean
• .lint_file(file_path) ⇒ Object
• .list_hook_templates ⇒ Object
• .list_script_templates ⇒ Object
• .load_htmlproofer_config ⇒ Object
• .load_manifest(force_reload: false) ⇒ Object

  Common Utility.

• .load_tools_data ⇒ Object
• .run_actionlint(opts_string = '') ⇒ Object
• .run_adoc_auto_fix(path = nil) ⇒ Object
• .run_all_linters ⇒ Object
• .run_auto_fix ⇒ Object
• .run_in_docker(command) ⇒ Object
• .run_linter_group(group_name, linters) ⇒ Object
• .run_rubocop(file_path = nil, opts_string = '') ⇒ Object

  Run Linters.

• .run_rubocop_auto_fix(path: nil) ⇒ Object
• .run_rubocop_with_filter(filter_name) ⇒ Object
• .run_script(script_name, args = []) ⇒ Object
• .run_shellcheck(file_path = nil, opts_string = '') ⇒ Object
• .run_vale(file_path = nil, opts_string = '', output_format: :cli, filter: nil, style_override: nil) ⇒ Object
• .run_with_fallback(tool_name, command, use_docker: false) ⇒ Object

  Tool Execution.

• .shell_shebang?(file) ⇒ Boolean
• .show_lint_rule(tool, rule) ⇒ Object

  Show Stuff.

• .sync_config_files(tool_filter = :all, offline: false) ⇒ Object

  Sync Operations.

• .sync_directory(source_dir, target_dir, synced: false, expected_targets: nil) ⇒ Object
• .sync_docs(force: false) ⇒ Object
• .sync_scripts ⇒ Object
• .sync_vale_styles(local: false) ⇒ Object
• .tool_available?(tool_name) ⇒ Boolean

  Checkers & Finders.

• .update_hooks_interactive ⇒ Object

Class Attribute Details

.manifest ⇒ Object

Returns the value of attribute manifest.

# File 'lib/docopslab/dev.rb', line 68

def manifest
  @manifest
end

.tools_data ⇒ Object

Returns the value of attribute tools_data.

# File 'lib/docopslab/dev.rb', line 68

def tools_data
  @tools_data
end

Class Method Details

.bootstrap_project ⇒ Object

# File 'lib/docopslab/dev.rb', line 162

def bootstrap_project
  Initializer.bootstrap_project
end

.check_config_structure ⇒ Object

# File 'lib/docopslab/dev.rb', line 234

def check_config_structure
  Checkers.check_config_structure(self)
end

.check_hook_updates ⇒ Object

# File 'lib/docopslab/dev.rb', line 174

def check_hook_updates
  GitHooks.check_hook_updates
end

.check_ruby_version ⇒ Object

# File 'lib/docopslab/dev.rb', line 230

def check_ruby_version
  Checkers.check_ruby_version
end

.check_standard_rake_tasks ⇒ Object

# File 'lib/docopslab/dev.rb', line 238

def check_standard_rake_tasks
  Checkers.check_standard_rake_tasks
end

.create_gitignore_stub ⇒ Object

# File 'lib/docopslab/dev.rb', line 182

def create_gitignore_stub
  Initializer.create_gitignore_stub
end

.create_project_manifest ⇒ Object

Initialization

# File 'lib/docopslab/dev.rb', line 158

def create_project_manifest
  Initializer.create_project_manifest
end

.docker_available? ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 214

def docker_available?
  ToolExecution.docker_available?
end

.file_matches_ignore_pattern?(file, pattern) ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 258

def file_matches_ignore_pattern? file, pattern
  FileUtilities.file_matches_ignore_pattern?(file, pattern)
end

.find_asciidoc_files ⇒ Object

# File 'lib/docopslab/dev.rb', line 250

def find_asciidoc_files
  FileUtilities.find_asciidoc_files(self)
end

.find_shell_scripts ⇒ Object

# File 'lib/docopslab/dev.rb', line 242

def find_shell_scripts
  FileUtilities.find_shell_scripts(self)
end

.gem_sourced_locally? ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 226

def gem_sourced_locally?
  Checkers.gem_sourced_locally?
end

.generate_htmlproofer_config ⇒ Object

# File 'lib/docopslab/dev.rb', line 272

def generate_htmlproofer_config
  ConfigManager.generate_htmlproofer_config(self)
end

.generate_vale_config(style_override: nil) ⇒ Object

Special Runtime Config Handling

# File 'lib/docopslab/dev.rb', line 268

def generate_vale_config style_override: nil
  ConfigManager.generate_vale_config(self, style_override: style_override)
end

.get_path_config(tool_slug) ⇒ Object

# File 'lib/docopslab/dev.rb', line 254

def get_path_config tool_slug
  ConfigManager.get_path_config(tool_slug, self)
end

.get_tool_entry(tool_slug) ⇒ Object

# File 'lib/docopslab/dev.rb', line 103

def get_tool_entry tool_slug
  # Get a tool's configuration from project manifest
  manifest = load_manifest
  return nil unless manifest

  manifest['tools']&.find { |t| t['tool'] == tool_slug }
end

.get_tool_files(tool_slug) ⇒ Object

# File 'lib/docopslab/dev.rb', line 111

def get_tool_files tool_slug
  # Get file mappings for a tool from manifest
  # Returns hash: { base: {upstream:, local:, synced:}, project: {upstream:, local:, synced:} }
  tool_entry = get_tool_entry(tool_slug)
  return {} unless tool_entry

  files = {}
  tool_entry['files']&.each do |file_config|
    target_path = file_config['target']
    source_path = file_config['source']

    next unless target_path # Skip if no target path defined

    if target_path.include?('.vendor/')
      files[:base] = {
        source: source_path,
        local: target_path,
        synced: file_config.fetch('synced', true)
      }
    else
      files[:project] = {
        source: source_path,
        local: target_path,
        synced: file_config.fetch('synced', false)
      }
    end
  end

  files
end

.get_tool_metadata(tool_slug) ⇒ Object

# File 'lib/docopslab/dev.rb', line 97

def get_tool_metadata tool_slug
  # Get a tool's info from tools definition
  tools_data = load_tools_data
  tools_data.find { |t| t['slug'] == tool_slug }
end

.git_tracked_or_staged?(file) ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 262

def git_tracked_or_staged? file
  FileUtilities.git_tracked_or_staged?(file)
end

.image_available? ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 218

def image_available?
  ToolExecution.image_available?
end

.install_missing_hooks ⇒ Object

# File 'lib/docopslab/dev.rb', line 170

def install_missing_hooks
  GitHooks.install_missing_hooks
end

.install_vale_styles ⇒ Object

# File 'lib/docopslab/dev.rb', line 166

def install_vale_styles
  SyncOps.install_vale_styles(self)
end

.lab_dev_mode? ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 222

def lab_dev_mode?
  Checkers.lab_dev_mode?
end

.lint_file(file_path) ⇒ Object

# File 'lib/docopslab/dev.rb', line 324

def lint_file file_path
  Linters.lint_file(self, file_path)
end

.list_hook_templates ⇒ Object

# File 'lib/docopslab/dev.rb', line 341

def list_hook_templates
  GitHooks.list_hook_templates
end

.list_script_templates ⇒ Object

# File 'lib/docopslab/dev.rb', line 345

def list_script_templates
  ScriptManager.list_script_templates
end

.load_htmlproofer_config ⇒ Object

# File 'lib/docopslab/dev.rb', line 276

def load_htmlproofer_config
  ConfigManager.load_htmlproofer_config
end

.load_manifest(force_reload: false) ⇒ Object

Common Utility

# File 'lib/docopslab/dev.rb', line 72

def load_manifest force_reload: false
  return @manifest if @manifest && !force_reload

  @manifest = YAML.load_file(MANIFEST_PATH) if File.exist?(MANIFEST_PATH)
  @manifest
rescue StandardError => e
  warn "Failed to load manifest: #{e.message}"
  nil
end

.load_tools_data ⇒ Object

# File 'lib/docopslab/dev.rb', line 82

def load_tools_data
  return @tools_data if @tools_data

  @tools_data = begin
    if File.exist?(TOOLS_DEF_PATH)
      YAML.load_file(TOOLS_DEF_PATH)
    else
      []
    end
  rescue StandardError => e
    warn "Failed to load tools data: #{e.message}"
    []
  end
end

.run_actionlint(opts_string = '') ⇒ Object

# File 'lib/docopslab/dev.rb', line 294

def run_actionlint opts_string=''
  Linters.run_actionlint(self, opts_string)
end

.run_adoc_auto_fix(path = nil) ⇒ Object

# File 'lib/docopslab/dev.rb', line 311

def run_adoc_auto_fix path=nil
  AutoFixAsciidoc.fix_asciidoc_files(self, path: path)
end

.run_all_linters ⇒ Object

# File 'lib/docopslab/dev.rb', line 298

def run_all_linters
  Linters.run_all_linters(self)
end

.run_auto_fix ⇒ Object

# File 'lib/docopslab/dev.rb', line 302

def run_auto_fix
  Linters.run_auto_fix
  AsciiidocAutoFix.fix_asciidoc_files(self)
end

.run_in_docker(command) ⇒ Object

# File 'lib/docopslab/dev.rb', line 148

def run_in_docker command
  ToolExecution.run_in_docker(command)
end

.run_linter_group(group_name, linters) ⇒ Object

# File 'lib/docopslab/dev.rb', line 315

def run_linter_group group_name, linters
  Linters.run_linter_group(self, group_name, linters)
end

.run_rubocop(file_path = nil, opts_string = '') ⇒ Object

Run Linters

# File 'lib/docopslab/dev.rb', line 282

def run_rubocop file_path=nil, opts_string=''
  Linters.run_rubocop(self, file_path, opts_string)
end

.run_rubocop_auto_fix(path: nil) ⇒ Object

# File 'lib/docopslab/dev.rb', line 307

def run_rubocop_auto_fix path: nil
  Linters.run_rubocop_auto_fix(self, path: path)
end

.run_rubocop_with_filter(filter_name) ⇒ Object

# File 'lib/docopslab/dev.rb', line 286

def run_rubocop_with_filter filter_name
  Linters.run_rubocop_with_filter(self, filter_name)
end

.run_script(script_name, args = []) ⇒ Object

# File 'lib/docopslab/dev.rb', line 152

def run_script script_name, args=[]
  ScriptManager.run_script(script_name, args)
end

.run_shellcheck(file_path = nil, opts_string = '') ⇒ Object

# File 'lib/docopslab/dev.rb', line 290

def run_shellcheck file_path=nil, opts_string=''
  Linters.run_shellcheck(self, file_path, opts_string)
end

.run_vale(file_path = nil, opts_string = '', output_format: :cli, filter: nil, style_override: nil) ⇒ Object

# File 'lib/docopslab/dev.rb', line 319

def run_vale file_path=nil, opts_string='', output_format: :cli, filter: nil, style_override: nil
  Linters.run_vale self, file_path, opts_string, output_format: output_format, filter: filter,
style_override: style_override
end

.run_with_fallback(tool_name, command, use_docker: false) ⇒ Object

Tool Execution

# File 'lib/docopslab/dev.rb', line 144

def run_with_fallback tool_name, command, use_docker: false
  ToolExecution.run_with_fallback(tool_name, command, use_docker: use_docker)
end

.shell_shebang?(file) ⇒ Boolean

Returns:

# File 'lib/docopslab/dev.rb', line 246

def shell_shebang? file
  FileUtilities.shell_shebang?(file)
end

.show_lint_rule(tool, rule) ⇒ Object

Show Stuff

# File 'lib/docopslab/dev.rb', line 330

def show_lint_rule tool, rule
  case tool
  when 'vale'
    print_vale_style(rule)
  when 'rubocop'
    print_cop(rule)
  else
    puts "❌ Unknown or unsupported tool: #{tool}. Supported tools: vale, rubocop"
  end
end

.sync_config_files(tool_filter = :all, offline: false) ⇒ Object

Sync Operations

# File 'lib/docopslab/dev.rb', line 188

def sync_config_files tool_filter=:all, offline: false
  SyncOps.sync_config_files(self, tool_filter: tool_filter, offline: offline)
end

.sync_directory(source_dir, target_dir, synced: false, expected_targets: nil) ⇒ Object

# File 'lib/docopslab/dev.rb', line 192

def sync_directory source_dir, target_dir, synced: false, expected_targets: nil
  SyncOps.sync_directory(source_dir, target_dir, synced: synced, expected_targets: expected_targets)
end

.sync_docs(force: false) ⇒ Object

# File 'lib/docopslab/dev.rb', line 204

def sync_docs force: false
  SyncOps.sync_docs(self, force: force)
end

.sync_scripts ⇒ Object

# File 'lib/docopslab/dev.rb', line 196

def sync_scripts
  SyncOps.sync_scripts(self)
end

.sync_vale_styles(local: false) ⇒ Object

# File 'lib/docopslab/dev.rb', line 200

def sync_vale_styles local: false
  SyncOps.sync_vale_styles(self, local: local)
end

.tool_available?(tool_name) ⇒ Boolean

Checkers & Finders

Returns:

# File 'lib/docopslab/dev.rb', line 210

def tool_available? tool_name
  ToolExecution.tool_available?(tool_name)
end

.update_hooks_interactive ⇒ Object

# File 'lib/docopslab/dev.rb', line 178

def update_hooks_interactive
  GitHooks.update_hooks_interactive
end