metasploit-erd 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWM3NzNkYTA5NTA2NmYxZGIwMDdkYTA5OTcxMTUwOGZlNDM0MTcxYw==
-  data.tar.gz: !binary |-
-    ZmFmYjJjYWJkYzYyMDkwNWZhODNmNTQyOTFkNTk1NjMyODNmYmVhYQ==
+SHA1:
+  metadata.gz: ef6368293df1c4dfd65ee566fa8f21d28150a397
+  data.tar.gz: 4a276d31b8c8f608b8fa063eb95ea61b41ad0528
 SHA512:
-  metadata.gz: !binary |-
-    ZWNmNWIyZjc0YTBkMDMzNWNkY2JmOTVkZGNiNWNlZTQzM2RkYmY3MDMxMTcx
-    MmFjNDZhNmVlNWQ2MjQzZDdkZWJmZDUxZWY2NWE2ZTQ4ZjcwNWNhMDA0MWNm
-    NmQ3MDBlNGIzNjBjZjY3NGZkOWEyNTAwNDkyZmUyZjUwMTNmNzc=
-  data.tar.gz: !binary |-
-    NmNhZDFmOGE1ODI4MjhjZmMyYTFmMmQ5YjUzYzAzMjgzZWJjNzRhNzYwZGY3
-    OGFlZTMxZjI5YTA5NmYyMjUxYWFlZjEwYjYxNzAyNWQ1YjliNjE1YTM5ODI2
-    Yjg1NDE0MDg2NzJhOTUyZjU1MGQ1ZTI3ZDcxYzI2N2E4ZjM0ZTM=
+  metadata.gz: aac17a79ded8d3425edb1beeb0a9698a7168db8847b2fd17d973dbb40a89d849a0f258af4e8eb973dd24097f1b78f57cc47ee5a98b1f948329a326d3182cdeae
+  data.tar.gz: 003b1e194a7bb06c20091a060ae2755b6fe3928031e4a6e215c3810aaa1625aed22495a15315e07883ec16fb6fb7c1b235a818c0068dfd66b1cd32c5f27d57ae

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
---backtrace
+--require spec_helper

data/.travis.yml

@@ -4,4 +4,5 @@ before_install:
   - sudo apt-get install -qq graphviz
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.1
+script: bundle exec rake spec yard

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes

data/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# Contributing
+
+## Forking
+
+[Fork this repository](https://github.com/rapid7/metasploit-erd/fork)
+
+## Branching
+
+Branch names follow the format `TYPE/ISSUE/SUMMARY`.  You can create it with `git checkout -b TYPE/ISSUE/SUMMARY`.
+
+### `TYPE`
+
+`TYPE` can be `bug`, `chore`, or `feature`.
+
+### `ISSUE`
+
+`ISSUE` is either a [Github issue](https://github.com/rapid7/metasploit-erd/issues) or an issue from some other
+issue tracking software.
+
+### `SUMMARY`
+
+`SUMMARY` is is short summary of the purpose of the branch composed of lower case words separated by '-' so that it is a valid `PRERELEASE` for the Gem version.
+
+## Changes
+
+### `PRERELEASE`
+
+1. Update `PRERELEASE` to match the `SUMMARY` in the branch name.  If you branched from `master`, and [version.rb](lib/metasploit/erd/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`:
+```
+# The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version number.
+PRERELEASE = '<SUMMARY>'
+```
+2. `rake spec`
+3.  Verify the specs pass, which indicates that `PRERELEASE` was updated correctly.
+4. Commit the change `git commit -a`
+
+### Your changes
+
+Make your changes or however many commits you like, committing each with `git commit`.
+
+### Pre-Pull Request Testing
+
+1. Run specs one last time before opening the Pull Request: `rake spec`
+2. Verify there was no failures.
+
+### Push
+
+Push your branch to your fork on gitub: `git push TYPE/ISSUE/SUMMARY`
+
+### Pull Request
+
+* [Create new Pull Request](https://github.com/rapid7/metasploit-erd/compare/)
+* Add a Verification Steps to the description comment
+
+```
+# Verification Steps
+
+- [ ] `bundle install`
+
+## `rake spec`
+- [ ] `rake spec`
+- [ ] VERIFY no failures
+```
+
+You should also include at least one scenario to manually check the changes outside of specs.
+
+* Add a Post-merge Steps comment
+
+The 'Post-merge Steps' are a reminder to the reviewer of the Pull Request of how to update the [`PRERELEASE`](lib/metasploit/erd/version.rb) so that [version_spec.rb](spec/lib/metasploit/erd/version.rb_spec.rb) passes on the target branch after the merge.
+
+DESTINATION is the name of the destination branch into which the merge is being made.  SOURCE_SUMMARY is the SUMMARY from TYPE/ISSUE/SUMMARY branch name for the SOURCE branch that is being made.
+
+When merging to `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to master or the build will be broke on master.
+
+## Version
+- [ ] Edit `lib/metasploit/erd/version.rb`
+- [ ] Remove `PRERELEASE` and its comment as `PRERELEASE` is not defined on master.
+
+## Gem build
+- [ ] gem build *.gemspec
+- [ ] VERIFY the gem has no '.pre' version suffix.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin master`
+```
+
+When merging to DESTINATION other than `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to DESTINATION or the build will be broke on DESTINATION.
+
+## Version
+- [ ] Edit `lib/metasploit/erd/version.rb`
+- [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
+
+## Gem build
+- [ ] gem build metasploit-erd.gemspec
+- [ ] VERIFY the prerelease suffix has change on the gem.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin DESTINATION`
+```
+
+To update the [CHANGELOG.md](CHANGELOG.md) with the merged changes or release the merged code see
+[RELEASING.md](RELEASING.md)

data/RELEASING.md

@@ -0,0 +1,80 @@
+# Releasing
+
+These steps can be added to the Pull Request description's task list to remind the reviewer of how to release the
+gem.
+
+```
+# Release
+
+Complete these steps on DESTINATION
+
+## [CHANGELOG.md](CHANGELOG.md)
+
+### Terminology
+
+* "Enhancements" are widdening the API, such as by adding new classes or methods.
+* "Bug Fixes" are fixes to the implementation that do not affect the public API.  If the public API is affected then
+  the change should be listed as both a "Bug Fix" and either an "Enhancement" or "Incompatible Change" depending on how
+  the bug was fixed.
+* "Deprecations" are changes to the implementation that cause deprecation warnings to be issued for APIs which will be
+  removed in a future major release.  "Deprecations" are usually accompanied by an Enhancement that creates a new API
+  that is meant to be used in favor of the deprecated API.
+* "Incompatbile Changes" are the removal of classes or methods or new required arguments or setup that shrink the API.
+  It is best practice to make a "Deprecation" for the API prior to its removal.
+
+### Task List
+
+- [ ] Generate the list of changes since the last release: `git log v<LAST_MAJOR>.<LAST_MINOR>.<LAST_PATCH>..HEAD`
+- [ ] For each commit in the release, find the corresponding PR by search for the commit on Github.
+- [ ] For each PR, determine whether it is an Enhancement, Bug Fix, Deprecation, and/or Incompatible Change.  A PR can
+      be in more than one category, in which case it should be listed in each category it belongs, but with a category
+      specific description of the change.
+- [ ] Add an item to each category's list in the following format: `[#<PR>](https://github.com/rapid7/metasploit-erd/pull/<PR>) <consumer summary> - [@<github_user>](https://github.com/<github_user>)`
+      `consumer_summary` should be a summary of the Enhancement, Bug Fix, Deprecation, or Incompatible Change from a
+      downstream consumer's of the library's perspective.  `github_user` should be Github handle of the author of the
+      PR.
+- [ ] If you added any Deprecations or Incompatible Changes, then adding upgrading information to
+      [UPGRADING.md](UPGRADING.md)
+
+## `VERSION`
+
+The entries in the [CHANGELOG.md](CHANGELOG.md) can be used to help determine how the `VERSION` should be bumped.
+
+### Compatible changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains only Enhancements, Bug Fixes, and/or Deprecations for the Next Release then
+increment [`PATCH`](lib/metasploit/erd/version.rb).
+
+### Incompatible changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains any Incompatible Changes for the Next Release, then you can either (1)
+decide to remain pre-1.0.0 or (2) advance to 1.0.0.
+
+1. To remain pre-1..0.0, then increment [`MINOR`](lib/metasploit/erd/version.rb) and reset [`PATCH`](lib/metasploit/erd/version.rb) to `0`.
+2. To advance to 1.0.0, increment [`MAJOR`](lib/metasploit/erd/version.rb) and reset [`MINOR`](lib/metasploit/erd/version.rb and [`PATCH`](lib/metasploit/erd/version.rb) to `0`.
+
+## Setup [CHANGELOG.md](CHANGELOG.md) for next release
+
+- [ ] Change `Next Release` section name at the top of [CHANGELOG.md](CHANGELOG.md) to match the current `VERSION`.
+- [ ] Add a new `Next Release` section above the `VERSION`'s section you just renamed:
+<pre>
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes
+</pre>
+
+## Release to rubygems.org
+
+## ruby-2.1
+- [ ] `rvm use ruby-2.1@metasploit-erd`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+There are currently no known downstream dependencies

data/Rakefile

@@ -1,9 +1,14 @@
 require "bundler/gem_tasks"
+require 'bundler/setup'
 require "rspec/core/rake_task"
 
-require 'yard'
-load 'tasks/yard.rake'
-
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+# Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+gem_specification = Gem::Specification.find_all_by_name('metasploit-yard').first
+
+Dir[File.join(gem_specification.gem_dir, 'lib', 'tasks', '**', '*.rake')].each do |rake|
+  load rake
+end

data/UPGRADING.md

@@ -0,0 +1 @@
+No Deprecations or Incompatible Changes have been introduced at this time

data/lib/metasploit/erd/cluster.rb

@@ -21,9 +21,9 @@ class Metasploit::ERD::Cluster
 
       class_entity = Metasploit::ERD::Entity::Class.new(klass)
 
-      class_entity.class_set.each do |klass|
-        unless visited_class_set.include? klass
-          class_queue << klass
+      class_entity.class_set.each do |set_class|
+        unless visited_class_set.include? set_class
+          class_queue << set_class
         end
       end
 

data/lib/metasploit/erd/diagram.rb

@@ -59,7 +59,7 @@ class Metasploit::ERD::Diagram < RailsERD::Diagram::Graphviz
       parent.mkpath
     end
 
-    instance_eval &supersave
+    instance_eval(&supersave)
   }
 
   #

data/lib/metasploit/erd/version.rb

@@ -2,18 +2,29 @@ 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
+      #
+      # CONSTANTS
+      #
+
       # 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 = 1
+      MINOR = 1
+      # The patch number, scoped to the {MAJOR} and {MINOR} version numbers.
+      PATCH = 0
+
+      #
+      # Module Methods
+      #
 
-      # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the `PRERELEASE` in the
+      # The full version string, including the {Metasploit::ERD::Version::MAJOR},
+      # {Metasploit::ERD::Version::MINOR}, {Metasploit::ERD::Version::PATCH}, and optionally, the
+      # `Metasploit::ERD::Version::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.
+      # @return [String] '{Metasploit::ERD::Version::MAJOR}.{Metasploit::ERD::Version::MINOR}.{Metasploit::ERD::Version::PATCH}'
+      #   on master. '{Metasploit::ERD::Version::MAJOR}.{Metasploit::ERD::Version::MINOR}.{Metasploit::ERD::Version::PATCH}-PRERELEASE'
+      #   on any branch other than master.
       def self.full
         version = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
@@ -23,9 +34,24 @@ module Metasploit
 
         version
       end
+
+      # The full gem version string, including the {Metasploit::ERD::Version::MAJOR},
+      # {Metasploit::ERD::Version::MINOR}, {Metasploit::ERD::Version::PATCH}, and optionally, the
+      # `Metasploit::ERD::Version::PRERELEASE` in the
+      # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+      #
+      # @return [String] '{Metasploit::ERD::Version::MAJOR}.{Metasploit::ERD::Version::MINOR}.{Metasploit::ERD::Version::PATCH}'
+      #   on master.  '{Metasploit::ERD::Version::MAJOR}.{Metasploit::ERD::Version::MINOR}.{Metasploit::ERD::Version::PATCH}.PRERELEASE'
+      #   on any branch other than master.
+      def self.gem
+        full.gsub('-', '.pre.')
+      end
     end
 
-    # @see Version.full
+    # (see Version.gem)
+    GEM_VERSION = Version.gem
+
+    # (see Version.full)
     VERSION = Version.full
   end
 end

data/metasploit-erd.gemspec

@@ -5,7 +5,7 @@ require 'metasploit/erd/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'metasploit-erd'
-  spec.version       = Metasploit::ERD::VERSION
+  spec.version       = Metasploit::ERD::GEM_VERSION
   spec.authors       = ['Luke Imhoff']
   spec.email         = ['luke_imhoff@rapid7.com']
   spec.summary       = 'Extensions to rails-erd to find clusters of models to generate subdomains specific to each model'
@@ -19,9 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.1'
+
   spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'metasploit-version', '~> 0.1.3'
+  spec.add_development_dependency 'metasploit-yard', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 10.3'
-  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 
   # restrict from rails 4.0 to be compatible with rest of metasploit ecosystem.
   # @todo Update to work with rails 4 (MSP-9836)

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

@@ -0,0 +1,3 @@
+RSpec.describe Metasploit::ERD::Version do
+  it_should_behave_like 'Metasploit::Version Version Module'
+end

data/spec/lib/metasploit/erd_spec.rb

@@ -0,0 +1,4 @@
+RSpec.describe Metasploit::ERD do
+  it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+  it_should_behave_like 'Metasploit::Version VERSION constant'
+end

data/spec/metasploit/erd/cluster_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Metasploit::ERD::Cluster do
+RSpec.describe Metasploit::ERD::Cluster do
   include_context 'ActiveRecord::Base connection'
   include_context 'ActiveRecord::Base.descendants cleaner'
 
@@ -151,8 +149,8 @@ describe Metasploit::ERD::Cluster do
         []
       end
 
-      it { should be_a Set }
-      it { should be_empty }
+      it { is_expected.to be_a Set }
+      it { is_expected.to be_empty }
     end
   end
 end

data/spec/metasploit/erd/diagram_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Metasploit::ERD::Diagram do
+RSpec.describe Metasploit::ERD::Diagram do
   subject(:diagram) {
     described_class.new(*arguments)
   }
@@ -15,7 +13,7 @@ describe Metasploit::ERD::Diagram do
     RailsERD::Domain.new
   }
 
-  it { should be_a RailsERD::Diagram::Graphviz }
+  it { is_expected.to be_a RailsERD::Diagram::Graphviz }
 
   context 'CONSTANTS' do
     context 'ATTRIBUTES' do
@@ -23,10 +21,10 @@ describe Metasploit::ERD::Diagram do
         described_class::ATTRIBUTES
       }
 
-      it { should include :content }
-      it { should include :foreign_keys }
-      it { should include :primary_keys }
-      it { should include :timestamps }
+      it { is_expected.to include :content }
+      it { is_expected.to include :foreign_keys }
+      it { is_expected.to include :primary_keys }
+      it { is_expected.to include :timestamps }
     end
 
     context 'DEFAULT_OPTIONS' do
@@ -100,7 +98,7 @@ describe Metasploit::ERD::Diagram do
         described_class::FILETYPE
       }
 
-      it { should == :png }
+      it { is_expected.to eq(:png) }
     end
 
     context 'INDIRECT' do
@@ -108,7 +106,7 @@ describe Metasploit::ERD::Diagram do
         described_class::INDIRECT
       }
 
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
 
     context 'INHERITANCE' do
@@ -116,7 +114,7 @@ describe Metasploit::ERD::Diagram do
         described_class::INHERITANCE
       }
 
-      it { should be_true }
+      it { is_expected.to eq(true) }
     end
 
     context 'NOTATION' do
@@ -124,7 +122,7 @@ describe Metasploit::ERD::Diagram do
         described_class::NOTATION
       }
 
-      it { should == :crowsfoot }
+      it { is_expected.to eq(:crowsfoot) }
     end
 
     context 'POLYMORPHISM' do
@@ -132,7 +130,7 @@ describe Metasploit::ERD::Diagram do
         described_class::POLYMORPHISM
       }
 
-      it { should be_true }
+      it { is_expected.to eq(true) }
     end
   end
 
@@ -146,7 +144,7 @@ describe Metasploit::ERD::Diagram do
         callbacks[:each_entity]
       }
 
-      it { should_not be_nil }
+      it { is_expected.to_not be_nil }
 
       it 'uses RailsERD::Diagram::Graphviz.callbacks[:each_entity]' do
         expect(each_entity).to eq(RailsERD::Diagram::Graphviz.send(:callbacks)[:each_entity])
