railman 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2452bb4c3c783b6efe3694e9582281bbcd8bc5f9
-  data.tar.gz: 63fbcfea9787bb517762ccc91b06a183de7844ca
+  metadata.gz: e1ecb9d6bcb4c0a2dbd78093cd8892efe6b89884
+  data.tar.gz: 9a65f64857c7dd6e9dd27e451addebb774d4eb86
 SHA512:
-  metadata.gz: 4b0ecbc34ee75ad020c4516b20615515aeaad8ad67083d3f2b26bcd367f76581bb9397285fcc9bc8af9d7f5c688bcc70fb8fa9aedce93110289a0c4688375b74
-  data.tar.gz: 21daa85a4cbc6f3c4e6c154a94c83d64a92518bcc904aaf500fa26333a0f57a98d4ec28f37e4bfff7111c6c7bbd7f84076f0ba0c84318e823c451233ed46badc
+  metadata.gz: 9d436a33a67ad227d9975bb7059ae627aa9133c75af7cd6b3f4d3cea50b4547ffe81f3e716313af694cc3c3d9549b81364a496f4faea32612c4d0681994716f2
+  data.tar.gz: 8370baad6e71bf1d1436e25c299e188359496c1ca80739b25e5d3613272c4df32e4813be9dcdb1b35bf1c5ee02beac411e50eeac28f2e3bf474bba55ecc120c1

data/README.md

@@ -35,6 +35,7 @@ Or install it yourself as:
 ## Usage
 
 Run `railman new APP_NAME` to create new rails application.
+Run `railman upgrade APP_NAME` to upgrade existing rails application.
 
 
 ## Development

data/lib/railman/cli.rb

@@ -1,5 +1,7 @@
 require 'thor'
+require 'yaml'
 require 'creategem'
+require 'railman/config'
 require 'railman/secret'
 
 module Railman
@@ -17,50 +19,74 @@ module Railman
     desc "new APPNAME", "Create new rails application named APPNAME"
     def new(app_name)
       say "Create a new rails application named: #{app_name}", :green
-      apply_rails_template(app_name)
+      config = create_config(app_name)
+      apply_rails_template(config)
       say "The rails application '#{app_name}' was successfully created.", :green
       say "Please check the settings in .env", :blue
     end
 
     desc "upgrade APPNAME", "Upgrade the rails upplication named APPNAME"
     def upgrade(app_name)
-      puts "TODO upgrade the rails application: #{app_name}"
-      apply_rails_template(app_name, false)
+      puts "Upgrade the rails application: #{app_name}"
+      config = load_config(app_name)
+      apply_rails_template(config, false)
       say "The rails application '#{app_name}' was successfully upgraded.", :green
       say "Please check the settings in .env", :blue
     end
 
     private
 
-    def apply_rails_template(app_name, create = true)
-      @app_name = app_name
-      @class_name = Thor::Util.camel_case(app_name)
-      @admin_email = ask("What is the adminitrator email address?")
-      @domain = ask("What is the url of the application (without http and www)?")
-      if yes?("Do you want me to configure www.#{@domain} domain to be redirected to #{@domain}? (y/n)")
-        @www_domain = "www.#{@domain}"
-        @domains = [@domain, @www_domain]
+    def create_config(app_name)
+      config = Railman::Config.new
+      config.app_name = app_name
+      config.class_name = Thor::Util.camel_case(app_name)
+      config.admin_email = ask("What is the adminitrator email address?")
+      config.domain = ask("What is the url of the application (without http and www)?")
+      if yes?("Do you want me to configure www.#{config.domain} domain to be redirected to #{config.domain}? (y/n)")
+        config.www_domain = "www.#{config.domain}"
+        config.domains = [config.domain, config.www_domain]
       else
-        @www_domain = nil
-        @domains = [@domain]
+        config.www_domain = nil
+        config.domains = [config.domain]
       end
-      @server = ask("What is the name of the production server?")
+      config
+    end
+
+    def load_config(app_name)
+      if File.exists? File.join(app_name, ".railman")
+        YAML::load_file File.join(app_name, ".railman")
+      else
+        create_config(app_name)
+      end
+    end
+
+    def save_config(config)
+      File.open File.join(config.app_name, ".railman"), "w" do |file|
+        file.write config.to_yaml
+      end
+    end
+
+    def apply_rails_template(config, create = true)
+      @config = config
       @repository = Creategem::Repository.new(vendor: :bitbucket,
                                               user: git_repository_user_name(:bitbucket),
-                                              name: app_name,
+                                              name: @config.app_name,
                                               gem_server_url: gem_server_url(:bitbucket))
       @rake_secret = "TODO: generate with: rake secret"
       @unicorn_behind_nginx = true
-      directory "rails_app", app_name
-      @rake_secret = Railman::Secret.generate_secret
-      @unicorn_behind_nginx = false
-      template "rails_app/.env.example.development.tt", "#{app_name}/.env"
-      Dir.chdir app_name do
+      directory "rails_app", @config.app_name
+      if create
+        @rake_secret = Railman::Secret.generate_secret
+        @unicorn_behind_nginx = false
+        template "rails_app/.env.example.development.tt", "#{@config.app_name}/.env"
+        save_config(@config)
+      end
+      Dir.chdir @config.app_name do
         run "bundle install"
         run "chmod +x bin/*"
         if create
           create_local_git_repository
-          create_remote_git_repository(@repository) if yes?("Do you want me to create bitbucket repository named #{app_name}? (y/n)")
+          create_remote_git_repository(@repository) if yes?("Do you want me to create bitbucket repository named #{@config.app_name}? (y/n)")
         end
       end
     end

data/lib/railman/config.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+# Railman::Config contains configuration parameters used to generate the rails application
+# It is saved in .railman in the generated application, so that it can be used to upgrade the application later.
+module Railman
+  class Config
+    attr_accessor :app_name, :class_name, :admin_email, :domain, :www_domain, :domains, :server
+  end
+end

data/lib/railman/version.rb

@@ -1,3 +1,3 @@
 module Railman
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/templates/rails_app/.env.example.development.tt

@@ -3,7 +3,7 @@
 # Don't commit this file to Git !!! Copy from .env.example.development and modify for each machine
 
 # Application settings
-APP_NAME = '<%= app_name %>'
+APP_NAME = '<%= @config.app_name %>'
 
 
 # Database settings
@@ -16,12 +16,12 @@ SECRET_TOKEN = '<%= @rake_secret %>'
 
 
 # Where to send exceptions and other admin emails
-ADMIN_EMAIL = '<%= @admin_email %>'
+ADMIN_EMAIL = '<%= @config.admin_email %>'
 
 
 # Exception notification settings
-EXCEPTION_NOTIFICATION_EMAIL_PREFIX = '[<%= @class_name %>] '
-EXCEPTION_NOTIFICATION_SENDER = 'server@<%= @domain %>'
+EXCEPTION_NOTIFICATION_EMAIL_PREFIX = '[<%= @config.class_name %>] '
+EXCEPTION_NOTIFICATION_SENDER = 'server@<%= @config.domain %>'
 
 
 # Unicorn settings

data/templates/rails_app/.env.example.production.tt

@@ -3,7 +3,7 @@
 # Don't commit this file to Git !!! Copy from .env.example.production and modify for each machine
 
 # Application settings
-APP_NAME = '<%= app_name %>'
+APP_NAME = '<%= @config.app_name %>'
 
 
 # Database settings
@@ -16,20 +16,20 @@ SECRET_TOKEN = '<%= @rake_secret %>'
 
 
 # SMTP server settings
-SMTP_SERVER = 'mail.<%= @domain %>'
-SMTP_USER = 'server@<%= @domain %>'
+SMTP_SERVER = 'mail.<%= @config.domain %>'
+SMTP_USER = 'server@<%= @config.domain %>'
 SMTP_PASSWORD = '*****'
-SMTP_DOMAIN = '<%= @domain %>'
-SMTP_DEFAULT_URL = '<%= @domain %>'
+SMTP_DOMAIN = '<%= @config.domain %>'
+SMTP_DEFAULT_URL = '<%= @config.domain %>'
 
 
 # Where to send exceptions and other admin emails
-ADMIN_EMAIL = '<%= @admin_email %>'
+ADMIN_EMAIL = '<%= @config.admin_email %>'
 
 
 # Exception notification settings
-EXCEPTION_NOTIFICATION_EMAIL_PREFIX = '[<%= @class_name %>] '
-EXCEPTION_NOTIFICATION_SENDER = 'server@<%= @domain %>'
+EXCEPTION_NOTIFICATION_EMAIL_PREFIX = '[<%= @config.class_name %>] '
+EXCEPTION_NOTIFICATION_SENDER = 'server@<%= @config.domain %>'
 
 
 # Unicorn settings

data/templates/rails_app/Eyefile.tt

@@ -1,9 +1,9 @@
 # Eye configuration file (https://github.com/kostya/eye)
 # Load with: 'eye l Eyefile'
 # Watch processes: 'eye w'
-# Stop all processes: 'eye stop <%= app_name %>'
-# Start all processes: 'eye start <%= app_name %>'
-# Restart unicorn: 'eye restart <%= app_name %>:unicorn'
+# Stop all processes: 'eye stop <%= @config.app_name %>'
+# Start all processes: 'eye start <%= @config.app_name %>'
+# Restart unicorn: 'eye restart <%= @config.app_name %>:unicorn'
 
 APP_ROOT = File.expand_path('..', __FILE__)
 

data/templates/rails_app/app/views/home/index.html.erb.tt

@@ -1 +1 @@
-<p>Welcome to: <%= @class_name %></p>
+<p>Welcome to: <%= @config.class_name %></p>

data/templates/rails_app/app/views/layouts/application.html.erb.tt

@@ -6,7 +6,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
 
-  <title><%= @class_name %></title>
+  <title><%= @config.class_name %></title>
   <%%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
   <%%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
 

data/templates/rails_app/config/application.rb.tt

@@ -6,7 +6,7 @@ require 'rails/all'
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
-module <%= @class_name %>
+module <%= @config.class_name %>
   class Application < Rails::Application
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers

data/templates/rails_app/config/database.yml.tt

@@ -3,7 +3,7 @@ development:
   encoding: unicode
   port: 5432
   host: localhost
-  database: <%= app_name %>_development
+  database: <%= @config.app_name %>_development
   username: <%%= ENV['DB_USER'] %>
   password: <%%= ENV['DB_PASSWORD'] %>
   pool: 5
@@ -14,7 +14,7 @@ test:
   encoding: unicode
   port: 5432
   host: localhost
-  database: <%= app_name %>_test
+  database: <%= @config.app_name %>_test
   username: <%%= ENV['DB_USER'] %>
   password: <%%= ENV['DB_PASSWORD'] %>
   pool: 5
@@ -25,7 +25,7 @@ production:
   encoding: unicode
   port: 5432
   host: localhost
-  database: <%= app_name %>_production
+  database: <%= @config.app_name %>_production
   username: <%%= ENV['DB_USER'] %>
   password: <%%= ENV['DB_PASSWORD'] %>
   pool: 15

data/templates/rails_app/config/deploy.rb.tt

@@ -1,7 +1,9 @@
 # Capistrano deployment tasks
 lock '3.4.1'
 
-set :application, '<%= app_name %>'
+require 'securerandom'
+
+set :application, '<%= @config.app_name %>'
 set :repo_url, '<%= @repository.origin %>'
 set :deploy_to, "/home/deploy/apps/#{fetch(:application)}"
 set :rbenv_home, '/home/deploy/.rbenv'
@@ -45,7 +47,9 @@ task :setup do
           execute :eye, :start, fetch(:application)
           execute :service, "nginx restart"
         else
