wellcar 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9629130bcd16fffcc9864daedb27e5f5795c660a33f92816a33851dac2bb98c
-  data.tar.gz: d59cc9b695eeaff5af97a498c589b053ab454f6f99583e1a54e913bf19172d7c
+  metadata.gz: 90b0b4af7693396802151c5b3e91c743886fe85dc36c3b117531b6b579e8253b
+  data.tar.gz: 94a331a46e2629cc0dc8dc19b5242e0d5a7f50147224921f8514c02fde3d0f22
 SHA512:
-  metadata.gz: e6da3f0f58f3c7ee6788ed5fd30bd767a8ac3c778a59e797bf174f5762db7eef75f742bdb9cd149e8327f66999f2291fefbfc8ddee139a94bc8849d218d2ce04
-  data.tar.gz: f14698f09a94e51c8072f9812b7eef731fb19be0752d03895679b185e6e54a17715acbb1280651fff8273742deb02299495ba80b387999803e4cbf6e4345dde4
+  metadata.gz: 781ac4148cbaef8b289dfc3ffad80ce738919c3436597fb3e56e54d0d4e7ee04fa26365fee367a0fbf67bbafc8cd01f8ed795a9d7bb9b15575409e648187d7ca
+  data.tar.gz: c43cf9ff268e5019b9afa86079fd19e52fa2ee8ba0786d2b904f52f9a5b03699ed06b99da6355fc9fe9168ccf72e2c70c3139e57654e0f76d74731c811019241

data/bin/wellcar

@@ -10,278 +10,7 @@ rescue LoadError => e
   exit 64
 end
 
-class CommandBase
-  attr_accessor :ruby_version,
-    :app_name,
-    :use_bundler_2,
-    :github_account,
-    :domain_name
 
