puppet-ghostbuster 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49c229d0aa6aae767948d12cad86f06a8afe5e66
-  data.tar.gz: 92ef9f461b7e676d33c0127113545d38a9de4415
+  metadata.gz: 54bed6f908a3bb9aaae26087248857c8390028b7
+  data.tar.gz: 3904dae59b8117dfd6233afaf73688ed232c2e6b
 SHA512:
-  metadata.gz: 8959c6a8b06e371120ffaddfdeb9ff2576998d3964bbcae991212102033d71e1ec3fa3375bd31067f27fc7062edc0f3bed07d6f0fbf5b4c80d055a147645185b
-  data.tar.gz: 37a00822a2869c26881a44bf88f0639c509635a39d1d1b74e233dec348d7afa878ddf4cfa4f18650dc24395a65d66145fbfbdf635902d977b2545117679db2d5
+  metadata.gz: 0b6a6044ce239fd2aef83b436994b5bff3bb85f5214c3e5537317fa853414c090b517d7e4eea2853df38acab5d5ca1fa6a881366f8817f8f9ff20dd4a9a2b394
+  data.tar.gz: 68abfdd84fd16af1b06a32c06b6173b90b9b50bf4024d26eb4aca4026d27cf5b75b17ed5bb1ca26b588a5896466678f3067a303eb94620f038dce084f68e4887

data/.travis.yml

@@ -1,6 +1,9 @@
+---
 language: ruby
 sudo: false
 cache: bundler
