yard-metasploit-erd 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWE2Y2MxNTI0YzViNTYyZjZmN2E0Y2M2YTU4OTU0MjBkYTY5ODI5Mg==
+  data.tar.gz: !binary |-
+    ZTIzNWQ5ZjgzNzU4ZjM4MzQ3NWY2MWQ4OWU5MzM4MzcxZjIwODk1Mw==
+SHA512:
+  metadata.gz: !binary |-
+    ODdhNTRmYTIxNDcxNWMyMTliNDBlY2Q0OWJjNDE2MTQ3YTM3NmI4Mzc2YWU2
+    OWJiY2Y1MmE5OWRkN2MzYjMxNTgxZTFmYzZkZTM1Yzk0MTJlYjk4YzU4MjM4
+    YmI1ZmQ5NzYwMmRkMTE5NmViODcxYjBjNDNhMmI2N2U0NmNiMzY=
+  data.tar.gz: !binary |-
+    NjQ2YjhkNDVmMTFkNTRmYWY2OGRiNjI5ZjNlMmQ4OWU2OWRlZTkxMjM5YTIz
+    OGZhNTJkOTVhOTE0YzgxMmU1MTVhMjdjYjIxZTY4NDliNjgzOTBmNWI1MDNj
+    ZjhlZDQ0NTEyYjY0OGE2ZTEzZGZjMDExZDkwNjJlNzkyNTAxZDI=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,28 @@
+# bundler
+.bundle
+
+# Rubymine
+.idea
+
+# rvm files should not be checked in as multiple rubies are supported in the CI builds
+.ruby-gemset
+.ruby-version
+.rvmrc
+
+# YARD
+.yardoc
+/doc/*
+!/doc/example
+
+# simplecov
+coverage
+
+# @see http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+
+# built gems
+pkg
+*.gem
+
+# compiled ruby from Rubinius
+*.rbc

data/.rspec

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

data/.simplecov

@@ -0,0 +1,42 @@
+# RM_INFO is set when using Rubymine.  In Rubymine, starting SimpleCov is
+# controlled by running with coverage, so don't explicitly start coverage (and
+# therefore generate a report) when in Rubymine.  This _will_ generate a report
+# whenever `rake spec` is run.
+unless ENV['RM_INFO']
+  SimpleCov.start
+end
+
+SimpleCov.configure do
+  # ignore this file
+  add_filter '.simplecov'
+
+  # Rake tasks aren't tested with rspec
+  add_filter 'Rakefile'
+  add_filter 'lib/tasks'
+
+  #
+  # Changed Files in Git Group
+  # @see http://fredwu.me/post/35625566267/simplecov-test-coverage-for-changed-files-only
+  #
+
+  untracked = `git ls-files --exclude-standard --others`
+  unstaged = `git diff --name-only`
+  staged = `git diff --name-only --cached`
+  all = untracked + unstaged + staged
+  changed_filenames = all.split("\n")
+
+  add_group 'Changed' do |source_file|
+    changed_filenames.detect { |changed_filename|
+      source_file.filename.end_with?(changed_filename)
+    }
+  end
+
+  add_group 'Libraries', 'lib'
+
+  #
+  # Specs are reported on to ensure that all examples are being run and all
+  # lets, befores, afters, etc are being used.
+  #
+
+  add_group 'Specs', 'spec'
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - jruby
+  - rbx

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yard-metasploit-erd.gemspec
+gemspec
+
+group :development, :test do
+  # markdown formatting for yard
+  gem 'kramdown', platforms: :jruby
+  # markdown formatting for yard
+  gem 'redcarpet', platforms: :ruby
+  # documentation
+  # 0.8.7.4 has a bug where setters are not documented when @!attribute is used
+  gem 'yard', '< 0.8.7.4'
+end
+
+group :test do
+  # blank?
+  # restrict for compatibility with rest of metasploit ecosystem until it upgrades to Rails 4
+  gem 'activesupport', '>= 3.2', '< 4.0.0'
+  # Upload coverage reports to coveralls.io
+  gem 'coveralls', require: false
+  # code coverage of tests
+  gem 'simplecov', require: false
+end

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2014 Rapid7, Inc.
+
+License: BSD-3-clause
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of Rapid7 LLC nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,61 @@
+# YARD::Metasploit::ERD [![Build Status](https://travis-ci.org/rapid7/yard-metasploit-erd.svg?branch=feature/gem-skeleton)](https://travis-ci.org/rapid7/yard-metasploit-erd)[![Code Climate](https://codeclimate.com/github/rapid7/yard-metasploit-erd.png)](https://codeclimate.com/github/rapid7/yard-metasploit-erd)[![Coverage Status](https://coveralls.io/repos/rapid7/yard-metasploit-erd/badge.png)](https://coveralls.io/r/rapid7/yard-metasploit-erd)[![Dependency Status](https://gemnasium.com/rapid7/yard-metasploit-erd.png)](https://gemnasium.com/rapid7/yard-metasploit-erd)[![Gem Version](https://badge.fury.io/rb/yard-metasploit-erd.png)](http://badge.fury.io/rb/yard-metasploit-erd)
+
+`yard-metasploit-erd` is a [YARD](yardoc.org) plugin that automatically inserts an "Entity-Relationship Diagram"
+subsection containing a PNG Entity-Relationship Diagram for the entire schema (on the index page), for each Module that
+contains `ActiveRecord::Base` subclasses and for each `ActiveRecord::Base` subclass.
+
+For namespace Modules, the diagrams are restricted to the `ActiveRecord::Base` subclasses in that namespace and the
+transitive closure of those classes `belongs_to` relationships.
+
+![Mdm::Module::Author ERD](doc/example/images/mdm/module/author.erd.png)
+
+For `ActiveRecord::Base` subclasses the diagram is restricted to the transitive closure of its `belongs_to`
+relationships.
+
+![Mdm::Module namespace ERD](doc/example/images/mdm/module.erd.png)
+
+Using the `belongs_to` transitive closure means that all foreign keys are mapped to primary keys, so any diagram's
+namespace or class could be extracted to another gem without leaving dangling foreign keys.
+
+## Versioning
+
+`YARD::Metasploit::ERD` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
+should set `YARD::Metasploit::ERD::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
+and the `PRERELEASE` section of `YARD::Metasploit::ERD::VERSION` does not exist.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'yard-metasploit-erd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-metasploit-erd
+
+## Usage
+
+Add this line to your application's `.yardopts`
+
+    --plugin yard-metasploit-erd
+
+Ensure your `ActiveRecord::Base` subclasses are loaded when YARD runs by eager loading before the `yard:doc` task runs:
+
+    # lib/tasks/yard.rake
+    task 'yard:doc' => :eager_load
+
+    task eager_load: :environment do
+      Rails.application.eager_load!
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yard-metasploit-erd/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+load 'tasks/yard.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tasks/yard.rake

@@ -0,0 +1,32 @@
+# @note All options not specific to any given rake task should go in the .yardopts file so they are available to both
+#   the below rake tasks and when invoking `yard` from the command line
+
+if defined? YARD
+  namespace :yard do
+    YARD::Rake::YardocTask.new(:doc) do |t|
+      # --no-stats here as 'stats' task called after will print fuller stats
+      t.options = ['--no-stats']
+
+      t.after = Proc.new {
+        Rake::Task['yard:stats'].execute
+      }
+    end
+
+    task :doc
+
+    desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
+    task :stats do
+      stats = YARD::CLI::Stats.new
+      stats.run('--compact', '--list-undoc')
+    end
+  end
+
+  # @todo Figure out how to just clone description from yard:doc
+  desc "Generate YARD documentation"
+  # allow calling namespace to as a task that goes to default task for namespace
+  task :yard => ['yard:doc']
+
+  task :default => :yard
+else
+  puts 'YARD not defined, so yard tasks cannot be setup.'
+end

data/lib/yard/metasploit/erd/version.rb

@@ -0,0 +1,33 @@
+module YARD
+  module Metasploit
+    module ERD
+      # Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+      module Version
+        # The major version number.
+        MAJOR = 0
+        # The minor version number, scoped to the {MAJOR} version number.
+        MINOR = 0
+        # The patch number, scoped to the {MINOR} version number.
+        PATCH = 2
+
+        # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+        # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+        #
+        # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-{PRERELEASE}' on any branch
+        #   other than master.
+        def self.full
+          version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+          if defined? PRERELEASE
+            version = "#{version}-#{PRERELEASE}"
+          end
+
+          version
+        end
+      end
+
+      # @see Version.full
+      VERSION = Version.full
+    end
+  end
+end

data/lib/yard/metasploit/erd.rb

@@ -0,0 +1,43 @@
+#
+# Gems
+#
+
+require 'yard'
+
+#
+# Project
+#
+
+require 'yard/metasploit/erd/version'
+
+# namespace inherited from `yard` gem itself
+module YARD
+  # namespace to match primary gem, `metasploit-erd`, that is used by this yard plugin.
+  module Metasploit
+    # namespace to match primary gem, `metasploit-erd`, that is used by this yard plugin.
+    module ERD
+      # Registers {templates} in `YARD::Templates::Engine.templates_paths`.
+      #
+      # @return [void]
+      def self.register_template_path
+        YARD::Templates::Engine.register_template_path templates.to_path
+      end
+
+      # The root directory of the yard-metasploit-erd gem.
+      #
+      # @return [Pathname]
+      def self.root
+        @root ||= Pathname.new(__FILE__).parent.parent.parent.parent
+      end
+
+      # Path to the YARD templates for this YARD plugin.
+      #
+      # @return [Pathname]
+      def self.templates
+        root.join('templates')
+      end
+    end
+  end
+end
+
+YARD::Metasploit::ERD.register_template_path

data/lib/yard-metasploit-erd.rb

@@ -0,0 +1,3 @@
+# YARD does not follow gem naming conventions for its plugins: it treats '-' in names as literal instead of being
+# directories.
+require 'yard/metasploit/erd'

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# require before 'metasploit/erd' so coverage is shown for files required by 'yard/metasploit/erd'
+require 'simplecov'
+require 'coveralls'
+
+if ENV['TRAVIS'] == 'true'
+  # don't generate local report as it is inaccessible on travis-ci, which is why coveralls is being used.
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+else
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      # either generate the local report
+      SimpleCov::Formatter::HTMLFormatter
+  ]
+end
+
+require 'yard/metasploit/erd'

data/spec/yard/metasploit/erd/version_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+require 'active_support/core_ext/object/blank'
+
+describe YARD::Metasploit::ERD::Version do
+  context 'CONSTANTS' do
+    context 'MAJOR' do
+      subject(:major) do
+        described_class::MAJOR
+      end
+
+      it 'is 0 because the API is not locked yet' do
+        expect(major).to eq(0)
+      end
+    end
+
+    context 'MINOR' do
+      subject(:minor) do
+        described_class::MINOR
+      end
+
+      it { should be_a Integer }
+    end
+
+    context 'PATCH' do
+      subject(:patch) do
+        described_class::PATCH
+      end
+
+      it { should be_a Integer }
+    end
+
+    pull_request = ENV['TRAVIS_PULL_REQUEST']
+
+    # a pull request cannot check PRERELEASE because it will be tested in the target branch, but the source itself
+    # is from the source branch and so has the source branch PRERELEASE.
+    #
+    # PRERELEASE can only be set appropriately for a merge by merging to the target branch and then updating PRERELEASE
+    # on the target branch before committing and/or pushing to github and travis-ci.
+    if pull_request.nil? || pull_request == 'false'
+      context 'PREPRELEASE' do
+        subject(:prerelease) do
+          described_class::PRERELEASE
+        end
+
+        branch = ENV['TRAVIS_BRANCH']
+
+        if branch.blank?
+          branch = `git rev-parse --abbrev-ref HEAD`.strip
+        end
+
+        if branch == 'master'
+          it 'does not have a PRERELEASE' do
+            expect(defined? described_class::PRERELEASE).to be_nil
+          end
+        else
+          branch_regex = /\A(feature|staging)\/(?<prerelease>.*)\z/
+          match = branch.match(branch_regex)
+
+          if match
+            it 'matches the branch relative name' do
+              expect(prerelease).to eq(match[:prerelease])
+            end
+          else
+            tag_regex = /\Av(?<major>\d+).(?<minor>\d+).(?<patch>\d+)(-(?<prerelease>.*))?\z/
+            # travis-ci sets TRAVIS_BRANCH to the tag name for tag builds
+            match = branch.match(tag_regex)
+
+            if match
+              tag_prerelease = match[:prerelease]
+
+              if tag_prerelease
+                it 'matches the tag prerelease' do
+                  expect(prerelease).to eq(tag_prerelease)
+                end
+              else
+                it 'does not have a PRERELEASE' do
+                  expect(defined? described_class::PRERELEASE).to be_nil
+                end
+              end
+            else
+              it 'has a abbreviated reference that can be parsed for prerelease' do
+                fail "Do not know how to parse #{branch.inspect} for PRERELEASE"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  context 'full' do
+    subject(:full) do
+      described_class.full
+    end
+
+    #
+    # lets
+    #
+
+    let(:major) do
+      1
+    end
+
+    let(:minor) do
+      2
+    end
+
+    let(:patch) do
+      3
+    end
+
+    before(:each) do
+      stub_const("#{described_class}::MAJOR", major)
+      stub_const("#{described_class}::MINOR", minor)
+      stub_const("#{described_class}::PATCH", patch)
+    end
+
+    context 'with PRERELEASE' do
+      let(:prerelease) do
+        'prerelease'
+      end
+
+      before(:each) do
+        stub_const("#{described_class}::PRERELEASE", prerelease)
+      end
+
+      it 'is <major>.<minor>.<patch>-<prerelease>' do
+        expect(full).to eq("#{major}.#{minor}.#{patch}-#{prerelease}")
+      end
+    end
+
+    context 'without PRERELEASE' do
+      before(:each) do
+        hide_const("#{described_class}::PRERELEASE")
+      end
+
+      it 'is <major>.<minor>.<patch>' do
+        expect(full).to eq("#{major}.#{minor}.#{patch}")
+      end
+    end
+  end
+end

data/spec/yard/metasploit/erd_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe YARD::Metasploit::ERD do
+  context 'CONSTANTS' do
+    context 'VERSION' do
+      subject(:version) do
+        described_class::VERSION
+      end
+
+      it 'is YARD::Metasploit::ERD::Version.full' do
+        expect(version).to eq(YARD::Metasploit::ERD::Version.full)
+      end
+    end
+  end
+end

data/templates/default/class/html/entity_relationship_diagram.erb

@@ -0,0 +1,8 @@
+<h2>Entity-Relationship Diagram</h2>
+
+<figure>
+  <img src="<%= url_for_file("images/#{object.title.underscore}.erd.png") %>" alt="<%= object.title %> Entity-Relationship Diagram">
+  <figcaption>
+    The cluster found by tracing <code>belongs_to</code> associations from <code><%= object.title %></code>
+  </figcaption>
+</figure>

data/templates/default/class/html/setup.rb

@@ -0,0 +1,25 @@
+#
+# Gems
+#
+
+require 'metasploit/erd'
+
+def active_record?
+  inheritance_tree = object.inheritance_tree
+  inheritance_titles = inheritance_tree.map(&:title)
+
+  inheritance_titles.include? 'ActiveRecord::Base'
+end
+
+def entity
+  unless @entity
+    if active_record?
+      klass = object.title.constantize
+      @entity = ::Metasploit::ERD::Entity::Class.new(klass)
+    else
+      super
+    end
+  end
+
+  @entity
+end

data/templates/default/layout/html/entity_relationship_diagram.erb

@@ -0,0 +1,8 @@
+<h2>Entity-Relationship Diagram</h2>
+
+<figure>
+  <img src="<%= url_for_file("images/_index.erd.png") %>" alt="Entity-Relationship Diagram">
+  <figcaption>
+    Full Entity-Relationship Diagram for this project.
+  </figcaption>
+</figure>

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,73 @@
+#
+# Gems
+#
+
+require 'metasploit/erd'
+require 'rails_erd/domain'
+
+def init
+  super
+
+  if object == '_index.html'
+    layout = sections[:layout]
+
+    unless layout
+      raise ArgumentError,
+            "Could not find layout subsection in root sections"
+    end
+
+    index = layout[:index]
+
+    unless index
+      raise ArgumentError,
+            "Could not find index subsection in layout section"
+    end
+
+    index.place(:entity_relationship_diagram).before(:listing)
+  end
+end
+
+#
+# Generates a file to the output with the specified contents.
+#
+# @example saving a custom html file to the documenation root
+#
+#   asset('my_custom.html','<html><body>Custom File</body></html>')
+#
+# @param [String] path relative to the document output where the file will be
+#   created.
+# @param [String] content the contents that are saved to the file.
+def asset(path, content)
+  if options.serializer
+    log.capture("Generating asset #{path}") do
+      options.serializer.serialize(path, content)
+    end
+  end
+end
+
+def entity_relationship_diagram
+  generate_entity_relationship_diagram
+  erb(:entity_relationship_diagram)
+end
+
+def generate_entity_relationship_diagram
+  domain = RailsERD::Domain.new(
+      ActiveRecord::Base.descendants,
+      # No entities should be missing because all desendents are in domain.
+      warn: true
+  )
+
+  Dir.mktmpdir { |directory|
+    filename = File.join(directory, '_index.erd')
+    diagram = ::Metasploit::ERD::Diagram.new(
+        domain,
+        filename: filename,
+        title: 'Entity-Relationship Diagram'
+    )
+    temporary_path = diagram.create
+
+    content = File.read(temporary_path)
+    asset_path = File.join('images', "_index.erd.#{diagram.send(:filetype)}")
+    asset(asset_path, content)
+  }
+end

data/templates/default/module/html/entity_relationship_diagram.erb

@@ -0,0 +1,8 @@
+<h2>Entity-Relationship Diagram</h2>
+
+<figure>
+  <img src="<%= url_for_file("images/#{object.title.underscore}.erd.png") %>" alt="<%= object.title %> Entity-Relationship Diagram">
+  <figcaption>
+    The cluster found by tracing <code>belongs_to</code> associations from <code>ActiveRecord::Base</code> descendants under the <code><%= object.title %></code> namespace.
+  </figcaption>
+</figure>

data/templates/default/module/html/setup.rb

@@ -0,0 +1,60 @@
+#
+# Standard Library
+#
+
+require 'tempfile'
+
+#
+# Gems
+#
+
+require 'metasploit/erd'
+
+def init
+  super
+  sections.place(:entity_relationship_diagram).before(:children)
+end
+
+def entity_relationship_diagram
+  unless erd_empty?
+    generate_entity_relationship_diagram
+    erb(:entity_relationship_diagram)
+  end
+end
+
+def erd_empty?
+  entity.cluster.class_set.empty?
+end
+
+def entity
+  @entity ||= ::Metasploit::ERD::Entity::Namespace.new(object.title)
+end
+
+#
+# Generates a file to the output with the specified contents.
+#
+# @example saving a custom html file to the documenation root
+#
+#   asset('my_custom.html','<html><body>Custom File</body></html>')
+#
+# @param [String] path relative to the document output where the file will be
+#   created.
+# @param [String] content the contents that are saved to the file.
+def asset(path, content)
+  if options.serializer
+    log.capture("Generating asset #{path}") do
+      options.serializer.serialize(path, content)
+    end
+  end
+end
+
+def generate_entity_relationship_diagram
+  Dir.mktmpdir { |directory|
+    diagram = entity.diagram(directory: directory)
+    temporary_path = diagram.create
+
+    content = File.read(temporary_path)
+    asset_path = File.join('images', "#{object.title.underscore}.erd.#{diagram.send(:filetype)}")
+    asset(asset_path, content)
+  }
+end

data/yard-metasploit-erd.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yard/metasploit/erd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yard-metasploit-erd'
+  spec.version       = YARD::Metasploit::ERD::VERSION
+  spec.authors       = ['Luke Imhoff']
+  spec.email         = ['luke_imhoff@rapid7.com']
+  spec.summary       = 'YARD plugin that add Metasploit::ERDs to namespaces and classes'
+  spec.description   = "YARD plugin that uses metasploit-erd to add Entity-Relationship Diagrams to each namespace " \
+                       "Module and ActiveRecord::Base subclass's documentation."
+  spec.homepage      = 'https://github.com/rapid7/yard-metasploit-erd'
+  spec.license       = 'BSD-3-clause'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+
+  # Generates namespace Module and Class<ActiveRecord::Base> specific ERDs for use in templates
+  spec.add_runtime_dependency 'metasploit-erd', '0.0.1'
+  # RailsERD::Domain is used directly to generate the _index.html ERD.
+  spec.add_runtime_dependency 'rails-erd'
+  # documentation
+  # 0.8.7.4 has a bug where setters are not documented when @!attribute is used
+  spec.add_runtime_dependency 'yard', '<= 0.8.7.4'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: yard-metasploit-erd
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Luke Imhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: metasploit-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+description: YARD plugin that uses metasploit-erd to add Entity-Relationship Diagrams
+  to each namespace Module and ActiveRecord::Base subclass's documentation.
+email:
+- luke_imhoff@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/example/images/mdm/module.erd.png
+- doc/example/images/mdm/module/author.erd.png
+- lib/tasks/yard.rake
+- lib/yard-metasploit-erd.rb
+- lib/yard/metasploit/erd.rb
+- lib/yard/metasploit/erd/version.rb
+- spec/spec_helper.rb
+- spec/yard/metasploit/erd/version_spec.rb
+- spec/yard/metasploit/erd_spec.rb
+- templates/default/class/html/entity_relationship_diagram.erb
+- templates/default/class/html/setup.rb
+- templates/default/layout/html/entity_relationship_diagram.erb
+- templates/default/layout/html/setup.rb
+- templates/default/module/html/entity_relationship_diagram.erb
+- templates/default/module/html/setup.rb
+- yard-metasploit-erd.gemspec
+homepage: https://github.com/rapid7/yard-metasploit-erd
+licenses:
+- BSD-3-clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: YARD plugin that add Metasploit::ERDs to namespaces and classes
+test_files:
+- spec/spec_helper.rb
+- spec/yard/metasploit/erd/version_spec.rb
+- spec/yard/metasploit/erd_spec.rb
+has_rdoc: