metasploit-erd 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWM3NzNkYTA5NTA2NmYxZGIwMDdkYTA5OTcxMTUwOGZlNDM0MTcxYw==
+  data.tar.gz: !binary |-
+    ZmFmYjJjYWJkYzYyMDkwNWZhODNmNTQyOTFkNTk1NjMyODNmYmVhYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZWNmNWIyZjc0YTBkMDMzNWNkY2JmOTVkZGNiNWNlZTQzM2RkYmY3MDMxMTcx
+    MmFjNDZhNmVlNWQ2MjQzZDdkZWJmZDUxZWY2NWE2ZTQ4ZjcwNWNhMDA0MWNm
+    NmQ3MDBlNGIzNjBjZjY3NGZkOWEyNTAwNDkyZmUyZjUwMTNmNzc=
+  data.tar.gz: !binary |-
+    NmNhZDFmOGE1ODI4MjhjZmMyYTFmMmQ5YjUzYzAzMjgzZWJjNzRhNzYwZGY3
+    OGFlZTMxZjI5YTA5NmYyMjUxYWFlZjEwYjYxNzAyNWQ1YjliNjE1YTM5ODI2
+    Yjg1NDE0MDg2NzJhOTUyZjU1MGQ1ZTI3ZDcxYzI2N2E4ZjM0ZTM=

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,26 @@
+# bundler
+.bundle
+
+# Rubymine
+.idea
+
+# rvm files should not be checked in as multiple rubies are supported in the CI builds
+.ruby-gemset
+.ruby-version
+
+# YARD
+.yardoc
+doc
+
+# 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,3 @@
+--format documentation
+--color
+--backtrace

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 @@
+before_install:
+  - sudo apt-get update -qq
+  # graphviz is needed to specs that check that diagram create works
+  - sudo apt-get install -qq graphviz
+language: ruby
+rvm:
+  - 1.9.3

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metasploit-erd.gemspec
+gemspec
+
+group :development 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
+  # in-memory database for ActiveRecord association traversal
+  gem 'sqlite3'
+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,44 @@
+# Metasploit::ERD [![Build Status](https://travis-ci.org/rapid7/metasploit-erd.svg?branch=feature/port)](https://travis-ci.org/rapid7/metasploit-erd)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-erd.png)](https://codeclimate.com/github/rapid7/metasploit-erd)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit-erd/badge.png)](https://coveralls.io/r/rapid7/metasploit-erd)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-erd.png)](https://gemnasium.com/rapid7/metasploit-erd)[![Gem Version](https://badge.fury.io/rb/metasploit-erd.png)](http://badge.fury.io/rb/metasploit-erd)
+
+Traces the `belongs_to` associations on `ActiveRecord::Base.descendants` to find the minimum cluster in which all
+foreign keys are fulfilled in the Entity-Relationship Diagram.'
+
+## Versioning
+
+`Metasploit::ERD` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
+should set `Metasploit::ERD::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
+and the `PRERELEASE` section of `Metasploit::ERD::VERSION` does not exist.
+
+## Installation
+
+### Gem
+
+Add this line to your application's Gemfile:
+
+    gem 'metasploit-erd'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metasploit-erd
+
+### System tools
+
+In order to generate the diagrams as PNGs, graphviz is used, which may have issues when use on OSX Mavericks.  If you
+get 'CoreTest performance note' messages when running 'rake yard', you should reinstall graphviz as follows:
+`brew reinstall graphviz --with-bindings --with-freetype --with-librsvg --with-pangocairo`.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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/metasploit/erd.rb

@@ -0,0 +1,35 @@
+#
+# Standard Library
+#
+
+require 'set'
+
+#
+# Gems
+#
+
+require 'active_record'
+require 'active_support/dependencies/autoload'
+
+#
+# Project
+#
+
+require "metasploit/erd/version"
+
+# Shared namespace for metasploit gems; used in {https://github.com/rapid7/metasploit-concern metasploit-concern},
+# {https://github.com/rapid7/metasploit-erd metasploit-erd},
+# {https://github.com/rapid7/metasploit-framework metasploit-framework}, and
+# {https://github.com/rapid7/metasploit-model metasploit-model}
+module Metasploit
+  # The namespace for this gem.
+  module ERD
+    extend ActiveSupport::Autoload
+
+    autoload :Cluster
+    autoload :Clusterable
+    autoload :Diagram
+    autoload :Entity
+    autoload :Relationship
+  end
+end

data/lib/metasploit/erd/cluster.rb

@@ -0,0 +1,49 @@
+# A cluster of `Class<ActiveRecord::Base>` that are connected by `belongs_to` associations so that all foreign keys are
+# paired with their appropriate primary keys.
+class Metasploit::ERD::Cluster
+  #
+  # Instance Methods
+  #
+
+  # @param roots [Array<Class<ActiveRecord::Base>>] starting `ActiveRecord::Base` subclasses to seed {#class_set}.
+  def initialize(*roots)
+    class_queue.concat(roots)
+  end
+
+  # Clases that are reachable through `belongs_to` associations on classes passed as `roots` to {#initialize}.
+  #
+  # @return [Set<Class<ActiveRecord::Base>>]
+  def class_set
+    until class_queue.empty?
+      klass = class_queue.pop
+      # add immediately to visited set in case there are recursive associations
+      visited_class_set.add klass
+
+      class_entity = Metasploit::ERD::Entity::Class.new(klass)
+
+      class_entity.class_set.each do |klass|
+        unless visited_class_set.include? klass
+          class_queue << klass
+        end
+      end
+
+      superclass = klass.superclass
+
+      unless superclass == ActiveRecord::Base || visited_class_set.include?(superclass)
+        class_queue << superclass
+      end
+    end
+
+    visited_class_set
+  end
+
+  private
+
+  def class_queue
+    @class_queue ||= []
+  end
+
+  def visited_class_set
+    @visited_class_set ||= Set.new
+  end
+end

data/lib/metasploit/erd/clusterable.rb

@@ -0,0 +1,39 @@
+require 'rails_erd/domain'
+
+# Adds {#domain} and {#diagram} to any class that responds to `#cluster`.
+module Metasploit::ERD::Clusterable
+  # Diagram using {#domain}.
+  #
+  # @param options (see Metasploit::ERD::Diagram#initialize)
+  # @option options (see Metasploit::ERD::Diagram#initialize)
+  # @option options [String] :basename The basename to use for the `:filename` option.  Only use only if not `nil`.
+  # @option options [String] :diretory (Dir.pwd) The directory to use for the `:filename` options.  Only used if
+  #   `:basename` is not `nil`.
+  # @return [Metasploit::ERD:Diagram]
+  def diagram(options={})
+    merged_options = options.except(:basename, :directory)
+    basename = options[:basename]
+
+    if basename
+      directory = options[:directory]
+      # separate line so coverage can show this case is tested
+      directory ||= Dir.pwd
+
+      merged_options[:filename] = File.join(directory, basename)
+    end
+
+    Metasploit::ERD::Diagram.new(domain, merged_options)
+  end
+
+  # Domain restricted to `#cluster` {Metasploit::ERD::Cluster#class_set}
+  #
+  # @return [RailsERD::Domain]
+  def domain
+    RailsERD::Domain.new(
+        cluster.class_set,
+        # don't warn about missing entities in domain since only belongs_to associations are traced in the cluster and
+        # not has_many associations.
+        warn: false
+    )
+  end
+end

