ods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42adc8c8dec7bc687e86198883d2616891e2fe88
+  data.tar.gz: a2015c1269f31acf444ca3a4fee01850e718afeb
+SHA512:
+  metadata.gz: 441b4d3d76316a7761532d3f54524fd0236ee2524b7c5e00bb4009044a6c7b1113c3fbe33a875b3c2e674fe9d8ecb88098012e6ce46e568c507a80cc528c89ef
+  data.tar.gz: 261923e9398914e2ba64c38b4acab295a53bd63f56676a128cb24f9791e2291bbb774264d90f85cc3f8ecd095aa0c6fde518bdb868120417e19cc8d021529788

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ods.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Park
+
+MIT License
+
+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,29 @@
+# Ods
+
+Ods provides read-only access to OpenOffice.org or LibreOffice spreadsheets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ods'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ods
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/ods

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'ods'
+
+Ods::Cli.start

data/lib/ods.rb

@@ -0,0 +1,9 @@
+require "ods/version"
+require 'ods/file'
+require 'ods/sheet'
+require 'ods/row'
+require 'ods/cell'
+require 'ods/cli'
+
+module Ods
+end

data/lib/ods/cell.rb

@@ -0,0 +1,38 @@
+module Ods
+  class Cell
+    attr_reader :row, :content
+
+    def initialize(content, row)
+      @content = content
+      @row = row
+    end
+
+    def value
+      value_type = content['office:value-type']
+      #puts "value_type=#{value_type}"
+      case value_type
+        when nil, 'string'
+          text
+        when 'date'
+          Date.strptime(content['office:date-value'], "%Y-%m-%d")
+        when 'boolean'
+          content['office:boolean-value'] == 'true' ? true : false
+        when 'float'
+          str = content['office:value']
+          if str.match(/\./)
+            str.to_f
+          else
+            str.to_i
+          end
+        when 'percentage'
+          content['office:value'].to_f
+        else
+          warn "Unknown type: #{value_type} [#{text}]"
+      end
+    end
+
+    def text
+      content.text
+    end
+  end
+end

data/lib/ods/cli.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require 'csv'
+
+module Ods
+  class Cli < Thor
+    option :sheet, default: 0
+    option :file, required: true
+    option :verbose
+    desc 'csv', 'dumps --sheet x (0 by default) in csv format'
+    def csv
+      file = Ods::File.open(options[:file])
+      sheet = file.sheets[options[:sheet].to_i]
+      sheet && sheet.csv
+    end
+  end
+end

data/lib/ods/file.rb

@@ -0,0 +1,39 @@
+require 'zip/zip'
+require 'nokogiri'
+
+module Ods
+  class File
+    XPATH_SHEETS = '//office:body/office:spreadsheet/table:table'
+
+    def self.open(path)
+      ods_file = new(path)
+      if block_given?
+        yield ods_file
+      else
+        ods_file
+      end
+    end
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def sheets
+      content.root.xpath(XPATH_SHEETS).map {|sheet| Sheet.new(sheet) }
+    end
+
+    private
+
+    def content
+      @content ||= unzip_content
+    end
+
+    def unzip_content
+      Zip::ZipFile.open(path) do |zip|
+        Nokogiri::XML::Document.parse(zip.read('content.xml'))
+      end
+    end
+  end
+end

data/lib/ods/row.rb

@@ -0,0 +1,23 @@
+module Ods
+  class Row
+    attr_reader :sheet, :content
+
+    def initialize(content, sheet)
+      @content = content
+      @sheet = sheet
+    end
+
+    def cols
+      return @cols if @cols
+      @cols = []
+      content.xpath('table:table-cell').each do |node|
+        repeat = node['table:number-columns-repeated'] || 1
+        a_cell = Cell.new(node, self)
+        repeat.to_i.times do
+          @cols << a_cell
+        end
+      end
+      @cols
+    end
+  end
+end

data/lib/ods/sheet.rb

@@ -0,0 +1,44 @@
+module Ods
+  class Sheet
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    def name
+      content.attribute('name').to_s
+    end
+
+    # access by (0,0) = top left
+    def [](row_index, col_index)
+      row = rows[row_index]
+      if row.kind_of?(Array)
+        puts "bad #{row_index} #{col_index}"
+        #puts row
+      end
+      row.nil? ? nil : row.cols[col_index]
+    end
+
+    def rows
+      return @rows if @rows
+      @rows = []
+      content.xpath('descendant::table:table-row').each do |node|
+        a_row =  Row.new(node, self)
+        repeat = node['table:number-rows-repeated'] || 1
+        repeat.to_i.times do
+          @rows << a_row
+        end
+      end
+      @rows
+    end
+
+    def csv
+      CSV do |csv|
+        rows.each do |row|
+          csv << row.cols.map(&:value)
+        end
+      end
+    end
+  end
+end

data/lib/ods/version.rb

