ruby-xlsx-to-md 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04b972bb134e07ea537c1e0431f79d9bffc183f2ba1fbc742800fdea272c9a3c
+  data.tar.gz: ec40486fa5398ac8486d14d32964042162493768833c7b4ad36aaddabf022782
+SHA512:
+  metadata.gz: 15c2924fe19691acf5e4a73179abec751be66efe31e8c6deefcc5acd1f396e7af7d435c6d2e0243433bdc38c7f79b458d7c40f2e8d800efd3df4106abfa7b836
+  data.tar.gz: edb041679a40536a9fe381a78ae0e05fe0b4bc02f41ba76eed9fa035b797d074b6412ab5ffe7fcc6f8d89ef57314d28b98294995082f8cc485e388217cdbee91

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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,39 @@
+# ruby-xlsx-to-md
+
+A Ruby gem for converting XLSX spreadsheets to Markdown.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-xlsx-to-md"
+```
+
+Then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install ruby-xlsx-to-md
+```
+
+## Usage
+
+```ruby
+require "ruby_xlsx_to_md"
+
+RubyXlsxToMd.convert("spreadsheet.xlsx")
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Run `bundle exec rake test` to run the test suite.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |task|
+  task.libs << "test"
+  task.pattern = "test/**/*_test.rb"
+end
+
+task default: :test

data/lib/ruby_xlsx_to_md/encoding.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RubyXlsxToMd
+  module Encoding
+    BOMS = {
+      "\xEF\xBB\xBF".b => "UTF-8",
+      "\xFF\xFE".b     => "UTF-16LE",
+      "\xFE\xFF".b     => "UTF-16BE",
+    }.freeze
+
+    def self.detect(bytes)
+      BOMS.each do |bom, encoding|
+        return encoding if bytes.start_with?(bom)
+      end
+
+      utf8 = bytes.dup.force_encoding("UTF-8")
+      return "UTF-8" if utf8.valid_encoding?
+
+      "Windows-1252"
+    end
+
+    def self.to_utf8(bytes)
+      encoding = detect(bytes)
+
+      text = bytes.dup.force_encoding(encoding)
+      text = text.encode("UTF-8", invalid: :replace, undef: :replace)
+      text.delete_prefix!("\uFEFF")
+      text
+    end
+
+    def self.ensure_utf8(value)
+      return value if value.encoding == ::Encoding::UTF_8 && value.valid_encoding?
+
+      to_utf8(value.b)
+    end
+  end
+end

data/lib/ruby_xlsx_to_md/version.rb

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

data/lib/ruby_xlsx_to_md.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "rubyXL"
+
+require_relative "ruby_xlsx_to_md/version"
+require_relative "ruby_xlsx_to_md/encoding"
+
+module RubyXlsxToMd
+  class Error < StandardError; end
+
+  def self.convert(path)
+    workbook = RubyXL::Parser.parse(path)
+
+    workbook.worksheets.map do |sheet|
+      "---\n#{sheet.sheet_name}\n---\n#{sheet_to_markdown(sheet)}"
+    end.join("\n\n")
+  end
+
+  def self.sheet_to_markdown(sheet)
+    rows = sheet.sheet_data
+    min_c = nil ; max_c = nil
+
+    # Find column range across all rows
+    rows.rows.each_with_index do |row, _ri|
+      next if row.nil?
+      row.cells.each_with_index do |cell, ci|
+        next if cell.nil? || (cell.value.nil? || cell.value.to_s.strip.empty?)
+        min_c = ci if min_c.nil? || ci < min_c
+        max_c = ci if max_c.nil? || ci > max_c
+      end
+    end
+
+    return "" if min_c.nil?
+
+    lines = []
+
+    header = "| Row # |"
+    (min_c..max_c).each { |c| header += " #{col_letter(c)} |" }
+    lines << header
+
+    sep = "|---|"
+    (min_c..max_c).each { |_| sep += "---|" }
+    lines << sep
+
+    rows.rows.each_with_index do |row, ri|
+      vals = (min_c..max_c).map do |ci|
+        raw = row&.[](ci)&.value
+        val = raw.to_s.empty? ? "" : Encoding.ensure_utf8(raw.to_s)
+        val.include?("|") ? val.gsub("|", "\\|") : val
+      end
+      lines << "| #{ri + 1} | #{vals.join(" | ")} |"
+    end
+
+    lines.join("\n")
+  end
+
+  def self.col_letter(index)
+    letters = ""
+    loop do
+      letters = ((65 + (index % 26)).chr) + letters
+      index = index / 26 - 1
+      break if index < 0
+    end
+    letters
+  end
+
+end

data/mise.toml

@@ -0,0 +1,5 @@
+[tools]
+ruby = "3.4.7"
+
+[tasks]
+test = "bundle exec rake test TESTOPTS='--verbose'"

data/ruby-xlsx-to-md.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_xlsx_to_md/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-xlsx-to-md"
+  spec.version = RubyXlsxToMd::VERSION
+  spec.authors = ["Victor"]
+  spec.email = ["victorgt2406@github.com"]
+
+  spec.summary = "Convert XLSX spreadsheets to Markdown."
+  spec.description = "A Ruby gem for converting XLSX spreadsheets to Markdown."
+  spec.homepage = "https://github.com/victorgt2406/ruby-xlsx-to-md"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.start_with?("test/", "spec/", "features/", ".git", "pkg/")
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyXL", "~> 3.4"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ruby-xlsx-to-md
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Ruby gem for converting XLSX spreadsheets to Markdown.
+email:
+- victorgt2406@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_xlsx_to_md.rb
+- lib/ruby_xlsx_to_md/encoding.rb
+- lib/ruby_xlsx_to_md/version.rb
+- mise.toml
+- ruby-xlsx-to-md.gemspec
+homepage: https://github.com/victorgt2406/ruby-xlsx-to-md
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/victorgt2406/ruby-xlsx-to-md
+  source_code_uri: https://github.com/victorgt2406/ruby-xlsx-to-md
+  changelog_uri: https://github.com/victorgt2406/ruby-xlsx-to-md/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Convert XLSX spreadsheets to Markdown.
+test_files: []