data/lib/metasploit/erd/diagram.rb

@@ -0,0 +1,89 @@
+require 'rails_erd/diagram/graphviz'
+
+# A diagram specialized with default options that work well with {Metasploit::ERD::Clusterable#domain}.
+class Metasploit::ERD::Diagram < RailsERD::Diagram::Graphviz
+  #
+  # CONSTANTS
+  #
+
+  # Enable all attributes
+  ATTRIBUTES = [
+      :content,
+      :foreign_keys,
+      :primary_keys,
+      :timestamps
+  ]
+
+  # File type that work for embedding in web pages and is lossless.
+  FILETYPE = :png
+
+  # Only show direct relationships because anything indirect can be found by tracing the direct arrows and only showing
+  # direct relationships cuts down on cluster
+  INDIRECT = false
+
+  # Show inheritance for Single Table Inheritance
+  INHERITANCE = true
+
+  # Use crowsfoot notation since its what metasploit uses for manually drawn and graffle diagrams.
+  NOTATION = :crowsfoot
+
+  # Show polymorphic association connections as they are traced by
+  # {Metasploit::ERD::Relationship#polymorphic_class_set}.
+  POLYMORPHISM = true
+
+  # Default options for {#initialize}
+  DEFAULT_OPTIONS = {
+      attributes: ATTRIBUTES,
+      filetype: FILETYPE,
+      indirect: INDIRECT,
+      inheritance: INHERITANCE,
+      notation: NOTATION,
+      polymorphism: POLYMORPHISM
+  }
+
+  #
+  # Callbacks
+  #
+
+  # Callbacks are not inherited normally, so this emulates inheriting
+  callbacks.merge!(superclass.send(:callbacks))
+
+  # super() for save
+  supersave = callbacks[:save]
+
+  # Automatically create parent directory if it does not exist.
+  save {
+    parent = Pathname.new(filename).parent
+
+    unless parent.directory?
+      parent.mkpath
+    end
+
+    instance_eval &supersave
+  }
+
+  #
+  # Instance Methods
+  #
+
+  # @param domain [RailsERD::Domain] domain to diagram
+  # @param options [Hash{Symbol => Object}] options controlling what to include from domain and how to render diagram.
+  #   Defaults to {Metasploit::ERD::Diagram::DEFAULT_OPTIONS}.
+  # @option options [Array<Symbol>] :attributes (ATTRIBUTES) attributes of each entity (table) to include in the
+  #   diagram.
+  # @option options [String, Symbol] :filetype (FILETYPE) the file type of the generated diagram.  Supported formats
+  #   depend on formats supported by graphviz installation.
+  # @option options [Boolean] :indirect (INDIRECT) Whether to include indirect (`has_many through:`) relationships.
+  # @option options [Boolean] :inheritance (INHERITANCE) Whether to include Single Table Inheritance (STI) subclass
+  #   entities.
+  # @option options [Symbol] :notation (NOTATION) The cardinality notation to be used.  Refer to RailsERD
+  #   documentation for availble notations.
+  # @option options [:horizontal, :vertical] :orientation (:horizontal) The directory of the hierarchy of entities.
+  # @option options [Boolean] :polymorphism (POLYMORPHISM) Whether to include abstract or polymorphic pseudo-entities.
+  # @option options [String] :title Title for diagram.
+  def initialize(domain, options={})
+    super_options = DEFAULT_OPTIONS.merge(options)
+
+    super(domain, super_options)
+  end
+end

data/lib/metasploit/erd/entity.rb

@@ -0,0 +1,11 @@
+require 'active_support/dependencies/autoload'
+
+# Namespace for classes that function as Entities in Entity-Relationship diagrams, such as
+# {Metasploit::ERD::Entity::Class `ActiveRecord::Base` subclasses} or
+# {Metasploit::ERD::Entity::Namespace namespace `Module`s}.
+module Metasploit::ERD::Entity
+  extend ActiveSupport::Autoload
+
+  autoload :Class
+  autoload :Namespace
+end