chef_attrdoc 0.9.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,30 @@
+chef-attrdoc
+============
+[![Gem Version](https://badge.fury.io/rb/chef-attrdoc.png)](http://badge.fury.io/rb/chef-attrdoc)
+[![Code Climate](https://codeclimate.com/github/mapleoin/chef-attrdoc.png)](https://codeclimate.com/github/mapleoin/chef-attrdoc)
+
+Extract documentation from chef cookbooks' attributes files and output it to the cookbook's README.md file.
+
+
+`chef-attrdoc` groups attribute initialization lines together with the comments immediately above them. Any lines containing an attribute initialization which are not separated by an empty line are considered a group. The comment immediately above them is assumed to describe the group of attributes below. Groups of attribute initialization lines which are not immediately preceded by a comment line are ignored and will not show up in the output.
+
+chef-attrdoc currently ignores *TODO*, *XXX*, *NOTE* and *foodcritic* comments.
+
+### Usage:
+
+```
+# gem install chef-attrdoc
+# chef-attrdoc ~/cookbooks/mycookbook
+```
+
+`chef-attrdoc` will try to find an Attributes heading in the README.md file in that directory and replace its contents with the generated `attributes/default.rb` documentation.
+
+`chef-attrdoc` uses ruby's stdlib `ripper` module and so does not have any dependencies.
+
+### Examples
+
+Here are some example outputs from openstack chef cookbooks:
+
+[openstack-compute attributes file](https://github.com/stackforge/cookbook-openstack-compute/blob/aa42f5c09a445cde7267e4b4d00a6ce893aa481e/attributes/default.rb) - [output](https://gist.github.com/mapleoin/6886586)
+
+[openstack-identity attributes file](https://github.com/stackforge/cookbook-openstack-identity/blob/2e6b8b9c6788ae28fbc362c77c53a51c040b49a6/attributes/default.rb) - [output](https://gist.github.com/mapleoin/6886493)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/chef-attrdoc

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require 'chef_attrdoc'
+
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: chef_attrdoc.rb [DIR] [options]\n"
+  opts.banner << "DIR - cookbook directory - defaults to the current directory\n\n"
+
+  options[:readme] = "README.md"
+  opts.on("-r", "--readme README",
+    "Readme file name; defaults to ./README.md; must be Markdown") do |readme|
+    options[:readme] = readme
+  end
+
+  opts.on("-s", "--stdout",
+    "Write output to stdout instead of the cookbook's README file") do |stdout|
+    options[:stdout] = stdout
+  end
+
+  opts.on_tail("-d", "--debug", "Show tracebacks on errors") do |debug|
+    options[:debug] = debug
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+file_path = ["attributes", "default.rb"]
+unless ARGV.empty?
+  file_path.unshift ARGV[0]
+  unless options[:stdout]
+    options[:readme] = File.join(ARGV[0], options[:readme])
+  end
+end
+file_path = File.join file_path
+
+begin
+  contents = IO.read(file_path)
+rescue Exception => e
+  puts e.message
+  exit
+end
+
+begin
+  attrs = ChefAttrdoc::AttributesFile.new contents
+  if options[:stdout]
+    puts attrs.to_s
+  else
+    attrs.to_readme options[:readme]
+  end
+rescue Exception => e
+  if options[:debug]
+    raise
+  else
+    puts e.message
+  end
+end

data/chef_attrdoc.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef_attrdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef_attrdoc"
+  spec.version       = ChefAttrdoc::VERSION
+  spec.authors       = ["Ionuț Arțăriși"]
+  spec.email         = ["iartarisi@suse.cz"]
+  spec.description   = %q{Generate README.md docs from chef cookbook attributesf file}
+  spec.summary       = %q{Generate README.md docs from chef cookbook attributesf file}
+  spec.homepage      = "https://github.com/mapleoin/chef-attrdoc"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/lib/chef_attrdoc/version.rb

@@ -0,0 +1,3 @@
+module ChefAttrdoc
+  VERSION = "0.9.0"
+end

data/lib/chef_attrdoc.rb

@@ -0,0 +1,161 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2013, 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 'ripper'
+
+module ChefAttrdoc
+  class AttributesFile
+
+    attr_reader :groups
+
+    def initialize(content)
+      @lexed = Ripper.lex(content)
+      @groups = []
+      @comment = false
+      @code = []
+      @newline = false
+
+      self.parse
+    end
+
+    def end_group
+      if @comment
+        @groups << [@code.join, @comment]
+      end
+      new_group
+    end
+
+    def new_group
+      @comment = false
+      @code = []
+      @newline = false
+    end
+
+    def parse
+      @lexed.each do |(lineno, column), token, content|
+        case token
+        # Ignored newlines occur when a newline is encountered, but
+        # the statement that was expressed on that line was not
+        # completed on that line.
+        when :on_ignored_nl
+          # end a group if we've reached an empty line after a comment
+          if @comment && @newline
+            end_group
+          else
+            @newline = true
+            @code << content
+          end
+        # This is the first thing that exists on a new line–NOT the last!
+        when :on_nl
+          @newline = true
+          @code << content
+        when :on_comment
+          if ignored_comments(content)
+            # inline comments
+            # go back to the existing code and remove the trailing
+            # whitespace, but give it the newline which the lexer
+            # considers part of the comment
+            if !@code.empty?
+              @code[-1].strip!
+              @code << "\n"
+            end
+
+            next
+          end
+
+          if @comment
+            # After the code has started, leave the inline comments
+            # where we found them, but ignore the ones below the
+            # code. Those are usually garbage. We do this by ending the
+            # current group when we encounter them.
+            if !@code.empty? && @newline
+              end_group
+              @comment = ''
+            end
+            # Since we can only have one comment per block (which we put
+            # at the top, before the code), keep appending to that
+            # until the code starts.
+            if @code.empty?
+              @comment << content
+            else
+              # inline comments
+              @code << content
+            end
+          elsif column == 0
+            @comment = content
+            @code = []
+          end
+
+          @newline = false
+        else
+          @code << content
+          @newline = false
+        end
+      end
+      # when there are no newlines at the end of the file, we have to close
+      # the code block manually
+      unless @code.empty?
+        end_group
+      end
+    end
+
+    def to_s
+      strings = []
+      # ignore the starting comments in a file, these are usually
+      # shebangs, copyright statements, encoding declarations etc.
+      @groups = @groups.drop_while{|code, doc| /\A[[:space:]]*\z/.match code}
+
+      @groups.each do |code, doc|
+        strings << doc.gsub(/^#[[:blank:]]*/, '')
+        strings << "\n"
+        unless /\A[[:space:]]*\z/.match code
+          strings << "```ruby\n"
+          strings << code
+          strings << "```\n\n"
+        end
+      end
+      strings.join
+    end
+
+    def to_readme(readme)
+      File.open(readme, File::RDWR) do |f|
+        # XXX find a cleaner way and do this in one step
+        content = f.read
+        if content =~ /\nAttributes\s*=+\s*\n/
+          updated = content.gsub(/(.*\nAttributes\s*=+\s*\n)(.+?)(\n\w+\s*\n=+.*)/m,
+            '\1CHEF_ATTRDOC_UPDATING_TEMPLATE\3')
+        elsif content =~ /\n[#]+\s*Attributes\s*\n/
+          updated = content.gsub(/(?<before>.*\n(?<header>[#]+)\s*Attributes\s*\n)(.+?)(?<after>\n\k<header>\s*\w+\s*\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', self.to_s
+        f.rewind
+        f.write(updated)
+        f.flush
+        f.truncate(f.pos)
+      end
+    end
+  end
+end
+
+def ignored_comments(content)
+  (/^#\s+\:pragma\-foodcritic\: .*$/ =~ content ||
+    /^#\s?(TODO|XXX|NOTE).*$/ =~ content)
+end

data/spec/chef_attrdoc_spec.rb

@@ -0,0 +1,245 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2013-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 ChefAttrdoc do
+  ["TODO bar", "XXX foo bar", "NOTE(me) nasty bug",
+    ":pragma-foodcritic: ~FC024 - won't fix this"].each do |comm|
+    it "ignores \"#{comm}\" comment" do
+      text = <<END
+# #{comm}
+# good comment
+default[good] = 'comment'
+END
+      ca = ChefAttrdoc::AttributesFile.new(text)
+      expect(ca.groups).to eq([["default[good] = 'comment'\n", "# good comment\n"]])
+    end
+  end
+
+  it "groups comments and several lines of code together" do
+    text = <<END
+# first block
+default[foo] = 'bar'
+default[bar] = 'baz'
+
+# second block
+node.set[baz] = 'qux'
+node.set[foo] = 'qux'
+node.set[bar = 'qux'
+END
+    ca = ChefAttrdoc::AttributesFile.new(text)
+    expect(ca.groups).to eq([
+        ["default[foo] = 'bar'\ndefault[bar] = 'baz'\n",
+          "# first block\n"],
+        ["node.set[baz] = 'qux'\nnode.set[foo] = 'qux'\nnode.set[bar = 'qux'\n",
+          "# second block\n"]])
+  end
+
+  it "ignores code without comments" do
+    text = <<END
+# first block
+default[foo] = 'bar'
+default[bar] = 'baz'
+
+default[ignored] = false
+
+# second block
+node.set[baz] = 'qux'
+END
+    ca = ChefAttrdoc::AttributesFile.new(text)
+    expect(ca.groups).to eq([
+        ["default[foo] = 'bar'\ndefault[bar] = 'baz'\n", "# first block\n"],
+        ["node.set[baz] = 'qux'\n", "# second block\n"]])
+  end
+
+  it "ignores the first comments in a file" do
+    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
+#!/she/bang
+
+# Copyright
+# foo
+
+# this is important
+default[foo] = 'bar'
+INPUT
+
+    expect(ca.to_s).to eq(<<-OUTPUT)
+this is important
+
+```ruby
+default[foo] = 'bar'
+```
+
+OUTPUT
+  end
+
+  it "handles platform group with lots of branches and hashes" do
+    text = <<END
+# platform specific attributes
+case platform
+when "fedora", "redhat", "centos"
+  default["openstack"]["identity"]["user"] = "keystone"
+  default["openstack"]["identity"]["group"] = "keystone"
+  default["openstack"]["identity"]["platform"] = {
+    "memcache_python_packages" => [ "python-memcached" ],
+    "keystone_packages" => [ "openstack-keystone" ],
+    "keystone_process_name" => "keystone-all",
+    "package_options" => ""
+  }
+when "suse"
+  default["openstack"]["identity"]["user"] = "openstack-keystone"
+  default["openstack"]["identity"]["platform"] = {
+    "mysql_python_packages" => [ "python-mysql" ],
+    "memcache_python_packages" => [ "python-python-memcached" ],
+    "keystone_process_name" => "keystone-all",
+    "package_options" => ""
+  }
+END
+    ca = ChefAttrdoc::AttributesFile.new(text)
+    expect(ca.to_s).to eq(<<-END)
+platform specific attributes
+
+```ruby
+case platform
+when "fedora", "redhat", "centos"
+  default["openstack"]["identity"]["user"] = "keystone"
+  default["openstack"]["identity"]["group"] = "keystone"
+  default["openstack"]["identity"]["platform"] = {
+    "memcache_python_packages" => [ "python-memcached" ],
+    "keystone_packages" => [ "openstack-keystone" ],
+    "keystone_process_name" => "keystone-all",
+    "package_options" => ""
+  }
+when "suse"
+  default["openstack"]["identity"]["user"] = "openstack-keystone"
+  default["openstack"]["identity"]["platform"] = {
+    "mysql_python_packages" => [ "python-mysql" ],
+    "memcache_python_packages" => [ "python-python-memcached" ],
+    "keystone_process_name" => "keystone-all",
+    "package_options" => ""
+  }
+```
+
+END
+  end
+
+  it "handles comments over several lines which include blank lines" do
+    text = <<END
+# my comment
+#
+# continued comment
+#
+default["some"]["actual"]["code"] = 42
+END
+    ca = ChefAttrdoc::AttributesFile.new(text)
+    expect(ca.to_s).to eq(<<-END)
+my comment
+
+continued comment
+
+
+```ruby
+default["some"]["actual"]["code"] = 42
+```
+
+END
+  end
+
+  it "keeps good inline comments" do
+    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
+# my comment
+default["ignored"]["thing"] = 33  # a useful inline comment
+default["foo"] = "bar"
+INPUT
+    expect(ca.to_s).to eq(<<-OUTPUT)
+my comment
+
+```ruby
+default["ignored"]["thing"] = 33  # a useful inline comment
+default["foo"] = "bar"
+```
+
+OUTPUT
+  end
+
+  it "discards ignored inline comments" do
+    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
+# my comment
+default["ignored"]["thing"] = 33  # TODO(tommy) an ignored inline comment
+default["foo"] = "bar"
+INPUT
+    expect(ca.to_s).to eq(<<-OUTPUT)
+my comment
+
+```ruby
+default["ignored"]["thing"] = 33
+default["foo"] = "bar"
+```
+
+OUTPUT
+  end
+
+  it "ignores inline comments on code with no leading comments" do
+    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
+# something good
+foo = bar
+
+default['something'] = 'bad' # foo
+default['just']['more'] = 'code'
+INPUT
+    expect(ca.to_s).to eq(<<-OUTPUT)
+something good
+
+```ruby
+foo = bar
+```
+
+OUTPUT
+  end
+
+  it "uses isolated comment blocks" do
+    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
+# foo bar
+foo = bar
+
+# comment we want to keep
+# still good
+
+# foo bar
+foo = bar
+INPUT
+    expect(ca.to_s).to eq(<<-OUTPUT)
+foo bar
+
+```ruby
+foo = bar
+```
+
+comment we want to keep
+still good
+
+foo bar
+
+```ruby
+foo = bar
+```
+
+OUTPUT
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chef_attrdoc
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Ionuț Arțăriși
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-26 00:00:00.000000000 Z
+dependencies: []
+description: Generate README.md docs from chef cookbook attributesf file
+email:
+- iartarisi@suse.cz
+executables:
+- chef-attrdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- LICENSE
+- README.md
+- Rakefile
+- bin/chef-attrdoc
+- chef_attrdoc.gemspec
+- lib/chef_attrdoc.rb
+- lib/chef_attrdoc/version.rb
+- spec/chef_attrdoc_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mapleoin/chef-attrdoc
+licenses:
+- Apache
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Generate README.md docs from chef cookbook attributesf file
+test_files:
+- spec/chef_attrdoc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: