agoo 2.12.1 → 2.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90300e7360e69307918af1de597ef316750dfe9b1970c5f92ff57913bd971401
-  data.tar.gz: dba7a5bda4f9d1405d17f738e84d049a8a9d32b79336581d0b7f11f190ec11ea
+  metadata.gz: ecda60c70d9a3bbf2ca2e9917f7cce3d073366a66684045425ffa770c2a0fb56
+  data.tar.gz: 5bbbd47dfc06d93b0aa93827391cabff6728a4feb2323286e36948c25b2e7968
 SHA512:
-  metadata.gz: faccbdb3de3a337fd54106bacf060cac12aec30171f9401b3f672b8f3c49a0a968decdd7cf2c4726be00810f2d788ab14bdaa1479b8b148017211db78a5f2d08
-  data.tar.gz: 8fbff6ad71237aa796d00cde0eeb6a5b1600a6a188c53af7319bee74ff1f146df8e78ed2cfdff33404c3dd38de568654fe5e8dad2427e3ff780378bba2cbb74b
+  metadata.gz: 38785b90ca7250269e33afdc9358da60351ccee96c4f4cbeff6dd4f7dbef445456e59010c9303c06538e4b070ed5ef2e563a97ba6d06ac524556e2dd53d9e91e
+  data.tar.gz: 93272b21eb3d4f3457bd09633503f2720a0d1f044abb3a34f68f56a9afa7be7b19dbf4817d5dafb55c322c0d42b93935cd3c938aac2e4cf7a809dcc712de918b

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All changes to the Agoo gem are documented here. Releases follow semantic versioning.
 
+## [2.12.2] - 2020-03-22
+
+Stub generator
+
+### Added
+
+- GraphQL stub generator to generate Ruby class file corresponding to GraphQL schema type. The generator is `bin/agoo_stubs`.
+
 ## [2.12.1] - 2020-03-17
 
 Check SO_REUSEPORT

data/bin/agoo_stubs

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+
+while (index = ARGV.index('-I'))
+  _, path = ARGV.slice!(index, 2)
+  $LOAD_PATH << path
+end
+
+require 'optparse'
+
+require 'agoo'
+
+usage = %{
+Usage: agoo_stubs [options] <graphql_schema>
+
+version #{Agoo::VERSION}
+
+Generates Ruby files that match the types in the GraphQL schema file specified.
+
+Example:
+
+  agoo_stubs --module Data --dir lib schema.graphql
+
+}
+
+@verbose = false
+@single = nil
+@dir = nil
+@mod = nil
+
+@opts = OptionParser.new(usage)
+@opts.on('-h', '--help', 'show this display')                            { puts @opts.help; Process.exit!(0) }
+@opts.on('-v', '--verbose', 'verbose output')                            { @verbose = true }
+@opts.on('-s', '--single PATH', String, 'path to fiel for all stubs')    { |s| @single = s }
+@opts.on('-d', '--dir PATH', String, 'directory to write files into')    { |d| @dir = d }
+@opts.on('-m', '--module STRING', String, 'module for the stub classes') { |m| @mod = m }
+
+@files = @opts.parse(ARGV)
+
+if @files.empty?
+  puts "A schema file must be specified."
+  puts @opts.help
+  Process.exit!(0)
+elsif 1 < @files.size
+  puts "Only one schema file can be specified."
+  puts @opts.help
+  Process.exit!(0)
+end
+
+Agoo::GraphQL.schema(nil) {
+  Agoo::GraphQL.load_file(@files[0])
+}
+
+def write_type_stub(f, t, depth)
+  indent = '  ' * depth
+  f.puts "#{indent}# #{t.description}" unless t.description.nil?
+  f.puts "#{indent}class #{t.name}"
+  t.fields.each { |field|
+    next unless field.args.nil?
+    f.puts "#{indent}  # #{field.description}" unless field.description.nil?
+    f.puts "#{indent}  attr_accessor :#{field.name}"
+  }
+  f.puts
+  f.puts "#{indent}  def initialize"
+  f.puts "#{indent}  end"
+  t.fields.each { |field|
+    next if field.args.nil?
+    f.puts
+    f.puts "#{indent}  # #{field.description}" unless field.description.nil?
+    args = field.args.map { |a| a.name }.join(', ')
+    f.puts "#{indent}  def #{field.name}(#{args})"
+    f.puts "#{indent}  end"
+  }
+  f.puts "#{indent}end"
+end
+
+def calc_filepath(t)
+  path = @dir
+  path += '/' + @mod.split('::').map { |m| m.downcase }.join('/') unless @mod.nil?
+  path + '/' + t.name.downcase + '.rb'
+end
+
+def assure_parent_dir(path)
+  dirs = path.split('/')[0..-2]
+  dirs.each_index { |i|
+    path = dirs[0..i].join('/')
+    Dir.mkdir(path) unless Dir.exist?(path)
+  }
+end
+
+def write_type_stub_file(t)
+  path = calc_filepath(t)
+  assure_parent_dir(path)
+  File.open(path, 'w') { |f|
+    f.puts "# #{t.name} class for schema file #{@files[0]}"
+    f.puts
+    depth = 0
+    unless @mod.nil?
+      @mod.split('::').each { |m|
+	f.puts("#{'  ' * depth}module #{m}")
+	depth += 1
+      }
+      f.puts
+    end
+    write_type_stub(f, t, depth)
+    f.puts
+    unless @mod.nil?
+      @mod.split('::').size.times {
+	depth -= 1
+	f.puts("#{'  ' * depth}end")
+      }
+    end
+  }
+end
+
+@out = nil
+
+if @dir.nil?
+  if @single.nil?
+    @out = STDOUT
+  else @single
+    @out = File.new(@single, 'w')
+  end
+end
+
+unless @out.nil?
+  @out.puts "# Classes for schema file #{@files[0]}"
+  @out.puts
+  depth = 0
+  unless @mod.nil?
+    @mod.split('::').each { |m|
+      @out.puts("#{'  ' * depth}module #{m}")
+      depth += 1
+    }
+    @out.puts
+  end
+  Agoo::GraphQL.sdl_types.sort { |a,b| a.name <=> b.name }.each { |t|
+    write_type_stub(@out, t, depth)
+    @out.puts
+  }
+  unless @mod.nil?
+    @mod.split('::').size.times {
+      depth -= 1
+      @out.puts("#{'  ' * depth}end")
+    }
+  end
+  @out.close unless STDOUT == @out
+else
+  Agoo::GraphQL.sdl_types.each { |t|
+    write_type_stub_file(t)
+  }
+  unless @mod.nil?
+    path = @dir
+    path += '/' + @mod.split('::').map { |m| m.downcase }.join('/')
+    assure_parent_dir(path)
+    m = path.split('/')[-1]
+    path += '.rb'
+
+    File.open(path, 'w') { |f|
+      f.puts "# Classes for schema file #{@files[0]}"
+      f.puts
+      Agoo::GraphQL.sdl_types.sort { |a,b| a.name <=> b.name }.each { |t|
+	f.puts "require_relative '#{m}/#{t.name.downcase}'"
+      }
+    }
+  end
+end

data/ext/agoo/rgraphql.c

@@ -37,6 +37,9 @@ typedef struct _bhArgs {
 static VALUE		graphql_class = Qundef;
 static VALUE		vroot = Qnil;
 static VALUE		build_headers_func = Qnil;
+static VALUE		arg_clas = Qnil;
+static VALUE		field_clas = Qnil;
+static VALUE		type_clas = Qnil;
 
 static ID		call_id;
 
@@ -774,16 +777,16 @@ graphql_load_file(VALUE self, VALUE path) {
     return Qnil;
 }
 
-/* Document-method: dump_sdl
+/* Document-method: sdl_dump
  *
- * call-seq: dump_sdl()
+ * call-seq: sdl_dump()
  *
  * The preferred method of inspecting a GraphQL schema is to use introspection
  * queries but for debugging and for reviewing the schema a dump of the schema
- * as SDL can be helpful. The _#dump_sdl_ method returns the schema as an SDL
+ * as SDL can be helpful. The _#sdl_dump_ method returns the schema as an SDL
  * string.
  *
- * - *options* [_Hash_] server options
+ * - *options* [_Hash_] options
  *
  *   - *:with_description* [_true_|_false_] if true the description strings are included. If false they are not included.
  *
@@ -817,6 +820,79 @@ graphql_sdl_dump(VALUE self, VALUE options) {
     return dump;
 }
 
+static void
+type_cb(gqlType type, void *ctx) {
+    VALUE	rtypes = (VALUE)ctx;
+    VALUE	t;
+
+    if (GQL_OBJECT != type->kind || type->core) {
+	return;
+    }
+    t = rb_obj_alloc(type_clas);
+    rb_ivar_set(t, rb_intern("@name"), rb_str_new_cstr(type->name));
+    if (NULL != type->desc) {
+	rb_ivar_set(t, rb_intern("@description"), rb_str_new_cstr(type->desc));
+    }
+    if (NULL != type->fields) {
+	VALUE		fields = rb_ary_new();
+	VALUE		field;
+	gqlField	f;
+
+	rb_ivar_set(t, rb_intern("@fields"), fields);
+	for (f = type->fields; NULL != f; f = f->next) {
+	    field = rb_obj_alloc(field_clas);
+	    rb_ary_push(fields, field);
+	    rb_ivar_set(field, rb_intern("@name"), rb_str_new_cstr(f->name));
+	    if (NULL != f->desc) {
+		rb_ivar_set(field, rb_intern("@description"), rb_str_new_cstr(f->desc));
+	    }
+	    if (NULL != f->type) {
+		rb_ivar_set(field, rb_intern("@type_name"), rb_str_new_cstr(f->type->name));
+	    }
+	    if (NULL != f->default_value) {
+		rb_ivar_set(field, rb_intern("@default_value"), gval_to_ruby(f->default_value));
+	    }
+	    if (NULL != f->args) {
+		VALUE	args = rb_ary_new();
+		VALUE	arg;
+		gqlArg	a;
+
+		rb_ivar_set(field, rb_intern("@args"), args);
+		for (a = f->args; NULL != a; a = a->next) {
+		    arg = rb_obj_alloc(arg_clas);
+		    rb_ary_push(args, arg);
+		    rb_ivar_set(arg, rb_intern("@name"), rb_str_new_cstr(a->name));
+		    if (NULL != a->desc) {
+			rb_ivar_set(arg, rb_intern("@description"), rb_str_new_cstr(a->desc));
+		    }
+		    if (NULL != a->type) {
+			rb_ivar_set(arg, rb_intern("@type_name"), rb_str_new_cstr(a->type->name));
+		    }
+		    if (NULL != a->default_value) {
+			rb_ivar_set(arg, rb_intern("@default_value"), gval_to_ruby(a->default_value));
+		    }
+		}
+	    }
+	}
+    }
+    rb_ary_push(rtypes, t);
+}
+
+/* Document-method: sdl_types
+ *
+ * call-seq: sdl_types()
+ *
+ * Returns an array of all SDL types as Ruby objects.
+ */
+static VALUE
+graphql_sdl_types(VALUE self) {
+    VALUE	rtypes = rb_ary_new();
+
+    gql_type_iterate(type_cb, (void*)rtypes);
+
+    return rtypes;
+}
+
 /* Document-method: publish
  *
  * call-seq: publish(subject, event)
@@ -963,10 +1039,16 @@ graphql_init(VALUE mod) {
 
     rb_define_module_function(graphql_class, "sdl_dump", graphql_sdl_dump, 1);
 
+    rb_define_module_function(graphql_class, "sdl_types", graphql_sdl_types, 0);
+
     rb_define_module_function(graphql_class, "publish", graphql_publish, 2);
 
     rb_define_module_function(graphql_class, "build_headers=", graphql_build_headers, 1);
     rb_define_module_function(graphql_class, "headers", graphql_headers, 1);
 
+    arg_clas = rb_const_get_at(graphql_class, rb_intern("Arg"));
+    field_clas = rb_const_get_at(graphql_class, rb_intern("Field"));
+    type_clas = rb_const_get_at(graphql_class, rb_intern("Type"));
+
     call_id = rb_intern("call");
 }

data/lib/agoo.rb

@@ -4,6 +4,7 @@ end
 
 require 'stringio' # needed for Ruby 2.7
 require 'agoo/version'
+require 'agoo/graphql'
 require 'rack/handler/agoo'
 require 'agoo/agoo' # C extension
 

data/lib/agoo/graphql.rb

@@ -0,0 +1,9 @@
+
+module Agoo
+  class GraphQL
+  end
+end
+
+require 'agoo/graphql/arg'
+require 'agoo/graphql/field'
+require 'agoo/graphql/type'

data/lib/agoo/graphql/arg.rb

@@ -0,0 +1,13 @@
+
+module Agoo
+  class GraphQL
+
+    class Arg
+      attr_accessor :name
+      attr_accessor :description
+      attr_accessor :type_name
+      attr_accessor :default_value
+    end
+
+  end
+end

data/lib/agoo/graphql/field.rb

@@ -0,0 +1,14 @@
+
+module Agoo
+  class GraphQL
+
+    class Field
+      attr_accessor :name
+      attr_accessor :description
+      attr_accessor :type_name
+      attr_accessor :args
+      attr_accessor :default_value
+    end
+
+  end
+end

data/lib/agoo/graphql/type.rb

@@ -0,0 +1,12 @@
+
+module Agoo
+  class GraphQL
+
+    class Type
+      attr_accessor :name
+      attr_accessor :description
+      attr_accessor :fields
+    end
+
+  end
+end

data/lib/agoo/version.rb

@@ -1,5 +1,5 @@
 
 module Agoo
   # Agoo version.
-  VERSION = '2.12.1'
+  VERSION = '2.12.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agoo
 version: !ruby/object:Gem::Version
-  version: 2.12.1
+  version: 2.12.2
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -34,6 +34,7 @@ description: A fast HTTP server supporting rack.
 email: peter@ohler.com
 executables:
 - agoo
+- agoo_stubs
 extensions:
 - ext/agoo/extconf.rb
 extra_rdoc_files:
@@ -45,6 +46,7 @@ files:
 - LICENSE
 - README.md
 - bin/agoo
+- bin/agoo_stubs
 - ext/agoo/agoo.c
 - ext/agoo/atomic.h
 - ext/agoo/base64.c
@@ -142,6 +144,10 @@ files:
 - ext/agoo/websocket.c
 - ext/agoo/websocket.h
 - lib/agoo.rb
+- lib/agoo/graphql.rb
+- lib/agoo/graphql/arg.rb
+- lib/agoo/graphql/field.rb
+- lib/agoo/graphql/type.rb
 - lib/agoo/version.rb
 - lib/rack/handler/agoo.rb
 - test/base_handler_test.rb