go-on-rails 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25289bcbadbef0dfd3ea8b2a40485cdb1c2c8862
-  data.tar.gz: af6b2200a33c29ed1e3393a5b74858ee737b10a9
+  metadata.gz: a3dc0eef63c002b0600a7b8593197776fa5d5efa
+  data.tar.gz: 899707b6d8f8be9734d0b8101533b73c3d2922f0
 SHA512:
-  metadata.gz: 525c1d5c73e45658c9038051ef7fc00fcd223f59371f8b44fe19f196600c18ddff0bb39a6ad1e03e833830c6fba172a176e7409c8885b95fbac0b1001e55b239
-  data.tar.gz: 275f4e5c119a7e4d3ee0bd4b2506d66f879520c1908de193205e71b09b6b68d196e3cc5f7605f98841af89cbefb435e52560853a1c204938489420d8300929b4
+  metadata.gz: a0905ffeef7c809e4d7d92b1b8dced27cec08202636ac508a1e06310a0c0087c3858a6129862a97c19aaf60af071884bdbf57a6980090731ac3ef6eb15f24aa5
+  data.tar.gz: 8733f862097286d34da51f0b504951b980477d740ada46cf0b6c511457227032094c89d35b0c30c2e9a69cfcadab5839e5c69be9454694a17ecdde7154cfb605

data/README.md

@@ -14,7 +14,10 @@ go-on-rails is a Rails generator created for three scenarios:
 2. Use your farmiliar Rails tools to develope and manage a Golang app project
 3. Convert a *not very complicated* Rails app to Golang equivalent
 
