chef_attrdoc 1.0.3 → 1.1.0

data/.gitignore

@@ -1 +1,3 @@
-Gemfile.lock
+Gemfile.lock
+*.gem
+.bundle

data/ChangeLog

@@ -0,0 +1,2 @@
+1.1.0 - September 7, 2014
+  * added a --dry-run cli option

data/README.md

@@ -29,6 +29,8 @@ It's that simple. Only one command to run and `chef_attrdoc` will know how to do
 
 ### Examples
 
+These are the two input files from a chef cookbook:
+
 ```bash
 $ cat cookbook-example/attributes/default.rb
 ```
@@ -49,10 +51,39 @@ $ cat cookbook-example/attributes/default.rb
     else
       default['some']['foo'] = 'qux'
     end
+
+```bash
+$ cat cookbook-example/README.md
+```
+    chef_attrdoc example README
+    ===========================
+
+    This is just an example
+
+    Attributes
+    ==========
+    nothing here now
+
+
+    License
+    =======
+    This is usually important.
+
+This is the output README file after running:
+
 ```bash
-$ chef_attrdoc cookbook-example --stdout
+$ chef_attrdoc cookbook-example
+$ cat cookbook-example/README.md
 ```
     ```
+    chef_attrdoc example README
+    ===========================
+
+    This is just an example
+
+    Attributes
+    ==========
+
     ## default.rb
 
     this is the attribute
@@ -72,6 +103,12 @@ $ chef_attrdoc cookbook-example --stdout
     end
     ```
 
+
+    License
+    =======
+    This is usually important.
+    ```
+
 Here are some longer examples from openstack chef cookbooks:
 
 [openstack-identity attributes file](https://github.com/stackforge/cookbook-openstack-identity/blob/552488824aa720f08249bc4d19f5224e9382aa00/attributes/default.rb) - [output](https://gist.github.com/mapleoin/d211b29f68dd519a4878#attributes)

data/bin/chef_attrdoc

@@ -36,10 +36,17 @@ opt_parser = OptionParser.new do |opts|
   end
 
   opts.on("-s", "--stdout",
-    "Write output to stdout instead of the cookbook's README file") do |stdout|
+    "Write the attributes section to stdout instead of overwriting anything"
+    ) do |stdout|
     options[:stdout] = stdout
   end
 
+  opts.on("--dry-run",
+    "Output the changed README.md to stdout instead of overwriting anything"
+    ) do |dry_run|
+    options[:dry_run] = dry_run
+  end
+
   opts.on_tail("-d", "--debug", "Show tracebacks on errors") do |debug|
     options[:debug] = debug
   end
@@ -62,6 +69,8 @@ begin
   attrs = ChefAttrdoc.process_attributes dir_path
   if options[:stdout]
     puts attrs
+  elsif options[:dry_run]
+    puts ChefAttrdoc.write_readme options[:readme], attrs, true
   else
     ChefAttrdoc.write_readme options[:readme], attrs
   end

data/lib/chef_attrdoc.rb

@@ -133,8 +133,9 @@ module ChefAttrdoc
   end
 
   # open the :readme: Markdown file and replace the 'Attributes' section
-  # with the contents of :parsed:
-  def self.write_readme(readme, parsed)
+  # with the contents of :parsed: . If :dry_run: is `true`, the string
+  # will be returned instead of overwriting the :readme: file.
+  def self.write_readme(readme, parsed, dry_run=false)
     File.open(readme, File::RDWR) do |f|
       # TODO find a cleaner way and do this in one step
       content = f.read
@@ -156,10 +157,14 @@ module ChefAttrdoc
         # parts of the original README
         "\n" + parsed.gsub(/\\/, "\\\\\\"))
 
-      f.rewind
-      f.write(updated)
-      f.flush
-      f.truncate(f.pos)
+      if dry_run
+        return updated
+      else
+        f.rewind
+        f.write(updated)
+        f.flush
+        f.truncate(f.pos)
+      end
     end
   end
 

data/lib/chef_attrdoc/version.rb

@@ -1,3 +1,3 @@
 module ChefAttrdoc
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/spec/functional/readme_example_spec.rb

@@ -0,0 +1,133 @@
+# -*- 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.
+#
+
+require 'chef_attrdoc'
+
+describe 'This is the example from chef_attrdoc\'s README.md' do
+  it 'prints the right attributes section when used with --stdout' do
+    output = `ruby -Ilib bin/chef_attrdoc spec/fixtures/cookbook-example/ -s`
+    expect(output).to eq(<<-OUTPUT)
+## default.rb
+
+this is the attribute
+
+```ruby
+default['some']['attribute'] = 'foo'
+```
+
+a longer block of code
+
+```ruby
+case something
+when 'foo'
+  default['some']['foo'] = 'baz'
+else
+  default['some']['foo'] = 'qux'
+end
+```
+
+OUTPUT
+  end
+
+  it 'prints the right output when used with --dry-run' do
+    output = `ruby -Ilib bin/chef_attrdoc spec/fixtures/cookbook-example/ --dry-run`
+    expect(output).to eq(<<-OUTPUT)
+chef_attrdoc example README
+===========================
+
+This is just an example
+
+Attributes
+==========
+
+## default.rb
+
+this is the attribute
+
+```ruby
+default['some']['attribute'] = 'foo'
+```
+
+a longer block of code
+
+```ruby
+case something
+when 'foo'
+  default['some']['foo'] = 'baz'
+else
+  default['some']['foo'] = 'qux'
+end
+```
+
+
+License
+=======
+This is usually important.
+OUTPUT
+  end
+
+  describe 'tests which change the README.md fixture' do
+    let(:readme) { 'spec/fixtures/cookbook-example/README.md' }
+    before do
+      @backup = File.read(readme)
+    end
+
+    after do
+      File.open(readme, 'w') do |f|
+        f.write(@backup)
+      end
+    end
+
+    it 'changes the README file appropriately when invoked with no args' do
+      output = `ruby -Ilib bin/chef_attrdoc spec/fixtures/cookbook-example/`
+      expect(output).to be_empty
+      expect(File.read('spec/fixtures/cookbook-example/README.md')).to eq(<<-OUT)
+chef_attrdoc example README
+===========================
+
+This is just an example
+
+Attributes
+==========
+
+## default.rb
+
+this is the attribute
+
+```ruby
+default['some']['attribute'] = 'foo'
+```
+
+a longer block of code
+
+```ruby
+case something
+when 'foo'
+  default['some']['foo'] = 'baz'
+else
+  default['some']['foo'] = 'qux'
+end
+```
+
+
+License
+=======
+This is usually important.
+OUT
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef_attrdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -54,6 +54,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- ChangeLog
 - Gemfile
 - LICENSE
 - README.md
@@ -64,13 +65,13 @@ 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
 - spec/fixtures/file2
 - spec/fixtures/file3.rb
-- spec/readme_example_spec.rb
+- spec/functional/cli_spec.rb
+- spec/functional/readme_example_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mapleoin/chef_attrdoc
 licenses:
@@ -100,12 +101,12 @@ 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
 - spec/fixtures/file2
 - spec/fixtures/file3.rb
-- spec/readme_example_spec.rb
+- spec/functional/cli_spec.rb
+- spec/functional/readme_example_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/readme_example_spec.rb

@@ -1,45 +0,0 @@
-# -*- 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.
-#
-
-require 'chef_attrdoc'
-
-describe 'This is the example from chef_attrdoc\'s README.md' do
-  it 'has the a fixed output' do
-    output = `ruby -Ilib bin/chef_attrdoc spec/fixtures/cookbook-example/ -s`
-    expect(output).to eq(<<-OUTPUT)
-## default.rb
-
-this is the attribute
-
-```ruby
-default['some']['attribute'] = 'foo'
-```
-
-a longer block of code
-
-```ruby
-case something
-when 'foo'
-  default['some']['foo'] = 'baz'
-else
-  default['some']['foo'] = 'qux'
-end
-```
-
-OUTPUT
-  end
-end