chef_attrdoc 0.9.2 → 1.0.0.pre

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+before_script:
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+# A sample Gemfile
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    chef_attrdoc (0.9.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chef_attrdoc!
+  rake
+  rspec

data/README.md

@@ -1,29 +1,74 @@
 chef_attrdoc
 ============
 [![Gem Version](https://badge.fury.io/rb/chef_attrdoc.png)](http://badge.fury.io/rb/chef_attrdoc)
+[![Build Status](https://travis-ci.org/mapleoin/chef_attrdoc.svg?branch=master)](https://travis-ci.org/mapleoin/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
+```bash
+$ 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` will try to find an Attributes heading in the README.md file in that directory and replace its contents with the generated attributes documentation. The attributes documentation is compiled from all the files in the cookbook's `attributes/` directory. All the files ending in `.rb` in that directory are considered to be attributes files.
 
 `chef_attrdoc` uses ruby's stdlib `ripper` module and so does not have any dependencies.
 
+`chef_attrdoc` currently requires `ruby >= 1.9`.
+
 ### Examples
 
-Here are some example outputs from openstack chef cookbooks:
+```bash
+$ cat cookbook-example/attributes/default.rb
+```
+    # Copyright 1970, nobody
+
+    # this is the attribute
+    default['some']['attribute'] = 'foo'
+
+    default['this']['will']['be'] = 'ignored'
+
+    # NOTE code blocks without a comment are ignored as are those beginning
+    # NOTE with 'NOTE', 'XXX', 'TODO' or foodcritic comments
+
+    # a longer block of code
+    case something
+    when 'foo'
+      default['some']['foo'] = 'baz'
+    else
+      default['some']['foo'] = 'qux'
+    end
+```bash
+$ chef_attrdoc cookbook-example --stdout
+```
+    ```
+    ## 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
+    ```
+
+Here are some longer examples 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)
 

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.rspec_opts = [].tap do |a|
+    a.push('--color')
+    a.push('--format progress')
+  end.join(' ')
+end
+
+task :default => [:test]

data/bin/chef_attrdoc

@@ -31,28 +31,20 @@ opt_parser = OptionParser.new do |opts|
   end
 end.parse!
 
-file_path = ["attributes", "default.rb"]
+dir_path = ["attributes"]
 unless ARGV.empty?
-  file_path.unshift ARGV[0]
+  dir_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
+  attrs = ChefAttrdoc.process_attributes dir_path
   if options[:stdout]
-    puts attrs.to_s
+    puts attrs
   else
-    attrs.to_readme options[:readme]
+    ChefAttrdoc.write_readme options[:readme], attrs
   end
 rescue Exception => e
   if options[:debug]

data/chef_attrdoc.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   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"]
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/chef_attrdoc/version.rb

@@ -1,3 +1,3 @@
 module ChefAttrdoc
-  VERSION = "0.9.2"
+  VERSION = "1.0.0.pre"
 end

data/lib/chef_attrdoc.rb

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright 2013, Ionuț Arțăriși <ionut@artarisi.eu>
+# 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.
@@ -130,28 +130,65 @@ module ChefAttrdoc
       end
       strings.join
     end
+  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
+  # open the :readme: Markdown file and replace the 'Attributes' section
+  # with the contents of :parsed:
+  def self.write_readme(readme, parsed)
+    File.open(readme, File::RDWR) do |f|
+      # 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=+.*)/,
+          '\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,
+          '\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
+      f.rewind
+      f.write(updated)
+      f.flush
+      f.truncate(f.pos)
+    end
+  end
 
-        updated.sub! 'CHEF_ATTRDOC_UPDATING_TEMPLATE', self.to_s
-        f.rewind
-        f.write(updated)
-        f.flush
-        f.truncate(f.pos)
+  # return a list of [filename, file-contents] for each ruby file in :dir:
+  def self.attrs_contents(dir)
+    files_contents = []
+    filenames = Dir.glob(File.join(dir, '*.rb')).sort
+
+    filenames.each do |f|
+      begin
+        files_contents << [File.basename(f), IO.read(f)]
+      rescue Exception => e
+        abort e.message
       end
     end
+
+    files_contents
+  end
+
+  # takes a directory of attributes files and returns a string with
+  # Markdown content with the output of processing all the attributes
+  def self.process_attributes(dir)
+    files_contents = ChefAttrdoc.attrs_contents dir
+
+    output = []
+    files_contents.each do |filename, contents|
+      attrs = ChefAttrdoc::AttributesFile.new contents
+      output << "## #{filename}\n\n#{attrs}"
+    end
+
+    output.join("\n")
   end
 end
 

data/spec/attributes_file_spec.rb

@@ -0,0 +1,276 @@
+# -*- 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 ChefAttrdoc::AttributesFile 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.to_s).to eq(<<-OUTPUT)
+good comment
+
+```ruby
+default[good] = 'comment'
+```
+
+OUTPUT
+    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.to_s).to eq(<<-OUTPUT)
+first block
+
+```ruby
+default[foo] = 'bar'
+default[bar] = 'baz'
+```
+
+second block
+
+```ruby
+node.set[baz] = 'qux'
+node.set[foo] = 'qux'
+node.set[bar] = 'qux'
+```
+
+OUTPUT
+  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.to_s).to eq(<<-OUTPUT)
+first block
+
+```ruby
+default[foo] = 'bar'
+default[bar] = 'baz'
+```
+
+second block
+
+```ruby
+node.set[baz] = 'qux'
+```
+
+OUTPUT
+  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/chef_attrdoc_spec.rb

@@ -19,227 +19,96 @@ 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
+  describe '#write_readme' do
+    context 'using Attributes\n========== syntax' do
+      it 'handles an Attributes section followed by a multiword header' do
+        readme = double('file').as_null_object
+        allow(readme).to receive(:read).and_return(<<-README)
 
-  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
+Attributes
+==========
+my attributes
 
-  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
+are nice
 
-  it "ignores the first comments in a file" do
-    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
-#!/she/bang
+Another header
+==============
 
-# Copyright
-# foo
+doc we won't touch
 
-# this is important
-default[foo] = 'bar'
-INPUT
+README
+        allow(::File).to receive(:open).and_yield(readme)
+        expect(readme).to receive(:write).with(<<-README)
 
-    expect(ca.to_s).to eq(<<-OUTPUT)
-this is important
+Attributes
+==========
 
-```ruby
-default[foo] = 'bar'
-```
+foo
 
-OUTPUT
-  end
+Another header
+==============
 
-  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
+doc we won't touch
 
-  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
+README
+        ChefAttrdoc.write_readme('filename', "foo\n")
+      end
+    end
+    context 'using ### Attributes syntax' do
+      it 'handles an Attributes section followed by a multiword header' do
+        readme = double('file').as_null_object
+        allow(readme).to receive(:read).and_return(<<-README)
 
-continued comment
+## Attributes
 
+my attributes
 
-```ruby
-default["some"]["actual"]["code"] = 42
-```
+are nice
 
-END
-  end
+## Another header
 
-  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
+doc we won't touch
+README
+        allow(::File).to receive(:open).and_yield(readme)
+        expect(readme).to receive(:write).with(<<-README)
 
-```ruby
-default["ignored"]["thing"] = 33  # a useful inline comment
-default["foo"] = "bar"
-```
+## Attributes
 
-OUTPUT
-  end
+foo
 
-  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
+## Another header
 
-```ruby
-default["ignored"]["thing"] = 33
-default["foo"] = "bar"
-```
-
-OUTPUT
+doc we won't touch
+README
+        ChefAttrdoc.write_readme('filename', "foo\n")
+      end
+    end
   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
+  describe '#attrs_contents' do
+    it 'reads the files in the directory and returns their contents' do
+      expect(ChefAttrdoc.attrs_contents(['spec', 'fixtures']))
+        .to eq([["file1.rb", "foo\n"], ["file3.rb", "baz\n"]])
+    end
   end
 
-  it "uses isolated comment blocks" do
-    ca = ChefAttrdoc::AttributesFile.new(<<-INPUT)
-# foo bar
-foo = bar
-
-# comment we want to keep
-# still good
+  describe '#process_attributes' do
+    it 'reads the files in the directory and processes them' do
+      allow(ChefAttrdoc).to receive(:attrs_contents).with('foodir')
+        .and_return([["file1.rb", "foo\n"], ["file3.rb", "baz\n"]])
 
-# foo bar
-foo = bar
-INPUT
-    expect(ca.to_s).to eq(<<-OUTPUT)
-foo bar
+      allow_any_instance_of(ChefAttrdoc::AttributesFile).to receive(:to_s)
+        .and_return("qux\n")
+      expect(ChefAttrdoc.process_attributes('foodir'))
+        .to eq(<<-OUTPUT)
+## file1.rb
 
-```ruby
-foo = bar
-```
+qux
 
-comment we want to keep
-still good
-
-foo bar
-
-```ruby
-foo = bar
-```
+## file3.rb
 
+qux
 OUTPUT
+    end
   end
 end

data/spec/fixtures/cookbook-example/README.md

@@ -0,0 +1,13 @@
+chef_attrdoc example README
+===========================
+
+This is just an example
+
+Attributes
+==========
+nothing here now
+
+
+License
+=======
+This is usually important.

data/spec/fixtures/cookbook-example/attributes/default.rb

@@ -0,0 +1,17 @@
+# Copyright 1970, nobody
+
+# this is the attribute
+default['some']['attribute'] = 'foo'
+
+default['this']['will']['be'] = 'ignored'
+
+# NOTE code blocks without a comment are ignored as are those beginning
+# NOTE with 'NOTE', 'XXX', 'TODO' or foodcritic comments
+
+# a longer block of code
+case something
+when 'foo'
+  default['some']['foo'] = 'baz'
+else
+  default['some']['foo'] = 'qux'
+end

data/spec/fixtures/file1.rb

@@ -0,0 +1 @@
+foo

data/spec/fixtures/file2

@@ -0,0 +1 @@
+bar

data/spec/fixtures/file3.rb

@@ -0,0 +1 @@
+baz

data/spec/readme_example_spec.rb

@@ -0,0 +1,45 @@
+# -*- 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

metadata

@@ -1,16 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: chef_attrdoc
 version: !ruby/object:Gem::Version
-  version: 0.9.2
-  prerelease: 
+  version: 1.0.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Ionuț Arțăriși
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
-dependencies: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate README.md docs from Chef cookbook attributes files
 email:
 - ionut@artarisi.eu
@@ -20,6 +52,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -27,7 +62,14 @@ files:
 - chef_attrdoc.gemspec
 - lib/chef_attrdoc.rb
 - lib/chef_attrdoc/version.rb
+- spec/attributes_file_spec.rb
 - spec/chef_attrdoc_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/spec_helper.rb
 homepage: https://github.com/mapleoin/chef_attrdoc
 licenses:
@@ -45,9 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -55,6 +97,13 @@ signing_key:
 specification_version: 3
 summary: Generate README.md docs from Chef cookbook attributes files
 test_files:
+- spec/attributes_file_spec.rb
 - spec/chef_attrdoc_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/spec_helper.rb
 has_rdoc: