yard-metasploit-erd 0.0.4 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1e6303498ce000429403508f9ccfd875ea9f39de
4
- data.tar.gz: 6f0e47e60eee6af9589a2fe02ee91267f3fde591
3
+ metadata.gz: 3e44e5d1bc0103558c99e86f0618be3a3a22f1f3
4
+ data.tar.gz: 0e1b4961f47866e39da48aa255f276433bdd69fc
5
5
  SHA512:
6
- metadata.gz: 4b8ffafe092628c1ee967627843fc93a6d2c6ffbd0d97219f075e3e001e611f0ccc1e0f8eaf497395f4703d9720afe65ba9698298ea5971a2cc5bcaba8596244
7
- data.tar.gz: c7c984e77c8ee7991482a5215fe80963dd87b91800cfff6bd7c40280208be3895bb486e44a06b27852896fdf728349cfe64e05b35cb3aeb9d2ce428514afd819
6
+ metadata.gz: e5f74637fdf9a722e164453b5418e833e53d89ae3655622f7fc41214339bec2f9bd08ca64d05b5b5a5c09d03a891c4cf212a7c14c4299550b038d381dfc806c4
7
+ data.tar.gz: 172f00e3ddac81cb804e87ac3721762de8c6f0399d1b1d7c1ee8abc4fd84b159dbf6f6ae6fda2a667c74bc23e906c8bd6dbcaa02770c7ca9f44d0c151c604ae7
data/.travis.yml CHANGED
@@ -1,5 +1,6 @@
1
+ cache: bundler
1
2
  language: ruby
2
3
  rvm:
3
4
  - 2.1
4
- - jruby
5
- - rbx
5
+ script: bundle exec rake spec yard
6
+ sudo: false
data/CONTRIBUTING.md CHANGED
@@ -40,9 +40,15 @@ Make your changes or however many commits you like, committing each with `git co
40
40
 
41
41
  ### Pre-Pull Request Testing
42
42
 
43
+ #### Specs
43
44
  1. Run specs one last time before opening the Pull Request: `rake spec`
44
45
  2. Verify there was no failures.
45
46
 
47
+ #### Documentation
48
+ 1. Run yard one last time before opening the Pull Request: `rake yard`
49
+ 2. Verify there are no warnings indicating you didn't mistype any links or tags.
50
+ 3. Verify there is 100% documented indicating you documented all the new Modules, Classes, Constants, and Methods.
51
+
46
52
  ### Push
47
53
 
48
54
  Push your branch to your fork on gitub: `git push TYPE/ISSUE/SUMMARY`
@@ -60,6 +66,11 @@ Push your branch to your fork on gitub: `git push TYPE/ISSUE/SUMMARY`
60
66
  ## `rake spec`
61
67
  - [ ] `rake spec`
62
68
  - [ ] VERIFY no failures
69
+
70
+ ## `rake yard`
71
+ - [ ] `rake yard`
72
+ - [ ] VERIFY no warnings
73
+ - [ ] VERIFY 100% documented
63
74
  ```
64
75
 
65
76
  You should also include at least one scenario to manually check the changes outside of specs.
data/RELEASING.md CHANGED
@@ -68,12 +68,6 @@ decide to remain pre-1.0.0 or (2) advance to 1.0.0.
68
68
 
69
69
  ## Release to rubygems.org
70
70
 
71
- ## jruby
72
- - [ ] `rvm use jruby@yard-metasploit-erd`
73
- - [ ] `rm Gemfile.lock`
74
- - [ ] `bundle install`
75
- - [ ] `rake release`
76
-
77
71
  ## ruby-2.1
78
72
  - [ ] `rvm use ruby-2.1@yard-metasploit-erd`
79
73
  - [ ] `rm Gemfile.lock`
data/Rakefile CHANGED
@@ -1,10 +1,14 @@
1
1
  require 'bundler/gem_tasks'
2
2
  require 'bundler/setup'
3
3
  require 'rspec/core/rake_task'
4
- require 'yard'
5
-
6
- load 'tasks/yard.rake'
7
4
 
8
5
  RSpec::Core::RakeTask.new(:spec)
9
6
 
10
7
  task default: :spec
8
+
9
+ # Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
10
+ gem_specification = Gem::Specification.find_all_by_name('metasploit-yard').first
11
+
12
+ Dir[File.join(gem_specification.gem_dir, 'lib', 'tasks', '**', '*.rake')].each do |rake|
13
+ load rake
14
+ end
@@ -10,9 +10,9 @@ module YARD
10
10
  # The major version number.
11
11
  MAJOR = 0
12
12
  # The minor version number, scoped to the {MAJOR} version number.
13
- MINOR = 0
13
+ MINOR = 1
14
14
  # The patch version number, scoped to the {MAJOR} and {MINOR} version numbers.
15
- PATCH = 4
15
+ PATCH = 0
16
16
 
17
17
  #
18
18
  # Module Methods
@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
23
23
 
24
24
  spec.add_development_dependency 'bundler', '~> 1.5'
25
25
  spec.add_development_dependency 'metasploit-version', '~> 0.1.3'
26
+ spec.add_development_dependency 'metasploit-yard', '~> 1.0'
26
27
  spec.add_development_dependency 'rake', '~> 10.3'
27
28
  spec.add_development_dependency 'rspec', '~> 3.1'
28
29
 
29
30
  # Generates namespace Module and Class<ActiveRecord::Base> specific ERDs for use in templates
30
- spec.add_runtime_dependency 'metasploit-erd', '0.0.1'
31
+ spec.add_runtime_dependency 'metasploit-erd', '0.1.0'
31
32
  # RailsERD::Domain is used directly to generate the _index.html ERD.
32
33
  spec.add_runtime_dependency 'rails-erd'
33
34
  spec.add_runtime_dependency 'yard'
metadata CHANGED
@@ -1,126 +1,141 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard-metasploit-erd
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.4
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Luke Imhoff
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-04-02 00:00:00.000000000 Z
11
+ date: 2015-04-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
- version_requirements: !ruby/object:Gem::Requirement
15
+ requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ~>
17
+ - - "~>"
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.5'
20
- requirement: !ruby/object:Gem::Requirement
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
21
23
  requirements:
22
- - - ~>
24
+ - - "~>"
23
25
  - !ruby/object:Gem::Version
24
26
  version: '1.5'
25
- prerelease: false
26
- type: :development
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: metasploit-version
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.1.3
34
+ type: :development
35
+ prerelease: false
29
36
  version_requirements: !ruby/object:Gem::Requirement
30
37
  requirements:
31
- - - ~>
38
+ - - "~>"
32
39
  - !ruby/object:Gem::Version
33
40
  version: 0.1.3
41
+ - !ruby/object:Gem::Dependency
42
+ name: metasploit-yard
34
43
  requirement: !ruby/object:Gem::Requirement
35
44
  requirements:
36
- - - ~>
45
+ - - "~>"
37
46
  - !ruby/object:Gem::Version
38
- version: 0.1.3
39
- prerelease: false
47
+ version: '1.0'
40
48
  type: :development
41
- - !ruby/object:Gem::Dependency
42
- name: rake
49
+ prerelease: false
43
50
  version_requirements: !ruby/object:Gem::Requirement
44
51
  requirements:
45
- - - ~>
52
+ - - "~>"
46
53
  - !ruby/object:Gem::Version
47
- version: '10.3'
54
+ version: '1.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
48
57
  requirement: !ruby/object:Gem::Requirement
49
58
  requirements:
50
- - - ~>
59
+ - - "~>"
51
60
  - !ruby/object:Gem::Version
52
61
  version: '10.3'
53
- prerelease: false
54
62
  type: :development
55
- - !ruby/object:Gem::Dependency
56
- name: rspec
63
+ prerelease: false
57
64
  version_requirements: !ruby/object:Gem::Requirement
58
65
  requirements:
59
- - - ~>
66
+ - - "~>"
60
67
  - !ruby/object:Gem::Version
61
- version: '3.1'
68
+ version: '10.3'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
62
71
  requirement: !ruby/object:Gem::Requirement
63
72
  requirements:
64
- - - ~>
73
+ - - "~>"
65
74
  - !ruby/object:Gem::Version
66
75
  version: '3.1'
67
- prerelease: false
68
76
  type: :development
69
- - !ruby/object:Gem::Dependency
70
- name: metasploit-erd
77
+ prerelease: false
71
78
  version_requirements: !ruby/object:Gem::Requirement
72
79
  requirements:
73
- - - '='
80
+ - - "~>"
74
81
  - !ruby/object:Gem::Version
75
- version: 0.0.1
82
+ version: '3.1'
83
+ - !ruby/object:Gem::Dependency
84
+ name: metasploit-erd
76
85
  requirement: !ruby/object:Gem::Requirement
77
86
  requirements:
78
87
  - - '='
79
88
  - !ruby/object:Gem::Version
80
- version: 0.0.1
81
- prerelease: false
89
+ version: 0.1.0
82
90
  type: :runtime
83
- - !ruby/object:Gem::Dependency
84
- name: rails-erd
91
+ prerelease: false
85
92
  version_requirements: !ruby/object:Gem::Requirement
86
93
  requirements:
87
- - - '>='
94
+ - - '='
88
95
  - !ruby/object:Gem::Version
89
- version: '0'
96
+ version: 0.1.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: rails-erd
90
99
  requirement: !ruby/object:Gem::Requirement
91
100
  requirements:
92
- - - '>='
101
+ - - ">="
93
102
  - !ruby/object:Gem::Version
