metasploit-erd 0.0.1

data/spec/metasploit/erd_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# require before 'metasploit/erd' so coverage is shown for files required by '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 'metasploit/erd'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+spec_pathname = Pathname.new(__FILE__).realpath.parent
+glob_pathname = spec_pathname.join('support', '**', '*.rb')
+
+Dir[glob_pathname].each do |f|
+  require f
+end

data/spec/support/shared/contexts/active_record_base_connection.rb

@@ -0,0 +1,12 @@
+shared_context 'ActiveRecord::Base connection' do
+  before(:each) do
+    ActiveRecord::Base.establish_connection(
+        adapter: 'sqlite3',
+        database: ':memory:'
+    )
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.disconnect!
+  end
+end

data/spec/support/shared/contexts/active_record_base_descendants_cleaner.rb

@@ -0,0 +1,11 @@
+shared_context 'ActiveRecord::Base.descendants cleaner' do
+  before(:each) do
+    expect(ActiveRecord::Base.direct_descendants).to be_empty
+  end
+
+  after(:each) do
+    # `ActiveSupport::DescendantsTracker.clear` will not clear ActiveRecord::Base subclasses because
+    # ActiveSupport::Dependencies is loaded
+    ActiveRecord::Base.direct_descendants.clear
+  end
+end

data/spec/support/shared/examples/metasploit/erd/clusterable.rb

