orats 0.7.3 → 0.8.0

data/lib/orats/cli.rb

@@ -1,169 +1,81 @@
 require 'thor'
-require 'orats/commands/project/exec'
-require 'orats/commands/inventory'
-require 'orats/commands/playbook'
-require 'orats/commands/role'
+require 'orats/commands/new/exec'
 require 'orats/commands/nuke'
-require 'orats/commands/diff/exec'
+require 'orats/version'
 
 module Orats
+  # the thor driven command line interface
   class CLI < Thor
-    option :pg_location, default: 'localhost', aliases: '-l'
-    option :pg_username, default: 'postgres', aliases: '-u'
-    option :pg_password, required: true, aliases: '-p'
-    option :redis_location, default: 'localhost', aliases: '-n'
-    option :redis_password, default: '', aliases: '-d'
-    option :template, default: '', aliases: '-m'
-    option :custom, default: '', aliases: '-c'
-    option :skip_ansible, type: :boolean, default: false, aliases: '-A'
-    option :skip_server_start, type: :boolean, default: false, aliases: '-S'
-    desc 'project TARGET_PATH [options]', ''
-    long_desc <<-D
-      `orats project target_path --pg-password supersecret` will create a new rails project and it will also create an ansible inventory to go with it by default.
-
-      You must supply at least this flag:
-
-      `--pg-password` to supply your development postgres password so the rails application can run database migrations
-
-      Configuration:
-
-      `--pg-location` to supply a custom postgres location [localhost]
-
-      `--pg-username` to supply a custom postgres username [postgres]
-
-      `--redis-location` to supply a custom redis location [localhost]
-
-      `--redis-password` to supply your development redis password []
-
-      Template features:
+    # if options are added through the .oratsrc file then we run the risk
+    # of having options not set for the command it was ran for
 
-      `--template` accepts a template name which will get added in addition to the base template []
+    # for example the new command has a --template flag but the nuke command
+    # does not. thor will throw an error if you have --template in the
+    # .oratsrc config because it does not exist for the nuke command
 
-      `--custom` will let you supply a custom template, a url or file is ok but urls must start with http or https []
+    # the code below gets a list of options that came from the .oratsrc file
+    # and compares them to the current options for the current command
 
-      Project features:
+    # this is good, but now we need a way to somehow add these options into
+    # the command to fool thor into thinking they exist. we need to add
+    # the option somehow, thoughts?
 
-      `--skip-ansible` skip creating the ansible related directories [false]
+    # for now none of the code below is in action and the readme explicitly
+    # says you can only store the postgres and redis credentials since
+    # the args only get inserted into the new and nuke commands
+    def initialize(args, local_options, config)
+      super
 
-      `--skip-server-start` skip automatically running puma and sidekiq [false]
-    D
+      matched_options = []
 
-    def project(target_path)
-      Commands::Project::Exec.new(target_path, options).init
-    end
-
-    desc 'inventory TARGET_PATH [options]', ''
-    long_desc <<-D
-      `orats inventory target_path` will create an ansible inventory.
-    D
-
-    def inventory(target_path)
-      Commands::Inventory.new(target_path, options).init
-    end
-
-    option :custom, default: '', aliases: '-c'
-    desc 'playbook TARGET_PATH [options]', ''
-    long_desc <<-D
-      `orats playbook target_path` will create an ansible playbook.
-
-      Help:
+      config[:current_command].options.each do |key|
+        aliases = key[1].aliases
+        option = key[0].to_s.gsub('_', '-')
 
-      If you pass in an existing playbook path it will update the role versions.
+        aliases.each do |item|
+          matched_options << item if local_options.join.include?(item)
+        end
 
-      Template features:
-
-      `--custom` will let you supply a custom template, a url or file is ok but urls
- must start with http or https []
-    D
-
-    def playbook(target_path)
-      Commands::Playbook.new(target_path, options).init
+        matched_options << option if local_options.include?("--#{option}")
+      end
     end
 
-    option :repo_name, default: '', aliases: '-r'
+    option :pg_location, default: 'localhost', aliases: '-l'
+    option :pg_username, default: 'postgres', aliases: '-u'
+    option :pg_password, default: '', aliases: '-p'
+    option :redis_location, default: 'localhost', aliases: '-n'
+    option :redis_password, default: '', aliases: '-d'
+    option :template, default: '', aliases: '-t'
     option :custom, default: '', aliases: '-c'
