metasploit-version 0.1.2-java

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

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Metasploit::Version::Version do
+  it_should_behave_like 'Metasploit::Version Version Module'
+end

data/spec/lib/metasploit/version_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Metasploit::Version do
+  it_should_behave_like 'Metasploit::Version GEM_VERSION constant'
+  it_should_behave_like 'Metasploit::Version VERSION constant'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# require before 'metasploit/version' so coverage is shown for files required by 'metasploit/version'
+require 'simplecov'
+
+require '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

data/spec/support/shared/examples/metasploit/version/gem_version_constant.rb

@@ -0,0 +1,17 @@
+shared_examples_for 'Metasploit::Version GEM_VERSION constant' do
+  context 'CONSTANTS' do
+    context 'GEM_VERSION' do
+      subject(:version) {
+        described_class::GEM_VERSION
+      }
+
+      it 'is defined' do
+        expect(defined? described_class::GEM_VERSION).not_to be_nil, "expected #{described_class}::GEM_VERSION to be defined"
+      end
+
+      it 'is Version.gem' do
+        expect(version).to eq(described_class::Version.gem), "expected #{described_class}::GEM_VERSION to equal #{described_class}::Version.gem"
+      end
+    end
+  end
+end

data/spec/support/shared/examples/metasploit/version/version_constant.rb

@@ -0,0 +1,17 @@
+shared_examples_for 'Metasploit::Version VERSION constant' do
+  context 'CONSTANTS' do
+    context 'VERSION' do
+      subject(:version) {
+        described_class::VERSION
+      }
+
+      it 'is defined' do
+        expect(defined? described_class::VERSION).not_to be_nil, "expected #{described_class}::VERSION to be defined"
+      end
+
+      it 'is Version.full' do
+        expect(version).to eq(described_class::Version.full), "expected #{described_class}::VERSION to equal #{described_class}::Version.full"
+      end
+    end
+  end
+end

data/spec/support/shared/examples/metasploit/version/version_module.rb

