metasploit-yard 1.0.2-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8ead908270612fce275fe39a9fc8d48367ad12a
+  data.tar.gz: bd5abd6f072446ffd62001434da7bb8d294e733f
+SHA512:
+  metadata.gz: d7c7ea17a98d93487312362da2c32fe7f60475c848488b7ec7a83c002a4755d5d8936e8dfaf8d3ca68d84757e6fbcfa9f758d2bf6d51c74ae0c6b9561d0814a3
+  data.tar.gz: 1a790f9eb46a0c681aa2d68d9ae57481e396f8d8ef5541c3eb0eb805592ce80e17eb9b51557902df2a21d2ae5411f7abe5f5c99c67727eaa33475cf4e97c5223

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,24 @@
+# Rubymine
+/.idea
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# RVM
+.ruby-version
+.ruby-gemset

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,21 @@
+env:
+  global:
+    - secure: "IxVtzpee/XU/Qkw9g88uXX9GtQkzeUNVx05LYpfBuZWjQZWggrTp4k91HyquBNZkg30I5l7iHLbuhMB2c2SyNPN1OfkkhWZjeerJzRtaGDn7RXTAfdKUCtDceZPnl9Kv4Wbk6I2pVsXpROOP0VaPjLgod7aJqHfnw4AvP8yZbDg="
+  matrix:
+    - RAKE_TASK=cucumber
+    - RAKE_TASK=spec
+language: ruby
+matrix:
+  # documentation coverage is not influenced by ruby implementation, so only run once
+  include:
+    - rvm: 2.1
+      env: RAKE_TASK=yard
+rvm:
+  - '1.9.3'
+  - '2.0'
+  - '2.1'
+  - 'ruby-head'
+  # jruby fails rake cucumber (see MSP-11240)
+  # - 'jruby-19mode'
+  - 'rbx-2.2'
+script: "bundle exec rake $RAKE_TASK"

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--private
+--protected
+{app,lib}/**/*.rb
+-
+CONTRIBUTING.md
+README.md

data/CONTRIBUTING.md

@@ -0,0 +1,178 @@
+# Contributing
+
+## Forking
+
+[Fork this repository](https://github.com/rapid7/metasploit-yard/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-yard/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/yard/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`: 
+```
+# The prerelease version, scoped to the {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, commiting 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 push TYPE/ISSUE/SUMMARY`
+
+### Pull Request
+
+* [Create new Pull Request](https://github.com/rapid7/metasploit-yard/compare/)
+* Add a Verification Steps comment
+
+```
+# Verification Steps
+
+- [ ] `bundle install`
+
+## `rake cucumber`
+- [ ] `rake cucumber`
+- [ ] VERIFY no failures
+
+## `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/yard/version.rb) so that [version_spec.rb](spec/lib/metasploit/yard/version_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/yard/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/yard/version.rb`
+- [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
+
+## Gem build
+- [ ] gem build *.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`
+```
+
+* Add a 'Release Steps' comment
+
+The 'Release Steps' are a reminder to the reviewer of the Pull Request of how to release the gem.
+
+```
+# Release
+
+Complete these steps on DESTINATION
+
+## `VERSION`
+
+### Incompatible API changes
+
+If your changes are incompatible with the previous branch's API, such as removing APIs or removing parts of API
+signatures:
+
+- [ ] Increment [`MAJOR`](lib/metasploit/yard/version.rb)
+- [ ] Reset [`MINOR`](lib/metasploit/yard/version.rb) to `0`
+- [ ] Reset [`PATCH`](lib/metasploit/yard/version.rb) to `0`
+- [ ] Commit
+
+### Compatible API changes
+
+If your changes are compatible with the previous branch's API, such as adding an API or adding options or optional
+positional arguments to an API:
+
+- [ ] Increment [`MINOR`](lib/metasploit/yard/version.rb)
+- [ ] Reset [`PATCH`](lib/metasploit/yard/version.rb) to `0`.
+- [ ] Commit
+
+### Compatible bug fixes
+
+If your changes are a bug fix that don't impact the APIs, then:
+
+- [ ] Increment [`PATCH`](lib/metasploit/yard/version.rb)
+- [ ] Commit
+
+## JRuby
+- [ ] `rvm use jruby@metasploit-yard`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+
+## MRI Ruby
+- [ ] `rvm use ruby-2.1@metasploit-yard`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+When releasing new versions, the following projects may need to be updated:
+
+(no current downstream dependents)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metasploit-yard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD-3-clause License
+
+Copyright (c) 2013-2014, Rapid7, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+.
+    * Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+.
+    * 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.
+.
+    * Neither the name of Rapid7, Inc. 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,114 @@
+# Metasploit::Yard [![Build Status](https://travis-ci.org/rapid7/metasploit-yard.svg?branch=master)](https://travis-ci.org/rapid7/metasploit-yard)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-yard.png)](https://codeclimate.com/github/rapid7/metasploit-yard)[![Test Coverage](https://codeclimate.com/github/rapid7/metasploit-yard/badges/coverage.svg)](https://codeclimate.com/github/rapid7/metasploit-yard)[![Coverage Status](https://img.shields.io/coveralls/rapid7/metasploit-yard.svg)](https://coveralls.io/r/rapid7/metasploit-yard)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-yard.svg)](https://gemnasium.com/rapid7/metasploit-yard)[![Gem Version](https://badge.fury.io/rb/metasploit-yard.svg)](http://badge.fury.io/rb/metasploit-yard)[![Inline docs](http://inch-ci.org/github/rapid7/metasploit-yard.svg?branch=master)](http://inch-ci.org/github/rapid7/metasploit-yard)[![PullReview stats](https://www.pullreview.com/github/rapid7/metasploit-yard/badges/master.svg)](https://www.pullreview.com/github/rapid7/metasploit-yard/reviews/master)
+
+`metasploit-yard` holds the YARD rake task, in [`lib/tasks/yard.rake`](lib/tasks.yard.rake) used across all
+`metasploit-*` projects.  The rake task is defined here to prevent code duplication and task redefinitions in a gem's
+dependencies leading to duplicate task actions, which led to yard docs being generated up to 6 times in some projects.
+
+## Versioning
+
+`Metasploit::Yard` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch
+should set `Metasploit::Yard::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`
+and the `PRERELEASE` section of `Metasploit::Yard::VERSION` does not exist.
+
+## Documentation
+
+`Metasploit::Yard` is documented using YARD.  In fact, it uses the same rake task as it exports for other gems to use.
+
+### Generate
+
+   rake yard
+   
+### Reading
+
+   open doc/frames.html
+
+## Installation
+
+### Project with only a Gemfile
+
+Add this line to your application's `Gemfile`:
+
+    gem 'metasploit-yard', group: :development
+
+And then execute:
+
+    $ bundle
+
+### Project with a gemspec
+
+Add this line to your gem's gemspec:
+
+    spec.add_development_dependency 'metasploit-yard'
+
+And then execute:
+
+   $ bundle
+   
+### Otherwise
+
+Or install it yourself as:
+
+    $ gem install metasploit-yard
+
+## Setup
+
+### In a Rails::Application
+
+`metasploit-yard` has a `Rails::Railtie`, [`Metasploit::Yard::Railtie`](lib/metasploit/yard/railtie) that will
+automatically be loaded if `Rails` is defined when `metasploit/yard` is required.  `Metasploit::Yard::Railtie` will
+automatically load [`yard.rake`](lib/tasks/yard.rake) for your Rails project.
+
+### In a Rails::Engine or non-Rails gem
+
+Add the following to your `Rakefile` to load `yard.rake` from `metasploit-yard`
+
+    # 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
+
+## Usage
+
+    $ rake yard
+
+### CI Integration
+
+`rake yard` will automatically call `rake yard:stats`.  `rake yard:stats` will exit with status `0` only if there are
+no undocumented objects.  If there are undocumented objects, then `rake yard:stats` will exist with status `1`.  If
+you want to lower the threshold of undocumented objects that are allowed from `100.0` percentage, set the value in
+`config/yard-stats-threshold` as a float.
+
+By adding `rake yard:stats` to the tasks run by your CI server, you can have your build fail if documentation slips
+below the threshold.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Testing
+
+`Metasploit::Yard` is tested using [RSpec](https://github.com/rspec/rspec)
+
+### Dependencies
+
+Remove your `Gemfile.lock` so you test with the latest compatible dependencies as will be done on
+[travis-ci](https://travis-ci.org/rapid7/metasploit-yard)
+
+    rm Gemfile.lock
+    bundle install
+
+### Database Setup
+
+To run the specs, access to the database is required, so setup the `database.yml`, create the database, and run the
+migrations:
+
+    cp spec/dummy/config/database.yml.example spec/dummy/config/database.yml
+    # fill in passwords
+    edit spec/dummy/config/database.yml
+    rake db:create db:migrate
+
+### Running
+
+    rake spec