-    desc 'role TARGET_PATH [options]', ''
-    long_desc <<-D
-      `orats role target_path` will create an ansible role suitable for the galaxy.
-
-      Configuration:
-
-      `--repo-name` if your github repo name is different than the full role name
-
-      Template features:
-
-      `--custom` will let you supply a custom template, a url or file is ok but urls
- must start with http or https []
-    D
-
-    def role(target_path)
-      Commands::Role.new(target_path, options).init
+    option :skip_server_start, type: :boolean, default: false, aliases: '-S'
+    option :rc, default: ''
+    desc 'new PATH [options]', 'Create a new orats application'
+    long_desc File.read(File.join(File.dirname(__FILE__), 'cli_help/new'))
+    def new(target_path)
+      Commands::New::Exec.new(target_path, options).init
     end
 
-    option :skip_data, type: :boolean, default: false, aliases: '-D'
+    option :pg_location, default: 'localhost', aliases: '-l'
+    option :pg_username, default: 'postgres', aliases: '-u'
+    option :pg_password, default: '', aliases: '-p'
+    option :redis_location, default: 'localhost', aliases: '-n'
     option :redis_password, default: '', aliases: '-d'
-    desc 'nuke TARGET_PATH [options]', ''
-    long_desc <<-D
-      `orats nuke target_path` will delete the directory and optionally all data associated to it.
-
-      Options:
-
-      `--skip-data` will skip deleting app specific postgres databases and redis namespaces [false]
-
-      `--redis-password` to supply your development redis password []
-    D
-
+    option :skip_data, type: :boolean, default: false, aliases: '-D'
+    option :rc, default: ''
+    desc 'nuke PATH [options]', 'Delete a path and optionally its data'
+    long_desc File.read(File.join(File.dirname(__FILE__), 'cli_help/nuke'))
     def nuke(target_path)
       Commands::Nuke.new(target_path, options).init
     end
 
-    option :galaxyfile, default: '', aliases: '-g'
-    option :playbook, default: '', aliases: '-p'
-    option :hosts, default: '', aliases: '-h'
-    option :inventory, default: '', aliases: '-i'
-    desc 'diff [options]', ''
-    long_desc <<-D
-      `orats diff` will run various comparisons on orats and your ansible files.
-
-      Options:
-
-      `--galaxyfile` to supply a galaxyfile for comparison []
-
-      `--playbook` to supply a playbook directory/file for comparison []
-
-      `--hosts` to supply a hosts file for comparison []
-
-      `--inventory` to supply an inventory directory/file for comparison []
-
-      Quality of life features:
-
-      `--playbook` also accepts a playbook path, if you kept the
-default file names it will automatically compare both your Galaxyfile and
-site.yml files.
-
-      `--inventory` also accepts an inventory path, if you kept the
-default file names it will automatically compare both your hosts and
-group_vars/all.yml files.
-    D
-
-    def diff
-      Commands::Diff::Exec.new(nil, options).init
-    end
-
-    desc 'templates', ''
-    long_desc <<-D
-      `orats templates` will return a list of available orats templates.
-    D
-
+    desc 'templates', 'Return a list of available templates'
+    long_desc 'Return a list of available built in templates.'
     def templates
-      Commands::Project::Exec.new.list_templates
+      Commands::New::Exec.new.available_templates
     end
 
-    desc 'version', ''
-    long_desc <<-D
-      `orats version` will print the current version.
-    D
-
+    desc 'version', 'The current version of orats'
+    long_desc 'Print the current version.'
     def version
       puts "Orats version #{VERSION}"
     end
@@ -176,4 +88,4 @@ group_vars/all.yml files.
       caller_locations(0).any? { |backtrace| backtrace.label == 'invoke' }
     end
   end
-end
+end

data/lib/orats/cli_help/new

@@ -0,0 +1,27 @@
+Create a new shiny rails app with quite a few best practices and opinions.
+
+Development server credentials:
+
+`--pg-location` to supply a custom postgres location [localhost]
+
+`--pg-username` to supply a custom postgres username [postgres]
+
+`--pg-password` to supply your postgres password to run migrations []
+
+`--redis-location` to supply a custom redis location [localhost]
+
+`--redis-password` to supply your redis password []
+
+Options:
+
+`--rc` to supply an .oratsrc file path to automatically populate credentials []
+
+Template features:
+
+`--template` to mix in an official orats template by supplying its name []
+
+`--custom` to add your own template at the very end, a url or file is ok []
+
+Project features:
+
+`--skip-server-start` to skip automatically running puma and sidekiq [false]

data/lib/orats/cli_help/nuke