-          warn "TODO: Create .env on the server by copying from .env.example.production and modify your database and smtp settings."
+          execute :cp, '.env.example.production', '.env'
+          execute "sed -i -e 's/TODO: generate with: rake secret/#{SecureRandom.hex(64)}/g' .en"
+          warn "TODO: Edit .env and modify your database and smtp settings."
           warn "TODO: Create rails secret token with 'rake secret' and insert it into .env"
           warn "TODO: Create ssl certificates by running the following command as root: /etc/letsencrypt/generate_letsencrypt.sh"
           warn "TODO: Run 'cap ENV setup' again!"

data/templates/rails_app/config/deploy/production.rb.tt

@@ -1,4 +1,4 @@
 # production server configuration for capistrano
-set :server, '<%= @server %>'
+set :server, '<%= @config.server %>'
 set :user, 'deploy'
 server fetch(:server), user: fetch(:user), roles: %w{web app db}

data/templates/rails_app/config/environments/{production.rb → production.rb.tt}

@@ -56,7 +56,7 @@ Rails.application.configure do
 
   # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
-  config.cache_store = :dalli_store, { namespace: ENV['APP_NAME'] }
+  config.cache_store = :dalli_store, { namespace: '<%= @config.app_name %>:' }
 
   # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = 'http://assets.example.com'

data/templates/rails_app/config/initializers/session_store.rb.tt

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
 Rails.application.config.session_store :redis_session_store, {
-  key: "_<%= app_name %>_session",
-  redis: { key_prefix: "<%= app_name %>:", expire_after: 2.minutes }
+  key: "_<%= @config.app_name %>_session",
+  redis: { key_prefix: "<%= @config.app_name %>:", expire_after: 2.minutes }
 }

data/templates/rails_app/config/initializers/sidekiq.rb.tt

@@ -1,7 +1,7 @@
 require 'sidekiq/scheduler'
 
-# Configure Sidekiq Redis connection to use the '<%= app_name %>' namespace
-redis_config = { url: 'redis://localhost:6379', namespace: '<%= app_name %>' }
+# Configure Sidekiq Redis connection to use the '<%= @config.app_name %>' namespace
+redis_config = { url: 'redis://localhost:6379', namespace: '<%= @config.app_name %>:' }
 
 Sidekiq.configure_server do |config|
   config.redis = redis_config

data/templates/rails_app/config/server/letsencrypt.conf.tt

@@ -2,13 +2,13 @@
 rsa-key-size = 4096
 
 # this address will receive renewal reminders, IIRC
-email = <%= @admin_email %>
+email = <%= @config.admin_email %>
 
 # Generate certificates for the specified domains
-domains = <%= @domains.join(',') %>
+domains = <%= @config.domains.join(',') %>
 
 # turn off the ncurses UI, we want this to be run as a cronjob
 text = True
 
 # authenticate by placing a file in the webroot (under .well-known/acme-challenge/) and then letting LE fetch it
-webroot-path = /home/deploy/apps/<%= app_name %>
+webroot-path = /home/deploy/apps/<%= @config.app_name %>

data/templates/rails_app/config/server/logrotate.conf.tt

