negroku 1.1.14 → 2.0.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c282d03f5f541227804a784fbc57381fff8ddd
-  data.tar.gz: 1fc7b07688546bd23134650dc793e1b2d2591ca9
+  metadata.gz: 827bfba759edd4825969e04d56bbec0e8c98d4ae
+  data.tar.gz: 7e624982d506520b2d10749ed70cf31705801c06
 SHA512:
-  metadata.gz: 3b5e451d53b63ef89a164636cbed57775e3f3ad0c3e4f3fad0888e9beaa7ce59cff5b0a54419717806976dd7895fc9865316375095fecd469b6c93c693da79f6
-  data.tar.gz: c10fe9ae6cd41b034aa86aab80e9f803516d61f9f37bb981996e53523580f1dd1e2968bf374c3b15ae718ef3b026201933139012e5562e48269bac94a069d621
+  metadata.gz: 5157300976ec2c0442401f1418845065e867bd32fadc83a6a6145c40f0e1d43d6f2291b138b7b85c74fcd2fa4ed032e18e90c4969b011788f9998202a53400af
+  data.tar.gz: 50065eddd201663c94b969b9f66ffbf4e19b1c5019a06434bf8d97f62379f1aa5eb3373b198b63e97e828d9ab4352deffb18d93d0a8b1a1fa71ec0597c62aec7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Juan Ignacio Donoso
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -3,211 +3,13 @@ Negroku [![Stories in Ready](https://badge.waffle.io/platanus/negroku.svg)](http
 
 Negroku is an opinionated collection of recipes for capistrano.
 
-The goal is to be able to deploy **ruby on rails applications** and **static websites** without the hassle of configuring and defining all the stuff involved in an application deployment.
+The goal is to be able to deploy **ruby on rails applications** and **static websites** without the hassle of configure and define all the stuff involved in an application deployment.
 
-All the server settings pre-defined in the configuration files generated by negroku are targeted to this server generic [configuration guide](https://github.com/platanus/guides/tree/master/deployment). Although in most cases you can customize those settings.
+All the server configurations pre-defined in the configuration files generated by negroku are targeted oto this generic [configuration guide](https://github.com/platanus/guides/tree/master/deployment).
 
-Installation
-------------
+## This is a rewrite that will use capistrano 3
 
-Install negroku as a global gem.
 
-```shell
-$ gem install negroku
-```
 
-Add the negroku gem to your `Gemfile` development group to lock the version your are going to use.
-
-```ruby
-group :development do
-    gem 'negroku', '1.1.4'
-end
-```
-
-You will need to add to your Gemfile these two gems:
-
-```ruby
-group :assets do
-    gem 'therubyracer', :platforms => :ruby
-end
-
-group :production do
-    gem 'unicorn'
-end
-```
-
-Then execute
-
-```shell
-$ bundle install
-```
-
-**Note:** Add the `therubyracer` gem only if your are going to use the assets precompile of a rails project.
-
-## Getting started
-
-1. Create your app executing the following command, and just follow the on-screen questions.
-
-    ```
-    $ negroku app create
-    ```
-
-    ####Give your application a name
-
-    This will be used to create the app folder structure in the server and to name some files, for example, the log files.
-
-
-    ####Please choose your repository
-
-    You'll need to choose the git respository where your are going to store your project. Typically a GitHub repository, it can be any repository that the server has access to.
-
-    If you have already initializated your git repository for the project, you'll be offered to choose the remotes of the current repo.
-
-    ####Target servers
-
-    You'll need to choose the server address where the project will be deployed and the hostname that will be used by *nginx* to host the application. Negroku will ask this for two stage servers (staging, production)
-
-    *Note:* Refer to the [negroku config taks](#config-task) to add some default servers to the negroku configuration.
-
-
-1. The `app create` command will bootpstrapp your app (behind the scenes it will run the capistrano command `capify .` and add some customizations)
-
-    Some files and folders will be added to your project, this is the same structure that capistrano expects when using multistage extensions
-
-    ```
-    project_root
-     |--- Capfile                       # Capistrano load file
-     +--- config
-           |--- deploy.rb               # Global setting for all environments
-           +--- deploy
-                 |--- production.rb     # Specific settings for production server
-                 +--- staging.rb        # Specific settings for staging server
-    ```
-
-1. Configure your specific settings in the files created above
-
-    ####Common settings for all stages `deploy.rb`
-
-    Here you can add all the settings that are common to all the stage severs.
-
-    ```ruby
-    #You may want to change the stages and the default stage
-    set :stages, %w(production staging)
-    set :default_stage, "staging"
-    ```
-
-
-    ####Per-stage settings `staging.rb` `production.rb`
-
-    Here you can add all the settings that are specific to the stage.
-
-    ```ruby
-    #You may want to change the repository branch for each stage.
-    set :branch,        "production"        # Optional, defaults to master
-    ```
-
-
-1. Prepare the server for your application executing
-
-    ```shell
-    $ cap deploy:setup
-    ```
-
-1. Commit and push the changes to the repository
-
-1. Configure all your environmental variables for your project using the [negroku env taks](#env-task)
-
-1. Deploy you application for the first time executing
-
-    ```shell
-    $ cap deploy:cold                # for the default stage
-    $ cap production deploy:cold     # for the production stage
-    ```
-
-    For all the next following deploys, you should execute
-
-    ```shell
-    $ cap deploy                     # for the default stage
-    $ cap production deploy          # for the production stage
-    ```
-
-The CLI
--------
-
-Negroku also provides a simple CLI that helps to initialize the deployment of your project and that wraps some tasks from its recipes collection.
-
-### App task
-
-*comming soon...*
-
-### Env task
-
-*comming soon...*
-
-### Config task
-
-*comming soon...*
-
-Included recipes
-----------------
-
-To achieve this goal negroku provides a set of pre-configured capistrano recipes and deploy configuration files in order to streamline the process to deploy a new application.
-
-### nginx tasks
-
-```
-cap nginx:reload                  # reload Nginx.
-cap nginx:restart                 # restart Nginx.
-cap nginx:setup                   # Setup nginx configuration for this applic...
-cap nginx:start                   # start Nginx.
-cap nginx:stop                    # stop Nginx.
-cap nginx:upload_ssl_certificates # Upload SSL certificates for this applicat...
-```
-
-### unicorn tasks
-
-```
-cap unicorn:add_worker            # Add a new worker
-cap unicorn:duplicate             # Duplicate Unicorn
-cap unicorn:reload                # Reload Unicorn
-cap unicorn:remove_worker         # Remove amount of workers
-cap unicorn:restart               # Restart Unicorn
-cap unicorn:setup                 # Setup unicorn configuration for this appl...
-cap unicorn:shutdown              # Immediately shutdown Unicorn
-cap unicorn:start                 # Start Unicorn master process
-cap unicorn:stop                  # Stop Unicorn
-```
-
-### logging tasks
-
-```
-cap log:app                       # Stream (tail) the application's productio...
-cap log:nginx_access              # Stream (tail) the nginx access log.
-cap log:nginx_error               # Stream (tail) the nginx error log.
-cap log:unicorn_error             # Stream (tail) the unicorn error log.
-```
-
-### rbenv task
-
-```
-cap rbenv:vars:add                # Add rbenv vars
-cap rbenv:vars:show               # Show current rbenv vars
-cap rbenv:vars:symlink            # Symlink rbenv-vars file into the current ...
-```
-
-
-Customizing the recipes
------------------------
-
-Aside of predefining some ways of doing the deployments, negroku is very flexible. This flexibility is inherited from capistrano, so you can extend negroku with your recipes, overide existing ones, and modify every configuration you want.
-
-Contributing
-------------
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
 
 

data/README.rdoc

@@ -0,0 +1,6 @@
+= negroku
+
+Describe your project here
+
+:include:negroku.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Negroku'
+end
+
+spec = eval(File.read('negroku.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/negroku

@@ -1,10 +1,2 @@
 #!/usr/bin/env ruby
-
-require 'rubygems'
-require 'capistrano'
-require 'negroku/config'
-require 'negroku/helpers'
-require 'negroku/capfile'
 require 'negroku/cli'
-
-Negroku::CLI.start

data/features/negroku.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "negroku"
+    Then the exit status should be 0

data/features/step_definitions/negroku_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/negroku/cli/bootstrap.rb

@@ -0,0 +1,139 @@
+require 'erb'
+require 'pathname'
+
+module Negroku::Bootstrap
+  extend self
+
+  def install
+
+    data = {}
+    data[:application_name] = ask_name
+    data[:repo_url] = select_repo
+
+    custom_capify select_stages, data
+
+  end
+
+  def add_stage(stage=nil)
+
+    if stage.nil?
+      name = ask_stage
+    end
+
+    custom_stage(name)
+
+  end
+
+  def remove_stage(stage=nil)
+
+    current_stages = Dir[File.join(@deploy_dir, '*.rb')].map(){|f| File.basename(f)}
+
+    if stage.nil?
+      selections = Ask.checkbox "What stages you want to remove", current_stages
+      stages_to_delete = selections.map.with_index { |v, i| current_stages[i] if v}.compact
+    else
+      stages_to_delete = ["#{stage}.rb"]
+    end
+
+    if stages_to_delete.count > 0
+      stages_to_delete.each do |s|
+        path_to_delete = File.join(@deploy_dir, s)
+        begin
+          FileUtils.rm(path_to_delete)
+        rescue
+          puts "The stage '#{s}' doesn't exist"
+        end
+      end
+    else
+      puts "Nothing to do"
+    end
+
+  end
+
+  private
+
+  @tasks_dir = Pathname.new('lib/capistrano/tasks')
+  @config_dir = Pathname.new('config')
+  @deploy_dir = @config_dir.join('deploy')
+
+  @deploy_rb = File.expand_path("../../templates/negroku/deploy.rb.erb", __FILE__)
+  @stage_rb = File.expand_path("../../templates/negroku/stage.rb.erb", __FILE__)
+  @capfile = File.expand_path("../../templates/negroku/Capfile.erb", __FILE__)
+
+  # This code was exatracted from capistrano to be used with our own templates
+  # https://github.com/capistrano/capistrano/blob/68e7632c5f16823a09c324d556a208e096abee62/lib/capistrano/tasks/install.rake
+  def custom_capify(stages, data={})
+
+    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)
+    stages.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
+
+  def custom_stage(stage, data={})
+
+  end
+
+  # Ask the application name
+  def ask_name
+    question = I18n.t :application_name, scope: :negroku
+    Ask.input question, default: File.basename(Dir.getwd)
+  end
+
+  # Ask the stage name
+  def ask_stage
+    question = I18n.t :ask_stage_name, scope: :negroku
+    Ask.input question
+  end
+
+  # Get git remotes from current git and ask to select one
+  def select_repo
+    remote_urls = %x(git remote -v 2> /dev/null | awk '{print $2}' | uniq).split("\n")
+    remote_urls << (I18n.t :other, scope: :negroku)
+
+    question = I18n.t :choose_repo_url, scope: :negroku
+    selected_idx = Ask.list question, remote_urls
+
+    if selected_idx == remote_urls.length - 1
+      question = I18n.t :type_repo_url, scope: :negroku
+      Ask.input question
+    else remote_urls[selected_idx] end
+  end
+
+  # Ask which stages to setup
+  def select_stages
+    default_stages = %w(staging production other)
+
+    question = I18n.t :choose_stages, scope: :negroku
+    selected_idx = Ask.checkbox question, default_stages
+
+    stages = selected_idx.map.with_index { |v, i| default_stages[i] if v}.compact
+
+    if selected_idx.last
+      question = "List the extra stages (comma separated)"
+      stages[0...-1].concat (Ask.input question).split(",").map(&:strip)
+    else stages end
+  end
+
+end

data/lib/negroku/cli/commands/app.rb

@@ -0,0 +1,39 @@
+module Negroku::CLI
+
+  desc 'Create and manage your app'
+  command :app do |app|
+
+    app.desc 'Bootstrap your application with capistrano and negroku'
+    app.command :create do |create|
+      create.action do |global_options,options,args|
+
+        Negroku::Bootstrap.install
+
+      end
+    end
+
+    app.desc 'Bootstrap your application with capistrano and negroku'
+    app.command :stage do |stage|
+
+      stage.desc 'Bootstrap your application with capistrano and negroku'
+      stage.command :add do |add|
+        add.action do |global_options,options,args|
+
+          Negroku::Bootstrap.add_stage
+
+        end
+      end
+
+      stage.desc 'Bootstrap your application with capistrano and negroku'
+      stage.command :remove do |remove|
+        remove.action do |global_options,options,args|
+
+          Negroku::Bootstrap.remove_stage args.first
+
+        end
+      end
+
+    end
+
+  end
+end

data/lib/negroku/cli/commands/negroku.rb

@@ -0,0 +1,15 @@
+module Negroku::CLI
+
+  # This is the default negroku command
+  # Here we'll manage the main interative cli ui
+  command :negroku do |c|
+
+    c.default_command :ask
+    c.command :ask do |s|
+      s.action do |global_options,options,args|
+
+      end
+    end
+
+  end
+end