release: 0.2.0

README.md

@@ -1,6 +1,6 @@
 # xls
 
-Crystal bindings to libxls
+Crystal bindings to [libxls](https://github.com/libxls/libxls)
 
 ## Installation
 
@@ -10,6 +10,7 @@ Crystal bindings to libxls
    dependencies:
      xls:
        github: mdwagner/xls.cr
+       version: 0.2.0
    ```
 
 2. Run `shards install`
@@ -18,41 +19,18 @@ Crystal bindings to libxls
 
 ```crystal
 require "xls"
+
+Xls::Spreadsheet # <- library entry point
 ```
 
+Look at `examples/` folder for idea of usage.
+
 TODO: Write usage instructions here
 
 ## Development
 
 TODO: Write development instructions here
 
-## How it works
-
-```
-Xls::Spreadsheet(1) -> Xls::Workbook(1) -> Xls::Sheets(N) -> Xls::Worksheet(N)
-```
-
-### Xls::Spreadsheet
-
-- Represents the `.xls` file (pointer)
-
-### Xls::Workbook
-
-- Metadata, including accessing sheets
-
-### Xls::Sheets
-
-- Parses sheets and gives you valid worksheets
-- Gives you sheet names and count
-
-### Xls::Worksheet
-
-- Content of a worksheet (rows, cols, types, etc.)
-- Types
-  - work like JSON::Any/XML::Any/etc.
-  - Single type is a union of all possible types
-  - has different methods to assert usage: as_s/as_s?
-
 ## Contributing
 
 1. Fork it (<https://github.com/mdwagner/xls.cr/fork>)

examples/csv.cr

@@ -0,0 +1,25 @@
+require "../src/xls"
+
+# Example: convert xls into csv
+#
+# Usage: [program] <xls file path>
+Xls::Spreadsheet.open(Path.new(ARGV[0])) do |s|
+  s.worksheets.each do |ws|
+    ws.rows.each do |row|
+      row.cells.each do |cell|
+        value = cell.value
+        if str = value.as_s?
+          if str.includes?(",")
+            print "\"#{str}\""
+          else
+            print str
+          end
+        else
+          print cell.value.raw
+        end
+        print ","
+      end
+      print "\n"
+    end
+  end
+end

shard.yml

@@ -1,10 +1,10 @@
 name: xls
-version: 0.1.0
+version: 0.2.0
 
 authors:
   - Michael Wagner <mdwranger@gmail.com>
 
-crystal: '>= 1.4.1'
+crystal: ">= 1.4.1"
 
 license: MIT
 

spec/xls/spreadsheet_spec.cr

@@ -3,67 +3,5 @@ require "../spec_helper"
 Spectator.describe Xls::Spreadsheet do
   include Helpers
 
-  describe "self.xls_version" do
-    it "matches version pattern" do
-      expect(described_class.xls_version).to match(/\d\.\d\.\d/)
-    end
-  end
-
-  describe "self.open_file" do
-    it "initializes using LibXls.open_file" do
-      expect(described_class.open_file(test_fixture)).to be_a(described_class)
-    end
-  end
-
-  describe "self.new" do
-    context "with file path" do
-      it "initializes" do
-        expect(described_class.new(test_fixture)).to be_a(described_class)
-      end
-    end
-
-    context "with file content as string" do
-      it "initializes" do
-        content = File.read(test_fixture)
-        expect(described_class.new(content)).to be_a(described_class)
-      end
-    end
-
-    context "with file content as io" do
-      it "initializes" do
-        File.open(test_fixture) do |file|
-          expect(described_class.new(file)).to be_a(described_class)
-        end
-      end
-    end
-  end
-
-  describe "self.open" do
-    it "yields a Workbook" do
-      described_class.open(test_fixture) do |wb|
-        expect(wb).to be_a(Xls::Workbook)
-      end
-    end
-  end
-
-  describe "#close!" do
-    double Xls::Spreadsheet do
-      stub close! : Nil
-    end
-
-    it "closes the workbook" do
-      dbl = double(Xls::Spreadsheet)
-      allow(dbl).to receive(:close!).and_return(nil)
-      expect(dbl.close!).to be_nil
-    end
-  end
-
-  describe "#workbook!" do
-    alias XlsWorkBook = Xls::LibXls::XlsWorkBook
-
-    it "returns a raw pointer" do
-      instance = described_class.new(test_fixture)
-      expect(instance.workbook!).to be_a(Pointer(XlsWorkBook))
-    end
-  end
+  skip "no specs yet"
 end