yard-metasploit-erd 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e6303498ce000429403508f9ccfd875ea9f39de
-  data.tar.gz: 6f0e47e60eee6af9589a2fe02ee91267f3fde591
+  metadata.gz: 3e44e5d1bc0103558c99e86f0618be3a3a22f1f3
+  data.tar.gz: 0e1b4961f47866e39da48aa255f276433bdd69fc
 SHA512:
-  metadata.gz: 4b8ffafe092628c1ee967627843fc93a6d2c6ffbd0d97219f075e3e001e611f0ccc1e0f8eaf497395f4703d9720afe65ba9698298ea5971a2cc5bcaba8596244
-  data.tar.gz: c7c984e77c8ee7991482a5215fe80963dd87b91800cfff6bd7c40280208be3895bb486e44a06b27852896fdf728349cfe64e05b35cb3aeb9d2ce428514afd819
+  metadata.gz: e5f74637fdf9a722e164453b5418e833e53d89ae3655622f7fc41214339bec2f9bd08ca64d05b5b5a5c09d03a891c4cf212a7c14c4299550b038d381dfc806c4
+  data.tar.gz: 172f00e3ddac81cb804e87ac3721762de8c6f0399d1b1d7c1ee8abc4fd84b159dbf6f6ae6fda2a667c74bc23e906c8bd6dbcaa02770c7ca9f44d0c151c604ae7

data/.travis.yml

@@ -1,5 +1,6 @@
+cache: bundler
 language: ruby
 rvm:
   - 2.1
-  - jruby
-  - rbx
+script: bundle exec rake spec yard
+sudo: false

data/CONTRIBUTING.md

@@ -40,9 +40,15 @@ Make your changes or however many commits you like, committing each with `git co
 
 ### Pre-Pull Request Testing
 
+#### Specs
 1. Run specs one last time before opening the Pull Request: `rake spec`
 2. Verify there was no failures.
 
+#### Documentation
+1. Run yard one last time before opening the Pull Request: `rake yard`
+2. Verify there are no warnings indicating you didn't mistype any links or tags.
+3. Verify there is 100% documented indicating you documented all the new Modules, Classes, Constants, and Methods.
+
 ### Push
 
 Push your branch to your fork on gitub: `git push TYPE/ISSUE/SUMMARY`
@@ -60,6 +66,11 @@ Push your branch to your fork on gitub: `git push TYPE/ISSUE/SUMMARY`
 ## `rake spec`
 - [ ] `rake spec`
 - [ ] VERIFY no failures
+
+## `rake yard`
+- [ ] `rake yard`
+- [ ] VERIFY no warnings
+- [ ] VERIFY 100% documented
 ```
 
 You should also include at least one scenario to manually check the changes outside of specs.

data/RELEASING.md

@@ -68,12 +68,6 @@ decide to remain pre-1.0.0 or (2) advance to 1.0.0.
 
 ## Release to rubygems.org
 
-## jruby
-- [ ] `rvm use jruby@yard-metasploit-erd`
-- [ ] `rm Gemfile.lock`
-- [ ] `bundle install`
-- [ ] `rake release`
-
 ## ruby-2.1
 - [ ] `rvm use ruby-2.1@yard-metasploit-erd`
 - [ ] `rm Gemfile.lock`

data/Rakefile

@@ -1,10 +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/lib/yard/metasploit/erd/version.rb

@@ -10,9 +10,9 @@ module YARD
         # The major version number.
         MAJOR = 0
         # The minor version number, scoped to the {MAJOR} version number.
-        MINOR = 0
+        MINOR = 1
         # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
-        PATCH = 4
+        PATCH = 0
 
         #
         # Module Methods

data/yard-metasploit-erd.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
 
   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', '~> 3.1'
 
   # Generates namespace Module and Class<ActiveRecord::Base> specific ERDs for use in templates
-  spec.add_runtime_dependency 'metasploit-erd', '0.0.1'
+  spec.add_runtime_dependency 'metasploit-erd', '0.1.0'
   # RailsERD::Domain is used directly to generate the _index.html ERD.
   spec.add_runtime_dependency 'rails-erd'
   spec.add_runtime_dependency 'yard'

metadata

@@ -1,126 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: yard-metasploit-erd
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Luke Imhoff
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-  prerelease: false
-  type: :development
 - !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: 0.1.3
-  prerelease: false
+        version: '1.0'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: metasploit-erd
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: metasploit-erd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  prerelease: false
+        version: 0.1.0
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: rails-erd
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails-erd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: yard
+  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'
-  prerelease: false
   type: :runtime
-description: YARD plugin that uses metasploit-erd to add Entity-Relationship Diagrams to each namespace Module and ActiveRecord::Base subclass's documentation.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -131,7 +146,6 @@ files:
 - UPGRADING.md
 - 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
@@ -149,28 +163,28 @@ homepage: https://github.com/rapid7/yard-metasploit-erd
 licenses:
 - BSD-3-clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.5
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
 specification_version: 4
 summary: YARD plugin that add Metasploit::ERDs to namespaces and classes
 test_files:
 - spec/lib/yard/metasploit/erd/version_spec.rb
 - spec/lib/yard/metasploit/erd_spec.rb
 - spec/spec_helper.rb
-has_rdoc:
+has_rdoc: 

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