knife-cookbook-readme 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a22fbf6290e37c8c038ef2df5c4d02f71de5d862
+  data.tar.gz: bc71a063b422222a8b1e54bedc82fef90dc44e4d
+SHA512:
+  metadata.gz: 23c18204dd65d728e9c972c05b1d7dee6fd46efbd8bd063bbb7e7472126f18fafaaea6df5c799913b3a4c62232c8a5a4f27df303afb6d496c20aea5e3b27989d
+  data.tar.gz: 7c5ceab3877c69dc5b9d66b9a4b54c20881aa7e99a6db182800b4f942995bb76ca2df404a0e75c6994d53e62017720489c77dfb882b00d92621dd4c80552d457

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+
+install: bundle install
+
+script: bundle exec rake spec
+
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+v0.1.3 (Sep 15 2013)
+--------------------
+
+* Add RSpec tests, including Rake task and Travis CI config.
+
+README updates:
+
+* Link to Opscode's metadata docs.
+* Say that knife-cookbook-doc is based on knife-cookbook-readme.
+* Add contributing guidelines.
+
 v0.1.2 (Jul 17 2013)
 --------------------
 

data/README.md

@@ -2,9 +2,7 @@ knife-cookbook-readme
 =====================
 
 This is a Knife plugin to generate a skeleton `README.md` file from a cookbook's
