roro 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae59fe35a7653d9c15191a99184ad9f850a50eb49ae6cde1da06ddf29b420a9
-  data.tar.gz: 00c864acbcf2155ad14ee0ab6d1b01bb0194352d80fa8191c950691863feb2df
+  metadata.gz: 04dbb241c4e833ddc92e4092594bafdc9be7d4e9a97f235ef2b3430af5c08081
+  data.tar.gz: 68dc2d2a07987ebeb819f7a4c15bc33ef43b2f1f544caf628706970a5f239bbc
 SHA512:
-  metadata.gz: 9c181460cfb92d19799ad53801f690fcc02335153985a849685a4e4472d935502b25e65387c3a9124b19453498b9f6d575ea128ac73dffe68b556b0c99391beb
-  data.tar.gz: a8051fd9f5d70b54dc490c5735396e7bca783554ce42cae6ecab90490d870c77b2b0aa41ce1ed46f00cf7c0c9195b7b5153b9a966ce1028c6f2c5fa53325e887
+  metadata.gz: 4debcc463150555b50360924374028fa74664955a33d47cf67f6362b3a9c1f84f2b2694551da8c342104e6e5d1386303f7018219b82549873b2a7d413747fea6
+  data.tar.gz: 0ec3c8fb00c1378007f6cad61e729b157b56b7be0d3bb4438f33e974365d6323f29bf1ded3dfb55293d24e23fab125f6bae02db786e77f3ea64766e865b95fea

data/.gitignore

@@ -5,7 +5,20 @@
 /doc/
 /pkg/
 /spec/reports/
-tmp/*
 Gemfile.lock
 .byebug_history
-/sandbox/**/*
+
+roro/**/*.env
+roro/**/*.key
+
+*.key
+*.env
+
+tmp/*
+tmp/*
+!tmp/.gitkeep 
+sandbox/*
+!sandbox/.keep 
+!sandbox/greenfield
+sandbox/greenfield/*
+!sandbox/greenfield/.keep

data/Guardfile

@@ -2,8 +2,8 @@
 # More info at https://github.com/guard/guard#readme
 
 options = {
-  cli: '',
-  all_after_run: true,
+  cli: '-f',
+  all_on_start: true,
   all_after_pass: true
 }
 
@@ -11,10 +11,7 @@ guard :minitest, options do
 
   watch(%r{^test/(.*)\/?test_(.*)\.rb$})
   watch(%r{^test/(.*)\/?(.*)_test\.rb$})
-  watch(%r{^lib/roro/cli/(.+)\.rb$}) { |m| "test/generators/#{m[1]}_test.rb" }
-
+  watch(%r{^lib/roro/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/thor_helper\.rb$})      { 'test' }
-
   watch(%r{^test/fixtures/files/(.*/)?([^/]+)\.yml$})     { 'test' }
-
 end

data/lib/roro.rb

@@ -1,8 +1,8 @@
+require 'byebug' 
 require "roro/version"
 require "thor"
 require "roro/cli"
 
 module Roro
   class Error < StandardError; end
-  # Your code goes here...
 end

data/lib/roro/cli.rb

@@ -1,20 +1,89 @@
-require 'byebug'
-require 'thor'
 require 'roro/cli/base/base'
-require 'roro/cli/rollon'
 require 'roro/cli/greenfield'
-require 'roro/cli/generate_keys'
 require 'roro/cli/obfuscate'
 require 'roro/cli/expose'
-require 'roro/cli/ruby_gem'
+require 'roro/cli/generate/config/rails'
+require 'roro/cli/generate/config'
+require 'roro/cli/generate/generate_keys'
+require 'roro/cli/configuration'
 
+require 'roro/cli/rollon'
 module Roro
+  
   class CLI < Thor
 
     include Thor::Actions
-
+    
     def self.source_root
       File.dirname(__FILE__) + '/cli/templates'
     end
