negroku 1.1.14 → 2.0.0.pre1

data/lib/negroku/cli.rb

@@ -1,217 +1,30 @@
-require 'thor'
-require 'rainbow'
-require 'highline/import'
-require 'negroku'
+require 'gli'
+require 'inquirer'
+require 'negroku/i18n'
+require 'negroku/version'
+require 'negroku/cli/bootstrap'
 
-trap('INT') { exit }
+module Negroku::CLI
 
-class App < Thor
+    extend GLI::App
 
-  say "\n\n#############################################".bright()
-  say "##                NEGROKU                  ##".bright()
-  say "#############################################\n".bright()
+    # Set th version
+    version Negroku::VERSION
 
-  desc "create", "Create application. Intialize the capfile, also create the deploy.rb file in the config folder"
-  method_option :local_recipes, :type => :boolean, :aliases => "-l"
-  method_option :path, :type => :string, :aliases => "-p"
-  def create(name=nil)
-    # Get configuration
-    config = getConfig
+    # Negroku commands will manage the interactive cli ui
+    default_command :negroku
 
-    # Test for config
-    if config.empty?
-      say "[WARNING]".foreground(:red)
-      say "It's recommended that you add some custom settings to negroku before you create your app deployment\n\n"
-      say "You can add your deployment servers urls using:\n"
-      say "negroku target add my.deployment.com".foreground(:yellow)
-      say "negroku target add 104.284.3.1\n".foreground(:yellow)
-      unless agree "You have not added custom settings! Do you want to continue? [y/n]", true
-        say "Goodbye"
-        exit
-      end
-    end
+    # Don't show the negroku commands in the help
+    hide_commands_without_desc true
 
-    say "We're about to create your application deploy setup\n".foreground(:green)
+    # Use the gemspec summary to describe the cli
+    program_desc Gem::Specification.find_by_name('negroku').summary
 
-    # Hash to hold the app info
-    data = {}
+    # Load all the commands in the negroku/cli/command folder
+    commands_from 'negroku/cli/commands'
 
-    # Get the name
-    if name.nil?
-      data[:application_name] = ask "Give your application a name:".bright()
-    else
-      data[:application_name] = name
-    end
-
-    # The application code repository
-    choose do |menu|
-
-      say "\nREPOSITORIES"
-      say "============"
-      menu.prompt = "Please choose your repository?".bright()
-      menu.select_by = :index
-
-      # find local remote from git repo
-      %x(git remote -v 2> /dev/null | awk '{print $2}' | uniq).split("\n").each do |url|
-        menu.choice(url) do |server|
-          say("Using #{server}")
-          data[:repo] = server;
-        end
-      end
-
-      # add other repo choice
-      menu.choice(:other) {
-        data[:repo] = ask "Type the url and username e.g. git@github.com:username/app-name.git: ".bright()
-      }
-    end
-
-    # The application target deploy server
-    say "\nTARGET SERVERS"
-    say "==============\n"
-    %w(staging production).each do |stage|
-
-      # Stage title
-      puts "\n#{stage.upcase}".foreground(:green)
-
-      # Ask server
-      choose do |menu|
-        menu.prompt = "Please choose your #{stage} deployment server?".bright()
-        menu.select_by = :index
-
-        # Adds the targets in the config file if there is one
-        if config[:target]
-          config[:target].each do |val|
-            menu.choice(val) do |server|
-              say("Using #{server} for #{stage}")
-              data[:"#{stage}_server"] = server;
-            end
-          end
-        else
-          say "[INFO] There are no target urls in the default settings".color(:yellow)
-        end
-
-        menu.choice(:other) {
-          data[:"#{stage}_server"] = ask "Type the hostname or ip of the #{stage} server to deploy to:".bright()
-        }
-      end
-
-      # Add custom domain
-      case stage
-      when "staging"
-        domain = data[:"#{stage}_server"].gsub(/^([a-z\d]*)/, data[:application_name])
-      when "production"
-        domain = "www.#{data[:application_name]}.com"
-      end
-      if agree "Do you want to use #{domain}? [y/n]", true
-        data[:"#{stage}_domains"] = domain
-      else
-        data[:"#{stage}_domains"] = ask "Please enter the domains separated by spaces"
-      end
-    end
-
-    init(".", data)
-
-    say "\n\nWhat to do next?\n".bright()
-    say "Setup your app running " + "cap deploy:setup".color(:yellow) + " then " + "cap deploy:cold".color(:yellow)
-    say "You can try with " + "cap -T".color(:yellow) +" to see the available tasks"
-    say "Also you can check the following files, you may want to change some things there"
-    say "config/deploy.rb".color(:yellow)
-    say "config/deploy/staging.rb".color(:yellow)
-    say "config/deploy/production.rb".color(:yellow)
-    say "\nHAPPY DEPLOY".foreground(:green)
-  end
-end
-
-class Target < Thor
-  desc "add", "add new default target server"
-  def add(host=nil)
-    if host.nil?
-      host = ask("Type the host or ip for the target machine")
-    end
-    saveConfig(:add, :target, host)
-    say "[Negroku] Added #{host}"
-  end
-
-  desc "remove", "remove some target"
-  def remove
-    puts "I will remove a target"
-  end
-
-  desc "list", "show the targets"
-  def list
-    puts "I will list the target servers"
-  end
-end
-
-class Konfig < Thor
-  namespace "config"
-
-  desc "show", "Show the current configuration file"
-
-  def show
-    showConfig
-  end
+    # Initialize GLI app
+    exit Negroku::CLI.run(ARGV)
 end
 
