dockrails 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af14517691bd7a4bb6d4cb322caa32b4ed44dc9
-  data.tar.gz: 72a9899888365436771a9955e553dd75d891d3d1
+  metadata.gz: adbe324970fc15fb50b9b9ad644592992c9f1241
+  data.tar.gz: 0776a2436119808d5471b06910d3535c16889847
 SHA512:
-  metadata.gz: f44e3310ba8fe63da42015b91262b29f6ce36aa89e1e66b9b9110af6199949ae5a76097e2e068dc73f20c5e5e176bef51459cfd3b0566d6a1c2ebfe2229bbb5f
-  data.tar.gz: 1f0d80977feb513ca7fd5c4d54915fc46ea0f27b238f2c490bc6bd1323ffd6ad207125409aabe2aeb082b7fdf10f16521b340f0fdfa4c3e61b9815d60f1341a4
+  metadata.gz: da05bbe63ab3882df34d3b5663268e4c72a907c16c2ecd82bffa4c06167ccb50410bcb420dc7b4a1410291cfae11b178243e671c00fd26bdef999060a04121ff
+  data.tar.gz: 75d4f9effa54dd0010f5743dad3ccb700198d9227f6b216d338f44c4373932a84be887e84e359567811d4a4962aaa9e4e1d2928312c784d0e2fe37c6d54c2f7e

data/bin/dockrails

@@ -18,7 +18,7 @@ command :init do |c|
     existing_files = ["Dockerfile", "docker-compose.yml", "docker-sync.yml"].map { |file| File.exist?(file) }
     if existing_files.include?(true)
       say "We detected an existing Docker install in this folder"
-      answer = agree "Do you want to continue and override it?"
+      answer = agree "Do you want to continue and override it? (yes|no)"
       exit if !answer
     end
 
@@ -30,6 +30,15 @@ command :init do |c|
     end
 
     generate = Dockrails::Generate.new(app_path: rails_app)
+
+    (generate.check_system_requirements).each do |k,v|
+      if v == false
+        say "please install \"#{k}\" in order to continue\n"
+        exit
+      end
+    end
+
+    generate.configure
     generate.create_folders
     generate.create_dockerfile
     generate.create_start_script

data/lib/dockrails/generate.rb

@@ -1,62 +1,60 @@
 module Dockrails
   class Generate
 
-    def initialize(app_path:)
-      check_system_requirements
+    def initialize(app_path:, config: {})
       @app_path = app_path
-      @config = ask_configuration
+      @config = config
     end
 
     def check_system_requirements
       requirement = Hash.new
-      requirement["unison"] = system("which unison > /dev/null")
-      requirement["docker"] = system("which docker > /dev/null")
-      requirement["docker-sync"] = system("which docker-sync > /dev/null")
-      requirement["docker-compose"] = system("which docker-compose > /dev/null")
-
-      requirement.each do |k,v|
-        if v == false
-          say "please install \"#{k}\" in order to continue\n"
-        end
+
+      ["unison", "docker", "docker-sync", "docker-compose"].each do |binary|
+        requirement[binary] = binary_present?(binary: binary)
       end
+
+      return requirement
+    end
+
+    def binary_present?(binary:)
+      system("which #{binary} > /dev/null")
     end
 
-    def ask_configuration
-      config = Hash.new
-      config["ruby-version"] = choose("\nChoose a ruby version?", "latest", "2.4", "2.3", "2.2")
-      config["db"] = choose("\nChoose a DB Engine?", :pgsql, :mysql)
-      config["db_name"] = ask "\nChoose a database name"
-      config["db_user"] = ask "\nChoose a database username"
-      config["db_password"] = ask "\nChoose a database password"
-      config["redis"] = agree("\nDo you need a Redis DB?")
-      config["sidekiq"] = agree("\nDo you need a SideKiq Container") if config["redis"]
+    def configure
+      @config[:"ruby-version"] = choose("\nChoose a ruby version?", "latest", "2.4", "2.3", "2.2")
+      @config[:db] = choose("\nChoose a DB Engine", :pgsql, :mysql)
+      @config[:db_name] = ask "\nChoose a database name"
+      @config[:db_user] = ask "\nChoose a database username"
+      @config[:db_password] = ask "\nChoose a database password"
+      @config[:redis] = agree("\nDo you need a Redis DB? (yes|no)")
+      @config[:sidekiq] = agree("\nDo you need a SideKiq Container? (yes|no)") if @config[:redis]
 
       user_agree = agree "\nSummary:
-    - Ruby version: #{config["ruby-version"]}
-    - DB Engine: #{config["db"]}
-    - DB Name: #{config["db_name"]}
-    - DB Username: #{config["db_user"]}
-    - DB Password: #{config["db_password"]}
-    - Redis? #{config["redis"]}
-    - Job Container? #{config["sidekiq"] ||= "false"}\n
-  Is this correct?"
+    - Ruby version: #{@config[:"ruby-version"]}
+    - DB Engine: #{@config[:db]}
+    - DB Name: #{@config[:db_name]}
+    - DB Username: #{@config[:db_user]}
+    - DB Password: #{@config[:db_password]}
+    - Redis? #{@config[:redis]}
+    - Job Container? #{@config[:sidekiq] ||= false}\n
+  Is this correct? (yes|no)"
 
       unless user_agree
-        ask_configuration
+        configure
       end
 
-      return(config)
+      return(@config)
     end
 
     def create_folders
-      system("rm -rf data")
-      system("mkdir -p data/sql")
-      system("mkdir -p data/redis") if @config["redis"]
+      FileUtils.rm_rf('data')
+      FileUtils.mkdir_p('data/sql')
+      FileUtils.mkdir_p('data/redis') if @config[:redis]
     end
 
     def create_dockerfile
       File.open("Dockerfile", 'w') do |f|