+    
+   
+    desc "rollon::rails", "Generates files for and makes changes to your app 
+      so it can run using Docker containers."
+    method_option :interactive, desc: "Set up your environment variables as 
+      you go."
+    map "rollon::rails" => "rollon_rails"
+    
+    def rollon_rails 
+      rollon
+    end
+
+    
+    desc "greenfield::rails", "Greenfield a new, dockerized rails app with
+      either MySQL or PostgreSQL in a separate container."
+    
+    method_option :env_vars, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "key1:value1 key2:value2"
+    method_option :interactive, desc: "Set up your environment variables as you go."
+    method_option :force, desc: "force over-write of existing files"
+
+    map "greenfield::rails" => "greenfield_rails"
+    
+    def greenfield_rails(*args) 
+      greenfield(*args)
+    end
+    desc "generate::exposed", "Generate private .env files from 
+      encrypted .env.enc files inside the roro directory."
+    map "generate::exposed" => "generate_exposed"
+    
+    def generate_exposed(*args) 
+      expose(*args)
+    end
+    
+    desc "generate::key", "Generate a key inside roro/keys. Takes the name of 
+      an environment as an argument to private .env files from 
+    encrypted .env.enc files inside the roro directory.
+    Expose encrypted files"
+    
+    map "generate::key" => "generate_key"
+    method_option :environment, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
+    
+    def generate_key(*args)
+      generate_key_or_keys(*args)
+    end
+
+    desc "generate::keys", "Generate keys for each environment inside roro/keys.
+      If you have .env files like 'roro/containers/app/[staging_env].env' and 
+      'roro/[circle_ci_env].env' it will generate '/roro/keys/[staging_env].key'
+      and '/roro/keys/[circle_ci_env].key'."
+    map "generate::keys" => "generate_keys"
+
+    def generate_keys(*args)
+      generate_key(*args)
+    end
+    
+    desc "generate::config", "Generate a config file at .roro_config.yml" 
+    map "generate::config" => "generate_config"
+    
+    def generate_config
+      create_file ".roro_config.yml", @config.app.to_yaml 
+    end
+    
+    desc "generate::obfuscated", "obfuscates any files matching the pattern ./roro/**/*.env"
+    map "generate::obfuscated" => "generate_obfuscated"
+    
+    def generate_obfuscated(*args) 
+      obfuscate(*args)
+    end
   end
 end

data/lib/roro/cli/base/base.rb

@@ -1,4 +1,5 @@
-require_relative 'configuration.rb'
+
+require_relative 'check_dependencies.rb'
 require_relative 'continuous_integration.rb'
 require_relative 'utilities.rb'
 require_relative 'insertions.rb'

data/lib/roro/cli/base/base_files.rb

@@ -5,8 +5,7 @@ module Roro
     no_commands do
       
       def copy_dockerignore 
-        copy_file 'base/.dockerignore', '.dockerignore', @env_hash[:use_force]
-
+        copy_file 'base/.dockerignore', '.dockerignore'
       end 
       
       def copy_host_example 
@@ -14,24 +13,11 @@ module Roro
       end
 
       def copy_docker_compose 
-        template "base/docker-compose.yml", 'docker-compose.yml', @env_hash[:force]
-      end
-      
-      def copy_roro 
-        directory 'base/roro/containers/app', "roro/containers/#{@env_hash[:app_name]}", @env_hash
-        directory 'base/roro/containers/database', "roro/containers/#{@env_hash[:database_container]}", @env_hash
-        directory 'base/roro/containers/frontend', "roro/containers/#{@env_hash[:frontend_container]}", @env_hash
+        template "base/docker-compose.yml", 'docker-compose.yml', @env_hash
       end
       
-      def copy_config_database_yml 
-        copy_file "base/config/database.yml", 'config/database.yml', @env_hash[:use_force]
-      end
-
-      def copy_base_files
-        copy_circleci
-        copy_roro 
-        copy_docker_compose 
-        copy_config_database_yml
+      def copy_database_yml_pg 
+        copy_file "base/config/database.pg.yml", 'config/database.yml', force: @env_hash[:use_force]
       end
     end
   end 

data/lib/roro/cli/base/check_dependencies.rb

@@ -0,0 +1,98 @@
+module Roro
+
+  class CLI < Thor
+
+    no_commands do
+     
+      def confirm_directory_not_empty 
+        confirm_dependency({
+          system_query: "ls -A",
+          warning: "This is an empty directory. You can generate a new and fully 
+            dockerized Rails app using the 'greenfield' command here here but if 
+            you want to containerize an existing app -- which is what the 'rollon'
+            command is for -- you'll need to navigate to a directory with an app we
+            can roll onto.",
+          suggestion: "$ roro greenfield",
+          conditional: "!Dir.glob('*').empty?" })
+      end
+      
+      def confirm_directory_empty 
+        confirm = confirm_dependency({
+          system_query: "ls -A",
+          warning: "this is not an empty directory. Roro will not greenfield a new Rails app unless either a) the current directory is empty or b) you run greenfield with the --force flag",
+          suggestion: "$ roro greenfield --force",
+          conditional: "Dir.glob('*').empty?" }) 
+        confirm || true
+      end
+          
+      def remove_roro_artifacts 
+        appname = Dir.pwd.split('/').last 
+        check_for_clashes = "docker ps --filter name=#{appname}* -aq"
+        no_artifact_containers = IO.popen(check_for_clashes).count.eql?(0)
+        no_artifact_volumes = IO.popen("docker volume ls --filter name=greenfield*").count > (1)
+        unless (no_artifact_containers && no_artifact_volumes)
+          remove_clashes = ["docker ps --filter name=#{appname}* -aq | xargs docker stop | xargs docker rm"]
+          volumes = %w(db_data app)
+          volumes.each {|v| remove_clashes << "docker volume rm #{appname}_#{v}"}
+          question = [
+            "\n\nWe found some container and volume artifacts which may clash",
+            "with RoRo moving forward. You can verify their existence in a ",
+            "separate terminal with:",
+            "\n\t$ #{check_for_clashes}'\n", 
+            "You can remove these artifacts with something like:\n" 
+          ]
+          remove_clashes.each { |c| question << "\t$ #{c}"}
+          question << "\nWould you like RoRo to attempt to remove them for you?"
+          question = question.join("\n")
+      
+          prompt = [question]
+          choices = {'y' => 'Yes', 'n' => 'No'}
+          choices.each { |k,v| prompt << "(#{k}) #{v.to_s}" }
+          answer = ask((prompt.join("\n\n") + "\n\n"), 
+          default: 'y', limited_to: choices.keys)
+          remove_clashes.each {|c| system c }
+        end
+      end
+    
+      def confirm_dependency(options)
+        msg = []
+        msg << ""
+        msg << delineator
+        msg << "It looks like #{options[:warning]}. The following bash command returns false:"
+        msg << "\t$ #{options[:system_query]}"
+        msg << "Please try these instructions:"
+        msg << ("\t" + options[:suggestion])
+        msg << delineator
+        conditional = options[:conditional] ? eval(options[:conditional]) : system(options[:system_query])
+        if conditional == false
+          raise(Roro::Error.new(msg.join("\n\n")))
+        else 
+          true 
+        end
+      end
+   
+      def confirm_dependencies
+        dependencies = [
+          {
+            system_query: "which docker",
+            warning: "Docker isn't installed",
+            suggestion: "https://docs.docker.com/install/"
+          }, {
+            system_query: "which docker-compose",
+            warning: "Docker Compose isn't installed",
+            suggestion: "https://docs.docker.com/compose/install/"
+
+          }, {
+            system_query: "docker info",
+            warning: "the Docker daemon isn't running",
+            suggestion: "https://docs.docker.com/config/daemon/#start-the-daemon-manually"
+          }
+        ]
+
+        dependencies.each do |dependency|
+          confirm_dependency(dependency)
+        end
+      end
+    end
+  end
+end

data/lib/roro/cli/base/insert_gems.rb

@@ -6,17 +6,25 @@ module Roro
     no_commands do 
           
       def insert_roro_gem_into_gemfile
-        insert_into_file 'Gemfile', "gem 'roro'", before: "group :development, :test do"
+        insert_into_file 'Gemfile', "gem 'roro'\n\n", before: "group :development, :test do"
       end
