go-on-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df621fc93adc16e27b7cb0ea6629daae00a423ee
-  data.tar.gz: 678bb116033389245337cbff83cfe473780c52d5
+  metadata.gz: 9440dee24a0661bf808bf44778dd5d9d95671a9c
+  data.tar.gz: ca2e1a666a7650cb3dd695cb97ccf1e00797cf2d
 SHA512:
-  metadata.gz: 25dfa07d3c00ce9d93901040cb898faf9c5a911b6367fa12f6803f91dd0177894db4dc95a031cc2054176a2a5426801e5a850b376f43d4a3b1f7648485fc1228
-  data.tar.gz: 7257cf5af21b9d489b8fbcd0fd4e808f21ee6ef13e758adcc87079dad457b420e67837f4e91281780fe7cac8bea07bbe0c3b87485a1f33a7014ec981ce773d57
+  metadata.gz: e69cb0445523bbb0a172b47cdf319f14d72196621b85240479727edfb416a9b2887089ee748521da03d7442ce93e332481145781db25533955a3fd75c45f4a6b
+  data.tar.gz: fb805efaf9e5ad7b66d523f0c4b303e99f09f1ffa6cea6b6e94b6d5510c521348b2f507d39d1c14bd3660a1726fbbcbf731a8d87e6a1dee4cfe38097e49c8c09

data/README.md

@@ -1,36 +1,35 @@
 [![Gem Version](https://badge.fury.io/rb/go-on-rails.svg)](https://badge.fury.io/rb/go-on-rails)
 [![Build Status](https://travis-ci.org/goonr/go-on-rails.svg?branch=dev)](https://travis-ci.org/goonr/go-on-rails)
-[![Join the chat at https://gitter.im/goonr/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/goonr/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6fba1f226f027a14c19b/maintainability)](https://codeclimate.com/github/goonr/go-on-rails/maintainability)
 
 <img align="right" width="260" height="260" src="./go-on-rails.png">
 
-go-on-rails
-====
+# Go on Rails
 
 [中文文档](./README_zh.md)
 
-go-on-rails is a Rails generator aims to:
+`go-on-rails` is a Rails generator aims to:
 
-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
+1. Help to develop and integrate some APIs written in Golang to existed Rails app for high performance
+2. Use your farmiliar Rails tools to develop and manage a Golang app project
 3. Convert a *not very complicated* Rails app to Golang equivalent
 
 Here's some examples:
-* a simple [example(tutorial)](https://github.com/goonr/example_simple) on the basic usage of go-on-rails generator
+* 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 handle a Rails session to get an user's info in a go-on-rails generated Go API
 
 ## Prerequisites
 
 * Rails 4.2+
-* Golang 1.5.x
+* Golang 1.7.x
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'go-on-rails', '~> 0.1.12'
+gem 'go-on-rails', '~> 0.3.0'
 ```
 
 And then execute:
@@ -44,20 +43,23 @@ $ gem install go-on-rails
 ```
 ## Usage
 
-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 must have an existed Rails app or to create a new one before you try go-on-rails to generate Golang codes.
 
-After that you can just run the command to convert the application:
+After that you can run the command just as other Rails generators:
 
 ```bash
-rails g gor [dev(elopment) | pro(duction) | test] [-m model_a model_b model_c ...]
+bundle exec rails g gor [dev(elopment) | pro(duction) | test] [-m model_a model_b model_c ...]
+
+# OR (on rails version < 5.0)
+bundle exec rake g gor ...
 ```
 
-Then a directory named "go_app" with Golang codes will be generated under your Rails app root path.
+Then a folder named `go_app` that includes Golang codes will be generated under your Rails app root path.
 
-Install the dependent Golang packages:
+Install the dependent Golang packages for this Go project:
 
 ```bash
-rails gor:deps
+bundle exec rails gor:deps
 ```
 
 Then change to the `go_app` directory and run:
@@ -66,12 +68,12 @@ Then change to the `go_app` directory and run:
 go run main.go
 ```
 
-You can visit the page in http://localhost:3000 by default.
+You can visit the page in http://localhost:4000 by default.
 
 More command details about go-on-rails generator:
 
 ```bash
-rails g gor --help
+bundle exec rails g gor --help
 ```
 
 ## What will be generated?
@@ -87,15 +89,16 @@ rails g gor --help
 You can view the godoc page of all functions in http://localhost:7979/doc/models.html after run:
 
 ```bash
-rails gor:doc
+bundle exec rails gor:doc
 ```
 
-there's [a sample project](https://github.com/goonr/gor_models_sample) generated by go-on-rails, you can view its godoc at godoc.org, [more details](https://github.com/goonr/gor_models_sample).
+Besides, there's [a sample project](https://github.com/goonr/gor_models_sample) generated by go-on-rails, you can view its [godoc](https://godoc.org/github.com/goonr/gor_models_sample) at godoc.org just now to get a picture of what functions are generated.
 
-And the gem is still under development, so there're a lot of known issues.
 
 ## Known issues and TODOs
 
+The gem is still under development, so there're some known issues.
+
 * databases specific functions between MySQL and Postgres or other databases are not covered yet
 * sql.NullType not supported yet, so you'd better in the migrations set those columns "not null" with a default value that's consistent with Golang's zero value specification, such as "" default for string and text typed column, and 0 default for int, etc. And now we have an alternative approch for manipulating the database nullable fields, see the wiki [Working with database nullable fields](https://github.com/goonr/go-on-rails/wiki/Working-with-database-nullable-fields)
 
@@ -118,6 +121,8 @@ And the gem is still under development, so there're a lot of known issues.
 
 * [Built-in Pagination](https://github.com/goonr/go-on-rails/wiki/Pagination)
 * [Working with database nullable fields](https://github.com/goonr/go-on-rails/wiki/Working-with-database-nullable-fields)
+* [Some Make commands](https://github.com/goonr/go-on-rails/wiki/Some-Make-commands)
+* [Dockerize a Go-on-Rails application](https://github.com/goonr/go-on-rails/wiki/Dockerize-a-Go-on-Rails-application)
 
 ## Golang dependencies by default
 

data/lib/generators/gor_generator.rb

@@ -63,6 +63,10 @@ class GorGenerator < Rails::Generators::Base
       template "home_controller.go.erb", "go_app/controllers/home_controller.go"
       copy_file "index.tmpl", "go_app/views/index.tmpl"
       copy_file "favicon.ico", "go_app/public/favicon.ico"
+      # generate config files for make and dockerization
+      template "docker-compose.yml.erb", "docker-compose.yml"
+      template "Dockerfile.go_app.erb", "go_app/Dockerfile"
+      copy_file "Makefile", "go_app/Makefile"
     end
 
     # use gofmt to prettify the generated Golang files
@@ -81,25 +85,26 @@ class GorGenerator < Rails::Generators::Base
   end
 
   def read_database_config rails_env
-    db_conf = Rails.configuration.database_configuration[rails_env]
-    db_conf["host"] = "localhost" unless db_conf["host"]
-    case db_conf["adapter"]
+    @db_config = Rails.configuration.database_configuration[rails_env].symbolize_keys
+    @db_config[:host] ||= "localhost"
+    case @db_config[:adapter]
     when "sqlite3"
       @db_config[:driver_name] = "sqlite3"
-      @db_config[:dsn] = Rails.root.join(db_conf["database"]).to_s
+      @db_config[:dsn] = Rails.root.join(@db_config[:database]).to_s
       @db_config[:driver_package] = "_ \"github.com/goonr/go-sqlite3\""
     when "mysql2"
       @db_config[:driver_name] = "mysql"
-      db_conf["port"] = 3306 unless db_conf["port"]
+      @db_config[:port] ||= "3306"
       # MySQL DSN format: username:password@protocol(address)/dbname?param=value
       # See more: https://github.com/go-sql-driver/mysql
       format = "%s:%s@tcp(%s:%s)/%s?charset=%s&parseTime=True&loc=Local"
-      @db_config[:dsn] = sprintf(format, *db_conf.values_at("username", "password", "host", "port", "database", "encoding"))
+      @db_config[:dsn] = sprintf(format, *@db_config.values_at(:username, :password, :host, :port, :database, :encoding))
       @db_config[:driver_package] = "_ \"github.com/go-sql-driver/mysql\""
     when "postgresql"
       @db_config[:driver_name] = "postgres"
-      format = "host=%s user=%s dbname=%s sslmode=disable password=%s"
-      @db_config[:dsn] = sprintf(format, *db_conf.values_at("host", "username", "database", "password"))
+      @db_config[:port] ||= "5432"
+      format = "host=%s port=%s user=%s dbname=%s sslmode=disable password=%s"
+      @db_config[:dsn] = sprintf(format, *@db_config.values_at(:host, :port, :username, :database, :password))
       @db_config[:driver_package] = "_ \"github.com/lib/pq\""
     end
   end

data/lib/generators/templates/Dockerfile.go_app.erb

@@ -0,0 +1,20 @@
+# Multi-stage builds require Docker 17.05 or higher on the daemon and client.
+# see: https://docs.docker.com/engine/userguide/eng-image/multistage-build/
+
+# build the go app binary
+FROM golang:1.9.2 as builder
+WORKDIR /root/
+COPY . /root/
+<%- if %w[127.0.0.1 localhost].include? @db_config[:host] and @db_config[:driver_name] != "sqlite3" -%>
+RUN perl -pi -e "s/tcp\(.*?:/tcp\(database:/; s/host=\S+? /host=database /" models/db.go
+<%- end -%>
+RUN make deps
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o myapp .
+
+# use the binary app to build the target image
+FROM alpine:latest
+WORKDIR /root/
+ADD views /root/views
+ADD public /root/public
+COPY --from=builder /root/myapp .
+CMD ["./myapp"]

data/lib/generators/templates/Makefile

@@ -0,0 +1,32 @@
+GO := go
+MYAPP := myapp
+IMAGE := $(MYAPP)
+TAG := latest
+
+$(MYAPP):
+	$(GO) build -o $(MYAPP)
+
+clean:
+	-rm $(MYAPP)
+
+build: $(MYAPP)
+	@:
+
+deps:
+	$(GO) get -u github.com/jmoiron/sqlx \
+		github.com/gin-gonic/gin \
+		github.com/goonr/go-sqlite3 \
+		github.com/go-sql-driver/mysql \
+		github.com/lib/pq \
+		github.com/asaskevich/govalidator
+
+test:
+	$(GO) test -v ./models
+
+run: $(MYAPP)
+	./$(MYAPP)
+
+image: clean
+	docker build -t $(USER)/$(IMAGE):$(TAG) .
+
+.PHONY: build clean deps test run image

data/lib/generators/templates/docker-compose.yml.erb

@@ -0,0 +1,37 @@
+version: '3'
+
+services:
+  <%- if %w[127.0.0.1 localhost].include? @db_config[:host] and @db_config[:driver_name] != "sqlite3" -%>
+  # generated according to the config/database.yml
+  database:
+    image: <%= @db_config[:driver_name] %>
+    ports:
+      - '<%= @db_config[:port] %>:<%= @db_config[:port] %>'
+  <%- end -%>
+
+  # rails app part. You need to modify this part by your project
+  # and create a Dockerfile for it before you run any docker-compose command
+  rails_app:
+    build: .
+    command: bundle exec rails s -p 3000 -b '0.0.0.0'
+    ports:
+      - "3000:3000"
+  <%- if %w[127.0.0.1 localhost].include? @db_config[:host] and @db_config[:driver_name] != "sqlite3" -%>
+    depends_on:
+      - database
+  <%- end -%>
+
+  # golang app part. It depends on the rails_app to initialize the database
+  go_app:
+    build: ./go_app
+    command: ./myapp -port 4000
+    environment:
+      # Gin webserver run mode. Or "debug" for debugging
+      - GIN_MODE=release
+    ports:
+      - "4000:4000"
+    depends_on:
+  <%- if %w[127.0.0.1 localhost].include? @db_config[:host] and @db_config[:driver_name] != "sqlite3" -%>
+      - database
+  <%- end -%>
+      - rails_app

data/lib/generators/templates/main.go

@@ -8,8 +8,8 @@ import (
 )
 
 func main() {
-	// The app will run on port 3000 by default, you can custom it with the flag -port
-	servePort := flag.String("port", "3000", "Http Server Port")
+	// The app will run on port 4000 by default, you can custom it with the flag -port
+	servePort := flag.String("port", "4000", "Http Server Port")
 	flag.Parse()
 
 	// Here we are instantiating the router

data/lib/tasks/gor.rake

@@ -2,7 +2,7 @@ namespace :gor do
   desc 'Install dependent Golang packages'
   task :deps do
     puts 'Beginning to install Go deps...'
-    system "go get \
+    system "go get -u \
     github.com/jmoiron/sqlx \
     github.com/gin-gonic/gin \
     github.com/goonr/go-sqlite3 \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: go-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - B1nj0y
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2018-01-11 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
@@ -25,7 +25,10 @@ files:
 - lib/generators/gor/converter.rb
 - lib/generators/gor/validator.rb
 - lib/generators/gor_generator.rb
+- lib/generators/templates/Dockerfile.go_app.erb
+- lib/generators/templates/Makefile
 - lib/generators/templates/db.go.erb
+- lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/favicon.ico
 - lib/generators/templates/gor_model.go.erb
 - lib/generators/templates/home_controller.go.erb