reflection 0.3.1 → 0.4.0

data/Rakefile

@@ -5,9 +5,9 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "reflection"
-    gem.summary = %Q{Helps you keeping your development machine in sync with production.}
+    gem.summary = %Q{Keep your development machine in sync with production.}
     gem.description = %Q{
-      Reflection is designed to keep your production assets (database comming soon) in sync with your development system.
+      Reflection is designed to keep your development system in sync with your production system's files and database (by dumping).
       It uses a shared git repository to store these files, which allows you to mirror your production environment without the need of 
       direct access to your production servers.
     }

data/Reflection.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{reflection}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andreas Wolff"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2009-11-18}
   s.default_executable = %q{reflection}
   s.description = %q{
-      Reflection is designed to keep your production assets (database comming soon) in sync with your development system.
+      Reflection is designed to keep your development system in sync with your production system's files and database (by dumping).
       It uses a shared git repository to store these files, which allows you to mirror your production environment without the need of 
       direct access to your production servers.
     }
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
      "lib/reflection/directory.rb",
      "lib/reflection/directory/base.rb",
      "lib/reflection/directory/stash.rb",
+     "lib/reflection/rails.rb",
      "lib/reflection/repository.rb",
      "lib/reflection/support.rb",
      "lib/reflection/support/home.rb",
@@ -52,6 +53,7 @@ Gem::Specification.new do |s|
      "spec/reflection/config_spec.rb",
      "spec/reflection/directory/base_spec.rb",
      "spec/reflection/directory/stash_spec.rb",
+     "spec/reflection/rails_spec.rb",
      "spec/reflection/repository_spec.rb",
      "spec/reflection/support/home_spec.rb",
      "spec/reflection/support_spec.rb",
@@ -63,13 +65,14 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Helps you keeping your development machine in sync with production.}
+  s.summary = %q{Keep your development machine in sync with production.}
   s.test_files = [
     "spec/reflection/cli_spec.rb",
      "spec/reflection/command/stash_spec.rb",
      "spec/reflection/config_spec.rb",
      "spec/reflection/directory/base_spec.rb",
      "spec/reflection/directory/stash_spec.rb",
+     "spec/reflection/rails_spec.rb",
      "spec/reflection/repository_spec.rb",
      "spec/reflection/support/home_spec.rb",
      "spec/reflection/support_spec.rb",

data/TODO

@@ -1,8 +1,6 @@
-+ Add config files ('$ reflection path/to/config')
-+ Add DB Dumper (include in cli-opt-parser)
 + Remove stash directory if its empty (on reinit)
 + Add Logger (Reflection::Support.log)
-+ After command callbacks: Twitter, Campfire on Serverside
++ After command callbacks: Apphunk
 + List existing reflections in client side
   + Allow to apply any (git) version, not just the latest
 + Add cli option use tmp-apply (removes ~/.reflection/apply-dir after command) 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/reflection/command/apply.rb

@@ -5,17 +5,23 @@ module Reflection
     class Apply < Reflection::Command::Base
 
       def validate!
-        validate.existence_of options.directory
+        validate.existence_of config.directory
+        if config.rails_root
+          validate.existence_of config.rails_root
+          Reflection::Rails.validate_environment(config)
+        end
       end
 
       def run!
-        stash_directory = Directory::Stash.new(Reflection::Repository.new(options.repository), 'apply')
-        target_directory = Directory::Base.new(options.directory)
+        stash_directory = Directory::Stash.new(Reflection::Repository.new(config.repository), 'apply')
+        target_directory = Directory::Base.new(config.directory)
 
         get_user_approval_for_cleaning_target(target_directory)
+        get_user_approval_for_apply_database_dump if config.rails_root
+        
         verify_that_target_is_not_a_repository(target_directory)
 
-        Reflection.log.info "Applying '#{options.repository}' >> '#{options.directory}'.."
+        Reflection.log.info "Applying '#{config.repository}' >> '#{config.directory}'.."
 
         target_directory.clean!
 
@@ -32,6 +38,7 @@ module Reflection
           stash_directory.get_git_index_from(target_directory.path)
         end
 
+        Reflection::Rails.apply(config, target_directory)
         Reflection.log.info "Apply Command done."
       end
 
@@ -40,7 +47,18 @@ module Reflection
 
         def get_user_approval_for_cleaning_target(target_directory)
           puts "\nIn order to get a fresh copy of your files, Reflection will have to remove all files under '#{target_directory.path}'."
-          puts "If you're sure, hit <enter> to proceed.."
+          puts "If you are sure, hit <enter> to proceed.."
+          
+          unless STDIN.getc == 10
+            puts "Aborting.."
+            exit
+          end
+        end
+
+        def get_user_approval_for_apply_database_dump
+          puts "\nCaution: You've enabled Rails database dumping/applying."
+          puts "In order to apply a fresh dump, Reflection will override your database."
+          puts "If you are sure, hit <enter> to proceed.."
 
           unless STDIN.getc == 10
             puts "Aborting.."

data/lib/reflection/command/base.rb

@@ -1,16 +1,16 @@
 module Reflection
   module Command
     class Base
-      attr_accessor :options
+      attr_accessor :config
       
-      def self.run!(options)
-        command = self.new(options)
+      def self.run!(config)
+        command = self.new(config)
         command.validate! if command.respond_to?(:validate!)
         command.run!
       end
       
-      def initialize(new_options)
-        self.options = new_options
+      def initialize(new_config)
+        self.config = new_config
       end      
       
       def validate

data/lib/reflection/command/stash.rb

@@ -5,14 +5,18 @@ module Reflection
     class Stash < Reflection::Command::Base
 
       def validate!
-        validate.existence_of options.directory
+        validate.existence_of config.directory
+        if config.rails_root
+          validate.existence_of config.rails_root
+          Reflection::Rails.validate_environment(config)
+        end
       end
 
       def run!
-        Reflection.log.info "Stashing '#{options.directory}'.."
+        Reflection.log.info "Stashing '#{config.directory}'.."
 
-        stash_directory = Directory::Stash.new(Reflection::Repository.new(options.repository), 'stash')
-        target_directory = Directory::Base.new(options.directory)
+        stash_directory = Directory::Stash.new(Reflection::Repository.new(config.repository), 'stash')
+        target_directory = Directory::Base.new(config.directory)
 
         verify_that_target_is_not_a_repository(target_directory)
         
@@ -34,8 +38,10 @@ module Reflection
 
       def stash_directory_into_repository(stash_directory, target_directory)
         copy_stash_repository_git_index_to_target(stash_directory.git_index, target_directory.path)
+        Reflection::Rails.stash(config, target_directory) if config.rails_root
         commit_and_push_files(target_directory.path, target_directory.name)
         move_stash_repository_git_index_back(target_directory.git_index, stash_directory.path)
+        Reflection::Rails.clean_target(target_directory) if config.rails_root
       end
 
 

data/lib/reflection/config.rb

@@ -11,6 +11,8 @@ module Reflection
     attr_accessor :command
     attr_accessor :directory
     attr_accessor :repository
+    attr_accessor :rails_root
+    attr_accessor :rails_environment
     attr_accessor :store_configuration_path
     
     def self.parse(args = [])
@@ -28,13 +30,21 @@ module Reflection
     end
 
     def to_hash
-      { :command => self.command, :repository => self.repository, :directory => self.directory }
+      { 
+        :command => self.command, 
+        :repository => self.repository, 
+        :directory => self.directory,
+        :rails_root => self.rails_root,
+        :rails_environment => self.rails_environment
+      }
     end
     
     def from_hash(hash)
       self.command = hash[:command]
       self.directory = hash[:directory]
       self.repository = hash[:repository]
+      self.rails_root = hash[:rails_root]
+      self.rails_environment = hash[:rails_environment]
     end
 
     def write(path)
@@ -61,8 +71,10 @@ module Reflection
 
     def parse_command_line_options(args)
       opt_parser = OptionParser.new do |opts|
-        opts.banner = "Usage: reflection --COMMAND --repository=GIT_REPO --directory=PATH"
-
+        opts.banner =   "Usage: reflection --COMMAND --repository=GIT_REPO --directory=PATH\n"
+        opts.banner <<  " -or-\n"
+        opts.banner <<  "Usage: reflection /path/to/reflection-config-file.yml"
+        
         opts.separator " "
         opts.separator "On the server side:"
 
@@ -86,7 +98,16 @@ module Reflection
         end
 
         opts.separator " "
-        opts.separator "Additional options for both:"        
+        opts.separator "Additional options for both:"
+
+        opts.on("--rails [RAILS_ROOT]", "Enable dumping/applying of a Rails managed MySQL database") do |path|
+          self.rails_root = path || nil
+        end        
+
+        opts.on("--rails-env [ENV]", "Rails environment to instrument") do |environment|
+          self.rails_environment = environment || nil
+        end        
+        
         opts.on("--write [FILE]", "Create a configuration FILE from the current commandline options") do |config_file_path|
           self.store_configuration_path = config_file_path if config_file_path
         end

data/lib/reflection/rails.rb

@@ -0,0 +1,62 @@
+module Reflection
+  module Rails
+    class << self
+      
+      def validate_environment(config)
+        env_file_path = File.join(config.rails_root, 'config/environments', "#{config.rails_environment}.rb")
+        unless File.exist?(env_file_path)
+          Reflection::Support.exit_with_error("Rails environment '#{config.rails_environment}' doesn't exist in #{env_file_path}.")
+        end
+      end
+      
+      def clean_target(target_directory)
+        target_file_path = File.join(target_directory.path, '_rails_database_dump.sql')
+        if File.exist?(target_file_path)
+          %x(rm #{target_file_path})          
+        end
+      end
+      
+      def database_command_line_options(database_config)
+        options = []
+        options <<  "-h #{database_config['host']}"
+        options <<  "-u #{database_config['username']}"
+        options <<  "-p #{database_config['password']}" if database_config['password'] && !database_config['password'].empty?
+        options <<  "#{database_config['database']}"
+        options.join(' ')
+      end
+      
+      def read_database_configuration(config)
+        begin
+          database_path = File.join(config.rails_root, "config/database.yml")
+          if db_config = YAML.load_file(database_path)[config.rails_environment]
+            return db_config
+          else
+            Reflection.log.error("Rails database configuration for '#{config.rails_environment}' isn't available in #{database_path}")
+            return false
+          end
+        rescue => e
+          Reflection.log.error("Error while parsing Rails database configuration: #{e}")
+          return false
+        end
+      end
+      
+      def stash(config, target_directory)
+        Reflection.log.debug "Stashing database dump.."
+        return unless database_config = read_database_configuration(config)
+        options = database_command_line_options(database_config)
+        target_file_path = File.join(target_directory.path, '_rails_database_dump.sql')
+        %x(mysqldump #{options} --add-drop-table > #{target_file_path})
+      end
+    
+      def apply(config, target_directory)
+        Reflection.log.debug "Applying database dump.."        
+        return unless database_config = read_database_configuration(config)
+        options = database_command_line_options(database_config)
+        target_file_path = File.join(target_directory.path, '_rails_database_dump.sql')
+        %x(mysql #{options} < #{target_file_path})
+        clean_target(target_directory)
+      end
+      
+    end
+  end
+end

data/lib/reflection/support/log.rb

@@ -10,6 +10,9 @@ module Reflection
         puts "** #{message}" if message && !message.empty?
       end
       
+      def error(message)
+        puts "!! #{message}" if message && !message.empty?
+      end
     end
   end
 end

data/lib/reflection.rb

@@ -5,6 +5,7 @@ module Reflection
   autoload :Config,           'reflection/config'
   autoload :Command,          'reflection/command'
   autoload :Directory,        'reflection/directory'
+  autoload :Rails,            'reflection/rails'
   autoload :Repository,       'reflection/repository'
   autoload :Support,          'reflection/support'
   autoload :Validations,      'reflection/validations'

data/spec/reflection/command/stash_spec.rb

@@ -2,8 +2,8 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 
 describe Reflection::Command::Stash do
   before(:each) do
-    @options = OpenStruct.new({ :directory => '/home/tmp/fu_asset_directory', :command => :stash })
-    @subject = Reflection::Command::Stash.new(@options)
+    @config = OpenStruct.new({ :directory => '/home/tmp/fu_asset_directory', :command => :stash })
+    @subject = Reflection::Command::Stash.new(@config)
   end
   
   describe 'validations' do
@@ -83,6 +83,13 @@ describe Reflection::Command::Stash do
       @subject.stash_directory_into_repository(@mock_stash_directory, @mock_target_directory)
     end
     
+    it 'should call the stash command on the database dumper if enabled' do
+      @config.rails_root = "/rails/root"
+      Reflection::Rails.should_receive(:stash).with(@config, @mock_target_directory)
+      @subject.stash_directory_into_repository(@mock_stash_directory, @mock_target_directory)
+    end
+    
+    
     it "should add and push the contents of directory to the repository" do
       @subject.should_receive(:commit_and_push_files).with("/home/tmp/assets", "assets")
       @subject.stash_directory_into_repository(@mock_stash_directory, @mock_target_directory)

data/spec/reflection/config_spec.rb

@@ -2,7 +2,9 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Reflection::Config do
   before(:each) do
-    @valid_options = { :command => :stash, :repository => 'repo', :directory => 'dir' }
+    @valid_options = { 
+      :command => :stash, :repository => 'repo', :directory => 'dir', :rails_root => "rails_root", :rails_environment => 'development' 
+    }
   end
   
   describe 'parse' do
@@ -41,6 +43,8 @@ describe Reflection::Config do
       @config.command = :stash
       @config.repository = 'repo'
       @config.directory = 'dir'
+      @config.rails_root = 'rails_root'
+      @config.rails_environment = 'development'
       @config.to_hash.should == @valid_options
     end
   end
@@ -52,6 +56,8 @@ describe Reflection::Config do
       @config.command.should eql(:stash)
       @config.repository.should eql('repo')
       @config.directory.should eql('dir')
+      @config.rails_root.should eql('rails_root')
+      @config.rails_environment.should eql('development')
     end
   end
   

data/spec/reflection/rails_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Reflection::Rails do
+  before(:each) do
+    @config = OpenStruct.new({ :rails_root => '/rails_root/', :rails_environment => 'development' })
+    @rails = Reflection::Rails
+  end
+  
+  describe 'validate_environment' do
+    it "should fail if the specified environment does't exist" do
+      Reflection::Support.should_receive(:exit_with_error)
+      File.stub!(:exist?).and_return(false)
+      @rails.validate_environment(@config)
+    end
+  end
+  
+  describe 'read_database_configuration' do
+    it 'should read the configuration for the specified environment' do
+      db_config = { "host" => "localhost", "username" => "root" }
+      YAML.should_receive(:load_file).with('/rails_root/config/database.yml').and_return({ "production" => {}, "development" => db_config })
+      db_config = @rails.read_database_configuration(@config)
+      db_config.should == db_config
+    end
+    
+    it "should log an error and return false if the environment isn't configured" do
+      Reflection.log.should_receive(:error).with(/available/)
+      YAML.stub!(:load_file).and_return({ "production" => {} })
+      @rails.read_database_configuration(@config).should be_false
+    end
+    
+    it "should log an error and return false if the database.yml cannot be found" do
+      Reflection.log.should_receive(:error).with(/Error/)
+      YAML.stub!(:load_file).and_raise(StandardError)
+      @rails.read_database_configuration(@config).should be_false
+    end
+  end
+  
+  describe 'database_command_line_options' do
+    before(:each) do
+      @db_config = { "host" => "localhost", "database" => "test", "username" => "root", "password" => "secret" }
+    end
+    
+    it 'should create options for the mysql command' do
+      @rails.database_command_line_options(@db_config).should == "-h localhost -u root -p secret test"
+    end
+    
+    it 'should ignore the password option if its not available' do
+      @db_config['password'] = ""
+      @rails.database_command_line_options(@db_config).should == "-h localhost -u root test"
+
+      @db_config['password'] = nil
+      @rails.database_command_line_options(@db_config).should == "-h localhost -u root test"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reflection
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Andreas Wolff
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 +01:00
+date: 2009-11-18 00:00:00 +01:00
 default_executable: reflection
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.5
     version: 
-description: "\n      Reflection is designed to keep your production assets (database comming soon) in sync with your development system.\n      It uses a shared git repository to store these files, which allows you to mirror your production environment without the need of \n      direct access to your production servers.\n    "
+description: "\n      Reflection is designed to keep your development system in sync with your production system's files and database (by dumping).\n      It uses a shared git repository to store these files, which allows you to mirror your production environment without the need of \n      direct access to your production servers.\n    "
 email: rubyphunk@gmail.com
 executables: 
 - reflection
@@ -61,6 +61,7 @@ files:
 - lib/reflection/directory.rb
 - lib/reflection/directory/base.rb
 - lib/reflection/directory/stash.rb
+- lib/reflection/rails.rb
 - lib/reflection/repository.rb
 - lib/reflection/support.rb
 - lib/reflection/support/home.rb
@@ -71,6 +72,7 @@ files:
 - spec/reflection/config_spec.rb
 - spec/reflection/directory/base_spec.rb
 - spec/reflection/directory/stash_spec.rb
+- spec/reflection/rails_spec.rb
 - spec/reflection/repository_spec.rb
 - spec/reflection/support/home_spec.rb
 - spec/reflection/support_spec.rb
@@ -104,13 +106,14 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Helps you keeping your development machine in sync with production.
+summary: Keep your development machine in sync with production.
 test_files: 
 - spec/reflection/cli_spec.rb
 - spec/reflection/command/stash_spec.rb
 - spec/reflection/config_spec.rb
 - spec/reflection/directory/base_spec.rb
 - spec/reflection/directory/stash_spec.rb
+- spec/reflection/rails_spec.rb
 - spec/reflection/repository_spec.rb
 - spec/reflection/support/home_spec.rb
 - spec/reflection/support_spec.rb