wellcar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41fbc50fae9ac8ae5ee904b21027e31a9c863d5e2fb9c3c3758b7f071cfe2fb1
-  data.tar.gz: 54b46d33182277c74712784613897efd46500cc198ec21166c72b553784eb43a
+  metadata.gz: d9629130bcd16fffcc9864daedb27e5f5795c660a33f92816a33851dac2bb98c
+  data.tar.gz: d59cc9b695eeaff5af97a498c589b053ab454f6f99583e1a54e913bf19172d7c
 SHA512:
-  metadata.gz: 41ca7e4d530f489b8f7c4db42da7b6fc9d31ab6bbce80a0d44c9a7f09a8b4c8598b32affca23b957975b50d7af98e98cda5334a0d31794a89999fec70c694b44
-  data.tar.gz: 552e7a7d1db64552c44f272464bd2065ea80d2f148f7f05acfdc5d5002b59bbc650858da498ae1e88628b4091cb5c355b16c24cd911501da3c6beabcff0114cc
+  metadata.gz: e6da3f0f58f3c7ee6788ed5fd30bd767a8ac3c778a59e797bf174f5762db7eef75f742bdb9cd149e8327f66999f2291fefbfc8ddee139a94bc8849d218d2ce04
+  data.tar.gz: f14698f09a94e51c8072f9812b7eef731fb19be0752d03895679b185e6e54a17715acbb1280651fff8273742deb02299495ba80b387999803e4cbf6e4345dde4

data/.gitignore

@@ -1,5 +1,27 @@
-*swp
-*swo
+# Swap
+[._]*.s[a-v][a-z]
+!*.svg  # comment out if you don't need vector files
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+# git mergefiles
+*.orig
+
+# macos metadata
 .DS_Store
+
 pkg
 tmp

data/README.markdown

@@ -15,3 +15,21 @@ I have published the gem to Rubygems.org, purely to make sure that the name `wel
 As such, please mess around or whatever but do not expect any polish, or even anything to work.
 
 [The DIP gem by @bidendi](https://github.com/bibendi/dip) is an inspiration for my tinkering here. Check it out if you're serious about developing and deploying Rails apps in Docker containers!
+[Kuby](https://github.com/getkuby/kuby-core) is a tool that automates Docker and Kubernetes for a Rails app. I discovered this via Ruby Weekly literally as I was going through publishing `wellcar`.
+
+## Approach
+I've taken a pragmatic, quick-and-dirty approach to building `wellcar`.
+
+### Templating files for Dockerising
+Docker files generation rather crudely relies on ERB templating.
+There are pairs of `.erb` and `.rb` files within `lib/wellcar/templates/` for each of the files that gets generated by `wellcar new` and `wellcar dock`.
+
+I would prefer to have some sort of AST for the different file types to make the system more flexible.
+However, I don't know enough about Docker, the files I might need to manage or ASTs to try to tackle that right now.
+It would be a long-term goal to do this.
+
+### Running commands
+Commands are also crudely executed with `system()` calls.
+This is a clunky approach but has helped me deep-dive into Docker and understand the command hierarchy, particularly between `docker` and `docker-compose`, and the workflow for deploying apps.
+
+At some stage, it might be possible to interact with the Docker Daemon directly although it's debatable whether this is advantageous or not.

data/bin/wellcar

@@ -132,7 +132,7 @@ class NewCommand < CommandBase
     # remove dockerfile.init and docker-compose.yml with initialisation services
     %w(Dockerfile.init docker-compose.yml config/database.yml).each {|f| File.delete(f) if File.file?(f) }
     # Create docker-compose.yml file
-    Wellcar::Templates::DockerCompose.new(app_name).write
+    Wellcar::Templates::DockerCompose.new(app_name, github_account).write
     Wellcar::Templates::DatabaseYaml.new(app_name).write
   end
 

data/lib/wellcar/templates/env_development_database.erb

@@ -1,3 +1,3 @@
 POSTGRES_USER=postgres
-POSTGRES_PASSWORD=a-development-password
+POSTGRES_PASSWORD=<%= password %>
 POSTGRES_DB=<%= app_name %>_development

data/lib/wellcar/templates/env_development_database.rb

@@ -1,3 +1,4 @@
+require "securerandom"
 require File.join(File.dirname(__FILE__), "base")
 
 module Wellcar
@@ -5,7 +6,8 @@ module Wellcar
     class EnvDevelopmentDatabase < Base
       def initialize(app_name)
         super ".env/development/database"
-        with_attributes app_name: app_name
+        with_attributes app_name: app_name,
+          password: SecureRandom.base64(20)
         with_template "env_development_database.erb"
       end
     end

data/lib/wellcar/templates/env_production_database.erb

@@ -1,3 +1,3 @@
 POSTGRES_USER=postgres
-POSTGRES_PASSWORD=replace-me
+POSTGRES_PASSWORD=<%= password %>
 POSTGRES_DB=<%= app_name %>_production

data/lib/wellcar/templates/env_production_database.rb

@@ -1,11 +1,13 @@
 require File.join(File.dirname(__FILE__), "base")
+require "securerandom"
 
 module Wellcar
   module Templates
     class EnvProductionDatabase < Base
       def initialize(app_name)
         super ".env/production/database"
-        with_attributes app_name: app_name
+        with_attributes app_name: app_name,
+          password: SecureRandom.base64(20)
         with_template "env_production_database.erb"
       end
     end

data/lib/wellcar/templates/reverse_proxy_conf.rb

@@ -4,9 +4,9 @@ module Wellcar
   module Templates
     class ReverseProxyConf < Base
       def initialize(domain_name)
-        super "reverse_proxy.conf"
+        super "reverse-proxy.conf"
         with_attributes domain_name: domain_name
-        with_template "reverse_proxy.conf.erb"
+        with_template "reverse-proxy.conf.erb"
         within "config/nginx"
       end
     end

data/lib/wellcar/version.rb

@@ -1,3 +1,3 @@
 module Wellcar
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/wellcar/templates/env_development_database_spec.rb

@@ -1,17 +1,23 @@
 require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
-require "yaml"
 require "wellcar/templates/env_development_database"
 
 RSpec.describe Wellcar::Templates::EnvDevelopmentDatabase do
   describe "#render" do
     subject { template.render }
+    
+    let(:password) { class_double "SecureRandom" }
+
+    before do
+      stub_const "SecureRandom", password
+      expect(password).to receive(:base64).with(20).and_return "a-password"
+    end
 
     context "with a first set of inputs" do
       let(:template) { described_class.new("test_app") }
 
       it { is_expected.to include("POSTGRES_DB=test_app_development") }
       it { is_expected.to include("POSTGRES_USER=postgres") }
-      it { is_expected.to include("POSTGRES_PASSWORD=a-development-password") }
+      it { is_expected.to include("POSTGRES_PASSWORD=a-password") }
     end
 
     context "with another set of inputs" do
@@ -19,7 +25,7 @@ RSpec.describe Wellcar::Templates::EnvDevelopmentDatabase do
 
       it { is_expected.to include("POSTGRES_DB=old_app_development") }
       it { is_expected.to include("POSTGRES_USER=postgres") }
-      it { is_expected.to include("POSTGRES_PASSWORD=a-development-password") }
+      it { is_expected.to include("POSTGRES_PASSWORD=a-password") }
     end
   end
 end

data/spec/wellcar/templates/env_production_database_spec.rb

@@ -1,17 +1,23 @@
 require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
-require "yaml"
 require "wellcar/templates/env_production_database"
 
 RSpec.describe Wellcar::Templates::EnvProductionDatabase do
   describe "#render" do
     subject { template.render }
 
+    let(:password) { class_double "SecureRandom" }
+
+    before do
+      stub_const "SecureRandom", password
+      expect(password).to receive(:base64).with(20).and_return "prod-password"
+    end
+
     context "with a first set of inputs" do
       let(:template) { described_class.new("test_app") }
 
       it { is_expected.to include("POSTGRES_DB=test_app_production") }
       it { is_expected.to include("POSTGRES_USER=postgres") }
-      it { is_expected.to include("POSTGRES_PASSWORD=replace-me") }
+      it { is_expected.to include("POSTGRES_PASSWORD=prod-password") }
     end
 
     context "with another set of inputs" do
@@ -19,7 +25,7 @@ RSpec.describe Wellcar::Templates::EnvProductionDatabase do
 
       it { is_expected.to include("POSTGRES_DB=old_app_production") }
       it { is_expected.to include("POSTGRES_USER=postgres") }
-      it { is_expected.to include("POSTGRES_PASSWORD=replace-me") }
+      it { is_expected.to include("POSTGRES_PASSWORD=prod-password") }
     end
   end
 end

data/spec/wellcar/templates/reverse_proxy_conf_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
-require "yaml"
 require "wellcar/templates/reverse_proxy_conf"
 
 RSpec.describe Wellcar::Templates::ReverseProxyConf do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wellcar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - NJ Pearman
@@ -111,7 +111,7 @@ files:
 - lib/wellcar/templates/env_production_database.rb
 - lib/wellcar/templates/env_production_web.erb
 - lib/wellcar/templates/env_production_web.rb
-- lib/wellcar/templates/reverse_proxy.conf.erb
+- lib/wellcar/templates/reverse-proxy.conf.erb
 - lib/wellcar/templates/reverse_proxy_conf.rb
 - lib/wellcar/version.rb
 - spec/.keep