go-on-rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a79eacecb3518a5d6a275b966c46c772af15a74
-  data.tar.gz: 631f955570f113bb767e83809287f5c39cc8433c
+  metadata.gz: 6d2c69a6ebce31c2804821e2984af576d8a45212
+  data.tar.gz: fcd5211c4a7eb06c15f8fb82ee37cb71f36ade55
 SHA512:
-  metadata.gz: b131b9b03ecca48ba7081d7bd8e27e9228c6c7effaff59e5c0d4defb1634b5c3824d45366bf20fe7cb7ff179ef69bd8906686d19ccdb585054efbc909dbc1efc
-  data.tar.gz: 7a93441d049b69b48288561088ebebeca048e96ccc309c7e868a656df1fb051556722e982e4b90ee677fa02e965f7f3106a98517be78ee09d80499c571ee752b
+  metadata.gz: 7706dd9487899a009c937f4cc114c197e839ffc8a3f89b115de3f59b3301013030b6950207c796b6c236870f9fdfa13a2ae4360663a6db33d27f0c73c533b93a
+  data.tar.gz: 0b60b8ded7ee6f87c8533c0cae640dcc07cb1724ee24ec98caed7c2f85e8407ed71a35eedbe3db02170598a729b472e2d4a1b8cef12116e830b4b1578fa24662

data/README.md

@@ -3,7 +3,7 @@
 go-on-rails
 ====
 
-go-on-rails aims at three scenarios:
+go-on-rails is a Rails generator created for three scenarios:
 
 1. Integrate some APIs written in Golang to existed Rails app for high performance
 2. Use your farmiliar Rails tools to develope and manage a Golang app project
@@ -37,7 +37,7 @@ $ gem install go-on-rails
 
 You must have a Rails app or to create one before you can try go-on-rails generator to convert a Rails app to Golang codes.
 
