Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade yard-doctest dependency #2415

Merged
merged 8 commits into from
Sep 10, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ gem "rubocop", "~> 0.50.0"
gem "simplecov", "~> 0.9"
gem "coveralls", "~> 0.7"
gem "yard", "~> 0.9"
gem "yard-doctest", "<= 0.1.8"
gem "yard-doctest", "~> 0.1.13"
gem "gems", "~> 0.8"
gem "actionpack", "~> 4.0"
gem "railties", "~> 4.0"
Expand Down
6 changes: 5 additions & 1 deletion gcloud/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,17 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING gcloud"
header "gcloud rubocop", "*"
sh "bundle exec rake rubocop"
header "gcloud yard", "*"
sh "bundle exec rake yard"
header "gcloud doctest", "*"
sh "bundle exec rake doctest"
header "gcloud test", "*"
Expand Down
2 changes: 1 addition & 1 deletion gcloud/gcloud.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"

gem.post_install_message = "gcloud is now google-cloud, please change the gem name in your dependencies"
end
10 changes: 7 additions & 3 deletions google-cloud-bigquery/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ namespace :benchmark do
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

desc "Start an interactive shell."
Expand All @@ -154,13 +154,17 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-bigquery"
header "google-cloud-bigquery rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-bigquery yard", "*"
sh "bundle exec rake yard"
header "google-cloud-bigquery doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-bigquery test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-bigquery/google-cloud-bigquery.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
10 changes: 4 additions & 6 deletions google-cloud-bigquery/support/doctest_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,6 @@ def mock_storage
# Google::Cloud::Bigquery::Dataset#access@Manage the access rules by passing a block:
doctest.before "Google::Cloud::Bigquery::Dataset#access" do
mock_bigquery do |mock|
def other_dataset_view_object
"foo"
end
mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset]
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"]
mock.expect :patch_dataset, dataset_full_gapi, ["my-project", "my_dataset", Google::Apis::BigqueryV2::Dataset, Hash]
Expand Down Expand Up @@ -361,9 +358,6 @@ def other_dataset_view_object

doctest.before "Google::Cloud::Bigquery::Dataset::Access" do
mock_bigquery do |mock|
def other_dataset_view_object
"foo"
end
mock.expect :insert_dataset, dataset_full_gapi, ["my-project", Google::Apis::BigqueryV2::Dataset]
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_dataset"]
mock.expect :get_dataset, dataset_full_gapi, ["my-project", "my_other_dataset"] # for view methods
Expand Down Expand Up @@ -1286,3 +1280,7 @@ def list_projects_gapi count = 2, token = nil
def time_millis
(Time.now.to_f * 1000).floor.to_s
end

def other_dataset_view_object
"foo"
end
7 changes: 6 additions & 1 deletion google-cloud-bigtable/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,9 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
# y.options << "--fail-on-warning"
end

desc "Run yard-doctest example tests."
task :doctest do
Expand All @@ -158,6 +160,9 @@ task :ci do
header "BUILDING google-cloud-bigtable"
header "google-cloud-bigtable rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-bigtable yard", "*"
header "bigtable yard still had warnings", "!"
sh "bundle exec rake yard"
header "google-cloud-bigtable doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-bigtable test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-bigtable/google-cloud-bigtable.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
6 changes: 5 additions & 1 deletion google-cloud-core/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,18 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-core"
header "google-cloud-core rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-core doctest", "*"
sh "bundle exec rake yard"
header "google-cloud-core yard", "*"
sh "bundle exec rake doctest"
header "google-cloud-core test", "*"
sh "bundle exec rake test"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-core/google-cloud-core.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
11 changes: 8 additions & 3 deletions google-cloud-datastore/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ namespace :acceptance do
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

desc "Start an interactive shell."
Expand All @@ -101,13 +101,18 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
# y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-datastore"
header "google-cloud-datastore rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-datastore yard", "*"
header "datastore yard still had warnings", "!"
sh "bundle exec rake yard"
header "google-cloud-datastore doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-datastore test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-datastore/google-cloud-datastore.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
14 changes: 9 additions & 5 deletions google-cloud-debugger/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ task :recompile do
end

desc "Run tests."
task :test => :compile do
task test: :compile do
$LOAD_PATH.unshift "lib", "test"
Dir.glob("test/**/*_test.rb").each { |file| require_relative file }
end
Expand Down Expand Up @@ -130,8 +130,8 @@ namespace :integration do
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

desc "Start an interactive shell."
Expand All @@ -151,13 +151,17 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
task ci: :compile do
header "BUILDING google-cloud-debugger"
header "google-cloud-debugger rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-debugger yard", "*"
sh "bundle exec rake yard"
header "google-cloud-debugger doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-debugger test", "*"
Expand Down
10 changes: 7 additions & 3 deletions google-cloud-dns/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ namespace :acceptance do
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

desc "Start an interactive shell."
Expand All @@ -129,13 +129,17 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-dns"
header "google-cloud-dns rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-dns yard", "*"
sh "bundle exec rake yard"
header "google-cloud-dns doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-dns test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-dns/google-cloud-dns.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
6 changes: 5 additions & 1 deletion google-cloud-env/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,17 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-env"
header "google-cloud-env rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-env yard", "*"
sh "bundle exec rake yard"
header "google-cloud-env doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-env test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-env/google-cloud-env.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
11 changes: 8 additions & 3 deletions google-cloud-error_reporting/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ namespace :acceptance do
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

namespace :integration do
Expand Down Expand Up @@ -131,13 +131,18 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
# y.options << "--fail-on-warning"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-error_reporting"
header "google-cloud-error_reporting rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-error_reporting yard", "*"
header "error_reporting yard still had warnings", "!"
sh "bundle exec rake yard"
header "google-cloud-error_reporting doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-error_reporting test", "*"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rack", ">= 0.1"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end
11 changes: 8 additions & 3 deletions google-cloud-firestore/Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -154,18 +154,23 @@ end

require "yard"
require "yard/rake/yardoc_task"
YARD::Rake::YardocTask.new
YARD::Rake::YardocTask.new do |y|
# y.options << "--fail-on-warning"
end

desc "Run yard-doctest example tests."
task doctest: :yard do
sh "bundle exec yard doctest"
task :doctest do
sh "bundle exec yard config load_plugins true && bundle exec yard doctest"
end

desc "Run the CI build"
task :ci do
header "BUILDING google-cloud-firestore"
header "google-cloud-firestore rubocop", "*"
sh "bundle exec rake rubocop"
header "google-cloud-firestore yard", "*"
header "firestore yard still had warnings", "!"
sh "bundle exec rake yard"
header "google-cloud-firestore doctest", "*"
sh "bundle exec rake doctest"
header "google-cloud-firestore test", "*"
Expand Down
2 changes: 1 addition & 1 deletion google-cloud-firestore/google-cloud-firestore.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,5 @@ Gem::Specification.new do |gem|
gem.add_development_dependency "rubocop", "~> 0.50.0"
gem.add_development_dependency "simplecov", "~> 0.9"
gem.add_development_dependency "yard", "~> 0.9"
gem.add_development_dependency "yard-doctest", "<= 0.1.8"
gem.add_development_dependency "yard-doctest", "~> 0.1.13"
end