-`metadata.rb` file.
-
-The plugin helps to
+[metadata.rb](http://docs.opscode.com/essentials_cookbook_metadata.html) file.
 
 - create the first bits of documentation you can build upon
 - write documentation that is consistent among your or your team's cookbooks
@@ -55,7 +53,8 @@ Alternatives
 Here is a list of other documentation tools for Chef (sorted alphabetically):
 
 * [knife-cookbook-doc](https://github.com/realityforge/knife-cookbook-doc)
-  ([blog post](http://realityforge.org/code/2013/04/01/documenting-cookbooks.html))
+  (based on knife-cookbook-readme,
+  [blog post](http://realityforge.org/code/2013/04/01/documenting-cookbooks.html))
 * [yard-chef](https://github.com/rightscale/yard-chef)
 
 
@@ -75,6 +74,16 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 
+Contributing
+------------
+
+1. Fork it
+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 new Pull Request
+
+
 Contact
 -------
 

data/Rakefile

@@ -1,6 +1,11 @@
 require 'bundler/gem_tasks'
 require 'rake/clean'
-
-task :default => :build
+require 'rspec/core/rake_task'
 
 CLEAN.include 'pkg'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color --format documentation'
+end
+
+task :default => :spec

data/knife_cookbook_readme.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'erubis'
 
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.14'
 end

data/lib/knife_cookbook_readme/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookReadme
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/readme_model_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path("../../lib/knife_cookbook_readme/readme_model", __FILE__)
+require "erubis"
+
+module KnifeCookbookReadme
+  describe ReadmeModel do
+    it "generates title from cookbook name" do
+      cookbook_name = "cats"
+      metadata = double(:metadata, :name => cookbook_name)
+      model = ReadmeModel.new(metadata)
+      model.title.should == "Cats Cookbook"
+    end
+
+    it "generates description" do
+      description = double
+      metadata = double(:metadata, :description => description)
+      model = ReadmeModel.new(metadata)
+      model.description.should == description
+    end
+
+    it "generates recipes" do
+      recipes = double
+      metadata = double(:metadata, :recipes => recipes)
+      model = ReadmeModel.new(metadata)
+      model.recipes.should == recipes
+    end
+
+    it "generates cookbook attributes" do
+      attributes = {
+        "pets/cat/name" => {
+          "description" => "The name of your cat",
+          "default"     => "Kitty",
+        },
+        "pets/dog/name" => {
+          "description" => "The name of your dog",
+          "default"     => "Barf",
+        }
+      }
+      metadata = double(:metadata, :attributes => attributes)
+      model = ReadmeModel.new(metadata)
+      model.attributes.sort.should == [
+        ["node['pets']['cat']['name']", "The name of your cat", "Kitty"],
+        ["node['pets']['dog']['name']", "The name of your dog", "Barf"],
+      ]
+    end
+
+    context "supported platforms" do
+      let(:metadata) do
+        platforms = { "debian" => "= 7", "ubuntu" => ">= 10.04" }
+        double(:metadata, :platforms => platforms)
+      end
+
+      it "generates platforms with version constraints" do
+        constraints = true
+        model = ReadmeModel.new(metadata, constraints)
+        model.platforms.sort.should == ["Debian (= 7)", "Ubuntu (>= 10.04)"]
+      end
+
+      it "generates platforms without version constraints" do
+        constraints = false
+        model = ReadmeModel.new(metadata, constraints)
+        model.platforms.sort.should == ["Debian", "Ubuntu"]
+      end
+    end
+
+    context "cookbook dependencies" do
+      let(:metadata) do
+        dependencies = {
+          "cats" => "< 1.0",
+          "dogs" => ReadmeModel::DEFAULT_CONSTRAINT,
+        }
+        double(:metadata, :dependencies => dependencies)
+      end
+
+      it "generates dependencies with version constraints" do
+        constraints = true
+        model = ReadmeModel.new(metadata, constraints)
+        model.dependencies.sort.should == ["cats (< 1.0)", "dogs"]
+      end
+
+      it "generates dependencies without version constraints" do
+        constraints = false
+        model = ReadmeModel.new(metadata, constraints)
+        model.dependencies.sort.should == ["cats", "dogs"]
+      end
+    end
+
+    context "license and author" do
+      it "generates author from maintainer name" do
+        maintainer = double
+        metadata = double(:metadata, :maintainer => maintainer)
+        model = ReadmeModel.new(metadata)
+        model.author.should == maintainer
+      end
+
+      it "generates author email from maintainer email" do
+        maintainer_email = double
+        metadata = double(:metadata, :maintainer_email => maintainer_email)
+        model = ReadmeModel.new(metadata)
+        model.author_email.should == maintainer_email
+      end
+
+      it "generates copyright year from current year" do
+        time_now = Time.mktime(2013, 1, 1)
+        Time.stub(:now).and_return(time_now)
+        metadata = double
+        model = ReadmeModel.new(metadata)
+        model.copyright_year.should == time_now.year
+      end
+      
+      it "generates license name" do
+        license = double
+        metadata = double(:metadata, :license => license)
+        model = ReadmeModel.new(metadata)
+        model.license.should == license
+      end
+    end
+
+    # TODO: implement ReadmeModel#render
+    context "template rendering" do
+      it "can be rendered with erubis" do
+        metadata = double(:metadata,
+                          :name => "cats",
+                          :description => "Manages a herd of cats!")
+        model = ReadmeModel.new(metadata)
+        template = <<EOS
+<%= title %>
+<%= '=' * title.length %>
+
+<%= description %>
+EOS
+        eruby = Erubis::Eruby.new(template)
+        result = eruby.result(model.get_binding)
+        result.should == <<EOS
+Cats Cookbook
+=============
+
+Manages a herd of cats!
+EOS
+      end
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Mathias Lafeldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -54,11 +48,24 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
 description: Knife plugin to generate README.md from metadata.rb
 email:
 - mathias.lafeldt@gmail.com
@@ -67,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -76,36 +84,31 @@ files:
 - lib/chef/knife/cookbook_readme_from.rb
 - lib/knife_cookbook_readme/readme_model.rb
 - lib/knife_cookbook_readme/version.rb
+- spec/readme_model_spec.rb
 - template/README.md.erb
 homepage: http://mlafeldt.github.com/knife-cookbook-readme
 licenses:
 - Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -921780819663544875
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -921780819663544875
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Knife plugin to generate README.md from metadata.rb
-test_files: []
+test_files:
+- spec/readme_model_spec.rb