rbxl 1.0.0

data/lib/rbxl/write_only_workbook.rb

@@ -0,0 +1,143 @@
+module Rbxl
+  class WriteOnlyWorkbook
+    attr_reader :worksheets
+
+    def initialize
+      @worksheets = []
+      @closed = false
+      @saved = false
+    end
+
+    def add_sheet(name)
+      ensure_writable!
+
+      sheet = WriteOnlyWorksheet.new(name: name)
+      @worksheets << sheet
+      sheet
+    end
+
+    def save(path)
+      ensure_writable!
+      raise Error, "at least one worksheet is required" if worksheets.empty?
+
+      Zip::OutputStream.open(path) do |zip|
+        write_entry(zip, "[Content_Types].xml", content_types_xml)
+        write_entry(zip, "_rels/.rels", root_rels_xml)
+        write_entry(zip, "xl/workbook.xml", workbook_xml)
+        write_entry(zip, "xl/_rels/workbook.xml.rels", workbook_rels_xml)
+        write_entry(zip, "xl/styles.xml", styles_xml)
+
+        worksheets.each_with_index do |sheet, index|
+          write_entry(zip, "xl/worksheets/sheet#{index + 1}.xml", sheet.to_xml)
+        end
+      end
+
+      @saved = true
+      close
+      path
+    end
+
+    def close
+      @closed = true
+    end
+
+    def closed?
+      @closed
+    end
+
+    private
+
+    def ensure_writable!
+      raise ClosedWorkbookError, "workbook has been closed" if closed?
+      raise WorkbookAlreadySavedError, "write-only workbook can only be saved once" if @saved
+    end
+
+    def write_entry(zip, name, content)
+      zip.put_next_entry(name)
+      zip.write(content)
+    end
+
+    def content_types_xml
+      worksheet_overrides = worksheets.each_index.map do |index|
+        %(<Override PartName="/xl/worksheets/sheet#{index + 1}.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"/>)
+      end.join
+
+      <<~XML.chomp
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types">
+          <Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/>
+          <Default Extension="xml" ContentType="application/xml"/>
+          <Override PartName="/xl/workbook.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"/>
+          <Override PartName="/xl/styles.xml" ContentType="application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"/>
+          #{worksheet_overrides}
+        </Types>
+      XML
+    end
+
+    def root_rels_xml
+      <<~XML.chomp
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+          <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="xl/workbook.xml"/>
+        </Relationships>
+      XML
+    end
+
+    def workbook_xml
+      sheet_nodes = worksheets.each_with_index.map do |sheet, index|
+        %(<sheet name="#{escape(sheet.name)}" sheetId="#{index + 1}" r:id="rId#{index + 1}"/>)
+      end.join
+
+      <<~XML.chomp
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <workbook xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships">
+          <sheets>#{sheet_nodes}</sheets>
+        </workbook>
+      XML
+    end
+
+    def workbook_rels_xml
+      relationship_nodes = worksheets.each_with_index.map do |_, index|
+        %(<Relationship Id="rId#{index + 1}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet" Target="worksheets/sheet#{index + 1}.xml"/>)
+      end
+      relationship_nodes << %(<Relationship Id="rId#{worksheets.length + 1}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" Target="styles.xml"/>)
+
+      <<~XML.chomp
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
+          #{relationship_nodes.join}
+        </Relationships>
+      XML
+    end
+
+    def styles_xml
+      <<~XML.chomp
+        <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        <styleSheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">
+          <fonts count="1">
+            <font><sz val="11"/><name val="Calibri"/></font>
+          </fonts>
+          <fills count="1">
+            <fill><patternFill patternType="none"/></fill>
+          </fills>
+          <borders count="1">
+            <border><left/><right/><top/><bottom/><diagonal/></border>
+          </borders>
+          <cellStyleXfs count="1">
+            <xf numFmtId="0" fontId="0" fillId="0" borderId="0"/>
+          </cellStyleXfs>
+          <cellXfs count="1">
+            <xf numFmtId="0" fontId="0" fillId="0" borderId="0" xfId="0"/>
+          </cellXfs>
+          <cellStyles count="1">
+            <cellStyle name="Normal" xfId="0" builtinId="0"/>
+          </cellStyles>
+        </styleSheet>
+      XML
+    end
+
+    def escape(value)
+      CGI.escapeHTML(value.to_s)
+    end
+  end
+end

data/lib/rbxl/write_only_worksheet.rb

