spreadsheet_exporter 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Nicholas Jakobsen
+
+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,2 @@
+= SpreadsheetExporter
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpreadsheetExporter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/spreadsheet_exporter.rb

@@ -0,0 +1,5 @@
+require 'spreadsheet_exporter/csv'
+require 'spreadsheet_exporter/xlsx'
+
+module SpreadsheetExporter
+end

data/lib/spreadsheet_exporter/csv.rb

@@ -0,0 +1,23 @@
+require 'csv'
+require_relative 'spreadsheet'
+
+module SpreadsheetExporter
+  module CSV
+    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)
+      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|
+        spreadsheet.each do |row|
+          csv << row
+        end
+      end
+
+      return BOM + output.encode!('utf-16le')
+    end
+  end
+end

data/lib/spreadsheet_exporter/spreadsheet.rb

@@ -0,0 +1,60 @@
+# TODO: Find out why we can't detect arrays properly and must resort to crappy class.name comparison
+module SpreadsheetExporter
+  module Spreadsheet
+    def self.from_objects(objects, options = {})
+      headers = []
+      rows = []
+
+      # Get all the data and accumulate headers from each row (since rows may not have all the same attributes)
+      Array(objects).each do |object|
+        data = object.respond_to?(:as_csv) ? get_values(object.as_csv(options)) : get_values(object.as_json(options))
+        headers = headers | data.keys
+        rows << data
+      end
+
+      # 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
+        rows.each do |row|
+          sorted_row = []
+          row.each do |header, value|
+            sorted_row[headers.index(header)] = value
+          end
+
+          spreadsheet << sorted_row
+        end
+      end
+    end
+
+    # Return an array of human_attribute_name's
+    # Used by the CSV Import/Export process to match CSV headers to model attribute names
+    def self.han(klass, *attributes)
+      options = attributes.extract_options!
+
+      attributes.flatten!
+      attributes.collect! {|attribute| klass.human_attribute_name(attribute) }
+      attributes.collect!(&:downcase) if options[:downcase]
+
+      return attributes.many? ? attributes : attributes.first
+    end
+
+    def self.get_values(node, current_header = nil)
+      output = {}
+      case node.class.name
+      when 'Hash'
+        node.each do |key, subnode|
+          output.merge! get_values(subnode, [current_header, key].compact.join('_'))
+        end
+      when 'Array'
+        node.each do |subnode|
+          get_values(subnode, current_header).each do |key, value|
+            output[key] = [output[key], value.to_s].compact.join(', ')
+          end
+        end
+      else
+        output[current_header] = node.to_s
+      end
+      return output
+    end
+  end
+end

data/lib/spreadsheet_exporter/version.rb

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

data/lib/spreadsheet_exporter/xlsx.rb

@@ -0,0 +1,43 @@
+require 'write_xlsx'
+require_relative 'spreadsheet'
+
+module SpreadsheetExporter
+  module XLSX
+    def self.from_objects(objects, options = {})
+      spreadsheet = Spreadsheet.from_objects(objects, options)
+      from_spreadsheet(spreadsheet)
+    end
+
+    def self.from_spreadsheet(spreadsheet, temp_file_path = 'tmp/items.xlsx')
+      # Create a new Excel workbook
+      workbook = WriteXLSX.new(temp_file_path)
+
+      # Add a worksheet
+      worksheet = workbook.add_worksheet
+
+      # Add and define a format
+      headerFormat = workbook.add_format # Add a format
+      headerFormat.set_bold
+
+      # Write header row
+      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|
+          worksheet.write(row + 1, col, value)
+        end
+      end
+
+      # Output the file contents and delete it
+      workbook.close
+      file = File.open(temp_file_path)
+      output = file.read
+      file.close
+      File.delete(temp_file_path)
+
+      return output
+    end
+  end
+end

data/lib/tasks/exporter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :spreadsheet_exporter do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: spreadsheet_exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nicholas Jakobsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Export your data as various types of spreadsheets. Supports csv and xlsx
+  output.
+email:
+- nicholas.jakobsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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: 
+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
+summary: Export your data as various types of spreadsheets
+test_files: []