-  def core_docker_templates
-     master_key = File.exist?("config/credentials/production.key") ?
-       File.read("config/credentials/production.key") :
-       nil
-
-    [
-      Wellcar::Templates::Dockerfile.new(ruby_version, app_name, use_bundler_2),
-      Wellcar::Templates::DockerStack.new(app_name, github_account),
-      Wellcar::Templates::EnvDevelopmentDatabase.new(app_name),
-      Wellcar::Templates::EnvDevelopmentWeb.new,
-      Wellcar::Templates::EnvProductionWeb.new(master_key),
-      Wellcar::Templates::EnvProductionDatabase.new(app_name),
-      Wellcar::Templates::Dockerignore.new,
-      Wellcar::Templates::DockerEntrypoint.new,
-      Wellcar::Templates::BuildProductionImage.new(app_name, github_account),
-      Wellcar::Templates::ReverseProxyConf.new(domain_name)
-    ]
-  end
-
-  def create_directories
-    FileUtils.mkdir_p "config"
-    FileUtils.mkdir_p "bin"
-    FileUtils.mkdir_p ".env/development"
-    FileUtils.mkdir_p ".env/production"
-  end
-
-  def write_files
-    files_before_docker = Dir['*']
-    
-    system "curl -o bin/wait-for https://raw.githubusercontent.com/mrako/wait-for/master/wait-for"
-
-    docker_files.each(&:write)
-    puts "Wellcar created:\n#{Dir['*'] - files_before_docker}\n"
-  end
-
-  def create_wellcar_folder
-    return if Dir.exist? ".wellcar"
-
-    Dir.mkdir ".wellcar"
-    FileUtils.touch ".wellcar/.keep"
-  end
-
-  def clean_docker
-    # Make sure that no pre-existing containers are running. Although 
-    # very unlikely, it's worth being thorough. This makes the command
-    # slow but for the time being this ensures the containers and images
-    # are as expected.
-    exit 8 unless system "docker-compose down --remove-orphans"
-
-    removable_volumes = ["#{app_name}_gem_cache", "#{app_name}_node_modules"]
-    volumes_to_remove = %x(docker volume ls --format='{{.Name}}')
-      .split("\n") & removable_volumes
-
-    return if volumes_to_remove.empty?
-
-    puts "Removing the following volumes: #{volumes_to_remove.join(", ")}"
-
-    system "docker volume rm #{volumes_to_remove.join(" ")}"
-  end
-  
-  def build_development_environment
-    exit 128 unless system "docker-compose build web webpack-dev-server database"
-  end
-end
-
-class NewCommand < CommandBase
-  def initialize(app_name, github_account, domain_name)
-    self.app_name = app_name
-    self.domain_name = domain_name
-    self.github_account = github_account
-    self.ruby_version = "2.6.6"
-    self.use_bundler_2 = true
-  end
-
-  def docker_files
-    @files ||= core_docker_templates.push(
-      Wellcar::Templates::DockerfileInit.new(ruby_version, app_name),
-      Wellcar::Templates::DockerCompose.new(app_name, 
-                                            github_account,
-                                            Wellcar::Templates::DockerCompose::INIT_TEMPLATE)
-    )
-  end
-
-  def try_full_nuke(nuke)
-    if nuke && Dir.exists?(app_name)
-      puts "*** Destroying the existing folder #{app_name} ***"
-      FileUtils.rm_rf app_name
-    elsif Dir.exists? app_name
-      puts "Cannot overwrite existing folder #{Dir.pwd}/#{app_name}"
-      exit 1
-    end
-  end
-
-  def within_app_folder(&block)
-    raise NotImplemented if block.nil?
-
-    Dir.mkdir app_name
-
-    Dir.chdir(app_name) do
-      yield
-    end
-  end
-
-  def perform_setup
-    # Create app and install webpacker
-    exit 16 unless system "docker-compose up --build new_rails"
-    exit 32 unless system "docker-compose up --build bundle"
-    exit 64 unless system "docker-compose up --build install_webpacker"
-    puts "Rails app created; initializing for Docker\n"
-  end
-
-  def tidy_up_setup
-    # 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, github_account).write
-    Wellcar::Templates::DatabaseYaml.new(app_name).write
-  end
-
-  def call(options, args)
-    # Here we want to create a new rails app that is set up with docker.
-    # We use `rails new` within a `docker run` command but skip a lot of set up so 
-    # that further setup steps can be taken later on.
-    # What I don't know right now is how steps that are skipped at the start can be
-    # initiated in an existing app.
-    #
-    # My list of pre-requisites for a Rails app are:
-    #   * RSpec
-    #   * Webpack + yarn
-    #   * Rubocop
-    #   * PostgreSQL
-    #   * Redis
-    #   * FactoryBot
-    #   * Capybara with a real webdriver
-    #   * Devise
-
-    try_full_nuke options[:full_nuke]
-
-    within_app_folder do
-      create_wellcar_folder
-      create_directories
-      write_files
-      clean_docker
-      perform_setup
-      tidy_up_setup
-      build_development_environment
-    end
-    
-    puts <<-FINISHED
-Your new Rails application "#{app_name}" has been created with Docker!
-
-Don't forget to commit everything to git.
-
-You can use wellcar to interact with the Docker containers and the Rails application as you develop your app.
-
-Run `wellcar` for help with commands.
-FINISHED
-  end
-end
-
-class DockCommand < CommandBase
-  def initialize(github_account, domain_name)
-    self.github_account = github_account
-    self.domain_name = domain_name
-  end
-
-  def interpret_app_name
-    app_name = File.read("./config/application.rb")
-      .split("\n")
-      .select {|line| line =~ /^module / }
-      .first
-      &.split
-      &.last
-      &.downcase
-
-    return app_name unless app_name.nil?
-
-    puts "Cannot determine app name from config/application.rb. wellcar expects to find one module in this file named for the application."
-    exit 5
-  end
-
-  def interpret_ruby_version
-    File.file?(".ruby_version") ?
-      File.read(".ruby_version").split.first :
-      "2.6.6"
-  end
-
-  def interpret_bundler_2
-    b2 = File.file?("Gemfile.lock") &&
-      File.read("Gemfile.lock").split("BUNDLED WITH")&.last.strip >= "2.0.0"
-    puts "Install bundler 2? #{b2}"
-    b2
-  end
-
-  def determine_variables
-    self.app_name = interpret_app_name
-    self.ruby_version = interpret_ruby_version
-    self.use_bundler_2 = interpret_bundler_2
-  end
-
-  def prepare_templates
-    docker_files
-  end
-
-  def docker_files
-    @files ||= core_docker_templates.push(Wellcar::Templates::DockerCompose.new(app_name, github_account))
-  end
-
-  def check_existing_files(force_new)
-    files_exist = docker_files.select {|file| file.exist? }.any?
-    if force_new && files_exist
-      puts "--force-new set. Overwriting **all** existing docker files."
-
-      if Dir.exist? ".env"
-        label = Time.new.strftime("%Y%m%d%H%M%S")
-        puts ".env will be backed up to .wellcar/env-#{label}"
-        destination = ".wellcar/env-#{label}"
-        FileUtils.copy_entry ".env", destination
-        exit unless Dir.exist? destination
-      end
-    elsif files_exist
-      puts "Found existing docker files. Please check your app source tree before trying to dockerise this app with wellcar again."
-      exit 3
-    end
-  end
-
-  def update_database_config
-    Wellcar::Templates::DatabaseYaml.new(app_name).update
-    puts <<-DB
- ... updated development settings for database.yml.
-Now using dockerised PostgreSQL server. Previous config saved as config/database.pre_docker.yml
-DB
-  end
-
-  # This does not currently work, as it is called before bundle is available. I'm debating how
-  # to include this "gem tidying" aspect of adding Docker to an existing project.
-  def tidy_gemfile
-    %w(sqlite3 figaro dotenv).each {|gem| system "docker-compose run --rm bin/bundle remove #{gem}" }
-    system "docker-compose run --rm bin/bundle add pg" unless system("docker-compose run --rm bin/bundle info pg")
-  end
-
-  def call(options, args)
-    create_wellcar_folder
-    determine_variables
-    prepare_templates
-    check_existing_files options[:"force-new"]
-    create_directories
-    write_files
-    update_database_config
-    clean_docker
-    # This assumes bin/bundle is available, which will not be the case.
-    # The gem set up done in this call should be part of a Dockerfile, but needs
-    # a script to manage some conditional logic.
-    # tidy_gemfile
-    build_development_environment
-
-    puts <<-DONE
-Your Rails app has been dockerised!
-
-You can use wellcar to interact with the Docker containers and the Rails application as you develop your app.
-
-Run `wellcar` for help with commands.
-DONE
-  end
-end
 
 class App
   extend GLI::App
@@ -307,7 +36,7 @@ class App
       required: true,
       desc: "Sets the GitHub account used in building Docker image paths (which assumes images are hosted as GitHub Packages)"
     c.action do |global_options, options, args|
-      NewCommand.new(args[0], options['github-account'], options[:domain]).call options, args
+      WellCar::Commmands::New.new(args[0], options['github-account'], options[:domain]).call options, args
     end
   end
 
@@ -325,7 +54,7 @@ class App
       required: true
 
     c.action do |global_options, options, args|
-      DockCommand.new(options['github-account'], options[:domain]).call options, args
+      WellCar::Commmands::Dock.new(options['github-account'], options[:domain]).call options, args
     end
   end
 

data/lib/wellcar.rb

@@ -1,4 +1,7 @@
 require 'wellcar/version.rb'
+require 'wellcar/commands/base.rb'
+require 'wellcar/commands/new.rb'
+require 'wellcar/commands/dock.rb'
 require 'wellcar/templates/base.rb'
 require 'wellcar/templates/dockerfile.rb'
 require 'wellcar/templates/dockerfile_init.rb'

data/lib/wellcar/commands/base.rb

@@ -0,0 +1,75 @@
+module Wellcar
+  module Commands
+    class Base
+      attr_accessor :ruby_version,
+        :app_name,
+        :use_bundler_2,
+        :github_account,
+        :domain_name
+
+      def core_docker_templates
+         master_key = File.exist?("config/credentials/production.key") ?
+           File.read("config/credentials/production.key") :
+           nil
+
+        [
+          Wellcar::Templates::Dockerfile.new(ruby_version, app_name, use_bundler_2),
+          Wellcar::Templates::DockerStack.new(app_name, github_account),
+          Wellcar::Templates::EnvDevelopmentDatabase.new(app_name),
+          Wellcar::Templates::EnvDevelopmentWeb.new,
+          Wellcar::Templates::EnvProductionWeb.new(master_key),
+          Wellcar::Templates::EnvProductionDatabase.new(app_name),
+          Wellcar::Templates::Dockerignore.new,
+          Wellcar::Templates::DockerEntrypoint.new,
+          Wellcar::Templates::BuildProductionImage.new(app_name, github_account),
+          Wellcar::Templates::ReverseProxyConf.new(domain_name)
+        ]
+      end
+
+      def create_directories
+        FileUtils.mkdir_p "config"
+        FileUtils.mkdir_p "bin"
+        FileUtils.mkdir_p ".env/development"
+        FileUtils.mkdir_p ".env/production"
+      end
+
+      def write_files
+        files_before_docker = Dir['*']
+        
+        system "curl -o bin/wait-for https://raw.githubusercontent.com/mrako/wait-for/master/wait-for"
+
+        docker_files.each(&:write)
+        puts "Wellcar created:\n#{Dir['*'] - files_before_docker}\n"
+      end
+
+      def create_wellcar_folder
+        return if Dir.exist? ".wellcar"
+
+        Dir.mkdir ".wellcar"
+        FileUtils.touch ".wellcar/.keep"
+      end
+
+      def clean_docker
+        # Make sure that no pre-existing containers are running. Although 
+        # very unlikely, it's worth being thorough. This makes the command
+        # slow but for the time being this ensures the containers and images
+        # are as expected.
+        exit 8 unless system "docker-compose down --remove-orphans"
+
+        removable_volumes = ["#{app_name}_gem_cache", "#{app_name}_node_modules"]
+        volumes_to_remove = %x(docker volume ls --format='{{.Name}}')
+          .split("\n") & removable_volumes
+
+        return if volumes_to_remove.empty?
+
+        puts "Removing the following volumes: #{volumes_to_remove.join(", ")}"
+
+        system "docker volume rm #{volumes_to_remove.join(" ")}"
+      end
+      
+      def build_development_environment
+        exit 128 unless system "docker-compose build web webpack-dev-server database"
+      end
+    end
+  end
+end

