mysql_rake_tasks 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b08d5ab0c8ee9fd347b874e6a137aa16ebf1bc33a94d9ecc961b5958a3c7a0ac
+  data.tar.gz: '02799bc1c94a6bddbec2a795a85355782dc937476571cf428a4dc23b8d3a016a'
+SHA512:
+  metadata.gz: 95dada497b356fce73cea69e704357e41cc746b93db227ad4d8cdd7f14ca49e667ee9ed8af55915e3592ef7dc2b3d433b7c222e1f95871c610a19f301e8fdc8a
+  data.tar.gz: 507bb3184fa1ade352f24a52aa9c7c255ad3c61a8b4398bf403c3feafd9eac54047c5656a99dfac7a271899efe51d6074b524c37c4efb0e6e6a14e483c9f1de2

data/README.rdoc

@@ -1,22 +1,22 @@
-= mysql_rake_tasks
+# mysql_rake_tasks
 
 A collection of rails rake tasks for mysql
 1. create_users - creates localhost mysql user accounts for each database listing in the database.yml
+2. stats - database stats - table size
 
-
-== Install
+## Install
 
 1. Add mysql_rake_tasks to your gem file
 
-  gem 'mysql_rake_tasks', '~> 0.0.1'
+  gem 'mysql_rake_tasks', '~> 0.1.0'
 
 2. Run the bundle command
 
   bundle install
 
-== Examples
+## Examples
 
-=== create_users
+### create_users
 
 To create mysql users in interactive mode run:
 
@@ -28,17 +28,35 @@ You can also specify your root username and password on the command line:
 
   rake db:mysel:create_users[root,mypassword]
 
-== License
+### stats
+
+To display database stats:
+
+  rake db:mysql:stats
+  +--------------------------------+---------------+-----------+----------+------------+
+  | Table Name                     |          Rows | Data Size | IDX Size | Total Size |
+  +--------------------------------+---------------+-----------+----------+------------+
+  | fish                           |  1.41 Million |   93.6 MB |  41.1 MB |     135 MB |
+  | birds                          |             0 |     16 KB |  0 Bytes |      16 KB |
+  | cats                           |            14 |     16 KB |  0 Bytes |      16 KB |
+  | schema_migrations              |             7 |     16 KB |  0 Bytes |      16 KB |
+  | users                          |             5 |     16 KB |    32 KB |      48 KB |
+  +--------------------------------+---------------+-----------+----------+------------+
+  |                                                                       |     135 MB |
+  +--------------------------------+---------------+-----------+----------+------------+
+  Database: mydb_development  MySQL Server Version: 5.1.58
+
+## License
 
 MIT
 
-== Credits
+## Credits
 
 Author: Gregory Ostermayr gregory.ostermayr@gmail.com
 
 Contributed code and/or ideas:
 
-Kevin Woods kwoods@privateergroup.com
+Kevin Woods
 
 Travis Herrick
 

data/Rakefile

@@ -5,6 +5,7 @@ Bundler::GemHelper.install_tasks
 task :default => :test
 
 require 'rake/testtask'
+
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true

data/lib/mysql_rake_tasks/mysql_rake_tasks.rake

@@ -1,11 +1,15 @@
 namespace :db do
   namespace :mysql do
 
-    desc "Create MySQL users from database.yml (localhost only). Run without parameters for interactive mode." 
-    task :create_users, [:root_user, :pass] => [:environment] do |rake_task, args|
+    desc "Create MySQL users from database.yml (localhost only). Run without parameters for interactive mode."
+    task :create_users, [:root_user, :pass] do |rake_task, args|
       MysqlRakeTasks::Tasks::create_users(args)
     end
 
+    desc "Display MySQL stats"
+    task :stats =>  [:environment] do |rake_task, args|
+      MysqlRakeTasks::Tasks::stats
+    end
   end
 end
 

data/lib/mysql_rake_tasks/tasks.rb

@@ -1,77 +1,161 @@
 require 'rails'
 require 'mysql2'
 
