graphql_java_gen 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3088c3fd787e2d815792f8bb8f6a0b3fe414829
-  data.tar.gz: 1058513015d8fe05d201f7e72ef5f3a007a94b8a
+  metadata.gz: '09c51e3a3cd35736ed828139d47f92bb6386fbe1'
+  data.tar.gz: 5388a33adb2994b597b8fa9d380c519115363b93
 SHA512:
-  metadata.gz: a3d82e27f2ca1cfbf3a7b7c082a5a75d631607f32f1d6bc2e7fdb54840ed023814ce81c8fe4d6e65bf4576a0c28bb1eadbb988aecb8593362935fa2603648e18
-  data.tar.gz: 1c040d36778c54054772af31b651ac30db8aef05f77812c158e51cbcf33ab98b171d942d1aaf1837439a84de2dcbeefab0063a6e43eb2455e40b666d5ff86d79
+  metadata.gz: 858c440553a22269df660fdd3560e7d3940bf02357984d4bad1543e7913b1f5e1c3a192834e6dc2cd8b37471b102ae1baa6d15e95fc7aadfa1bbeac7e9c57fc9
+  data.tar.gz: 2dc257fbbdae8e1d84d0202605c279fbaea372129cb42cbce7cf6f783baa808bb0791ee5ff5bf532821a3f7c178ddfa9c02434279a3a8e3e6cd89bac6f21a829

data/README.md

@@ -1,4 +1,5 @@
 # GraphQLJavaGen