@@ -0,0 +1,284 @@
+shared_examples_for 'Metasploit::ERD::Clusterable' do
+  include_context 'ActiveRecord::Base connection'
+
+  #
+  # Methods
+  #
+
+  def migrate
+    ActiveRecord::Migration.verbose = false
+
+    ActiveRecord::Migration.create_table :dummy_factories do |t|
+      t.timestamps
+    end
+
+    ActiveRecord::Migration.create_table :dummy_widgets do |t|
+      t.references :factory
+
+      t.timestamps
+    end
+  end
+
+  #
+  # lets
+  #
+
+  let(:dummy_module) {
+    Module.new do
+      def self.table_name_prefix
+        'dummy_'
+      end
+    end
+  }
+
+  let(:dummy_factory) {
+    Class.new(ActiveRecord::Base) do
+      has_many :widgets,
+               class_name: 'Dummy::Widget',
+               inverse_of: :factory
+    end
+  }
+
+  let(:dummy_widget) {
+    Class.new(ActiveRecord::Base) do
+      belongs_to :factory,
+                 class_name: 'Dummy::Factory',
+                 inverse_of: :widgets
+    end
+  }
+
+  #
+  # Callbacks
+  #
+
+  before(:each) do
+    migrate
+
+    stub_const('Dummy', dummy_module)
+    stub_const('Dummy::Factory', dummy_factory)
+    stub_const('Dummy::Widget', dummy_widget)
+  end
+
+  context '#diagram' do
+    subject(:diagram) {
+      entity.diagram(*arguments)
+    }
+
+    let(:arguments) {
+      []
+    }
+
+    it { should be_a Metasploit::ERD::Diagram }
+
+    context 'Metasploit::ERD::Diagram#create' do
+      subject(:create) {
+        diagram.create
+      }
+
+      #
+      # lets
+      #
+
+      let(:arguments) {
+        [
+            {
+                directory: directory
+            }
+        ]
+      }
+
+      let(:directory) {
+        spec_pathname.join('tmp')
+      }
+
+      let(:spec_pathname) {
+        Pathname.new(__FILE__).parent.parent.parent.parent.parent.parent
+      }
+
+      #
+      # Callbacks
+      #
+
+      before(:each) do
+        if directory.exist?
+          directory.rmtree
+        end
+      end
+
+      after(:each) do
+        directory.rmtree
+      end
+
+      context 'directory' do
+        context 'with existing' do
+          before(:each) do
+            directory.mkpath
+          end
+
+          it 'returns path where diagram was written' do
+            expect(create).to be_a String
+          end
+        end
+
+        context 'without existing' do
+          it 'creates directory' do
+            expect {
+              create
+            }.to change(directory, :directory?).to(true)
+          end
+
+          it 'returns path where diagram was written' do
+            expect(create).to be_a String
+          end
+        end
+      end
+
+    end
+
+    context 'Metasploit::ERD::Diagram#domain' do
+      subject(:domain) {
+        diagram.domain
+      }
+
+      it 'is #domain' do
+        entity_domain = entity.domain
+        allow(entity).to receive(:domain).and_return(entity_domain)
+
+        expect(domain).to eq(entity_domain)
+      end
+    end
+
+    context 'Metasploit::ERD::Diagram#options' do
+      subject(:options) {
+        diagram.options
+      }
+
+      context 'with :basename' do
+        let(:arguments) {
+          [
+              argument_options
+          ]
+        }
+
+        let(:argument_options) {
+          {
+              basename: argument_basename
+          }
+        }
+
+        context 'with nil' do
+          let(:argument_basename) {
+            nil
+          }
+
+          it 'is not retained' do
+            expect(options).not_to have_key(:basename)
+          end
+        end
+
+        context 'without nil' do
+          let(:argument_basename) {
+            'basename.extra.extension'
+          }
+
+          it 'is not retained' do
+            expect(options).not_to have_key(:basename)
+          end
+
+          context '[:filename]' do
+            subject(:filename) {
+              options[:filename]
+            }
+
+            it 'ends with :basename' do
+              expect(filename).to end_with(argument_basename)
+            end
+          end
+
+          context '[:directory]' do
+            let(:argument_options) {
+              super().merge(
+                  directory: argument_directory
+              )
+            }
+
+            context 'with nil' do
+              let(:argument_directory) {
+                nil
+              }
+
+              it 'is not retained' do
+                expect(options).not_to have_key(:directory)
+              end
+
+              context '[:filename]' do
+                subject(:filename) {
+                  options[:filename]
+                }
+
+                it 'uses Dir.pwd for the directory' do
+                  expect(File.dirname(filename)).to eq(Dir.pwd)
+                end
+              end
+            end
+
+            context 'without nil' do
+              let(:argument_directory) {
+                '/a/directory'
+              }
+
+              it 'is not retained' do
+                expect(options).not_to have_key(:directory)
+              end
+
+              context '[:filename]' do
+                subject(:filename) {
+                  options[:filename]
+                }
+
+                it 'uses :directory for the directory' do
+                  expect(File.dirname(filename)).to eq(argument_directory)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      context '[:directory]' do
+        it 'is not retained' do
+          expect(options).not_to have_key(:directory)
+        end
+      end
+
+      context '[:title]' do
+        subject(:title) {
+          options[:title]
+        }
+
+        it { should be_a String }
+      end
+    end
+  end
+
+  context '#domain' do
+    subject(:domain) do
+      entity.domain
+    end
+
+    it 'creates RailsERD::Domain from #cluster Metasploit::ERD::Cluster#class_set' do
+      # ensures entity's class defined cluster
+      cluster = entity.cluster
+      class_set = cluster.class_set
+
+      expect(entity).to receive(:cluster).and_return(cluster)
+      expect(cluster).to receive(:class_set).and_return(class_set)
+      expect(RailsERD::Domain).to receive(:new).with(
+                                      class_set,
+                                      hash_including(warn: false)
+                                  )
+
+      domain
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: metasploit-erd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luke Imhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 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.
+email:
+- luke_imhoff@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/metasploit/erd.rb
+- lib/metasploit/erd/cluster.rb
+- lib/metasploit/erd/clusterable.rb
+- lib/metasploit/erd/diagram.rb
+- lib/metasploit/erd/entity.rb
+- lib/metasploit/erd/entity/class.rb
+- lib/metasploit/erd/entity/namespace.rb
+- lib/metasploit/erd/relationship.rb
+- lib/metasploit/erd/version.rb
+- lib/tasks/yard.rake
+- metasploit-erd.gemspec
+- spec/metasploit/erd/cluster_spec.rb
+- spec/metasploit/erd/diagram_spec.rb
+- spec/metasploit/erd/entity/class_spec.rb
+- spec/metasploit/erd/entity/namespace_spec.rb
+- spec/metasploit/erd/relationship_spec.rb
+- spec/metasploit/erd/version_spec.rb
+- spec/metasploit/erd_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/contexts/active_record_base_connection.rb
+- spec/support/shared/contexts/active_record_base_descendants_cleaner.rb
+- spec/support/shared/examples/metasploit/erd/clusterable.rb
+homepage: https://github.com/rapid7/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: Extensions to rails-erd to find clusters of models to generate subdomains
+  specific to each model
+test_files:
+- spec/metasploit/erd/cluster_spec.rb
+- spec/metasploit/erd/diagram_spec.rb
+- spec/metasploit/erd/entity/class_spec.rb
+- spec/metasploit/erd/entity/namespace_spec.rb
+- spec/metasploit/erd/relationship_spec.rb
+- spec/metasploit/erd/version_spec.rb
+- spec/metasploit/erd_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/contexts/active_record_base_connection.rb
+- spec/support/shared/contexts/active_record_base_descendants_cleaner.rb
+- spec/support/shared/examples/metasploit/erd/clusterable.rb
+has_rdoc: