goa_model_gen 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55c211e5cded1ceaad2db67152473f68f80db81ee97d83f8ea453ce08ee07cf8
-  data.tar.gz: 2a752f9dcd6daa746f7e8364ca9ca972e73a78e8dfd497eb08783da6ebb8ecc8
+  metadata.gz: 721bb2c0d07817d9853be4f1dae801b682b51d636416880e464b29ace1477949
+  data.tar.gz: 2a5c2e05448fd86fb2b3bef0d5b3693589fd325c45830763ea82f29a1e924f39
 SHA512:
-  metadata.gz: 7197c6ef9959172c9d32f533fe8cacd72ed94f1b9f5a7eacbbed21622e39a5226cd9a2a765f25bed15e206cba6b8bb85a3e93e519596d6f667d7c22d9c5ada6a
-  data.tar.gz: bc4dfd74fd8cc1b0d7362218da8e51039614dcc008b074d95fab2fc5e6214f629be95a5917f3660621f655b65dbd864b50b0d58779345b18240d8e40a46fbde3
+  metadata.gz: bd7b88d3471523df596f2b07ad5cb974c5ca6a127ed75cca19a5615d8b432a5edf812341047c554a7988358f0dfa6ef9548ecf5857d435b8b17cd0ded2f60ece
+  data.tar.gz: d1cb7ccfbe6dd50baeede29910cdcafbdace04d8b55d2fbf322143fb76f42017b5bf8c9dbfb23a20be748bb827765a95c5eb1841834b6c5df83b4450de62f56f

data/lib/goa_model_gen/cli.rb

@@ -32,22 +32,22 @@ module GoaModelGen
     desc "show FILE1...", "Show model info from definition files"
     def show(*paths)
       show_version_if_required
-      load_types_for(paths) do |path, types|
-        puts "types in #{path}"
-        puts YAML.dump(types)
+      load_types_for(paths) do |source_file|
+        puts "types in #{source_file.yaml_path}"
+        puts YAML.dump(source_file.types)
       end
     end
 
     desc "model FILE1...", "Generate model files from definition files"
     def model(*paths)
       show_version_if_required
-      load_types_for(paths) do |path, types|
-        generator = new_generator.tap{|g| g.types = types }
+      load_types_for(paths) do |source_file|
+        generator = new_generator.tap{|g| g.source_file = source_file }
         [
           {path: 'templates/model.go.erb', suffix: '.go', overwrite: true},
           {path: 'templates/model_validation.go.erb', suffix: '_validation.go', overwrite: false},
         ].each do |d|
-          dest = File.join(cfg.model_dir, File.basename(path, ".*") + d[:suffix])
+          dest = File.join(cfg.model_dir, File.basename(source_file.path, ".*") + d[:suffix])
           generator.run(d[:path], dest, overwrite: d[:overwrite])
         end
       end
@@ -56,10 +56,10 @@ module GoaModelGen
     desc "converter FILE1...", "Generate converter files from definition files and swagger.yaml"
     def converter(*paths)
       show_version_if_required
-      load_types_for(paths) do |path, types|
-        generator = new_generator.tap{|g| g.types = types }
-        dest = File.join(cfg.controller_dir, File.basename(path, ".*") + "_conv.go")
-        if types.any?{|t| !!t.payload || !!t.media_type}
+      load_types_for(paths) do |source_file|
+        generator = new_generator.tap{|g| g.types = source_file.types }
+        dest = File.join(cfg.controller_dir, File.basename(source_file.yaml_path, ".*") + "_conv.go")
+        if source_file.types.any?{|t| !!t.payload || !!t.media_type}
           generator.run('templates/converter.go.erb', dest, overwrite: true)
         end
       end
@@ -88,24 +88,12 @@ module GoaModelGen
       end
 
       def load_types_for(paths)
