Contents

require 'bundler/gem_tasks'
require 'rspec/core/rake_task'
require 'rubocop/rake_task'

RSpec::Core::RakeTask.new(:specs)

task default: :spec

task :spec do
  Rake::Task['specs'].invoke
  Rake::Task['rubocop'].invoke
end

desc 'Run RuboCop on the lib/specs directory'
RuboCop::RakeTask.new(:rubocop) do |task|
  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
end

task :readme do
  readme = File.open("README.md", 'rb', &:read)

  start_split = "## Usage"
  end_split = "## Development"

  start = readme.split(start_split)[0]
  rest = readme.split(start_split)[1]
  finale = rest.split(end_split)[1]

  require 'yard'
  files = ["lib/gh_inspector/inspector.rb", "lib/gh_inspector/sidekick.rb", "lib/gh_inspector/evidence.rb"]
  docs = YARD::Registry.load(files, true)

  usage = "\n\n"
  usage << "#### The Inspector\n\n"
  usage << docs.at("GhInspector::Inspector").docstring
  usage << "\n"

  usage << "#### Presenting Your Report \n\n"
  evidence = docs.at("GhInspector::Evidence")
  usage << evidence.docstring

  usage << "\nProtocol for custom objects:\n\n"
  evidence.children.each do |method|
    next unless method.name.to_s.start_with? "inspector"
    params = method.parameters.flatten.compact
    usage << " - `#{method.name}(#{params.join ', '})` - #{method.docstring}\n"
  end
  usage << "\n\n"

  new_file = start + start_split + usage + end_split + finale
  File.open("README.md", 'w') { |f| f.write new_file }
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
gh_inspector-1.1.2	Rakefile
gh_inspector-1.1.1	Rakefile
gh_inspector-1.1.0	Rakefile
gh_inspector-1.0.3	Rakefile
gh_inspector-1.0.2	Rakefile
gh_inspector-1.0.1	Rakefile
gh_inspector-1.0.0	Rakefile