qddrud 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55ced2a77a6c4babdbd328d60236760600393f4e
+  data.tar.gz: 9d01f03fe09fd48632582807ec6df77b9f2eed7b
+SHA512:
+  metadata.gz: 889b9929238f1fd36bcf4080f4e9b5212189c59eec0a1eae3288fb606ce2e05aea81914dbedecefd323201a9e90fc9bf1a68298e2a77b1ce44b6744dbad94a9d
+  data.tar.gz: b80a4411db211978bcc958d22b197686f4966144a96bc42da3c9bee64203a780117f44fd3c9d3f68aa7318e6e09bfa8628db654900e9a9f6d91a64ce88605fbe

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+html

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile

data/Gemfile

@@ -0,0 +1,4 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 NewMedia Denver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Drud
+
+Evaluates an opscode chef cookbook's [metadata](https://github.com/cyberswat){http://docs.opscode.com/essentials_cookbook_metadata.html} and [github](https://github.com/) history to generate a README.md file. The README.md is placed in the root level of the cookbook. This forces cookbook developers to properly use metadata to document their cookbooks efficiently.  Additionally, it provides proper attribution for all committers in the project with links back to the contributors github profile. It is written to take advantage of cookbooks that properly utilize both Rake tasks and metadata.
+
+You can see this in use in our cookbooks. Our reference cookbook is https://github.com/newmediadenver/nmd-skeletor
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drud'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drud
+
+## Usage
+
+Here's an example rake task that could be placed in your cookbooks Rake file.
+
+    desc 'Generate the Readme.md file.'
+    task :readme do
+      drud = Drud::Readme.new(File.dirname(__FILE__))
+      drud.render
+    end
+
+If you set the environment variable `DRUD_OAUTH` to a
+[Github Applicaiton access tokent](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
+that token will be used to authenticate the Octokit client and allow access to private repos.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/drud/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+desc "Build the Gem"
+task :build do  
+  sh 'gem build qddrud.gemspec'
+end
+
+desc "Release the Gem"
+task :release => :build do  
+  sh "gem push qddrud-0.1.0.gem"
+end  
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('lib/*.rb', 'lib/drud/*.rb')
+end
+
+desc 'Run rspec tests'
+RSpec::Core::RakeTask.new(:spec)

data/lib/qddrud.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require 'qddrud/version'
+require 'qddrud/readme'

data/lib/qddrud/readme.rb

@@ -0,0 +1,95 @@
+require 'chef/cookbook/metadata'
+require 'erb'
+require 'ostruct'
+
+module Qddrud
+  # Constructs a new ERB object for rendering a Readme.md file.
+  class ReadmeTemplate < OpenStruct
+    # Desribe the behaviour of the method
+    #
+    # ==== Attributes
+    #
+    # * +:template+ - The template to render against.
+    #
+    # ==== Examples
+    # Assuming this is the content of template.erb:
+    #    My metadata is <%= metadata %>
+    # You would render it with the following:
+    #    markdown = ReadmeTemplate.new(metadata: @metadata)
+    #    markdown.render(File.read('template.erb'))
+    def render(template)
+      ERB.new(template).result(binding)
+    end
+  end
+  # Evaluates an opscode chef cookbook's
+  # {metadata}[http://docs.opscode.com/essentials_cookbook_metadata.html] and
+  # {github}[https://github.com/] history to generate a README.md file. The
+  # README.rb is placed in the root level of the cookbook. This forces cookbook
+  # developers to properly use metadata to document their cookbooks
+  # efficiently.  Additionally, it provides proper attribution for all
+  # committers in the project with links back to the contributors github
+  # profile. It is written to take advantage of cookbooks that properly utilize
+  # both Rake tasks and metadata.
+  class Readme
+    # Hash map of all site cookbooks including metadata
+    attr_accessor :cookbooks
+
+    # Path to the site-cookbooks
+    attr_accessor :path
+  
+    # Initialize a new instance of Drud::Readme
+    #
+    # ==== Attributes
+    #
+    # * +:path+ - The local path of the site cookbooks
+    #
+    # ==== Examples
+    # This can be placed in a convenient location, such as a Rake task inside
+    # the cookbook. When the render method is called, it will overwrite the
+    # cookbooks README.md
+    #    readme = Drud::Readme.new(File.dirname(__FILE__))
+    #    readme.render
+    def initialize(path)
+      @path = File.expand_path(path)
+      @cookbooks = load_cookbooks
+    end
+
+    # Renders the README.md file and saves it in the cookbooks path.
+    def render
+      markdown = ReadmeTemplate.new(
+        metadata: @metadata, tasks: @tasks, credit: @credit
+      )
+      template_path = File.join(
+        File.dirname(File.expand_path(__FILE__)),
+        '../../templates/readme.md.erb'
+      )
+      readme = markdown.render(File.read(template_path))
+      File.open("#{@cookbook}/README.md", 'w') { |file| file.write(readme) }
+    end
+
+    private
+    # Generates a hash of all site cookbook metadata by cookbook folder name
+    def load_cookbooks # :doc:
+      _cookbooks = Hash.new
+
+      Dir.glob(File.join(@path, '*/*.rb')).each do |cb_metadata|
+        cb_path = File.dirname(cb_metadata)
+        cb_name = File.basename(cb_path)
+        _cookbooks[cb_name] = [
+          'path' => cb_path,
+          'metadata' => load_metadata(cb_metadata)
+        ]
+      end
+
+      _cookbooks
+    end
+
+    # Reads the cookbooks metadata and instantiates an instance of
+    # Chef::Cookbook::Metadata
+    def load_metadata(cb_metadata) # :doc:
+      metadata = Chef::Cookbook::Metadata.new
+      metadata.from_file(cb_metadata)
+      metadata
+    end
+  end
+end

data/lib/qddrud/version.rb

@@ -0,0 +1,6 @@
+# The Drud module contains general functionality written to help our developers
+# be more efficient.
+module Qddrud
+  # The drud version number.
+  VERSION = '0.1.1'
+end

data/qddrud.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qddrud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qddrud'
+  spec.version       = Qddrud::VERSION
+  spec.authors       = ['Jon Bogaty']
+  spec.email         = ['jon@jonbogaty.com']
+  spec.required_ruby_version = '>= 2.1.2'
+  spec.summary       = 'Generates the README.md file for Chef cookbooks.'
+  desc = 'Quick and dirty Drud local-mode only supporting grokking of an entire site-cookbook directory worth of metadata'
+
+  spec.description   = desc
+  spec.homepage      = 'https://github.com/newmediadenver/qddrud'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'chef', '~> 12.4', '>= 12.4.1'
+end

data/spec/drud_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Drud do
+  it 'does stuff' do
+    pending # no code yet
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'vendor/'
+end
+require 'drud'

data/templates/readme.md.erb

@@ -0,0 +1,37 @@
+<%= metadata.maintainer %>'s <%= metadata.name %> cookbook
+=============================
+
+<%= metadata.name %> (<%= metadata.version %>) <%= metadata.description %>
+
+Requirements
+------------
+
+### Platforms
+<% metadata.platforms.each do |os, version| %>
+`<%= os %> <%= version %>`
+<% end %>
+### Dependencies
+<% metadata.dependencies.each do |os, version| %>
+`<%= os %> <%= version %>`
+<% end %>
+
+Attributes
+----------
+<% metadata.attributes.each do |name, values| %>
+    <%= name %>
+      calculated: <%= values['calculated'] %>
+      choice: <%= values['choice'].inspect %>
+      default: <%= values['default'] %>
+      description: <%= values['description'] %>
+      display_name: <%= values['display_name'] %>
+      type: <%= values['type'] %>
+      recipes: <%= values['recipes'].inspect %>
+      required: <%= values['required'] %>
+<% end %>
+
+Recipes
+-------
+<% metadata.recipes.each do |name, desc| %>
+    <%= name %>
+      <%= desc %>
+<% end %>

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: qddrud
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jon Bogaty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.4.1
+description: Quick and dirty Drud local-mode only supporting grokking of an entire
+  site-cookbook directory worth of metadata
+email:
+- jon@jonbogaty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qddrud.rb
+- lib/qddrud/readme.rb
+- lib/qddrud/version.rb
+- qddrud.gemspec
+- spec/drud_spec.rb
+- spec/spec_helper.rb
+- templates/readme.md.erb
+homepage: https://github.com/newmediadenver/qddrud
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Generates the README.md file for Chef cookbooks.
+test_files:
+- spec/drud_spec.rb
+- spec/spec_helper.rb