-        f.write("FROM ruby:#{@config["ruby-version"]}
+        f.write("FROM ruby:#{@config[:"ruby-version"]}
   RUN apt-get update && apt-get install -y \
   build-essential \
   wget \
@@ -88,7 +86,7 @@ module Dockrails
     end
 
     def create_start_script
-      system("mkdir -p #{@app_path}/scripts")
+      FileUtils.mkdir_p("#{@app_path}/scripts")
       File.open("#{@app_path}/scripts/start-dev.sh", "w") do |f|
         f.write("#!/bin/bash
   bundle check || bundle install
@@ -102,17 +100,17 @@ module Dockrails
         f.write "services:\n"
         f.write " db:\n"
 
-        case @config["db"] when :mysql
+        case @config[:db] when :mysql
           f.write "   image: mysql\n"
           f.write "   volumes:\n"
           f.write "     - ./data/sql:/var/lib/mysql\n"
           f.write "   ports:\n"
           f.write "     - \"3306:3306\"\n"
           f.write "   environment:\n"
-          f.write "     MYSQL_DATABASE: #{@config["db_name"]}\n"
-          f.write "     MYSQL_USER: #{@config["db_user"]}\n"
-          f.write "     MYSQL_PASSWORD: #{@config["db_password"]}\n"
-          f.write "     MYSQL_ROOT_PASSWORD: #{@config["db_password"]}\n"
+          f.write "     MYSQL_DATABASE: #{@config[:db_name]}\n"
+          f.write "     MYSQL_USER: #{@config[:db_user]}\n"
+          f.write "     MYSQL_PASSWORD: #{@config[:db_password]}\n"
+          f.write "     MYSQL_ROOT_PASSWORD: #{@config[:db_password]}\n"
         when :pgsql
           f.write "   image: postgres\n"
           f.write "   volumes:\n"
@@ -120,12 +118,12 @@ module Dockrails
           f.write "   ports:\n"
           f.write "     - \"5432:5432\"\n"
           f.write "   environment:\n"
-          f.write "     POSTGRES_DB: #{@config["db_name"]}\n"
-          f.write "     POSTGRES_USER: #{@config["db_user"]}\n"
-          f.write "     POSTGRES_PASSWORD: #{@config["db_password"]}\n"
+          f.write "     POSTGRES_DB: #{@config[:db_name]}\n"
+          f.write "     POSTGRES_USER: #{@config[:db_user]}\n"
+          f.write "     POSTGRES_PASSWORD: #{@config[:db_password]}\n"
         end
 
-        if @config["redis"]
+        if @config[:redis]
           f.write "\n redis:\n"
           f.write "   image: redis\n"
           f.write "   volumes:\n"
@@ -144,16 +142,16 @@ module Dockrails
         f.write "   ports:\n"
         f.write "     - \"3000:3000\"\n"
         f.write "   environment:\n"
-        f.write "     REDIS_URL: redis://redis:6379\n" if @config["redis"]
-        f.write "     DB_USER: #{@config["db_user"]}\n"
-        f.write "     DB_PASSWORD: #{@config["db_password"]}\n"
+        f.write "     REDIS_URL: redis://redis:6379\n" if @config[:redis]
+        f.write "     DB_USER: #{@config[:db_user]}\n"
+        f.write "     DB_PASSWORD: #{@config[:db_password]}\n"
         f.write "   links:\n"
         f.write "     - db\n"
-        f.write "     - redis\n" if @config["redis"]
+        f.write "     - redis\n" if @config[:redis]
         f.write "   tty: true\n"
         f.write "   stdin_open: true\n"
 
-        if @config["redis"] && @config["sidekiq"]
+        if @config[:redis] && @config[:sidekiq]
           f.write "\n job:\n"
           f.write "   build: .\n"
           f.write "   command: bundle exec sidekiq -C config/sidekiq.yml\n"

data/lib/dockrails/version.rb

@@ -1,3 +1,3 @@
 module Dockrails
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/generate_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'dockrails/generate'
+
+
+class Dummy
+  def command_line
+    system("ls")
+  end
+end
+
+describe Dockrails::Generate do
+
+  before(:all) do
+    #$stderr = StringIO.new
+    #mock_terminal
+
+    @app_path = "rails_app"
+    @generate = Dockrails::Generate.new(app_path: @app_path)
+  end
+
+  describe ".check_system_requirements" do
+    it "should test for Unison, docker, docker-compose and docker-sync binaries" do
+      values = @generate.check_system_requirements.map{|k,v| k}
+      expect(values).to eql ["unison", "docker", "docker-sync", "docker-compose"]
+    end
+
+    context "when all requirements are met" do
+      it {
+        allow(@generate).to receive(:binary_present?).with(binary: "unison") { true }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker") { true }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker-sync") { true }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker-compose") { true }
+
+        expect(@generate.check_system_requirements).to be_kind_of Hash
+      }
+    end
+
+    context "when NOT all requirements are met" do
+      it {
+        allow(@generate).to receive(:binary_present?).with(binary: "unison") { false }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker") { true }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker-sync") { true }
+        allow(@generate).to receive(:binary_present?).with(binary: "docker-compose") { true }
+
+        expect(@generate.check_system_requirements).to be_kind_of Hash
+      }
+    end
+  end
+
+  describe ".configure" do
+  end
+
+  context "once it's configured" do
+
+    before(:all) do
+      @app_path = "rails_app"
+
+      @config_with_redis = {
+        "ruby-version": "latest",
+        db: :pgsql,
+        db_name: "rails",
+        db_user: "rails",
+        db_password: "rails",
+        redis: true,
+        sidekiq: true
+      }
+
+      @config_without_redis = {
+        "ruby-version": "latest",
+        db: :pgsql,
+        db_name: "rails",
+        db_user: "rails",
+        db_password: "rails",
+        redis: false,
+        sidekiq: false
+      }
+
+      @config_with_mysql = {
+        "ruby-version": "latest",
+        db: :mysql,
+        db_name: "rails",
+        db_user: "rails",
+        db_password: "rails",
+        redis: false,
+        sidekiq: false
+      }
+
+      @generate_with_redis = Dockrails::Generate.new(app_path: @app_path, config: @config_with_redis)
+      @generate_without_redis = Dockrails::Generate.new(app_path: @app_path, config: @config_without_redis)
+      @generate_with_mysql = Dockrails::Generate.new(app_path: @app_path, config: @config_with_mysql)
+    end
+
+    describe ".create_folders" do
+      context "When Redis is not set" do
+        it "should create the data and data/sql folders" do
+          allow(FileUtils).to receive(:mkdir_p).with("data")
+          allow(FileUtils).to receive(:mkdir_p).with("data/sql")
+          @generate_without_redis.create_folders
+        end
+      end
+
+      context "When Redis is set" do
+        it "should create the data, data/sql and data/redis folders" do
+          allow(FileUtils).to receive(:mkdir_p).with("data")
+          allow(FileUtils).to receive(:mkdir_p).with("data/sql")
+          allow(FileUtils).to receive(:mkdir_p).with("data/redis")
+          @generate_with_redis.create_folders
+        end
+      end
+    end
+
+    describe ".create_dockerfile" do
+      it "Should create a Dockerfile" do
+        allow(File).to receive(:open).with("Dockerfile", 'w').once
+        @generate_with_redis.create_dockerfile
+      end
+    end
+
+    describe ".create_docker_compose" do
+      it "Should create a docker-compose.yml file" do
+        allow(File).to receive(:open).with("docker-compose.yml", 'w').once
+        @generate_with_redis.create_docker_compose
+      end
+
+      context "When PGSQL is set" do
+        it "Should contain the Pgsql config" do
+          @generate_with_redis.create_docker_compose
+          expect(File.read("docker-compose.yml")).to match /postgres/i
+        end
+      end
+
+      context "When MySQL is set" do
+        it "Should contain the Mysql config" do
+          @generate_with_mysql.create_docker_compose
+          expect(File.read("docker-compose.yml")).to match /mysql/i
+        end
+      end
+
+      context "When Redis is not set" do
+        it "Should not contain a Redis node" do
+          @generate_without_redis.create_docker_compose
+          expect(File.read("docker-compose.yml")).not_to match /redis/i
+        end
+
+        it "Should not contain a Sidekiq node" do
+          @generate_without_redis.create_docker_compose
+          expect(File.read("docker-compose.yml")).not_to match /sidekiq/i
+        end
+      end
+
+      context "When Redis & Sidekiq are set" do
+        it "Should contain a Redis node" do
+          @generate_with_redis.create_docker_compose
+          expect(File.read("docker-compose.yml")).to match /redis/i
+        end
+
+        it "Should contain a Sidekiq node" do
+          @generate_with_redis.create_docker_compose
+          expect(File.read("docker-compose.yml")).to match /sidekiq/i
+        end
+      end
+    end
+
+    describe ".create_docker_sync" do
+      it "Should create a docker-sync.yml file" do
+        allow(File).to receive(:open).with("docker-sync.yml", 'w').once
+        @generate_with_redis.create_docker_sync
+      end
+    end
+
+    describe ".create_start_script" do
+      it "Should create a scripts folder and start-dev.sh file" do
+        allow(File).to receive(:open).with("#{@app_path}/scripts/start-dev.sh", 'w').once
+        allow(FileUtils).to receive(:mkdir_p).with("#{@app_path}/scripts").once
+        @generate_with_redis.create_start_script
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'commander'
+require 'commander/methods'
+require 'pry'
+require 'fakefs/spec_helpers'
+
+# Mock terminal IO streams so we can spec against them
+def mock_terminal
+  @input = StringIO.new
+  @output = StringIO.new
+  $terminal = HighLine.new @input, @output
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockrails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Guillaume Montard
@@ -38,6 +38,76 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Docker + Rails + Mac + Dev = <3
 email: 
 executables:
@@ -50,6 +120,8 @@ files:
 - lib/dockrails.rb
 - lib/dockrails/generate.rb
 - lib/dockrails/version.rb
+- spec/generate_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/gmontard/dockrails/
 licenses:
 - MIT
@@ -74,4 +146,6 @@ rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple CLI to Generate and Run a Rails environment with Docker!
-test_files: []
+test_files:
+- spec/generate_spec.rb
+- spec/spec_helper.rb