-You can just run the command to convert the application:
+After that you can just run the command to convert the application:
 
 ```bash
 rails g gor [dev(elopment) | pro(duction) | test] [-m model_a model_b model_c ...]
@@ -70,8 +70,17 @@ rails g gor --help
 * Go project directory layout (all under the `go_app` directory, like `views`, `controllers`, `public`)
 * A Go data struct corresponding to each activerecord model
 * And each struct related CRUD functions/methods like FindModel, UpdateModel, DestroyModle etc. All these models related program files under the `go_app/models` directory
+* And godoc files for all the functions under `go_app/models/doc`
 * We use [Gin](https://github.com/gin-gonic/gin) as the default web framework, but you can change it to anyone that you favor in `main.go` and `controllers` programs
 
+### View the godoc of all functions
+
+You can view the godoc page of all functions in http://localhost:7979/doc/models.html after run:
+
+```bash
+rails gor:doc
+```
+
 And the gem is still under development, so there're a lot of known issues.
 
 ## Known issues and TODOs
@@ -120,7 +129,14 @@ The `dev` branch has a whole Rails environment for development: models, seeds fo
 
 ### Testing
 
-Run `rails db:seed` to use the data defined in `db/seeds.rb`. And change to `go_app/models` directory to run `go test` to test generated models-related functions.
+We create four models for testing:
+
+- Physician
+- Patient
+- Appointment
+- Picture
+
+Run `rails db:seed` to use the data defined in `db/seeds.rb`. And change to `go_app/models` directory to run `go test` to test generated models-related functions. The test covers a small part of the functions currently. More will be added later on.
 
 ## License
 

data/lib/generators/gor/gor_generator.rb

@@ -60,6 +60,9 @@ class GorGenerator < Rails::Generators::Base
 
     # use gofmt to prettify the generated Golang files
     gofmt_go_files
+
+    # generate go docs for models
+    generate_go_docs
   end
 
   private
@@ -96,6 +99,14 @@ class GorGenerator < Rails::Generators::Base
     go_files = Rails.root.join('go_app', 'models/*.go').to_s
     system "gofmt -w #{go_files} > /dev/null 2>&1"
   end
+
+  def generate_go_docs
+    models_dir = Rails.root.join('go_app', 'models').to_s
+    return unless Dir.exist?(File.expand_path(models_dir))
+    doc_dir = File.join(models_dir, "doc")
+    Dir.mkdir(doc_dir) unless Dir.exist?(doc_dir)
+    system "godoc -html #{models_dir} | awk '{ gsub(\"/src/target\", \"\"); print }' > #{doc_dir}/models.html"
+  end
 end
 
 require_relative 'go-on-rails/converter'

data/lib/generators/gor/templates/gor_model.go.erb

@@ -2,10 +2,7 @@
 <%- model_name_underscore = @model_name.underscore -%>
 <%- col_names = @struct_info[:col_names] -%>
 <%- has_assoc = !@struct_info[:assoc_info][:has_many].empty? || !@struct_info[:assoc_info][:has_one].empty? -%>
-// Package models is generated by go-on-rails, a Rails generator gem:
-// https://rubygems.org/gems/go-on-rails
-// Or on Github: https://github.com/goonr/go-on-rails
-// By B1nj0y <idegorepl@gmail.com>
+// Package models includes the functions on the model <%= @model_name %>.
 package models
 
 import (
@@ -20,6 +17,11 @@ import (
 	"github.com/asaskevich/govalidator"
 )
 
+// set flags to output more detailed log
+func init() {
+	log.SetFlags(log.LstdFlags | log.Lshortfile)
+}
+
 type <%= @model_name %> struct {
 	<%= @struct_info[:struct_body] -%>
 }
@@ -380,6 +382,8 @@ func Find<%= @model_name.pluralize %>BySql(sql string, args ...interface{}) (<%=
 	return <%= param_name_plural %>, nil
 }
 
+// Create<%= @model_name %> use a named params to create a single <%= @model_name %> record.
+// A named params is key-value map like map[string]interface{}{"first_name": "John", "age": 23} .
 func Create<%= @model_name %>(am map[string]interface{}) (int64, error) {
 	if len(am) == 0 {
 		return 0, fmt.Errorf("Zero key in the attributes map!")
@@ -413,6 +417,7 @@ func Create<%= @model_name %>(am map[string]interface{}) (int64, error) {
 	return lastId, nil
 }
 
+// Create is a method for <%= @model_name %> to create a record
 func (_<%= model_name_underscore %> *<%= @model_name %>) Create() (int64, error) {
 	ok, err := govalidator.ValidateStruct(_<%= model_name_underscore %>)
 	if !ok {
@@ -446,7 +451,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Create() (int64, error)
 <%- unless @struct_info[:assoc_info][:has_many].empty? -%>
 	<%- has_many = @struct_info[:assoc_info][:has_many] -%>
 	<%- has_many.each do |k, v| -%>
-// <%= k.pluralize %>Create used to create the associated objects
+// <%= k.pluralize %>Create is used for <%= @model_name %> to create the associated objects <%= k.pluralize %>
 func (_<%= model_name_underscore %> *<%= @model_name %>) <%= k.pluralize %>Create(am map[string]interface{}) error {
 	<%- if v[:through] -%>
 		// FIXME: use transaction to create these associated objects
@@ -470,7 +475,9 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) <%= k.pluralize %>Creat
 	return err
 }
 
-// Get<%= k.pluralize %> used to get associated objects
+// Get<%= k.pluralize %> is used for <%= @model_name %> to get associated objects <%= k.pluralize %>
+// Say you have a <%= @model_name %> object named <%= model_name_underscore %>, when you call <%= model_name_underscore %>.Get<%= k.pluralize %>(),
+// the object will get the associated <%= k.pluralize %> attributes evaluated in the struct
 func (_<%= model_name_underscore %> *<%= @model_name %>) Get<%= k.pluralize %>() error {
 	_<%= k.underscore.pluralize %>, err := <%= @model_name %>Get<%= k.pluralize %>(_<%= model_name_underscore %>.Id)
 	if err == nil {
@@ -510,6 +517,7 @@ func <%= @model_name %>Get<%= k.pluralize %>(id int64) ([]<%= v[:class_name] %>,
 <%- unless @struct_info[:assoc_info][:has_one].empty? -%>
 	<%- has_one = @struct_info[:assoc_info][:has_one] -%>
 	<%- has_one.each do |k, v| -%>
+// Create<%= k %> is a method used for <%= @model_name %> model
 func (_<%= model_name_underscore %> *<%= @model_name %>) Create<%= k %>(am map[string]interface{}) error {
 	<%- if v[:foreign_key] -%>
 	am["<%= v[:foreign_key] %>"] = _<%= model_name_underscore %>.Id
@@ -527,6 +535,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Create<%= k %>(am map[s
 	<%- belongs_to.each do |k, v| -%>
     <%-# don't create virtual table for polymorphic model -%>
 	<%- next if v[:polymorphic] -%>
+// Create<%= k %> is a method for a <%= @model_name %> object to create an associated <%= k %> record
 func (_<%= model_name_underscore %> *<%= @model_name %>) Create<%= k %>(am map[string]interface{}) error {
 	<%- if v[:foreign_key] -%>
 	am["<%= v[:foreign_key] %>"] = _<%= model_name_underscore %>.Id
@@ -539,6 +548,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Create<%= k %>(am map[s
 	<%- end -%>
 <%- end -%>
 
+// Destroy is method used for a <%= @model_name %> object to be destroyed.
 func (_<%= model_name_underscore %> *<%= @model_name %>) Destroy() error {
 	if _<%= model_name_underscore %>.Id == 0 {
 		return errors.New("Invalid Id field: it can't be a zero value")
@@ -547,6 +557,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Destroy() error {
 	return err
 }
 
+// Destroy<%= @model_name %> will destroy a <%= @model_name %> record specified by id parameter.
 func Destroy<%= @model_name %>(id int64) error {
 	<%- if @struct_info[:has_assoc_dependent] -%>
 	// Destroy association objects at first
@@ -561,6 +572,7 @@ func Destroy<%= @model_name %>(id int64) error {
 	return nil
 }
 
+// Destroy<%= @model_name.pluralize %> will destroy <%= @model_name %> records those specified by the ids parameters.
 func Destroy<%= @model_name.pluralize %>(ids ...int64) (int64, error) {
 	if len(ids) == 0 {
 		msg := "At least one or more ids needed"
@@ -621,7 +633,8 @@ func Destroy<%= @model_name.pluralize %>Where(where string, args ...interface{})
 }
 
 <%- if @struct_info[:has_assoc_dependent] -%>
-// the func not return err temporarily
+// destroy<%= @model_name %>Associations is a private function used to destroy a <%= @model_name %> record's associated objects.
+// The func not return err temporarily.
 func destroy<%= @model_name %>Associations(ids ...int64) {
 	idsHolder := ""
 	if len(ids) > 1 {
@@ -696,6 +709,8 @@ func destroy<%= @model_name %>Associations(ids ...int64) {
 }
 <%- end -%>
 
+// Save method is used for a <%= @model_name %> object to update an existed record mainly.
+// If no id provided a new record will be created. A UPSERT action will be implemented further.
 func (_<%= model_name_underscore %> *<%= @model_name %>) Save() error {
 	ok, err := govalidator.ValidateStruct(_<%= model_name_underscore %>)
 	if !ok {
@@ -707,7 +722,8 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Save() error {
 		return errors.New(errMsg)
 	}
 	if _<%= model_name_underscore %>.Id == 0 {
-		return errors.New("Invalid Id field: it can't be a zero value")
+		_, err = _<%= model_name_underscore %>.Create()
+		return err
 	}
 <%- if @struct_info[:timestamp_cols].include? "updated_at" -%>
 	_<%= model_name_underscore %>.UpdatedAt = time.Now()
@@ -719,6 +735,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) Save() error {
     return err
 }
 
+// Update<%= @model_name %> is used to update a record with a id and map[string]interface{} typed key-value parameters.
 func Update<%= @model_name %>(id int64, am map[string]interface{}) error {
 	if len(am) == 0 {
 		return errors.New("Zero key in the attributes map!")
@@ -747,6 +764,7 @@ func Update<%= @model_name %>(id int64, am map[string]interface{}) error {
 	return nil
 }
 
+// Update is a method used to update a <%= @model_name %> record with the map[string]interface{} typed key-value parameters.
 func (_<%= model_name_underscore %> *<%= @model_name %>) Update(am map[string]interface{}) error {
 	if _<%= model_name_underscore %>.Id == 0 {
 		return errors.New("Invalid Id field: it can't be a zero value")
@@ -763,6 +781,7 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) UpdateAttributes(am map
 	return err
 }
 
+// UpdateColumns method is supposed to be used to update <%= @model_name %> records as corresponding update_columns in Rails
 func (_<%= model_name_underscore %> *<%= @model_name %>) UpdateColumns(am map[string]interface{}) error {
 	if _<%= model_name_underscore %>.Id == 0 {
 		return errors.New("Invalid Id field: it can't be a zero value")
@@ -771,6 +790,8 @@ func (_<%= model_name_underscore %> *<%= @model_name %>) UpdateColumns(am map[st
 	return err
 }
 
+// Update<%= @model_name.pluralize %>BySql is used to update <%= @model_name %> records by a SQL clause
+// that use '?' binding syntax
 func Update<%= @model_name.pluralize %>BySql(sql string, args ...interface{}) (int64, error) {
 	if sql == "" {
 		return 0, errors.New("A blank SQL clause")

data/lib/tasks/gor.rake

@@ -17,4 +17,17 @@ namespace :gor do
     go_files = Rails.root.join('go_app', 'models/*.go').to_s
     system "gofmt -w #{go_files} > /dev/null 2>&1"
   end
+
+  desc 'View the doc of all the functions generated on models'
+  task :doc do
+    models_dir = Rails.root.join('go_app', 'models').to_s
+    puts 'Please open "http://localhost:7979/doc/models.html" to view the doc of all functions generated on models.'
+    puts 'Use Ctrl-C to terminate this server!'
+    if RUBY_PLATFORM =~ /darwin/
+      system 'open http://localhost:7979/doc/models.html'
+    elsif RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+      system 'start http://localhost:7979/doc/models.html'
+    end
+    system "godoc -goroot #{models_dir} -http=:7979"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - B1nj0y
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies: []
 description: Modeling, developing and testing your Golang app with your familiar Rails
   tools like rails generate, db migration, console etc. It is more meant to help integrating