class KnifeCookbookReadme::Readme

Public Class Methods

new(metadata) click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 5
def initialize(metadata)
  @metadata = metadata
end

Public Instance Methods

attributes() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 29
def attributes
  @metadata.attributes.map do |attr, options|
    name = "node['#{attr.gsub("/", "']['")}']"
    [name, options['description'], options['default']]
  end
end
author() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 40
def author
  @metadata.maintainer
end
author_email() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 44
def author_email
  @metadata.maintainer_email
end
dependencies() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 23
def dependencies
  @metadata.dependencies.map do |cookbook, version|
    format_constraint(cookbook, version)
  end
end
description() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 13
def description
  @metadata.description
end
license() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 52
def license
  @metadata.license
end
platforms() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 17
def platforms
  @metadata.platforms.map do |platform, version|
    format_constraint(platform.capitalize, version)
  end
end
recipes() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 36
def recipes
  @metadata.recipes
end
render(template) click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 56
def render(template)
  Template.render(template, get_binding)
end
title() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 9
def title
  "#{@metadata.name.capitalize} Cookbook"
end

Private Instance Methods

format_constraint(name, version) click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 62
def format_constraint(name, version)
  if version && version != DEFAULT_CONSTRAINT
    "#{name} (#{version})"
  else
    name
  end
end
get_binding() click to toggle source
# File lib/knife_cookbook_readme/readme.rb, line 70
def get_binding
  binding
end