-        swagger_loader = GoaModelGen::SwaggerLoader.new(cfg.swagger_yaml)
-        path_to_types = {}
-        defined_types = {}
-        paths.each do |path|
-          types = GoaModelGen::ModelLoader.new(path).load_types
-          types.each{|t| t.assign_swagger_types(swagger_loader) }
-          types.each{|t| defined_types[t.name] = t }
-          path_to_types[path] = types
-        end
-        paths.each do |path|
-          types = path_to_types[path]
-          types.each{|t| t.assign_field_type_base(defined_types) }
-        end
-        paths.each do |path|
-          yield(path, path_to_types[path])
+        loader = GoaModelGen::Loader.new(cfg)
+        source_files = loader.load(paths)
+        source_files.each do |source_file|
+          yield(source_file)
         end
       end
-
     end
 
   end

data/lib/goa_model_gen/config.rb

@@ -17,7 +17,7 @@ module GoaModelGen
       controller_dir
     ].freeze
 
-    attr_reader *ATTRIBUTES
+    attr_accessor *ATTRIBUTES
 
     def fulfill
       @go_package     ||= default_go_package

data/lib/goa_model_gen/field.rb

@@ -62,6 +62,10 @@ module GoaModelGen
       ].map{|k,v| v ? "#{k}:\"#{v}\"" : nil}.compact.join(' ')
     end
 
+    def definition
+      "#{ name } #{ type } `#{ tag }`"
+    end
+
     # https://swagger.io/docs/specification/data-models/data-types/
     # https://tour.golang.org/basics/11
     # https://golang.org/pkg/go/types/#pkg-variables

data/lib/goa_model_gen/generator.rb

@@ -1,4 +1,5 @@
 require "goa_model_gen"
+require "goa_model_gen/golang_helper"
 
 require "erb"
 
@@ -9,23 +10,30 @@ module GoaModelGen
   class Generator
     # These are used in templates
     attr_reader :config
-    attr_accessor :types
+    attr_accessor :source_file
 
     def initialize(config)
       @config = config
     end
 
-    def run(rel_path, path, overwrite: false)
-      return if File.exist?(path) && !overwrite
-      abs_path = File.expand_path('../' + rel_path, __FILE__)
+    def golang_helper
+      @golang_helper ||= GolangHelper.new
+    end
+
+    def generate(template_path)
+      abs_path = File.expand_path('../' + template_path, __FILE__)
       erb = ERB.new(File.read(abs_path), nil, "-")
       erb.filename = abs_path
       content = erb.result(binding)
-      open(path, 'w'){|f| f.puts(content) }
-      if (File.extname(path) == '.go') && !config.gofmt_disabled
-        system("gofmt -w #{path}")
-      end
     end
 
+    def run(template_path, output_path, overwrite: false)
+      return if File.exist?(output_path) && !overwrite
+      content = generate(template_path)
+      open(output_path, 'w'){|f| f.puts(content) }
+      if (File.extname(output_path) == '.go') && !config.gofmt_disabled
+        system("gofmt -w #{output_path}")
+      end
+    end
   end
 end

data/lib/goa_model_gen/golang_helper.rb

@@ -0,0 +1,19 @@
+module GoaModelGen
+  class GolangHelper
+
+    PARTITION_PATTERNS = [
+      /\A[^\.\/]+(?:\/.+)?\z/,
+      /\Agopkg\.in\//,
+      /\Agolang\.org\//,
+      /\Agoogle\.golang\.org\//,
+      /\Agithub\.com\//,
+    ]
+
+    def partition(paths)
+      groups = paths.group_by do |path|
+        PARTITION_PATTERNS.index{|ptn| ptn =~ path} || PARTITION_PATTERNS.length
+      end
+      groups.keys.sort.map{|k| groups[k].sort }
+    end
+  end
+end

data/lib/goa_model_gen/loader.rb

@@ -4,6 +4,7 @@ require "yaml"
 
 require "goa_model_gen/type"
 require "goa_model_gen/field"
+require "goa_model_gen/source_file"
 
 module GoaModelGen
   class BaseLoader
@@ -16,12 +17,6 @@ module GoaModelGen
       @raw = YAML.load_file(path)
     end
 
-    def load_types
-      raw[types_key].map do |name, definition|
-        build_type(name, definition)
-      end
-    end
-
     def build_type(name, d)
       kind.new(name, d).tap do |t|
         if d[fields_key]
