metasploit-yard 1.0.0 → 1.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTdkZGNmNDA2OTM2N2Y0OTE0OTg2YzA5ZTQwNTA4ZmVlMWUzOWFkNg==
-  data.tar.gz: !binary |-
-    MGVlN2FkOTMzYjZmNTMzMTAwYjZkMmMxYjdjMDcwNjg4MzI0NTg0Yw==
+SHA1:
+  metadata.gz: 0ef63c14dcb5a9f948a43ee8903f41e12e94b16c
+  data.tar.gz: e10531c7cbff07767963d4a464acd5d86f79f9c1
 SHA512:
-  metadata.gz: !binary |-
-    M2Y4Y2Q1ZjRlODZmZGY2Njk0MDkwODk3ZWE4ZGJmYzc4NWQwYjBmYTI0Nzk2
-    ZWRjNGRmNDdlOWY2NGFjODRiN2Y2MTJlODFkOWRiMjExNzI4YWE3ZjAwYzc5
-    ZDU3NjYwMGJmMDY1ZGE4NWY3ODNmNzY1YjZmMmZlYjMyODdhMWE=
-  data.tar.gz: !binary |-
-    OWYxZTVhNWQyYjU2Y2YwZjIzZDQ0ZjY0OTQ1YmY4NzM5Mjc0Y2RjNWZiMTFh
-    NWJiMTI3Y2IyYTI0ZjAyYzJhOGUxYzIyY2RjYTZmM2M3YWQ3ZGU3MGU0ZGVh
-    ODhlNTU1ODEwNDJlMGI5YjUwYzUzMjk3MDk1YTEzZjYyNzRlM2M=
+  metadata.gz: 8855aa062651f6c12bf96b9cfb20c4354a281172c9c82cd3542886fec13af43a2cb09fac58332a3a77abfa072857322188d8dbcb3d177d3617751a0314a0de8e
+  data.tar.gz: 26e2d66ddb603d995b588c4d4b20a2d12e52a3097e1128142778d9d87e6bbb884b11841740799b454be8284b2a4390d5e2e5c8cbbdb56637fccbc450188bd914

data/CONTRIBUTING.md

@@ -158,6 +158,12 @@ 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`

data/features/step_definitions/rvm.rb

@@ -1,5 +1,3 @@
-require 'metasploit/yard/aruba/rvm_env'
-
 Before do
   @gemsets_to_delete = []
 end

data/features/support/env.rb

@@ -1,6 +1,8 @@
 require 'active_support/core_ext/integer/time'
 require 'aruba/cucumber'
 
+require 'metasploit/yard'
+
 Before do
   @aruba_timeout_seconds = 10.minutes
 end

data/lib/metasploit/yard.rb

@@ -11,6 +11,8 @@ require 'metasploit/yard/version'
 module Metasploit
   # Namespace for this gem.
   module Yard
+    autoload :Aruba, 'metasploit/yard/aruba'
+
     if defined?(Rails)
       require 'metasploit/yard/railtie'
     end

data/lib/metasploit/yard/aruba.rb

@@ -1,6 +1,12 @@
-require 'metasploit/yard'
+#
+# Gems
+#
+
+require 'active_support/dependencies/autoload'
 
 # Helpers for aruba step definitions for testing `rake yard`
 module Metasploit::Yard::Aruba
+  extend ActiveSupport::Autoload
 
+  autoload :RvmEnv
 end

data/lib/metasploit/yard/aruba/rvm_env.rb

@@ -2,19 +2,21 @@
 # Gems
 #
 
+require 'active_support/dependencies/autoload'
 require 'active_support/core_ext/hash/keys'
 
 #
 # Project
 #
 
-require 'metasploit/yard/aruba'
-
 # Helpers for parsing `rvm env` output
 module Metasploit::Yard::Aruba::RvmEnv
-  require 'metasploit/yard/aruba/rvm_env/export'
-  require 'metasploit/yard/aruba/rvm_env/prepend'
-  require 'metasploit/yard/aruba/rvm_env/unset'
+  extend ActiveSupport::Autoload
+
+  autoload :Export
+  autoload :Prepend
+  autoload :Unset
+  autoload :Variable
 
   #
   # CONSTANTS

data/lib/metasploit/yard/aruba/rvm_env/export.rb

@@ -1,15 +1,3 @@
-#
-# Gems
-#
-
-require 'active_support/core_ext/hash/keys'
-
-#
-# Project
-#
-
-require 'metasploit/yard/aruba/rvm_env/variable'
-
 # Recognizes `export`s of a variable
 class Metasploit::Yard::Aruba::RvmEnv::Export < Metasploit::Yard::Aruba::RvmEnv::Variable
   #
@@ -17,7 +5,7 @@ class Metasploit::Yard::Aruba::RvmEnv::Export < Metasploit::Yard::Aruba::RvmEnv:
   #
 
   # Matches line with format `export <name>=<quote><value><quote>`
-  REGEXP = /\Aexport (?<name>.*?)=(?<quote>"|')(?<value>.*?)\k<quote>\Z/
+  REGEXP = /\Aexport (?<name>\S+?)(\s+;\s+\k<name>)?=(?<quote>"|')(?<value>.*?)\k<quote>\Z/
 
   #
   # Attributes

data/lib/metasploit/yard/aruba/rvm_env/prepend.rb

@@ -1,15 +1,3 @@
-#
-# Gems
-#
-
-require 'active_support/core_ext/hash/keys'
-
-#
-# Project
-#
-
-require 'metasploit/yard/aruba/rvm_env'
-
 # Recognizes `export`s that are actually prepending values to the pre-existing value as is the case with `PATH`.
 class Metasploit::Yard::Aruba::RvmEnv::Prepend < Metasploit::Yard::Aruba::RvmEnv::Export
   #
@@ -19,7 +7,7 @@ class Metasploit::Yard::Aruba::RvmEnv::Prepend < Metasploit::Yard::Aruba::RvmEnv
   # Matches line with format `export <name>=<quote><value>$<name><quote>`.  `<value>` will contain trailing
   # `File::PATH_SEPARATOR`, so it can be directly prepended to the current value of `<name>` to get the value to set
   # the environment variable.
-  REGEXP = /\Aexport (?<name>.*?)=(?<quote>"|')(?<value>.*?#{File::PATH_SEPARATOR})\$\k<name>\k<quote>\Z/
+  REGEXP = /\Aexport (?<name>\S+?)(\s+;\s+\k<name>)?=(?<quote>"|')(?<value>.*?#{File::PATH_SEPARATOR})\$\k<name>\k<quote>\Z/
 
   # Replaces {Metasploit::Yard::Aruba::RvmEnv::Export#value `:from` value} with
   # {Metasploit::Yard::Aruba::RvmEnv::Export#value this variable's value}.

data/lib/metasploit/yard/aruba/rvm_env/unset.rb

@@ -1,15 +1,3 @@
-#
-# Gems
-#
-
-require 'active_support/core_ext/hash/keys'
-
-#
-# Project
-#
-
-require 'metasploit/yard/aruba/rvm_env/variable'
-
 # Recognizes `unset`s of environment variables.
 class Metasploit::Yard::Aruba::RvmEnv::Unset < Metasploit::Yard::Aruba::RvmEnv::Variable
   #

data/lib/metasploit/yard/aruba/rvm_env/variable.rb

@@ -1,15 +1,3 @@
-#
-# Gems
-#
-
-require 'active_support/core_ext/hash/keys'
-
-#
-# Project
-#
-
-require 'metasploit/yard/aruba/rvm_env'
-
 # An environment variable in `rvm env`.
 class Metasploit::Yard::Aruba::RvmEnv::Variable
   #

data/lib/metasploit/yard/railtie.rb

@@ -1,5 +1,3 @@
-require 'rails/railtie'
-
 module Metasploit
   module Yard
     # Automatically loads `yard.rake` for any Rails project.

data/lib/metasploit/yard/version.rb

@@ -7,12 +7,12 @@ module Metasploit
       # The minor version number, scoped to the {MAJOR} version number.
       MINOR = 0
       # The patch number, scoped to the {MINOR} version number.
-      PATCH = 0
+      PATCH = 2
 
-      # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+      # The full version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the PRERELEASE in the
       # {http://semver.org/spec/v2.0.0.html semantic versioning v2.0.0} format.
       #
-      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-{PRERELEASE}' on any branch
+      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}-PRERELEASE' on any branch
       #   other than master.
       def self.full
         version = "#{MAJOR}.#{MINOR}.#{PATCH}"
@@ -24,10 +24,10 @@ module Metasploit
         version
       end
 
-      # The full gem version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the {PRERELEASE} in the
+      # The full gem version string, including the {MAJOR}, {MINOR}, {PATCH}, and optionally, the PRERELEASE in the
       # {http://guides.rubygems.org/specification-reference/#version RubyGems versioning} format.
       #
-      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.{PRERELEASE}' on any branch
+      # @return [String] '{MAJOR}.{MINOR}.{PATCH}' on master.  '{MAJOR}.{MINOR}.{PATCH}.PRERELEASE' on any branch
       #   other than master.
       def self.gem
         full.gsub('-', '.pre.')

data/metasploit-yard.gemspec

@@ -29,6 +29,20 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
 
   spec.add_runtime_dependency 'rake'
+
+  if RUBY_PLATFORM =~ /java/
+    # markdown library for YARD to enable proper parsing of README.md and CONTRIBUTING.md
+    spec.add_runtime_dependency 'kramdown'
+
+    # Cannot use Gem::Platform::JAVA as it is only defined by bundler, so `gem build *.gemspec` wouldn't work.
+    spec.platform = Gem::Platform.new('java')
+  else
+    # markdown library for YARD to enable proper parsing of README.md and CONTRIBUTING.md
+    spec.add_runtime_dependency 'redcarpet'
+
+    spec.platform = Gem::Platform::RUBY
+  end
+
   spec.add_runtime_dependency 'yard'
 
   # Ruby 1.9 JSON Hash syntax is used

data/spec/metasploit/yard/aruba/rvm_env/export_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Export do
+  context 'CONSTANTS' do
+    context 'REGEXP' do
+      subject(:regexp) {
+        described_class::REGEXP
+      }
+
+      let(:name) {
+        'rvm_env_string'
+      }
+
+      let(:set) {
+        %Q{#{name}=#{quote}#{value}#{quote}}
+      }
+
+      let(:value) {
+        'ruby-1.9.3-p547@pro'
+      }
+
+      context 'with combined export and set' do
+        let(:line) {
+          %Q{export #{set}}
+        }
+
+        context 'with "' do
+          let(:quote) {
+            '"'
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+
+        context "with '" do
+          let(:quote) {
+            "'"
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+      end
+
+      context 'with separate export and set' do
+        let(:line) {
+          %Q{export #{name} ; #{set}}
+        }
+
+        context 'with "' do
+          let(:quote) {
+            '"'
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+
+        context "with '" do
+          let(:quote) {
+            "'"
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/metasploit/yard/aruba/rvm_env/prepend_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Prepend do
+  context 'CONSTANTS' do
+    context 'REGEXP' do
+      subject(:regexp) {
+        described_class::REGEXP
+      }
+
+      let(:name) {
+        'PATH'
+      }
+
+      let(:prepend) {
+        %Q{#{name}=#{quote}#{value}$#{name}#{quote}}
+      }
+
+      let(:value) {
+        '/Users/bob/.rvm/gems/ruby-1.9.3-p547@pro/bin:/Users/bob/.rvm/gems/ruby-1.9.3-p547@global/bin:/Users/bob/.rvm/rubies/ruby-1.9.3-p547/bin:/Users/bob/.rvm/bin:'
+      }
+
+      context 'with combined export and prepend' do
+        let(:line) {
+          %Q{export #{prepend}}
+        }
+
+        context 'with "' do
+          let(:quote) {
+            '"'
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+
+        context "with '" do
+          let(:quote) {
+            "'"
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+      end
+
+      context 'with separate export and prepend' do
+        let(:line) {
+          %Q{export #{name} ; #{prepend}}
+        }
+
+        context 'with "' do
+          let(:quote) {
+            '"'
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+
+        context "with '" do
+          let(:quote) {
+            "'"
+          }
+
+          it 'matches groups correctly' do
+            expect(regexp).to match(line)
+
+            match = regexp.match(line)
+
+            expect(match[:name]).to eq(name)
+            expect(match[:value]).to eq(value)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,153 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-yard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Luke Imhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: YARD rake tasks used through the metasploit-* gem namespace
@@ -157,12 +171,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .simplecov
-- .travis.yml
-- .yardopts
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -184,6 +198,8 @@ files:
 - lib/metasploit/yard/version.rb
 - lib/tasks/yard.rake
 - metasploit-yard.gemspec
+- spec/metasploit/yard/aruba/rvm_env/export_spec.rb
+- spec/metasploit/yard/aruba/rvm_env/prepend_spec.rb
 - spec/metasploit/yard/version_spec.rb
 - spec/metasploit/yard_spec.rb
 - spec/spec_helper.rb
@@ -197,17 +213,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: yard rake tasks
@@ -216,6 +232,8 @@ test_files:
 - features/step_definitions/project.rb
 - features/step_definitions/rvm.rb
 - features/support/env.rb
+- spec/metasploit/yard/aruba/rvm_env/export_spec.rb
+- spec/metasploit/yard/aruba/rvm_env/prepend_spec.rb
 - spec/metasploit/yard/version_spec.rb
 - spec/metasploit/yard_spec.rb
 - spec/spec_helper.rb