+# test unit seems to need these
+require 'active_support'
+require 'action_view'
+
+include ActionView::Helpers::NumberHelper
+
 module MysqlRakeTasks
   class Tasks
 
     # Parses input args for username and password, if not given
     # it will prompt the user
     def self.get_input(*args)
-      if !args[0].nil? then
+      unless args[0].nil?
         root_user = args[0][:root_user]
         root_pass = args[0][:pass]
       end
 
-      if root_user.nil? or root_pass.nil? then
+      if root_user.nil? or root_pass.nil?
         $stdout.puts 'mysql user:'
         root_user = $stdin.gets.chomp
 
-	$stdout.puts 'mysql password:'
+        $stdout.puts 'mysql password:'
         system 'stty -echo'
         root_pass = $stdin.gets.chomp
         system 'stty echo'
       end
 
-      {:root_user => root_user, :pass => root_pass}
+      return root_user, root_pass
     end
 
-    # creates user permissions for mysql database for localhost only 
+    # creates user permissions for mysql database for localhost only
     def self.create_users(args)
-      args = self.get_input(args)
-      @root_user = args[:root_user]
-      @pass = args[:pass]
+      @root_user, @pass = self.get_input(args)
 
       # create a mysql user for each listing in database.yml file
       Rails::configuration.database_configuration.each do |listing|
+        @config = listing[1]
+        username = @config['username']
+        db_name = @config['database']
+
         begin
-  	  @config = listing[1]
-          db = Mysql2::Client.new(
-               :host => 'localhost',
-               :username => @root_user,
-               :password => @pass,
-               :socket => @config['socket'])
+          db = Mysql2::Client.new( host: 'localhost', username: @root_user, password: @pass)
 
           sql = self.create_user_sql(@config)
-          db.query sql
-	  $stdout.puts "Created #{@config['username']} on #{@config['database']}\n"
+          db.query(sql)
+
+          sql = self.grant_user_sql(@config)
+          db.query(sql)
+
+          $stdout.puts "Created #{username} on #{db_name}\n"
         rescue Mysql2::Error => e
-          $stdout.puts "Error code: #{e.errno}"
-          $stdout.puts "Error message: #{e.error}"
-          $stdout.puts "Error SQLSTATE: #{e.sqlstate}" if e.respond_to?("sqlstate")
-        ensure # disconnect from server 
+          error_output(e)
+        ensure # disconnect from server
           db.close if db
         end
       end
     end
 
     def self.create_user_sql(config)
-      if config.nil? then
-        return ""
+      return '' unless config
+
+      if config['username'].nil?
+        puts 'Error code: missing username entry'
       end
 
-      if config['username'].nil? then
+      sql = <<-SQL
+        CREATE USER '#{config['username']}'@'localhost' IDENTIFIED BY '#{config['password']}';
+      SQL
+    end
+
+    def self.grant_user_sql(config)
+      return '' unless config
+
+      if config['username'].nil?
         puts 'Error code: missing username entry'
       end
 
