[DOCS] Add doc examples

estolfo · estolfo · commit a6b1ad4ad582 · 2019-08-22T16:59:41.000+02:00
diff --git a/Gemfile b/Gemfile
@@ -27,3 +27,7 @@ end
 if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
   gem "test-unit", '~> 2'
 end
+
+group :development do
+  gem 'rspec'
+end
diff --git a/Rakefile b/Rakefile
@@ -230,3 +230,16 @@ task :update_version, :old, :new do |task, args|
         "rake release"
         "\n"
 end
+
+require 'rake/testtask'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc 'Run code examples for documentation'
+task :doc_examples do
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'example/docs/spec/**{,/*/**}/*_spec.rb'
+  end
+  Rake::Task['spec'].execute
+end
diff --git a/example/docs/asciidoc/docs/delete/47b5ff897f26e9c943cee5c06034181d.adoc b/example/docs/asciidoc/docs/delete/47b5ff897f26e9c943cee5c06034181d.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/delete_spec.rb[tag=47b5ff897f26e9c943cee5c06034181d,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/delete/c5e5873783246c7b1c01d8464fed72c4.adoc b/example/docs/asciidoc/docs/delete/c5e5873783246c7b1c01d8464fed72c4.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/delete_spec.rb[tag=c5e5873783246c7b1c01d8464fed72c4,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/delete/d90a84a24a407731dfc1929ac8327746.adoc b/example/docs/asciidoc/docs/delete/d90a84a24a407731dfc1929ac8327746.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/delete_spec.rb[tag=d90a84a24a407731dfc1929ac8327746,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/0ba0b2db24852abccb7c0fc1098d566e.adoc b/example/docs/asciidoc/docs/get/0ba0b2db24852abccb7c0fc1098d566e.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=0ba0b2db24852abccb7c0fc1098d566e,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/138ccd89f72aa7502dd9578403dcc589.adoc b/example/docs/asciidoc/docs/get/138ccd89f72aa7502dd9578403dcc589.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=138ccd89f72aa7502dd9578403dcc589,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/1d65cb6d055c46a1bde809687d835b71.adoc b/example/docs/asciidoc/docs/get/1d65cb6d055c46a1bde809687d835b71.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=1d65cb6d055c46a1bde809687d835b71,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/2468ab381257d759d8a88af1141f6f9c.adoc b/example/docs/asciidoc/docs/get/2468ab381257d759d8a88af1141f6f9c.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=2468ab381257d759d8a88af1141f6f9c,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/5eabcdbf61bfcb484dc694f25c2bba36.adoc b/example/docs/asciidoc/docs/get/5eabcdbf61bfcb484dc694f25c2bba36.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=5eabcdbf61bfcb484dc694f25c2bba36,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/69a7be47f85138b10437113ab2f0d72d.adoc b/example/docs/asciidoc/docs/get/69a7be47f85138b10437113ab2f0d72d.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=69a7be47f85138b10437113ab2f0d72d,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/710c7871f20f176d51209b1574b0d61b.adoc b/example/docs/asciidoc/docs/get/710c7871f20f176d51209b1574b0d61b.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=710c7871f20f176d51209b1574b0d61b,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/745f9b8cdb8e91073f6e520e1d9f8c05.adoc b/example/docs/asciidoc/docs/get/745f9b8cdb8e91073f6e520e1d9f8c05.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=745f9b8cdb8e91073f6e520e1d9f8c05,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/89a8ac1509936acc272fc2d72907bc45.adoc b/example/docs/asciidoc/docs/get/89a8ac1509936acc272fc2d72907bc45.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=89a8ac1509936acc272fc2d72907bc45,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/8fdf2344c4fb3de6902ad7c5735270df.adoc b/example/docs/asciidoc/docs/get/8fdf2344c4fb3de6902ad7c5735270df.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=8fdf2344c4fb3de6902ad7c5735270df,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/913770050ebbf3b9b549a899bc11060a.adoc b/example/docs/asciidoc/docs/get/913770050ebbf3b9b549a899bc11060a.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=913770050ebbf3b9b549a899bc11060a,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/98234499cfec70487cec5d013e976a84.adoc b/example/docs/asciidoc/docs/get/98234499cfec70487cec5d013e976a84.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=98234499cfec70487cec5d013e976a84,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/d222c6a6ec7a3beca6c97011b0874512.adoc b/example/docs/asciidoc/docs/get/d222c6a6ec7a3beca6c97011b0874512.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=d222c6a6ec7a3beca6c97011b0874512,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/get/fbcf5078a6a9e09790553804054c36b3.adoc b/example/docs/asciidoc/docs/get/fbcf5078a6a9e09790553804054c36b3.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/get_spec.rb[tag=fbcf5078a6a9e09790553804054c36b3,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/048d8abd42d094bbdcf4452a58ccb35b.adoc b/example/docs/asciidoc/docs/index/048d8abd42d094bbdcf4452a58ccb35b.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=048d8abd42d094bbdcf4452a58ccb35b,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/1f336ecc62480c1d56351cc2f82d0d08.adoc b/example/docs/asciidoc/docs/index/1f336ecc62480c1d56351cc2f82d0d08.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=1f336ecc62480c1d56351cc2f82d0d08,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/36818c6d9f434d387819c30bd9addb14.adoc b/example/docs/asciidoc/docs/index/36818c6d9f434d387819c30bd9addb14.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=36818c6d9f434d387819c30bd9addb14,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/625dc94df1f9affb49a082fd99d41620.adoc b/example/docs/asciidoc/docs/index/625dc94df1f9affb49a082fd99d41620.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=625dc94df1f9affb49a082fd99d41620,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/b918d6b798da673a33e49b94f61dcdc0.adoc b/example/docs/asciidoc/docs/index/b918d6b798da673a33e49b94f61dcdc0.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=b918d6b798da673a33e49b94f61dcdc0,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/bb143628fd04070683eeeadc9406d9cc.adoc b/example/docs/asciidoc/docs/index/bb143628fd04070683eeeadc9406d9cc.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=bb143628fd04070683eeeadc9406d9cc,indent=0]
+----
diff --git a/example/docs/asciidoc/docs/index/d718b63cf1b6591a1d59a0cf4fd995eb.adoc b/example/docs/asciidoc/docs/index/d718b63cf1b6591a1d59a0cf4fd995eb.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/index_spec.rb[tag=d718b63cf1b6591a1d59a0cf4fd995eb,indent=0]
+----
diff --git a/example/docs/asciidoc/setup/install/check_running/3d1ff6097e2359f927c88c2ccdb36252.adoc b/example/docs/asciidoc/setup/install/check_running/3d1ff6097e2359f927c88c2ccdb36252.adoc
@@ -0,0 +1,4 @@
+[source,ruby]
+----
+include::./../../../spec/check_running_spec.rb[tag=048d8abd42d094bbdcf4452a58ccb35b,indent=0]
+----
diff --git a/example/docs/spec/check_running_spec.rb b/example/docs/spec/check_running_spec.rb
@@ -0,0 +1,21 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require_relative 'spec_helper'
+
+describe 'CheckRunning documentation examples' do
+  let(:client) do
+    DEFAULT_CLIENT
+  end
+
+  it 'executes the example code - d1ff6097e2359f927c88c2ccdb36252' do
+    # tag::3d1ff6097e2359f927c88c2ccdb36252[]
+    response = client.info
+    # end::3d1ff6097e2359f927c88c2ccdb36252[]
+
+    puts '-'*50
+    puts response
+    puts '-'*50
+  end
+end
diff --git a/example/docs/spec/delete_spec.rb b/example/docs/spec/delete_spec.rb
@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require_relative 'spec_helper'
+
+describe 'Delete documentation examples' do
+  let(:client) do
+    DEFAULT_CLIENT
+  end
+
+  before do
+    client.indices.create(index: 'twitter')
+    client.index(index: 'twitter', id: 1, body: {})
+  end
+
+  after do
+    client.indices.delete(index: 'twitter')
+  end
+
+  it 'executes the example code: - d1ff6097e2359f927c88c2ccdb36252' do
+    # tag::3d1ff6097e2359f927c88c2ccdb36252[]
+    response = client.delete(index: 'twitter', id: 1)
+    # end::3d1ff6097e2359f927c88c2ccdb36252[]
+
+    puts '-'*50
+    puts response
+    puts '-'*50
+  end
+
+  it 'executes the example code: - 47b5ff897f26e9c943cee5c06034181d' do
+    # tag::3d1ff6097e2359f927c88c2ccdb36252[]
+    response = client.delete(index: 'twitter', id: 1, routing: 'kimchy')
+    # end::3d1ff6097e2359f927c88c2ccdb36252[]
+
+    puts '-'*50
+    puts response
+    puts '-'*50
+  end
+
+  it 'executes the example code: - d90a84a24a407731dfc1929ac8327746' do
+    # tag::3d1ff6097e2359f927c88c2ccdb36252[]
+    response = client.delete(index: 'twitter', id: 1, routing: 'kimchy', timeout: '5m')
+    # end::3d1ff6097e2359f927c88c2ccdb36252[]
+
+    puts '-'*50
+    puts response
+    puts '-'*50
+  end
+end
diff --git a/example/docs/spec/get_spec.rb b/example/docs/spec/get_spec.rb
diff --git a/example/docs/spec/index_spec.rb b/example/docs/spec/index_spec.rb
diff --git a/example/docs/spec/spec_helper.rb b/example/docs/spec/spec_helper.rb

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +[source,ruby]
 +----
 +include::./../../../spec/delete_spec.rb[tag=47b5ff897f26e9c943cee5c06034181d,indent=0]
 +----