+[![Build Status](https://travis-ci.org/Shopify/graphql_java_gen.svg?branch=master)](https://travis-ci.org/Shopify/graphql_java_gen)
 
 Generate code for a specific GraphQL schema that provides query
 builders and response classes.
@@ -10,27 +11,21 @@ The code generator requires ruby version 2.1 or later.
 It is recommended to use [bundler](http://bundler.io/) to install
 the code generators ruby package.
 
-Until this project is released, it is recommended to include it into
-a project as a git submodule.
-
-    $ git submodule https://github.com/Shopify/graphql_java_gen.git
-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'graphql_java_gen', path: 'graphql_java_gen'
+gem 'graphql_java_gen'
 ```
 
 And then execute:
 
     $ bundle
 
-The generated code depends on the com.shopify.graphql.support package
-which is in the support directory of this repo. Create a symlink to
-include that project in a [gradle multi-project build
-](https://docs.gradle.org/current/userguide/multi_project_builds.html)
+The generated code depends on the com.shopify.graphql.support java
+package. This can be added to a gradle project by adding the following
+jCenter dependancy to you `build.gradle` file:
 
-    $ ln -s graphql_java_gen/support GraphQLSupport
+    compile 'com.shopify.graphql.support:support:0.1.0'
 
 ## Usage
 

data/codegen/lib/graphql_java_gen.rb

@@ -247,8 +247,9 @@ class GraphQLJavaGen
 
   def java_implements(type)
     return "implements #{type.name} " unless type.object?
-    return "" if type.interfaces.empty?
-    "implements #{type.interfaces.map{ |interface| interface.name }.join(', ')} "
+    interfaces = abstract_types.fetch(type.name)
+    return "" if interfaces.empty?
+    "implements #{interfaces.to_a.join(', ')} "
   end
 
   def java_annotations(field)
@@ -260,4 +261,36 @@ class GraphQLJavaGen
   def type_names_set
     @type_names_set ||= schema.types.map(&:name).to_set
   end
+
+  def abstract_types
+    @abstract_types ||= schema.types.each_with_object({}) do |type, result|
+      case type.kind
+      when 'OBJECT'
+        result[type.name] ||= Set.new
+      when 'INTERFACE', 'UNION'
+        type.possible_types.each do |possible_type|
+          (result[possible_type.name] ||= Set.new).add(type.name)
+        end
+      end
+    end
+  end
+
+  def java_doc(element)
+    doc = ''
+    unless element.description.nil?
+      description = wrap_text(element.description, 100)
+      description = description.chomp("\n").gsub("\n", "\n* ")
+      doc << "/**\n"
+      doc << '* '
+      doc << description
+      doc << "\n*/"
+    end
+    doc
+  end
+
+  def wrap_text(text, col_width=80)
+    text.gsub!( /(\S{#{col_width}})(?=\S)/, '\1 ' )
+    text.gsub!( /(.{1,#{col_width}})(?:\s+|$)/, "\\1\n" )
+    text
+  end
 end

data/codegen/lib/graphql_java_gen/templates/APISchema.java.erb

@@ -23,7 +23,7 @@ import java.util.Map;
 
 public class <%= schema_name %> {
     <% [[:query, schema.query_root_name], [:mutation, schema.mutation_root_name]].each do |operation_type, root_name| %>
-        <% next unless schema.mutation_root_name %>
+        <% next unless root_name %>
         public static <%= root_name %>Query <%= operation_type %>(<%= root_name %>QueryDefinition queryDef) {
             StringBuilder queryString = new StringBuilder("<%= operation_type unless operation_type == :query %>{");
             <%= root_name %>Query query = new <%= root_name %>Query(queryString);
@@ -67,10 +67,12 @@ public class <%= schema_name %> {
 
     <% schema.types.reject{ |type| type.name.start_with?('__') || type.scalar? }.each do |type| %>
         <% case type.kind when 'OBJECT', 'INTERFACE', 'UNION' %>
+            <% fields = type.fields || [] %>
             public interface <%= type.name %>QueryDefinition {
                 void define(<%= type.name %>Query _queryBuilder);
             }
 
+            <%= java_doc(type) %>
             public static class <%= type.name %>Query extends Query<<%= type.name %>Query> {
                 <%= type.name %>Query(StringBuilder _queryBuilder) {
                     super(_queryBuilder);
@@ -82,7 +84,7 @@ public class <%= schema_name %> {
                     <% end %>
                 }
 
-                <% type.fields.each do |field| %>
+                <% fields.each do |field| %>
                     <% next if field.name == "id" && type.object? && type.implement?("Node") %>
                     <% unless field.optional_args.empty? %>
                         public class <%= field.classify_name %>Arguments extends Arguments {
@@ -91,6 +93,7 @@ public class <%= schema_name %> {
                             }
 
                             <% field.optional_args.each do |arg| %>
+                                <%= java_doc(arg) %>
                                 public <%= field.classify_name %>Arguments <%= escape_reserved_word(arg.camelize_name) %>(<%= java_input_type(arg.type) %> value) {
                                     if (value != null) {
                                         startArgument("<%= arg.name %>");
@@ -105,11 +108,13 @@ public class <%= schema_name %> {
                             void define(<%= field.classify_name %>Arguments args);
                         }
 
+                        <%= java_doc(field) %>
                         public <%= type.name %>Query <%= escape_reserved_word(field.camelize_name) %>(<%= java_arg_defs(field, skip_optional: true) %>) {
                             return <%= escape_reserved_word(field.camelize_name) %>(<%= java_arg_expresions_with_empty_optional_args(field) %>);
                         }
                     <% end %>
 
+                    <%= java_doc(field) %>
                     public <%= type.name %>Query <%= escape_reserved_word(field.camelize_name) %>(<%= java_arg_defs(field) %>) {
                         startField("<%= field.name %>");
                         <% unless field.args.empty? %>
@@ -155,15 +160,20 @@ public class <%= schema_name %> {
             }
 
             <% unless type.object? %>
-                public interface <%= type.name %> {
+                <% if type.name == 'Node' %>
+                  public interface <%= type.name %> extends com.shopify.graphql.support.Node {
+                <% else %>
+                  public interface <%= type.name %> {
+                <% end %>
                     String getGraphQlTypeName();
-                    <% type.fields.each do |field| %>
+                    <% fields.each do |field| %>
                         <%= java_output_type(field.type) %> get<%= field.classify_name %>();
                     <% end %>
                 }
             <% end %>
 
             <% class_name = type.object? ? type.name : "Unknown#{type.name}" %>
+            <%= java_doc(type) %>
             public static class <%= class_name %> extends AbstractResponse<<%= class_name %>> <%= java_implements(type) %>{
                 public <%= class_name %>() {
                 }
@@ -173,7 +183,7 @@ public class <%= schema_name %> {
                     String key = field.getKey();
                     String fieldName = getFieldName(key);
                     switch (fieldName) {
-                      <% type.fields.each do |field| %>
+                      <% fields.each do |field| %>
                         case "<%= field.name %>": {
                           <% generate_build_output_code("field.getValue()", field.type) do |statements, expr| %>
                             <%= statements %>
@@ -200,28 +210,6 @@ public class <%= schema_name %> {
                     }
                 <% end %>
 
-                <% if type_names_set.include?('Node') %>
-                  public List<Node> getNodes() {
-                    List<Node> children = new ArrayList<>();
-                    <% if type.object? && type.implement?("Node") %>
-                      children.add(this);
-                    <% end %>
-                    <% type.fields.each do |field| %>
-                      <% next unless field.type.unwrap.object? %>
-                      if (get<%= field.classify_name %>() != null) {
-                        <% if field.type.unwrap_non_null.kind == 'LIST' %>
-                            for (<%= java_output_type(field.type.unwrap) %> elem: get<%= field.classify_name %>()) {
-                              children.addAll(elem.getNodes());
-                            }
-                        <% else %>
-                            children.addAll(get<%= field.classify_name %>().getNodes());
-                        <% end %>
-                      }
-                    <% end %>
-                    return children;
-                  }
-                <% end %>
-
                 <% if type.object? %>
                     public String getGraphQlTypeName() {
                         return "<%= type.name %>";
@@ -246,7 +234,8 @@ public class <%= schema_name %> {
                     }
                 <% end %>
 
-                <% type.fields.each do |field| %>
+                <% fields.each do |field| %>
+                    <%= java_doc(field) %>
                     <%= java_annotations(field) %>
                     public <%= java_output_type(field.type) %> get<%= field.classify_name %>() {
                       return (<%= java_output_type(field.type) %>) get("<%= field.name %>");
@@ -254,14 +243,14 @@ public class <%= schema_name %> {
 
                     <% next if field.name == "id" && type.object? && type.implement?("Node") %>
                     public <%= class_name %> set<%= field.classify_name %>(<%= java_output_type(field.type) %> arg) {
-                      optimisticData.put("<%= field.name %>", arg);
+                      optimisticData.put(getKey("<%= field.name %>"), arg);
                       return this;
                     }
                 <% end %>
 
                   public boolean unwrapsToObject(String key) {
-                    switch (key) {
-                      <% type.fields.each do |field| %>
+                    switch (getFieldName(key)) {
+                      <% fields.each do |field| %>
                         case "<%= field.name %>": return <%= field.type.unwrap.object? %>;
                       <% end %>
                       default: return false;
@@ -327,6 +316,7 @@ public class <%= schema_name %> {
                 }
             }
         <% when 'ENUM' %>
+            <%= java_doc(type) %>
             public enum <%= type.name %> {
               <% type.enum_values.each do |value| %>
                 <%= value.upcase_name %>,

data/codegen/lib/graphql_java_gen/version.rb

@@ -1,3 +1,3 @@
 class GraphQLJavaGen
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_java_gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dylan Thacker-Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql_schema
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: GraphQL java client code generator