@@ -35,19 +30,6 @@ module GoaModelGen
     def build_field(name, f)
       Field.new(name, f)
     end
-
-    def dig(path)
-      dig_into(raw, path.split('/'), [])
-    end
-
-    def dig_into(hash, keys, footprints)
-      # puts "dig_into(hash, #{keys.inspect}, #{footprints.inspect})"
-      key = keys.shift
-      value = hash[key]
-      return value if keys.empty?
-      raise "No data for #{key} in #{footprints.join('/')}" if value.nil?
-      return dig_into(value, keys, footprints + [key])
-    end
   end
 
   class ModelLoader < BaseLoader
@@ -55,6 +37,13 @@ module GoaModelGen
       super(path, Model, 'types', 'fields')
     end
 
+    def load_file
+      types = raw[types_key].map do |name, definition|
+        build_type(name, definition)
+      end
+      SourceFile.new(path, types)
+    end
+
     def build_field(name, f)
       fd = f.is_a?(Hash) ? f : {'type' => f.to_s}
       fd['type'] ||= 'string'
@@ -94,5 +83,40 @@ module GoaModelGen
       raise "#{name} not found in #{path}" unless r
       r
     end
+
+    def dig(path)
+      dig_into(raw, path.split('/'), [])
+    end
+
+    def dig_into(hash, keys, footprints)
+      # puts "dig_into(hash, #{keys.inspect}, #{footprints.inspect})"
+      key = keys.shift
+      value = hash[key]
+      return value if keys.empty?
+      raise "No data for #{key} in #{footprints.join('/')}" if value.nil?
+      return dig_into(value, keys, footprints + [key])
+    end
+  end
+
+  class Loader
+    attr_reader :config
+    def initialize(config)
+      @config = config
+    end
+
+    def load_types(paths)
+      swagger_loader = GoaModelGen::SwaggerLoader.new(config.swagger_yaml)
+      defined_types = {}
+      files = paths.map do |path|
+        GoaModelGen::ModelLoader.new(path).load_file.tap do |f|
+          f.types.each{|t| t.assign_swagger_types(swagger_loader) }
+          f.types.each{|t| defined_types[t.name] = t }
+        end
+      end
+      files.each do |f|
+        f.types.each{|t| t.assign_field_type_base(defined_types) }
+      end
+      return files
+    end
   end
 end

data/lib/goa_model_gen/source_file.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+require 'goa_model_gen'
+require 'goa_model_gen/type'
+
+require "active_support/core_ext/string"
+
+module GoaModelGen
+  class SourceFile
+    attr_reader :yaml_path, :types
+    def initialize(yaml_path, types)
+      @yaml_path, @types = yaml_path, types
+    end
+
+    def model_dependencies
+      @model_dependencies ||= calc_model_dependencies
+    end
+
+    def calc_model_dependencies
+      r = []
+      r << "github.com/goadesign/goa/uuid" if types.any?(&:use_uuid?)
+      if types.any?(&:store?)
+        r << "fmt"
+        r << "golang.org/x/net/context"
+        r << "google.golang.org/appengine/datastore"
+        r << "google.golang.org/appengine/log"
+      end
+      r << "time" if types.any?(&:has_time_field?)
+      r.uniq
+    end
+  end
+end

data/lib/goa_model_gen/templates/model.go.erb

@@ -1,29 +1,27 @@
 package model
 
+<%- unless source_file.model_dependencies.empty? -%>
 import (
-  "fmt"
-  "time"
-
-  "golang.org/x/net/context"
-	"google.golang.org/appengine/datastore"
-	"google.golang.org/appengine/log"
+<%- golang_helper.partition(source_file.model_dependencies).each do |group| -%>
+<%-   group.each do |path| -%>
+  "<%= path %>"
+<%-   end -%>
 
-<%- if types.select(&:store?).any?{|m| m.goon['id_type'] == 'UUID'} -%>
-	"github.com/goadesign/goa/uuid"
 <%- end -%>
 )
+<%- end -%>
 
