innodb_ruby 0.9.14 → 0.12.0

data/lib/innodb/stats.rb

@@ -1,46 +1,44 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 
 # Collect stats globally within innodb_ruby for comparison purposes and for
 # correctness checking.
-class Innodb::Stats
-  @@data = Hash.new(0)
+module Innodb
+  class Stats
+    @data = Hash.new(0)
 
-  # Return the data hash directly.
-  def self.data
-    @@data
-  end
-
-  # Increment a statistic by name (typically a symbol), optionally by a value
-  # provided.
-  def self.increment(name, value=1)
-    @@data[name] += value
-  end
+    class << self
+      attr_reader :data
+    end
 
-  # Get a statistic by name.
-  def self.get(name)
-    @@data[name]
-  end
+    # Increment a statistic by name (typically a symbol), optionally by a value
+    # provided.
+    def self.increment(name, value = 1)
+      @data[name] += value
+    end
 
-  # Reset all statistics.
-  def self.reset
-    @@data.clear
-    nil
-  end
+    # Get a statistic by name.
+    def self.get(name)
+      @data[name]
+    end
 
-  # Print a simple report of collected statistics, optionally to the IO object
-  # provided, or by default to STDOUT.
-  def self.print_report(io=STDOUT)
-    io.puts "%-50s%10s" % [
-      "Statistic",
-      "Count",
-    ]
-    @@data.sort.each do |name, count|
-      io.puts "%-50s%10i" % [
-        name,
-        count
-      ]
+    # Reset all statistics.
+    def self.reset
+      @data.clear
+      nil
     end
 
-    nil
+    # Print a simple report of collected statistics, optionally to the IO object
+    # provided, or by default to STDOUT.
+    def self.print_report(io = $stdout)
+      io.puts "%-50s%10s" % %w[Statistic Count]
+      @data.sort.each do |name, count|
+        io.puts "%-50s%10i" % [
+          name,
+          count,
+        ]
+      end
+
+      nil
+    end
   end
 end

data/lib/innodb/system.rb

@@ -1,230 +1,208 @@
-# -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 
 # A class representing an entire InnoDB system, having a system tablespace
 # and any number of attached single-table tablespaces.
-class Innodb::System
-  # A hash of configuration options by configuration key.
-  attr_reader :config
-
-  # A hash of spaces by space ID.
-  attr_reader :spaces
-
-  # Array of space names for which a space file was not found.
-  attr_reader :orphans
-
-  # The Innodb::DataDictionary for this system.
-  attr_reader :data_dictionary
-
-  # The space ID of the system space, always 0.
-  SYSTEM_SPACE_ID = 0
-
-  def initialize(arg)
-    if arg.is_a?(Array) && arg.size > 1
-      data_filenames = arg
-    else
-      arg = arg.first if arg.is_a?(Array)
-      if File.directory?(arg)
-        data_filenames = Dir.glob(arg + "/ibdata?").sort
-        if data_filenames.empty?
-          raise "Couldn't find any ibdata files in #{arg}"
-        end
-      else
-        data_filenames = [arg]
-      end
-    end
+module Innodb
+  class System
+    # A hash of configuration options by configuration key.
+    attr_reader :config
 
-    @spaces = {}
-    @orphans = []
-    @config = {
-      :datadir => File.dirname(data_filenames.first),
-    }
+    # A hash of spaces by space ID.
+    attr_reader :spaces
 
-    add_space_file(data_filenames)
+    # Array of space names for which a space file was not found.
+    attr_reader :orphans
 
-    @data_dictionary = Innodb::DataDictionary.new(system_space)
-  end
+    # The Innodb::DataDictionary for this system.
+    attr_reader :data_dictionary
 
-  # A helper to get the system space.
-  def system_space
-    spaces[SYSTEM_SPACE_ID]
-  end
+    # The space ID of the system space, always 0.
+    SYSTEM_SPACE_ID = 0
 
-  # Add an already-constructed Innodb::Space object.
-  def add_space(space)
-    unless space.is_a?(Innodb::Space)
-      raise "Object was not an Innodb::Space"
-    end
+    def initialize(arg, data_directory: nil)
+      if arg.is_a?(Array) && arg.size > 1
+        data_filenames = arg
+      else
+        arg = arg.first if arg.is_a?(Array)
+        if File.directory?(arg)
+          data_filenames = Dir.glob("#{arg}/ibdata?").sort
+          raise "Couldn't find any ibdata files in #{arg}" if data_filenames.empty?
+        else
+          data_filenames = [arg]
+        end
+      end
 
-    spaces[space.space_id.to_i] = space
-  end
+      @spaces = {}
+      @orphans = []
+      @config = {
+        data_directory: data_directory || File.dirname(data_filenames.first),
+      }
 
-  # Add a space by filename.
-  def add_space_file(space_filenames)
-    space = Innodb::Space.new(space_filenames)
-    space.innodb_system = self
-    add_space(space)
-  end
+      add_space_file(data_filenames)
 
-  # Add an orphaned space.
-  def add_space_orphan(space_file)
-    orphans << space_file
-  end
+      @data_dictionary = Innodb::DataDictionary.new(system_space)
+    end
 
-  # Add a space by table name, constructing an appropriate filename
-  # from the provided table name.
-  def add_table(table_name)
-    space_file = "%s/%s.ibd" % [config[:datadir], table_name]
-    if File.exist?(space_file)
-      add_space_file(space_file)
-    else
-      add_space_orphan(table_name)
+    # A helper to get the system space.
+    def system_space
+      spaces[SYSTEM_SPACE_ID]
     end
-  end
 
-  # Return an Innodb::Space object for a given space ID, looking up
-  # and adding the single-table space if necessary.
-  def space(space_id)
-    return spaces[space_id] if spaces[space_id]
+    # Add an already-constructed Innodb::Space object.
+    def add_space(space)
+      raise "Object was not an Innodb::Space" unless space.is_a?(Innodb::Space)
 
-    unless table_record = data_dictionary.table_by_space_id(space_id)
-      raise "Table with space ID #{space_id} not found"
+      spaces[space.space_id.to_i] = space
     end
 
-    add_table(table_record["NAME"])
-
-    spaces[space_id]
-  end
+    # Add a space by filename.
+    def add_space_file(space_filenames)
+      space = Innodb::Space.new(space_filenames)
+      space.innodb_system = self
+      add_space(space)
+    end
 
-  # Return an Innodb::Space object by table name.
-  def space_by_table_name(table_name)
-    unless table_record = data_dictionary.table_by_name(table_name)
-      raise "Table #{table_name} not found"
+    # Add an orphaned space.
+    def add_space_orphan(space_file)
+      orphans << space_file
     end
 
-    if table_record["SPACE"] == 0
-      return nil
+    # Add a space by table name, constructing an appropriate filename
+    # from the provided table name.
+    def add_table(table_name)
+      space_file = "%s/%s.ibd" % [config[:data_directory], table_name]
+      if File.exist?(space_file)
+        add_space_file(space_file)
+      else
+        add_space_orphan(table_name)
+      end
     end
 
-    space(table_record["SPACE"])
-  end
+    # Return an Innodb::Space object for a given space ID, looking up
+    # and adding the single-table space if necessary.
+    def space(space_id)
+      return spaces[space_id] if spaces[space_id]
 
-  # Iterate through all table names.
-  def each_table_name
-    unless block_given?
-      return enum_for(:each_table_name)
-    end
+      unless (table_record = data_dictionary.table_by_space_id(space_id))
+        raise "Table with space ID #{space_id} not found"
+      end
+
+      add_table(table_record["NAME"])
 
-    data_dictionary.each_table do |record|
-      yield record["NAME"]
+      spaces[space_id]
     end
 
-    nil
-  end
+    # Return an Innodb::Space object by table name.
+    def space_by_table_name(table_name)
+      unless (table_record = data_dictionary.table_by_name(table_name))
+        raise "Table #{table_name} not found"
+      end
 
-  # Iterate throught all orphaned spaces.
-  def each_orphan
-    unless block_given?
-      return enum_for(:each_orphan)
-    end
+      return if table_record["SPACE"].zero?
 
-    orphans.each do |space_name|
-      yield space_name
+      space(table_record["SPACE"])
     end
 
-    nil
-  end
+    # Iterate through all table names.
+    def each_table_name
+      return enum_for(:each_table_name) unless block_given?
 
-  # Iterate through all column names by table name.
-  def each_column_name_by_table_name(table_name)
-    unless block_given?
-      return enum_for(:each_column_name_by_table_name, table_name)
-    end
+      data_dictionary.each_table do |record|
+        yield record["NAME"]
+      end
 
-    data_dictionary.each_column_by_table_name(table_name) do |record|
-      yield record["NAME"]
+      nil
     end
 
-    nil
-  end
+    # Iterate throught all orphaned spaces.
+    def each_orphan(&block)
+      return enum_for(:each_orphan) unless block_given?
 
-  # Iterate through all index names by table name.
-  def each_index_name_by_table_name(table_name)
-    unless block_given?
-      return enum_for(:each_index_name_by_table_name, table_name)
-    end
+      orphans.each(&block)
 
-    data_dictionary.each_index_by_table_name(table_name) do |record|
-      yield record["NAME"]
+      nil
     end
 
-    nil
-  end
+    # Iterate through all column names by table name.
+    def each_column_name_by_table_name(table_name)
+      return enum_for(:each_column_name_by_table_name, table_name) unless block_given?
 
-  # Iterate through all field names in a given index by table name
-  # and index name.
-  def each_index_field_name_by_index_name(table_name, index_name)
-    unless block_given?
-      return enum_for(:each_index_field_name_by_index_name,
-                      table_name, index_name)
+      data_dictionary.each_column_by_table_name(table_name) do |record|
+        yield record["NAME"]
+      end
+
+      nil
     end
 
-    data_dictionary.each_field_by_index_name(table_name, index_name) do |record|
-      yield record["COL_NAME"]
+    # Iterate through all index names by table name.
+    def each_index_name_by_table_name(table_name)
+      return enum_for(:each_index_name_by_table_name, table_name) unless block_given?
+
+      data_dictionary.each_index_by_table_name(table_name) do |record|
+        yield record["NAME"]
+      end
+
+      nil
     end
 
-    nil
-  end
+    # Iterate through all field names in a given index by table name
+    # and index name.
+    def each_index_field_name_by_index_name(table_name, index_name)
+      return enum_for(:each_index_field_name_by_index_name, table_name, index_name) unless block_given?
+
+      data_dictionary.each_field_by_index_name(table_name, index_name) do |record|
+        yield record["COL_NAME"]
+      end
 
-  # Return the table name given a table ID.
-  def table_name_by_id(table_id)
-    if table_record = data_dictionary.table_by_id(table_id)
-      table_record["NAME"]
+      nil
     end
-  end
 
-  # Return the index name given an index ID.
-  def index_name_by_id(index_id)
-    if index_record = data_dictionary.index_by_id(index_id)
-      index_record["NAME"]
+    # Return the table name given a table ID.
+    def table_name_by_id(table_id)
+      data_dictionary.table_by_id(table_id).fetch("NAME", nil)
     end
-  end
 
-  # Return the clustered index name given a table name.
-  def clustered_index_by_table_name(table_name)
-    data_dictionary.clustered_index_name_by_table_name(table_name)
-  end
+    # Return the index name given an index ID.
+    def index_name_by_id(index_id)
+      data_dictionary.index_by_id(index_id).fetch("NAME", nil)
+    end
 
-  # Return an array of the table name and index name given an index ID.
-  def table_and_index_name_by_id(index_id)
-    if dd_index = data_dictionary.data_dictionary_index_ids[index_id]
-      # This is a data dictionary index, which won't be found in the data
-      # dictionary itself.
-      [dd_index[:table], dd_index[:index]]
-    elsif index_record = data_dictionary.index_by_id(index_id)
-      # This is a system or user index.
-      [table_name_by_id(index_record["TABLE_ID"]), index_record["NAME"]]
+    # Return the clustered index name given a table name.
+    def clustered_index_by_table_name(table_name)
+      data_dictionary.clustered_index_name_by_table_name(table_name)
     end
-  end
 
-  # Return an Innodb::Index object given a table name and index name.
-  def index_by_name(table_name, index_name)
-    index_record = data_dictionary.index_by_name(table_name, index_name)
+    # Return an array of the table name and index name given an index ID.
+    def table_and_index_name_by_id(index_id)
+      if (dd_index = data_dictionary.data_dictionary_index_ids[index_id])
+        # This is a data dictionary index, which won't be found in the data
+        # dictionary itself.
+        [dd_index[:table], dd_index[:index]]
+      elsif (index_record = data_dictionary.index_by_id(index_id))
+        # This is a system or user index.
+        [table_name_by_id(index_record["TABLE_ID"]), index_record["NAME"]]
+      end
+    end
 
-    index_space = space(index_record["SPACE"])
-    describer = data_dictionary.record_describer_by_index_name(table_name, index_name)
-    index = index_space.index(index_record["PAGE_NO"], describer)
+    # Return an Innodb::Index object given a table name and index name.
+    def index_by_name(table_name, index_name)
+      index_record = data_dictionary.index_by_name(table_name, index_name)
 
-    index
-  end
+      index_space = space(index_record["SPACE"])
+      describer = data_dictionary.record_describer_by_index_name(table_name, index_name)
+      index_space.index(index_record["PAGE_NO"], describer)
+    end
+
+    # Return the clustered index given a table ID.
+    def clustered_index_by_table_id(table_id)
+      table_name = table_name_by_id(table_id)
+      return unless table_name
 
-  # Return the clustered index given a table ID.
-  def clustered_index_by_table_id(table_id)
-    if table_name = table_name_by_id(table_id)
       index_by_name(table_name, clustered_index_by_table_name(table_name))
     end
-  end
 
-  def history
-    Innodb::History.new(self)
+    def history
+      Innodb::History.new(self)
+    end
   end
 end