@@ -1,4 +1,4 @@
-/home/deploy/apps/<%= app_name %>/log/*.log {
+/home/deploy/apps/<%= @config.app_name %>/log/*.log {
   daily
   missingok
   rotate 9

data/templates/rails_app/config/server/nginx.conf.tt

@@ -1,13 +1,13 @@
-upstream <%= app_name %> {
-	server unix:/tmp/unicorn.<%= app_name %>.sock fail_timeout=0;
+upstream <%= @config.app_name %> {
+	server unix:/tmp/unicorn.<%= @config.app_name %>.sock fail_timeout=0;
 }
 
 server {
   listen 443 ssl;
-  server_name <%= @domain %>;
+  server_name <%= @config.domain %>;
 
   index index.html;
-  root /home/deploy/apps/<%= app_name %>/public;
+  root /home/deploy/apps/<%= @config.app_name %>/public;
   try_files $uri/index.html $uri @app;
 
   location @app {
@@ -18,7 +18,7 @@ server {
 
     proxy_set_header Host $http_host;
     proxy_redirect off;
-    proxy_pass http://<%= app_name %>;
+    proxy_pass http://<%= @config.app_name %>;
   }
 
   client_max_body_size 100m;
@@ -37,17 +37,17 @@ server {
   }
 
   location ~ ^/(assets)/  {
-    root /home/deploy/apps/<%= app_name %>/public;
+    root /home/deploy/apps/<%= @config.app_name %>/public;
     gzip_static on; # to serve pre-gzipped version
     expires max;
     add_header Cache-Control public;
   }
 
   # Let's Encrypt certificates
-  ssl_certificate /etc/letsencrypt/live/<%= @domain %>/fullchain.pem;
-  ssl_certificate_key /etc/letsencrypt/live/<%= @domain %>/privkey.pem;
+  ssl_certificate /etc/letsencrypt/live/<%= @config.domain %>/fullchain.pem;
+  ssl_certificate_key /etc/letsencrypt/live/<%= @config.domain %>/privkey.pem;
 
-  location /home/deploy/apps/<%= app_name %>/public/.well-known {
+  location /home/deploy/apps/<%= @config.app_name %>/public/.well-known {
   	allow all;
   }
 }
@@ -55,18 +55,18 @@ server {
 
 server {
   listen 80;
-  server_name <%= @domains.join(' ') %>;
-  return 301 https://<%= @domain %>$request_uri;
+  server_name <%= @config.domains.join(' ') %>;
+  return 301 https://<%= @config.domain %>$request_uri;
 }
 
-<% if @www_domain %>
+<% if @config.www_domain %>
 server {
   listen 443 ssl;
-  server_name <%= @www_domain %>;
-  return 301 $scheme://<%= @domain %>$request_uri;
+  server_name <%= @config.www_domain %>;
+  return 301 $scheme://<%= @config.domain %>$request_uri;
 
   # Let's Encrypt certificates
-  ssl_certificate /etc/letsencrypt/live/<%= @domain %>/fullchain.pem;
-  ssl_certificate_key /etc/letsencrypt/live/<%= @domain %>/privkey.pem;
+  ssl_certificate /etc/letsencrypt/live/<%= @config.domain %>/fullchain.pem;
+  ssl_certificate_key /etc/letsencrypt/live/<%= @config.domain %>/privkey.pem;
 }
 <% end %>

data/templates/rails_app/config/unicorn.rb.tt

@@ -6,7 +6,7 @@ require 'dotenv'
 Dotenv.load
 
 if ENV['UNICORN_BEHIND_NGINX']
-  listen '/tmp/unicorn.<%= app_name %>.sock'
+  listen '/tmp/unicorn.<%= @config.app_name %>.sock'
 else
   listen Integer(ENV['UNICORN_PORT'] || 3000)
 end

data/templates/rails_app/test/integration/homepage_test.rb.tt

@@ -4,6 +4,6 @@ class HomepageTest < WebTest
   test 'homepage' do
     visit '/'
     screenshot 'homepage'
-    must_have_content 'Welcome to: <%= @class_name %>'
+    must_have_content 'Welcome to: <%= @config.class_name %>'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railman
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Jancev
@@ -157,6 +157,7 @@ files:
 - exe/railman
 - lib/railman.rb
 - lib/railman/cli.rb
+- lib/railman/config.rb
 - lib/railman/secret.rb
 - lib/railman/version.rb
 - railman.gemspec
@@ -205,7 +206,7 @@ files:
 - templates/rails_app/config/deploy/production.rb.tt
 - templates/rails_app/config/environment.rb
 - templates/rails_app/config/environments/development.rb
-- templates/rails_app/config/environments/production.rb
+- templates/rails_app/config/environments/production.rb.tt
 - templates/rails_app/config/environments/test.rb
 - templates/rails_app/config/initializers/assets.rb
 - templates/rails_app/config/initializers/backtrace_silencers.rb