YardGhurt

spec.add_development_dependency 'yard_ghurt', '~> X.X.X'

gem 'yard_ghurt', '~> X.X.X', group: %i[development test]
# or...
gem 'yard_ghurt', git: 'https://github.com/esotericpig/yard_ghurt.git',
                  branch: main, group: %i[development test]

gem 'redcarpet','~> X.X' # For YARDoc Markdown (*.md).

YardGhurt::GFMFixTask.new do |task|
  task.arg_names = %i[dev]
  task.dry_run = false
  task.fix_code_langs = true
  task.md_files = ['index.html']

  task.before = proc do |task2,args|
    # Delete this file as it's never used (`index.html` is an exact copy).
    YardGhurt.rm_exist(File.join(task2.doc_dir,'file.README.html'))

    # Root dir of my GitHub Page for CSS/JS.
    ghp_root_dir = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'

    task2.css_styles << %(<link rel="stylesheet" type="text/css" href="#{ghp_root_dir}/css/prism.css" />)
    task2.js_scripts << %(<script src="#{ghp_root_dir}/js/prism.js"></script>)
  end
end

YardGhurt::GFMFixTask.new(:yard_fix) do |task|
  task.anchor_db           = {'tests' => 'Testing'} # Anchor links `#tests` become `#Testing`.
  task.arg_names          << :name # Custom args.
  task.css_styles         << '<link rel="stylesheet" href="css/my_css.css" />' # Inserted at `</head>`.
  task.css_styles         << '<style>body { background-color: linen; }</style>'
  task.custom_gsub         = proc { |line| !line.gsub!('YardGhurt','YARD GHURT!').nil? }
  task.custom_gsubs       << [/newline/i,'Do you smell what The Rock is cooking?']
  task.deps               << :yard # Custom dependencies.
  task.description         = 'Fix it'
  task.doc_dir             = 'doc'
  task.dry_run             = true
  task.exclude_code_langs  = Set['ruby']
  task.fix_anchor_links    = true
  task.fix_code_langs      = true
  task.fix_file_links      = true
  task.js_scripts         << '<script src="js/my_js.js"></script>' # Inserted at `</body>`.
  task.js_scripts         << '<script>document.write("Hello World!");</script>'
  task.md_files            = ['index.html']
  task.verbose             = false

  task.before = proc { |_task2,args| puts "Hi, #{args.name}!" }
  task.during = proc { |_task2,args,file| puts "#{args.name} can haz #{file}?" }
  task.after  = proc { |_task2,args| puts "Goodbye, #{args.name}!" }
end

YardGhurt::GHPSyncTask.new do |task|
  task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
  task.sync_args << '--delete-after'
end

# Execute: rake ghp_doc[false,'Custom']
YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
  task.arg_names   << :name                      # Custom args ('Custom').
  task.deps        << :yard                      # Custom dependencies.
  task.description  = 'Rsync my_doc/ to my page'
  task.doc_dir      = 'my_doc'                   # YARDoc directory of generated files.
  task.ghp_dir      = '../dest_dir/my_page'
  task.strict       = true                       # Fail if doc_dir doesn't exist.
  task.sync_args   << '--delete-after'
  task.sync_cmd     = '/usr/bin/rsync'

  task.before = proc { |_task2,args| puts "Hi, #{args.name}!" }
  task.after  = proc { |_task2,args| puts "Goodbye, #{args.name}!" }
end

require 'yard_ghurt/util'

# If the file exists, delete it, and if `output` is true, log it to stdout.
YardGhurt::Util.rm_exist('doc/file.README.html')
YardGhurt::Util.rm_exist('doc/file.README.html',false)

# Convert an Object to true or false.
puts YardGhurt::Util.to_bool('true') #=> true
puts YardGhurt::Util.to_bool('on')   #=> true
puts YardGhurt::Util.to_bool('yes')  #=> true
puts YardGhurt::Util.to_bool(nil)    #=> false

require 'yard_ghurt'

YardGhurt.rm_exist('doc/file.README.html')
puts YardGhurt.to_bool('true')

require 'yard_ghurt/anchor_links'

al = YardGhurt::AnchorLinks.new

puts al.to_github_anchor_id('This is a test!') #=> this-is-a-test
puts al.to_yard_anchor_id('This is a test!')   #=> This_is_a_test_

al = YardGhurt::AnchorLinks.new
name = 'This is a test!'

puts al.to_yard_anchor_id(name)   #=> This_is_a_test_
puts al.to_yard_anchor_id(name)   #=> This_is_a_test_

puts al.to_github_anchor_id(name) #=> this-is-a-test
puts al.to_github_anchor_id(name) #=> this-is-a-test

al << name # Officially add it to the database.

# Instead of being 0 & 0, it will be 0 & 1 (incremented),
#   even without being added to the database.
puts al.to_yard_anchor_id(name)   #=> This_is_a_test_0
puts al.to_yard_anchor_id(name)   #=> This_is_a_test_1

puts al.to_github_anchor_id(name) #=> this-is-a-test-1
puts al.to_github_anchor_id(name) #=> this-is-a-test-1

name = 'This is another test!'
al << name # Officially add it to the database.

# Instead of being 0 & 1, it will be 2 & 3 (global increment),
#   even without being added to the database.
puts al.to_yard_anchor_id(name)   #=> This_is_another_test_2
puts al.to_yard_anchor_id(name)   #=> This_is_another_test_3

puts al.to_github_anchor_id(name) #=> this-is-another-test-1
puts al.to_github_anchor_id(name) #=> this-is-another-test-1