-
-      def insert_pg_gem_into_gemfile
-        comment_lines 'Gemfile', /sqlite/
-        comment_lines 'Gemfile', /mysql/
-        insert_into_file 'Gemfile', "gem 'pg'\n", before: "group :development, :test do"
+      
+      def insert_db_gem(gem)
+        gem_lines = [
+          /gem\s['"]sqlite3['"]/,
+          /gem\s['"]mysql2['"]/,
+          /gem\s['"]pg['"]/,
+          
+        ]
+        gem_lines.each do |line| 
+          comment_lines 'Gemfile', line 
+          gsub_file 'Gemfile', line, 'gem copied over by roro'
+        end
+        insert_into_file 'Gemfile', "gem '#{gem}'\n\n", before: "group :development, :test"
       end
 
       def insert_hfci_gem_into_gemfile
-        insert_into_file 'Gemfile', "gem 'handsome_fencer-test'", after: "group :development, :test do"
+        insert_into_file 'Gemfile', "gem 'handsome_fencer-test'\n\n", after: "group :development, :test do"
       end  
     end
   end 

data/lib/roro/cli/base/insertions.rb

@@ -6,7 +6,9 @@ module Roro
     no_commands do 
           
       def config_std_out_true
-        prepend_to_file('config/boot.rb', "$stdout.sync = true\n\n", @env_hash[:use_force])
+        file = 'config/boot.rb'
+        line = "$stdout.sync = true\n\n"
+        prepend_to_file(file, line, force: true)
       end 
       
       def gitignore_sensitive_files

data/lib/roro/cli/base/utilities.rb

@@ -12,6 +12,28 @@ module Roro
       def own_if_required
         system 'sudo chown -R $USER .'
       end   
+      
+      def as_system(command)
+        command = OS.linux? ? "sudo #{command}" : command
+        system command
+      end
+
+      def chown_if_required()
+        warning = "It looks like you're running Docker on some flavor of Linux, in which case the files created by your containers are owned by the root user of the container, and not by the user of the host machine. Please change their ownership by supplying your password at the prompt.",
+        action = "system 'sudo chown -R $USER .'"
+        msg = []
+        msg << ""
+        msg << delineator
+        msg << warning
+        msg << ""
+        msg.join("\n\n")
+        puts msg
+        eval(action)
+      end
+
+      def delineator
+        ("-" * 80)
+      end
     end
   end 
 end

data/lib/roro/cli/cli.rb

@@ -0,0 +1,99 @@
+require 'thor'
+require 'roro/cli/base/base'
+require 'roro/cli/rollon/stories'
+require 'roro/cli/rollon'
+require 'roro/cli/greenfield'
+require 'roro/cli/obfuscate'
+require 'roro/cli/expose'
+require 'roro/cli/ruby_gem'
+require 'roro/cli/generate/config/rails'
+require 'roro/cli/generate/config'
+require 'roro/cli/generate/generate_keys'
+require 'roro/cli/configuration'
+
+module Roro
+  
+  class CLI < Thor
+    
+    include Thor::Actions
+    
+    def self.source_root
+      File.dirname(__FILE__) + '/cli/templates'
+    end
+    
+    desc "rollon::ruby_gem", "Generate files for containerized gem testing, CircleCI, and releasing to RubyGems."
+    method_option :rubies, type: :array, banner: "2.5.3 2.4.2"
+    map "rollon::ruby_gem" => "rollon_ruby_gem"
+
+    def rollon_ruby_gem(*args) 
+      ruby_gem(*args)
+    end
+    
+    desc "rollon::rails", "Generates files for and makes changes to your app 
+      so it can run using Docker containers."
+    method_option :interactive, desc: "Set up your environment variables as 
+      you go."
+    map "rollon::rails" => "rollon_rails"
+    
+    def rollon_rails 
+      rollon
+    end
+
+    
+    desc "greenfield::rails", "Greenfield a new, dockerized rails app with
+      either MySQL or PostgreSQL in a separate container."
+    
+    method_option :env_vars, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "key1:value1 key2:value2"
+    method_option :interactive, desc: "Set up your environment variables as you go."
+    method_option :force, desc: "force over-write of existing files"
+
+    map "greenfield::rails" => "greenfield_rails"
+    
+    def greenfield_rails(*args) 
+      greenfield(*args)
+    end
+    desc "generate::exposed", "Generate private .env files from 
+      encrypted .env.enc files inside the roro directory."
+    map "generate::exposed" => "generate_exposed"
+    
+    def generate_exposed(*args) 
+      expose(*args)
+    end
+    
+    desc "generate::key", "Generate a key inside roro/keys. Takes the name of 
+      an environment as an argument to private .env files from 
+    encrypted .env.enc files inside the roro directory.
+    Expose encrypted files"
+    
+    map "generate::key" => "generate_key"
+    method_option :environment, type: :hash, default: {}, desc: "Pass a list of environment variables like so: env:var", banner: "development, staging"
+    
+    def generate_key(*args)
+      generate_key_or_keys(*args)
+    end
+
+    desc "generate::keys", "Generate keys for each environment inside roro/keys.
+      If you have .env files like 'roro/containers/app/[staging_env].env' and 
+      'roro/[circle_ci_env].env' it will generate '/roro/keys/[staging_env].key'
+      and '/roro/keys/[circle_ci_env].key'."
+    map "generate::keys" => "generate_keys"
+
+    def generate_keys(*args)
+      generate_key(*args)
+    end
+    
+    desc "generate::config", "Generate a config file at .roro_config.yml" 
+    map "generate::config" => "generate_config"
+    
+    def generate_config
+      create_file ".roro_config.yml", @config.app.to_yaml 
+    end
+    
+    desc "generate::obfuscated", "obfuscates any files matching the pattern ./roro/**/*.env"
+    map "generate::obfuscated" => "generate_obfuscated"
+    
+    def generate_obfuscated(*args) 
+      obfuscate(*args)
+    end
+  end
+end