goa_model_gen 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0cacd5ba7fc52902ba68ae788e6e4ec5a50fb6dd663da221d995c81b425f560
-  data.tar.gz: 71368a7fdecfbdac2cc28168df06f583891833f8067c662323576ff58060fd87
+  metadata.gz: 82c7930eb91dbfa049e61b483ab4e570e5319020a1a0e283bf79c9014b7059f3
+  data.tar.gz: b7dcdd494bbfaf4f93333398c285f94b31e47d24b2c5adb643cfadb844b2c29d
 SHA512:
-  metadata.gz: 70e0595b798469b555cf54c3fd277c5768a4ca3972a1654ec345c3d95d68cee0657fea988e43e27a8aed168ca7e360fb840a8ca8a3ca2f14aa23d81ffd74b649
-  data.tar.gz: 9d3390c47308bada677ce7ed720fa39984a86013a49d0c0c010cec95c7e77c41ace145137d988f80206d32a814e0f433bce9ac971b918135e05893c93a3985bd
+  metadata.gz: 873ab6ec5df1fd224c8c07d47ca1b4d77220f9aa16cb67913fede6726f4097bd8dc2682afbff38bc6dfbb8a8ce1b5fc8a637066b67233dc9850ff3f7fc246f4e
+  data.tar.gz: 682549fb13dc19eb00d4c7a82be17b8ede6a6e1e8cf7c081ccff9dd52883923b2fe4e7cd6524c0c72a77b7e9ae7b3096b901387805bbcbaf2e413212733cee55

data/lib/goa_model_gen/cli.rb

@@ -10,6 +10,8 @@ require "goa_model_gen/generator"
 module GoaModelGen
   class Cli < Thor
     class_option :version, type: :boolean, aliases: 'v', desc: 'Show version before processing'
+    class_option :dryrun, type: :boolean, aliases: 'd', desc: "Don't write or overwrite file"
+    class_option :force, type: :boolean, aliases: 'f', desc: 'Force overwrite files'
     class_option :log_level, type: :string, aliases: 'l', desc: 'Log level, one of  debug,info,warn,error,fatal. The default value is info'
     class_option :config, type: :string, aliases: 'c', default: './goa_model_gen.yaml', desc: 'Path to config file. You can generate it by config subcommand'
 
@@ -19,18 +21,6 @@ module GoaModelGen
       open(path, 'w'){|f| f.puts(Config.new.fulfill.to_yaml) }
     end
 
-    desc "bootstrap", "Generate files not concerned with model"
-    def bootstrap
-      setup
-      generator = new_generator
-      {
-        "templates/goon.go.erb" => "model/goon.go",
-        "templates/converter_base.go.erb" => "controller/converter_base.go",
-      }.each do |template, dest|
-        generator.run(template, dest, overwrite: true)
-      end
-    end
-
     desc "show FILE1...", "Show model info from definition files"
     def show(*paths)
       setup
@@ -43,27 +33,30 @@ module GoaModelGen
     desc "model FILE1...", "Generate model files from definition files"
     def model(*paths)
       setup
+      new_generator.process({
+        "templates/goon.go.erb" => File.join(cfg.model_dir, "goon.go"),
+        'templates/validator.go.erb' => File.join(cfg.model_dir, 'validator.go'),
+      })
       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(source_file.yaml_path, ".*") + d[:suffix])
-          generator.run(d[:path], dest, overwrite: d[:overwrite])
-        end
+        new_generator.tap{|g| g.source_file = source_file }.process({
+          'templates/model.go.erb' => dest_path(cfg.model_dir, source_file, '.go'),
+          'templates/model_store.go.erb' => dest_path(cfg.model_dir, source_file, '_store.go'),
+          'templates/model_validation.go.erb' => dest_path(cfg.model_dir, source_file, '_validation.go'),
+        })
       end
     end
 
     desc "converter FILE1...", "Generate converter files from definition files and swagger.yaml"
     def converter(*paths)
       setup
+      new_generator.process({
+        "templates/converter_base.go.erb" => File.join(cfg.controller_dir, "converter_base.go"),
+      })
       load_types_for(paths) do |source_file|
-        generator = new_generator.tap{|g| g.source_file = source_file }
-        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
+        next if source_file.types.all?{|t| !t.payload && !t.media_type}
+        new_generator.tap{|g| g.source_file = source_file }.process({
+          'templates/converter.go.erb' => dest_path(cfg.controller_dir, source_file, "_conv.go"),
+        })
       end
     end
 
@@ -87,7 +80,10 @@ module GoaModelGen
       end
 
       def new_generator
-        GoaModelGen::Generator.new(cfg)
+        GoaModelGen::Generator.new(cfg).tap do |g|
+          g.force = options[:force]
+          g.dryrun = options[:dryrun]
+        end
       end
 
       def load_types_for(paths)
@@ -97,6 +93,10 @@ module GoaModelGen
           yield(source_file)
         end
       end
+
+      def dest_path(dir, source_file, suffix)
+        File.join(dir, File.basename(source_file.yaml_path, ".*") + suffix)
+      end
     end
 
   end

data/lib/goa_model_gen/config.rb

@@ -15,6 +15,7 @@ module GoaModelGen
       gofmt_disabled
       model_dir
       controller_dir
+      validator_path
     ].freeze
 
     attr_accessor *ATTRIBUTES
@@ -25,6 +26,7 @@ module GoaModelGen
       @gofmt_disabled ||= false
       @model_dir      ||= "./model"
       @controller_dir ||= "./controller"
+      @validator_path ||= "gopkg.in/go-playground/validator.v9"
       self
     end
 

data/lib/goa_model_gen/field.rb

@@ -9,6 +9,7 @@ module GoaModelGen
     attr_reader :name, :type, :default
     attr_accessor :format # for swagger. See https://swagger.io/docs/specification/data-models/data-types/
     attr_accessor :required
+    attr_accessor :unique
     attr_accessor :validation
     attr_accessor :swagger_name
     attr_reader :type_obj
@@ -19,6 +20,7 @@ module GoaModelGen
       @type = attrs['type']
       @format = attrs['format']
       @required = attrs['required']
+      @unique = attrs['unique']
       @default = attrs['default']
       @validation = attrs['validation']
       @goa_name = attrs['goa_name']
@@ -49,6 +51,10 @@ module GoaModelGen
       !required
     end
 
+    def unique?
+      !!unique
+    end
+
     def not_null?
       required || !default.nil?
     end

data/lib/goa_model_gen/generator.rb

@@ -11,9 +11,13 @@ module GoaModelGen
     # These are used in templates
     attr_reader :config
     attr_accessor :source_file
+    attr_accessor :force, :dryrun
 
     def initialize(config)
       @config = config
+      @user_editable = false
+      @force = false
+      @dryrun = false
     end
 
     def golang_helper
@@ -42,6 +46,13 @@ module GoaModelGen
       end
     end
 