94
103
  version: '0'
95
- prerelease: false
96
104
  type: :runtime
97
- - !ruby/object:Gem::Dependency
98
- name: yard
105
+ prerelease: false
99
106
  version_requirements: !ruby/object:Gem::Requirement
100
107
  requirements:
101
- - - '>='
108
+ - - ">="
102
109
  - !ruby/object:Gem::Version
103
110
  version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: yard
104
113
  requirement: !ruby/object:Gem::Requirement
105
114
  requirements:
106
- - - '>='
115
+ - - ">="
107
116
  - !ruby/object:Gem::Version
108
117
  version: '0'
109
- prerelease: false
110
118
  type: :runtime
111
- description: YARD plugin that uses metasploit-erd to add Entity-Relationship Diagrams to each namespace Module and ActiveRecord::Base subclass's documentation.
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: YARD plugin that uses metasploit-erd to add Entity-Relationship Diagrams
126
+ to each namespace Module and ActiveRecord::Base subclass's documentation.
112
127
  email:
113
128
  - luke_imhoff@rapid7.com
114
129
  executables: []
115
130
  extensions: []
116
131
  extra_rdoc_files: []
117
132
  files:
118
- - .coveralls.yml
119
- - .gitignore
120
- - .rspec
121
- - .simplecov
122
- - .travis.yml
123
- - .yardopts
133
+ - ".coveralls.yml"
134
+ - ".gitignore"
135
+ - ".rspec"
136
+ - ".simplecov"
137
+ - ".travis.yml"
138
+ - ".yardopts"
124
139
  - CHANGELOG.md
125
140
  - CONTRIBUTING.md
126
141
  - Gemfile
@@ -131,7 +146,6 @@ files:
131
146
  - UPGRADING.md
132
147
  - doc/example/images/mdm/module.erd.png
133
148
  - doc/example/images/mdm/module/author.erd.png
134
- - lib/tasks/yard.rake
135
149
  - lib/yard-metasploit-erd.rb
136
150
  - lib/yard/metasploit/erd.rb
137
151
  - lib/yard/metasploit/erd/version.rb
@@ -149,28 +163,28 @@ homepage: https://github.com/rapid7/yard-metasploit-erd
149
163
  licenses:
150
164
  - BSD-3-clause
151
165
  metadata: {}
152
- post_install_message:
166
+ post_install_message:
153
167
  rdoc_options: []
154
168
  require_paths:
155
169
  - lib
156
170
  required_ruby_version: !ruby/object:Gem::Requirement
157
171
  requirements:
158
- - - '>='
172
+ - - ">="
159
173
  - !ruby/object:Gem::Version
160
174
  version: '2.1'
161
175
  required_rubygems_version: !ruby/object:Gem::Requirement
162
176
  requirements:
163
- - - '>='
177
+ - - ">="
164
178
  - !ruby/object:Gem::Version
165
179
  version: '0'
166
180
  requirements: []
167
- rubyforge_project:
168
- rubygems_version: 2.4.5
169
- signing_key:
181
+ rubyforge_project:
182
+ rubygems_version: 2.4.3
183
+ signing_key:
170
184
  specification_version: 4
171
185
  summary: YARD plugin that add Metasploit::ERDs to namespaces and classes
172
186
  test_files:
173
187
  - spec/lib/yard/metasploit/erd/version_spec.rb
174
188
  - spec/lib/yard/metasploit/erd_spec.rb
175
189
  - spec/spec_helper.rb
176
- has_rdoc:
190
+ has_rdoc:
data/lib/tasks/yard.rake DELETED
@@ -1,32 +0,0 @@
1
- # @note All options not specific to any given rake task should go in the .yardopts file so they are available to both
2
- # the below rake tasks and when invoking `yard` from the command line
3
-
4
- if defined? YARD
5
- namespace :yard do
6
- YARD::Rake::YardocTask.new(:doc) do |t|
7
- # --no-stats here as 'stats' task called after will print fuller stats
8
- t.options = ['--no-stats']
9
-
10
- t.after = Proc.new {
11
- Rake::Task['yard:stats'].execute
12
- }
13
- end
14
-
15
- task :doc
16
-
17
- desc "Shows stats for YARD Documentation including listing undocumented modules, classes, constants, and methods"
18
- task :stats do
19
- stats = YARD::CLI::Stats.new
20
- stats.run('--compact', '--list-undoc')
21
- end
22
- end
23
-
24
- # @todo Figure out how to just clone description from yard:doc
25
- desc "Generate YARD documentation"
26
- # allow calling namespace to as a task that goes to default task for namespace
27
- task :yard => ['yard:doc']
28
-
29
- task :default => :yard
30
- else
31
- puts 'YARD not defined, so yard tasks cannot be setup.'
32
- end