plastic_rails 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da9466a21fafd8f0adf91a52a0cdc8a8c3292774a46e983963c47d39e9084f8
-  data.tar.gz: ad73731d007875b4e2ccf5df6f2a029e0457071cefadc29a749d570d7ac0806d
+  metadata.gz: 90f7872cb0a90ce249ef6032210d9ef6e9dd0a4fd4db2b451c4a4c95447d0d68
+  data.tar.gz: 98304d1e9bddeae78bf548697aac75804f5b6841443e8b7d450b48cfaff2f7b5
 SHA512:
-  metadata.gz: 72062d13c60db678f6af2acd78e9d6cf9735590a35d0d86e11eb9552446700d84540140f12d8237e8da16505c4f332f05046f8b16a99449b68df6cbb250f49e5
-  data.tar.gz: 072b6fc02654c3476ce558723ede41157fc93a24c4a9342f224d1ff5de919cbd556a1efa91f2bd7bd1864231e45e604a3acecde713beebfb7efdafae87349b90
+  metadata.gz: aff574d76f5ba7c0fa36cc8a29f01d6d5b64cd9dc48bbd18060fee392f78f65851ec71044e5ec892804322e75530fa6b7ac34aeb05b9025795f5261f51845b10
+  data.tar.gz: 04df7a51737a3d1f6b16290b0e01ba223ed8e80868fa3a687c1fb83a4319086c543161cd079ff7a2b45a1410fbd8c0c4be6c438b848e7ffb261b797ab9953c6b

data/.gitignore

@@ -7,5 +7,4 @@
 /spec/reports/
 /tmp/
 .DS_Store
-Gemfile.lock
 .ruby-version

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    plastic_rails (0.1.4)
+      thor (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.1)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  plastic_rails!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,8 +1,12 @@
 # Plastic Rails
