noveku 0.6 → 0.7

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    noveku (0.5)
+    noveku (0.7)
       gomon
 
 GEM

data/README.md

@@ -1,39 +1,48 @@
 # Noveku
 
-A collection of aliases we use when interacting with heroku.
+A console utility easing up interactions with heroku when you have several heroku apps for one project (most common use case: production and staging environments for a webapp).
 This gem was inspired by [a collection of thoughtbot aliases](https://github.com/thoughtbot/dotfiles/commit/86494030441e88ef9c2e2ceaa00a4da82023e445).
 
 ## Prerequisites
 
-Ruby 1.9+ only. This gem depends on novelys/gomon. However, the presence of the command `heroku` (either via the gem, or the toolbelt) is assumed
+Ruby 1.9+ only. This gem depends on novelys/gomon. However, the presence of the commands `heroku` and `git` is assumed.
 
 ## Installation
 
-`gem install noveku`. Since it will not be part of your application, only of your workflow,
-you should install it globally, not via bundler and your project's Gemfile.
+`gem install noveku`
 
 ## Usage
 
-This gem is developed with Rails 3+ in mind. However, it should be suited to any project with a notion of "app environment", with different heroku apps for these environments.
+This gem is developed with Rails 3+ in mind. 
 
-`noveku production COMMAND` translate `COMMAND` in the context of the heroku remote `heroku-production`. When pushing/deploying, the local source branche is `production`. Please read the next two paragraphs for more detailed explications.
+However, it should be suited to any project with a notion of "app environment",
+with different heroku apps for these environments.
+It is assumed that your apps are using the cedar stack.
+While some commands might work for other stacks, this is purely coincidental.
+
+`noveku ENV COMMAND` means that `COMMAND` will be executed for the heroku app with the remote named `heroku-ENV`.
+In the case of the commands `push` and `deploy`, the local branch used as source is `ENV`.
+Please read the next two paragraphs for detailed explications.
 
 ### Conventions
 
 This gem makes a few assumptions about how your branches and remotes are named.
-This is *not* configurable, and that there is no plans to change this.
+This is *not* configurable, and there is no plans to change this.
 
-* `origin` is the main git remote, pointing towards github, bitbucket, or any other server.
+* `origin` is the main git remote, pointing towards GitHub, BitBucket, or any other server.
 * if you have a branch named `novelys`, the heroku git remote corresponding this branch is assumed to be `heroku-novelys`.
 
-Our git flow at Novelys is pretty straightforward : the branch `master` is the current version of the app; `staging` is the pre-production version; `production` the production one.
+Our git flow at Novelys is pretty straightforward :
+the branch `master` is the current version of the app;
+`staging` is the pre-production version;
+`production` the production one.
 
 This translates to two heroku apps (the name of the apps does not matter), and the remotes named `heroku-staging` and `heroku-master` :
 
     [remote "heroku-production"]
       url = git@heroku.com:sampleapp.git
       fetch = +refs/heads/*:refs/remotes/production/*
-    [remote "heroky-staging"]
+    [remote "heroku-staging"]
       url = git@heroku.com:sampleapp-preprod.git
       fetch = +refs/heads/*:refs/remotes/staging/*
 
@@ -43,31 +52,35 @@ Considering what is written above :
 
 `noveku ENV COMMAND`: will execute the given `COMMAND` in the context of the `ENV` local branch and `heroku-ENV` heroku git remote.
 
-## Heroku commands
+## Commands
+
+When giving a command that has no specific support, it will be proxied to `heroku` : `heroku ARGS --remote ENV`.  
+This makes several other commands available, such as `restart`, `releases`, `ps`, `open`...
+
+### Common options
+
+Exception made of mongodb related commands, they all accept the following options:
+
+* `--dry-run`: only prints the git command that is going to be executed, without executing it;
+* `--verbose`: prints the git command that is going to be executed, and then execute it.
+
+### Heroku 
 
 Supported commands and their equivalent : 
 
-* `rake` : `heroku run rake ARGS --remove ENV`
+* `rake ARGS` : `heroku run rake ARGS --remove ENV`
 * `console`: `heroku run console --remote ENV`
 * `migrate`: `heroku run rake db:migrate --remote ENV && heroku restart --remote ENV`
 * `tail`: `heroku logs --tail --remote ENV`
-
-When giving a command that is not specifically supported, it will be passed to `heroku` : `heroku ARGS --remote ENV`.  
-This makes several other commands available, such as `restart`, `releases`, `ps`, `open`...
-
-## Advanced commands
+* `create APP_NAME ENV [ADDONS...]`: creates `APP_NAME` bound to the remote `heroku-ENV`. Each listed addon will be added right away. If any part of the subcommand fails, the remaining will not be executed.
+* `clone APP_NAME NEW_ENV BASE_ENV [ADDONS...]`: creates APP_NAME bound to the remote `heroku-NEW_ENV`, and adds every addon from `BASE_ENV`.
 
 ### Git
 
 Those commands are shortcuts for other git commands.
 
-* `push`: Push your changes in your local branch to the `origin` remote.
-* `deploy`: Push your changes in your local branch to the heroku remote.
-
-They accept the following options:
-
-* `--dry-run`: only prints the git command that is going to be executed, without executing it;
-* `--verbose`: prints the git command that is going to be executed, and then execute it.
+* `push`: `git push origin ENV`, push your changes in your local branch to the `origin` remote.
+* `deploy`: `git push heroku-ENV ENV:master`, push your changes in your local branch to the heroku remote.
 
 ### MongoDB
 
@@ -81,7 +94,7 @@ Since the restoration of the database does not involve any interaction with hero
 
 ## What's next
 
-I plan on adding a command allowing you to create a heroku app, setup your addons, update your git config, create a local branch if needed.. all that in one step. We're still thinking about what the command api will look like. This will probably be the last feature before tagging 1.0.0.
+Better test coverage. This will be bumped to `1.0.0` once this is done and after using the gem in our daily flow for a few weeks.
 
 ## Contributions
 
@@ -92,6 +105,7 @@ I plan on adding a command allowing you to create a heroku app, setup your addon
 
 ## Changelog
 
+* `0.7`: Adds `create` and `clone`.
 * `0.6`: Adds `deploy` and `push`; assumes heroku remotes are prefixed with `heroku-`; enhanced README; internal refactoring.
 * `0.5`: Test coverage, check the presence of environment & that it matches a heroku app, that pwd is a heroku app, the presence of mongohq/lab uri.
 * `0.4`: Require `gomon` for mongodump, changed executable names, internal refactoring.

data/lib/noveku/addon.rb

@@ -0,0 +1,31 @@
+module Noveku
+  module Addon
+    # Command string to add an addon
+    def addon_cmd_str(name)
+      "addons:add #{name}"
+    end
+
+    # Command string to list addons for current env
+    def raw_list_addons_str
+      "addons"
+    end
+
+    # Get the raw list of addons
+    def raw_list_addons
+      heroku = get_heroku raw_list_addons_str
+
+      `#{heroku.command}`
+    end
+
+    # Clean the list of addons
+    def cleaned_addons_list
+      return @addons if @addons
+
+      @addons = raw_list_addons.split("\n")
+      @addons.reject! { |addon| addon.start_with?('===') }
+      @addons.map! { |addon| addon.split(' ').first }
+      @addons.uniq!
+      @addons
+    end
+  end
+end

data/lib/noveku/cli/base.rb

@@ -2,6 +2,7 @@ module Noveku
   module CLI
     class Base
       attr_reader :commands
+      attr_accessor :noveku
 
       # Extract commands & options
       def initialize(*commands)
@@ -42,12 +43,12 @@ module Noveku
 
       # Only print the command
       def print
-        puts command
+        puts ">> Command to be executed: #{command}"
       end
 
       # The command template, with stream redirection handled
-      def template_command_with_output_cleaned(*args)
-        base = template_command(*args)
+      def template_command_with_output_cleaned(command)
+        base = template_command(command)
 
         stream = if hide_both?
           '&'

data/lib/noveku/cli/heroku.rb

@@ -13,7 +13,7 @@ module Noveku
 
       # Template for commands
       def template_command(command)
-        "heroku #{command} --remote '#{environment}'"
+        "heroku #{command} --remote '#{noveku.remote}'"
       end
     end
   end

data/lib/noveku/clone.rb

@@ -0,0 +1,23 @@
+module Noveku
+  module Clone
+    # Clone args
+    def clone_cmd_args
+      base = ["apps:create #{@app_name}"]
+
+      cleaned_addons_list.each { |addon| base << addon_cmd_str(addon) }
+
+      base
+    end
+
+    # Clone command
+    def clone_cmd
+      # Get the command from base env...
+      commands = clone_cmd_args
+
+      # Switch to new env and execute
+      @environment = @new_environment
+
+      execute_heroku *commands
+    end
+  end
+end

data/lib/noveku/config.rb

@@ -6,8 +6,8 @@ module Noveku
 
     # Returns config value for key
     def config_value_for(key)
-      cmd = execute_heroku config_value_str(key), hide_stderr: true
-      value = `#{cmd}`.strip
+      heroku = get_heroku config_value_str(key), hide_stderr: true
+      value = `#{heroku.command}`.strip
       value = nil if value == ''
       value
     end

data/lib/noveku/core.rb

@@ -1,7 +1,10 @@
+require 'noveku/addon'
 require 'noveku/cli/git'
 require 'noveku/cli/heroku'
+require 'noveku/clone'
 require 'noveku/config'
 require 'noveku/console'
+require 'noveku/create'
 require 'noveku/deploy'
 require 'noveku/exceptions'
 require 'noveku/migrate'
@@ -25,6 +28,9 @@ module Noveku
     include Rake
     include Tail
     # Advanced Features
+    include Addon
+    include Clone
+    include Create
     include Deploy
     include Mongo
     include Push
@@ -35,11 +41,18 @@ module Noveku
     def initialize(*arguments)
       @environment = arguments.shift
 
-      ensure_env
-      ensure_heroku_app
+      if environmentless_command?
+        arguments.unshift @environment
+        @environment = nil
+      else
+        ensure_env
+        ensure_heroku_app
+      end
 
       @command     = arguments.shift
       @arguments   = arguments
+
+      post_arguments_handling
     rescue Exception => e
       handle_exception(e)
     end
@@ -64,22 +77,61 @@ module Noveku
 
     private
 
-    # Execute the commands
-    def execute_heroku(*commands)
+    # Post treatment of arguments in some cases
+    def post_arguments_handling
+      return unless environmentless_command?
+
+      send "#{command}_arguments_handling"
+    end
+
+    # Arguments handling for `create` command
+    def create_arguments_handling
+      @app_name = arguments.shift
+      @environment = arguments.shift
+
+      raise ArgumentError, '`create` expects an app name: noveku create APPNAME ENV [addons...]' unless @app_name
+      raise ArgumentError, '`create` expects an env name: noveku create APPNAME ENV [addons...]' unless @environment
+    end
+
+    # Arguments handling for `clone` command
+    def clone_arguments_handling
+      @app_name = arguments.shift
+      @new_environment = arguments.shift
+      @environment = arguments.shift
+
+      raise ArgumentError, '`clone` expects an app name: noveku clone APPNAME NEW_ENV BASE_ENV' unless @app_name
+      raise ArgumentError, '`clone` expects a new env name: noveku clone APPNAME NEW_ENV BASE_ENV' unless @new_environment
+      raise ArgumentError, '`clone` expects a base env name: noveku clone APPNAME NEW_ENV BASE_ENV' unless @environment
+    end
+
+    # Retrieve heroku object setup
+    def get_heroku(*commands)
       options = (commands.last.is_a?(Hash) && commands.pop) || {}
       options = {dry_run: dry_run?, verbose: verbose?}.merge(options)
 
       h = Noveku::CLI::Heroku.new environment, *commands, options
-      h.()
+      h.noveku = self
+      h
     end
 
     # Execute the commands
-    def execute_git(*commands)
+    def execute_heroku(*commands)
+      get_heroku(*commands).call
+    end
+
+    # Retrieve heroku object setup
+    def get_git(*commands)
       options = (commands.last.is_a?(Hash) && commands.pop) || {}
       options = {dry_run: dry_run?, verbose: verbose?}.merge(options)
 
       g = Noveku::CLI::Git.new *commands, options
-      g.()
+      g.noveku = self
+      g
+    end
+
+    # Execute the commands
+    def execute_git(*commands)
+      get_git(*commands).call
     end
   end
 end

data/lib/noveku/create.rb

@@ -0,0 +1,17 @@
+module Noveku
+  module Create
+    # Create args
+    def create_cmd_args
+      base = ["apps:create #{@app_name}"]
+
+      proxied_arguments.each { |addon| base << addon_cmd_str(addon) }
+
+      base
+    end
+
+    # Open the console
+    def create_cmd
+      execute_heroku *create_cmd_args
+    end
+  end
+end

data/lib/noveku/exceptions.rb

@@ -13,6 +13,11 @@ module Noveku
   module Exceptions
     private
 
+    # Some commands do not require an environment supplied
+    def environmentless_command?
+      @envless ||= (environment && ['create', 'clone'].include?(environment))
+    end
+
     # Check if environment is present
     def ensure_env
       raise NotAValidEnvironment unless @environment
@@ -23,7 +28,7 @@ module Noveku
       # This env is used for testing
       return if @environment == 'noveku-safe-env'
 
-      system "heroku releases --remote '#{environment}' >& /dev/null"
+      system "heroku releases --remote '#{remote}' >& /dev/null"
 
       raise NoHerokuApp unless $?.exitstatus == 0
     end

data/lib/noveku/version.rb

@@ -1,3 +1,3 @@
 module Noveku
-  VERSION = '0.6'
+  VERSION = '0.7'
 end

data/spec/clone_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'noveku/core'
+
+describe 'Clone' do
+  let(:app_less) { Noveku::Core.new 'clone' }
+  let(:new_env_less) { Noveku::Core.new 'clone', 'newapp' }
+  let(:base_env_less) { Noveku::Core.new 'clone', 'newapp', 'new-env' }
+  subject { Noveku::Core.new 'clone', 'newapp', 'new-env', 'base-env' }
+
+  it 'should have the app name supplied' do
+    expect(-> {app_less}).to raise_error(ArgumentError)
+  end
+
+  it 'should have the new env name supplied' do
+    expect(-> {new_env_less}).to raise_error(ArgumentError)
+  end
+
+  it 'should have the base env name supplied' do
+    expect(-> {base_env_less}).to raise_error(ArgumentError)
+  end
+
+  it 'should be environmentless' do
+    expect(subject.send(:environmentless_command?)).to be_true
+  end
+end

data/spec/create_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'noveku/core'
+
+describe 'Create' do
+  let(:app_less) { Noveku::Core.new 'create' }
+  let(:env_less) { Noveku::Core.new 'create', 'newapp' }
+  subject { Noveku::Core.new 'create', 'newapp', 'env-name' }
+
+  it 'should have the app name supplied' do
+    expect(-> {app_less}).to raise_error(ArgumentError)
+  end
+
+  it 'should have the env name supplied' do
+    expect(-> {env_less}).to raise_error(ArgumentError)
+  end
+
+  it 'should be environmentless' do
+    expect(subject.send(:environmentless_command?)).to be_true
+  end
+
+  it 'should have a prefixed remote' do
+    expect(subject.remote).to eq "#{subject.prefix}-env-name"
+  end
+
+  context 'Without addons' do
+    it 'must have an executable command string' do
+      expect(subject.create_cmd_args).to eq ['apps:create newapp']
+    end
+  end
+
+  context 'With addons' do
+    subject { Noveku::Core.new 'create', 'newapp', 'env-name', 'addon:1', 'otherone' }
+
+    it 'must have an executable command string' do
+      expect(subject.create_cmd_args).to eq ['apps:create newapp', 'addons:add addon:1', 'addons:add otherone']
+    end
+  end
+end

data/spec/heroku_spec.rb

@@ -1,17 +1,22 @@
 require 'spec_helper'
+require 'noveku/core'
 require 'noveku/cli/heroku'
 
 describe 'CLI' do
   context 'Heroku' do
+    let(:core) { Noveku::Core.new 'noveku-safe-env', 'notrelevant'}
+
     it 'string to execute should contain given command' do
       heroku = Noveku::CLI::Heroku.new 'noveku-safe-env', 'run rake stats'
-      str = "heroku run rake stats --remote 'noveku-safe-env'"
+      heroku.noveku = core
+      str = "heroku run rake stats --remote '#{heroku.noveku.prefix}-noveku-safe-env'"
       expect(heroku.command).to eq str
     end
 
     it 'string to execute should chain given command' do
       heroku = Noveku::CLI::Heroku.new 'noveku-safe-env', 'run rake stats', 'releases'
-      str = "heroku run rake stats --remote 'noveku-safe-env' && heroku releases --remote 'noveku-safe-env'"
+      heroku.noveku = core
+      str = "heroku run rake stats --remote '#{heroku.noveku.prefix}-noveku-safe-env' && heroku releases --remote '#{heroku.noveku.prefix}-noveku-safe-env'"
       expect(heroku.command).to eq str
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noveku
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gomon
@@ -69,6 +69,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
@@ -77,12 +78,15 @@ files:
 - Rakefile
 - bin/noveku
 - lib/noveku.rb
+- lib/noveku/addon.rb
 - lib/noveku/cli/base.rb
 - lib/noveku/cli/git.rb
 - lib/noveku/cli/heroku.rb
+- lib/noveku/clone.rb
 - lib/noveku/config.rb
 - lib/noveku/console.rb
 - lib/noveku/core.rb
+- lib/noveku/create.rb
 - lib/noveku/deploy.rb
 - lib/noveku/exceptions.rb
 - lib/noveku/migrate.rb
@@ -94,9 +98,11 @@ files:
 - lib/noveku/tail.rb
 - lib/noveku/version.rb
 - noveku.gemspec
+- spec/clone_spec.rb
 - spec/config_spec.rb
 - spec/console_spec.rb
 - spec/core_spec.rb
+- spec/create_spec.rb
 - spec/deploy_spec.rb
 - spec/heroku_spec.rb
 - spec/migrate_spec.rb