data/lib/wellcar/commands/dock.rb

@@ -0,0 +1,109 @@
+module Wellcar
+  module Commands
+    class Dock < Base
+      def initialize(github_account, domain_name)
+        self.github_account = github_account
+        self.domain_name = domain_name
+      end
+
+      def interpret_app_name
+        app_name = File.read("./config/application.rb")
+          .split("\n")
+          .select {|line| line =~ /^module / }
+          .first
+          &.split
+          &.last
+          &.downcase
+
+        return app_name unless app_name.nil?
+
+        puts "Cannot determine app name from config/application.rb. wellcar expects to find one module in this file named for the application."
+        exit 5
+      end
+
+      def interpret_ruby_version
+        File.file?(".ruby_version") ?
+          File.read(".ruby_version").split.first :
+          "2.6.6"
+      end
+
+      def interpret_bundler_2
+        b2 = File.file?("Gemfile.lock") &&
+          File.read("Gemfile.lock").split("BUNDLED WITH")&.last.strip >= "2.0.0"
+        puts "Install bundler 2? #{b2}"
+        b2
+      end
+
+      def determine_variables
+        self.app_name = interpret_app_name
+        self.ruby_version = interpret_ruby_version
+        self.use_bundler_2 = interpret_bundler_2
+      end
+
+      def prepare_templates
+        docker_files
+      end
+
+      def docker_files
+        @files ||= core_docker_templates.push(Wellcar::Templates::DockerCompose.new(app_name, github_account))
+      end
+
+      def check_existing_files(force_new)
+        files_exist = docker_files.select {|file| file.exist? }.any?
+        if force_new && files_exist
+          puts "--force-new set. Overwriting **all** existing docker files."
+
+          if Dir.exist? ".env"
+            label = Time.new.strftime("%Y%m%d%H%M%S")
+            puts ".env will be backed up to .wellcar/env-#{label}"
+            destination = ".wellcar/env-#{label}"
+            FileUtils.copy_entry ".env", destination
+            exit unless Dir.exist? destination
+          end
+        elsif files_exist
+          puts "Found existing docker files. Please check your app source tree before trying to dockerise this app with wellcar again."
+          exit 3
+        end
+      end
+
+      def update_database_config
+        Wellcar::Templates::DatabaseYaml.new(app_name).update
+        puts <<-DB
+     ... updated development settings for database.yml.
+    Now using dockerised PostgreSQL server. Previous config saved as config/database.pre_docker.yml
+    DB
+      end
+
+      # This does not currently work, as it is called before bundle is available. I'm debating how
+      # to include this "gem tidying" aspect of adding Docker to an existing project.
+      def tidy_gemfile
+        %w(sqlite3 figaro dotenv).each {|gem| system "docker-compose run --rm bin/bundle remove #{gem}" }
+        system "docker-compose run --rm bin/bundle add pg" unless system("docker-compose run --rm bin/bundle info pg")
+      end
+
+      def call(options, args)
+        create_wellcar_folder
+        determine_variables
+        prepare_templates
+        check_existing_files options[:"force-new"]
+        create_directories
+        write_files
+        update_database_config
+        clean_docker
+        # This assumes bin/bundle is available, which will not be the case.
+        # The gem set up done in this call should be part of a Dockerfile, but needs
+        # a script to manage some conditional logic.
+        # tidy_gemfile
+        build_development_environment
+
+        puts <<-DONE
+    Your Rails app has been dockerised!
+
+    You can use wellcar to interact with the Docker containers and the Rails application as you develop your app.
+
+    Run `wellcar` for help with commands.
+    DONE
+      end
+    end
+  end
+end