-      sql  = <<-SQL
-        GRANT
-        ALL PRIVILEGES
-        ON #{config['database']}.*
-        TO #{config['username']}@localhost
-        IDENTIFIED BY '#{config['password']}';
+      sql = <<-SQL
+        GRANT ALL ON #{config['database']}.* TO '#{config['username']}'@'localhost';
+      SQL
+    end
+
+    def self.stats
+      config = Rails::configuration.database_configuration[Rails.env].clone
+
+      begin
+        db = Mysql2::Client.new( host: config['host'], username: config['username'], password: config['password'])
+
+        db_name = config['database']
+        version = db.info[:version]
+
+        sql = stats_query(db_name)
+        result = db.query sql
+
+      print_header
+
+      db_total = 0
+      result.each  do |row|
+        print_stat_line(row)
+        db_total += row["total_size"].to_i
+      end
+
+      print_footer(db_total, db_name, version)
+      rescue Mysql2::Error => e
+        error_output(e)
+      ensure
+        db.close if db
+      end
+    end
+
+    def self.print_separator
+      puts  "+--------------------------------+---------------+-----------+----------+------------+"
+    end
+
+    def self.print_header
+      print_separator
+      printf "| %30s | %13s | %9s | %8s | %8s |\n",
+        "Table Name".ljust(30), "Rows", "Data Size", "IDX Size", "Total Size"
+      print_separator
+    end
+
+    def self.print_stat_line(row)
+      printf "| %30s | %13s | %9s | %8s | %10s |\n",
+        row["table_name"].ljust(30),
+        number_to_human(row["table_rows"]).rjust(13),
+        number_to_human_size(row["data"]),
+        number_to_human_size(row["idx"]),
+        number_to_human_size(row["total_size"])
+    end
+
+    def self.print_footer(db_total, db_name, version)
+      print_separator
+      printf "|%70s | %10s |\n",'', number_to_human_size(db_total)
+      print_separator
+      puts "Database: #{db_name}  MySQL Server Version: #{version}\n"
+      puts " "
+    end
+
+    def self.stats_query(db_name)
+      sql = <<-SQL
+          SELECT table_name,
+          concat(table_rows) as table_rows,
+          concat(data_length) data,
+          concat(index_length) idx,
+          concat(data_length+index_length) total_size
+          FROM information_schema.TABLES
+          WHERE table_schema LIKE '#{db_name}'
+          ORDER BY table_name;
       SQL
     end
 
+    def self.error_output(e)
+      $stdout.puts "Error code: #{e.errno}"
+      $stdout.puts "Error message: #{e.error}"
+      $stdout.puts "Error SQLSTATE: #{e.sqlstate}" if e.respond_to?("sqlstate")
+    end
   end
 end
-

data/lib/mysql_rake_tasks/version.rb

@@ -1,3 +1,3 @@
 module MysqlRakeTasks
-  VERSION = "0.0.3"
+  VERSION = '1.0.0'
 end

data/mysql_rake_tasks.gemspec

@@ -12,20 +12,21 @@ Gem::Specification.new do |s|
   s.description = %q{A collection of rails rake tasks for mysql.}
   s.license = "MIT"
   s.extra_rdoc_files = [
-   "LICENSE",
+    "LICENSE.txt",
    "README.rdoc"
   ]
 
   s.rubyforge_project = "mysql_rake_tasks"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = Dir['test/*.rb'] 
+  s.test_files    = Dir['test/*.rb']
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  s.add_development_dependency 'rake', '~> 0.9.2'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'mocha', '~> 0.9.12'
+  s.add_development_dependency 'test-unit-rails', '~> 6.0'
   s.add_runtime_dependency 'mysql2', '>= 0.2.7'
 end

data/test/tasks_test.rb

@@ -5,37 +5,37 @@ require 'stringio'
 require 'mocha'
 
 class TasksTest < Test::Unit::TestCase
+  def setup
+    Rails.stubs(:configuration).returns(Rails::Application::Configuration.allocate)
+    Rails.configuration.stubs(:database_configuration).returns(stub_config)
+  end
 
   def test_two_args_returns_two_values
-    output = MysqlRakeTasks::Tasks::get_input({:root_user => 'user', :pass => 'pass'})
+    user, pass = MysqlRakeTasks::Tasks::get_input({:root_user => 'user', :pass => 'pass'})
 
-    assert_equal 2, output.length
-    assert_equal 'user', output[:root_user]
-    assert_equal 'pass', output[:pass]
+    assert_equal 'user', user
+    assert_equal 'pass', pass
   end
 
   def test_lack_of_args_invokes_cli_interface
     output = ""
     screen = io_mock do |input|
-               input.string = "root\nmypassword\n"
-               output = MysqlRakeTasks::Tasks.get_input
+               input.string = "root\nmyrootpass\n"
+               @user, @pass = MysqlRakeTasks::Tasks.get_input
              end
 
     assert_equal 'mysql user:', screen[0]
     assert_equal 'mysql password:', screen[1]
-    assert_equal 'root', output[:root_user]
-    assert_equal 'mypassword', output[:pass]
+    assert_equal 'root', @user
+    assert_equal 'myrootpass',@pass
   end
 
 
   def test_unsuccessful_authentication
-    Rails.stubs(:configuration).returns(Rails::Application::Configuration.allocate) 
-    Rails.configuration.stubs(:database_configuration).returns(stub_config)
-
     screen = io_mock do |input|
       MysqlRakeTasks::Tasks.create_users(:root_user => 'root', :pass => 'wrong')
     end
-   
+
     assert_equal 'Error code: 1045', screen[0]
     assert_equal "Error message: Access denied for user 'root'@'localhost' (using password: YES)", screen[1]
     assert_equal 'Error code: 1045', screen[2]
@@ -45,12 +45,13 @@ class TasksTest < Test::Unit::TestCase
   end
 
   def test_successful_creation
-    Rails.stubs(:configuration).returns(Rails::Application::Configuration.allocate)
-    Rails.configuration.stubs(:database_configuration).returns(stub_config)
-
     screen = io_mock do |input|
       # :pass needs to be set to mysql root in order to pass
-      MysqlRakeTasks::Tasks.create_users(:root_user => 'root', :pass => 'myrootpass') 
+      #  mysqladmin --user=root password "myrootpass"
+      # create database task_test
+      # create database task_production
+      # drop user 'test'@'localhost';drop user 'dev'@'localhost';drop user 'prod'@'localhost';
+      MysqlRakeTasks::Tasks.create_users(:root_user => 'root', :pass => 'myrootpass')
     end
 
     assert_equal "Created dev on task_development", screen[0], 'Note: ***check test machine password***'
@@ -59,10 +60,11 @@ class TasksTest < Test::Unit::TestCase
   end
 
   def test_lack_of_user_throws_error
-    config = stub_config
+    config = stub_config.clone
     config["development"].delete "username"
+    config["production"].delete "username"
+    config["test"].delete "username"
 
-    Rails.stubs(:configuration).returns(Rails::Application::Configuration.allocate)
     Rails.configuration.stubs(:database_configuration).returns(config)
 
     screen = io_mock do |input|
@@ -71,7 +73,17 @@ class TasksTest < Test::Unit::TestCase
     end
 
     assert_equal 'Error code: missing username entry', screen[0], 'Note: ***check test machine password***'
-    assert_equal 'Error code: 1064', screen[1]
+    assert_equal 'Error code: 1396', screen[1]
+  end
+
+  def test_stats_outputs_header
+    screen = io_mock do |input|
+      MysqlRakeTasks::Tasks.stats
+    end
+
+    assert_equal  '+--------------------------------+---------------+-----------+----------+------------+', screen[0]
+    assert_equal  '| Table Name                     |          Rows | Data Size | IDX Size | Total Size |', screen[1]
+    assert_equal  '+--------------------------------+---------------+-----------+----------+------------+', screen[2]
   end
 
   def stub_config
@@ -95,7 +107,7 @@ class TasksTest < Test::Unit::TestCase
                   "database"=>"task_production",
                   "pool"=>5,
                   "username"=>"prod",
-                  "password"=>"prodpassword"}} 
+                  "password"=>"prodpassword"}}
   end
 
 

metadata

@@ -1,62 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: mysql_rake_tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Gregory Ostermayr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-09-05 00:00:00.000000000 -04:00
-default_executable: 
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &22621080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: '13.0'
   type: :development
   prerelease: false
-  version_requirements: *22621080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &22582860 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *22582860
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: test-unit-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &22582360 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.7
   type: :runtime
   prerelease: false
-  version_requirements: *22582360
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.7
 description: A collection of rails rake tasks for mysql.
 email:
 - gregory.ostermayr@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE
+- LICENSE.txt
 - README.rdoc
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - lib/mysql_rake_tasks.rb
@@ -66,31 +87,28 @@ files:
 - lib/mysql_rake_tasks/version.rb
 - mysql_rake_tasks.gemspec
 - test/tasks_test.rb
-has_rdoc: true
 homepage: https://github.com/gregors/mysql_rake_tasks
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mysql_rake_tasks
-rubygems_version: 1.6.2
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
 summary: Rake tasks for mysql
 test_files:
 - test/tasks_test.rb