@@ -0,0 +1,19 @@
+Delete the target path and optionally all data associated to it.
+
+Development server credentials:
+
+`--pg-location` to supply a custom postgres location [localhost]
+
+`--pg-username` to supply a custom postgres username [postgres]
+
+`--pg-password` to supply your postgres password []
+
+`--redis-location` to supply a custom redis location [localhost]
+
+`--redis-password` to supply your redis password []
+
+Options:
+
+`--skip-data` to skip deleting app specific postgres and redis data [false]
+
+`--rc` to supply an .oratsrc file path to automatically populate credentials []

data/lib/orats/commands/new/exec.rb

@@ -0,0 +1,59 @@
+require 'orats/common'
+require 'orats/commands/new/rails'
+require 'orats/commands/new/server'
+
+module Orats
+  module Commands
+    module New
+      # entry point to the new command
+      class Exec < Common
+        include Rails
+        include Server
+
+        AVAILABLE_TEMPLATES = {
+          auth: 'add authentication and authorization'
+        }
+
+        def initialize(target_path = '', options = {})
+          super
+        end
+
+        def init
+          check_exit_conditions
+
+          rails_template 'base' do
+            rails_template_actions
+          end
+
+          orats_rails_template if template_exist?(@options[:template])
+          custom_rails_template unless @options[:custom].empty?
+          server_start
+        end
+
+        def available_templates
+          puts
+          log 'templates',
+              'Add `-t TEMPLATE` to the new command to mixin a template',
+              :magenta
+          puts
+
+          AVAILABLE_TEMPLATES.each_pair do |key, value|
+            log key, value, :cyan
+          end
+        end
+
+        private
+
+        def orats_to_local(source, dest)
+          includes_path = "#{base_path}/templates/includes"
+
+          unless Dir.exist?(File.dirname(dest))
+            system "mkdir -p #{File.dirname(dest)}"
+          end
+
+          system "cp #{includes_path}/#{source} #{dest}"
+        end
+      end
+    end
+  end
+end

data/lib/orats/commands/new/rails.rb