-class RemoteEnv < Thor
-  namespace "env"
-  class_option :stage, :type => :string, :aliases => "-s", :desc => "Set the capistrano stage to be used", :banner => "STAGE"
-
-  desc "show", "Show the current remote variables"
-  def show
-    %x(cap #{options[:stage]} rbenv:vars:show)
-  end
-
-  desc "add", "Adds or updates env variables to the remote server"
-  method_option :local, :type => :boolean, :aliases => "-l"
-  def add(key=nil, value=nil)
-
-    # Check if the paramenter were sent in the call
-    # Ask for the value if only the key was sent
-    if !key.nil? && value.nil?
-      value = ask("Please enter the value for #{key}:")
-    # If nothing was sent
-    elsif key.nil? && value.nil?
-      # Check if the .rbenv-vars file exists and offer get the info from there
-      if File.exist?(".rbenv-vars") && (agree "Do you want to add variables from your local .rbenv-vars file [y/n]", true)
-        choose do |menu|
-          menu.prompt = "Please choose variable you want to add?".bright()
-          menu.select_by = :index
 
-          File.readlines(".rbenv-vars").each do |line|
-            menu.choice(line.gsub("\n","")) do |command|
-              key = command.split("=")[0]
-              value = command.split("=")[1]
-            end
-          end
-        end
-      else
-        key = ask("Please enter the variable key:")
-        value = ask("Please enter the value for #{key}:")
-      end
-    end
-
-    %x(cap #{options[:stage]} rbenv:vars:add -s key="#{key}" -s value="#{value}")
-  end
-end
-
-module Negroku
-  class CLI < Thor
-    class_option :version, :type => :boolean, :aliases => "-v"
-
-    def initialize(*)
-      super
-
-      # Show the version
-      if options[:version]
-        puts Negroku::VERSION
-        exit 0
-      end
-    end
-
-    register(App, 'app', 'app [COMMAND]', 'Application')
-    register(Target, 'target', 'target [COMMAND]', 'Target servers')
-    register(Konfig, 'config', 'config [COMMAND]', 'Configuration')
-    register(RemoteEnv, 'env', 'env [COMMAND]', 'Remote environmental variables')
-  end
-end

data/lib/negroku/deploy.rb

@@ -1,39 +1,17 @@
-##
-# Load Deployer Helpers
-require File.join(File.dirname(__FILE__), 'helpers')
+# Base configuration
+set :scm, :git
 
-# Base settings
-set   :scm,                 'git'
-set   :deploy_via, :remote_cache
-set   :use_sudo,            false
+# set :format, :pretty
+# set :log_level, :debug
+set :pty, true
 
-##
-# Default Configuration
-set :remote, 'origin' unless respond_to?(:remote)
-set :branch, 'master' unless respond_to?(:branch)
+set :keep_releases, 5
 
-# Default environment
-set :rails_env, 'production' unless respond_to?(:rails_env)
-
-## Default path
-set :default_environment, {
-  'PATH' => "$HOME/.rbenv/shims:$HOME/.rbenv/bin:$HOME/.nodenv/shims:$HOME/.nodenv/bin:$PATH"
-}
-
-# Run on Linux: `$ ssh-add` or on OSX: `$ ssh-add -K` for "forward_agent".
-ssh_options[:forward_agent] = true
-ssh_options[:port]          = 22
-default_run_options[:pty]   = true
-
-# Use the bundler capistrano task to deploy to the shared folder
-require "bundler/capistrano"
-set :bundle_flags,    "--deployment --binstubs"
-
-##
-# Load Deployment Tasks
-load_tasks('base')
-load_tasks('log')
-load_tasks('rbenv')
-load_tasks('bower')
-load_tasks('nginx')
-load_tasks('unicorn')
+require 'negroku/helpers'
+load_task "negroku"
+load_task "rbenv"     if was_required? 'capistrano/rbenv'
+load_task "nodenv"    if was_required? 'capistrano/nodenv'
+load_task "bower"     if was_required? 'capistrano/bower'
+load_task "bundler"   if was_required? 'capistrano/bundler'
+load_task "nginx"     if was_required? 'capistrano/nginx'
+load_task "unicorn"   if was_required? 'capistrano3/unicorn'

data/lib/negroku/helpers.rb

@@ -1,86 +1,9 @@
-def init(target=".", data)
-
-  # Main locations
-  target_path    = File.expand_path(target)
-  config_path = File.join(target_path, "config")
-  deploy_path = File.join(target_path, "config", "deploy")
-  capfile = File.join(target_path, "Capfile")
-  deployfile = File.join(config_path, "deploy.rb")
-  stagingfile = File.join(deploy_path, "staging.rb")
-  productionfile = File.join(deploy_path, "production.rb")
-
-  # Create the cap file if not found
-  if Dir.entries(target_path).include?("Capfile")
-    puts "[Negroku] => Found Capfile!"
-  else
-    puts "[Negroku] => Capifying!"
-    `capify #{target_path}`
-  end
-
-  # Find or create config folder
-  unless File.directory?(config_path)
-    puts "[Negroku] => Could not find the \"config\" folder. Creating it now!"
-    %x(mkdir #{config_path})
-  end
-
-  # Find or create deploy folder
-  unless File.directory?(deploy_path)
-    puts "[Negroku] => Could not find the \"deploy\" folder. Creating it now!"
-    %x(mkdir #{deploy_path})
-  end
-
-  # replace and rename older deploy.rb
-  if File.exist?(deployfile)
-    puts "[Negroku] => Backing up deploy.rb"
-    old_versions = Dir.entries(config_path).map {|entree| entree if entree =~ /deploy\.old\.(\d+)\.rb$/}.compact!
-    if old_versions.empty?
-      %x(mv #{deployfile} #{File.join(config_path, 'deploy.old.1.rb')})
-    else
-      version = old_versions.last.match('^deploy\.old\.(\d+)\.rb$')[1].to_i + 1
-      %x(mv #{deployfile} #{File.join(config_path, "deploy.old.#{version}.rb")})
-    end
-  end
-
-  # Create the new deploy
-  puts "[Negroku] => Writing new deploy.rb."
-  erb = getTemplate 'deploy.rb.erb'
-  File.open(deployfile, 'w') do |f|
-    f.write ERB.new(erb).result(binding)
-  end
-
-  # Create the new configuration stages
-  puts "[Negroku] => Writing new deploy/staging.rb"
-  erb = getTemplate 'staging.rb.erb'
-  File.open(stagingfile, 'w') do |f|
-    f.write ERB.new(erb).result(binding)
-  end
-  puts "[Negroku] => Writing new deploy/production.rb"
-  erb = getTemplate 'production.rb.erb'
-  File.open(productionfile, 'w') do |f|
-    f.write ERB.new(erb).result(binding)
-  end
-
-  # Prepares the Capfile for negroku
-  cfile = Capfile.new(capfile)
-  cfile.assets()
-  puts "[Negroku] => Enabling assets tasks."
-  cfile.negroku()
-  puts "[Negroku] => Adding Negroku Loader inside #{capfile}."
-
-end
-
-def showConfig()
-  # Load the yaml file
-  config = getConfig
-  puts config
-end
-
-def getTemplate(template)
-  File.read(File.join(File.dirname(__FILE__), 'templates', template))
+# Find out if a specific library file was already required
+def was_required?(file)
+  rex = Regexp.new("/#{Regexp.quote(file)}\.(so|o|sl|rb)?")
+  $LOADED_FEATURES.find { |f| f =~ rex }
 end
 
-##
-# Helper Method that assists in loading in tasks from the tasks folder
-def load_tasks(tasks)
-  load File.join(File.dirname(__FILE__), 'tasks', "#{tasks}.rb")
+def load_task(name)
+  load File.join(File.dirname(__FILE__), 'tasks', "#{name}.rake")
 end

data/lib/negroku/i18n.rb

@@ -0,0 +1,17 @@
+require 'i18n'
+
+en = {
+  capified:                    'Capified',
+  written_file:                'create %{file}',
+  application_name:            'Give your application a name',
+  other:                       'Other',
+  choose_repo_url:             'Choose the repository url',
+  type_repo_url:               'Type the url and username e.g. git@github.com:username/app-name.git',
+  choose_stages:               'Select the stages you are going to use'
+}
+
+I18n.backend.store_translations(:en, { negroku: en })
+
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = true
+end

data/lib/negroku/tasks/bower.rake

@@ -0,0 +1,12 @@
+## bower.rb
+#
+# Adds capistrano/bower specific variables and tasks
+
+namespace :load do
+  task :defaults do
+
+    # Add bower to :nodenv_map_bins
+    fetch(:nodenv_map_bins) << 'bower'
+
+  end
+end

data/lib/negroku/tasks/bundler.rake

@@ -0,0 +1,12 @@
+## bundler.rb
+#
+# Adds capistrano/bundler specific properties and tasks
+
+namespace :load do
+  task :defaults do
+
+    # Set bundler to run with the --deployment flag
+    set :bundle_flags, '--deployment'
+
+  end
+end

data/lib/negroku/tasks/negroku.rake

@@ -0,0 +1,48 @@
+require 'erb'
+require 'pathname'
+
+namespace :negroku do
+
+  desc 'Install Negroku, cap install STAGES=staging,production'
+  task :install do
+    envs = ENV['STAGES'] || 'staging,production'
+
+    tasks_dir = Pathname.new('lib/capistrano/tasks')
+    config_dir = Pathname.new('config')
+    deploy_dir = config_dir.join('deploy')
+
+    deploy_rb = File.expand_path("../../templates/deploy.rb.erb", __FILE__)
+    stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
+    capfile = File.expand_path("../../templates/Capfile", __FILE__)
+
+    FileUtils.mkdir_p deploy_dir
+
+    template = File.read(deploy_rb)
+    file = config_dir.join('deploy.rb')
+    File.open(file, 'w+') do |f|
+      f.write(ERB.new(template).result(binding))
+      puts I18n.t(:written_file, scope: :negroku, file: file)
+    end
+
+    template = File.read(stage_rb)
+    envs.split(',').each do |stage|
+      file = deploy_dir.join("#{stage}.rb")
+      File.open(file, 'w+') do |f|
+        f.write(ERB.new(template).result(binding))
+        puts I18n.t(:written_file, scope: :negroku, file: file)
+      end
+    end
+
+    FileUtils.mkdir_p tasks_dir
+
+    FileUtils.cp(capfile, 'Capfile')
+
+
+    puts I18n.t :capified, scope: :negroku
+  end
+
+  task :test do
+    puts "si!!!"
+    puts I18n.t :capified, scope: :negroku
+  end
+end

data/lib/negroku/tasks/nginx.rake

@@ -0,0 +1,24 @@
+## nginx.rb
+#
+# Adds capistrano3/nginx specific variables and tasks
+
+namespace :load do
+  task :defaults do
+
+  end
+end
+
+# Adds some task on complement the capistrano3-nginx tasks
+# This tasks are under the negroku namespace for easier identification
+namespace :negroku do
+
+    namespace :nginx do
+        # Reload or restart unicorn after the application is published
+        after 'deploy:publishing', 'restart' do
+          invoke 'nginx:site:add'
+          invoke 'nginx:site:enable'
+          invoke 'nginx:reload'
+        end
+    end
+end
+

data/lib/negroku/tasks/nodenv.rake

@@ -0,0 +1,13 @@
+## nodenv.rb
+#
+# Adds capistrano/nodenv specific variables and tasks
+
+namespace :load do
+  task :defaults do
+
+    # Set the node version using the .node-version file
+    # Looks for the file in the project root
+    set :nodenv_node, File.read('.node-version').strip if File.exist?('.node-version')
+
+  end
+end

data/lib/negroku/tasks/rbenv.rake

@@ -0,0 +1,56 @@
+## rbenv.rb
+#
+# Adds capistrano/rbenv specific variables and tasks
+
+namespace :load do
+  task :defaults do
+
+    # Set the ruby version using the .ruby-version file
+    # Looks for the file in the project root
+    set :rbenv_ruby, File.read('.ruby-version').strip if File.exist?('.ruby-version')
+
+    # Link .rbenv-vars file
+    set :linked_files, fetch(:linked_files, []) << '.rbenv-vars' if File.exist?('.rbenv-vars')
+  end
+end
+
+namespace :rbenv do
+  namespace :vars do
+    desc "Show current environmental variables"
+    task :show do
+      on release_roles :app do
+        within current_path do
+          execute :rbenv, 'vars'
+        end
+      end
+    end
+
+    desc "Add environmental variable"
+    task :add, [:key, :value] do |t, args|
+      key = args[:key]
+      value = args[:value]
+      on release_roles :app do
+        within shared_path do
+          unless test "[ ! -f .rbenv-vars ]"
+            execute :touch, ".rbenv-vars"
+          end
+          cmd = "if awk < #{shared_path}/.rbenv-vars -F= '{print $1}' | grep --quiet -w #{key}; then "
+          cmd += "sed -i 's/^#{key}=.*/#{key}=#{value.gsub("\/", "\\/")}/g' #{shared_path}/.rbenv-vars;"
+          cmd += "else echo '#{key}=#{value}' >> #{shared_path}/.rbenv-vars;"
+          cmd += "fi"
+          execute cmd
+        end
+      end
+    end
+
+    desc "Remove environmental variable"
+    task :remove, [:key] do |t, args|
+      on release_roles :app do
+        within shared_path do
+          execute :sed, "-i", "/^#{args[:key]}=/d", ".rbenv-vars"
+        end
+      end
+    end
+
+  end
+end

data/lib/negroku/tasks/unicorn.rake

@@ -0,0 +1,92 @@
+## unicorn.rb
+#
+# Adds unicorn variables and tasks
+# Unicorn main tasks are taken from the gem capistrano3-unicorn
+
+# Here we are setting up the main negroku default to work with unicorn
+namespace :load do
+  task :defaults do
+    # Add unicorn to :rbenv_map_bins
+    fetch(:rbenv_map_bins) << 'unicorn'
+
+    ###################################
+    ## capistrano3/unicorn variables
+
+    # Defines where the unicorn pid will live.
+    set :unicorn_pid, -> { "#{shared_path}/tmp/pids/unicorn.pid" }
+
+    set :unicorn_config_path, -> { "#{shared_path}/config/unicorn.rb" }
+
+    ###################################
+    ## unicorn.rb template variables
+
+    # Local path to look for custom config template
+    set :unicorn_template, -> { "config/deploy/#{fetch(:stage)}/unicorn.rb.erb" }
+
+    # The type of template to use
+    # rails, rails_activerecord
+    set :unicorn_template_type, -> { "rails_activerecord" }
+
+    # Number of workers (Rule of thumb is 2 per CPU)
+    # Just be aware that every worker needs to cache all classes and thus eat some
+    # of your RAM.
+    set :unicorn_workers, -> { 1 }
+
+    # Workers timeout in the amount of seconds below, when the master kills it and
+    # forks another one.
+    set :unicorn_workers_timeout, -> { 30 }
+
+    # The location of the unicorn socket
+    set :unicorn_socket, -> { "#{shared_path}/tmp/sockets/unicorn.sock" }
+
+    # Preload app for fast worker spawn
+    set :unicorn_preload, -> { true }
+
+    ###################################
+    ## capistrano3/nginx variables
+
+    # # Add bower to :nodenv_map_bins
+    set :app_server_socket, -> { fetch(:unicorn_socket) } if was_required? 'capistrano/nginx'
+
+  end
+end
+
+# Adds some task on complement the capistrano3-unicorn tasks
+# This tasks are under the negroku namespace for easier identification
+namespace :negroku do
+
+  namespace :unicorn do
+    desc "Upload unicorn configuration file"
+    task :setup do
+      on release_roles fetch(:unicorn_roles) do
+        within "#{shared_path}/config" do
+          config_file = fetch(:unicorn_template)
+          unless File.exists?(config_file)
+            config_file = File.expand_path("../../templates/tasks/unicorn_#{fetch(:unicorn_template_type)}.rb.erb", __FILE__)
+          end
+          config = ERB.new(File.read(config_file)).result(binding)
+          upload! StringIO.new(config), '/tmp/unicorn.rb'
+
+          execute :mv, '/tmp/unicorn.rb', 'unicorn.rb'
+        end
+      end
+    end
+
+    # Reload or restart unicorn after the application is published
+    after 'deploy:publishing', 'restart' do
+      invoke 'negroku:unicorn:setup'
+      invoke fetch(:unicorn_preload)? 'unicorn:restart' : 'unicorn:reload'
+    end
+
+    # Ensure the folders needed exist
+    after 'deploy:check', 'deploy:check:directories' do
+      on release_roles fetch(:unicorn_roles) do
+        execute :mkdir, '-pv', "#{shared_path}/config"
+        execute :mkdir, '-pv', "#{shared_path}/tmp/sockets"
+        execute :mkdir, '-pv', "#{shared_path}/tmp/pids"
+      end
+    end
+
+  end
+
+end