rails_mysql 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c456d2132355527a87316b1e94910d46fa97059e
-  data.tar.gz: 468297fc3a0c23df03dae5cdd74d833586d9677c
+  metadata.gz: b7f2e583d64423a37a54925b814b1beafba71e63
+  data.tar.gz: e3dad132c87c76685f8ba7f1ca6be4c89449fbac
 SHA512:
-  metadata.gz: b6317b5b2f848ed031fa2484c7acb6b3446befeda9d3008f914d3990adc356b05b10d2646a7d15716a9fceddd7e209b74c3b170616a151d5d56b258f52546af7
-  data.tar.gz: 188a8e73f59f3e249908c5ea64530731e9b8be0d100a0e2257de3662f0dd07ecbb0b3af5a3ce91bc4b2bc395662aa1f965b0e20bdac5a44f111855b4f258999b
+  metadata.gz: 7cce39e097ac6d4751c84e9262766ebdb30d0a0edb46319e52447735c43170762d8ca4f5ec3d20a5ea232ebfcee0159a7a4edb30b6445a175af82d92587e736a
+  data.tar.gz: a412eb9afd695a1e8a105029f29484cd0bfd3be562e4765214bb6ceb97589ed32f46ed7024baad96e96e5f85dc8d5364c4c9729915e3ece8a1692f4a9d686d5d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+
+# 0.0.2
+ * BUGFIX: Shouldn't be a space before password on `mysqldump` command
+ * If the underlying command doesnt require specific parameters, neither do we
+ * Includes the database name in the mysql dump output file
+# 0.0.1
+ * Initial release

data/README.md

@@ -18,11 +18,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installation into a Rails project, it provides two rake tasks for your
+use.
+
+`rake mysql:cli` will execute the command line cli program connecting to 
+the mysql database for your current environment
+
+`rake mysql:dump` will execute a mysqldump against your configured database.
+Dump files are gzipped and stored in in the db/ folder.
+
+Configurations are read from the standard `config/database.yml' file.
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/rails_mysql/fork )
+1. Fork it ( https://github.com/akatakritos/rails_mysql/fork )
 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`)

data/lib/rails_mysql.rb

@@ -7,4 +7,5 @@ require 'rails_mysql/railtie' if defined?(Rails)
 
 module RailsMysql
   # Your code goes here...
+  class ConfigurationError < StandardError; end
 end

data/lib/rails_mysql/cli_command.rb

@@ -5,7 +5,14 @@ module RailsMysql
     end
 
     def command
-      %Q{mysql -h"#{config.host}" -u"#{config.username}" -p"#{config.password}" -P"#{config.port}" -D"#{config.database}"}
+      cmd_parts = []
+      cmd_parts << "-h\"#{config.host}\""     if config.host
+      cmd_parts << "-u\"#{config.username}\"" if config.username
+      cmd_parts << "-p\"#{config.password}\"" if config.password
+      cmd_parts << "-P\"#{config.port}\""     if config.port
+      cmd_parts << "-D\"#{config.database}\"" if config.database
+
+      %Q{mysql #{cmd_parts.join(' ')}}.strip
     end
 
     private

data/lib/rails_mysql/database_config.rb

@@ -1,5 +1,4 @@
 module RailsMysql
-  class ConfigurationError < StandardError; end
   class DatabaseConfig
 
     def self.from_yaml(env, file='config/database.yml')
@@ -11,11 +10,11 @@ module RailsMysql
     def initialize(options)
       raise ConfigurationError, "Not a mysql adapter" unless options["adapter"] =~ /mysql/
 
-      @host     = options.fetch('host', 'localhost')
-      @username = options.fetch('username', 'root')
-      @password = options.fetch('password', 'root')
-      @port     = options.fetch('port', '3306')
-      @database = options.fetch('database', 'db')
+      @host     = options['host']
+      @username = options['username']
+      @password = options['password']
+      @port     = options['port']
+      @database = options['database']
     end
 
   end

data/lib/rails_mysql/dump_command.rb

@@ -2,15 +2,22 @@ module RailsMysql
   class DumpCommand
 
     def initialize(config)
+      raise RailsMysql::ConfigurationError, "mysqldump requires a database" unless config.database
       @config = config
     end
 
     def command
-      "mysqldump -h \"#{config.host}\" -P \"#{config.port}\" -u \"#{config.username}\" -p \"#{config.password}\" \"#{config.database}\" | gzip > #{filename}"
+      cmd_parts = []
+      cmd_parts << "-h \"#{config.host}\""     if config.host
+      cmd_parts << "-P \"#{config.port}\""     if config.port
+      cmd_parts << "-u \"#{config.username}\"" if config.username
+      cmd_parts << "-p\"#{config.password}\""  if config.password
+
+      "mysqldump #{cmd_parts.join(' ')} \"#{config.database}\" | gzip > #{filename}"
     end
 
     def filename
-      "db/#{Time.now.utc.iso8601}.sql.gz"
+      "db/#{config.database}-#{Time.now.utc.iso8601}.sql.gz"
     end
 
     private

data/lib/rails_mysql/version.rb

@@ -1,3 +1,3 @@
 module RailsMysql
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/rails_mysql/cli_command_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe RailsMysql::CliCommand do
-  describe 'exec' do
+  describe 'command' do
     before { Kernel.stub(:exec) }
     let(:command) { RailsMysql::CliCommand.new(config) }
     let(:config) { double(:host => "HOST",
@@ -9,9 +9,44 @@ describe RailsMysql::CliCommand do
                          :password => "PASSWORD",
                          :port => "PORT",
                          :database => "DATABASE") }
+
+    def cli_without(*args)
+      args.each do |arg|
+        config.stub(arg) { nil }
+      end
+      RailsMysql::CliCommand.new(config)
+    end
+
     it 'Kernel.execs the correct parameters' do
       expect(command.command).to eq(%Q{mysql -h"HOST" -u"USERNAME" -p"PASSWORD" -P"PORT" -D"DATABASE"})
     end
+
+    describe 'optional configurations' do
+      it 'allows host to be optional' do
+        expect(cli_without(:host).command).to_not include("-h")
+      end
+      it 'allows username to be optional' do
+        expect(cli_without(:username).command).to_not include("-u")
+      end
+      
+      it 'allows port to be optional' do
+        expect(cli_without(:port).command).to_not include("-P")
+      end
+      
+      it 'allows database to be optional' do
+        expect(cli_without(:database).command).to_not include("-D")
+      end
+
+      it 'executes just mysql with no options' do
+        expect(cli_without(
+          :database,
+          :username,
+          :password,
+          :port,
+          :host).command).to eq "mysql"
+      end
+      
+    end
   end
 end
 

data/spec/lib/rails_mysql/dump_command_spec.rb

@@ -1,20 +1,6 @@
 require 'spec_helper'
 require 'optparse'
 
-def parse_options(cmd)
-  splitted_cmd = cmd.shellsplit
-  options = {}
-  OptionParser.new do |opts|
-    opts.on("-h host") { |h| options[:host] = h }
-    opts.on("-u username") { |u| options[:username] = u }
-    opts.on("-p password") { |p| options[:password] = p }
-    opts.on("-P port") { |p| options[:port] = p }
-  end.parse!(splitted_cmd)
-  
-  options[:cmd] = splitted_cmd.first
-  options[:args] = splitted_cmd[1..-1]
-  options
-end
 describe RailsMysql::DumpCommand do
   let(:config) {
     double(
@@ -30,29 +16,64 @@ describe RailsMysql::DumpCommand do
     cmd = RailsMysql::DumpCommand.new(config).command
 
     options = parse_options(cmd[/^[^\|]+/])
-    expect(options[:cmd]).to      eq "mysqldump"
-    expect(options[:host]).to     eq config.host
-    expect(options[:port]).to     eq config.port
-    expect(options[:username]).to eq config.username
-    expect(options[:password]).to eq config.password
-    expect(options[:args]).to     eq [config.database]
+    expect(options[:cmd]).to  eq "mysqldump"
+    expect(options["-h"]).to  eq config.host
+    expect(options["-P"]).to  eq config.port
+    expect(options["-u"]).to  eq config.username
+    expect(options["-p"]).to  eq config.password
+    expect(options[:args]).to eq [config.database]
+
+  end
 
+  it 'doesnt have a space between -p and the password' do
+    cmd = described_class.new(config).command
+    expect(cmd).to_not match "\s-p\s"
+  end
+
+  def dump_without(*args)
+    args.each do |arg|
+      config.stub(arg){ nil }
+    end
+    RailsMysql::DumpCommand.new(config)
+  end
+
+  describe 'optional arguments' do
+    it 'doesnt require host' do
+      expect(dump_without(:host).command).to_not include "-h"
+    end
+
+    it 'doesnt require username' do
+      expect(dump_without(:username).command).to_not include "-u"
+    end
+
+    it 'doesnt require password' do
+      expect(dump_without(:password).command).to_not include "-p"
+    end
+
+    it 'doesnt require port' do
+      expect(dump_without(:port).command).to_not include "-P"
+    end
+  end
+
+  it 'throws when it doesnt have a database' do
+    conf = double(:database => nil)
+    expect{ RailsMysql::DumpCommand.new(conf) }.to raise_error(RailsMysql::ConfigurationError)
   end
 
   it 'pipes through gzip' do
     cmd = RailsMysql::DumpCommand.new(config).command
-    expect(cmd).to match(/\|\s+gzip\s+>.*$/)
+    expect(cmd).to pipe_to("gzip")
   end
 
   it 'cats out to its filename' do
     dumper = RailsMysql::DumpCommand.new(config)
     cmd = dumper.command
     expect(cmd).to match(/\s>\s+#{Regexp.escape(dumper.filename)}$/)
-
   end
 
   describe 'filename' do
     let(:dumper) { RailsMysql::DumpCommand.new(config) }
+
     it 'is in the db folder' do
       expect(dumper.filename).to start_with("db/")
     end
@@ -66,7 +87,11 @@ describe RailsMysql::DumpCommand do
     end
 
     it 'is in utc' do
-      expect(Time.parse(dumper.filename[/db\/(.*?)\.sql\.gz/, 1])).to be_utc
+      expect(Time.parse(dumper.filename[/db\/.*-(.*?)\.sql\.gz/, 1])).to be_utc
+    end
+
+    it 'has the db name' do
+      expect(dumper.filename).to include "DATABASE"
     end
   end
 

data/spec/lib/tasks/mysql_rake_spec.rb

@@ -21,7 +21,6 @@ ensure
   Dir.chdir old_path
 end
 
-
 describe 'rake tasks' do
 
   before(:all) do
@@ -34,11 +33,21 @@ describe 'rake tasks' do
     before { Rails.stub(:env) { "development" } }
 
     it 'calls exec with the correct params' do
+      expect(RakeFileUtils).to receive(:sh) do |cmd|
+        opts = parse_options(cmd)
+        expect(opts[:cmd]).to eq 'mysql'
+        expect(opts["-h"]).to eq 'HOST'
+        expect(opts["-u"]).to eq "USER"
+        expect(opts["-p"]).to eq "PASSWORD"
+        expect(opts["-P"]).to eq "PORT"
+        expect(opts["-D"]).to eq "DATABASE"
+      end
+
       with_fixture("default") do
         rake 'mysql:cli'
       end
 
-      expect(RakeFileUtils).to have_received(:sh).with("mysql -h\"HOST\" -u\"USER\" -p\"PASSWORD\" -P\"PORT\" -D\"DATABASE\"");
+      #expect(RakeFileUtils).to have_received(:sh).with("mysql -h\"HOST\" -u\"USER\" -p\"PASSWORD\" -P\"PORT\" -D\"DATABASE\"");
 
     end
   end
@@ -50,12 +59,15 @@ describe 'rake tasks' do
     it 'calls exec with the correct params' do
 
       expect(RakeFileUtils).to receive(:sh) do |cmd|
-        expect(cmd).to match(/^mysqldump\b/)
-        expect(cmd).to match(/-h\s+"HOST"/)
-        expect(cmd).to match(/-u\s+"USER"/)
-        expect(cmd).to match(/-p\s+"PASSWORD"/)
-        expect(cmd).to match(/-P\s+"PORT"/)
-        expect(cmd).to match(/|\s+>\s+.*/) # cats to some file
+        opts = parse_options(cmd)
+
+        expect(opts[:cmd]).to eq 'mysqldump'
+        expect(opts["-h"]).to eq 'HOST'
+        expect(opts["-u"]).to eq "USER"
+        expect(opts["-p"]).to eq "PASSWORD"
+        expect(opts["-P"]).to eq "PORT"
+
+        expect(cmd).to pipe_to "gzip"
       end
 
       with_fixture("default") do

data/spec/spec_helper.rb

@@ -1,2 +1,28 @@
 require 'rails_mysql'
 require 'rake'
+
+def parse_options(cmd)
+  splitted_cmd = cmd.shellsplit
+  options = {}
+  OptionParser.new do |opts|
+    opts.on("-h host")     { |h| options["-h"] = h }
+    opts.on("-u username") { |u| options["-u"] = u }
+    opts.on("-p password") { |p| options["-p"] = p }
+    opts.on("-P port")     { |p| options["-P"] = p }
+    opts.on("-D database") { |d| options["-D"] = d }
+  end.parse!(splitted_cmd)
+
+  options[:cmd]  = splitted_cmd.first
+  options[:args] = splitted_cmd[1..-1]
+  options
+end
+
+##
+# expect(command).to pipe_to "gzip"
+#   => asserts that command has basically "| gzip " in it somewhere
+RSpec::Matchers.define :pipe_to do |command|
+  match do |actual|
+    actual.match /\|\s*#{Regexp.quote(command)}\b/
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mysql
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Burke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt