xmlss 1.0.0.rc.4 → 1.0.0

data/.gitignore

@@ -1,5 +1,21 @@
-pkg/*
-.bundle
 *.gem
 *.log
+*.rbc
+.rbx/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
 bench/*.xml

data/Gemfile

@@ -1,9 +1,8 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in xmlss.gemspec
 gemspec
 
-gem 'bundler', '~>1.1'
-gem 'rake', '~>0.9.2'
-gem "whysoslow", "~> 0.0"
+gem 'rake'
+gem 'pry'
+gem "whysoslow"
 gem 'ruby-prof'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2011-Present Kelly Redding
+
+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.rdoc → README.md}

@@ -1,37 +1,35 @@
-= Xmlss
+# Xmlss
 A ruby DSL for generating spreadsheets in the XML Spreadsheet format.  It provides an api for constructing spreadsheet data and then uses that data to generate xml that can be interpreted by MS Excel.
 
 ** Note: this gem only generates XML according to a subset of the August 2001 XML Spreadsheet spec (http://msdn.microsoft.com/en-us/library/aa140066(office.10).aspx).  It does not generate the more modern open office spreadsheet spec (xlsx) and may have limited support in modern spreadsheet applications.
 
-== Installation
+## Simple Usage Example
 
-    gem install xmlss
+```ruby
+require 'xmlss'
 
-== Simple Example
+workbook = Xmlss::Workbook.new(Xmlss::Writer.new) do
 
-    require 'xmlss'
-
-    workbook = Xmlss::Workbook.new(Xmlss::Writer.new) do
-
-      worksheet("5 columns, 1 row") {
-        5.times do
-          column
-        end
+  worksheet("5 columns, 1 row") {
+    5.times do
+      column
+    end
 
-          row {
-            # put data into the row (infer type)
-            [1, "text", 123.45, "0001267", "$45.23"].each do |data_value|
-              cell { data data_value }
-            end
-          }
+      row {
+        # put data into the row (infer type)
+        [1, "text", 123.45, "0001267", "$45.23"].each do |data_value|
+          cell { data data_value }
         end
       }
-
     end
+  }
 
-    workbook.to_s    # => "..." (XML Spreadsheet xml string)
+end
 
-== DSL / API
+workbook.to_s    # => "..." (XML Spreadsheet xml string)
+```
+
+## DSL / API
 
 Use these directives to create workbook markup elements.
 
@@ -104,57 +102,65 @@ number_format(value):
 protection(value):
 * value: bool, default: false
 
-== Usage
+## Usage
 
 To generate a spreadsheet, create an Xmlss::Workbook instance and build the workbook using the above DSL.  Workbook takes three parameters:
 * Xmlss::Writer instance
 * data hash: (optional) key value data to bind to the workbook scope
 * build block: (optional) block containing DSL directives
 
-=== Writer (Undies)
+### Writer (Undies)
 
 The Xmlss::Writer uses Undies (https://github.com/kellyredding/undies) to write the XML output.  The writer takes Undies::IO options.  See the Undies README for usage details.
 
-    Xmlss::Workbook.new(Xmlss::Writer.new(:pp => 2)) do
-      worksheet('A cool sheet') {
-        ...
-      }
-    end
+```ruby
+Xmlss::Workbook.new(Xmlss::Writer.new(:pp => 2)) do
+  worksheet('A cool sheet') {
+    ...
+  }
+end
+```
 
-=== Data hash
+### Data hash
 
 Xmlss evals the build proc in the scope of the workbook instance.  This means that the build has access to only the data it is given or the DSL itself.  Data is given in the form of a Hash.  The string form of the hash keys are exposed as local workbook methods that return their corresponding values.
 
-    Xmlss::Workbook.new(Xmlss::Writer.new, :sheet_name => 'A cool sheet') do
-      worksheet(sheet_name) {
-        ...
-      }
-    end
+```ruby
+Xmlss::Workbook.new(Xmlss::Writer.new, :sheet_name => 'A cool sheet') do
+  worksheet(sheet_name) {
+    ...
+  }
+end
+```
 
-=== Builder approach
+### Builder approach
 
 The above examples all pass in a build proc that is eval'd in the scope of the workbook instance.  This works great when you know your build at the same time you create your Workbook object.  However, in some cases, the build may not be known upfront or you may want to use a more declarative style to specify your spreadsheet content.  Workbook builds can be specified programmatically using the "builder" approach.
 
 To render using this approach, create a Workbook instance passing it data and output info as above.  However, don't pass any build proc and save off the created workbook:
 
-    # choosing not to use any local data or output options
-    workbook = Xmlss::Workbook.new(Xmlss::Writer.new)
+```ruby
+# choosing not to use any local data or output options
+workbook = Xmlss::Workbook.new(Xmlss::Writer.new)
+```
 
 Now just interact with the Workbook API directly.
 
-    # notice that it becomes less important to bind any local data to the Workbook using this approach
-    something = "Some Thing!"
-    workbook.worksheet(something) {
-      workbook.column
+```ruby
+# notice that it becomes less important to bind any local data to the Workbook using this approach
+something = "Some Thing!"
+workbook.worksheet(something) {
+  workbook.column
 
-      workbook.row {
-        workbook.cell {
-          workbook.data "hi hi something hi"
-        }
-      }
+  workbook.row {
+    workbook.cell {
+      workbook.data "hi hi something hi"
     }
+  }
+}
+```
 
-== Disclaimer
+# Disclaimer
 
 Be aware this library only provides the basic, raw API for constructing spreadsheets using this spec and utilities to convert those objects to string xml data representing them.  It does not provide any macro logic to aid in constructing the sheets.  If you want a more convenient API for your use case, I suggest extending the objects and tailoring them to your needs.
 
@@ -164,27 +170,24 @@ The XML Spreadsheet spec and format are legacy and may have limited support depe
 
 * Full XML Spreadsheet spec: http://msdn.microsoft.com/en-us/library/aa140066(office.10).aspx
 
-== License
-
-Copyright (c) 2011-Present, Kelly D. Redding
-
-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.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'whysoslow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install whysoslow
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1,10 +1,4 @@
-require 'assert/rake_tasks'
-include Assert::RakeTasks
-
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-task :default => :build
+require "bundler/gem_tasks"
 
 namespace :bench do
 

data/lib/xmlss/element/cell.rb

@@ -1,4 +1,5 @@
 require 'enumeration'
+require 'date'
 
 module Xmlss; end
 module Xmlss::Element
@@ -38,6 +39,10 @@ module Xmlss::Element
       case self.data
       when ::Date, ::Time, ::DateTime
         self.data.strftime("%Y-%m-%dT%H:%M:%S")
+      when ::TrueClass
+        1
+      when ::FalseClass
+        0
       else
         self.data.to_s
       end

data/lib/xmlss/element/worksheet.rb

@@ -34,5 +34,6 @@ module Xmlss::Element
       # worksheet name cannot contain: /, \, :, ;, * or start with '['
       name.to_s.gsub(/[\/|\\|:|;|\*]/, '').gsub(/^\[/, '')
     end
+
   end
 end

data/lib/xmlss/version.rb

@@ -1,3 +1,3 @@
 module Xmlss
-  VERSION = "1.0.0.rc.4"
+  VERSION = "1.0.0"
 end

data/lib/xmlss/writer.rb

@@ -4,9 +4,6 @@ require 'stringio'
 module Xmlss
   class Writer
 
-    class Markup; end
-    class AttrsHash; end
-
     # Xmlss uses Undies to stream its xml markup
     # The Undies writer is responsible for driving the Undies API to generate
     # the xmlss xml markup for the workbook.
@@ -192,79 +189,75 @@ module Xmlss
       worksheets_markup.element("Table", nil, {})
     end
 
-  end
-
-
+    # utility classes
 
-  class Writer::AttrsHash
+    class AttrsHash
+      attr_reader :raw
 
-    attr_reader :raw
-
-    def initialize
-      @raw = Hash.new
-    end
+      def initialize
+        @raw = Hash.new
+      end
 
-    def value(k, v)
-      # ignore any nil-value or empty string attrs
-      @raw["#{Xmlss::Writer::SHEET_NS}:#{k}"] = v if v && v != ''
-      self
-    end
+      def value(k, v)
+        # ignore any nil-value or empty string attrs
+        @raw["#{Xmlss::Writer::SHEET_NS}:#{k}"] = v if v && v != ''
+        self
+      end
 
-    def bool(k, v)
-      # write truthy values as '1', otherwise ignore
-      @raw["#{Xmlss::Writer::SHEET_NS}:#{k}"] = 1 if v
-      self
+      def bool(k, v)
+        # write truthy values as '1', otherwise ignore
+        @raw["#{Xmlss::Writer::SHEET_NS}:#{k}"] = 1 if v
+        self
+      end
     end
 
-  end
-
-  class Writer::Markup
+    class Markup
+      attr_reader :template, :push_count, :pop_count
 
-    attr_reader :template, :push_count, :pop_count
-
-    def initialize(opts={})
-      @markup = ""
-      @template = Undies::Template.new(Undies::IO.new(@markup, opts))
-      @push_count = 0
-      @pop_count  = 0
-    end
+      def initialize(opts={})
+        @markup = ""
+        @template = Undies::Template.new(Undies::IO.new(@markup, opts))
+        @push_count = 0
+        @pop_count  = 0
+      end
 
-    def raw(markup)
-      @template.raw(
-        Undies::Template.escape_html(markup).gsub(/(\r|\n)+/, Xmlss::Writer::LB)
-      )
-    end
+      def raw(markup)
+        @template.raw(
+          Undies::Template.escape_html(markup).gsub(/(\r|\n)+/, Xmlss::Writer::LB)
+        )
+      end
 
-    def element(name, data, attrs)
-      @template.__open_element(name, data, attrs)
-    end
+      def element(name, data, attrs)
+        @template.__open_element(name, data, attrs)
+      end
 
-    def inline_element(name, attrs)
-      @template.__closed_element(name, attrs)
-    end
+      def inline_element(name, attrs)
+        @template.__closed_element(name, attrs)
+      end
 
-    def push
-      @push_count += 1
-      @template.__push
-    end
+      def push
+        @push_count += 1
+        @template.__push
+      end
 
-    def pop
-      @pop_count += 1
-      @template.__pop
-    end
+      def pop
+        @pop_count += 1
+        @template.__pop
+      end
 
-    def flush
-      while @push_count > @pop_count
-        pop
+      def flush
+        while @push_count > @pop_count
+          pop
+        end
+        @template.__flush
+        self
       end
-      @template.__flush
-      self
-    end
 
-    def empty?; @markup.empty?; end
+      def empty?; @markup.empty?; end
 
-    def to_s
-      @markup.to_s
+      def to_s
+        @markup.to_s
+      end
     end
 
   end

data/test/helper.rb

@@ -1,9 +1,12 @@
-# this file is automatically required in when you require 'assert' in your tests
-# put test helpers here
+# this file is automatically required when you run `assert`
+# put any test helpers here
 
-# add root dir to the load path
+# add the root dir to the load path
 $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 
+# require pry for debugging (`binding.pry`)
+require 'pry'
+
 class Assert::Context
 
   def self.be_styled