@@ -0,0 +1,197 @@
+module Orats
+  module Commands
+    module New
+      # helper functions for the new::exec class
+      module Rails
+        def check_exit_conditions
+          exit_if_path_exists
+          exit_if_invalid_template
+          exit_if_invalid_system
+          exit_if_database_exists
+        end
+
+        def rails_template(command, flags = '')
+          orats_template = "--template #{base_path}/templates/#{command}.rb"
+
+          run "rails new #{@target_path} #{flags} --skip-bundle " + \
+              " #{orats_template unless command.empty?}"
+
+          yield if block_given?
+        end
+
+        def orats_rails_template
+          rails_template @options[:template], '--skip ' do
+            migrate_and_seed_database
+          end
+        end
+
+        def custom_rails_template
+          task 'Add custom template'
+
+          if @options[:custom].include('://')
+            url_to_string(@options[:custom])
+          else
+            file_to_string(@options[:custom])
+          end
+
+          rails_template '', "--skip --template #{@options[:custom]}"
+        end
+
+        def rails_template_actions
+          gsub_postgres_info
+          gsub_redis_info
+          gsub_app_path
+          gsub_readme
+
+          bundle_install
+          bundle_binstubs
+          spring_binstub
+
+          create_and_migrate_database
+          generate_home_page
+          generate_favicons
+        end
+
+        def gsub_postgres_info
+          task 'Update the postgres connection details'
+
+          gsub_file "#{@target_path}/.env", "DATABASE_HOST: 'localhost'",
+                    "DATABASE_HOST: '#{@options[:pg_location]}'"
+          gsub_file "#{@target_path}/.env", ": 'postgres'",
+                    ": '#{@options[:pg_username]}'"
+          gsub_file "#{@target_path}/.env", ": 'supersecrets'",
+                    ": '#{@options[:pg_password]}'"
+
+          commit 'Update the postgres connection details'
+        end
+
+        def gsub_redis_info
+          task 'Update the redis connection details'
+
+          gsub_file "#{@target_path}/.env", "HE_PASSWORD: ''",
+                    "HE_PASSWORD: '#{@options[:redis_password]}'"
+          gsub_file "#{@target_path}/.env", "CACHE_HOST: 'localhost'",
+                    "CACHE_HOST: '#{@options[:redis_location]}'"
+
+          commit 'Update the redis connection details'
+        end
+
+        def gsub_app_path
+          task 'Update the app path'
+
+          gsub_file "#{@target_path}/.env", ": '/tmp/yourapp'",
+                    ": '#{File.expand_path(@target_path)}'"
+
+          commit 'Update the app path'
+        end
+
+        def gsub_readme
+          task 'Update the readme'
+
+          gsub_file "#{@target_path}/README.md", 'VERSION', VERSION
+
+          commit 'Update the readme'
+        end
+
+        def bundle_install
+          task 'Run bundle install, this may take a while'
+          run_from @target_path, 'bundle install'
+
+          commit 'Add Gemfile.lock'
+        end
+
+        def bundle_binstubs
+          task 'Run bundle binstubs for a few gems'
+          run_from @target_path, 'bundle binstubs whenever puma sidekiq backup'
+
+          commit 'Add binstubs for the important gems'
+        end
+
+        def spring_binstub
+          task 'Run spring binstub'
+          run_from @target_path, 'bundle exec spring binstub --all'
+
+          commit 'Add spring binstubs for all of the bins'
+        end
+
+        def generate_home_page
+          kill_spring_servers
+
+          task 'Add pages controller with static page'
+          run_from @target_path, 'bundle exec rails g controller Pages home'
+
+          gsub_home_page
+          copy_home_page_views
+
+          commit 'Add pages controller with home page'
+        end
+
+        def generate_favicons
+          run_rake 'orats:favicons'
+
+          commit 'Add favicons'
+        end
+
+        def create_and_migrate_database
+          task 'Create and migrate the database'
+
+          create_database
+          run_rake 'db:migrate'
+
+          commit 'Add the database schema file'
+        end
+
+        def migrate_and_seed_database
+          run_rake 'db:migrate db:seed'
+
+          commit 'Update the database schema file'
+        end
+
+        def template_exist?(template)
+          Exec::AVAILABLE_TEMPLATES.include?(template.to_sym)
+        end
+
+        private
+
+        def gsub_home_page
+          gsub_file "#{@target_path}/config/routes.rb",
+                    "  # root 'welcome#index'", "  root 'pages#home'"
+          gsub_file "#{@target_path}/config/routes.rb",
+                    "  get 'pages/home'\n\n", ''
+
+          gsub_file "#{@target_path}/test/controllers/pages_controller_" + \
+                    'test.rb', '"should get home"', "'expect home page'"
+        end
+
+        def copy_home_page_views
+          run_from @target_path, 'rm app/views/pages/home.html.erb'
+
+          orats_to_local 'new/rails/app/views/pages/home.html.erb',
+                         "#{@target_path}/app/views/pages/home.html.erb"
+
+          gsub_file "#{@target_path}/app/views/pages/home.html.erb",
+                    'vVERSION', VERSION
+        end
+
+        def exit_if_invalid_template
+          template = @options[:template] || ''
+          task 'Check if template exists'
+
+          return if template.empty? || template_exist?(template)
+
+          error 'Cannot find template',
+                "'#{template}' is not a valid template name"
+
+          available_templates
+          exit 1
+        end
+
+        def kill_spring_servers
+          # rails generators will lock up if a spring server is running,
+          # so kill them all before continuing
+          system 'pkill -f spring'
+        end
+      end
+    end
+  end
+end

data/lib/orats/commands/new/server.rb

@@ -0,0 +1,67 @@
+require 'socket'
+require 'timeout'
+
+module Orats
+  module Commands
+    module New
+      # handle starting the server
+      module Server
+        START_COMMAND = 'bundle exec foreman start'
+
+        def server_start
+          if @options[:skip_server_start]
+            message = 'Start your'
+          else
+            message = 'Starting'
+          end
+
+          display_notice message
+          attempt_to_start unless @options[:skip_server_start]
+        end
+
+        private
+
+        def display_notice(message)
+          results "#{message} server with the following commands",
+                  'command', "cd #{@target_path}"
+          log 'command', START_COMMAND, :white
+        end
+
+        def attempt_to_start
+          while port_taken?
+            error 'Failed to start server',
+                  "Another application is using port 3000\n"
+            puts
+            exit 1 if no?('Would you like to try running ' + \
+                          ' the server again? (y/N)', :cyan)
+          end
+
+          puts
+          run_from @target_path, START_COMMAND
+        end
+
+        def port_taken?
+          begin
+            start_server?
+          rescue Timeout::Error
+            false
+          end
+
+          false
+        end
+
+        def start_server?
+          Timeout.timeout(5) do
+            s = TCPSocket.new('localhost', 3000)
+            s.close
+
+            true
+          end
+
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            false
+        end
+      end
+    end
+  end
+end