+script:
+  bundle exec rake spec
 rvm:
 - 2.1.5
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [0.5.0](https://rubygems.org/gems/puppet-ghostbuster/versions/0.5.0) (2016-05-10)
+[Full Changelog](https://github.com/camptocamp/puppet-ghostbuster/compare/0.4.5...0.5.0)
+
+**Implemented enhancements:**
+
+- Major Reimplementation. Delivered as puppet-lint plugins.
+
 ## [0.4.5](https://rubygems.org/gems/puppet-ghostbuster/versions/0.4.5) (2016-05-04)
 [Full Changelog](https://github.com/camptocamp/puppet-ghostbuster/compare/0.4.4...0.4.5)
 

data/README.md

@@ -17,82 +17,42 @@ This gems only support PuppetDB APi v4 (PuppetDB 3+)
 Usage
 -----
 
-If you want to read default options and private key from puppet configuration, this gem needs to have root (puppet) permissions.
-```
-sudo bundle exec puppet-ghostbuster
+```shell
+$ find . -type f -exec puppet-lint --only-checks ghostbuster_classes,ghostbuster_defines,ghostbuster_files,ghostbuster_templates {} \+
 ```
 
-You can add preconnect command with ``-p`` and server url with ``-s``.
+Environment variables
+---------------------
 
-``-h`` or ``--help`` for full options.
+### PUPPETDB_URL
 
-Example output
---------------
-```
-$ puppet-ghostbuster -s https://puppetdburl:8081 | jsonpp
-[
-  {
-    "title": "[GhostBuster] Class Foo::Install seems unused",
-    "body": "./modules/foo/manifests/install.pp"
-  },
-  {
-    "title": "[GhostBuster] Class Foo::Service seems unused",
-    "body": "./modules/foo/manifests/service.pp"
-  },
-  {
-    "title": "[GhostBuster] Class Foo seems unused",
-    "body": "./modules/foo/manifests/init.pp"
-  },
-  {
-    "title": "[GhostBuster] Define Bar:Baz seems unused",
-    "body": "./modules/bar/manifests/baz.pp"
-  },
-  {
-    "title": "[GhostBuster] Template modulename/foo.erb seems unused",
-    "body": "./modules/modulename/templates/foo.erb"
-  },
-  {
-    "title": "[GhostBuster] Template modulename/bar.erb seems unused",
-    "body": "./modules/modulename/templates/bar.erb"
-  },
-  {
-    "title": "[GhostBuster] Template modulename/baz.erb seems unused",
-    "body": "./modules/modulename/templates/baz.erb"
-  },
-  {
-    "title": "[GhostBuster] File foo/bar.txt seems unused",
-    "body": "./modules/foo/files/bar.txt"
-  },
-  {
-    "title": "[GhostBuster] File foo/baz.txt seems unused",
-    "body": "./modules/foo/files/baz.txt"
-  }
-]
-```
+The url or the PuppetDB. Defaults to `http://puppetdb:8080`
+
+### PUPPETDB_CACERT_FILE
 
-How It Works
-------------
-To find unused classes:
-  1. It search puppet code recursively starting (by default) from current directory.
-  2. For each .pp file found, it extract the class name
-  3. Query puppetdb (using cache) to find matching class in catalogs
-  4. Display the number of class, followed by the class name.
+Your site’s CA certificate
 
-Same method applies to find unused defines.
+### PUPPETDB_CERT_FILE
 
-To find template and files, it has to loop twice, so this step can be longer.
+An SSL certificate signed by your site’s Puppet CA
 
-.ghostbusterignore
-------------------
+### PUPPETDB_KEY_FILE
 
-Puppet-ghostbuster supports `.ghostbusterignore` files with a list of path that
-will be excluded from the dead code detection. Useful for upstream modules where
-you are are not using everything.
+The private key for that certificate
 
-Example of `.ghostbusterignore` file:
+Example output
+--------------
 
+TODO
 ```
-modules/apache
-modules/mysql
-modules/mcollective/templates
+$ find . -type f -exec puppet-lint --only-checks ghostbuster_classes,ghostbuster_defines,ghostbuster_files,ghostbuster_templates {} \+
+./modules/foo/manifests/install.pp - WARNING: Class Foo::Install seems unused on line 1
+./modules/foo/manifests/service.pp - WARNING: Class Foo::Service seems unused on line 1
+./modules/foo/manifests/init.pp - WARNING: Class Foo seems unused on line 1
+./modules/bar/manifests/baz.pp - WARNING: Define Bar::Baz seems unused on line 1
+./modules/modulename/templates/foo.erb - WARNING: Template modulename/foo.erb seems unused on line 1
+./modules/modulename/templates/bar.erb - WARNING: Template modulename/bar.erb seems unused on line 1
+./modules/modulename/templates/baz.erb - WARNING: Template modulename/baz.erb seems unused on line 1
+./modules/foo/files/bar.txt - WARNING: File foo/bar.txt seems unused on line 1
+./modules/foo/files/baz.txt - WARNING: File foo/baz.txt seems unused on line 1
 ```

data/Rakefile

@@ -10,3 +10,5 @@ GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.future_release = PuppetGhostbuster::VERSION
   config.release_url = "https://rubygems.org/gems/puppet-ghostbuster/versions/%s"
 end
+
+task :default => :spec

data/lib/puppet-ghostbuster/puppetdb.rb

@@ -0,0 +1,28 @@
+require 'puppetdb'
+
+class PuppetGhostbuster
+  class PuppetDB
+    def self.client
+      @@client ||= ::PuppetDB::Client.new({
+        :server => "#{ENV['PUPPETDB_URL'] || 'http://puppetdb:8080'}/pdb/query",
+        :pem    => {
+          'key'     => ENV['PUPPETDB_KEY_FILE'],
+          'cert'    => ENV['PUPPETDB_CERT_FILE'],
+          'ca_file' => ENV['PUPPETDB_CACERT_FILE'],
+        }
+      }, 4)
+    end
+
+    def client
+      self.class.client
+    end
+
+    def self.classes
+      @@classes ||= client.request('resources', [:'=', 'type', 'Class']).data.map { |r| r['title'] }.uniq
+    end
+
+    def classes
+      self.class.classes
+    end
+  end
+end

data/lib/puppet-ghostbuster/version.rb

@@ -1,3 +1,3 @@
 class PuppetGhostbuster
-  VERSION = '0.4.5'
+  VERSION = '0.5.0'
 end

data/lib/puppet-lint/plugins/check_ghostbuster_classes.rb

@@ -0,0 +1,22 @@
+require 'puppet-ghostbuster/puppetdb'
+
+PuppetLint.new_check(:ghostbuster_classes) do
+  def check
+    return if path.match(%r{^\./(:?[^/]+/){2}?manifests/.+$}).nil?
+
+    puppetdb = PuppetGhostbuster::PuppetDB.new
+
+    class_indexes.each do |class_idx|
+      title_token = class_idx[:name_token]
+      title = title_token.value.split('::').map(&:capitalize).join('::')
+
+      return if puppetdb.classes.include? title
+
+      notify :warning, {
+        :message => "Class #{title} seems unused",
+        :line    => title_token.line,
+        :column  => title_token.column,
+      }
+    end
+  end
+end

data/lib/puppet-lint/plugins/check_ghostbuster_defines.rb

@@ -0,0 +1,23 @@
+require 'puppet-ghostbuster/puppetdb'
+
+PuppetLint.new_check(:ghostbuster_defines) do
+  def check
+    return if path.match(%r{^\./(:?[^/]+/){2}?manifests/.+$}).nil?
+
+    puppetdb = PuppetGhostbuster::PuppetDB.new
+
+    defined_type_indexes.each do |define_idx|
+      title_token = define_idx[:name_token]
+      type = title_token.value.split('::').map(&:capitalize).join('::')
+
+      return if puppetdb.client.request('resources', [:'=', 'type', type]).data.size > 0
+
+      notify :warning, {
+        :message => "Define #{type} seems unused",
+        :line    => title_token.line,
+        :column  => title_token.column,
+      }
+    end
+  end
+end
+

data/lib/puppet-lint/plugins/check_ghostbuster_files.rb

@@ -0,0 +1,61 @@
+require 'puppet-ghostbuster/puppetdb'
+
+class PuppetLint::Checks
+  def load_data(path, content)
+    lexer = PuppetLint::Lexer.new
+    PuppetLint::Data.path = path
+    begin
+      PuppetLint::Data.manifest_lines = content.split("\n", -1)
+      PuppetLint::Data.tokens = lexer.tokenise(content)
+      PuppetLint::Data.parse_control_comments
+    rescue
+      PuppetLint::Data.tokens = []
+    end
+  end
+end
+
+PuppetLint.new_check(:ghostbuster_files) do
+  def manifests
+    Dir.glob('./**/manifests/**/*.pp')
+  end
+
+  def check
+    m = path.match(%r{.*/([^/]+)/files/(.+)$})
+    return if m.nil?
+
+    puppetdb = PuppetGhostbuster::PuppetDB.new
+
+    module_name, file_name = m.captures
+    return if puppetdb.client.request('resources', [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{file_name}"],).data.size > 0
+
+    dir_name = File.dirname(file_name)
+    while dir_name != '.' do
+      return if puppetdb.client.request(
+        'resources',
+        [:'and',
+         [:'or',
+          [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{dir_name}"],
+          [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{dir_name}/"],
+      ],
+      [:'=', ['parameter', 'recurse'], true],
+      ],
+      ).data.size > 0
+      dir_name = File.dirname(dir_name)
+    end
+
+    manifests.each do |manifest|
+      return if File.readlines(manifest).grep(%r{["']#{module_name}/#{file_name}["']}).size > 0
+      if match = manifest.match(%r{.*/([^/]+)/manifests/.+$})
+        if match.captures[0] == module_name
+          return if File.readlines(manifest).grep(/["']\$\{module_name\}\/#{file_name}["']/).size > 0
+        end
+      end
+    end
+
+    notify :warning, {
+      :message => "File #{module_name}/#{file_name} seems unused",
+      :line    => 1,
+      :column  => 1,
+    }
+  end
+end

data/lib/puppet-lint/plugins/check_ghostbuster_templates.rb

@@ -0,0 +1,41 @@
+class PuppetLint::Checks
+  def load_data(path, content)
+    lexer = PuppetLint::Lexer.new
+    PuppetLint::Data.path = path
+    begin
+      PuppetLint::Data.manifest_lines = content.split("\n", -1)
+      PuppetLint::Data.tokens = lexer.tokenise(content)
+      PuppetLint::Data.parse_control_comments
+    rescue
+      PuppetLint::Data.tokens = []
+    end
+  end
+end
+
+PuppetLint.new_check(:ghostbuster_templates) do
+  def manifests
+    Dir.glob('./**/manifests/**/*.pp')
+  end
+
+  def check
+    m = path.match(%r{.*/([^/]+)/templates/(.+)$})
+    return if m.nil?
+
+    module_name, template_name = m.captures
+
+    manifests.each do |manifest|
+      return if File.readlines(manifest).grep(%r{["']#{module_name}/#{template_name}["']}).size > 0
+      if match = manifest.match(%r{.*/([^/]+)/manifests/.+$})
+        if match.captures[0] == module_name
+          return if File.readlines(manifest).grep(/["']\$\{module_name\}\/#{template_name}["']/).size > 0
+        end
+      end
+    end
+
+    notify :warning, {
+      :message => "Template #{module_name}/#{template_name} seems unused",
+      :line    => 1,
+      :column  => 1,
+    }
+  end
+end

data/puppet-ghostbuster.gemspec

@@ -17,9 +17,12 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-its', '~> 1.0'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.0'
   s.add_development_dependency 'github_changelog_generator'
   s.add_runtime_dependency 'json'
   s.add_runtime_dependency 'puppet'
+  s.add_dependency         'puppet-lint', '~> 1.0'
   s.add_runtime_dependency 'puppetdb-ruby'
 end

data/spec/puppet-lint/plugins/ghostbuster_classes_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+class PuppetDBRequest
+  def initialize(data)
+    @data = data
+  end
+
+  def data
+    @data
+  end
+end
+
+describe 'ghostbuster_classes' do
+  #let(:path) { "./manifests/site.pp" }
+  let(:path) { "./modules/foo/manifests/init.pp" }
+
+  context 'with fix disabled' do
+
+    before :each do
+      expect(PuppetGhostbuster::PuppetDB).to \
+        receive(:classes).and_return(['Foo'])
+    end
+
+    context 'when class is used' do
+      let(:code) { "class foo {}" }
+
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when class is not used' do
+      let(:code) { "class bar {}" }
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning('Class Bar seems unused')
+      end
+    end
+  end
+end

data/spec/puppet-lint/plugins/ghostbuster_defines_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class PuppetDBRequest
+  def initialize(data)
+    @data = data
+  end
+
+  def data
+    @data
+  end
+end
+
+describe 'ghostbuster_defines' do
+  let(:path) { "./modules/foo/manifests/init.pp" }
+
+  context 'with fix disabled' do
+
+    context 'when define is used' do
+      let(:code) { "define foo {}" }
+
+      before :each do
+        expect_any_instance_of(PuppetDB::Client).to \
+          receive(:request).with('resources', [:'=', 'type', 'Foo'])
+          .and_return(PuppetDBRequest.new([
+        {
+          'type' => 'Foo',
+          'title' => 'bar',
+        },
+        ]))
+      end
+
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when define is not used' do
+      let(:code) { "define foo {}" }
+
+      before :each do
+        expect_any_instance_of(PuppetDB::Client).to \
+          receive(:request).with('resources', [:'=', 'type', 'Foo'])
+          .and_return(PuppetDBRequest.new([]))
+      end
+
+      it 'should detect one problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning('Define Foo seems unused')
+      end
+    end
+  end
+end

data/spec/puppet-lint/plugins/ghostbuster_files_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe 'ghostbuster_files' do
+  let(:path) { "./modules/foo/files/bar/baz" }
+  let(:code) { "" }
+
+  context 'with fix disabled' do
+
+    context 'when file usage is found in puppetdb' do
+
+      before :each do
+        expect_any_instance_of(PuppetDB::Client).to\
+          receive(:request).with(
+            'resources',
+            [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/baz"],
+        )
+          .and_return(PuppetDBRequest.new([{}]))
+      end
+
+      it 'should not detect any problem' do
+        expect(problems).to have(0).problems
+      end
+    end
+
+    context 'when file usage is not found in puppetdb' do
+
+      before :each do
+        expect_any_instance_of(PuppetDB::Client).to\
+          receive(:request).with(
+            'resources',
+            [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/baz"],
+        )
+          .and_return(PuppetDBRequest.new([]))
+      end
+
+      context 'when parent directory with recurse => true usage is found in puppetdb' do
+        before :each do
+          expect_any_instance_of(PuppetDB::Client).to \
+            receive(:request).with(
+              'resources',
+              [:'and',
+               [:'or',
+                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
+                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/"],
+          ],
+          [:'=', ['parameter', 'recurse'], true],
+          ],
+          )
+            .and_return(PuppetDBRequest.new([
+          {
+          },
+          ]))
+        end
+
+        it 'should not detect any problem' do
+          expect(problems).to have(0).problems
+        end
+      end
+
+      context 'when parent directory usage is not found in puppetdb' do
+        before :each do
+          expect_any_instance_of(PuppetDB::Client).to \
+            receive(:request).with(
+              'resources',
+              [:'and',
+               [:'or',
+                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar"],
+                [:'=', ['parameter', 'source'], "puppet:///modules/foo/bar/"],
+          ],
+          [:'=', ['parameter', 'recurse'], true],
+          ],
+          )
+            .and_return(PuppetDBRequest.new([]))
+        end
+
+        context 'when file usage is found in manifests' do
+
+          before :each do
+            expect(Dir).to receive(:glob){["./modules/foo/manifests/bar.pp" ]}
+          end
+
+          context 'when using full module name syntax' do
+            it 'should not detect any problem' do
+              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => file('foo/bar/baz'),", "  }"])
+              expect(problems).to have(0).problems
+            end
+          end
+
+          context 'when using $module_name syntax' do
+            it 'should not detect any problem' do
+              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => file('bar/foo'),", "  }"])
+              expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", '  content => file("${module_name}/bar/baz"),', "  }"])
+              expect(problems).to have(0).problems
+            end
+          end
+        end
+
+        context 'when file usage is not found in manifests' do
+          it 'should detect one problem' do
+            expect(problems).to have(1).problems
+          end
+
+          it 'should create a warning' do
+            expect(problems).to contain_warning("File foo/bar/baz seems unused")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/puppet-lint/plugins/ghostbuster_templates_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'ghostbuster_templates' do
+  let(:path) { "./modules/foo/templates/bar" }
+  let(:code) { "" }
+
+  context 'with fix disabled' do
+
+    context 'when template usage is found in manifests' do
+
+      before :each do
+        expect(Dir).to receive(:glob){["./modules/foo/manifests/bar.pp" ]}
+      end
+
+      context 'when using full module name syntax' do
+        it 'should not detect any problem' do
+          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => template('foo/bar'),", "  }"])
+          expect(problems).to have(0).problems
+        end
+      end
+
+      context 'when using $module_name syntax' do
+        it 'should not detect any problem' do
+          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", "  content => template('bar/foo'),", "  }"])
+          expect(File).to receive(:readlines).with("./modules/foo/manifests/bar.pp").and_return(["file{'foo':", '  content => template("${module_name}/bar"),', "  }"])
+          expect(problems).to have(0).problems
+        end
+      end
+    end
+
+    context 'when template usage is not found in manifests' do
+      it 'should detect one problem' do
+        expect(problems).to have(1).problems
+      end
+
+      it 'should create a warning' do
+        expect(problems).to contain_warning("Template foo/bar seems unused")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'puppet-lint'
+
+PuppetLint::Plugins.load_spec_helper

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-ghostbuster
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Camptocamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -42,16 +42,44 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: puppetdb-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -110,8 +152,7 @@ dependencies:
         version: '0'
 description: Try and find dead code in Puppet receipts
 email: 
-executables:
-- puppet-ghostbuster
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -122,13 +163,18 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/puppet-ghostbuster
-- lib/puppet-ghostbuster.rb
-- lib/puppet-ghostbuster/bin.rb
-- lib/puppet-ghostbuster/configuration.rb
-- lib/puppet-ghostbuster/optparser.rb
+- lib/puppet-ghostbuster/puppetdb.rb
 - lib/puppet-ghostbuster/version.rb
+- lib/puppet-lint/plugins/check_ghostbuster_classes.rb
+- lib/puppet-lint/plugins/check_ghostbuster_defines.rb
+- lib/puppet-lint/plugins/check_ghostbuster_files.rb
+- lib/puppet-lint/plugins/check_ghostbuster_templates.rb
 - puppet-ghostbuster.gemspec
+- spec/puppet-lint/plugins/ghostbuster_classes_spec.rb
+- spec/puppet-lint/plugins/ghostbuster_defines_spec.rb
+- spec/puppet-lint/plugins/ghostbuster_files_spec.rb
+- spec/puppet-lint/plugins/ghostbuster_templates_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/camptocamp/puppet-ghostbuster
 licenses:
 - Apache-2.0

data/bin/puppet-ghostbuster

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-
-require 'puppet-ghostbuster'
-
-exit PuppetGhostbuster::Bin.new(ARGV).run

data/lib/puppet-ghostbuster/bin.rb

@@ -1,31 +0,0 @@
-require 'puppet-ghostbuster/optparser'
-class PuppetGhostbuster::Bin
-  def initialize(args)
-    @args = args
-  end
-
-  def run
-    opts = PuppetGhostbuster::OptParser.build
-
-    begin
-      opts.parse!(@args)
-    rescue OptionParser::InvalidOption
-      puts "puppet-ghostbuster: #{$!.message}"
-      puts "puppet-ghostbuster: try 'puppet-ghostbuster --help' for more information"
-      return 1
-    end
-
-    if PuppetGhostbuster.configuration.display_version
-      puts "puppet-ghostbuster #{PuppetGhostbuster::VERSION}"
-      return 0
-    end
-
-    if @args[0].nil?
-      PuppetGhostbuster.new().run
-    else
-      PuppetGhostbuster.new(@args[0]).run
-    end
-
-    exit 0
-  end
-end

data/lib/puppet-ghostbuster/configuration.rb

@@ -1,96 +0,0 @@
-class PuppetGhostbuster
-  # Public: A singleton class to store the running configuration of
-  # puppet-ghostbuster.
-  class Configuration
-
-    def initialize
-      Puppet.initialize_settings
-    end
-
-    # Public: Catch situations where options are being set for the first time
-    # and create the necessary methods to get & set the option in the future.
-    #
-    # args   - An Array of values to set the option to.
-    # method - The String name of the option.
-    # block  - Unused.
-    #
-    # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>=(value)
-    def method_missing(method, *args, &block)
-      if method.to_s =~ /^(\w+)=$/
-        option = $1
-        add_option(option.to_s) if settings[option].nil?
-        settings[option] = args[0]
-      else
-        nil
-      end
-    end
-
-    # Internal: Add options to the PuppetGhostbuster::Configuration object from inside
-    # the class.
-    #
-    # option - The String name of the option.
-    #
-    # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>
-    #   <option>=(value)
-    def add_option(option)
-      self.class.add_option(option)
-    end
-
-    # Public: Add an option to the PuppetGhostbuster::Configuration object from
-    # outside the class.
-    #
-    # option - The String name of the option.
-    #
-    # Returns nothing.
-    #
-    # Signature
-    #
-    #   <option>
-    #   <option>=(value)
-    def self.add_option(option)
-      # Public: Set the value of the named option.
-      #
-      # value - The value to set the option to.
-      #
-      # Returns nothing.
-      define_method("#{option}=") do |value|
-        settings[option] = value
-      end
-
-      # Public: Get the value of the named option.
-      #
-      # Returns the value of the option.
-      define_method(option) do
-        settings[option]
-      end
-    end
-
-    # Internal: Access the internal storage for settings.
-    #
-    # Returns a Hash containing all the settings.
-    def settings
-      @settings ||= {}
-    end
-
-    # Public: Clear the PuppetGhostbuster::Configuration storage and set some sane
-    # default values.
-    #
-    # Returns nothing.
-    def defaults
-      settings.clear
-      self.loglevel = Logger::INFO
-      self.puppetdbserverurl = "https://#{Puppet[:server]}:8081"
-      self.hostprivkey = Puppet[:hostprivkey]
-      self.hostcert    = Puppet[:hostcert]
-      self.localcacert = Puppet[:localcacert]
-    end
-  end
-end

data/lib/puppet-ghostbuster/optparser.rb

@@ -1,68 +0,0 @@
-require 'optparse'
-
-# Public: Contains the puppet-ghostbuster option parser so that it can be used easily
-# in multiple places.
-class PuppetGhostbuster::OptParser
-  HELP_TEXT = <<-EOF
-    puppet-ghostbuster
-
-    Basic Command Line Usage:
-      puppet-ghostbuster [OPTIONS] [PATH]
-
-            PATH        Path to the Root directory of puppet code. Current dir by default.
-
-    Option:
-  EOF
-
-  # Public: Initialise a new puppet-ghostbuster OptionParser.
-  #
-  # Returns an OptionParser object.
-  def self.build
-    OptionParser.new do |opts|
-      opts.banner = HELP_TEXT
-
-      opts.on('--version', 'Display the current version.') do
-        PuppetGhostbuster.configuration.display_version = true
-      end
-
-      opts.on('-c', '--config FILE', 'Load puppet-ghostbuster options from file.') do |file|
-        opts.load(file)
-      end
-
-      opts.on('--log-level LEVEL', [:debug, :info, :warn, :error],
-              'The level of verbosity (debug, info, warn or error)') do |loglevel|
-        PuppetGhostbuster.configuration.loglevel=Logger::DEBUG if loglevel==:debug
-        PuppetGhostbuster.configuration.loglevel=Logger::INFO  if loglevel==:info
-        PuppetGhostbuster.configuration.loglevel=Logger::WARN  if loglevel==:warn
-        PuppetGhostbuster.configuration.loglevel=Logger::ERROR if loglevel==:error
-      end
-
-      opts.on('-s', '--puppetdburl SERVER',
-              'puppet db server url to connect to.',
-              'Defaults to the puppet server found in puppet configuration') do |s|
-        PuppetGhostbuster.configuration.puppetdbserverurl = s
-      end
-
-      opts.on('--key FILE', 'Load private key from the given file.') do |key|
-        PuppetGhostbuster.configuration.hostprivkey = key
-      end
-
-      opts.on('--cert FILE', 'Load cert from the given file.') do |cert|
-        PuppetGhostbuster.configuration.hostcert = cert
-      end
-
-      opts.on('--ca FILE', 'Load local ca cert from the given file.') do |ca|
-        PuppetGhostbuster.configuration.localcacert = ca
-      end
-
-      opts.load('/etc/puppet-ghostbuster.rc')
-      begin
-        opts.load(File.expand_path('~/.puppet-ghostbuster.rc')) if ENV['HOME']
-      rescue Errno::EACCES
-        # silently skip loading this file if HOME is set to a directory that
-        # the user doesn't have read access to.
-      end
-      opts.load('.puppet-ghostbuster.rc')
-    end
-  end
-end

data/lib/puppet-ghostbuster.rb

@@ -1,207 +0,0 @@
-require 'json'
-require 'puppet'
-require 'puppetdb'
-require 'optparse'
-
-require 'puppet-ghostbuster/version'
-require 'puppet-ghostbuster/bin'
-require 'puppet-ghostbuster/configuration'
-
-class PuppetGhostbuster
-
-  attr_accessor :path
-  @@issues = []
-
-  def exclude(filelist)
-    ignorefile = "#{path}/.ghostbusterignore"
-    if File.exist?(ignorefile) then
-      ignorelist = File.readlines(ignorefile).each {|l| l.chomp!}
-      ignorelist.each do |ignorerule|
-        filelist.reject! { |item| item =~ /^#{path}\/#{ignorerule}/ }
-      end
-    end
-    filelist
-  end
-
-  def manifests
-    exclude Dir["#{path}/**/manifests/**/*.pp"]
-  end
-
-  def templates
-    exclude Dir["#{path}/**/templates/**/*"]
-  end
-
-  def files
-    exclude Dir["#{path}/**/files/**/*"]
-  end
-
-  def self.configuration
-    @configuration ||= PuppetGhostbuster::Configuration.new
-  end
-
-  def configuration
-    self.class.configuration
-  end
-
-  def self.puppetdbserverfilename
-    return configuration.puppetdbserverurl.gsub(/[:\/]/,'_')
-  end
-
-  def self.cache
-    "/var/tmp/puppet-ghostbuster.#{puppetdbserverfilename}.cache"
-  end
-
-  def self.update_cache(value)
-    File.open(cache, 'w') do |f|
-      f.write(value)
-    end
-    value
-  end
-
-  def self.get_cache
-    if File.exists?(cache)
-      JSON.parse(File.read(cache))
-    else
-      false
-    end
-  end
-
-  def self.client
-    @@logger.debug "Connecting to puppet DB #{configuration.puppetdbserverurl}"
-    PuppetDB::Client.new({
-      :server => "#{configuration.puppetdbserverurl}/pdb/query",
-      :pem    => {
-        'key'     => configuration.hostprivkey,
-        'cert'    => configuration.hostcert,
-        'ca_file' => configuration.localcacert,
-      }
-    }, 4)
-  end
-
-  def self.used_classes
-    return get_cache || update_cache(
-      client.request(
-        'resources',
-        [:'=', 'type', 'Class'],
-      ).data.map { |resource|
-        resource['title']
-      }
-    )
-  end
-
-  def find_unused_classes
-    @@logger.info 'Now trying to find unused classes'
-    manifests.each do |file|
-      @@logger.debug "  file #{file}."
-      if File.symlink?(file)
-        @@logger.warn "  Skipping symlink #{file}"
-        next
-      end
-      if c = File.readlines(file).grep(/^class\s+([^\s\(\{]+)/){$1}[0]
-        class_name = c.split('::').map(&:capitalize).join('::')
-        count = self.class.used_classes.select { |klass| klass == class_name }.size
-        @@issues << { :title => "[GhostBuster] Class #{class_name} seems unused", :body => file } if count == 0
-      end
-    end
-  end
-
-  def find_unused_defines
-    @@logger.info 'Now trying to find unused defines'
-    manifests.each do |file|
-      if File.symlink?(file)
-        @@logger.warn "  Skipping symlink #{file}"
-        next
-      end
-      if d = File.readlines(file).grep(/^define\s+([^\s\(\{]+)/){$1}[0]
-        define_name = d.split('::').map(&:capitalize).join('::')
-        count = self.class.client.request('resources', [:'=', 'type', define_name]).data.size
-        @@issues << { :title => "[GhostBuster] Define #{define_name} seems unused", :body => file } if count == 0
-      end
-    end
-  end
-
-  def find_unused_templates
-    @@logger.info 'Now trying to find unused templates'
-    templates.each do |template|
-      next unless File.file?(template)
-      module_name, template_name = template.match(/.*\/([^\/]+)\/templates\/(.+)$/).captures
-      count = 0
-      manifests.each do |manifest|
-        if File.symlink?(manifest)
-          @@logger.warn "  Skipping symlink #{manifest}"
-          next
-        end
-        if match = manifest.match(/.*\/([^\/]+)\/manifests\/.+$/)
-          manifest_module_name = match.captures[0]
-          count += File.readlines(manifest).grep(/["']\$\{module_name\}\/#{template_name}["']/).size if manifest_module_name == module_name
-        end
-        count += File.readlines(manifest).grep(/["']#{module_name}\/#{template_name}["']/).size
-      end
-      @@issues << { :title => "[GhostBuster] Template #{module_name}/#{template_name} seems unused", :body => template } if count == 0
-    end
-  end
-
-  def find_unused_files
-    @@logger.info 'Now trying to find unused files'
-    files.each do |file|
-      next unless File.file?(file)
-      module_name, file_name = file.match(/.*\/([^\/]+)\/files\/(.+)$/).captures
-      found = false
-
-      found = true if self.class.client.request('resources', [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{file_name}"],).data.size > 0
-
-      dir_name = File.dirname(file_name)
-      while dir_name != '.' do
-        found = true if self.class.client.request(
-          'resources',
-          [:'and',
-            [:'or',
-              [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{dir_name}"],
-              [:'=', ['parameter', 'source'], "puppet:///modules/#{module_name}/#{dir_name}/"],
-            ],
-            [:'=', ['parameter', 'recurse'], true],
-        ],
-        ).data.size > 0
-        dir_name = File.dirname(dir_name)
-      end
-
-      manifests.each do |manifest|
-        if File.symlink?(manifest)
-          @@logger.warn "  Skipping symlink #{manifest}"
-          next
-        end
-
-        if match = manifest.match(/.*\/([^\/]+)\/manifests\/.+$/)
-          manifest_module_name = match.captures[0]
-          if manifest_module_name == module_name
-            found = true if File.readlines(manifest).grep(/["']\$\{module_name\}\/#{file_name}["']/).size > 0
-            break if found
-          end
-        end
-        found = true if File.readlines(manifest).grep(/#{module_name}\/#{file_name}/).size > 0
-        break if found
-      end
-
-      @@issues << { :title => "[GhostBuster] File #{module_name}/#{file_name} seems unused", :body => file } unless found
-    end
-  end
-
-  def initialize(path = '.')
-    self.path = path
-    @@logger = Logger.new(STDERR).tap do |log|
-      log.progname = 'PuppetGhostbuster'
-      log.level=PuppetGhostbuster.configuration.loglevel
-    end
-  end
-
-  def run
-    find_unused_classes
-    find_unused_defines
-    find_unused_templates
-    find_unused_files
-    puts @@issues.to_json
-  end
-
-end
-
-PuppetGhostbuster.configuration.defaults