metasploit-version 0.1.2 → 0.1.3

data/app/templates/Rakefile.tt

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/templates/UPGRADING.md.tt

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

data/app/templates/lib/versioned/version.rb.tt

@@ -0,0 +1,64 @@
+<%- namespaces.each_with_index do |module_name, i| -%>
+<%= '  ' * i %>module <%= module_name %>
+<%- end -%>
+<%- indent = '  ' * namespaces.length -%>
+<%= indent %># Holds components of {VERSION} as defined by {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0}.
+<%= indent %>module Version
+<%= indent %>  #
+<%= indent %>  # CONSTANTS
+<%= indent %>  #
+
+<%= indent %>  # The major version number.
+<%= indent %>  MAJOR = <%= options[:major] %>
+<%= indent %>  # The minor version number, scoped to the {MAJOR} version number.
+<%= indent %>  MINOR = <%= options[:minor] %>
+<%= indent %>  # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
+<%= indent %>  PATCH = <%= options[:patch] %>
+<%- if prerelease -%>
+<%= indent %>  # The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version numbers.
+<%= indent %>  PRERELEASE = '<%= prerelease %>'
+<%- end -%>
+
+<%= indent %>  #
+<%= indent %>  # Module Methods
+<%= indent %>  #
+
+<%= indent %>  # The full version string, including the {<%= namespace_name %>::Version::MAJOR},
+<%= indent %>  # {<%= namespace_name %>::Version::MINOR}, {<%= namespace_name %>::Version::PATCH}, and optionally, the
+<%= indent %>  # `<%= namespace_name %>::Version::PRERELEASE` in the
+<%= indent %>  # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
+<%= indent %>  #
+<%= indent %>  # @return [String] '{<%= namespace_name %>::Version::MAJOR}.{<%= namespace_name %>::Version::MINOR}.{<%= namespace_name %>::Version::PATCH}' on master.
+<%= indent %>  #   '{<%= namespace_name %>::Version::MAJOR}.{<%= namespace_name %>::Version::MINOR}.{<%= namespace_name %>::Version::PATCH}-PRERELEASE'
+<%= indent %>  #   on any branch other than master.
+<%= indent %>  def self.full
+<%= indent %>    version = "#{MAJOR}.#{MINOR}.#{PATCH}"
+
+<%= indent %>    if defined? PRERELEASE
+<%= indent %>      version = "#{version}-#{PRERELEASE}"
+<%= indent %>    end
+
+<%= indent %>    version
+<%= indent %>  end
+
+<%= indent %>  # The full gem version string, including the {<%= namespace_name %>::Version::MAJOR},
+<%= indent %>  # {<%= namespace_name %>::Version::MINOR}, {<%= namespace_name %>::Version::PATCH}, and optionally, the
+<%= indent %>  # `<%= namespace_name %>::Version::PRERELEASE` in the
+<%= indent %>  # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
+<%= indent %>  #
+<%= indent %>  # @return [String] '{<%= namespace_name %>::Version::MAJOR}.{<%= namespace_name %>::Version::MINOR}.{<%= namespace_name %>::Version::PATCH}'
+<%= indent %>  #   on master.  '{<%= namespace_name %>::Version::MAJOR}.{<%= namespace_name %>::Version::MINOR}.{<%= namespace_name %>::Version::PATCH}.PRERELEASE'
+<%= indent %>  #   on any branch other than master.
+<%= indent %>  def self.gem
+<%= indent %>    full.gsub('-', '.pre.')
+<%= indent %>  end
+<%= indent %>end
+
+<%= indent %># (see Version.gem)
+<%= indent %>GEM_VERSION = Version.gem
+
+<%= indent %># (see Version.full)
+<%= indent %>VERSION = Version.full
+<%- (namespaces.length - 1).downto(0) do |i| -%>
+<%= '  ' * i %>end
+<%- end -%>

data/app/templates/spec/lib/versioned/version_spec.rb.tt

@@ -0,0 +1,3 @@
+RSpec.describe <%= namespace_name %>::Version do
+  it_should_behave_like 'Metasploit::Version Version Module'
+end

data/app/templates/spec/lib/versioned_spec.rb.tt

@@ -0,0 +1,4 @@
+RSpec.describe <%= namespace_name %> do
+  it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+  it_should_behave_like 'Metasploit::Version VERSION constant'
+end

data/app/templates/spec/spec_helper.rb.tt

