knife-cookbook-readme 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22fbf6290e37c8c038ef2df5c4d02f71de5d862
-  data.tar.gz: bc71a063b422222a8b1e54bedc82fef90dc44e4d
+  metadata.gz: 193805210062a991a89d12cd47566a7510fc3b07
+  data.tar.gz: 0bf71481d6c7d0d520dc6d3d6ab0d11a8b3ae695
 SHA512:
-  metadata.gz: 23c18204dd65d728e9c972c05b1d7dee6fd46efbd8bd063bbb7e7472126f18fafaaea6df5c799913b3a4c62232c8a5a4f27df303afb6d496c20aea5e3b27989d
-  data.tar.gz: 7c5ceab3877c69dc5b9d66b9a4b54c20881aa7e99a6db182800b4f942995bb76ca2df404a0e75c6994d53e62017720489c77dfb882b00d92621dd4c80552d457
+  metadata.gz: 985774423c5a13afd53b117896ed95569897ddec8cfa76f0fe47481cc781f91297732eed682ad489a04d21ce3a7910c21c23109edc33b8d434526e4065bc1680
+  data.tar.gz: 42a8cf5c5525e4d22a2a3e4b864282a49adffea4f3d37c4d64c41493f80b5f6e0cc8fb9cfb58266aad5b761bb2e57a67a8b3cdad72d478f41e61e2be0a87de65

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.2.0 (Sep 22 2013)
+--------------------
+
+* Split up logic into `Metadata`, `Readme`, and `Template` classes. Add specs.
+* Make `DEFAULT_CONSTRAINT` a module variable.
+
 v0.1.3 (Sep 15 2013)
 --------------------
 

data/lib/chef/knife/cookbook_readme_from.rb

@@ -4,9 +4,9 @@ require 'pathname'
 module KnifeCookbookReadme
   class CookbookReadmeFrom < Chef::Knife
     deps do
-      require 'chef/cookbook/metadata'
-      require 'erubis'
-      require 'knife_cookbook_readme/readme_model'
+      require 'knife_cookbook_readme/metadata'
+      require 'knife_cookbook_readme/readme'
+      require 'knife_cookbook_readme/template'
     end
 
     banner 'knife cookbook readme from FILE (options)'
@@ -26,18 +26,19 @@ module KnifeCookbookReadme
            :description => 'Set template file used to render README.md'
 
     def run
-      unless (metadata_file = name_args.first)
+      metadata_file = name_args.first
+      template_file = config[:template_file]
+      constraints   = config[:constraints]
+
+      unless metadata_file
         ui.fatal 'Please provide metadata.rb file as argument'
-        exit(1)
+        exit 1
       end
 
-      metadata = Chef::Cookbook::Metadata.new
-      metadata.from_file(metadata_file)
-
-      model = ReadmeModel.new(metadata, config[:constraints])
-      template = File.read(config[:template_file])
-      eruby = Erubis::Eruby.new(template)
-      result = eruby.result(model.get_binding)
+      metadata = Metadata.from_file(metadata_file)
+      template = File.read(template_file)
+      readme = Readme.new(metadata, constraints)
+      result = readme.render(template)
 
       ui.output(result)
     end

data/lib/knife_cookbook_readme/metadata.rb

@@ -0,0 +1,11 @@
+require "chef/cookbook/metadata"
+
+module KnifeCookbookReadme
+  class Metadata
+    def self.from_file(filename)
+      metadata = Chef::Cookbook::Metadata.new
+      metadata.from_file(filename)
+      metadata
+    end
+  end
+end

data/lib/knife_cookbook_readme/{readme_model.rb → readme.rb}

@@ -1,7 +1,7 @@
 module KnifeCookbookReadme
-  class ReadmeModel
-    DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
+  DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
 
+  class Readme
     def initialize(metadata, constraints=false)
       @metadata = metadata
       @constraints = constraints
@@ -54,8 +54,8 @@ module KnifeCookbookReadme
       @metadata.license
     end
 
-    def get_binding
-      binding
+    def render(template)
+      Template.render(template, get_binding)
     end
 
     private
@@ -67,5 +67,9 @@ module KnifeCookbookReadme
         name
       end
     end
+
+    def get_binding
+      binding
+    end
   end
 end

data/lib/knife_cookbook_readme/template.rb

@@ -0,0 +1,11 @@
+require "erubis"
+
+module KnifeCookbookReadme
+  class Template
+    def self.render(template, binding)
+      eruby = Erubis::Eruby.new(template)
+      output = eruby.result(binding)
+      output
+    end
+  end
+end

data/lib/knife_cookbook_readme/version.rb

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

data/spec/metadata_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../../lib/knife_cookbook_readme/metadata", __FILE__)
+
+module KnifeCookbookReadme
+  describe "Metadata.from_file" do
+    it "knows how to read metadata from metadata.rb" do
+      file = double
+      Chef::Cookbook::Metadata.any_instance.should_receive(:from_file).with(file)
+      Metadata.from_file(file)
+    end
+  end
+end

