noveku 0.5 → 0.6

data/Gemfile.lock

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

data/README.md

@@ -14,14 +14,34 @@ you should install it globally, not via bundler and your project's Gemfile.
 
 ## Usage
 
-`noveku ENV commands...`: will execute the given commands for the `ENV` remote.
+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.
 
-We strongly suggest adding shell aliases for convenience :
+`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.
 
-```shell
-alias nvp='noveku production'
-alias nvs='noveku staging'
-```
+### 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.
+
+* `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.
+
+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"]
+      url = git@heroku.com:sampleapp-preprod.git
+      fetch = +refs/heads/*:refs/remotes/staging/*
+
+### Interface
+
+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
 
@@ -37,6 +57,20 @@ This makes several other commands available, such as `restart`, `releases`, `ps`
 
 ## Advanced commands
 
+### 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.
+
+### MongoDB
+
 * `mongodump`: Dumps the mongo database. Shortcut for both `mongolab_dump` and `mongohq_dump`: tries mongolab first, then mongohq.
 * `mongolab_dump`: Dumps the mongo database. Look in the config keys of `ENV` to find `MONGOLAB_URI`.
 * `mongohq_dump`: Dumps the mongo database. Look in the config keys of `ENV` to find `MONGOHQ_URL`.
@@ -58,6 +92,7 @@ I plan on adding a command allowing you to create a heroku app, setup your addon
 
 ## Changelog
 
+* `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.
 * `0.3`: Added `mongodump`, `mongolab_dump`, `mongohq_dump`.

data/lib/noveku/cli/base.rb

@@ -0,0 +1,73 @@
+module Noveku
+  module CLI
+    class Base
+      attr_reader :commands
+
+      # Extract commands & options
+      def initialize(*commands)
+        @options = (commands.last.is_a?(Hash) && commands.pop) || {}
+        @commands = commands
+      end
+
+      # Only print
+      def dry_run?
+        @options[:dry_run]
+      end
+
+      # Print & execute
+      def verbose?
+        @options[:verbose]
+      end
+
+      # Hide stderr ?
+      def hide_stderr?
+        !!(@options[:hide_stderr])
+      end
+
+      # Hide stderr ?
+      def hide_stdout?
+        !!(@options[:hide_stdout])
+      end
+
+      # Hide stderr & stdout ?
+      def hide_both?
+        hide_stderr? && hide_stdout?
+      end
+
+      # Execute the commands
+      def call
+        print if dry_run? || verbose?
+        system(command) unless dry_run?
+      end
+
+      # Only print the command
+      def print
+        puts command
+      end
+
+      # The command template, with stream redirection handled
+      def template_command_with_output_cleaned(*args)
+        base = template_command(*args)
+
+        stream = if hide_both?
+          '&'
+        elsif hide_stderr?
+          '2'
+        elsif hide_stdout?
+          '1'
+        end
+
+        base = "#{base} #{stream}> /dev/null" if stream
+        base
+      end
+
+      # Command string to execute
+      def command
+        return nil unless commands
+
+        # Map commands to template & chain
+        commands.map(&method(:template_command_with_output_cleaned)).join(' && ')
+      end
+    end
+  end
+end

data/lib/noveku/cli/git.rb

@@ -0,0 +1,12 @@
+require 'noveku/cli/base'
+
+module Noveku
+  module CLI
+    class Git < Base
+      # Template for commands
+      def template_command(command)
+        "git #{command}"
+      end
+    end
+  end
+end

data/lib/noveku/cli/heroku.rb

@@ -0,0 +1,20 @@
+require 'noveku/cli/base'
+
+module Noveku
+  module CLI
+    class Heroku < Base
+      attr_reader :environment
+
+      # Extract environment from commands
+      def initialize(*commands)
+        super
+        @environment = @commands.shift
+      end
+
+      # Template for commands
+      def template_command(command)
+        "heroku #{command} --remote '#{environment}'"
+      end
+    end
+  end
+end

data/lib/noveku/config.rb

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

data/lib/noveku/console.rb

@@ -6,7 +6,7 @@ module Noveku
 
     # Open the console
     def console_cmd
-      execute console_cmd_str
+      execute_heroku console_cmd_str
     end
   end
 end

data/lib/noveku/core.rb

@@ -1,25 +1,33 @@
+require 'noveku/cli/git'
+require 'noveku/cli/heroku'
 require 'noveku/config'
-require 'noveku/exceptions'
-require 'noveku/rake'
 require 'noveku/console'
+require 'noveku/deploy'
+require 'noveku/exceptions'
 require 'noveku/migrate'
+require 'noveku/mongo'
+require 'noveku/options'
 require 'noveku/proxy'
+require 'noveku/push'
+require 'noveku/rake'
 require 'noveku/tail'
-require 'noveku/mongo'
 
 module Noveku
   # Common functionnality
   class Core
     include Config
     include Exceptions
+    include Options
     # Aliases
-    include Rake
     include Console
     include Migrate
     include Proxy
+    include Rake
     include Tail
     # Advanced Features
+    include Deploy
     include Mongo
+    include Push
 
     attr_reader :environment, :command, :arguments
 
@@ -41,22 +49,37 @@ module Noveku
       send "#{@command}_cmd"
     end
 
+    # Prefix of heroku git remotes
+    def prefix
+      "heroku"
+    end
+
+    # Environment
+    alias :branch :environment
+
+    # Name of heroku remote
+    def remote
+      "#{prefix}-#{environment}"
+    end
+
     private
 
     # Execute the commands
-    def execute(*commands)
-      system executable_command(*commands)
-    end
+    def execute_heroku(*commands)
+      options = (commands.last.is_a?(Hash) && commands.pop) || {}
+      options = {dry_run: dry_run?, verbose: verbose?}.merge(options)
 
-    # Build command to execute
-    def executable_command(*commands)
-      return nil unless commands
+      h = Noveku::CLI::Heroku.new environment, *commands, options
+      h.()
+    end
 
-      # Template proc
-      template = ->(command) { "heroku #{command} --remote '#{environment}'" }
+    # Execute the commands
+    def execute_git(*commands)
+      options = (commands.last.is_a?(Hash) && commands.pop) || {}
+      options = {dry_run: dry_run?, verbose: verbose?}.merge(options)
 
-      # Map commands to template & chain
-      commands.map(&template).join(' && ')
+      g = Noveku::CLI::Git.new *commands, options
+      g.()
     end
   end
 end

data/lib/noveku/deploy.rb

@@ -0,0 +1,12 @@
+module Noveku
+  module Deploy
+    def deploy_cmd_str
+      "push #{remote} #{branch}:master"
+    end
+
+    # Open the console
+    def deploy_cmd
+      execute_git(deploy_cmd_str)
+    end
+  end
+end

data/lib/noveku/exceptions.rb

@@ -21,7 +21,7 @@ module Noveku
     # Check if there is a matching heroku app
     def ensure_heroku_app
       # This env is used for testing
-      return if environment == 'noveku-safe-env'
+      return if @environment == 'noveku-safe-env'
 
       system "heroku releases --remote '#{environment}' >& /dev/null"
 

data/lib/noveku/migrate.rb

@@ -7,7 +7,7 @@ module Noveku
 
     # Open the console
     def migrate_cmd
-      execute *migrate_cmd_args
+      execute_heroku *migrate_cmd_args
     end
   end
 end

data/lib/noveku/options.rb

@@ -0,0 +1,15 @@
+module Noveku
+  module Options
+    def verbose?
+      arguments.include?('--verbose')
+    end
+
+    def dry_run?
+      arguments.include?('--dry-run')
+    end
+
+    def proxied_arguments
+      arguments.reject { |a| %w(--verbose --dry-run).include?(a) }
+    end
+  end
+end

data/lib/noveku/proxy.rb

@@ -2,13 +2,13 @@ module Noveku
   module Proxy
     # String to execute when proxying commands
     def proxy_cmd_str
-      ([@command] + @arguments).join(' ')
+      ([@command] + proxied_arguments).join(' ')
     end
 
     # If this is a command with no specific support, pass the raw arguments to `heroku` directly
     def method_missing(name, *args, &block)
       if name.to_s.end_with?('_cmd')
-        execute proxy_cmd_str
+        execute_heroku proxy_cmd_str
       else
         super
       end

data/lib/noveku/push.rb

@@ -0,0 +1,12 @@
+module Noveku
+  module Push
+    def push_cmd_str
+      "push origin #{environment}"
+    end
+
+    # Open the console
+    def push_cmd
+      execute_git(push_cmd_str)
+    end
+  end
+end

data/lib/noveku/rake.rb

@@ -9,7 +9,7 @@ module Noveku
 
     # Execute a rake task
     def rake_cmd
-      execute rake_cmd_str
+      execute_heroku rake_cmd_str
     end
   end
 end

data/lib/noveku/tail.rb

@@ -7,7 +7,7 @@ module Noveku
 
     # Tail logs
     def tail_cmd
-      execute tail_cmd_str
+      execute_heroku tail_cmd_str
     end
   end
 end

data/lib/noveku/version.rb

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

data/spec/core_spec.rb

@@ -11,8 +11,16 @@ describe 'Core' do
   context 'commands' do
     subject { Noveku::Core.new 'noveku-safe-env', 'rake', 'stats' }
 
+    it 'prefix should be "heroku"' do
+      expect(subject.prefix).to eq 'heroku'
+    end
+
     it 'environment should be the first command' do
-      expect(subject.environment).to eq 'noveku-safe-env'
+      expect(subject.environment).to eq "noveku-safe-env"
+    end
+
+    it 'remote should be the prefixed environment' do
+      expect(subject.remote).to eq "#{subject.prefix}-#{subject.environment}"
     end
 
     it 'main command should be the second command' do
@@ -22,15 +30,5 @@ describe 'Core' do
     it 'argument should be the remaining' do
       expect(subject.arguments).to eq ['stats']
     end
-
-    it 'string to execute should contain given command' do
-      str = "heroku run rake stats --remote 'noveku-safe-env'"
-      expect(subject.send(:executable_command, 'run rake stats')).to eq str
-    end
-
-    it 'string to execute should chain given command' do
-      str = "heroku run rake stats --remote 'noveku-safe-env' && heroku releases --remote 'noveku-safe-env'"
-      expect(subject.send(:executable_command, 'run rake stats', 'releases')).to eq str
-    end
   end
 end

data/spec/deploy_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'noveku/core'
+
+describe 'Deploy' do
+  subject { Noveku::Core.new 'noveku-safe-env', 'deploy' }
+
+  it 'must have an executable command string' do
+    expect(subject.deploy_cmd_str).to eq "push #{subject.prefix}-noveku-safe-env noveku-safe-env:master"
+  end
+end

data/spec/heroku_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'noveku/cli/heroku'
+
+describe 'CLI' do
+  context 'Heroku' do
+    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'"
+      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'"
+      expect(heroku.command).to eq str
+    end
+  end
+end

data/spec/options_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'noveku/core'
+
+describe 'Options handler' do
+  context 'Dry run' do
+    subject { Noveku::Core.new 'noveku-safe-env', 'anycommandyoulike', '--dry-run' }
+
+    it 'recognizes the long form option' do
+      expect(subject.dry_run?).to be_true
+    end
+
+    it 'does not proxy the option' do
+      expect(subject.proxied_arguments).not_to include '--dry-run'
+    end
+  end
+
+  context 'Verbose' do
+    subject { Noveku::Core.new 'noveku-safe-env', 'anycommandyoulike', '--verbose' }
+
+    it 'recognizes the long form option' do
+      expect(subject.verbose?).to be_true
+    end
+
+    it 'does not proxy the option' do
+      expect(subject.proxied_arguments).not_to include '--verbose'
+    end
+  end
+end

data/spec/push_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'noveku/core'
+
+describe 'Push' do
+  subject { Noveku::Core.new 'noveku-safe-env', 'push' }
+
+  it 'must have an executable command string' do
+    expect(subject.push_cmd_str).to eq "push origin #{subject.environment}"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noveku
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gomon
@@ -77,13 +77,19 @@ files:
 - Rakefile
 - bin/noveku
 - lib/noveku.rb
+- lib/noveku/cli/base.rb
+- lib/noveku/cli/git.rb
+- lib/noveku/cli/heroku.rb
 - lib/noveku/config.rb
 - lib/noveku/console.rb
 - lib/noveku/core.rb
+- lib/noveku/deploy.rb
 - lib/noveku/exceptions.rb
 - lib/noveku/migrate.rb
 - lib/noveku/mongo.rb
+- lib/noveku/options.rb
 - lib/noveku/proxy.rb
+- lib/noveku/push.rb
 - lib/noveku/rake.rb
 - lib/noveku/tail.rb
 - lib/noveku/version.rb
@@ -91,9 +97,13 @@ files:
 - spec/config_spec.rb
 - spec/console_spec.rb
 - spec/core_spec.rb
+- spec/deploy_spec.rb
+- spec/heroku_spec.rb
 - spec/migrate_spec.rb
 - spec/mongo_spec.rb
+- spec/options_spec.rb
 - spec/proxy_spec.rb
+- spec/push_spec.rb
 - spec/rake_spec.rb
 - spec/spec_helper.rb
 - spec/tail_spec.rb