@@ -0,0 +1,180 @@
+module Rbxl
+  class WriteOnlyWorksheet
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+      @rows = []
+      @column_name_cache = []
+    end
+
+    def <<(values)
+      append(values)
+    end
+
+    def append(values)
+      unless values.is_a?(Array) || values.is_a?(Enumerator)
+        raise TypeError, "row must be an Array or Enumerator, got #{values.class}"
+      end
+
+      @rows << Array(values)
+      self
+    end
+
+    def to_xml
+      if defined?(Rbxl::Native)
+        return Rbxl::Native.generate_sheet(@rows)
+      end
+
+      dimension_ref = @rows.empty? ? "A1" : "A1:#{column_name(max_columns)}#{@rows.length}"
+      buf = +""
+      buf << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
+      buf << "\n"
+      buf << '<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main">'
+      buf << "\n"
+      buf << '  <dimension ref="'
+      buf << dimension_ref
+      buf << '"/>'
+      buf << "\n"
+      buf << '  <sheetData>'
+
+      @rows.each_with_index do |row_values, row_index|
+        row_num_str = (row_index + 1).to_s
+        buf << '<row r="'
+        buf << row_num_str
+        buf << '">'
+        row_values.each_with_index do |value, col_index|
+          serialize_cell_to(buf, column_name(col_index + 1), row_num_str, value)
+        end
+        buf << '</row>'
+      end
+
+      buf << "</sheetData>\n</worksheet>"
+      buf
+    end
+
+    private
+
+    def serialize_cell_to(buf, col_name, row_num_str, value)
+      if value.is_a?(WriteOnlyCell)
+        serialize_write_only_cell_to(buf, col_name, row_num_str, value)
+        return
+      end
+
+      buf << '<c r="'
+      buf << col_name
+      buf << row_num_str
+      case value
+      when nil
+        buf << '"/>'
+      when true
+        buf << '" t="b"><v>1</v></c>'
+      when false
+        buf << '" t="b"><v>0</v></c>'
+      when Integer
+        buf << '"><v>'
+        buf << value.to_s
+        buf << '</v></c>'
+      when Numeric
+        buf << '"><v>'
+        buf << value.to_s
+        buf << '</v></c>'
+      when Date, DateTime, Time
+        buf << '" t="inlineStr"><is><t>'
+        escape_to(buf, value.iso8601)
+        buf << '</t></is></c>'
+      else
+        buf << '" t="inlineStr"><is><t>'
+        escape_to(buf, value.to_s)
+        buf << '</t></is></c>'
+      end
+    end
+
+    def escape_to(buf, str)
+      i = 0
+      len = str.bytesize
+      start = 0
+
+      while i < len
+        byte = str.getbyte(i)
+        case byte
+        when 38 # &
+          buf << str.byteslice(start, i - start) if i > start
+          buf << '&amp;'
+          start = i + 1
+        when 60 # <
+          buf << str.byteslice(start, i - start) if i > start
+          buf << '&lt;'
+          start = i + 1
+        when 62 # >
+          buf << str.byteslice(start, i - start) if i > start
+          buf << '&gt;'
+          start = i + 1
+        when 34 # "
+          buf << str.byteslice(start, i - start) if i > start
+          buf << '&quot;'
+          start = i + 1
+        end
+        i += 1
+      end
+
+      if start == 0
+        buf << str
+      elsif start < len
+        buf << str.byteslice(start, len - start)
+      end
+    end
+
+    def column_name(index)
+      @column_name_cache[index] ||= begin
+        name = +""
+        current = index
+        while current.positive?
+          current -= 1
+          name.prepend((65 + (current % 26)).chr)
+          current /= 26
+        end
+        name.freeze
+      end
+    end
+
+    def max_columns
+      max = 0
+      @rows.each { |r| max = r.length if r.length > max }
+      max > 0 ? max : 1
+    end
+
+    def serialize_write_only_cell_to(buf, col_name, row_num_str, cell)
+      buf << '<c r="'
+      buf << col_name
+      buf << row_num_str
+      buf << '"'
+      if cell.style_id
+        buf << ' s="'
+        buf << cell.style_id.to_s
+        buf << '"'
+      end
+
+      case cell.value
+      when nil
+        buf << '/>'
+      when true
+        buf << ' t="b"><v>1</v></c>'
+      when false
+        buf << ' t="b"><v>0</v></c>'
+      when Numeric
+        buf << '><v>'
+        buf << cell.value.to_s
+        buf << '</v></c>'
+      when Date, DateTime, Time
+        buf << ' t="inlineStr"><is><t>'
+        escape_to(buf, cell.value.iso8601)
+        buf << '</t></is></c>'
+      else
+        buf << ' t="inlineStr"><is><t>'
+        escape_to(buf, cell.value.to_s)
+        buf << '</t></is></c>'
+      end
+    end
+  end
+end

data/lib/rbxl.rb

@@ -0,0 +1,33 @@
+require "cgi"
+require "date"
+require "nokogiri"
+require "stringio"
+require "zip"
+
+require_relative "rbxl/cell"
+require_relative "rbxl/empty_cell"
+require_relative "rbxl/errors"
+require_relative "rbxl/read_only_cell"
+require_relative "rbxl/read_only_workbook"
+require_relative "rbxl/read_only_worksheet"
+require_relative "rbxl/row"
+require_relative "rbxl/version"
+require_relative "rbxl/write_only_cell"
+require_relative "rbxl/write_only_workbook"
+require_relative "rbxl/write_only_worksheet"
+
+module Rbxl
+  class << self
+    def open(path, read_only: false)
+      raise ArgumentError, "read_only: true is required for this MVP" unless read_only
+
+      ReadOnlyWorkbook.open(path)
+    end
+
+    def new(write_only: false)
+      raise ArgumentError, "write_only: true is required for this MVP" unless write_only
+
+      WriteOnlyWorkbook.new
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rbxl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Taro KOBAYASHI
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.19'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A small Ruby gem for read-only and write-only xlsx workflows.
+email:
+- taro@matzlika.co.jp
+executables: []
+extensions:
+- ext/rbxl_native/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/rbxl_native/extconf.rb
+- ext/rbxl_native/native.c
+- lib/rbxl.rb
+- lib/rbxl/cell.rb
+- lib/rbxl/empty_cell.rb
+- lib/rbxl/errors.rb
+- lib/rbxl/native.rb
+- lib/rbxl/read_only_cell.rb
+- lib/rbxl/read_only_workbook.rb
+- lib/rbxl/read_only_worksheet.rb
+- lib/rbxl/row.rb
+- lib/rbxl/version.rb
+- lib/rbxl/write_only_cell.rb
+- lib/rbxl/write_only_workbook.rb
+- lib/rbxl/write_only_worksheet.rb
+homepage: https://github.com/matzlika/rbxl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/matzlika/rbxl
+  source_code_uri: https://github.com/matzlika/rbxl
+  bug_tracker_uri: https://github.com/matzlika/rbxl/issues
+  changelog_uri: https://github.com/matzlika/rbxl/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Streaming xlsx reader/writer inspired by openpyxl
+test_files: []