@@ -158,7 +156,7 @@ describe Metasploit::ERD::Diagram do
         callbacks[:each_relationship]
       }
 
-      it { should_not be_nil }
+      it { is_expected.to_not be_nil }
 
       it 'uses RailsERD::Diagram::Graphviz.callbacks[:each_relationship]' do
         expect(each_relationship).to eq(RailsERD::Diagram::Graphviz.send(:callbacks)[:each_relationship])
@@ -170,7 +168,7 @@ describe Metasploit::ERD::Diagram do
         callbacks[:each_specialization]
       }
 
-      it { should_not be_nil }
+      it { is_expected.to_not be_nil }
 
       it 'uses RailsERD::Diagram::Graphviz.callbacks[:each_specialization]' do
         expect(each_specialization).to eq(RailsERD::Diagram::Graphviz.send(:callbacks)[:each_specialization])
@@ -182,7 +180,7 @@ describe Metasploit::ERD::Diagram do
         callbacks[:save]
       }
 
-      it { should_not be_nil }
+      it { is_expected.to_not be_nil }
 
       it 'extends RailsERD::Diagram::Graphviz.callbacks[:save]' do
         expect(save).not_to eq(RailsERD::Diagram::Graphviz.send(:callbacks)[:save])
@@ -194,7 +192,7 @@ describe Metasploit::ERD::Diagram do
         callbacks[:setup]
       }
 