@@ -0,0 +1,76 @@
+require 'bundler/setup'
+
+#
+# Gems
+#
+
+require 'metasploit/version'
+
+#
+# Project
+#
+
+require '<%= namespaced_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
+
+Dir[File.join(gem_specification.gem_dir, 'spec', 'support', '**', '*.rb')].each do |f|
+  require f
+end
+
+RSpec.configure do |config|
+  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
+
+  # allow more verbose output when running an individual spec file.
+  if config.files_to_run.one?
+    # RSpec filters the backtrace by default so as not to be so noisy.
+    # This causes the full backtrace to be printed when running a single
+    # spec file (e.g. to troubleshoot a particular spec failure).
+    config.full_backtrace = true
+  end
+
+  # 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
+
+  # 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
+
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    expectations.syntax = :expect
+  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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    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.
+    mocks.verify_partial_doubles = true
+  end
+end

data/bin/metasploit-version

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'metasploit/version/cli'
+rescue LoadError
+  warn 'Could not load "metasploit/version/cli"'
+  exit -1
+end
+
+Metasploit::Version::CLI.start

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+---
+# Don't automatically load simplecov_setup as it will be loaded as needed in Before
+default: --exclude support/simplecov_setup.rb

data/features/metasploit-version/install/add_development_dependency.feature

@@ -0,0 +1,68 @@
+Feature: metasploit-version install adds 'metasploit-version' as a development dependency
+
+  The `metasploit-version install` command will add 'metasploit-version' to the gem's gemspec if it is not already
+  added.
+
+  Background:
+    Given I successfully run `bundle gem add_development_dependency`
+    And I cd to "add_development_dependency"
+
+  Scenario: Not added to gemspec
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then metasploit-version should be development dependency with semantic version restriction in "add_development_dependency.gemspec"
+
+  Scenario: No semantic version restriction
+    Given I overwrite "add_development_dependency.gemspec" with:
+      """
+      # coding: utf-8
+
+      Gem::Specification.new do |spec|
+        spec.name          = "add_development_dependency"
+        spec.version       = '0.0.0'
+        spec.authors       = ["Luke Imhoff"]
+        spec.email         = ["luke_imhoff@rapid7.com"]
+        spec.summary       = %q{TODO: Write a short summary. Required.}
+        spec.description   = %q{TODO: Write a longer description. Optional.}
+        spec.homepage      = ""
+        spec.license       = "MIT"
+
+        spec.files         = `git ls-files -z`.split("\x0")
+        spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+        spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+        spec.require_paths = ["lib"]
+
+        spec.add_development_dependency "bundler", "~> 1.6"
+        spec.add_development_dependency 'metasploit-version'
+        spec.add_development_dependency "rake"
+      end
+      """
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then metasploit-version should be development dependency with semantic version restriction in "add_development_dependency.gemspec"
+
+  Scenario: Semantic version restriction in gemspec
+    Given I overwrite "add_development_dependency.gemspec" with:
+      """
+      # coding: utf-8
+
+      Gem::Specification.new do |spec|
+        spec.name          = "add_development_dependency"
+        spec.version       = '0.0.0'
+        spec.authors       = ["Luke Imhoff"]
+        spec.email         = ["luke_imhoff@rapid7.com"]
+        spec.summary       = %q{TODO: Write a short summary. Required.}
+        spec.description   = %q{TODO: Write a longer description. Optional.}
+        spec.homepage      = ""
+        spec.license       = "MIT"
+
+        spec.files         = `git ls-files -z`.split("\x0")
+        spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+        spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+        spec.require_paths = ["lib"]
+
+        spec.add_development_dependency "bundler", "~> 1.6"
+        spec.add_development_dependency 'metasploit-version', '~> 0.0.0'
+        spec.add_development_dependency "rake"
+      end
+      """
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then metasploit-version should be development dependency with semantic version restriction in "add_development_dependency.gemspec"

data/features/metasploit-version/install/bundle_install.feature

@@ -0,0 +1,24 @@
+Feature: metasploit-version install will install dependencies with bundle install
+
+  After `metasploit-version install` adds the `metasploit-version` as a development dependency to the gemspec,
+  `metasploit-version install` should run `bundle install` so that `metasploit-version` itself and its dependencies,
+  such as `rspec` are installed so that user can immediately run `rake spec`
+
+  Scenario:
+    Given I build gem from project's "metasploit-version.gemspec"
+    And I'm using a clean gemset "installed"
+    When I run `bundle list`
+    Then the output from "bundle list" should not contain "metasploit-version"
+    Given I install latest local "metasploit-version" gem
+    And I successfully run `bundle gem installed`
+    And I cd to "installed"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem installed"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    And I successfully run `metasploit-version install --force`
+    When I run `bundle list`
+    Then the output from "bundle list" should contain "metasploit-version"
+    And the output from "bundle list" should contain "rspec"