@@ -0,0 +1,3 @@
+module Ods
+  VERSION = "0.1.0"
+end

data/ods.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ods/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ods"
+  spec.version       = Ods::VERSION
+  spec.authors       = ["Mike Park"]
+  spec.email         = ["mikep@quake.net"]
+  spec.description   = %q{Provides a command line and API interface to extract data from ods spreadsheets.}
+  spec.summary       = %q{Gem to extract data from OpenOffice/LibreOffice .ods spreadsheets.}
+  spec.homepage      = "https://github.com/mike-park/ods"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6.0"
+  spec.add_dependency "rubyzip", "~> 0.9.9"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "awesome_print"
+end

data/spec/file_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Ods::File do
+  it "should have 3 sheets" do
+    ods_file = Ods::File.open(SIMPLE_ODS_FILE)
+    expect(ods_file.sheets).to have_exactly(3).items
+  end
+end

data/spec/sheet_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Ods::Sheet do
+  let(:file) { Ods::File.open(SIMPLE_ODS_FILE) }
+  let(:sheets) { file.sheets }
+
+  context "sheet 1" do
+    let(:sheet) { sheets.first }
+
+    it { sheet.name.should == 'Sheet1' }
+
+    context "sizes" do
+      it { sheet.rows.count.should > 4 }
+      it { sheet.rows[0].cols.count.should == 4 }
+    end
+
+    context "basic navigation" do
+      context "first row" do
+        it { sheet[0,0].value.should == 'A' }
+        it { sheet[0,0].value.should be_kind_of(String) }
+        it "have 4 columns" do
+          sheet.rows[0].cols.count.should == 4
+        end
+        it "contains" do
+          %w(A row of strings).each_with_index do |s, i|
+            sheet[0, i].value.should == s
+          end
+        end
+      end
+
+      context "second row" do
+        (1..4).each do |i|
+          it { sheet[1,i-1].value.should == Date.new(2011, 1, i) }
+          it { sheet[1,i-1].value.should be_kind_of(Date) }
+        end
+      end
+
+      context "third row integers" do
+        (1..4).each do |i|
+          it { sheet[2,i-1].value.should == i }
+          it { sheet[2,i-1].value.should be_kind_of(Fixnum) }
+        end
+      end
+
+      context "forth row matches third row" do
+        (1..4).each do |i|
+          it { sheet[3,i-1].value.should == i }
+          it { sheet[3,i-1].value.should be_kind_of(Fixnum) }
+        end
+      end
+
+      context "row five has mixed float&ints" do
+        it { sheet[4,0].value.should == 0 }
+        it { sheet[4,0].value.should be_kind_of(Fixnum) }
+
+        it { sheet[4,1].value.should == -1.1 }
+        it { sheet[4,1].value.should be_kind_of(Float) }
+
+        it { sheet[4,2].value.should == 2.2 }
+        it { sheet[4,2].value.should be_kind_of(Float) }
+
+        it { sheet[4,3].value.should == 3 }
+        it { sheet[4,3].value.should be_kind_of(Fixnum) }
+      end
+
+      context "row 6 has booleans" do
+        it { sheet[5,0].value.should == true }
+        it { sheet[5,0].value.should be_kind_of(TrueClass) }
+
+        it { sheet[5,1].value.should == false }
+        it { sheet[5,1].value.should be_kind_of(FalseClass) }
+      end
+
+      context "out of bounds" do
+        it { sheet[1000,100].should_not be }
+      end
+    end
+  end
+
+  context "sheet 2" do
+    let(:sheet) { sheets[1] }
+
+    it { sheet.name.should == "Sheet2" }
+
+    context "column A" do
+      (0..9).each do |row|
+        context "row #{row}" do
+          it { sheet[row, 0].value.should == "A#{row+1}" }
+        end
+      end
+
+      it { sheet[10,0].should_not be }
+    end
+
+    context "bottom right" do
+      it { sheet[9, 3].value.should == 'D10' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'ods'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+SIMPLE_ODS_FILE = Pathname.new(__FILE__).dirname + 'simple.ods'

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: ods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Park
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a command line and API interface to extract data from ods spreadsheets.
+email:
+- mikep@quake.net
+executables:
+- ods
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ods
+- lib/ods.rb
+- lib/ods/cell.rb
+- lib/ods/cli.rb
+- lib/ods/file.rb
+- lib/ods/row.rb
+- lib/ods/sheet.rb
+- lib/ods/version.rb
+- ods.gemspec
+- spec/file_spec.rb
+- spec/sheet_spec.rb
+- spec/simple.ods
+- spec/spec_helper.rb
+homepage: https://github.com/mike-park/ods
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Gem to extract data from OpenOffice/LibreOffice .ods spreadsheets.
+test_files:
+- spec/file_spec.rb
+- spec/sheet_spec.rb
+- spec/simple.ods
+- spec/spec_helper.rb