-      it { should_not be_nil }
+      it { is_expected.to_not be_nil }
 
       it 'uses RailsERD::Diagram::Graphviz.callbacks[:setup]' do
         expect(setup).to eq(RailsERD::Diagram::Graphviz.send(:callbacks)[:setup])

data/spec/metasploit/erd/entity/class_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Metasploit::ERD::Entity::Class do
+RSpec.describe Metasploit::ERD::Entity::Class do
   include_context 'ActiveRecord::Base.descendants cleaner'
 
   subject(:class_entity) {
@@ -116,7 +114,7 @@ describe Metasploit::ERD::Entity::Class do
         end
 
         it 'includes class once' do
-          expect(class_set).to have(1).items
+          expect(class_set.length).to eq(1)
           expect(class_set).to include(target)
         end
       end
@@ -208,7 +206,7 @@ describe Metasploit::ERD::Entity::Class do
         end
 
         it 'includes belongs_to target classes' do
-          expect(class_set).to include(belongs_to_target)
+          expect(class_set.map(&:name)).to include(belongs_to_target.name)
         end
 
         it 'does not include has_many target classes' do
@@ -218,7 +216,7 @@ describe Metasploit::ERD::Entity::Class do
     end
 
     context 'without belongs_to associations' do
-      it { should be_empty }
+      it { is_expected.to be_empty }
     end
   end
 

data/spec/metasploit/erd/entity/namespace_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Metasploit::ERD::Entity::Namespace do
+RSpec.describe Metasploit::ERD::Entity::Namespace do
   include_context 'ActiveRecord::Base.descendants cleaner'
 
   subject(:namespace_entity) {
@@ -107,7 +105,7 @@ describe Metasploit::ERD::Entity::Namespace do
     end
 
     context 'without ActiveRecord::Base descendants' do
-      it { should be_empty }
+      it { is_expected.to be_empty }
     end
   end
 

data/spec/metasploit/erd/relationship_spec.rb

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Metasploit::ERD::Relationship do
+RSpec.describe Metasploit::ERD::Relationship do
   include_context 'ActiveRecord::Base connection'
   include_context 'ActiveRecord::Base.descendants cleaner'
 
@@ -75,7 +73,7 @@ describe Metasploit::ERD::Relationship do
           end
         end
 
-        it { should be_a Set }
+        it { is_expected.to be_a Set }
 
         it 'includes association.klass' do
           expect(class_set).to include(association.klass)
@@ -137,7 +135,7 @@ describe Metasploit::ERD::Relationship do
           end
         end
 
-        it { should be_a Set }
+        it { is_expected.to be_a Set }
 
         it 'includes all classes that have has_many <inverse>, as: <reflection.name>' do
           expect(class_set).to eq(Set.new(things))
@@ -225,7 +223,7 @@ describe Metasploit::ERD::Relationship do
       end
     end
 
-    it { should be_a Set }
+    it { is_expected.to be_a Set }
 
     context 'with has_many as: <association.name>' do
       it 'includes classes' do

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
 
 # require before 'metasploit/erd' so coverage is shown for files required by 'metasploit/erd'
 require 'simplecov'
@@ -14,13 +14,95 @@ else
   ]
 end
 
+#
+# Gems
+#
+
+require 'metasploit/version'
+
+#
+# Project
+#
+
 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')
+roots = []
+roots << Pathname.new(__FILE__).realpath.parent.parent.to_path
+
+# Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+gem_specification = Gem::Specification.find_all_by_name('metasploit-version').first
+roots << gem_specification.gem_dir
+
+roots.each do |root|
+  Dir[File.join(root, 'spec', 'support', '**', '*.rb')].each do |f|
+    require f
+  end
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = :expect
+  end
+
+  config.expose_dsl_globally = false
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.patch_marshal_to_support_partial_doubles = false
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
 
-Dir[glob_pathname].each do |f|
-  require f
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
 end

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

@@ -1,4 +1,4 @@
-shared_context 'ActiveRecord::Base connection' do
+RSpec.shared_context 'ActiveRecord::Base connection' do
   before(:each) do
     ActiveRecord::Base.establish_connection(
         adapter: 'sqlite3',

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

@@ -1,4 +1,4 @@
-shared_context 'ActiveRecord::Base.descendants cleaner' do
+RSpec.shared_context 'ActiveRecord::Base.descendants cleaner' do
   before(:each) do
     expect(ActiveRecord::Base.direct_descendants).to be_empty
   end

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

@@ -1,4 +1,4 @@
-shared_examples_for 'Metasploit::ERD::Clusterable' do
+RSpec.shared_examples_for 'Metasploit::ERD::Clusterable' do
   include_context 'ActiveRecord::Base connection'
 
   #
@@ -68,7 +68,7 @@ shared_examples_for 'Metasploit::ERD::Clusterable' do
       []
     }
 
-    it { should be_a Metasploit::ERD::Diagram }
+    it { is_expected.to be_a Metasploit::ERD::Diagram }
 
     context 'Metasploit::ERD::Diagram#create' do
       subject(:create) {
@@ -256,7 +256,7 @@ shared_examples_for 'Metasploit::ERD::Clusterable' do
           options[:title]
         }
 
-        it { should be_a String }
+        it { is_expected.to be_a String }
       end
     end
   end

metadata

@@ -1,109 +1,137 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-erd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Luke Imhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2015-04-21 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: metasploit-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: metasploit-yard
+  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: 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'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.2'
 - !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
@@ -115,16 +143,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .simplecov
-- .travis.yml
-- .yardopts
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
+- UPGRADING.md
 - lib/metasploit/erd.rb
 - lib/metasploit/erd/cluster.rb
 - lib/metasploit/erd/clusterable.rb
@@ -134,15 +166,14 @@ files:
 - lib/metasploit/erd/entity/namespace.rb
 - lib/metasploit/erd/relationship.rb
 - lib/metasploit/erd/version.rb
-- lib/tasks/yard.rake
 - metasploit-erd.gemspec
+- spec/lib/metasploit/erd/version_spec.rb
+- spec/lib/metasploit/erd_spec.rb
 - 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
@@ -157,29 +188,29 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 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/lib/metasploit/erd/version_spec.rb
+- spec/lib/metasploit/erd_spec.rb
 - 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

data/lib/tasks/yard.rake

@@ -1,32 +0,0 @@
-# @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/spec/metasploit/erd/version_spec.rb

@@ -1,125 +0,0 @@
-require 'spec_helper'
-
-require 'active_support/core_ext/object/blank'
-
-describe 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
-          feature_regex = /(feature|staging)\/(?<prerelease>.*)/
-          match = branch.match(feature_regex)
-
-          if match
-            it 'matches the branch relative name' do
-              expect(prerelease).to eq(match[:prerelease])
-            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
-
-  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/metasploit/erd_spec.rb

@@ -1,15 +0,0 @@
-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