data/features/metasploit-version/install/changelog.feature

@@ -0,0 +1,29 @@
+Feature: metasploit-version install should add CHANGELOG.md
+
+  `metasploit-version install` should generate CHANGELOG.md which details the Enhancements, Bug Fixes, Deprecations and
+  Incompatible Changes for each release version.  Items in each category should link to the associated PR with a
+  user-facing summary and contributor credit using their github handle.
+
+  See https://github.com/intridea/hashie/blob/master/CHANGELOG.md for an example of this item format and
+  https://github.com/elixir-lang/elixir/blob/e38f960d7edbf564c8e1b44bd2266ad9eaf6a453/CHANGELOG.md for an example of the
+  category breakdown.
+
+  Scenario:
+    Given I successfully run `bundle gem changed`
+    And I cd to "changed"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem changed"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "CHANGELOG.md" should contain:
+      """
+      # Next Release
+
+      * Enhancements
+      * Bug Fixes
+      * Deprecations
+      * Incompatible Changes
+      """

data/features/metasploit-version/install/conflict.feature

@@ -0,0 +1,45 @@
+Feature: metasploit-version install handles conflicts in 'version.rb' and 'Rakefile'
+
+  `metasploit-version install` will detect if the a version.rb file and/or Rakefile already exists and prompt the user
+  for conflict resolution.  The user can also non-interactive force the files to be overwritten with --force or skip
+  overwriting the files with --skip.
+
+  Background:
+    Given I successfully run `bundle gem metasploit_version_install_conflict`
+    And I cd to "metasploit_version_install_conflict"
+    And I write to "spec/lib/metasploit_version_install_conflict_spec.rb" with:
+      """
+      RSpec.describe MetasploitVersionInstallConflict do
+        it 'is a Module' do
+          expect(described_class).to be_a Module
+        end
+      end
+
+      """
+
+  Scenario: Prompts for confirmation if --force or --skip is not used
+    When I run `metasploit-version install --no-bundle-install` interactively
+    # to overwrite version.rb
+    And I type "y"
+    # to overwrite Rakefile
+    And I type "y"
+    # to overwrite metasploit_version_install_spec.rb
+    And I type "y"
+    Then the output should contain "conflict  Rakefile"
+    And the output should contain "conflict  lib/metasploit_version_install_conflict/version.rb"
+    And the output should contain "conflict  spec/lib/metasploit_version_install_conflict_spec.rb"
+    And the output should contain "force  Rakefile"
+    And the output should contain "force  lib/metasploit_version_install_conflict/version.rb"
+    And the output should contain "force  spec/lib/metasploit_version_install_conflict_spec.rb"
+
+  Scenario: --force will force update version.rb
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the output should contain "force  Rakefile"
+    And the output should contain "force  lib/metasploit_version_install_conflict/version.rb"
+    And the output should contain "force  spec/lib/metasploit_version_install_conflict_spec.rb"
+
+  Scenario: --skip will not update version.rb
+    When I successfully run `metasploit-version install --no-bundle-install --skip`
+    Then the output should contain "skip  Rakefile"
+    And the output should contain "skip  lib/metasploit_version_install_conflict/version.rb"
+    And the output should contain "skip  spec/lib/metasploit_version_install_conflict_spec.rb"

data/features/metasploit-version/install/contributing.feature

@@ -0,0 +1,139 @@
+Feature: metasploit-version install should add CONTRIBUTING.md
+
+  `metasploit-version install` should generate CONTRIBUTING.md
+
+  Scenario:
+    Given I successfully run `bundle gem contributed`
+    And I cd to "contributed"
+    And my git identity is configured
+    And I successfully run `git commit --message "bundle gem contributed"`
+    And I unset the environment variable "TRAVIS_BRANCH"
+    And I set the environment variables to:
+      | variable            | value |
+      | TRAVIS_PULL_REQUEST | false |
+    When I successfully run `metasploit-version install --force --no-bundle-install`
+    Then the file "CONTRIBUTING.md" should contain:
+      """
+      # Contributing
+
+      ## Forking
+
+      [Fork this repository](https://github.com/rapid7/contributed/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/contributed/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/contributed/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/contributed/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/contributed/version.rb) so that [version_spec.rb](spec/lib/contributed/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/contributed/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/contributed/version.rb`
+      - [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
+
+      ## Gem build
+      - [ ] gem build contributed.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)
+      """