-<%- types.each do |type| -%>
+<%- source_file.types.each do |type| -%>
 <%-   if !type.fields.empty? -%>
 type <%= type.name %> struct {
 <%-     if type.goon -%>
-	<%= type.id_name %> <%= type.id_golang_type %> `datastore:"-" goon:"id" json:"<%= type.id_name.underscore %>"`
+	<%= type.id_definition %>
 <%-       if type.parent -%>
 	ParentKey *datastore.Key `datastore:"-" goon:"parent" json:"-"`
 <%-       end -%>
 <%-     end -%>
 <%-     type.fields.each do |field| -%>
-	<%= field.name %> <%= field.type %> `<%= field.tag %>`
+	<%= field.definition %>
 <%-     end -%>
 }
 <%-   elsif type.base -%>
@@ -40,7 +38,7 @@ const (
 
 <%- end -%>
 
-<%- types.select(&:store?).each do |model| -%>
+<%- source_file.types.select(&:store?).each do |model| -%>
 func (m *<%= model.name %>) PrepareToCreate() error {
 <%- if model.fields.any?{|f| f.name == "CreatedAt"} -%>
 	if m.CreatedAt.IsZero() {
@@ -71,7 +69,7 @@ func (m *<%= model.name %>) Parent(ctx context.Context) (*<%= model.parent %>, e
 
 <%- end -%>
 
-<%- types.select(&:store?).each do |model| -%>
+<%- source_file.types.select(&:store?).each do |model| -%>
 <%- store_name = "#{model.name}Store" -%>
 type <%= store_name %> struct{
 <%- if model.parent -%>

data/lib/goa_model_gen/templates/model_validation.go.erb

@@ -4,7 +4,7 @@ import (
 	"gopkg.in/go-playground/validator.v9"
 )
 
-<%- types.select(&:store?).each do |model| -%>
+<%- source_file.types.select(&:store?).each do |model| -%>
 func (m *<%= model.name %>) Validate() error {
 	validator := validator.New()
 	return validator.Struct(m)

data/lib/goa_model_gen/type.rb

@@ -16,6 +16,15 @@ module GoaModelGen
     def assign_field_type_base(types)
       self.fields.each{|f| f.assign_type_base(types) }
     end
+
+    def use_uuid?
+      false
+    end
+
+    TIME_TYPE_PATTERN = /\Atime\./
+    def has_time_field?
+      fields.any?{|f| f.type =~ TIME_TYPE_PATTERN}
+    end
   end
 
   class Model < Type
@@ -58,6 +67,10 @@ module GoaModelGen
       s.blank? ? nil : s[0].downcase + s[1..-1]
     end
 
+    def id_definition
+      goon && "#{id_name} #{id_golang_type } `datastore:\"-\" goon:\"id\" json:\"#{ id_name.underscore }\"`"
+    end
+
     def parent
       goon && goon['parent']
     end
@@ -66,6 +79,11 @@ module GoaModelGen
       !!goon
     end
 
+    # @override
+    def use_uuid?
+      goon && (goon['id_type'] == 'UUID')
+    end
+
     def key_id_method
       case id_golang_type
       when 'int64' then 'IntID'
@@ -110,6 +128,9 @@ module GoaModelGen
       end
     end
 
+    def field_by(name)
+      fields.detect{|f| f.name == name}
+    end
   end
 
   class SwaggerDef < Type

data/lib/goa_model_gen/version.rb

@@ -1,3 +1,3 @@
 module GoaModelGen
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goa_model_gen
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - akm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -120,7 +120,9 @@ files:
 - lib/goa_model_gen/field.rb
 - lib/goa_model_gen/generator.rb
 - lib/goa_model_gen/goa.rb
+- lib/goa_model_gen/golang_helper.rb
 - lib/goa_model_gen/loader.rb
+- lib/goa_model_gen/source_file.rb
 - lib/goa_model_gen/templates/converter.go.erb
 - lib/goa_model_gen/templates/converter_base.go.erb
 - lib/goa_model_gen/templates/goon.go.erb
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Generate model files for goa in golang