chef_attrdoc 1.0.1 → 1.0.2

data/bin/chef_attrdoc

@@ -19,6 +19,7 @@
 require 'optparse'
 
 require 'chef_attrdoc'
+require 'chef_attrdoc/version'
 
 options = {}
 
@@ -26,6 +27,8 @@ opt_parser = OptionParser.new do |opts|
   opts.banner = "Usage: chef_attrdoc [DIR] [options]\n"
   opts.banner << "DIR - cookbook directory - defaults to the current directory\n"
 
+  opts.version = ChefAttrdoc::VERSION
+
   options[:readme] = "README.md"
   opts.on("-r", "--readme README",
     "Readme file name; defaults to ./README.md; must be Markdown") do |readme|

data/lib/chef_attrdoc/version.rb

@@ -1,3 +1,3 @@
 module ChefAttrdoc
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/chef_attrdoc.rb

@@ -139,21 +139,16 @@ module ChefAttrdoc
       # TODO find a cleaner way and do this in one step
       content = f.read
       if content =~ /\nAttributes\s*=+\s*\n/
-        updated = content.gsub(/(?<before>.*\nAttributes\s*=+\s*\n)(?m:.+?)(?<after>\n.+\s*\n=+.*)/,
+        updated = content.gsub(/(?<before>.*\nAttributes\s*=+\s*?\n)\n*(?m:.+?)(?<after>\n.+\s*\n=+.*)/,
           '\k<before>CHEF_ATTRDOC_UPDATING_TEMPLATE\k<after>')
-
-        # XXX hack because I couldn't figure out how to get another
-        # newline in between the <before> and the content
-        updated.sub!('CHEF_ATTRDOC_UPDATING_TEMPLATE',
-          "\nCHEF_ATTRDOC_UPDATING_TEMPLATE")
       elsif content =~ /\n\#+\s*Attributes\s*\n/
-        updated = content.gsub(/(?<before>.*\n\#+\s*Attributes\s*\n)(.+?)(?<after>\n\#+.*)/m,
+        updated = content.gsub(/(?<before>.*\n\#+\s*Attributes\s*?\n)\n*(.+?)(?<after>\n\#+.*)/m,
           '\k<before>CHEF_ATTRDOC_UPDATING_TEMPLATE\k<after>')
       else
         raise StandardError, "Could not find Attributes heading in #{readme}. Please make sure your README file has proper markdown formatting and includes an Attributes heading."
       end
 
-      updated.sub! 'CHEF_ATTRDOC_UPDATING_TEMPLATE', parsed
+      updated.sub! 'CHEF_ATTRDOC_UPDATING_TEMPLATE', "\n" + parsed
       f.rewind
       f.write(updated)
       f.flush

data/spec/chef_attrdoc_spec.rb

@@ -27,6 +27,42 @@ describe ChefAttrdoc do
 
 Attributes
 ==========
+my attributes
+
+are nice
+
+Another header
+==============
+
+doc we won't touch
+
+README
+        allow(::File).to receive(:open).and_yield(readme)
+        expect(readme).to receive(:write).with(<<-README)
+
+Attributes
+==========
+
+foo
+
+Another header
+==============
+
+doc we won't touch
+
+README
+        ChefAttrdoc.write_readme('filename', "foo\n")
+      end
+
+      it 'normalizes space after an Attributes section' do
+        readme = double('file').as_null_object
+        allow(readme).to receive(:read).and_return(<<-README)
+
+Attributes
+==========
+
+
+
 my attributes
 
 are nice
@@ -60,6 +96,35 @@ README
         allow(readme).to receive(:read).and_return(<<-README)
 
 ## Attributes
+my attributes
+
+are nice
+
+## Another header
+
+doc we won't touch
+README
+        allow(::File).to receive(:open).and_yield(readme)
+        expect(readme).to receive(:write).with(<<-README)
+
+## Attributes
+
+foo
+
+## Another header
+
+doc we won't touch
+README
+        ChefAttrdoc.write_readme('filename', "foo\n")
+      end
+
+      it 'normalizes space after an Attributes section' do
+        readme = double('file').as_null_object
+        allow(readme).to receive(:read).and_return(<<-README)
+
+## Attributes
+
+
 
 my attributes
 

data/spec/cli_spec.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2014, Ionuț Arțăriși <ionut@artarisi.eu>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+describe 'chef_attrdoc' do
+  it 'shows version' do
+    output = `ruby -Ilib bin/chef_attrdoc --version`
+    expect(output).to match(/chef_attrdoc \d+\.\d+\.\d+/)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef_attrdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -64,6 +64,7 @@ files:
 - lib/chef_attrdoc/version.rb
 - spec/attributes_file_spec.rb
 - spec/chef_attrdoc_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/cookbook-example/README.md
 - spec/fixtures/cookbook-example/attributes/default.rb
 - spec/fixtures/file1.rb
@@ -99,6 +100,7 @@ summary: Generate README.md docs from Chef cookbook attributes files
 test_files:
 - spec/attributes_file_spec.rb
 - spec/chef_attrdoc_spec.rb
+- spec/cli_spec.rb
 - spec/fixtures/cookbook-example/README.md
 - spec/fixtures/cookbook-example/attributes/default.rb
 - spec/fixtures/file1.rb