Process markdown cloud links for PHP #1091

michaelbausor · 2017-03-03T19:05:03Z

Prepend https://cloud.google.com to cloud site links where necessary.

Borrows from https://github.com/googleapis/toolkit/blob/master/src/main/java/com/google/api/codegen/util/ruby/RubyCommentReformatter.java

codecov-io · 2017-03-03T19:09:38Z

Codecov Report

Merging #1091 into master will increase coverage by 0.37%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1091      +/-   ##
============================================
+ Coverage     86.14%   86.52%   +0.37%     
- Complexity     3770     3816      +46     
============================================
  Files           380      376       -4     
  Lines         14967    15260     +293     
  Branches       1666     1688      +22     
============================================
+ Hits          12893    13203     +310     
+ Misses         1624     1609      -15     
+ Partials        450      448       -2

Impacted Files	Coverage Δ	Complexity Δ
.../api/codegen/util/ruby/RubyCommentReformatter.java	`98.18% <100%> (+4.35%)`	`17 <1> (-8)`	⬇️
...le/api/codegen/util/php/PhpCommentReformatter.java	`100% <100%> (ø)`	`3 <2> (ø)`	⬇️
.../api/codegen/util/py/PythonCommentReformatter.java	`100% <100%> (+5.76%)`	`8 <0> (-7)`	⬇️
...ogle/api/codegen/util/js/JSCommentReformatter.java	`100% <100%> (+2.94%)`	`8 <1> (-5)`	⬇️
...n/java/com/google/api/codegen/CommentPatterns.java	`91.66% <100%> (ø)`	`1 <0> (ø)`	⬇️
...om/google/api/codegen/util/CommentTransformer.java	`100% <100%> (ø)`	`5 <5> (?)`
.../java/com/google/api/codegen/util/LinkPattern.java	`100% <100%> (ø)`	`4 <4> (?)`
...pi/codegen/viewmodel/StaticLangClientFileView.java	`83.33% <0%> (-16.67%)`	`4% <0%> (+1%)`
...odegen/viewmodel/testing/ClientTestAssertView.java	`83.33% <0%> (-16.67%)`	`4% <0%> (-2%)`
.../java/com/google/api/codegen/discovery/Method.java	`90.32% <0%> (-9.68%)`	`8% <0%> (+2%)`
... and 40 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 79a2750...0a4e52c. Read the comment docs.

michaelbausor · 2017-04-04T18:20:43Z

Ping - sorry I forgot about this one!

michaelbausor · 2017-04-26T16:39:52Z

Followup ping

src/main/java/com/google/api/codegen/util/php/PhpCommentReformatter.java

+      m.appendReplacement(sb, Matcher.quoteReplacement(String.format("[%s](%s)", m.group(1), url)));
+    } while (m.find());
+    m.appendTail(sb);
+    return sb.toString();


src/main/java/com/google/api/codegen/util/CommentReformatting.java