+    def user_editable(value: true)
+      @user_editable = value
+    end
+    def user_editable?
+      @user_editable
+    end
+
     GO_BASE_PATH = File.expand_path('../templates/base.go.erb', __FILE__)
 
     PACKAGE_FOR_IMPORT = {
@@ -63,13 +74,36 @@ module GoaModelGen
       base.result(binding).strip
     end
 
-    def run(template_path, output_path, overwrite: false)
-      return if File.exist?(output_path) && !overwrite
+    COLORS = {
+      generate: "\e[32m",        # green   # !file_exist
+      no_change: "\e[37m",    # white   # file_exist && !modified
+      overwrite: "\e[33m",       # yellow  # file_exist && !user_editable
+      keep: "\e[34m",            # blue    # file_exist && user_editable && !force
+      force_overwrite: "\e[31m", # red     # file_exist && user_editable && force
+      clear: "\e[0m",            # clear
+    }
+    MAX_ACTION_LENGTH = COLORS.keys.map(&:to_s).map(&:length).max
+
+    def run(template_path, output_path)
+      already_exist = File.exist?(output_path)
       content = generate(template_path)
+      modified = already_exist ? (content != File.read(output_path)) : true
+      action =
+        !already_exist ? :generate :
+          !modified ? :no_change :
+            !user_editable? ? :overwrite :
+              force ? :force_overwrite : :keep
+      GoaModelGen.logger.info("%s%-#{MAX_ACTION_LENGTH}s %s%s" % [COLORS[action], action.to_s, output_path, COLORS[:clear]])
+      return if action == :no_change
+      return if dryrun
       open(output_path, 'w'){|f| f.puts(content) }
       if (File.extname(output_path) == '.go') && !config.gofmt_disabled
         system("gofmt -w #{output_path}")
       end
     end
+
+    def process(temp_path_to_dest_path)
+      temp_path_to_dest_path.each{|src, dest| run(src, dest) }
+    end
   end
 end

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

@@ -1,3 +1,10 @@
+<%- if user_editable? -%>
+// You can edit this file. goa_model_gen doesn't overwrite this file.
+<%- else -%>
+// DO NOT EDIT this file.
+<%- end -%>
+// This code generated by goa_model_gen-<%= GoaModelGen::VERSION %>
+
 package <%= package %>
 
 <%- unless dependencies.empty? -%>

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

@@ -1,3 +1,4 @@
+<%- user_editable -%>
 <%- package 'model' -%>
 
 <%-

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

@@ -1,14 +1,14 @@
 <%- package "model" -%>
 
 <%- source_file.types.select(&:store?).each do |model| -%>
-<%-   store_name = "#{model.name}Store" -%>
+<%-	 store_name = "#{model.name}Store" -%>
 <%-
-      import(
-        "context",
-        "fmt",
-        "google.golang.org/appengine/datastore",
-        "google.golang.org/appengine/log",
-      )
+			import(
+				"context",
+				"fmt",
+				"google.golang.org/appengine/datastore",
+				"google.golang.org/appengine/log",
+			)
 -%>
 type <%= store_name %> struct{
 <%- if model.parent -%>
@@ -32,6 +32,16 @@ func (s *<%= store_name %>) Select(ctx context.Context, q *datastore.Query) ([]*
 	return r, nil
 }
 
+func (s *<%= store_name %>) CountBy(ctx context.Context, q *datastore.Query) (int, error) {
+	g := GoonFromContext(ctx)
+	c, err := g.Count(q)
+	if err != nil {
+		log.Errorf(ctx, "Failed to count <%= model.name %> with %v because of %v\n", q, err)
+		return 0, err
+	}
+	return c, nil
+}
+
 func (s *<%= store_name %>) Query(ctx context.Context) *datastore.Query {
 	g := GoonFromContext(ctx)
 	k := g.Kind(new(<%= model.name %>))
@@ -45,7 +55,7 @@ func (s *<%= store_name %>) ByID(ctx context.Context, <%= model.id_name_var %> <
 <%- else -%>
 	r := <%= model.name %>{<%= model.id_name %>: <%= model.id_name_var %>}
 <%- end -%>
-  err := s.Get(ctx, &r)
+	err := s.Get(ctx, &r)
 	if err != nil {
 		return nil, err
 	}
@@ -123,54 +133,57 @@ func (s *<%= store_name %>) Exist(ctx context.Context, m *<%= model.name %>) (bo
 }
 
 func (s *<%= store_name %>) Create(ctx context.Context, m *<%= model.name %>) (*datastore.Key, error) {
-  err := m.PrepareToCreate()
-  if err != nil {
-    return nil, err
-  }
-	if err := m.Validate(); err != nil {
-		return nil, err
-	}
-
-<%- if model.goon['id_type'] == 'string' -%>
-	exist, err := s.Exist(ctx, m)
+	err := m.PrepareToCreate()
 	if err != nil {
 		return nil, err
 	}
-	if exist {
-		log.Errorf(ctx, "Failed to create %v because of another entity has same key\n", m)
-		return nil, fmt.Errorf("Duplicate <%= model.goon['id_name'] %> error: %q of %v\n", m.<%= model.goon['id_name'] %>, m)
-	}
-<%- end -%>
-
-  return s.Put(ctx, m)
+	return s.PutWith(ctx, m, func() error {
+		exist, err := s.Exist(ctx, m)
+		if err != nil {
+			return err
+		}
+		if exist {
+			log.Errorf(ctx, "Failed to create %v because of another entity has same key\n", m)
+			return fmt.Errorf("Duplicate <%= model.goon['id_name'] %> error: %q of %v\n", m.<%= model.goon['id_name'] %>, m)
+		}
+		return nil
+	})
 }
 
 func (s *<%= store_name %>) Update(ctx context.Context, m *<%= model.name %>) (*datastore.Key, error) {
-  err := m.PrepareToUpdate()
-  if err != nil {
-    return nil, err
-  }
-	if err := m.Validate(); err != nil {
+	err := m.PrepareToUpdate()
+	if err != nil {
 		return nil, err
 	}
+	return s.PutWith(ctx, m, func() error {
+		exist, err := s.Exist(ctx, m)
+		if err != nil {
+			return err
+		}
+		if !exist {
+			log.Errorf(ctx, "Failed to update %v because it doesn't exist\n", m)
+			return fmt.Errorf("No data to update %q of %v\n", m.<%= model.goon['id_name'] %>, m)
+		}
+		return nil
+	})
+}
 
-<%- if model.goon['id_type'] == 'string' -%>
-	exist, err := s.Exist(ctx, m)
-	if err != nil {
+func (s *<%= store_name %>) PutWith(ctx context.Context, m *<%= model.name %>, f func() error) (*datastore.Key, error) {
+	if err := s.Validate(ctx, m); err != nil {
 		return nil, err
 	}
-	if !exist {
-		log.Errorf(ctx, "Failed to update %v because it doesn't exist\n", m)
-		return nil, fmt.Errorf("No data to update %q of %v\n", m.<%= model.goon['id_name'] %>, m)
+	if f != nil {
+		if err := f(); err != nil {
+			return nil, err
+		}
 	}
-<%- end -%>
 
-  return s.Put(ctx, m)
+	return s.Put(ctx, m)
 }
 
 func (s *<%= store_name %>) Put(ctx context.Context, m *<%= model.name %>) (*datastore.Key, error) {
 <%- if model.goon['id_type'] == 'UUID' -%>
-<%-   import "github.com/goadesign/goa/uuid" -%>
+<%-	 import "github.com/goadesign/goa/uuid" -%>
 	if m.Id == "" {
 		m.Id = uuid.NewV4().String()
 	}
@@ -193,13 +206,13 @@ func (s *<%= store_name %>) Put(ctx context.Context, m *<%= model.name %>) (*dat
 <%- if model.parent -%>
 func (s *<%= store_name %>) ValidateParent(m *<%= model.name %>) error {
 	if s.ParentKey == nil {
-	  return nil
+		return nil
 	}
 	if m.ParentKey == nil {
 		m.ParentKey = s.ParentKey
 	}
 	if !s.ParentKey.Equal(m.ParentKey) {
-	  return fmt.Errorf("Invalid ParentKey for %v", m)
+		return fmt.Errorf("Invalid ParentKey for %v", m)
 	}
 	return nil
 }
@@ -219,4 +232,26 @@ func (s *<%= store_name %>) Delete(ctx context.Context, m *<%= model.name %>) er
 	return nil
 }
 
+func (s *<%= store_name %>) ValidateUniqueness(ctx context.Context, m *<%= model.name %>) error {
+	conditions := map[string]interface{}{
+<%- model.fields.select(&:unique?).each do |field| -%>
+		"<%= field.name %>": m.<%= field.name %>,
+<%- end -%>
+	}
+	for field, value := range conditions {
+		q := s.Query(ctx).Filter(field + " =", value)
+		c, err := s.CountBy(ctx, q)
+		if err != nil {
+			return err
+		}
+		if c > 0 {
+			return &ValidationError{
+				Field: field,
+				Message: fmt.Sprintf("%v has already been taken", value),
+			}
+		}
+	}
+	return nil
+}
+
 <%- end -%>

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

@@ -1,10 +1,26 @@
+<%- user_editable -%>
 <%- package "model" -%>
 
 <%- source_file.types.select(&:store?).each do |model| -%>
-<%-   import "gopkg.in/go-playground/validator.v9" -%>
-func (m *<%= model.name %>) Validate() error {
-	validator := validator.New()
-	return validator.Struct(m)
+<%-
+      import "context"
+      import config.validator_path # "gopkg.in/go-playground/validator.v9"
+-%>
+<%-   store_name = "#{model.name}Store" -%>
+func (s *<%= store_name %>) Validate(ctx context.Context, m *<%= model.name %>) error {
+	if err := m.Validate(ctx); err != nil {
+		return err
+	}
+	if err := s.ValidateUniqueness(ctx, m); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (m *<%= model.name %>) Validate(ctx context.Context) error {
+	return WithValidator(ctx, func(validate *validator.Validate) error {
+		return validate.Struct(m)
+	})
 }
 
 <%- end -%>

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

@@ -0,0 +1,28 @@
+<%- user_editable -%>
+<%- package "model" -%>
+<%-
+		import(
+			"context",
+			config.validator_path,
+			# ja_translations "github.com/akm/validator/translations/ja",
+		)
+-%>
+
+func NewValidator(ctx context.Context) (*validator.Validate, error) {
+	validate := validator.New()
+	// trans, err := GetTranslator(ctx)
+	// if err != nil {
+	// 	return nil, err
+	// }
+	// // See https://github.com/go-playground/validator/blob/v9/_examples/translations/main.go
+	// ja_translations.RegisterDefaultTranslations(validate, trans)
+	return validate, nil
+}
+
+func WithValidator(ctx context.Context, f func(*validator.Validate) error) error {
+	validate, err := NewValidator(ctx)
+	if err != nil {
+		return err
+	}
+	return f(validate)
+}

data/lib/goa_model_gen/version.rb

@@ -1,3 +1,3 @@
 module GoaModelGen
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goa_model_gen
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - akm
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -131,6 +131,7 @@ files:
 - lib/goa_model_gen/templates/model.go.erb
 - lib/goa_model_gen/templates/model_store.go.erb
 - lib/goa_model_gen/templates/model_validation.go.erb
+- lib/goa_model_gen/templates/validator.go.erb
 - lib/goa_model_gen/type.rb
 - lib/goa_model_gen/version.rb
 homepage: https://github.com/akm/goa_model_gen
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Generate model files for goa in golang