gitpusshuten 0.0.4 → 0.0.5

data/.rspec

@@ -0,0 +1 @@
+--format Fuubar

data/Gemfile

@@ -6,4 +6,5 @@ group :test do
   gem 'rspec'
   gem 'mocha'
   gem 'infinity_test'
+  gem 'fuubar'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitpusshuten (0.0.3)
+    gitpusshuten (0.0.5)
       activesupport (~> 3.0.0)
       highline (~> 1.6.0)
       json (~> 1.4.0)
@@ -14,6 +14,10 @@ GEM
   specs:
     activesupport (3.0.1)
     diff-lcs (1.1.2)
+    fuubar (0.0.2)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+      ruby-progressbar (~> 0.0.9)
     highline (1.6.1)
     infinity_test (0.2.0)
       watchr (>= 0.7)
@@ -32,9 +36,11 @@ GEM
     rspec-core (2.0.1)
     rspec-expectations (2.0.1)
       diff-lcs (>= 1.1.2)
+    rspec-instafail (0.1.4)
     rspec-mocks (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
+    ruby-progressbar (0.0.9)
     watchr (0.7)
 
 PLATFORMS
@@ -42,6 +48,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (~> 3.0.0)
+  fuubar
   gitpusshuten!
   highline (~> 1.6.0)
   infinity_test

data/lib/gitpusshuten/command.rb

@@ -125,6 +125,7 @@ module GitPusshuTen
       puts "\nGit Pusshu Ten\n\s\s\s\sプッシュ天\n\n"
       puts "[Command]\n\n\s\s#{y(command)}\n\n"
       puts "[Description]\n\n\s\s#{get_constant_for(command).description}\n\n"
+      puts "#{get_constant_for(command).long_description.gsub(/^/, "\s\s")}\n\n" unless get_constant_for(command).long_description.nil?
       puts "[Usage]\n\n\s\s#{y get_constant_for(command).usage}\n\n"
       puts "[Examples]\n#{get_constant_for(command).example}\n\n"
       puts "For a list of all commands: #{y 'heavenly help'}"

data/lib/gitpusshuten/commands/base.rb

@@ -20,7 +20,15 @@ module GitPusshuTen
 
       ##
       # Contains the invoked command
-      attr_accessor :command
+      attr_writer :command
+      
+      ##
+      # Returns the underscored version of the command if it's a string
+      # otherwise just return the unmodified value (probably nil)
+      def command
+        return @command.underscore if @command.is_a?(String)
+        @command
+      end
 
       ##
       # This is a flag, that, when set to true, will invoke the
@@ -42,6 +50,17 @@ module GitPusshuTen
         end
       end
 
+      ##
+      # This is used by the "help" command to display the
+      # long version of the description
+      def self.long_description(value = nil)
+        if value.nil?
+          @long_description
+        else
+          @long_description = value
+        end
+      end
+
       ##
       # This is used by the "help" command to display the
       # usage of the command in the CLI
@@ -206,7 +225,9 @@ module GitPusshuTen
         ##
         # Connect to the remote environment and perform the pre deploy hooks
         hooks.render_commands(hooks.pre_hooks).each do |name, commands|
-          GitPusshuTen::Log.message("Performing pre deploy hook: #{y(name)}")
+          adjusted_name = name.sub(/^\d+\)\s/, '')
+          
+          GitPusshuTen::Log.message("Performing pre deploy hook: #{y(adjusted_name)}")
           standard environment.execute_as_user("cd '#{e.app_dir}'; #{commands}")
         end
       end
@@ -224,7 +245,9 @@ module GitPusshuTen
         ##
         # Connect to the remote environment and perform the post deploy hooks
         hooks.render_commands(hooks.post_hooks).each do |name, commands|
-          GitPusshuTen::Log.message("Performing post deploy hook: #{y(name)}")
+          adjusted_name = name.sub(/^\d+\)\s/, '')
+          
+          GitPusshuTen::Log.message("Performing post deploy hook: #{y(adjusted_name)}")
           standard environment.execute_as_user("cd '#{e.app_dir}'; #{commands}")
         end
       end
@@ -241,6 +264,16 @@ module GitPusshuTen
         e.execute_as_user('')
       end
 
+      ##
+      # Will check to see if the user exists, if it doesn't then it'll
+      # display an error telling the user to set up a user first
+      def requires_user_existence!
+        if not e.user_exists?
+          error "You have to setup your user before you can perform this action."
+          exit
+        end
+      end
+
     end
   end
 end