data/lib/wellcar/commands/new.rb

@@ -0,0 +1,98 @@
+module Wellcar
+  module Commands
+    class New < Base
+      def initialize(app_name, github_account, domain_name)
+        self.app_name = app_name
+        self.domain_name = domain_name
+        self.github_account = github_account
+        self.ruby_version = "2.6.6"
+        self.use_bundler_2 = true
+      end
+
+      def docker_files
+        @files ||= core_docker_templates.push(
+          Wellcar::Templates::DockerfileInit.new(ruby_version, app_name),
+          Wellcar::Templates::DockerCompose.new(app_name, 
+                                                github_account,
+                                                Wellcar::Templates::DockerCompose::INIT_TEMPLATE)
+        )
+      end
+
+      def try_full_nuke(nuke)
+        if nuke && Dir.exists?(app_name)
+          puts "*** Destroying the existing folder #{app_name} ***"
+          FileUtils.rm_rf app_name
+        elsif Dir.exists? app_name
+          puts "Cannot overwrite existing folder #{Dir.pwd}/#{app_name}"
+          exit 1
+        end
+      end
+
+      def within_app_folder(&block)
+        raise NotImplemented if block.nil?
+
+        Dir.mkdir app_name
+
+        Dir.chdir(app_name) do
+          yield
+        end
+      end
+
+      def perform_setup
+        # Create app and install webpacker
+        exit 16 unless system "docker-compose up --build new_rails"
+        exit 32 unless system "docker-compose up --build bundle"
+        exit 64 unless system "docker-compose up --build install_webpacker"
+        puts "Rails app created; initializing for Docker\n"
+      end
+
+      def tidy_up_setup
+        # 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, github_account).write
+        Wellcar::Templates::DatabaseYaml.new(app_name).write
+      end
+
+      def call(options, args)
+        # Here we want to create a new rails app that is set up with docker.
+        # We use `rails new` within a `docker run` command but skip a lot of set up so 
+        # that further setup steps can be taken later on.
+        # What I don't know right now is how steps that are skipped at the start can be
+        # initiated in an existing app.
+        #
+        # My list of pre-requisites for a Rails app are:
+        #   * RSpec
+        #   * Webpack + yarn
+        #   * Rubocop
+        #   * PostgreSQL
+        #   * Redis
+        #   * FactoryBot
+        #   * Capybara with a real webdriver
+        #   * Devise
+
+        try_full_nuke options[:full_nuke]
+
+        within_app_folder do
+          create_wellcar_folder
+          create_directories
+          write_files
+          clean_docker
+          perform_setup
+          tidy_up_setup
+          build_development_environment
+        end
+        
+        puts <<-FINISHED
+    Your new Rails application "#{app_name}" has been created with Docker!
+
+    Don't forget to commit everything to git.
+
+    You can use wellcar to interact with the Docker containers and the Rails application as you develop your app.
+
+    Run `wellcar` for help with commands.
+    FINISHED
+      end
+    end
+  end
+end

data/lib/wellcar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wellcar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - NJ Pearman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,6 +85,9 @@ files:
 - bin/wellcar
 - command_history_example.txt
 - lib/wellcar.rb
+- lib/wellcar/commands/base.rb
+- lib/wellcar/commands/dock.rb
+- lib/wellcar/commands/new.rb
 - lib/wellcar/templates/base.rb
 - lib/wellcar/templates/build-production-image.yml.erb
 - lib/wellcar/templates/build_production_image.rb