bayonet 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bec54b0bad049f5802aca27083b33bc782290dc
+  data.tar.gz: 5ee3c94ac1f7ddd9b70675af7109b6952efed880
+SHA512:
+  metadata.gz: fcd56d9e58e861a38fb7976997f6487637c8f3e46a9d1c3426fd3cba5abfc8c74c284115cac3b8d5c06629fc328b7acb260749a1c31dfcdbf9e43e9c0d36ec37
+  data.tar.gz: 193a3fe91b11c9baa8adad8fd5990b548eb290002e3b72dddc30c7dfb39ec55ed788d77c918c621cd4a05f05876f4bc0bf97d1f776e51402c54ed708e83619cc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.0
+
+script: bundle exec rspec
+
+addons:
+  code_climate:
+    repo_token: bf3282e65bbe4a73a660110de614caad3f6e65449563b61666088a877d5661d5

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec', '~> 3.2.0'
+  gem 'roo', '~> 2.0'
+  gem 'byebug'
+  gem 'codeclimate-test-reporter'
+end
+
+# Specify your gem's dependencies in bayonet.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thomas Ritter
+
+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,58 @@
+# Bayonet gem
+
+[![Build Status](https://travis-ci.org/nethad/bayonet.svg?branch=master)](https://travis-ci.org/nethad/bayonet)
+[![Code Climate](https://codeclimate.com/github/nethad/bayonet/badges/gpa.svg)](https://codeclimate.com/github/nethad/bayonet)
+[![Test Coverage](https://codeclimate.com/github/nethad/bayonet/badges/coverage.svg)](https://codeclimate.com/github/nethad/bayonet/coverage)
+
+Bayonet is a Microsoft Excel write-only gem that reads and produces XLSX files.
+It's strength lies in the fact that it's able to open bigger Excel files (even with macros!) -- and write cells without touching the rest of the Excel file. I've written the gem because *roo* was unbearably slow and was using ~1GB of RAM to read a 5MB XLSX file.
+
+
+**WARNING:** Use this gem at your own risk. It's writing directly to sheet XML files and uses a few tricks that Microsoft Excel 2010 seems to be fine with, but I cannot guarantee that future (or past) versions will play along. That being said, I've used it successfully in one of my projects. If you find any bugs, let me know.
+
+### Usage example
+
+```ruby
+workbook = Bayonet::Workbook.new(a_file_path)
+
+workbook.on_sheet('The First Sheet') do |sheet|
+  sheet.set_typed_cell('A', 1, "I'm a string") # set a cell auto-typed to a string
+  sheet.set_typed_cell('B', 1, 42)             # set a cell auto-typed to a number
+  sheet.set_cell('C', 1, "Some value")         # set a cell without setting its type
+  sheet.write_string('D', 1, "Some value")     # set a cell and forcing it to be a string
+  sheet.write_number('E', 1, 23)               # set a cell and forcing it to be a number
+end
+
+workbook.write_and_close(output_file_path)
+```
+
+See the *Tips* section for more information.
+
+### When to use Bayonet?
+
+* If you want to modify an existing, possibly huge XLSX file.
+* If other gems fail at the task or are too slow.
+
+### When should I use other gems?
+
+* If you want to create an XLSX file from scratch.
+* If you plan to open legacy (binary) XLS files.
+* If your XLSX file is small and other gems are working fine.
+
+Other gems I can recommend are:
+
+* [roo](https://rubygems.org/gems/roo) (read/write, lots of features and supported formats)
+* [axlsx](https://rubygems.org/gems/axlsx) (write-only)
+* [creek](https://rubygems.org/gems/creek) (read-only, very fast)
+
+
+### Tips
+
+#### When should I use `set_typed_cell` vs. `set_cell`?
+
+Normally you should use `set_typed_cell`, which sets the cell type correctly and falls back to `string`. If you're using a prepared XLSX sheet you might not want to override the current cell type. You should use `set_cell` for those instances. If you want to force a cell type, you can use `write_string` or `write_number` instead, but this should rarely be necessary.
+
+#### Why can't I read cells?
+
+It's simply not been implemented yet. I've been writing to template files with pre-defined cells to fill, so reading cells was not necessary. It shouldn't be hard to implemented, though there might be some edge cases I haven't considered yet, that's why I left it out for now. Pull requests are welcome, otherwise I'd suggest to use other gems for that.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bayonet.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bayonet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bayonet"
+  spec.version       = Bayonet::VERSION
+  spec.authors       = ["Thomas Ritter"]
+  spec.email         = ["ritter.thomas@gmail.com"]
+
+  spec.summary       = %q{Bayonet is a Microsoft Excel write-only gem that reads and produces XLSX files.}
+  spec.description   = %q{Bayonet is a Microsoft Excel write-only gem that reads and produces XLSX files. It's strength lies in the fact that it's able to open bigger Excel files (even with macros!) -- and write cells without touching the rest of the Excel file.}
+  spec.homepage      = "https://github.com/nethad/bayonet"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubyzip", "~> 1.1"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bayonet"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bayonet.rb

@@ -0,0 +1,8 @@
+require "bayonet/cell"
+require "bayonet/node_creation"
+require "bayonet/sheet"
+require "bayonet/version"
+require "bayonet/workbook"
+
+module Bayonet
+end

data/lib/bayonet/cell.rb

@@ -0,0 +1,37 @@
+module Bayonet
+  class Cell
+
+    ROW_MATCHER    = /\A[A-Z]+\z/ # is only A-Z characters, upper case.
+
+    def initialize(row, column)
+      @row    = row
+      @column = column
+    end
+
+    def label
+      cell_label = "#{row}#{column}"
+      if valid?
+        cell_label
+      else
+        raise "Invalid cell: #{cell_label}."
+      end
+    end
+
+    def valid?
+      row_valid? && column_valid?
+    end
+
+    private
+
+    attr_reader :row, :column
+
+    def row_valid?
+      (row =~ ROW_MATCHER) != nil
+    end
+
+    def column_valid?
+      column.is_a?(Integer) && column >= 1
+    end
+
+  end
+end

data/lib/bayonet/node_creation.rb

@@ -0,0 +1,79 @@
+module Bayonet
+  class NodeCreation
+
+    attr_reader :cell_label, :sheet
+
+    def initialize(cell_label, sheet)
+      @cell_label = cell_label
+      @sheet      = sheet
+    end
+
+    def get_or_create_cell_node
+      unless has_cell_node?
+        create_nodes
+      end
+
+      cell_node
+    end
+
+    private
+
+    def xml
+      sheet.xml
+    end
+
+    def cell_node
+      @cell_node ||= xml.at_css("c[r=\"#{cell_label}\"]")
+    end
+
+    def has_cell_node?
+      !cell_node.nil?
+    end
+
+    def row_node
+      @row_node ||= xml.at_css("row[r=\"#{row_number}\"]")
+    end
+
+    def has_row_node?
+      !row_node.nil?
+    end
+
+    def row_number
+      @row_number ||= cell_label.gsub(/[^\d]/, '')
+    end
+
+    def sheet_data_node
+      @sheet_data_node ||= xml.at_css('sheetData')
+    end
+
+    def create_cell_node
+      create_node('c', row_node, cell_label)
+    end
+
+    def create_row_node
+      create_node('row', sheet_data_node, row_number)
+    end
+
+    def create_node(tag, parent_node, value)
+      Nokogiri::XML::Node.new(tag, parent_node).tap do |node|
+        node['r'] = value
+        parent_node.add_child(node)
+      end
+    end
+
+    def create_row_node_with_cell_node
+      row_node  = create_row_node
+      cell_node = create_cell_node
+      row_node.add_child(cell_node)
+    end
+
+    def create_nodes
+      if has_row_node?
+        create_cell_node
+      else
+        create_row_node_with_cell_node
+      end
+    end
+
+  end
+end

data/lib/bayonet/sheet.rb

@@ -0,0 +1,66 @@
+module Bayonet
+  class Sheet
+
+    def initialize(name, workbook)
+      @name = name
+      @workbook = workbook
+    end
+
+    def path
+      "xl/worksheets/sheet#{id}.xml"
+    end
+
+    def xml
+      @xml ||= read_and_parse_xml
+    end
+
+    def write_string(cell_row, cell_column, value)
+      set_cell(cell_row, cell_column, value.to_s, :str)
+    end
+
+    def write_number(cell_row, cell_column, value)
+      set_cell(cell_row, cell_column, value, :n)
+    end
+
+    def set_cell(cell_row, cell_column, value, type = nil)
+      cell_node = get_or_create_cell_node(Cell.new(cell_row, cell_column))
+      cell_node['t'] = type unless type.nil?
+      set_value(cell_node, value)
+    end
+
+    def set_typed_cell(cell_row, cell_column, value)
+      if (value.is_a?(Numeric))
+        write_number(cell_row, cell_column, value)
+      else
+        write_string(cell_row, cell_column, value)
+      end
+    end
+
+    private
+
+    attr_reader :name, :workbook
+
+    def id
+      @id ||= workbook.xml.at_css("sheets sheet[name=\"#{name}\"]")["r:id"][3..-1]
+    end
+
+    def read_and_parse_xml
+      entry = workbook.zip_file.find_entry(path)
+      Nokogiri::XML.parse(entry.get_input_stream)
+    end
+
+    def get_or_create_cell_node(cell)
+      Bayonet::NodeCreation.new(cell.label, self).get_or_create_cell_node
+    end
+
+    def set_value(cell_node, value)
+      if cell_node.children.nil? || cell_node.children.empty?
+        value_node = Nokogiri::XML::Node.new('v', cell_node)
+        value_node.content = value
+        cell_node.add_child value_node
+      else
+        cell_node.at_css("v").content = value
+      end
+    end
+  end
+end

data/lib/bayonet/version.rb

@@ -0,0 +1,3 @@
+module Bayonet
+  VERSION = "0.2.0"
+end

data/lib/bayonet/workbook.rb

@@ -0,0 +1,79 @@
+require 'zip'
+require 'nokogiri'
+
+module Bayonet
+  class Workbook
+
+    WORKBOOK_PATH = 'xl/workbook.xml'
+
+    def initialize(file)
+      @file = file
+    end
+
+    def zip_file
+      @zip_file ||= Zip::File.open(file)
+    end
+
+    def xml
+      @xml ||= read_and_parse_xml
+    end
+
+    def on_sheet(sheet_name, &block)
+      sheet = find_sheet_by_name_and_cache(sheet_name)
+      block.call(sheet)
+    end
+
+    def write(file)
+      Zip::File.open(file, Zip::File::CREATE) do |destination|
+        zip_file.each do |entry|
+          destination.get_output_stream(entry.name) do |file_stream|
+            write_modifications(entry, file_stream)
+          end
+        end
+      end
+    end
+
+    def close
+      zip_file.close
+    end
+
+    def write_and_close(file)
+      write(file)
+      close
+    end
+
+    private
+
+    attr_reader :file
+
+    def find_sheet_by_name_and_cache(sheet_name)
+      return modified_sheets[sheet_name] if modified_sheets.key?(sheet_name)
+
+      sheet = Bayonet::Sheet.new(sheet_name, self)
+      modified_sheets[sheet_name] = sheet
+      sheet
+    end
+
+    def find_sheet_by_path(path)
+      modified_sheets.values.detect { |sheet| sheet.path == path }
+    end
+
+    def write_modifications(entry, file_stream)
+      sheet = find_sheet_by_path(entry.name)
+      if sheet
+        file_stream.write(sheet.xml.to_s)
+      else
+        file_stream.write(zip_file.read(entry.name))
+      end
+    end
+
+    def modified_sheets
+      @modified_sheets ||= {}
+    end
+
+    def read_and_parse_xml
+      entry = zip_file.find_entry(WORKBOOK_PATH)
+      Nokogiri::XML.parse(entry.get_input_stream)
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: bayonet
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Ritter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Bayonet is a Microsoft Excel write-only gem that reads and produces XLSX
+  files. It's strength lies in the fact that it's able to open bigger Excel files
+  (even with macros!) -- and write cells without touching the rest of the Excel file.
+email:
+- ritter.thomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bayonet.gemspec
+- bin/console
+- bin/setup
+- lib/bayonet.rb
+- lib/bayonet/cell.rb
+- lib/bayonet/node_creation.rb
+- lib/bayonet/sheet.rb
+- lib/bayonet/version.rb
+- lib/bayonet/workbook.rb
+homepage: https://github.com/nethad/bayonet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Bayonet is a Microsoft Excel write-only gem that reads and produces XLSX
+  files.
+test_files: []