Skip to content

Commit 0b2ba69

Browse files
blowmageblowmage
authored
Upgrade yard-doctest dependency (googleapis#2415)
The yard-doctest gem is used to test the code examples in documentation. Upgrade the dependency to include the ability read .yardopts and exclude files. Add the yard rake task to CI and enable yard documentation warnings. Include a couple small documentation fixes as well.
1 parent 72331c5 commit 0b2ba69

44 files changed

Lines changed: 367 additions & 79 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Gemfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ gem "rubocop", "~> 0.50.0"
1111
gem "simplecov", "~> 0.9"
1212
gem "coveralls", "~> 0.7"
1313
gem "yard", "~> 0.9"
14-
gem "yard-doctest", "<= 0.1.8"
14+
gem "yard-doctest", "~> 0.1.13"
1515
gem "gems", "~> 0.8"
1616
gem "actionpack", "~> 4.0"
1717
gem "railties", "~> 4.0"

‎gcloud/Rakefile‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,17 @@ end
6161

6262
require "yard"
6363
require "yard/rake/yardoc_task"
64-
YARD::Rake::YardocTask.new
64+
YARD::Rake::YardocTask.new do |y|
65+
y.options << "--fail-on-warning"
66+
end
6567

6668
desc "Run the CI build"
6769
task :ci do
6870
header "BUILDING gcloud"
6971
header "gcloud rubocop", "*"
7072
sh "bundle exec rake rubocop"
73+
header "gcloud yard", "*"
74+
sh "bundle exec rake yard"
7175
header "gcloud doctest", "*"
7276
sh "bundle exec rake doctest"
7377
header "gcloud test", "*"

‎gcloud/gcloud.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
2929
gem.add_development_dependency "rubocop", "~> 0.50.0"
3030
gem.add_development_dependency "simplecov", "~> 0.9"
3131
gem.add_development_dependency "yard", "~> 0.9"
32-
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
32+
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
3333

3434
gem.post_install_message = "gcloud is now google-cloud, please change the gem name in your dependencies"
3535
end

‎google-cloud-bigquery/Rakefile‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ namespace :benchmark do
133133
end
134134

135135
desc "Run yard-doctest example tests."
136-
task doctest: :yard do
137-
sh "bundle exec yard doctest"
136+
task :doctest do
137+
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
138138
end
139139

140140
desc "Start an interactive shell."
@@ -154,13 +154,17 @@ end
154154

155155
require "yard"
156156
require "yard/rake/yardoc_task"
157-
YARD::Rake::YardocTask.new
157+
YARD::Rake::YardocTask.new do |y|
158+
y.options << "--fail-on-warning"
159+
end
158160

159161
desc "Run the CI build"
160162
task :ci do
161163
header "BUILDING google-cloud-bigquery"
162164
header "google-cloud-bigquery rubocop", "*"
163165
sh "bundle exec rake rubocop"
166+
header "google-cloud-bigquery yard", "*"
167+
sh "bundle exec rake yard"
164168
header "google-cloud-bigquery doctest", "*"
165169
sh "bundle exec rake doctest"
166170
header "google-cloud-bigquery test", "*"

‎google-cloud-bigquery/google-cloud-bigquery.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
3232
gem.add_development_dependency "rubocop", "~> 0.50.0"
3333
gem.add_development_dependency "simplecov", "~> 0.9"
3434
gem.add_development_dependency "yard", "~> 0.9"
35-
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
35+
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
3636
end

‎google-cloud-bigquery/support/doctest_helper.rb‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,6 @@ def mock_storage
163163
# Google::Cloud::Bigquery::Dataset#access@Manage the access rules by passing a block:
164164
doctest.before "Google::Cloud::Bigquery::Dataset#access" do
165165
mock_bigquery do |mock|
166-
def other_dataset_view_object
167-
"foo"
168-
end
169166
mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset]
170167
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"]
171168
mock.expect :patch_dataset, dataset_full_gapi, ["my-project", "my_dataset", Google::Apis::BigqueryV2::Dataset, Hash]
@@ -361,9 +358,6 @@ def other_dataset_view_object
361358

362359
doctest.before "Google::Cloud::Bigquery::Dataset::Access" do
363360
mock_bigquery do |mock|
364-
def other_dataset_view_object
365-
"foo"
366-
end
367361
mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset]
368362
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"]
369363
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_other_dataset"] # for view methods
@@ -1286,3 +1280,7 @@ def list_projects_gapi count = 2, token = nil
12861280
def time_millis
12871281
(Time.now.to_f * 1000).floor.to_s
12881282
end
1283+
1284+
def other_dataset_view_object
1285+
"foo"
1286+
end

‎google-cloud-bigtable/Rakefile‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,9 @@ end
146146

147147
require "yard"
148148
require "yard/rake/yardoc_task"
149-
YARD::Rake::YardocTask.new
149+
YARD::Rake::YardocTask.new do |y|
150+
# y.options << "--fail-on-warning"
151+
end
150152

151153
desc "Run yard-doctest example tests."
152154
task :doctest do
@@ -158,6 +160,9 @@ task :ci do
158160
header "BUILDING google-cloud-bigtable"
159161
header "google-cloud-bigtable rubocop", "*"
160162
sh "bundle exec rake rubocop"
163+
header "google-cloud-bigtable yard", "*"
164+
header "bigtable yard still had warnings", "!"
165+
sh "bundle exec rake yard"
161166
header "google-cloud-bigtable doctest", "*"
162167
sh "bundle exec rake doctest"
163168
header "google-cloud-bigtable test", "*"

‎google-cloud-bigtable/google-cloud-bigtable.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
3232
gem.add_development_dependency "rubocop", "~> 0.50.0"
3333
gem.add_development_dependency "simplecov", "~> 0.9"
3434
gem.add_development_dependency "yard", "~> 0.9"
35-
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
35+
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
3636
end

‎google-cloud-core/Rakefile‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,18 @@ end
6060

6161
require "yard"
6262
require "yard/rake/yardoc_task"
63-
YARD::Rake::YardocTask.new
63+
YARD::Rake::YardocTask.new do |y|
64+
y.options << "--fail-on-warning"
65+
end
6466

6567
desc "Run the CI build"
6668
task :ci do
6769
header "BUILDING google-cloud-core"
6870
header "google-cloud-core rubocop", "*"
6971
sh "bundle exec rake rubocop"
7072
header "google-cloud-core doctest", "*"
73+
sh "bundle exec rake yard"
74+
header "google-cloud-core yard", "*"
7175
sh "bundle exec rake doctest"
7276
header "google-cloud-core test", "*"
7377
sh "bundle exec rake test"

‎google-cloud-core/google-cloud-core.gemspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ Gem::Specification.new do |gem|
3030
gem.add_development_dependency "rubocop", "~> 0.50.0"
3131
gem.add_development_dependency "simplecov", "~> 0.9"
3232
gem.add_development_dependency "yard", "~> 0.9"
33-
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
33+
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
3434
end

0 commit comments

Comments
 (0)