spreadsheet_exporter 0.1.0 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f35de8fa1c694230a24e6bcaeaae713e3b162d9c7109f07bef0fb886cb57aac
+  data.tar.gz: b926ade21fe17468043676d0795a6fc7eecf5ad3a2d9a507c4d709c0f37b7303
+SHA512:
+  metadata.gz: 1dd829ce6816c2d40b82f3553595e3ee644b5c12eec914c6b4f44ed472dd56c4a7362d1c47e982a229daade09a02654b81abaf9f6b38c98114769435a05e0a3e
+  data.tar.gz: fde7aa07e6090e6e0fc2403da828112873a04cdcf87574dadaaf116d6596d0fec32ef6306accdabb90c06e408d3c62bbfbf8d6aefcb4cd244a27d5984152bc17

data/README.md

@@ -1,2 +1,30 @@
-= SpreadsheetExporter
+# SpreadsheetExporter
 
+```ruby
+gem 'spreadsheet_exporter'
+```
+
+
+## Usage
+
+Objects that are exported must respond to ```as_csv``` or ```as_json``` and return a hash
+representing column names and values.
+
+### CSV or XLSX
+Output can be .csv or .xlsx. Choose by using SpreadsheetExporter::CSV or SpreadsheetExporter::XLSX modules.
+Note that .csv output is actually tab delimited by default so that Excel can
+open files properly without needing to use its import function. If you need to output
+that is actually comma-delimited, pass ```:col_sep => ','``` as an option when exporting
+
+### Array of ActiveRecord Objects
+```ruby
+  SpreadsheetExporter::CSV.from_objects(array_of_objects, options)
+
+  # Humanize header names using klass.human_attribute_name
+  SpreadsheetExporter::CSV.from_objects(array_of_objects, :humanize_headers_class => User)
+```
+
+### 2D Array
+```ruby
+  SpreadsheetExporter::CSV.from_spreadsheet([["First Name", "Last Name"], ["Bob", "Hoskins"], ["Roger", "Rabbit"]])
+```

data/lib/spreadsheet_exporter/csv.rb

@@ -6,12 +6,12 @@ module SpreadsheetExporter
     BOM = "\377\376".force_encoding("utf-16le") # Byte Order Mark so Excel displays characters correctly
 
     def self.from_objects(objects, options = {})
-      spreadsheet = Spreadsheet.from_objects(objects, options)
+      spreadsheet = Spreadsheet.from_objects(objects, options).compact
       from_spreadsheet(spreadsheet)
     end
 
-    def self.from_spreadsheet(spreadsheet, temp_file_path = 'tmp/items.xlsx')
-      output = ::CSV.generate(:encoding => 'UTF-8', :col_sep => "\t") do |csv|
+    def self.from_spreadsheet(spreadsheet, options = {})
+      output = ::CSV.generate(**options.reverse_merge(:encoding => 'UTF-8', :col_sep => "\t")) do |csv|
         spreadsheet.each do |row|
           csv << row
         end

data/lib/spreadsheet_exporter/spreadsheet.rb

@@ -14,7 +14,7 @@ module SpreadsheetExporter
 
       # Create the csv, ensuring to place each row's attributes under the appropriate header (since rows may not have all the same attributes)
       [].tap do |spreadsheet|
-        spreadsheet << headers
+        spreadsheet << (options[:humanize_headers_class] ? han(options[:humanize_headers_class], headers) : headers)
         rows.each do |row|
           sorted_row = []
           row.each do |header, value|

data/lib/spreadsheet_exporter/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetExporter
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/lib/spreadsheet_exporter/xlsx.rb

@@ -4,7 +4,7 @@ require_relative 'spreadsheet'
 module SpreadsheetExporter
   module XLSX
     def self.from_objects(objects, options = {})
-      spreadsheet = Spreadsheet.from_objects(objects, options)
+      spreadsheet = Spreadsheet.from_objects(objects, options).compact
       from_spreadsheet(spreadsheet)
     end
 
@@ -20,12 +20,12 @@ module SpreadsheetExporter
       headerFormat.set_bold
 
       # Write header row
-      spreadsheet.first.each_with_index do |column_name, col|
+      Array(spreadsheet.first).each_with_index do |column_name, col|
         worksheet.write(0, col, column_name, headerFormat)
       end
 
-      spreadsheet[1..-1].each_with_index do |values, row|
-        values.each_with_index do |value, col|
+      Array(spreadsheet[1..-1]).each_with_index do |values, row|
+        Array(values).each_with_index do |value, col|
           worksheet.write(row + 1, col, value)
         end
       end

data/lib/spreadsheet_exporter.rb

@@ -1,5 +1,9 @@
 require 'spreadsheet_exporter/csv'
 require 'spreadsheet_exporter/xlsx'
-
 module SpreadsheetExporter
+  begin
+    Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
+  rescue NameError
+    # No Mime::Type
+  end
 end

metadata

@@ -1,32 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_exporter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicholas Jakobsen
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: write_xlsx
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.1
 description: Export your data as various types of spreadsheets. Supports csv and xlsx
   output.
 email:
@@ -35,38 +45,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/spreadsheet_exporter.rb
 - lib/spreadsheet_exporter/csv.rb
 - lib/spreadsheet_exporter/spreadsheet.rb
 - lib/spreadsheet_exporter/version.rb
 - lib/spreadsheet_exporter/xlsx.rb
-- lib/spreadsheet_exporter.rb
 - lib/tasks/exporter_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.md
 homepage: https://github.com/culturecode/spreadsheet_exporter
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
-signing_key: 
-specification_version: 3
+rubygems_version: 3.6.9
+specification_version: 4
 summary: Export your data as various types of spreadsheets
 test_files: []