+[![Gem Version](https://badge.fury.io/rb/plastic_rails.svg)](https://badge.fury.io/rb/plastic_rails)
+
+
 docker上にRuby on Railsの環境を一発で作るスクリプト
 
 プラレールのように自分用のレールを引こう
 
+
 ## Requirements
 - Docker
 - Docker Compose
@@ -20,20 +24,33 @@ gem install plastic_rails
 - rails new済のDockerコンテナを作成する
   - `plastic_rails new <APP_NAME>`
 - コンテナのシェルにログインする
-  -  `cd <APP_NAME>; docker-compose exec web bash; `
+  -  `cd <APP_NAME>; plastic_rails login; `
 - コンテナ上でRails serverを起動する
   - `rails s -b 0.0.0.0`
 
 ## 環境の操作
-環境を作成した後は以下のコマンドで環境を操作する。
-
-- コンテナ停止（<APP＿NAME>ディレクトリで）
-  -  `docker-compose stop`
-- コンテナ削除（<APP＿NAME>ディレクトリで）
-  -  `docker-compose down`
+環境を作成した後は以下のコマンドで環境を操作する。（<APP＿NAME>ディレクトリで実行する）
+
+- コンテナ停止
+  -  `plastic_rails stop`
+- コンテナ削除
+  -  `plastic_rails down`
+- コンテナ起動
+  -  `plastic_rails up`
 - 削除したコンテナを再セットアップ
   -  `./setup.sh`
 
+## カスタマイズ
+DockerfileやRailsのテンプレートを修正することによって、作成する環境をカスタマイズできる。DBをデフォルトのMySQLから別のものに変更することなどが可能。
+
+- デフォルトのテンプレートをコピー
+  - `plastic_rails copy_template <NEW_TEMPLATE>`
+  - <NEW_TEMPLATE> に デフォルトのテンプレート（DockerfileやRailsのアプリケーションテンプレート）が入ったディレクトリがコピーされる。
+- テンプレートを修正する
+- 修正したテンプレートを使用して環境を作成する
+  - `plastic_rails new <APP_NAME> --template=<NEW_TEMPLATE>` 
+
+
 ## Plastic Rails自体の開発・デバッグ
 ### デバッグ環境（Vagrant）作成
 - あらかじめ、VirtualboxとVagrantをインストールしておく。

data/lib/plastic_rails.rb

@@ -1,17 +1,24 @@
 require "thor"
 require "plastic_rails/version"
 require "plastic_rails/fileutils"
+  THOR_SILENCE_DEPRECATION = true
 
 module PlasticRails
   class Error < StandardError; end
 
   class PlaRails < Thor
-    TMPL_DIR=File.dirname(__FILE__)
-    p TMPL_DIR
-    desc "new APPNAME", "create a Rails application skelton with Docker container."
+    DEFAULT_TEMPLATE_DIR = File.join(File.dirname(__FILE__) , "tmpl")
+
+    def self.exit_on_failure?
+      # コマンドが失敗したときに終了ステータス１を返すようにする設定
+      true
+    end
+
+    desc "new [APPNAME]", "Create a Rails application skelton with Docker container."
     option :db_path, :default => "./db/mysql/volumes"
+    option :template, :default => DEFAULT_TEMPLATE_DIR
     def new(appname)
-      execute("cp -a #{TMPL_DIR}/tmpl #{appname}")
+      execute("cp -a #{options[:template]} #{appname}")
       Dir.chdir(appname)
 
       # DBのファイルパスを設定する
@@ -27,11 +34,31 @@ module PlasticRails
       system("./setup.sh")
     end
 
-    desc "login", "log in Rails container related to current directory."
+    desc "login", "Log in Rails container related to current directory."
     def login
       execute("docker-compose exec web bash")
     end
 
+    desc "up", "Start up Rails container related to current directory."
+    def up
+      execute("docker-compose up -d")
+    end
+
+    desc "stop", "Stop Rails container related to current directory."
+    def stop
+      execute("docker-compose stop")
+    end
+
+    desc "down", "Stop and remove Rails container related to current directory."
+    def down
+      execute("docker-compose down")
+    end
+
+    desc "copy_template [DEST_DIR]", "Copy the default template to any dir. (To use in `new` command with `--template` option.)"
+    def copy_template(dest_dir)
+      execute("cp -a #{DEFAULT_TEMPLATE_DIR} #{dest_dir}")
+    end
+
     private
 
     def execute(cmd)

data/lib/plastic_rails/version.rb

@@ -1,3 +1,3 @@
 module PlasticRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/plastic_rails.gemspec

@@ -10,23 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["gohannnotomo@gmail.com"]
 
   spec.summary       = %q{docker上にRuby on Railsの環境を一発で作るスクリプト}
-  spec.description   = %q{プラレールのように自分用のレールを引こう}
+  spec.description   = %q{docker上にRuby on Railsの環境を一発で作るスクリプト。プラレールのように自分用のレールを引こう。}
   spec.homepage      = "http://github.com/koki-h/plastic_rails"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-#  if spec.respond_to?(:metadata)
-#    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-#
-#    spec.metadata["homepage_uri"] = spec.homepage
-#    spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-#    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-#  else
-#    raise "RubyGems 2.0 or newer is required to protect against " \
-#      "public gem pushes."
-#  end
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -36,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_runtime_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_runtime_dependency "thor", "~> 1.0"
 end

metadata

@@ -1,58 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: plastic_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Koki Hashimoto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: プラレールのように自分用のレールを引こう
+        version: '1.0'
+description: docker上にRuby on Railsの環境を一発で作るスクリプト。プラレールのように自分用のレールを引こう。
 email:
 - gohannnotomo@gmail.com
 executables:
@@ -63,6 +63,7 @@ files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -77,18 +78,11 @@ files:
 - lib/tmpl/build.sh
 - lib/tmpl/docker-compose.yml
 - lib/tmpl/init/Gemfile
+- lib/tmpl/init/Gemfile.lock
 - lib/tmpl/init/application_template/template.rb
 - lib/tmpl/init/application_template/template/config/database.yml
 - lib/tmpl/setup.sh
 - plastic_rails.gemspec
-- tmpl/Dockerfile
-- tmpl/apps/.keep
-- tmpl/build.sh
-- tmpl/docker-compose.yml
-- tmpl/init/Gemfile
-- tmpl/init/application_template/template.rb
-- tmpl/init/application_template/template/config/database.yml
-- tmpl/setup.sh
 homepage: http://github.com/koki-h/plastic_rails
 licenses:
 - MIT

data/tmpl/Dockerfile

@@ -1,37 +0,0 @@
-FROM ruby:2.6.5-alpine3.9
-
-RUN apk update
-RUN apk upgrade
-
-RUN apk add --no-cache \
-      bash git vim openssh openssl yarn sudo su-exec shadow tzdata \
-      mysql-client mysql-dev\
-      build-base libxml2-dev libxslt-dev
-
-ARG UID=1000
-ARG GID=1000
-
-RUN mkdir /var/mail
-RUN groupadd -g $GID devel
-RUN useradd -u $UID -g devel -m devel
-RUN echo "devel ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
-
-# install rails
-WORKDIR /tmp
-COPY init/Gemfile /tmp/Gemfile
-COPY init/Gemfile.lock /tmp/Gemfile.lock
-RUN bundle install
-
-COPY ./apps /apps
-
-RUN apk add --no-cache openssl
-
-WORKDIR /apps
-
-USER devel
-
-RUN openssl rand -hex 64 > /home/devel/.secret_key_base
-RUN echo $'export SECRET_KEY_BASE=$(cat /home/devel/.secret_key_base)' \
-  >> /home/devel/.bashrc
-
-COPY init/application_template/ /tmp/application_template/

data/tmpl/build.sh

@@ -1,20 +0,0 @@
-#!/bin/bash
-set -eu
-APPNAME=$1
-BUILD_CMD="docker-compose build --no-cache --build-arg APPNAME=$APPNAME"
-RUN_ON_WEB_CMD="docker-compose run --rm web"
-OSTYPE=$(uname)
-
-case "$OSTYPE" in
-  Darwin*)
-    $BUILD_CMD web
-    ;;
-  Linux*)
-    $BUILD_CMD --build-arg UID=$(id -u) --build-arg GID=$(id -g) web
-    ;;
-  *)
-    echo "Unknown OS Type: $OSTYPE"
-    ;;
-esac
-
-$RUN_ON_WEB_CMD rails new $APPNAME --database=mysql --skip-bundle --skip-webpack-install -m /tmp/application_template/template.rb

data/tmpl/docker-compose.yml

@@ -1,28 +0,0 @@
-version: '3'
-services:
-  db:
-    image: mysql:5.7
-    environment:
-      MYSQL_USER: root
-      MYSQL_ROOT_PASSWORD: password
-    ports:
-      - '3316:3306'
-    volumes:
-      - %DB_PATH%:/var/lib/mysql
-
-  web:
-    build: .
-    command: /bin/sh
-    environment:
-      WEBPACKER_DEV_SERVER_HOST: "0.0.0.0"
-      RAILS_SERVE_STATIC_FILES: "1"
-      EDITOR: "vim"
-    volumes:
-      - ./apps:/apps
-    ports:
-      - "3000:3000"
-      - "3035:3035"
-    depends_on:
-      - db
-    tty: true
-    working_dir: /apps/

data/tmpl/init/Gemfile

@@ -1,2 +0,0 @@
-source 'https://rubygems.org'
-gem 'rails', '~> 6.0.0'

data/tmpl/init/application_template/template.rb

@@ -1,12 +0,0 @@
-@app_name = app_name
-def source_paths
-  ["#{__dir__}/template"]
-end
-
-# Database
-inside 'config' do
-  remove_file "database.yml"
-  copy_file "database.yml"
-  gsub_file 'database.yml', /%APPNAME%/, @app_name
-  gsub_file 'database.yml', /%APPNAME_UPPERCASE%/, @app_name.upcase
-end

data/tmpl/init/application_template/template/config/database.yml

@@ -1,54 +0,0 @@
-# MySQL. Versions 5.5.8 and up are supported.
-#
-# Install the MySQL driver
-#   gem install mysql2
-#
-# Ensure the MySQL gem is defined in your Gemfile
-#   gem 'mysql2'
-#
-# And be sure to use new-style password hashing:
-#   https://dev.mysql.com/doc/refman/5.7/en/password-hashing.html
-#
-default: &default
-  adapter: mysql2
-  encoding: utf8mb4
-  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
-  username: root
-  password: password
-  host: db
-
-development:
-  <<: *default
-  database: %APPNAME%_development
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  <<: *default
-  database: %APPNAME%_test
-
-# As with config/credentials.yml, you never want to store sensitive information,
-# like your database password, in your source code. If your source code is
-# ever seen by anyone, they now have access to your database.
-#
-# Instead, provide the password as a unix environment variable when you boot
-# the app. Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
-# for a full rundown on how to provide these environment variables in a
-# production deployment.
-#
-# On Heroku and other platform providers, you may have a full connection URL
-# available as an environment variable. For example:
-#
-#   DATABASE_URL="mysql2://myuser:mypass@localhost/somedatabase"
-#
-# You can use this database configuration with:
-#
-#   production:
-#     url: <%= ENV['DATABASE_URL'] %>
-#
-production:
-  <<: *default
-  database: %APPNAME%_production
-  username: %APPNAME%
-  password: <%= ENV['%APPNAME_UPPERCASE%_DATABASE_PASSWORD'] %>

data/tmpl/setup.sh

@@ -1,19 +0,0 @@
-#!/bin/bash
-set -eu
-ESC="\e["
-ESCEND=m
-COLOR_OFF=$(printf ${ESC}${ESCEND})
-COLOR_CMD=$(printf "${ESC}36;1;${ESCEND}") # front: cyan;bold 
-RUN_ON_WEB_CMD="docker-compose exec web"
-#RUN_ON_WEB_CMD="docker-compose run --rm web"
-function docker_run {
-  cmd=$1
-  echo ${COLOR_CMD}${cmd}${COLOR_OFF}
-  $RUN_ON_WEB_CMD $cmd
-}
-docker-compose up -d
-docker_run "bundle install "
-docker_run "yarn install --check-files"
-docker_run "yarn upgrade"
-docker_run "rails webpacker:install"
-docker_run "rails db:setup"