simple_spreadsheets 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzRlYzFkMzk2MjA4MDVlYjJiZmZlN2RkMDc5YTU3YTgzZTRkNTNkNQ==
+  data.tar.gz: !binary |-
+    Nzg3Mzk5YTkzNWY1ZGEzMThkY2I4ZmNmNTQxZTFmOGQ1ZGY4M2FjNw==
+SHA512:
+  metadata.gz: !binary |-
+    N2U1YjVmNTcxOTIwNDg4ZTdlY2Y0NGYxZTlkMmE0YmI3ZWYxMjc4MzBmZWQ2
+    MTI4YTFmOWI4ZGRiYjBhMGIwMzJkMDdlMjAzY2M5ZTE1NWE1YjM1NzdiMjI5
+    NGIwZDc4N2MzZDg4NTgwNDU2MjdmYjhkMjFlMThiMDAyMjM3Y2E=
+  data.tar.gz: !binary |-
+    MjI1NjMzMWU4MGE5NWVjMTUyYjY3NWVmYjY4YjlmY2IxOGNlYmE2NzFiZDcx
+    MWRmNDAwNzZlZjU2YTY1YjExY2RjM2JiNWYzZTFhYTJhMTE2MmY5NDlmMmRk
+    ZTI4YWY4OTkxODQ2NDI1NzkyYWFiM2Y0NmY0YWNjZWJlOGE4Yjk=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jon Evans
+
+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,108 @@
+# SimpleSpreadsheets
+
+Write Excel-friendly spreadsheets with ease!
+
+## Usage
+
+First, add a helper that allows using `SimpleSpreadsheets` easily. Note that
+this is not included by default so that you can easily customize the
+interface, filename, etc. Here's an example:
+
+```ruby
+def xls(title, &block)
+  filename = [title, file_timestamp].join("_")
+  response.headers['Content-Disposition'] = "attachment; filename=\"#{filename}.xls\""
+  SimpleSpreadsheets.render(title, &block).html_safe
+end
+```
+
+In your controller, specify that you respond to `xls`. Here's an example where
+people can view a list of boats in their browser, or export the same list:
+
+```ruby
+class BoatsController < ApplicationController
+  respond_to :html, :xls
+
+  def index
+    @search = search
+
+    respond_to do |format|
+      format.html { @boats = Boat.paginate(page: params[:page]) }
+      format.xls  { @boats = Boat.all }
+    end
+  end
+end
+```
+
+Now, in `boats/index.xls.erb`, you can use `SimpleSpreadsheets` to render a
+spreadsheet for all the boats:
+
+```erb
+<%= xls("Boats") do |xls| %>
+  <% xls.row do |row| %>
+    <% row.string "Manufacturer" %>
+    <% row.string "Model" %>
+    <% row.string "Color" %>
+    <% row.string "Count" %>
+  <% end %>
+
+  <% @boats.each do |boat| %>
+    <% xls.row do |row| %>
+      <% row.string boat.manufacturer %>
+      <% row.string boat.model %>
+      <% row.string boat.color %>
+      <% row.number boat.count %>
+    <% end %>
+  <% end %>
+<% end %>
+```
+
+## Testing
+
+`simple_spreadsheets` comes bundled with a custom RSpec matcher that you can use
+from your feature specs to ensure the response is valid xls. In your spec,
+
+```ruby
+require 'simple_spreadsheets/rspec/matcher'
+```
+
+Example usage:
+
+```ruby
+scenario 'exporting to XLS' do
+  click_link('Download XLS')
+  expect(page).to be_valid_xls
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_spreadsheets'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_spreadsheets
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/simple_spreadsheets/fork )
+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 a new Pull Request
+
+## About Foraker Labs
+
+<img src="http://assets.foraker.com/foraker_logo.png" width="400" height="62">
+
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.
+
+Foraker Labs is a Boulder-based Ruby on Rails and iOS development shop. Please reach out if we can [help build your product](http://www.foraker.com).

data/Rakefile

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

data/lib/simple_spreadsheets.rb

@@ -0,0 +1,12 @@
+require "simple_spreadsheets/version"
+require "simple_spreadsheets/rendering"
+require "simple_spreadsheets/document"
+require "active_support/core_ext"
+
+module SimpleSpreadsheets
+  def self.render(name)
+    document = Document.new(name)
+    yield(document)
+    document.render
+  end
+end

data/lib/simple_spreadsheets/document.rb

@@ -0,0 +1,70 @@
+module SimpleSpreadsheets
+  class Document
+    include Rendering
+
+    def self.render(title)
+      instance = new(title)
+      yield instance
+      instance.render
+    end
+
+    def initialize(title)
+      @title = title
+      @rows = []
+    end
+
+    def row
+      row = Row.new
+      yield(row)
+      rows << row
+    end
+
+    private
+
+    attr_accessor :rows
+
+    def render_rows
+      rows.map(&:render).join("\n")
+    end
+
+    class Row
+      include Rendering
+
+      def initialize
+        @cells = []
+      end
+
+      def string(value)
+        append_cell("String", value)
+      end
+
+      def number(value)
+        append_cell("Number", value)
+      end
+
+      private
+
+      def append_cell(type, value)
+        cells << Cell.new(type, value)
+      end
+
+      attr_accessor :cells
+
+      def render_cells
+        cells.map(&:render).join("\n")
+      end
+
+      class Cell
+        include Rendering
+
+        def initialize(type, value)
+          @type, @value = type, value
+        end
+
+        private
+
+        attr_reader :type, :value
+      end
+    end
+  end
+end

data/lib/simple_spreadsheets/rendering.rb

@@ -0,0 +1,15 @@
+module SimpleSpreadsheets
+  module Rendering
+    def render
+      ERB.new(template).result(binding)
+    end
+
+    def template
+      File.read(File.expand_path("../templates/#{template_file}.xml.erb", __FILE__))
+    end
+
+    def template_file
+      self.class.name.demodulize.downcase
+    end
+  end
+end

data/lib/simple_spreadsheets/rspec/matcher.rb

@@ -0,0 +1,16 @@
+module SimpleSpreadsheets
+  module Rspec
+    module Matcher
+      RSpec::Matchers.define :be_valid_xls do |expected|
+        match do |page|
+          parsed = Nokogiri::XML(page.body.sub("<?xml version=\"1.0\"?>", ""))
+          root   = parsed.xpath('/*').first
+
+          parsed.errors.none? &&
+          root.name == "Workbook" &&
+          root.namespace.href == "urn:schemas-microsoft-com:office:spreadsheet"
+        end
+      end
+    end
+  end
+end

data/lib/simple_spreadsheets/templates/cell.xml.erb

@@ -0,0 +1 @@
+<ss:Cell><ss:Data ss:Type="<%= type %>"><%= value %></ss:Data></ss:Cell>

data/lib/simple_spreadsheets/templates/document.xml.erb

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<ss:Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
+  xmlns:o="urn:schemas-microsoft-com:office:office"
+  xmlns:x="urn:schemas-microsoft-com:office:excel"
+  xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet"
+  xmlns:html="http://www.w3.org/TR/REC-html40">
+  <ss:Worksheet ss:Name="Acceptances">
+    <ss:Table>
+      <%= render_rows %>
+    </ss:Table>
+  </ss:Worksheet>
+</ss:Workbook>

data/lib/simple_spreadsheets/templates/row.xml.erb

@@ -0,0 +1 @@
+<ss:Row><%= render_cells %></ss:Row>

data/lib/simple_spreadsheets/version.rb

@@ -0,0 +1,3 @@
+module SimpleSpreadsheets
+  VERSION = "0.0.1"
+end

data/simple_spreadsheets.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_spreadsheets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_spreadsheets"
+  spec.version       = SimpleSpreadsheets::VERSION
+  spec.authors       = ["Foraker Labs"]
+  spec.email         = ["llc@foraker.com"]
+  spec.summary       = %q{Easily render Excel-friendly spreadsheets.}
+  spec.description   = %q{A gem for simply rendering xls.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: simple_spreadsheets
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Foraker Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: A gem for simply rendering xls.
+email:
+- llc@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_spreadsheets.rb
+- lib/simple_spreadsheets/document.rb
+- lib/simple_spreadsheets/rendering.rb
+- lib/simple_spreadsheets/rspec/matcher.rb
+- lib/simple_spreadsheets/templates/cell.xml.erb
+- lib/simple_spreadsheets/templates/document.xml.erb
+- lib/simple_spreadsheets/templates/row.xml.erb
+- lib/simple_spreadsheets/version.rb
+- simple_spreadsheets.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easily render Excel-friendly spreadsheets.
+test_files: []