migration_history 0.1.0

data/lib/migration_history/extractor.rb

@@ -0,0 +1,116 @@
+require "parser/current"
+
+class MigrationHistory::Extractor < Parser::AST::Processor
+  attr_reader :current_class, :actions
+  TABLE_DEFINITION_ADD_COLUMN_METHODS = %i(
+    column primary_key timestamps
+    blob tinyblob mediumblob longblob
+    tinytext mediumtext longtext unsigned_integer unsigned_bigint
+    unsigned_float unsigned_decimal bigserial bit bit_varying cidr citext daterange
+    hstore inet interval int4range int8range jsonb ltree macaddr
+    money numrange oid point line lseg box path polygon circle
+    serial tsrange tstzrange tsvector uuid xml timestamptz enum
+    bigint binary boolean date datetime decimal
+    float integer json string text time timestamp virtual
+  )
+
+  def initialize
+    @current_class = nil
+    @actions = []
+  end
+
+  def on_class(node)
+    class_name, _superclass, body = *node
+    @current_class = class_name.children[1].to_s
+    process(body)
+  end
+
+  def on_def(node)
+    method_name, _args, body = *node
+    @current_method = method_name
+    if %i(up change).include?(method_name)
+      process(body)
+    end
+    @current_method = nil
+  end
+
+  def on_send(node)
+    return unless @current_method
+    receiver, method_name, *args = *node
+    return unless receiver.nil?
+
+    case method_name
+    when :create_table
+      table_name = args.first.children.first
+      options = extract_options(args[1])
+      @actions << { action: :create_table, details: { table_name: table_name, options: options } }
+    when :add_column
+      table_name = args.first.children.first
+      options = extract_options(args[1])
+      @actions << { action: :add_column, details: { table_name: table_name, column_name: args[1].children.first, type: args[2].children.first, options: options } }
+    end
+  end
+
+  def on_block(node)
+    return unless @current_method
+    send_node, args, body = *node
+    _, method_name, *_ = *send_node
+
+    table_name = send_node.children.try(:[], 2)&.children&.first
+    table_var_name = args.children&.first&.children&.first
+
+    return unless table_name && table_var_name
+
+    case method_name
+    when :create_table
+      @actions << { action: :create_table, details: { table_name: table_name, options: {} } }
+    end
+
+    handle_table_block(body, table_name, table_var_name)
+  end
+
+
+  def extract_options(option_hash_node)
+    return {} unless option_hash_node&.type == :hash
+
+    option_hash_node.children.each_with_object({}) do |pair, hash|
+      key, value = pair.children
+      hash[key.children.first] = value.children.first
+    end
+  end
+
+  private
+    def handle_table_block(body, table_name, table_var_name)
+      body.children.each do |child|
+        next if child.nil? || child.is_a?(Symbol)
+        next unless child.type == :send
+
+        receiver, method_name, *args = *child
+        next unless receiver&.type == :lvar && receiver.children.first == table_var_name
+        if TABLE_DEFINITION_ADD_COLUMN_METHODS.include?(method_name)
+          if method_name == :timestamps
+            %i(created_at updated_at).each do |column_name|
+              @actions << {
+                action: :add_column,
+                details: { table_name: table_name, column_name: column_name, type: :datetime, options: {} }
+              }
+            end
+          else
+            column_name = args[0]&.children&.first
+            type = not_column_type_method?(method_name) ? args[1].children.first : method_name
+            options = not_column_type_method?(method_name) ? extract_options(args[2]) : extract_options(args[1])
+
+            next unless column_name
+            @actions << {
+              action: :add_column,
+              details: { table_name: table_name, column_name: column_name, type: type, options: options }
+            }
+          end
+        end
+      end
+    end
+
+    def not_column_type_method?(method_name)
+      %i(primary_key column).include?(method_name)
+    end
+end

data/lib/migration_history/formatter/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MigrationHistory
+  module Formatter
+    class Base
+      attr_accessor :output_file_name
+
+      DEFAULT_OUTPUT_FILE_NAME = "migration_history"
+
+      def initialize
+        @migration_actions = []
+        @output_file_name ||= DEFAULT_OUTPUT_FILE_NAME
+      end
+
+      def format(result_set)
+        raise NotImplementedError
+      end
+
+      def file_extension
+        raise NotImplementedError
+      end
+
+      def output_file_name_with_extension
+        "#{output_file_name}.#{file_extension}"
+      end
+    end
+  end
+end

data/lib/migration_history/formatter/html_formatter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "migration_history/formatter/base"
+
+module MigrationHistory
+  module Formatter
+    class HtmlFormatter < Base
+      def format(result_set)
+        File.open(File.join(Dir.pwd, output_file_name_with_extension), "wb") do |file|
+          file.puts template("template").result(binding)
+        end
+      end
+
+      def template(name)
+        ERB.new(File.read(File.join(File.dirname(__FILE__), "../../../views/", "#{name}.erb")))
+      end
+
+      def file_extension
+        "html"
+      end
+    end
+  end
+end

data/lib/migration_history/formatter/json_formatter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "migration_history/formatter/base"
+
+module MigrationHistory
+  module Formatter
+    class JsonFormatter < Base
+      def format(result_set)
+        File.open(File.join(Dir.pwd, output_file_name_with_extension), "wb") do |file|
+          file.puts result_set.original_result.to_json
+        end
+      end
+
+      def file_extension
+        "json"
+      end
+    end
+  end
+end

data/lib/migration_history/query.rb

@@ -0,0 +1,51 @@
+require "migration_history/result_set"
+require "migration_history/tracker"
+
+module MigrationHistory
+  module QueryMethods
+    @migration_file_dir = "db/migrate"
+    @tracker = nil
+
+    module ClassMethods
+      attr_accessor :migration_file_dir
+
+      def filter(table_name, column_name = nil, action_name = nil)
+        table_name = table_name.to_sym
+        column_name = column_name.to_sym if column_name
+        action_name = action_name.to_sym if action_name
+        raise InvalidError.new("Table name is required") unless table_name
+
+        found_migration_info = {}
+        tracker.migration_info.values.each do |v|
+          if v[:actions].to_a.any? { |action|
+              action.dig(:details, :table_name) == table_name &&
+                (column_name.nil? || action.dig(:details, :column_name) == column_name) &&
+                (action_name.nil? || action[:action] == action_name)
+            }
+
+            found_migration_info[v[:class_name]] = v
+          end
+        end
+
+        ResultSet.new(found_migration_info)
+      end
+
+      def all
+        ResultSet.new(tracker.migration_info)
+      end
+
+      def tracker
+        @tracker ||= Tracker.new(migration_file_dir).tap(&:setup!)
+      end
+
+      def reload!
+        @tracker = nil
+        tracker
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/migration_history/result_set.rb

@@ -0,0 +1,17 @@
+require "migration_history/formatter/base"
+require "migration_history/formatter/html_formatter"
+
+module MigrationHistory
+  class ResultSet
+    attr_accessor :original_result
+
+    def initialize(original_result)
+      @original_result = original_result
+    end
+
+    def format!
+      formatter = HTMLFormatter.new
+      formatter.format(self)
+    end
+  end
+end

data/lib/migration_history/tracker.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "migration_history/extractor"
+
+module MigrationHistory
+  class Tracker
+    attr_accessor :migration_info, :migration_file_dir
+
+    def initialize(migration_file_dir = nil)
+      @migration_file_dir = migration_file_dir || "db/migrate"
+      @migration_info = {}
+    end
+
+    def setup!
+      migration_path = File.expand_path(File.join(Dir.pwd, @migration_file_dir))
+      migration_files = Dir.glob(File.join(migration_path, "*.rb"))
+
+      migration_files.each do |file|
+        result = extract_migration_methods(file)
+        @migration_info[result[:class_name]] = result
+        @migration_info[result[:class_name]][:timestamp] = File.basename(file).split("_").first.to_i
+      end
+    end
+
+    private
+      def extract_migration_methods(file_path)
+        code = File.read(file_path)
+        ast = Parser::CurrentRuby.parse(code)
+        return unless ast
+
+        visitor = MigrationHistory::Extractor.new
+        visitor.process(ast)
+
+        {
+          file_path: File.basename(file_path),
+          class_name: visitor.current_class,
+          actions: visitor.actions
+        }
+      end
+  end
+end

data/lib/migration_history/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MigrationHistory
+  VERSION = "0.1.0"
+end

data/lib/migration_history.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "migration_history/cli"
+require "migration_history/query"
+require "active_record"
+require "rails"
+
+module MigrationHistory
+  include QueryMethods
+  class InvalidError
+    def initialize(message)
+      @message = message
+    end
+  end
+end

data/migration_history.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "migration_history/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "migration_history"
+  spec.version       = MigrationHistory::VERSION
+  spec.authors       = ["a5-stable"]
+  spec.email         = ["sh07e1916@gmail.com"]
+
+  spec.summary       = "A Gem to track and collect migration history in Rails projects, including when tables and columns were added, with details available in various formats"
+  spec.description   = "Track and collect detailed migration history in Rails, including table/column changes, with flexible output formats such as HTML, CLI, and more."
+  spec.homepage      = "https://github.com/a5-stable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/a5-stable/migration_history"
+    spec.metadata["changelog_uri"] = "https://github.com/a5-stable/migration_history"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 6.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 12.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "thor", "~> 1.0"
+end

data/views/template.erb

@@ -0,0 +1,282 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Migration History</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        margin: 0;
+        padding: 0;
+        background-color: #f4f4f4;
+      }
+      .container {
+        width: 80%;
+        margin: 0 auto;
+        padding: 20px;
+        background-color: #fff;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+        border-radius: 8px;
+      }
+      h1 {
+        text-align: center;
+        color: #333;
+        margin-bottom: 20px;
+      }
+      .filter-container {
+        display: flex;
+        flex-wrap: wrap;
+        gap: 20px;
+        padding: 15px;
+        background-color: #fafafa;
+        border: 1px solid #ddd;
+        border-radius: 8px;
+        margin-bottom: 20px;
+      }
+      .filter-group {
+        flex: 1;
+        min-width: 200px;
+      }
+      .filter-group label {
+        display: block;
+        font-weight: bold;
+        margin-bottom: 5px;
+      }
+      .filter-group input {
+        width: 100%;
+        padding: 10px;
+        border: 1px solid #ccc;
+        border-radius: 4px;
+        box-sizing: border-box;
+      }
+      .date-filter .date-inputs {
+        display: flex;
+        flex-wrap: wrap;
+        gap: 10px;
+      }
+      .date-filter button {
+        padding: 10px 15px;
+        background-color: #007BFF;
+        color: #fff;
+        border: none;
+        border-radius: 4px;
+        cursor: pointer;
+        transition: background-color 0.3s;
+      }
+      .date-filter button:hover {
+        background-color: #0056b3;
+      }
+      .date-filter-wrapper {
+        background-color: #f0f0f0; /* 任意の背景色 */
+        padding: 15px;
+        border-radius: 8px; /* 任意の角丸 */
+      }
+      .date-filter-wrapper .date-filter {
+        margin-bottom: 10px;
+      }
+      table {
+        width: 100%;
+        border-collapse: collapse;
+        margin-bottom: 20px;
+        table-layout: fixed;
+        word-break: break-all;
+        word-wrap: break-all;
+      }
+      th, td {
+        padding: 12px;
+        text-align: left;
+        border: 1px solid #ddd;
+      }
+      th {
+        background-color: #f4f4f4;
+        position: sticky;
+        top: 0;
+        z-index: 1;
+      }
+      th.sortable-header {
+        cursor: pointer;
+        user-select: none;
+      }
+      th.sortable-header:hover {
+        background-color: #eaeaea;
+      }
+      tr:nth-child(even) {
+        background-color: #f9f9f9;
+      }
+      tr:hover {
+        background-color: #f1f1f1;
+      }
+      .sort-arrow {
+        margin-left: 5px;
+        visibility: hidden;
+      }
+      .sorted-asc .sort-arrow::after {
+        content: '▲';
+      }
+      .sorted-desc .sort-arrow::after {
+        content: '▼';
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <h1>Migration History</h1>
+      <div class="filter-container">
+        <div class="filter-group">
+          <label for="searchInput">Keyword Search</label>
+          <input type="text" id="searchInput" placeholder="Search by any keyword...">
+        </div>
+        <div class="filter-group">
+          <label for="searchInputByCol1">Target Table</label>
+          <input type="text" id="searchInputByCol1" placeholder="Search Target Table" onkeyup="filterTable(1)">
+        </div>
+        <div class="filter-group">
+          <label for="searchInputByCol2">Action</label>
+          <input type="text" id="searchInputByCol2" placeholder="Search Action" onkeyup="filterTable(2)">
+        </div>
+        <div class="filter-group date-filter-wrapper">
+          <div class="filter-group date-filter">
+            <label>Date Range</label>
+            <div class="date-inputs">
+              <input type="date" id="searchInputBydatetimeStart" aria-label="Start Date">
+              <input type="date" id="searchInputBydatetimeEnd" aria-label="End Date">
+              <button onclick="filterByDateRange()">Filter by Date</button>
+            </div>
+          </div>
+        </div>
+      </div>
+      <table id="migrationTable">
+        <thead>
+          <tr id="migrationTable-header">
+            <th class="sortable-header" onclick="sortTable(0)">DateTime <span class="sort-arrow"></span></th>
+            <th class="sortable-header" onclick="sortTable(1)">Target Table <span class="sort-arrow"></span></th>
+            <th class="sortable-header" onclick="sortTable(2)">Action <span class="sort-arrow"></span></th>
+            <th>Details</th>
+            <th>File Name</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% result_set.original_result.each_value do |migration| %>
+            <% migration[:actions].each do |action| %>
+              <tr class="migrationTable-row">
+                <td><%= Time.parse(migration[:timestamp].to_s).strftime('%Y-%m-%d %H:%M') %></td>
+                <td><%= action.dig(:details, :table_name) %></td>
+                <td><%= action[:action] %></td>
+                <td>
+                  Table: <%= action.dig(:details, :table_name) %><br>
+                  <% if action.dig(:details, :column_name) %>
+                    Column: <%= action.dig(:details, :column_name) %><br>
+                    Type: <%= action.dig(:details, :type) %><br>
+                  <% end %>
+                  Options: <%= action.dig(:details, :options).inspect %>
+                </td>
+                <td><%= migration[:file_path] %></td>
+              </tr>
+            <% end %>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <script>
+      let currentSortColumn = null; // To store the current sorted column index
+      let currentSortDirection = true; // true for ascending, false for descending
+
+      document.getElementById('searchInput').addEventListener('input', function() {
+        const filter = this.value.toLowerCase();
+        const rows = document.querySelectorAll('#migrationTable .migrationTable-row');
+
+        rows.forEach(row => {
+          const text = row.textContent.toLowerCase();
+          row.style.display = text.includes(filter) ? '' : 'none';
+        });
+      });
+
+      document.querySelectorAll('.searchInputByCol').forEach((input, index) => {
+        input.addEventListener('input', function() {
+          filterTable(index);
+        });
+      });
+
+      function filterTable(index) {
+        const filter = document.getElementById(`searchInputByCol${index}`).value.toLowerCase();
+        const rows = document.querySelectorAll('#migrationTable .migrationTable-row');
+
+        rows.forEach(row => {
+          const text = row.querySelectorAll('td')[index].textContent.toLowerCase();
+          row.style.display = text.includes(filter) ? '' : 'none';
+        });
+      }
+
+      function filterByDateRange() {
+        const startInput = document.getElementById('searchInputBydatetimeStart').value;
+        const endInput = document.getElementById('searchInputBydatetimeEnd').value;
+        const startDate = startInput ? new Date(startInput) : null;
+        const endDate = endInput ? new Date(endInput) : null;
+        const rows = document.querySelectorAll('#migrationTable .migrationTable-row');
+
+        rows.forEach(row => {
+          const dateCell = row.cells[0];
+          if (dateCell) {
+            const rowDate = new Date(dateCell.textContent.trim());
+            if (
+              (!startDate || rowDate >= startDate) &&
+              (!endDate || rowDate <= endDate)
+            ) {
+              row.style.display = '';
+            } else {
+              row.style.display = 'none';
+            }
+          }
+        });
+      }
+
+      function sortTable(columnIndex) {
+        const rows = Array.from(document.querySelectorAll('#migrationTable .migrationTable-row'));
+        const direction = currentSortColumn === columnIndex && currentSortDirection ? -1 : 1; // Toggle sort direction if same column
+
+        // Reset all column arrows
+        resetSortArrows();
+
+        rows.sort((rowA, rowB) => {
+          const cellA = rowA.cells[columnIndex].textContent.trim();
+          const cellB = rowB.cells[columnIndex].textContent.trim();
+
+          if (columnIndex === 0) { // For DateTime column, we compare Date objects
+            return (new Date(cellA) - new Date(cellB)) * direction;
+          }
+
+          return cellA.localeCompare(cellB) * direction;
+        });
+
+        rows.forEach(row => document.querySelector('tbody').appendChild(row));
+
+        // Update current sort column and direction
+        currentSortColumn = columnIndex;
+        currentSortDirection = direction === 1;
+
+        updateSortArrows();
+      }
+
+      function resetSortArrows() {
+        const headerCells = document.querySelectorAll('#migrationTable th');
+        headerCells.forEach(th => {
+          th.classList.remove('sorted-asc', 'sorted-desc');
+        });
+      }
+
+      function updateSortArrows() {
+        const headerCells = document.querySelectorAll('#migrationTable th');
+        const arrow = headerCells[currentSortColumn].querySelector('.sort-arrow');
+        if (!arrow) return;
+        if (currentSortDirection) {
+          headerCells[currentSortColumn].classList.add('sorted-asc');
+        } else {
+          headerCells[currentSortColumn].classList.add('sorted-desc');
+        }
+        arrow.style.visibility = 'visible';
+      }
+    </script>
+  </body>
+</html>