+
+  /**
+   * The Formatter object allows the static methods in CommentReformatting to be used via a fluent
+   * interface.


michaelbausor · 2017-05-11T22:59:02Z

Ping

src/main/java/com/google/api/codegen/util/CommentReformatter.java

+    return new Function<Matcher, String>() {
+      @Override
+      public String apply(Matcher matcher) {
+        String url = urlPrefix + matcher.group(2);


src/main/java/com/google/api/codegen/util/js/JSCommentReformatter.java

-    return sb.toString();
+    return CommentTransformer.of(comment)
+        .transform(ProtoLinkPattern.PROTO.createTransformation("{@link %s}"))
+        .transform(ProtoLinkPattern.CLOUD.createTransformation("[%s](%s)"))


src/main/java/com/google/api/codegen/util/ruby/RubyCommentReformatter.java

+        .transform(PROTO_TO_RUBY_DOC_TRANSFORMATION)
+        .transform(ProtoLinkPattern.CLOUD.createTransformation("{%s}[%s]"))
+        .transform(ProtoLinkPattern.ABSOLUTE.createTransformation("{%s}[%s]"))
+        .transform(HEADLINE_TRANSFORMATION)


garrettjonesgoogle · 2017-05-26T21:45:29Z

LBTM (looks beautiful to me)

* Fix JSON pretty print in Ruby sample (#1254) * Ruby: README Overhaul (feat. examples) (#1245) * go: use new metadata methods (#1262) Updates googleapis/google-cloud-go#624. metadata.FromContext and metdata.NewContext are replaced by metadata.{New,From}{Incoming,Outgoing}Context. Generated unit tests now verify that x-goog-api-client header is inserted. Additionally, clients now save a string slice containing x-goog-api-client header value instead of the value by itself. This is a small optimization so that we don't create a new slice every time. * Change media body from an object to a string (#1256) Samples fail before sending a request if the media body is an object. * Fix NONE auth Go sample (#1261) * Change Node.js unit test require. (#1264) * Ruby: Allow doc gapic generation to generate tests. (#1266) * Ruby: Remove aliasing from method samples and tests (#1253) * Ruby: Fix broken baselines from aliasing fix (#1269) * Remove unused code (#1270) * Python: README overhaul. (#1263) * Ruby: Update gemspec and add useful metadata files (#1258) * Ruby: Update gemspec and add useful metadata files * Specify HTTP client when constructing client (#1275) If a HTTP client is not passed to `build`, the Google API Python client will create a default one and attempt to authenticate it. This causes failures in environments where ADC auth is not available (Travis). In any case, it's not useful to access any auth code in the mock tests. This commit removes that possibility. * Fix JSON print in Ruby (#1274) It turns out that `to_h` is not a method available on every object returned by the samples at the moment. Also, there's some kind of decoding bug showing up in certain samples where the JSON module is unable to unparse the response. It's troublesome to have so much boilerplate just to pretty print. This commit removes the pretty calls in favor of the vanilla `to_json` method implemented by the base model class in the Ruby client. In the future, once the bugs w.r.t `pretty_generate` have been resolved, we can revert. * NodeJS: Update version index to support partial veneers (#1267) * NodeJS: Updates to package.json (#1268) * Migrate import disambiguation to Python MVVM (#1243) * Fix Node package.json (#1282) * go: use time.UnixNano instead of testutil.UIDSpace (#1279) Since generated code should be testable from api-client-staging repo, we want to reduce dependency on other cloud.google.com/go packages, especially internal ones. Clients will still depend on testutil for ProjID and TokenSource. This is OK, since they can be easily reimplemented in google-client-staging repo itself. * Update Java grpc metadata for new staging structure (#1265) * PHP: share credentials with operations client (#1283) * java: move CredentialProvider up to ClientSettings (#1251) This implements the client side changes to support googleapis/gax-java#305. * NodeJS: generate readme. (#1240) * NodeJS: Small additions to the package.json (#1289) * NodeJS: Use fileheader for copyright lines. (#1293) * NodeJS: Use correct casing for partial veneers (#1295) * NodeJS: Small readme fix from GCN reviews (#1294) * go: make longrunning methods use generated longrunning client (#1288) The cloud.google.com/go/longrunning package will need to change slightly to accomodate this change. xGoogHeader is now gone from the generated longrunnging types, as the header will be automatically inserted by LROClient itself. * NodeJS: Update partial veneer surface to add api documentation. (#1296) * NodeJS: Metadata updates. (#1298) * Readme: Update readme templates to add api summaries. (#1299) * Add PHP Exception tests (#951) * Add exception tests * Remove unnecessary checks in exception tests * Process markdown cloud links for PHP (#1091) * Process markdown cloud links for PHP * Restructure comment formatting * go: return error creating LRO client instead of panicking (#1300)

* merge master to Discogapic (#1304) * Fix JSON pretty print in Ruby sample (#1254) * Ruby: README Overhaul (feat. examples) (#1245) * go: use new metadata methods (#1262) Updates googleapis/google-cloud-go#624. metadata.FromContext and metdata.NewContext are replaced by metadata.{New,From}{Incoming,Outgoing}Context. Generated unit tests now verify that x-goog-api-client header is inserted. Additionally, clients now save a string slice containing x-goog-api-client header value instead of the value by itself. This is a small optimization so that we don't create a new slice every time. * Change media body from an object to a string (#1256) Samples fail before sending a request if the media body is an object. * Fix NONE auth Go sample (#1261) * Change Node.js unit test require. (#1264) * Ruby: Allow doc gapic generation to generate tests. (#1266) * Ruby: Remove aliasing from method samples and tests (#1253) * Ruby: Fix broken baselines from aliasing fix (#1269) * Remove unused code (#1270) * Python: README overhaul. (#1263) * Ruby: Update gemspec and add useful metadata files (#1258) * Ruby: Update gemspec and add useful metadata files * Specify HTTP client when constructing client (#1275) If a HTTP client is not passed to `build`, the Google API Python client will create a default one and attempt to authenticate it. This causes failures in environments where ADC auth is not available (Travis). In any case, it's not useful to access any auth code in the mock tests. This commit removes that possibility. * Fix JSON print in Ruby (#1274) It turns out that `to_h` is not a method available on every object returned by the samples at the moment. Also, there's some kind of decoding bug showing up in certain samples where the JSON module is unable to unparse the response. It's troublesome to have so much boilerplate just to pretty print. This commit removes the pretty calls in favor of the vanilla `to_json` method implemented by the base model class in the Ruby client. In the future, once the bugs w.r.t `pretty_generate` have been resolved, we can revert. * NodeJS: Update version index to support partial veneers (#1267) * NodeJS: Updates to package.json (#1268) * Migrate import disambiguation to Python MVVM (#1243) * Fix Node package.json (#1282) * go: use time.UnixNano instead of testutil.UIDSpace (#1279) Since generated code should be testable from api-client-staging repo, we want to reduce dependency on other cloud.google.com/go packages, especially internal ones. Clients will still depend on testutil for ProjID and TokenSource. This is OK, since they can be easily reimplemented in google-client-staging repo itself. * Update Java grpc metadata for new staging structure (#1265) * PHP: share credentials with operations client (#1283) * java: move CredentialProvider up to ClientSettings (#1251) This implements the client side changes to support googleapis/gax-java#305. * NodeJS: generate readme. (#1240) * NodeJS: Small additions to the package.json (#1289) * NodeJS: Use fileheader for copyright lines. (#1293) * NodeJS: Use correct casing for partial veneers (#1295) * NodeJS: Small readme fix from GCN reviews (#1294) * go: make longrunning methods use generated longrunning client (#1288) The cloud.google.com/go/longrunning package will need to change slightly to accomodate this change. xGoogHeader is now gone from the generated longrunnging types, as the header will be automatically inserted by LROClient itself. * NodeJS: Update partial veneer surface to add api documentation. (#1296) * NodeJS: Metadata updates. (#1298) * Readme: Update readme templates to add api summaries. (#1299) * Add PHP Exception tests (#951) * Add exception tests * Remove unnecessary checks in exception tests * Process markdown cloud links for PHP (#1091) * Process markdown cloud links for PHP * Restructure comment formatting * go: return error creating LRO client instead of panicking (#1300) * fails b/c Node.empty() uses null params * one test passes * all current tests pass * tests for Node parent() * Test * removed Method.empty(): * reordering methods for convention * made Node.from(Node, path) methods package private * removed path() from Document, Schema, and Method * removed static constructors with empty parent node

Process markdown cloud links for PHP

54fa70a

michaelbausor requested review from shinfan and garrettjonesgoogle March 3, 2017 19:05

garrettjonesgoogle reviewed Apr 28, 2017

View reviewed changes

src/main/java/com/google/api/codegen/util/php/PhpCommentReformatter.java Outdated

m.appendReplacement(sb, Matcher.quoteReplacement(String.format("[%s](%s)", m.group(1), url)));

} while (m.find());

m.appendTail(sb);

return sb.toString();

This comment was marked as spam.

Sign in to view

michaelbausor added 4 commits May 3, 2017 08:19

Add comment reformatter to share code

834373d

Add fluent interface

cea4eeb

Merge branch 'master' into php-markdown-docs

0c83bf0

Remove trim

1b901db

garrettjonesgoogle reviewed May 4, 2017

View reviewed changes

src/main/java/com/google/api/codegen/util/CommentReformatting.java Outdated

/**

* The Formatter object allows the static methods in CommentReformatting to be used via a fluent

* interface.

This comment was marked as spam.

Sign in to view

Switch to fluent interface only, support python

7dba1e4

garrettjonesgoogle reviewed May 16, 2017

View reviewed changes

michaelbausor added 3 commits May 18, 2017 09:34

Restructure to CommentTransformer

8e3d52d

Revert rename of CommentReformatter

191bb30

Push functionality into ProtoLinkPattern

78f9801

garrettjonesgoogle reviewed May 23, 2017

View reviewed changes

michaelbausor added 4 commits May 26, 2017 11:05

Remove use of matcher in function signatures

726a2bf

Change model to constructed transformer

06bceaf

Update handling of link formats

0ca0060

Update docs

0a4e52c

michaelbausor merged commit d31e0d8 into googleapis:master May 26, 2017

michaelbausor deleted the php-markdown-docs branch May 26, 2017 21:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Process markdown cloud links for PHP #1091

Process markdown cloud links for PHP #1091

michaelbausor commented Mar 3, 2017

codecov-io commented Mar 3, 2017 •

edited

Loading

michaelbausor commented Apr 4, 2017

michaelbausor commented Apr 26, 2017

This comment was marked as spam.

This comment was marked as spam.

michaelbausor commented May 11, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

garrettjonesgoogle commented May 26, 2017

Process markdown cloud links for PHP #1091

Process markdown cloud links for PHP #1091

Conversation

michaelbausor commented Mar 3, 2017

codecov-io commented Mar 3, 2017 • edited Loading

Codecov Report

michaelbausor commented Apr 4, 2017

michaelbausor commented Apr 26, 2017

This comment was marked as spam.

This comment was marked as spam.

michaelbausor commented May 11, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

garrettjonesgoogle commented May 26, 2017

codecov-io commented Mar 3, 2017 •

edited

Loading