xlg 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 487577ad7b07e1220696b70de189c3c098a39547c84dc8db0204b5420c4ae0af
+  data.tar.gz: 8e58a4ba07793fd06036bbeb3c03069938dab6fe5f3eb0aa21dc38a7d94912bf
+SHA512:
+  metadata.gz: 54c70a935c0b50d11d63e70f9d0203172afd17022f8bd058a2ddb8cc8e66de14524a561881d8070ca301d93aede144305c909c9a0fb9d389628bc69ee1dfeeff
+  data.tar.gz: da330328bb724784d21f0d1e59322f4eec091fbe57c48fc55ab03cee9238470867c8b321a2b833894a96cf69c80b830f528bfa800188b44b7744aee66516ca21

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2025 Kazto TAKAHASHI (@kazto)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+# xlg - Excel Grep Tool
+
+`xlg` is a command-line tool that provides functionality to search keywords in Excel files in various formats. It works like `grep` but for Excel files, outputting results in a grep-like format showing file, sheet, cell reference, and matched content.
+
+## Features
+
+- Search text in Excel files (.xlsx, .xls, .xlsm)
+- Support for single file, multiple files, and directory-based searches
+- Case-insensitive keyword matching
+- Grep-like output format: `filename:sheet:cell_ref:matched_text`
+- Automatic Excel file discovery in directories
+- Comprehensive error handling and validation
+
+## Installation
+
+Build and install the gem:
+
+```bash
+gem build gemspec
+gem install xlg-0.4.2.gem
+```
+
+Or install directly from the built gem files:
+
+```bash
+gem install xlg-0.4.2.gem
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+# Search in a single Excel file
+xlg 'keyword' sample.xlsx
+
+# Search in multiple Excel files
+xlg 'keyword' file1.xlsx file2.xlsx
+
+# Search all Excel files in a directory
+xlg 'keyword' /path/to/directory/
+```
+
+### Command Line Options
+
+```
+xlg KEYWORD FILE.xlsx                    # Single file search
+xlg KEYWORD FILE1.xlsx FILE2.xlsx       # Multiple file search
+xlg KEYWORD /path/to/directory/          # Directory search
+
+Options:
+  -h, --help  Show help message
+```
+
+### Examples
+
+```bash
+# Search for "test" in sample.xlsx
+xlg 'test' sample.xlsx
+
+# Search for "データ" in multiple files
+xlg 'データ' file1.xlsx file2.xlsx
+
+# Search for "keyword" in all Excel files in documents folder
+xlg 'キーワード' /home/user/documents/
+```
+
+## Output Format
+
+The output follows a grep-like format:
+
+```
+filename.xlsx:SheetName:A1:matched content
+filename.xlsx:SheetName:B5:another match
+```
+
+Where:
+- `filename.xlsx`: The Excel file name
+- `SheetName`: The worksheet name
+- `A1`: Cell reference (Excel format)
+- `matched content`: The actual cell content that contains the keyword
+
+## Supported File Formats
+
+- `.xlsx` (Excel 2007 and later)
+- `.xls` (Excel 97-2003)
+- `.xlsm` (Excel with macros)
+
+## Requirements
+
+- Ruby >= 3.0
+- rubyXL gem (~> 3.4) - automatically installed as dependency
+
+## Architecture
+
+The tool consists of four main components:
+
+- `ExcelGrep` (lib/excel_grep.rb): Core search functionality for single files
+- `MultiFileSearcher` (lib/multi_file_searcher.rb): Handles multiple files and directories
+- `CellMatcher` (lib/cell_matcher.rb): Performs case-insensitive text matching
+- `OutputFormatter` (lib/output_formatter.rb): Formats output in grep-like style
+
+## Development
+
+### Running Tests
+
+```bash
+ruby test/test_*.rb
+```
+
+### Project Structure
+
+```
+├── lib/
+│   ├── excel_grep.rb          # Main Excel search engine
+│   ├── multi_file_searcher.rb # Multi-file search coordination
+│   ├── cell_matcher.rb        # Text matching logic
+│   └── output_formatter.rb    # Output formatting
+├── bin/
+│   └── xlg                    # Command-line executable
+├── test/                      # Unit tests
+├── docs/                      # Documentation
+└── gemspec                    # Gem specification
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Author
+
+Kazto TAKAHASHI (kazto@kazto.dev)
+
+## Repository
+
+https://github.com/kazto/xlg

data/bin/xlg

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'excel_grep'
+require 'multi_file_searcher'
+
+def show_help
+  puts "使用方法:"
+  puts "  xlg KEYWORD FILE.xlsx                    # 単一ファイル"
+  puts "  xlg KEYWORD FILE1.xlsx FILE2.xlsx       # 複数ファイル"
+  puts "  xlg KEYWORD /path/to/directory/          # ディレクトリ内全検索"
+  puts ""
+  puts "Excel ファイル内の文字列を検索し、grep形式で出力します。"
+  puts ""
+  puts "引数:"
+  puts "  KEYWORD         検索するキーワード"
+  puts "  FILE.xlsx       検索対象のExcelファイル（複数指定可能）"
+  puts "  /path/to/dir/   検索対象のディレクトリ"
+  puts ""
+  puts "対応ファイル形式:"
+  puts "  .xlsx (Excel 2007以降)"
+  puts "  .xls  (Excel 97-2003)"
+  puts "  .xlsm (マクロ有効Excel)"
+  puts ""
+  puts "例:"
+  puts "  xlg 'test' sample.xlsx"
+  puts "  xlg 'データ' file1.xlsx file2.xlsx"
+  puts "  xlg 'キーワード' /home/user/documents/"
+  puts ""
+  puts "オプション:"
+  puts "  -h, --help  このヘルプを表示"
+end
+
+def main
+  if ARGV.include?('-h') || ARGV.include?('--help') || ARGV.length == 0
+    show_help
+    exit 0
+  end
+
+  if ARGV.length < 2
+    $stderr.puts "エラー: 引数の数が正しくありません"
+    $stderr.puts "使用方法: xlg KEYWORD FILE.xlsx [FILE2.xlsx ...]"
+    $stderr.puts "詳細は 'xlg --help' を参照してください"
+    exit 1
+  end
+
+  keyword = ARGV[0]
+  paths = ARGV[1..-1]
+
+  begin
+    if paths.length == 1
+      # 単一ファイル/ディレクトリの場合
+      path = paths[0]
+      if File.directory?(path)
+        # ディレクトリの場合はMultiFileSearcherを使用
+        searcher = MultiFileSearcher.new(keyword, [path])
+        success = searcher.search
+      else
+        # 単一ファイルの場合はExcelGrepを使用
+        grep = ExcelGrep.new(keyword, path)
+        success = grep.search
+      end
+    else
+      # 複数パスの場合はMultiFileSearcherを使用
+      searcher = MultiFileSearcher.new(keyword, paths)
+      success = searcher.search
+    end
+    
+    exit(success ? 0 : 1)
+  rescue ArgumentError => e
+    $stderr.puts "エラー: #{e.message}"
+    exit 1
+  rescue => e
+    $stderr.puts "予期しないエラーが発生しました: #{e.message}"
+    exit 1
+  end
+end
+
+main

data/lib/cell_matcher.rb

@@ -0,0 +1,22 @@
+class CellMatcher
+  def match?(cell_value, keyword)
+    return false if cell_value.nil? || keyword.nil? || keyword.empty?
+    
+    cell_str = cell_value.to_s
+    return false if cell_str.empty?
+    
+    cell_str.downcase.include?(keyword.downcase)
+  end
+
+  def extract_match(cell_value, keyword)
+    return nil unless match?(cell_value, keyword)
+    
+    cell_str = cell_value.to_s
+    keyword_lower = keyword.downcase
+    
+    start_index = cell_str.downcase.index(keyword_lower)
+    return nil if start_index.nil?
+    
+    cell_str[start_index, keyword.length]
+  end
+end

data/lib/excel_grep.rb

@@ -0,0 +1,62 @@
+require 'rubyXL'
+require 'cell_matcher'
+require 'output_formatter'
+
+class ExcelGrep
+  attr_reader :keyword, :file_path
+
+  def initialize(keyword, file_path)
+    raise ArgumentError, "キーワードが空です" if keyword.nil? || keyword.empty?
+    raise ArgumentError, "ファイルパスが空です" if file_path.nil? || file_path.empty?
+    
+    @keyword = keyword
+    @file_path = file_path
+    @matcher = CellMatcher.new
+    @formatter = OutputFormatter.new
+  end
+
+  def validate_file(file_path)
+    return false if file_path.nil? || file_path.empty?
+    return false unless File.exist?(file_path)
+    return false unless file_path.match?(/\.(xlsx?|xlsm)$/i)
+    
+    true
+  end
+
+  def search
+    unless validate_file(@file_path)
+      $stderr.puts "エラー: ファイルが見つかりません、またはExcelファイルではありません: #{@file_path}"
+      return false
+    end
+
+    begin
+      workbook = RubyXL::Parser.parse(@file_path)
+      file_name = File.basename(@file_path)
+      
+      workbook.worksheets.each do |worksheet|
+        next if worksheet.nil?
+        
+        sheet_name = worksheet.sheet_name || "Sheet#{worksheet.index + 1}"
+        
+        worksheet.each_with_index do |row, row_index|
+          next if row.nil?
+          
+          row.cells.each_with_index do |cell, col_index|
+            next if cell.nil? || cell.value.nil?
+            
+            cell_value = cell.value.to_s
+            if @matcher.match?(cell_value, @keyword)
+              cell_ref = RubyXL::Reference.ind2ref(row_index, col_index)
+              puts @formatter.format(file_name, sheet_name, cell_ref, cell_value)
+            end
+          end
+        end
+      end
+      
+      true
+    rescue => e
+      $stderr.puts "エラー: Excelファイルの読み込みに失敗しました: #{e.message}"
+      false
+    end
+  end
+end

data/lib/multi_file_searcher.rb

@@ -0,0 +1,68 @@
+require 'excel_grep'
+
+class MultiFileSearcher
+  attr_reader :keyword, :paths
+
+  def initialize(keyword, paths)
+    raise ArgumentError, "キーワードが空です" if keyword.nil? || keyword.empty?
+    raise ArgumentError, "パスが空です" if paths.nil? || paths.empty?
+    
+    @keyword = keyword
+    @paths = paths
+  end
+
+  def search
+    expanded_files = expand_paths(@paths)
+    success_count = 0
+    
+    expanded_files.each do |file_path|
+      begin
+        grep = ExcelGrep.new(@keyword, file_path)
+        if grep.search
+          success_count += 1
+        end
+      rescue => e
+        $stderr.puts "エラー: #{file_path} - #{e.message}"
+      end
+    end
+    
+    success_count > 0
+  end
+
+  def expand_paths(paths)
+    expanded = []
+    
+    paths.each do |path|
+      if File.directory?(path)
+        expanded.concat(find_excel_files(path))
+      else
+        expanded << path
+      end
+    end
+    
+    expanded.uniq
+  end
+
+  def find_excel_files(directory)
+    return [] unless File.exist?(directory) && File.directory?(directory)
+    
+    excel_files = []
+    
+    begin
+      Dir.entries(directory).each do |entry|
+        next if entry.start_with?('.')  # 隠しファイルとカレント/親ディレクトリを除外
+        
+        file_path = File.join(directory, entry)
+        next if File.directory?(file_path)  # サブディレクトリを除外
+        
+        if entry.match?(/\.(xlsx?|xlsm)$/i)
+          excel_files << file_path
+        end
+      end
+    rescue => e
+      $stderr.puts "ディレクトリ読み込みエラー: #{directory} - #{e.message}"
+    end
+    
+    excel_files.sort
+  end
+end

data/lib/output_formatter.rb

@@ -0,0 +1,5 @@
+class OutputFormatter
+  def format(file_name, sheet_name, cell_ref, match_text)
+    "#{file_name}:#{sheet_name}:#{cell_ref}:#{match_text}"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: xlg
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Kazto TAKAHASHI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: "`xlg` is a command-line tool that provides functionality to search keywords
+  in Excel files in various formats."
+email:
+- kazto@kazto.dev
+executables:
+- xlg
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/xlg
+- lib/cell_matcher.rb
+- lib/excel_grep.rb
+- lib/multi_file_searcher.rb
+- lib/output_formatter.rb
+homepage: https://github.com/kazto/xlg
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A Ruby library for reading and writing Excel files.
+test_files: []