@@ -0,0 +1,226 @@
+shared_examples_for 'Metasploit::Version Version Module' do
+  context 'CONSTANTS' do
+    context 'MAJOR' do
+      subject(:major) {
+        described_class::MAJOR
+      }
+
+      it { should be_an Integer }
+    end
+
+    context 'MINOR' do
+      subject(:minor) {
+        described_class::MINOR
+      }
+
+      it { should be_a Integer }
+    end
+
+    context 'PATCH' do
+      subject(:patch) {
+        described_class::PATCH
+      }
+
+      it { should be_a Integer }
+    end
+
+    pull_request = ENV['TRAVIS_PULL_REQUEST']
+    example_options = {}
+
+    if !pull_request.nil? && pull_request != 'false'
+      example_options = {
+          pending: "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."
+      }
+    end
+
+    context 'PRERELEASE' do
+      subject(:prerelease) {
+        described_class::PRERELEASE
+      }
+
+      branch = Metasploit::Version::Branch.current
+      parsed_branch = Metasploit::Version::Branch.parse(branch)
+
+      #
+      # Methods
+      #
+
+      # use define_method to capture `parsed_branch`
+      define_method(:expect_prerelease_to_be_defined) do
+        expect(defined? described_class::PRERELEASE).not_to(
+            be_nil,
+            # lambda so error string is only calculated on failures
+            ->() {
+              "expected #{described_class}::PRERELEASE to be defined.\n" \
+              "Add the following to #{described_class}:\n" \
+              "\n" \
+              "    # The prerelease version, scoped to the {PATCH} version number.\n" \
+              "    PRERELEASE = #{parsed_branch[:prerelease]}"
+            }
+        )
+      end
+
+      # unknown format
+      if parsed_branch.nil?
+        # unknown format is still wrong, even on a pull request, so don't use `example_options`
+        it 'has an abbreviated reference that can be parsed for prerelease' do
+          fail "Do not know how to parse #{branch.inspect} for PRERELEASE"
+        end
+      # detached HEAD in git
+      elsif parsed_branch == 'HEAD'
+        it 'has an abbreviated reference that can be parsed for prerelease',
+           pending: 'Cannot determine branch name in detached HEAD state.  Set TRAVIS_BRANCH to supply branch name' do
+          fail "Do not know how to parse #{branch.inspect} for PRERELEASE"
+        end
+      # master
+      elsif parsed_branch == 'master'
+        it 'is not defined', example_options do
+          expect(defined? described_class::PRERELEASE).to(
+              be_nil,
+              "expected #{described_class}::PRERELEASE not to be defined on master"
+          )
+        end
+      # non-master branches
+      elsif parsed_branch.has_key? :type
+        it "matches the #{parsed_branch[:type]} branch's name", example_options do
+          expect_prerelease_to_be_defined
+          expect(prerelease).to eq(parsed_branch[:prerelease])
+        end
+      # tags
+      else
+        # pre-release tag
+        if parsed_branch[:prerelease]
+          it 'matches the tag prerelease converted from a gem version to a VERSION', example_options do
+            expect_prerelease_to_be_defined
+            expect(prerelease).to eq(parsed_branch[:prerelease])
+          end
+        # master tag
+        else
+          it 'is not defined', example_options do
+            expect(defined? described_class::PRERELEASE).to(
+                be_nil,
+                "expected #{described_class}::PRERELEASE not to be defined on master"
+            )
+          end
+        end
+      end
+    end
+  end
+
+  context 'full' do
+    subject(:full) {
+      described_class.full
+    }
+
+    #
+    # Methods
+    #
+
+    def expect_method_defined
+      expect(defined? described_class.full).to(
+          eq('method'),
+          # lambda so expensive message calculation only happens on failure
+          ->() {
+            "expected #{described_class} to define self.full().\n" \
+            "Add the following to #{described_class}\n" \
+            "\n" \
+            "    # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the\n" \
+            "    # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.\n" \
+            "    #\n" \
+            "    # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-{PRERELEASE}' on any branch\n" \
+            "    #   other than master.\n" \
+            "    def self.full\n" \
+            "      version = \"\#{MAJOR}.\#{MINOR}.\#{PATCH}\"\n" \
+            "\n" \
+            "      if defined? PRERELEASE\n" \
+            "        version = \"\#{version}-\#{PRERELEASE}\"\n" \
+            "      end\n" \
+            "\n" \
+            "      version\n" \
+            "   end"
+          }
+      )
+    end
+
+    #
+    # Callbacks
+    #
+
+    before(:each) do
+      expect_method_defined
+    end
+
+    context 'with PRERELEASE defined' do
+      #
+      # lets
+      #
+
+      let(:prerelease) {
+        'prerelease'
+      }
+
+      #
+      # Callbacks
+      #
+
+      before(:each) do
+        stub_const("#{described_class}::PRERELEASE", prerelease)
+      end
+
+      it 'is <MAJOR>.<MINOR>.<PATCH>-<PRERELEASE>' do
+        expect(full).to eq("#{described_class::MAJOR}.#{described_class::MINOR}.#{described_class::PATCH}-#{prerelease}")
+      end
+    end
+
+    context 'without PRERELEASE defined' do
+      before(:each) do
+        hide_const("#{described_class}::PRERELEASE")
+      end
+
+      it 'is <MAJOR>.<MINOR>.<PATCH>' do
+        expect(full).to eq("#{described_class::MAJOR}.#{described_class::MINOR}.#{described_class::PATCH}")
+      end
+    end
+  end
+
+  context 'gem' do
+    subject(:gem) {
+      described_class.gem
+    }
+
+    before(:each) do
+      expect(described_class).to receive(:full).and_return('1.2.3-multiword-prerelease')
+    end
+
+    it "replaces '-' with '.pre.' to be compatible with rubygems 1.8.6" do
+      gem_method = described_class.method(:gem)
+      method_arity = gem_method.arity
+
+      expect(method_arity).to(
+          eq(0),
+          # lambda so expensive message calculation only happens on failure
+          ->() {
+            method_location = gem_method.source_location
+            method_file = method_location[0]
+            method_line = method_location[1]
+
+            "expected #{described_class} to define self.gem(), but method defined by #{gem_method.owner} in " \
+            "#{method_file} on line #{method_line} with arity #{method_arity}.\n" \
+            "Add the following to #{described_class}:\n" \
+            "\n" \
+            "   # The full gem version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the\n" \
+            "   # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.\n" \
+            "   #\n" \
+            "   # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch\n" \
+            "   #   other than master.\n" \
+            "   def self.gem\n" \
+            "     full.gsub('-', '.pre.')\n" \
+            "   end"
+          }
+      )
+
+      expect(gem).to eq('1.2.3.pre.multiword.pre.prerelease')
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: metasploit-version
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: java
+authors:
+- Luke Imhoff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: metasploit-yard
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+description: 'Metasploit::Version::Full for deriving String VERSION from constants
+  in Version module and shared examples: ''Metasploit::Version VERSION constant''
+  to check VERSION and ''Metasploit::Version Version Module'' to check Version.'
+email:
+- luke_imhoff@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .simplecov
+- .travis.yml
+- .yardopts
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/shared/examples/metasploit/version/gem_version_constant.feature
+- features/shared/examples/metasploit/version/version_constant.feature
+- features/shared/examples/metasploit/version/version_module.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/branch.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/detached_head.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/master.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/step_definitions/environment_variable_steps.rb
+- features/shared/examples/metasploit/version/version_module/prerelease/git/step_definitions/git_steps.rb
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/branch.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/master.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/pull_request.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/tag.feature
+- features/support/env.rb
+- features/support/simplecov_setup.rb
+- lib/metasploit/version.rb
+- lib/metasploit/version/branch.rb
+- lib/metasploit/version/version.rb
+- metasploit-version.gemspec
+- spec/lib/metasploit/version/branch_spec.rb
+- spec/lib/metasploit/version/version_spec.rb
+- spec/lib/metasploit/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/examples/metasploit/version/gem_version_constant.rb
+- spec/support/shared/examples/metasploit/version/version_constant.rb
+- spec/support/shared/examples/metasploit/version/version_module.rb
+homepage: https://github.com/rapid7/metasploit-version
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Semantic versioning helpers and shared examples
+test_files:
+- features/shared/examples/metasploit/version/gem_version_constant.feature
+- features/shared/examples/metasploit/version/version_constant.feature
+- features/shared/examples/metasploit/version/version_module.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/branch.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/detached_head.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/master.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/git/step_definitions/environment_variable_steps.rb
+- features/shared/examples/metasploit/version/version_module/prerelease/git/step_definitions/git_steps.rb
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/branch.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/master.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/pull_request.feature
+- features/shared/examples/metasploit/version/version_module/prerelease/travis_ci/tag.feature
+- features/support/env.rb
+- features/support/simplecov_setup.rb
+- spec/lib/metasploit/version/branch_spec.rb
+- spec/lib/metasploit/version/version_spec.rb
+- spec/lib/metasploit/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/examples/metasploit/version/gem_version_constant.rb
+- spec/support/shared/examples/metasploit/version/version_constant.rb
+- spec/support/shared/examples/metasploit/version/version_module.rb
+has_rdoc: