metasploit-version 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81bcd1c0b7d61d6e30a6fad4b1ac333dbb7581ab
+  data.tar.gz: 447c56d81b51a5437146f56d65eeeebc85122dff
+SHA512:
+  metadata.gz: 5dd755bdc48758ee7729493f496e9c216c845208b5fd84e02abab70fe6a02472e1b21aad3e50e0eb7d701f823191bf7e97f0adda2a1401d4e350d6d14aa50715
+  data.tar.gz: a12d1c52252e8c7f4daddd712a6c99cc1d380977d3f5a58a4783f99122271fec2e91fd2f73c699644c7a3aa1ae614bf9e27f9169ade1932634c55f971d289e77

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,32 @@
+# bundler
+.bundle
+
+# Rubymine
+.idea
+
+# aruba temporary files
+/tmp
+
+# simplecov
+coverage
+
+# @see http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+
+# yard
+/.yardoc
+/doc
+
+# RVM management
+.ruby-version
+.ruby-gemset
+
+# Built Rubygems
+pkg/*
+
+# YARD database
+.yardoc
+# coverage report directory for simplecov/Rubymine
+coverage
+# generated yardocs
+doc

data/.simplecov

@@ -0,0 +1,60 @@
+# 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
+
+require 'codeclimate-test-reporter'
+require 'coveralls'
+
+if ENV['TRAVIS'] == 'true'
+  formatters = []
+
+  # don't use `CodeClimate::TestReporter.start` as it will overwrite some .simplecov settings
+  if CodeClimate::TestReporter.run?
+    formatters << CodeClimate::TestReporter::Formatter
+  end
+
+  formatters << Coveralls::SimpleCov::Formatter
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    *formatters
+  ]
+end

data/.travis.yml

@@ -0,0 +1,26 @@
+env:
+  global:
+    secure: "G0LDGrupZ+RAFzoPwd6bjfrWfwoU/V9RTswQXIUNmi640rW/CP86a8F9hQcAXdUwy7Ag1cwmlEEv2JDDbLopQdNvkh8B7M3PSIpmJWlBsj+UPMMcCz04oYiQB3G6xgYb4xeuY6cNqxiY2rTJMHlfUfTlSJf1Z0dh6hAS3alHpGw="
+  matrix:
+    - RAKE_TASK=cucumber
+    - RAKE_TASK=spec
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+  # documentation coverage is not influenced by ruby version, but the dependencies differ for MRI and JRuby, so
+  # rake yard for both.
+  include:
+    - rvm: 2.1
+      env: RAKE_TASK=yard
+    - rvm: jruby
+      env: RAKE_TASK=yard
+rvm:
+- 1.9.3
+- 2.0
+- 2.1
+- ruby-head
+- jruby
+- rbx-2.2
+script: "bundle exec rake $RAKE_TASK"

data/.yardopts

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

data/CONTRIBUTING.md

@@ -0,0 +1,156 @@
+# Contributing
+
+## Forking
+
+[Fork this repository](https://github.com/rapid7/metasploit-version/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-version/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/version/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-version/compare/)
+* Add a Verification Steps 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/version/version.rb) so that [version_spec.rb](spec/lib/metasploit/version/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/version/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/version/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`
+
+### Compatible changes
+
+If your change are compatible with the previous branch's API, then increment [`PATCH`](lib/metasploit/version/version.rb).
+
+### Incompatible changes
+
+If your changes are incompatible with the previous branch's API, then increment [`MINOR`](lib/metasploit/version/version.rb) and reset [`PATCH`](lib/metasploit/version/version.rb) to `0`.
+
+- [ ] Following the rules for [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html), update [`MINOR`](lib/metasploit/version/version.rb) and [`PATCH`](lib/metasploit/version/version.rb) and commit the changes.
+
+## JRuby
+- [ ] `rvm use jruby@metasploit-version`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+
+## MRI Ruby
+- [ ] `rvm use ruby-2.1@metasploit-version`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+There are currently no known downstream dependencies

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metasploit-version.gemspec
+gemspec
+
+group :test do
+  # Test the shared example
+  gem 'aruba'
+  # Upload spec coverage to codeclimate.com
+  gem 'codeclimate-test-reporter', require: false
+  # Upload spec coverage to coveralls.io
+  gem 'coveralls', require: false
+    # Test the shared example
+  gem 'cucumber'
+  # code coverage for specs
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Luke Imhoff
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Metasploit::Version [![Build Status](https://travis-ci.org/rapid7/metasploit-version.svg)](https://travis-ci.org/rapid7/metasploit-version)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-version.png)](https://codeclimate.com/github/rapid7/metasploit-version)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit-version/badge.png?branch=feature%2FMSP-9923-port)](https://coveralls.io/r/rapid7/metasploit-version?branch=feature%2FMSP-9923-port)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-version.svg)](https://gemnasium.com/rapid7/metasploit-version)[![Inline docs](http://inch-ci.org/github/rapid7/metasploit-version.svg?branch=master)](http://inch-ci.org/github/rapid7/metasploit-version)[![Gem Version](https://badge.fury.io/rb/metasploit-version.png)](http://badge.fury.io/rb/metasploit-version)[![PullReview stats](https://www.pullreview.com/github/rapid7/metasploit-version/badges/feature/MSP-9923-port.svg?)](https://www.pullreview.com/github/rapid7/metasploit-version/reviews/feature/MSP-9923-port)
+
+Metasploit::Version allows your gem to declare the pieces of its [semantic version](semver.org) as constant and for
+your `VERSION` `String` to be automatically derived from those constants.  Shared examples are available to test that
+the `PRERELEASE` `String` matches the expected pattern of using the branch relative name and being undefined on master.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'metasploit-version'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metasploit-version
+
+## Usage
+
+### Gem version.rb
+
+Your gem's version.rb file should have a `Version` `Module` that defines the parts of the semantic version and
+`extend Metasploit::Version::Full`.  Then, `VERSION` in your gem's top-level namespace `Module` can be set to
+`Version.full`
+
+    module MyNamespace
+      module MyGem
+        # 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
+
+          # The prerelease version, scoped to the {PATCH} version number.
+          PRERELEASE = '<relative-name>'
+          
+          #
+          # Module Methods
+          #
+    
+          # The full version string, including the {MyNamespace::MyGem::Version::MAJOR},
+          # {MyNamespace::MyGem::Version::MINOR}, {MyNamespace::MyGem::Version::PATCH}, and optionally, the
+          # `MyNamespace::MyGem::Version::PRERELEASE` in the
+          # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+          #
+          # @return [String] '{MyNamespace::MyGem::Version::MAJOR}.{MyNamespace::MyGem::Version::MINOR}.{MyNamespace::MyGem::Version::PATCH}'
+          #   on master.  '{MyNamespace::MyGem::Version::MAJOR}.{MyNamespace::MyGem::Version::MINOR}.{MyNamespace::MyGem::Version::PATCH}-PRERELEASE'
+          #   on any branch other than master.
+          def self.full
+            version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    
+            if defined? PRERELEASE
+              version = "#{version}-#{PRERELEASE}"
+            end
+    
+            version
+          end
+    
+          # The full gem version string, including the {MyNamespace::MyGem::Version::MAJOR},
+          # {MyNamespace::MyGem::Version::MINOR}, {MyNamespace::MyGem::Version::PATCH}, and optionally, the
+          # `MyNamespace::MyGem::Version::PRERELEASE` in the
+          # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+          #
+          # @return [String] '{MyNamespace::MyGem::Version::MAJOR}.{MyNamespace::MyGem::Version::MINOR}.{MyNamespace::MyGem::Version::PATCH}'
+          #   on master.  '{MyNamespace::MyGem::Version::MAJOR}.{MyNamespace::MyGem::Version::MINOR}.{MyNamespace::MyGem::Version::PATCH}.PRERELEASE'
+          #   on any branch other than master.
+          def self.gem
+            full.gsub('-', '.pre.')
+          end
+        end
+
+        # (see Version.gem)
+        GEM_VERSION = Version.gem
+
+        # (see Version.full)
+        VERSION = Version.full
+      end
+    end
+
+On a branch such the relative name is the portion after the branch type as in `bug/<relative-name>`,
+`chore/<relative-name>`, `feature/<relative-name>`, or `staging/<relative-name>`.  On master, the gem is assumed to
+no longer be in prerelease, so `PRERELEASE` should not be defined.  If it is defined, the
+`'Metasploit::Version Version Module'` shared example will fail.
+
+### spec_helper.rb
+
+In your `spec_helper.rb`, require the shared examples from `metasploit-version`.
+
+    # 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
+
+    Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+      require f
+    end
+
+### Gem namespace spec
+
+The spec for your gem's namespace `Module` should use the `'Metasploit::Version VERSION constant'` shared example.
+
+    require 'spec_helper'
+
+    describe MyNamespace::MyGem do
+      it_should_behave_like 'Metasploit::Version VERSION constant'
+      it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+    end
+
+### Gem Version spec
+
+The spec for your gem's `Version` `Module` defined in the `version.rb` file should use the
+`'Metasploit::Version Version Module'` shared example.
+
+    require 'spec_helper'
+
+    describe MyNamespace::MyGem::Version do
+      it_should_behave_like 'Metasploit::Version Version Module'
+    end
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+