data/lib/gitpusshuten/configuration.rb

@@ -118,5 +118,11 @@ module GitPusshuTen
       self
     end
 
+    ##
+    # Returns a (simple) sanitized version of the application name
+    def sanitized_app_name
+      application.gsub(' ', '_').downcase
+    end
+
   end
 end

data/lib/gitpusshuten/hooks.rb

@@ -132,14 +132,21 @@ module GitPusshuTen
     # Takes an array of hooks and renders them a Hash that
     # contains the name of the hook, as well as all the commands
     # bundled in a single string, separated by semi-colons.
+    #
+    # Note: Using a hack to avoid "Hash" sorting issues between Ruby versions
+    # which cause the hooks to invoke in the incorrect order. This has been addressed
+    # by prefixing the Hash's "key" with the index of the array and sorting based on that.
+    # Then the \d+\)\s gets #sub'd for friendly user output 
     def render_commands(hooks)
       hooks_hash = {}
-      hooks.each do |hook|
-        hooks_hash[hook.name] = ''
+      
+      hooks.each_with_index do |hook, index|
+        hooks_hash["#{index}) #{hook.name}"] = ''
         hook.commands.each do |command|
-          hooks_hash[hook.name] << "#{command};".gsub(/;{2,}/, ';')
+          hooks_hash["#{index}) #{hook.name}"] += "#{command};".gsub(/;{2,}/, ';')
         end
       end
+      
       hooks_hash
     end
 

data/lib/gitpusshuten/log.rb

@@ -5,7 +5,7 @@ module GitPusshuTen
     ##
     # Displays a regular message without prefix
     def self.standard(message)
-      puts message
+      puts message unless message.nil?
       to_file message
     end
     

data/lib/gitpusshuten/modules/active_record/command.rb

@@ -0,0 +1,222 @@
+# encoding: utf-8
+module GitPusshuTen
+  module Commands
+    class ActiveRecord < GitPusshuTen::Commands::Base
+      description       "[Module] Active Record commands."
+      long_description  "By using the Active Record CLI utility you can avoid checking your database.yml into your git repository.\n" +
+                        "Use the examples below to create, and then upload your custom database.yml for the desired environment to the server\n" +
+                        "and the Active Record module will handle the rest! After the deployment of your application this uploaded database.yml file will\n" +
+                        "be placed inside your APP_ROOT/config/database.yml. If the database.yml file already exists there, it'll overwrite it.\n" +
+                        "This is a security measure, since it's generally bad practice to store any sensitive information in your Git repository."
+                        
+      usage             "active_record <command> for <enviroment>"
+      example           "heavenly active_record create_configuration    # Creates a template for your remote database."
+      example           "                       create_config           # Alias."  
+      example           "heavenly active_record upload_configuration    # Uploads your configuration file to the remote server."
+      example           "                       upload_config           # Alias."
+      example           "heavenly active_record download_configuration  # Downloads your configuration file from the remote server."
+      example           "                       download_config         # Alias."
+
+      def initialize(*objects)
+        super
+        
+        ##
+        # Set the command
+        @command = cli.arguments.shift
+        
+        ##
+        # Display the help screen if either the command
+        # or environment name hasn't been set
+        help if command.nil? or e.name.nil?
+        
+        ##
+        # Default Configuration
+        @local_configuration_dir    = File.join(local.gitpusshuten_dir, 'active_record')
+        @local_configuration_file   = File.join(@local_configuration_dir, "#{e.name}.database.yml")
+        @remote_configuration_dir   = File.join(c.path, 'modules', 'active_record')
+        @remote_configuration_file  = File.join(@remote_configuration_dir, "#{e.sanitized_app_name}.#{e.name}.database.yml")
+        
+        ##
+        # Ensure the directory is always available
+        FileUtils.mkdir_p(@local_configuration_dir)
+      end
+
+      ##
+      # Creates a template for the user to work with
+      def perform_create_configuration!
+        overwrite_if_exists?
+        
+        render_database_yml
+        message "Created #{y(@local_configuration_file)}."
+      end
+
+      ##
+      # Alias to perform_create_configuration!
+      def perform_create_config!
+        perform_create_configuration!
+      end
+
+      ##
+      # Uploads the local configuration file to the remote server.
+      def perform_upload_configuration!
+        requires_user_existence!
+        prompt_for_user_password!
+        
+        if not File.exist?(@local_configuration_file)
+          error "Could not find #{y(@local_configuration_file)}."
+          error "Either download an existing one from your server with:"
+          standard "\n\s\s#{y("heavenly active_record download-configuration from #{e.name}")}\n\n"
+          error "Or create a new template with:"
+          standard "\n\s\s#{y("heavenly active_record create-configuration for #{e.name}")}"
+          exit
+        end
+        
+        ##
+        # Ensure the remote active_record module directory exits
+        # and upload the local file to the remote file location
+        Spinner.return :message => "Uploading the database configuration file.." do
+          e.execute_as_user("mkdir -p '#{@remote_configuration_dir}'")
+          e.scp_as_user(:upload, @local_configuration_file, @remote_configuration_file)
+          g('Done!')
+        end
+      end
+
+      ##
+      # Alias to perform_upload_configuration!
+      def perform_upload_config!
+        perform_upload_configuration!
+      end
+
+      ##
+      # Downloads the configuration file from the remote server.
+      def perform_download_configuration!
+        overwrite_if_exists?
+        
+        ##
+        # Don't proceed unless the file exists
+        if not e.file?(@remote_configuration_file)
+          error "Configuration could not be found on the server in #{y(@remote_configuration_file)}."
+          exit
+        end
+        
+        ##
+        # Ensure the remote active_record module directory exits
+        # and upload the local file to the remote file location
+        Spinner.return :message => "Downloading the database configuration file.." do
+          e.scp_as_user(:download, @remote_configuration_file, @local_configuration_file)
+          g('Done!')
+        end        
+      end
+
+      ##
+      # Alias to perform_download_configuration!
+      def perform_download_config!
+        perform_download_configuration!
+      end
+
+      ##
+      # Prompts the user to choose a database adapter
+      def choose_adapter
+        choose do |menu|
+          menu.prompt = ''
+          menu.choice('mysql', 'mysql2')
+          menu.choice('postgresql')
+          menu.choice('sqlite3')
+          menu.choice('oracle')
+          menu.choice('frontbase')
+          menu.choice('ibm_db')
+        end
+      end
+
+      ##
+      # Render the chosen Active Record database template file 
+      def render_database_yml
+        config_content = case choose_adapter
+        when 'mysql', 'mysql2'
+<<-CONFIG
+production:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: #{e.sanitized_app_name}_#{e.name}
+  pool: 5
+  username: #{c.user}
+  password:
+  host: localhost
+  # socket: /tmp/mysql.sock
+CONFIG
+        when 'postgresql'
+<<-CONFIG
+production:
+  adapter: postgresql
+  encoding: unicode
+  database: #{e.sanitized_app_name}_#{e.name}
+  pool: 5
+  username: #{c.user}
+  password:
+CONFIG
+        when 'sqlite3'
+<<-CONFIG
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000
+CONFIG
+        when 'oracle'
+<<-CONFIG
+production:
+  adapter: oracle
+  database: #{e.sanitized_app_name}_#{e.name}
+  username: #{c.user}
+  password: 
+CONFIG
+        when 'frontbase'
+<<-CONFIG
+production:
+  adapter: frontbase
+  host: localhost
+  database: #{e.sanitized_app_name}_#{e.name}
+  username: #{c.user}
+  password: 
+CONFIG
+        when 'ibm_db'
+<<-CONFIG
+production:
+  adapter: ibm_db
+  username: #{c.user}
+  password:
+  database: #{e.sanitized_app_name}_#{e.name}
+  #schema: db2inst1
+  #host: localhost
+  #port: 50000
+  #account: my_account
+  #app_user: my_app_user
+  #application: my_application
+  #workstation: my_workstation
+  #security: SSL
+  #timeout: 10
+  #authentication: SERVER
+  #parameterized: false
+CONFIG
+        end # end case statement
+        
+        File.open(@local_configuration_file, 'w') do |file|
+          file << config_content
+        end
+      end
+
+      ##
+      # If the local configuration file exists, it will ask the
+      # user whether he wants to overwrite it
+      def overwrite_if_exists?
+        if File.exist?(@local_configuration_file)
+          warning "Configuration file already exists in #{@local_configuration_file}."
+          warning "Would you like to overwrite?"
+          exit unless yes?
+        end
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/modules/active_record/hooks.rb

@@ -1,19 +1,14 @@
 ##
-# Will check if the app_root/config/database.yml.<environment> exists
-# if it does, it'll overwrite the database.yml with that environment database.
-# If it does not exist, it'll leave the database.yml unchanged.
-post "Setting proper database for environment. (Rails)" do
-  run "if [[ -f 'config/database.yml.#{environment}' ]]; then " +
-      "echo 'config/database.yml.#{environment} found! Using this one instead of config/database.yml';" +
-      "echo 'Overwriting config/database.yml with config/database.yml.#{environment}';" +
-      "mv 'config/database.yml.#{environment}' 'config/database.yml'; " +
+# If the user uploaded his own database.yml file (using the Active Record CLI) then
+# it'll overwrite the repository version (if it exists) before migrating.
+post "Configure and Migrate Database (Active Record)" do
+  run "if [[ -f '#{configuration.path}/modules/active_record/#{configuration.sanitized_app_name}.#{environment}.database.yml' ]]; then " +
+      "cp '#{configuration.path}/modules/active_record/#{configuration.sanitized_app_name}.#{environment}.database.yml' " +
+      "'#{configuration.path}/#{configuration.sanitized_app_name}.#{environment}/config/database.yml'; " +
+      "echo 'Uploaded \"database.yml\" file found! Will be using it for the #{environment} environment!'; " +
+      "else echo 'Could not find any (pre) uploaded database.yml, skipping.'; " +
       "fi"
-end
-
-##
-# Will create the database if it doesn't exist yet.
-# Migrates the database.
-post "Migrate Database (Active Record)" do
+  
   run "rake db:create"
   run "rake db:migrate"
 end

data/lib/gitpusshuten/modules/redis/command.rb

@@ -4,9 +4,9 @@ module GitPusshuTen
     class Redis < GitPusshuTen::Commands::Base
       description "[Module] Redis commands."
       usage       "redis <command> for <enviroment>"
-      example     "heavenly redis install                 # Installs Redis (system wide) and downloads config template."
-      example     "heavenly redis upload-configuration    # Uploads the Redis configuration template to the server, will install Redis if not already present."
-      example     "               upload-config           # Alias."
+      example     "heavenly redis install to staging                # Installs Redis (system wide) and downloads config template."
+      example     "heavenly redis upload-configuration to staging   # Uploads the Redis configuration template to the server, will install Redis if not already present."
+      example     "               upload-config to staging          # Alias."
 
       def initialize(*objects)
         super

data/lib/gitpusshuten/version.rb

@@ -1,3 +1,3 @@
 module GitPusshuTen
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/gitpusshuten.rb

@@ -1,4 +1,4 @@
-require 'FileUtils'
+require 'fileutils'
 require 'open-uri'
 require 'yaml'
 

data/spec/hooks_spec.rb

@@ -138,9 +138,9 @@ describe GitPusshuTen::Hooks do
     describe '#render_commands_as_string' do
       it do
         hooks.render_commands(hooks.post_hooks).should == {
-          :render_output                => 'rake render:output;',
-          :restart_nginx_and_passenger  => '/etc/init.d/nginx stop;sleep 1;/etc/init.d/nginx start;mkdir tmp;touch tmp/restart.txt;',
-          :ensure_correct_branch        => 'git commit -am "Commit and Ensuring";git checkout master;'
+          '0) render_output'                => 'rake render:output;',
+          '1) restart_nginx_and_passenger'  => '/etc/init.d/nginx stop;sleep 1;/etc/init.d/nginx start;mkdir tmp;touch tmp/restart.txt;',
+          '2) ensure_correct_branch'        => 'git commit -am "Commit and Ensuring";git checkout master;'
         }
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitpusshuten
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Michael van Rooijen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 +01:00
+date: 2010-11-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -129,6 +129,7 @@ extra_rdoc_files: []
 files: 
 - .bundle/config
 - .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -163,6 +164,7 @@ files:
 - lib/gitpusshuten/initializer.rb
 - lib/gitpusshuten/local.rb
 - lib/gitpusshuten/log.rb
+- lib/gitpusshuten/modules/active_record/command.rb
 - lib/gitpusshuten/modules/active_record/hooks.rb
 - lib/gitpusshuten/modules/apache/command.rb
 - lib/gitpusshuten/modules/bundler/command.rb