active_record_to_xls 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c52c2f9748f585a25ce7925fe0ae4f138c4ce1c672e508da8a9325d503ce8a1f
+  data.tar.gz: 8e95741bd3ad84276ce8583a1f7801c0003a2504db9511fa70f499ce9048dd2e
+SHA512:
+  metadata.gz: 7c2be1c0e1487891b38220e98b953c7178219bdfdbb27c4c4ca1b98ca79cc1686bbf28ff695a8b3c0d1e17be7a9064fb24e9763babda62af7cb4af65c175f33f
+  data.tar.gz: 574e48a1a514b27a5984bc6339df7786ae26ff096329cbcc9e8a896bb96e9b46c32645b890d62dfbd8b4b73abcbf8c035210a658b909d40ff720916c45bbb7a4

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org/"
+
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Liang
+
+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,116 @@
+# ActiveRecordToXls
+
+This gem will generate XLS data for a collection of ActiveRecord models.
+
+It was forked from the [to_xls-rails gem](https://github.com/liangwenke/to_xls-rails).
+
+## Installation
+
+**Gemfile**:
+
+```ruby
+gem 'active_record_to_xls'
+```
+
+**config/initializers/mime_types.rb**:
+
+```ruby
+Mime::Type.register_alias "text/excel", :xls
+```
+
+## Usage
+
+**controller**: 
+
+```ruby
+format.xls {
+  filename = “my_export.xls”
+  send_data ActiveRecordToXls.call(Widget.all)
+}
+```
+
+**view:**  
+
+```ruby  
+link_to 'Export Excel', my_action_path(format: :xls)
+```
+
+### Options  
+
+#### client_encoding
+
+- **Type:** String  
+- **Default**: UTF-8
+
+#### only 
+
+- **Type:** Array
+
+Will only include the columns specified in this array:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, only: [:title, :body] )
+```
+
+#### except 
+
+- **Type:** Array
+
+Will omit the columns specified in this array, eg:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, omit: [:id] )
+```
+
+#### prepend
+  
+- **Type:** Array of row arrays
+
+Will prepend above header:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, prepend: [["Col 0, Row 0", "Col 1, Row 0"], ["Col 0, Row 1"]] )
+```
+
+#### header
+
+- **Type:** true or false
+- **Default:** false
+
+Will omit the header row:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, header: false )
+```
+
+#### header_columns
+
+- **Type**: Array
+
+Specify header column names:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, header: false , header_columns: ['Title', 'Description])
+```
+
+#### column_width
+
+- **Type:** Array of integers
+
+Set column widths:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, column_width: [17,15,15,40,25,37] )
+```
+
+#### append
+
+- **Type:** Array of row arrays
+
+Will append this row at end, eg:
+
+```ruby
+send_data ActiveRecordToXls.call( Widget.all, append: [["Col 0, Row 0", "Col 1, Row 0"], ["Col 0, Row 1"]] )
+```
+
+  

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/active_record_to_xls.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name                      = 'active_record_to_xls'
+  spec.version                   = version
+  spec.author                    = "Gordon B. Isnor"
+  spec.email                     = "info@isnorcreative.com"
+  spec.homepage                  = "http://github.com/gordonbisnor/active_record_to_xls"
+  spec.summary                   = "Export Rails ActiveRecord data to Excel XLS data"
+  spec.description               = "This simple plugin gives you the ability to get XLS for a collection of ActiveRecord models."
+  spec.files                     = Dir["{lib,test}/**/*", "[a-zA-Z]*", "init.rb"] - ["Gemfile.lock"]
+  spec.require_path              = "lib"
+  spec.license                   = 'MIT'
+  spec.add_runtime_dependency 'spreadsheet', '~> 0.8.5'
+  spec.add_development_dependency 'rspec', '~> 3.7', '>= 3.7.0'
+  spec.platform                  = Gem::Platform::RUBY
+  spec.required_rubygems_version = ">= 1.3.4"
+end

data/init.rb

@@ -0,0 +1 @@
+require 'active_record_to_xls'

data/lib/active_record_to_xls.rb

@@ -0,0 +1,59 @@
+require 'spreadsheet'
+
+class ActiveRecordToXls
+
+  def self.call(target, options = {}, &block)
+
+    return '' if target.nil? && options[:prepend].nil?
+
+    columns = []
+    
+    show_header = options[:header] == true
+
+    xls_report = StringIO.new
+
+    Spreadsheet.client_encoding = options[:client_encoding] || "UTF-8"
+
+    book = Spreadsheet::Workbook.new
+    sheet = book.create_worksheet
+
+    columns = if options[:only]
+      Array(options[:only]).map(&:to_sym)
+    elsif !target.nil?
+      if target.first.is_a? Hash
+        target.first.keys.map(&:to_sym) - Array(options[:except]).map(&:to_sym)
+      else
+        target.first.attributes.keys.map(&:to_sym) - Array(options[:except]).map(&:to_sym)
+      end
+    end
+
+    return '' if columns.empty? && options[:prepend].nil?
+
+    sheet_index = 0
+
+    options[:prepend].map { |arr| sheet.row(sheet_index).concat(arr); sheet_index += 1 } unless options[:prepend].nil?
+
+    if show_header
+      sheet.row(sheet_index).concat(options[:header_columns].nil? ? columns.map(&:to_s).map(&:humanize) : options[:header_columns])
+      sheet_index += 1
+    end
+    
+    options[:column_width].each_index { |index| sheet.column(index).width = options[:column_width][index] } if options[:column_width]
+
+    target.each_with_index do |obj, i|
+      if block
+        sheet.row(sheet_index).replace(columns.map { |col| block.call(col, obj.is_a?(Hash) ? obj[col] : obj.send(col), i) } )
+      else
+        sheet.row(sheet_index).replace(columns.map { |col| obj.is_a?(Hash) ? obj[col] : obj.send(col) } )
+      end
+      sheet_index += 1
+    end
+    
+    options[:append].map { |arr| sheet.row(sheet_index).concat(arr); sheet_index += 1 } unless options[:append].nil?
+
+    book.write(xls_report)
+
+    xls_report.string
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: active_record_to_xls
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gordon B. Isnor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+description: This simple plugin gives you the ability to get XLS for a collection
+  of ActiveRecord models.
+email: info@isnorcreative.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- active_record_to_xls.gemspec
+- init.rb
+- lib/active_record_to_xls.rb
+homepage: http://github.com/gordonbisnor/active_record_to_xls
+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: 1.3.4
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Export Rails ActiveRecord data to Excel XLS data
+test_files: []