data/spec/{readme_model_spec.rb → readme_spec.rb}

@@ -1,27 +1,28 @@
-require File.expand_path("../../lib/knife_cookbook_readme/readme_model", __FILE__)
-require "erubis"
+require File.expand_path("../../lib/knife_cookbook_readme/readme", __FILE__)
+
+class Template; end
 
 module KnifeCookbookReadme
-  describe ReadmeModel do
+  describe Readme 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"
+      readme = Readme.new(metadata)
+      readme.title.should == "Cats Cookbook"
     end
 
     it "generates description" do
       description = double
       metadata = double(:metadata, :description => description)
-      model = ReadmeModel.new(metadata)
-      model.description.should == description
+      readme = Readme.new(metadata)
+      readme.description.should == description
     end
 
     it "generates recipes" do
       recipes = double
       metadata = double(:metadata, :recipes => recipes)
-      model = ReadmeModel.new(metadata)
-      model.recipes.should == recipes
+      readme = Readme.new(metadata)
+      readme.recipes.should == recipes
     end
 
     it "generates cookbook attributes" do
@@ -36,8 +37,8 @@ module KnifeCookbookReadme
         }
       }
       metadata = double(:metadata, :attributes => attributes)
-      model = ReadmeModel.new(metadata)
-      model.attributes.sort.should == [
+      readme = Readme.new(metadata)
+      readme.attributes.sort.should == [
         ["node['pets']['cat']['name']", "The name of your cat", "Kitty"],
         ["node['pets']['dog']['name']", "The name of your dog", "Barf"],
       ]
@@ -51,36 +52,33 @@ module KnifeCookbookReadme
 
       it "generates platforms with version constraints" do
         constraints = true
-        model = ReadmeModel.new(metadata, constraints)
-        model.platforms.sort.should == ["Debian (= 7)", "Ubuntu (>= 10.04)"]
+        readme = Readme.new(metadata, constraints)
+        readme.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"]
+        readme = Readme.new(metadata, constraints)
+        readme.platforms.sort.should == ["Debian", "Ubuntu"]
       end
     end
 
     context "cookbook dependencies" do
       let(:metadata) do
-        dependencies = {
-          "cats" => "< 1.0",
-          "dogs" => ReadmeModel::DEFAULT_CONSTRAINT,
-        }
+        dependencies = { "cats" => "< 1.0", "dogs" => 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"]
+        readme = Readme.new(metadata, constraints)
+        readme.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"]
+        readme = Readme.new(metadata, constraints)
+        readme.dependencies.sort.should == ["cats", "dogs"]
       end
     end
 
@@ -88,54 +86,40 @@ module KnifeCookbookReadme
       it "generates author from maintainer name" do
         maintainer = double
         metadata = double(:metadata, :maintainer => maintainer)
-        model = ReadmeModel.new(metadata)
-        model.author.should == maintainer
+        readme = Readme.new(metadata)
+        readme.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
+        readme = Readme.new(metadata)
+        readme.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
+        readme = Readme.new(metadata)
+        readme.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
+        readme = Readme.new(metadata)
+        readme.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
+    context "#render" do
+      it "knows how to render a README.md file" do
+        template = double
+        Template.should_receive(:render).with(template, kind_of(Binding))
+        metadata = double
+        readme = Readme.new(metadata)
+        readme.render(template)
       end
     end
   end

data/spec/template_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../../lib/knife_cookbook_readme/template", __FILE__)
+
+module KnifeCookbookReadme
+  describe "Template.render" do
+    it "renders ERB template" do
+      template = "Hello, <%= title %>."
+      binding = { :title => "Mr. President" }
+      output = Template.render(template, binding)
+      output.should == "Hello, Mr. President."
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mathias Lafeldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -82,9 +82,13 @@ files:
 - Rakefile
 - knife_cookbook_readme.gemspec
 - lib/chef/knife/cookbook_readme_from.rb
-- lib/knife_cookbook_readme/readme_model.rb
+- lib/knife_cookbook_readme/metadata.rb
+- lib/knife_cookbook_readme/readme.rb
+- lib/knife_cookbook_readme/template.rb
 - lib/knife_cookbook_readme/version.rb
-- spec/readme_model_spec.rb
+- spec/metadata_spec.rb
+- spec/readme_spec.rb
+- spec/template_spec.rb
 - template/README.md.erb
 homepage: http://mlafeldt.github.com/knife-cookbook-readme
 licenses:
@@ -111,4 +115,6 @@ signing_key:
 specification_version: 4
 summary: Knife plugin to generate README.md from metadata.rb
 test_files:
-- spec/readme_model_spec.rb
+- spec/metadata_spec.rb
+- spec/readme_spec.rb
+- spec/template_spec.rb