roo-oxide 0.0.2

data/lib/roo/oxide.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "roo"
+require "roo/excelx"
+require_relative "oxide/version"
+
+if Roo.const_defined?(:Calamine, false) && !Roo::Calamine.equal?(Roo::Oxide)
+  raise LoadError, "Replace roo-calamine with roo-oxide in your Gemfile before loading roo/oxide"
+end
+
+Roo::Calamine = Roo::Oxide unless Roo.const_defined?(:Calamine, false)
+
+module Roo
+  # Reads `.xlsx` and `.xlsm` worksheets for Roo::Excelx with a native
+  # extension. Loading this file is all it takes; `Roo::Oxide.enabled =
+  # false` or `ROO_OXIDE=0` switches back to roo's own reader at runtime.
+  module Oxide
+    # Raised by the native reader for XML it does not reproduce exactly the
+    # way roo reads it. Roo::Oxide rescues it and lets roo read the sheet.
+    class UnsupportedError < StandardError; end
+
+    DISABLING_ENV_VALUES = %w[0 false off].freeze
+    private_constant :DISABLING_ENV_VALUES
+
+    @enabled = true
+
+    class << self
+      attr_writer :enabled
+
+      # Whether the native extension is loaded. It is `false` on Ruby
+      # implementations other than CRuby, such as JRuby.
+      def available?
+        defined?(Native::Reader) ? true : false
+      end
+
+      # Whether the next worksheet read goes through the native reader.
+      def enabled?
+        environment = ENV.fetch("ROO_OXIDE") { ENV.fetch("ROO_CALAMINE", "") }
+        @enabled && available? && !DISABLING_ENV_VALUES.include?(environment.downcase)
+      end
+
+      # roo-oxide's own API, not roo's: yields each row of a worksheet as an
+      # Array of the values roo's cells return from `#value`, without building
+      # the cells. A row is what
+      # `Roo::Excelx#each_row_streaming(sheet:, pad_cells: true)` yields, with
+      # `cell&.value` in place of each cell: one entry per column from A up to
+      # the row's last cell, `nil` where the worksheet has no cell.
+      #
+      # `source` and `options` are what `Roo::Excelx.new` takes. The workbook
+      # is closed when the block returns. Without a block, returns an
+      # Enumerator.
+      def each_row_values(source, sheet: nil, **options, &block)
+        return enum_for(__method__, source, sheet:, **options) unless block
+
+        workbook = Roo::Excelx.new(source, options)
+        roo_sheet = workbook.sheet_for(sheet)
+        if available?
+          roo_sheet.instance_variable_get(:@sheet).each_row_values(roo_sheet, &block)
+        else
+          roo_sheet.each_row(pad_cells: true) { |cells| yield cells.map { |cell| cell&.value } }
+        end
+        nil
+      ensure
+        workbook&.close
+      end
+    end
+  end
+end
+
+if RUBY_ENGINE == "ruby"
+  begin
+    require "roo/oxide/#{RUBY_VERSION[/\d+\.\d+/]}/roo_oxide"
+  rescue LoadError
+    require "roo/oxide/roo_oxide"
+  end
+  require_relative "oxide/context"
+  require_relative "oxide/deferred_sheets"
+  require_relative "oxide/sheet_doc"
+  require_relative "oxide/sheet_parts"
+  require_relative "oxide/excelx"
+  require_relative "oxide/csv"
+  require_relative "oxide/formatters"
+  require_relative "oxide/row_index"
+  require_relative "oxide/row_iteration"
+  require_relative "oxide/sheet"
+  require_relative "oxide/shared_strings"
+  Roo::Excelx::SheetDoc.prepend(Roo::Oxide::DeferredSheetDoc)
+  Roo::Excelx::SheetDoc.prepend(Roo::Oxide::SheetDoc)
+  Roo::Excelx::SheetDoc.prepend(Roo::Oxide::SheetParts)
+  Roo::Excelx::Relationships.prepend(Roo::Oxide::HyperlinkRelationships)
+  Roo::Excelx::Sheet.prepend(Roo::Oxide::Sheet)
+  Roo::Excelx.prepend(Roo::Oxide::DeferredSheets)
+  Roo::Excelx.prepend(Roo::Oxide::Excelx)
+  Roo::Excelx.prepend(Roo::Oxide::SheetSelection)
+  Roo::Excelx::SharedStrings.prepend(Roo::Oxide::SharedStrings)
+  Roo::Excelx::Workbook.prepend(Roo::Oxide::MetadataDocument)
+  Roo::Excelx::Styles.prepend(Roo::Oxide::MetadataDocument)
+  Roo::Excelx.prepend(Roo::Oxide::CSV)
+  Roo::Excelx.prepend(Roo::Oxide::Formatters)
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: roo-oxide
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sebastian Sala
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.130
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.130
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: An unofficial acceleration layer built on top of Roo. Add roo-oxide to
+  the Gemfile; Roo is installed as a dependency and its spreadsheet API stays the
+  same. A Rust extension speeds up XLSX and XLSM reads while preserving Roo's cell
+  and value rules. Unsupported input uses Roo's own reader. Not affiliated with roo-rb.
+executables: []
+extensions:
+- ext/roo_oxide/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
+- LICENSE
+- README.md
+- ext/roo_oxide/Cargo.toml
+- ext/roo_oxide/extconf.rb
+- ext/roo_oxide/src/archive.rs
+- ext/roo_oxide/src/convert.rs
+- ext/roo_oxide/src/convert/cells.rs
+- ext/roo_oxide/src/convert/csv.rs
+- ext/roo_oxide/src/lib.rs
+- ext/roo_oxide/src/numeric.rs
+- ext/roo_oxide/src/reader.rs
+- ext/roo_oxide/src/reader/attributes.rs
+- ext/roo_oxide/src/reader/tests.rs
+- ext/roo_oxide/src/shared_strings.rs
+- ext/roo_oxide/src/sheet_parts.rs
+- ext/roo_oxide/src/store.rs
+- ext/roo_oxide/src/store/formatters.rs
+- lib/roo/calamine.rb
+- lib/roo/calamine/version.rb
+- lib/roo/oxide.rb
+- lib/roo/oxide/context.rb
+- lib/roo/oxide/csv.rb
+- lib/roo/oxide/deferred_sheets.rb
+- lib/roo/oxide/excelx.rb
+- lib/roo/oxide/formatters.rb
+- lib/roo/oxide/row_index.rb
+- lib/roo/oxide/row_iteration.rb
+- lib/roo/oxide/shared_strings.rb
+- lib/roo/oxide/sheet.rb
+- lib/roo/oxide/sheet_doc.rb
+- lib/roo/oxide/sheet_parts.rb
+- lib/roo/oxide/version.rb
+homepage: https://github.com/salasebas/roo-oxide
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/salasebas/roo-oxide
+  source_code_uri: https://github.com/salasebas/roo-oxide/tree/v0.0.2
+  changelog_uri: https://github.com/salasebas/roo-oxide/blob/v0.0.2/CHANGELOG.md
+  bug_tracker_uri: https://github.com/salasebas/roo-oxide/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rust-powered native acceleration for Roo's XLSX and XLSM readers.
+test_files: []