-Here's a simple [example(tutorial)](https://github.com/goonr/example_simple) shows the basic usage of go-on-rails generator, and [another example](https://github.com/goonr/example_with_admin) shows how to integrate Go APIs in a Rails project. Some real-world examples are coming soon.
+Here's some examples:
+* a simple [example(tutorial)](https://github.com/goonr/example_simple) on the basic usage of go-on-rails generator
+* [An advanced example](https://github.com/goonr/example_with_admin) shows how to integrate Go APIs in a Rails project
+* [Another example](https://github.com/goonr/example_read_rails_session) shows how to read a Rails session from a go-on-rails generated Go API
 
 ## Prerequisites
 
@@ -26,7 +29,7 @@ Here's a simple [example(tutorial)](https://github.com/goonr/example_simple) sho
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'go-on-rails', '~> 0.1.9'
+gem 'go-on-rails', '~> 0.1.11'
 ```
 
 And then execute:

data/lib/generators/gor/go-on-rails/converter.rb

@@ -11,14 +11,27 @@ module GoOnRails
       "integer(8)" => "int64",
       "float"      => "float64",
       "datetime"   => "time.Time",
-      "date"       => "time.Time"
-    }
+      "date"       => "time.Time",
+      "inet"       => "string"
+    }.freeze
 
-    def initialize(klass, models)
+    # COALESCE datetime typed field for different databases
+    # FIXME: no idea for sqlite3 at present
+    DATETIME_COALESCE_MAP = {
+      "sqlite3"  => "%s",
+      "mysql"    => "COALESCE(%s, CONVERT_TZ('0001-01-01 00:00:00','+00:00','UTC')) AS %s",
+      "postgres" => "COALESCE(%s, (TIMESTAMP WITH TIME ZONE '0001-01-01 00:00:00+00') AT TIME ZONE 'UTC') AS %s"
+    }.freeze
+
+    # types need special treatment in the nullable_map() method
+    SPECIAL_COALESCE_TYPES = %w[inet].freeze
+
+    def initialize(klass, models, database)
       @klass = klass
       @models = models
+      @database = database
     end
-    attr_accessor :klass, :models
+    attr_accessor :klass, :models, :database
 
     def convert
       get_schema_info
@@ -27,9 +40,16 @@ module GoOnRails
     private
 
     def get_schema_info
-      struct_info = {col_names: [], timestamp_cols: [], has_datetime_type: false, struct_body: ""}
+      struct_info = {
+        col_names: [],
+        timestamp_cols: [],
+        has_datetime_type: false,
+        struct_body: "",
+      }
 
       validation = GoOnRails::Validator.new(self.klass)
+      # store fields by if nullable
+      fields = { yes: [], no: [] }
 
       self.klass.columns.each_with_index do |col, index|
         tags = []
@@ -51,6 +71,17 @@ module GoOnRails
           type = TYPE_MAP[col_type] || "string"
         end
 
+        # check the fields if nullable
+        if col.null == true
+          if SPECIAL_COALESCE_TYPES.include?(col_type)
+            fields[:yes] << [col.name, col_type]
+          else
+            fields[:yes] << [col.name, type]
+          end
+        else
+          fields[:no] << col.name
+        end
+
         struct_info[:col_names] << col.name unless col.name == "id"
         struct_info[:struct_body] << sprintf("%s %s `%s`\n", col.name.camelize, type, tags.join(" "))
       end
@@ -59,6 +90,8 @@ module GoOnRails
       struct_info[:struct_body] << assoc[:struct_body]
       struct_info[:assoc_info] = assoc[:assoc_info]
       struct_info[:has_assoc_dependent] = assoc[:has_assoc_dependent]
+      struct_info[:select_fields] = nullable_select_str(fields)
+
       return struct_info
     end
 
@@ -75,6 +108,36 @@ module GoOnRails
       valid_tags = validation.build_validator_tag(col)
       "json:\"#{col.name},omitempty\" db:\"#{col.name}\" #{valid_tags}"
     end
+
+    def nullable_select_str(fields)
+      fields[:yes].map do |f|
+        sprintf(nullable_map(f[1]), "#{self.klass.table_name}.#{f[0]}", f[0])
+      end.concat(
+        fields[:no].map do |f|
+          sprintf("%s.%s", self.klass.table_name, f)
+        end
+      ).join(", ")
+    end
+
+    def nullable_map(type)
+      case type
+      when "string"
+        "COALESCE(%s, '') AS %s"
+      when "int8", "int16", "int32", "int64"
+        "COALESCE(%s, 0) AS %s"
+      when "float64"
+        "COALESCE(%s, 0.0) AS %s"
+      when "bool"
+        "COALESCE(%s, FALSE) AS %s"
+      when "time.Time"
+        DATETIME_COALESCE_MAP[self.database]
+      when "inet"
+        "COALESCE(%s, '0.0.0.0') AS %s"
+      else
+        # FIXME: here just return the column name, may skip some nullable field and cause an error in a query
+        "%s"
+      end
+    end
   end
 end
 

data/lib/generators/gor/gor_generator.rb

@@ -33,21 +33,26 @@ class GorGenerator < Rails::Generators::Base
     @db_config = {}
     read_database_config(rails_env)
 
-    # iterate the models to generate Go codes
+    @all_structs_info = {}
+    # iterate the models to get all the structs' info
     @models.each do |m|
       begin
         klass = m.split('::').inject(Object) { |kls, part| kls.const_get(part) }
         if klass < ActiveRecord::Base && !klass.abstract_class?
-          @model_name = klass.to_s
-          convertor = GoOnRails::Convertor.new(klass, @models)
-          @struct_info = convertor.convert
-          template "gor_model.go.erb", "go_app/models/gor_#{@model_name.underscore}.go"
+          convertor = GoOnRails::Convertor.new(klass, @models, @db_config[:driver_name])
+          @all_structs_info[klass.to_s] = convertor.convert
         end
       rescue Exception => e
         puts "Failed to convert the model [#{m}]: #{e.message}"
       end
     end
 
+    # iterate the structs info to generate codes for each model
+    @all_structs_info.each do |k, v|
+      @model_name, @struct_info = k, v
+      template "gor_model.go.erb", "go_app/models/gor_#{@model_name.underscore}.go"
+    end
+
     # generate program for database connection
     template "db.go.erb", "go_app/models/db.go"
 

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

@@ -2,6 +2,7 @@
 <%- var_pmn = table_name = @model_name.underscore.pluralize -%>
 <%#- var_umn stands for underscored model name -#%>
 <%- var_umn = @model_name.underscore -%>
+<%- fields  = @struct_info[:select_fields] -%>
 <%- col_names = @struct_info[:col_names] -%>
 <%- has_assoc = !@struct_info[:assoc_info][:has_many].empty? || !@struct_info[:assoc_info][:has_one].empty? -%>
 // Package models includes the functions on the model <%= @model_name %>.
@@ -13,9 +14,9 @@ import (
 	"log"
 	"math"
 	"strings"
-	<%- if @struct_info[:has_datetime_type] -%>
+<%- if @struct_info[:has_datetime_type] -%>
 	"time"
-    <%- end -%>
+<%- end -%>
 
 	"github.com/asaskevich/govalidator"
 )
@@ -228,7 +229,7 @@ func Find<%= @model_name %>(id int64) (*<%= @model_name %>, error) {
 		return nil, errors.New("Invalid ID: it can't be zero")
 	}
 	_<%= var_umn %> := <%= @model_name %>{}
-	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT * FROM <%= table_name %> WHERE id = ? LIMIT 1`), id)
+	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT <%= fields %> FROM <%= table_name %> WHERE <%= table_name %>.id = ? LIMIT 1`), id)
 	if err != nil {
 		log.Printf("Error: %v\n", err)
 		return nil, err
@@ -239,7 +240,7 @@ func Find<%= @model_name %>(id int64) (*<%= @model_name %>, error) {
 // First<%= @model_name %> find the first one <%= var_umn %> by ID ASC order
 func First<%= @model_name %>() (*<%= @model_name %>, error) {
 	_<%= var_umn %> := <%= @model_name %>{}
-	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT * FROM <%= table_name %> ORDER BY id ASC LIMIT 1`))
+	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT <%= fields %> FROM <%= table_name %> ORDER BY <%= table_name %>.id ASC LIMIT 1`))
 	if err != nil {
 		log.Printf("Error: %v\n", err)
 		return nil, err
@@ -250,7 +251,7 @@ func First<%= @model_name %>() (*<%= @model_name %>, error) {
 // First<%= @model_name.pluralize %> find the first N <%= var_umn.pluralize %> by ID ASC order
 func First<%= @model_name.pluralize %>(n uint32) ([]<%= @model_name %>, error) {
 	_<%= var_pmn %> := []<%= @model_name %>{}
-	sql := fmt.Sprintf("SELECT * FROM <%= table_name %> ORDER BY id ASC LIMIT %v", n)
+	sql := fmt.Sprintf("SELECT <%= fields %> FROM <%= table_name %> ORDER BY <%= table_name %>.id ASC LIMIT %v", n)
 	err := DB.Select(&_<%= var_pmn %>, DB.Rebind(sql))
 	if err != nil {
 		log.Printf("Error: %v\n", err)
@@ -262,7 +263,7 @@ func First<%= @model_name.pluralize %>(n uint32) ([]<%= @model_name %>, error) {
 // Last<%= @model_name %> find the last one <%= var_umn %> by ID DESC order
 func Last<%= @model_name %>() (*<%= @model_name %>, error) {
 	_<%= var_umn %> := <%= @model_name %>{}
-	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT * FROM <%= table_name %> ORDER BY id DESC LIMIT 1`))
+	err := DB.Get(&_<%= var_umn %>, DB.Rebind(`SELECT <%= fields %> FROM <%= table_name %> ORDER BY <%= table_name %>.id DESC LIMIT 1`))
 	if err != nil {
 		log.Printf("Error: %v\n", err)
 		return nil, err
@@ -273,7 +274,7 @@ func Last<%= @model_name %>() (*<%= @model_name %>, error) {
 // Last<%= @model_name.pluralize %> find the last N <%= var_umn.pluralize %> by ID DESC order
 func Last<%= @model_name.pluralize %>(n uint32) ([]<%= @model_name %>, error) {
 	_<%= var_pmn %> := []<%= @model_name %>{}
-	sql := fmt.Sprintf("SELECT * FROM <%= table_name %> ORDER BY id DESC LIMIT %v", n)
+	sql := fmt.Sprintf("SELECT <%= fields %> FROM <%= table_name %> ORDER BY <%= table_name %>.id DESC LIMIT %v", n)
 	err := DB.Select(&_<%= var_pmn %>, DB.Rebind(sql))
 	if err != nil {
 		log.Printf("Error: %v\n", err)
@@ -291,7 +292,7 @@ func Find<%= @model_name.pluralize %>(ids ...int64) ([]<%= @model_name %>, error
 	}
 	_<%= var_pmn %> := []<%= @model_name %>{}
 	idsHolder := strings.Repeat(",?", len(ids)-1)
-	sql := DB.Rebind(fmt.Sprintf(`SELECT * FROM <%= table_name %> WHERE id IN (?%s)`, idsHolder))
+	sql := DB.Rebind(fmt.Sprintf(`SELECT <%= fields %> FROM <%= table_name %> WHERE <%= table_name %>.id IN (?%s)`, idsHolder))
 	idsT := []interface{}{}
 	for _,id := range ids {
 		idsT = append(idsT, interface{}(id))
@@ -307,7 +308,7 @@ func Find<%= @model_name.pluralize %>(ids ...int64) ([]<%= @model_name %>, error
 // Find<%= @model_name %>By find a single <%= var_umn %> by a field name and a value
 func Find<%= @model_name %>By(field string, val interface{}) (*<%= @model_name %>, error) {
 	_<%= var_umn %> := <%= @model_name %>{}
-	sqlFmt := `SELECT * FROM <%= table_name %> WHERE %s = ? LIMIT 1`
+	sqlFmt := `SELECT <%= fields %> FROM <%= table_name %> WHERE %s = ? LIMIT 1`
 	sqlStr := fmt.Sprintf(sqlFmt, field)
 	err := DB.Get(&_<%= var_umn %>, DB.Rebind(sqlStr), val)
 	if err != nil {
@@ -319,7 +320,7 @@ func Find<%= @model_name %>By(field string, val interface{}) (*<%= @model_name %
 
 // Find<%= @model_name.pluralize %>By find all <%= var_pmn %> by a field name and a value
 func Find<%= @model_name.pluralize %>By(field string, val interface{}) (_<%= var_pmn %> []<%= @model_name %>, err error) {
-	sqlFmt := `SELECT * FROM <%= table_name %> WHERE %s = ?`
+	sqlFmt := `SELECT <%= fields %> FROM <%= table_name %> WHERE %s = ?`
 	sqlStr := fmt.Sprintf(sqlFmt, field)
 	err = DB.Select(&_<%= var_pmn %>, DB.Rebind(sqlStr), val)
 	if err != nil {
@@ -331,7 +332,7 @@ func Find<%= @model_name.pluralize %>By(field string, val interface{}) (_<%= var
 
 // All<%= @model_name.pluralize %> get all the <%= @model_name %> records
 func All<%= @model_name.pluralize %>() (<%= var_pmn %> []<%= @model_name %>, err error) {
-	err = DB.Select(&<%= var_pmn %>, "SELECT * FROM <%= table_name %>")
+	err = DB.Select(&<%= var_pmn %>, "SELECT <%= fields %> FROM <%= table_name %>")
 	if err != nil {
 		log.Println(err)
 		return nil, err
@@ -526,7 +527,7 @@ func <%= @model_name %>StrCol(col, where string, args ...interface{}) (strColRec
 // with placeholders, eg: FindUsersWhere("first_name = ? AND age > ?", "John", 18)
 // will return those records in the table "users" whose first_name is "John" and age elder than 18
 func Find<%= @model_name.pluralize %>Where(where string, args ...interface{}) (<%= var_pmn %> []<%= @model_name %>, err error) {
-	sql := "SELECT * FROM <%= table_name %>"
+	sql := "SELECT <%= fields %> FROM <%= table_name %>"
 	if len(where) > 0 {
 		sql = sql + " WHERE " + where
 	}
@@ -688,7 +689,7 @@ func <%= @model_name %>Get<%= k.pluralize %>(id int64) ([]<%= v[:class_name] %>,
 		// FIXME: use transaction to create these associated objects
 		<%- target_table = v[:class_name].underscore.pluralize -%>
 		<%- through_table = v[:through].to_s.pluralize -%>
-		sql := `SELECT <%= target_table %>.*
+		sql := `SELECT <%= @all_structs_info[v[:class_name]][:select_fields] %>
 		        FROM   <%= target_table %>
 		               INNER JOIN <%= through_table %>
 		                       ON <%= target_table %>.id = <%= through_table %>.<%= v[:class_name].underscore %>_id

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

@@ -1,4 +1,4 @@
-package controller
+package controllers
 
 import (
 	"net/http"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - B1nj0y
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-13 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