metasploit-yard 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ef63c14dcb5a9f948a43ee8903f41e12e94b16c
-  data.tar.gz: e10531c7cbff07767963d4a464acd5d86f79f9c1
+  metadata.gz: ea5c31ba9a7ed3e254a753359bef4fef4f6190a9
+  data.tar.gz: d384baa3a3eec34d4bbb0a95a21f003cbd6dd339
 SHA512:
-  metadata.gz: 8855aa062651f6c12bf96b9cfb20c4354a281172c9c82cd3542886fec13af43a2cb09fac58332a3a77abfa072857322188d8dbcb3d177d3617751a0314a0de8e
-  data.tar.gz: 26e2d66ddb603d995b588c4d4b20a2d12e52a3097e1128142778d9d87e6bbb884b11841740799b454be8284b2a4390d5e2e5c8cbbdb56637fccbc450188bd914
+  metadata.gz: 2914d0f497e6de11c8f50dfc3b0c45620d69eaba635e15b2664f8b88c2010b4eb399d04f4544d4b1ce6bec8dbc5abe9cd77c6ba8fb4b9c8070599e15bfdb5732
+  data.tar.gz: c25e494a404d9b393a14b727c602ce0e53ea6eec6e9a0f447f7c484d1476ce90cc42f2291f38e44847582e8a797ba41320fa48c10d813601ef7fdf5ef0004ab5

data/.travis.yml

@@ -9,13 +9,11 @@ matrix:
   # documentation coverage is not influenced by ruby implementation, so only run once
   include:
     - rvm: 2.1
-      env: RAKE_TASK=yard
+      env: RAKE_TASK=yard:stats
 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"
+addons:
+  postgresql: '9.3'

data/lib/metasploit/yard.rb

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

data/lib/metasploit/yard/cli.rb

@@ -0,0 +1,4 @@
+# Namespace for overrides of `YARD::CLI` namespace classes.
+module Metasploit::Yard::CLI
+  autoload :Stats, 'metasploit/yard/cli/stats'
+end

data/lib/metasploit/yard/cli/stats.rb

@@ -0,0 +1,13 @@
+# Extends `YARD::CLI::Stats` to not mark writers as undocuments for instance attributes.
+class Metasploit::Yard::CLI::Stats < ::YARD::CLI::Stats
+  # Statistics for methods
+  def stats_for_methods
+    objs = all_objects.select {|m| m.type == :method }
+    objs.reject! {|m| m.is_alias? }
+    undoc = objs.select { |m|
+      m.docstring.blank? && !(m.writer? && m.is_attribute?)
+    }
+    @undoc_list |= undoc if @undoc_list
+    output "Methods", objs.size, undoc.size
+  end
+end

data/lib/metasploit/yard/version.rb

@@ -7,7 +7,7 @@ module Metasploit
       # The minor version number, scoped to the {MAJOR} version number.
       MINOR = 0
       # The patch number, scoped to the {MINOR} version number.
-      PATCH = 2
+      PATCH = 3
 
       # 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.

data/lib/tasks/yard.rake

@@ -23,7 +23,8 @@ namespace :yard do
 
   desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
   task :stats => :environment do
-    stats = YARD::CLI::Stats.new
+    require 'metasploit/yard'
+    stats = Metasploit::Yard::CLI::Stats.new
     stats.run('--compact', '--list-undoc')
 
     threshold = 100.0
@@ -52,6 +53,10 @@ namespace :yard do
   end
 end
 
+task :environment do
+  # stub task for when not run in a Rails project
+end
+
 # @todo Figure out how to just clone description from yard:doc
 desc "Generate YARD documentation"
 # allow calling namespace to as a task that goes to default task for namespace

data/metasploit-yard.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.1'
+
   # assert_valid_keys
   spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'aruba'
@@ -44,7 +46,4 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_runtime_dependency 'yard'
-
-  # Ruby 1.9 JSON Hash syntax is used
-  spec.required_ruby_version = '>= 1.9'
 end

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

@@ -16,7 +16,7 @@ RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Export do
       }
 
       let(:value) {
-        'ruby-1.9.3-p547@pro'
+        'ruby-2.1.5@pro'
       }
 
       context 'with combined export and set' do
@@ -92,4 +92,4 @@ RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Export do
       end
     end
   end
-end
+end

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

@@ -16,7 +16,7 @@ RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Prepend do
       }
 
       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:'
+        '/Users/bob/.rvm/gems/ruby-2.1.5@pro/bin:/Users/bob/.rvm/gems/ruby-2.1.5@global/bin:/Users/bob/.rvm/rubies/ruby-2.1.5/bin:/Users/bob/.rvm/bin:'
       }
 
       context 'with combined export and prepend' do
@@ -92,4 +92,4 @@ RSpec.describe Metasploit::Yard::Aruba::RvmEnv::Prepend do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metasploit-yard
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Luke Imhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -194,6 +194,8 @@ files:
 - lib/metasploit/yard/aruba/rvm_env/prepend.rb
 - lib/metasploit/yard/aruba/rvm_env/unset.rb
 - lib/metasploit/yard/aruba/rvm_env/variable.rb
+- lib/metasploit/yard/cli.rb
+- lib/metasploit/yard/cli/stats.rb
 - lib/metasploit/yard/railtie.rb
 - lib/metasploit/yard/version.rb
 - lib/tasks/yard.rake
@@ -215,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -223,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: yard rake tasks