xls_reporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74b6a4b5417f9fb10df890a37dc87c19f31bce8a
+  data.tar.gz: ef56353dc21c4da727ab68d76239475c384cfd26
+SHA512:
+  metadata.gz: 1dd4beaf15c64d7929df6ecc59e3a903c49be42f0b6b76f62362903decd3dbeff9a9de14273a82312de0265d21ea5f1d60d20cade619704c52de68616bb9f79b
+  data.tar.gz: f1520bd2777aead6d6d835589ed13938d2b552a5690667512adff7fcb44fa70bdb82bceb6dea99ab09f2769c450719cc3c2e8e44e81547f7d79b90b6fc4d25e8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 fcano
+
+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,74 @@
+# XlsReporter
+
+XlsReporter lets you to export a collection of data to an Excel file, in a **Ruby** or **Ruby on Rails** project. Only need to specify the way to show data in the report.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xls_reporter'
+```
+And then execute:
+```sh
+$ bundle install
+```
+Or install it yourself as:
+```sh
+$ gem install xls_reporter
+```
+
+## Usage
+To export data:
+```ruby
+# create instance of reporter class
+table_reporter = XlsReporter::DataExport.new
+
+# generate report file
+table_reporter.generate_excel(collection, header_params, body_params,
+                          filename, filepath, batch_iteration, retry_methods)
+```
+with the follow parameters:
+- *collection*: set of iterable data (`ActiveRecord::Relation`, `Array` of objects, etc.).
+- *header_params*: `Array` of hashes, indicate the title of each column:
+```ruby
+  header_params = [
+                {:index => 0, :title => "SKU"},
+                {:index => 1, :title => "Event"},
+                {:index => 2, :title => I18n.t(model.attribute)},
+        ]
+```
+- *body_params*: `Array` of hashes, indicate the methods (and their params) to apply in each element of collection to show in report:
+```ruby
+  body_params = [
+             # one method
+             {:index => 0, :object_methods => :get_sku },
+             # one method with one param
+             {:index => 1, :object_methods => {:get_event => Time.now } },
+             # method chaining with params
+             {:index => 2, :object_methods => [ 
+                  # one method with multiple params
+                  {:method_name=>:values_by_ids, :params_values => [1,2,4]}, 
+                  # one method
+                  :get_color , 
+                  #one method with one param
+                  {:method_name =>:set_size, :params_values => "large"}
+                ] 
+             },
+          ]
+```
+- *filename*: `String` with the name of the exported file (ie: *report.xlsx*).
+- *filepath*: `String` with the path for save the report file.
+- *batch_iteration*: this `boolean` option permit iterate data in [batches](http://api.rubyonrails.org/classes/ActiveRecord/Batches.html#method-i-find_each) if you use `ActiveRecord`. Default is **true**.
+- *retry_methods*:  this `boolean` option is used to manage exceptions when calling methods in data elements, and retry them. Default is **true**.
+
+## TO DO
+  Write tests and validate code. 
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/xls_reporter/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

data/Rakefile

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

data/lib/xls_reporter.rb

@@ -0,0 +1,115 @@
+require "xls_reporter/version"
+
+module XlsReporter
+  class DataExport
+      require 'write_xlsx'
+
+      NUMBER_OF_RETRIES = 5
+
+      # generate_excel: Main method to generate file
+      # ----------------------------------------------------------------------------
+      # Valid header_params format:
+      #    header_params = [
+      #       {:index => 0, :title => I18n.t(model.attributes)},
+      #       {:index => 1, :title => "Event"},
+      #       {:index => 2, :title => "SKU"},
+      #    ]
+      # ----------------------------------------------------------------------------
+      # Valid body_params format:
+      #    body_params = [
+      #       {:index => 0, :object_methods => [ {:method_name=>:values_by_ids, :params_values => [1,2,4]}, :get_color , {:method_name =>:set_size, :params_values => "large"}] },
+      #       {:index => 1, :object_methods => {:get_event => Time.now } },
+      #       {:index => 2, :object_methods => :get_sku },
+      #    ]
+      def generate_excel collection, header_params, body_params, filename="report_#{Time.now.strftime("%Y%m%d%H%M")}.xlsx", filepath = default_path, batch_iteration = true, retry_methods = true
+
+         fullpath= File.join(filepath, filename)
+         puts "#{Time.now} Generating #{fullpath}"
+
+         workbook = WriteXLSX.new(fullpath)
+         worksheet = workbook.add_worksheet
+         row = 0
+
+         # Set Headers
+         if header_params
+            header_params.each do |param|
+               worksheet.write(row, param[:index], param[:title])
+            end
+            row = row + 1
+         end
+
+         # Use batch iteration if ActiveRecord is defined and param is set
+         iterate_method = defined?(ActiveRecord) && collection.is_a?(ActiveRecord::Relation)  && batch_iteration ? "find_each" : "each"
+
+         if body_params
+            collection.send(iterate_method) do |object|
+               body_params.each do |param|
+
+                  # Get object column value depending of datatype of args
+                  object_value = if param[:object_methods].is_a? Array #Multiple methods
+                     #Chaining methods across the array
+                     param[:object_methods].reduce(object) do |method_params, chained_value|
+                        call_method chained_value, method_params, retry_methods ? 0 : -1
+                     end
+                  else
+                    call_method object, param[:object_methods], retry_methods ? 0 : -1
+                  end
+
+                  worksheet.write(row, param[:index], object_value)
+               end
+
+               row = row + 1
+            end
+         end
+
+         workbook.close
+         puts "#{Time.now} Exporting to #{fullpath} done!"
+
+       end
+
+
+      private
+
+      # Call methods for each object and retry if fail
+        def call_method object, method_params, retry_count = -1
+           begin
+              if method_params.is_a? Hash
+                if method_params.key?(:method_name) && method_params.key?(:params_values) #  {:method _name=>:values_by_ids, :params_values => [1,2,4]}
+                  method_name = method_params[:method_name]
+                  object.send method_name, *method_params[:params_values]
+                else #  {:get_event => Time.now }
+                  method_name = method_params.flatten.first
+                  object.send method_name.to_sym, method_params[method_name]
+                end
+              else # method_name
+                method_name = method_params
+                object.send method_name.to_sym
+              end
+           rescue Exception => e
+              puts "Error calling method  method_name. #{e}"
+
+              if retry_count > 0 && retry_count <= NUMBER_OF_RETRIES
+                seconds_to_sleep = (Random.rand(5) + 5)*(retry_count+1) # (5 + 0..5) x (#retries + 1) seconds
+                puts "Retry call method in #{seconds_to_sleep} seconds"
+
+                sleep seconds_to_sleep
+                call_method object, method_params, retry_count+1
+              else
+                puts "Retries finished or ignored, filling with blank"
+                ""
+              end
+           end
+        end
+
+        # Rails defined?
+        def rails?
+          defined? Rails
+        end
+
+        #Default values of  main method
+        def default_path
+           rails? ? Rails.public_path : File.expand_path(File.dirname(__FILE__))
+        end
+
+   end
+end

data/lib/xls_reporter/version.rb

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

data/xls_reporter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xls_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xls_reporter"
+  spec.version       = XlsReporter::VERSION
+  spec.authors       = ["Felipe Cano"]
+  spec.email         = ["felicanoo@gmail.com"]
+  spec.summary       = "Export data to Excel file."
+  spec.description   = "Export data to Excel file. Iterate in a collection and map values in each row to fill Excel spreadsheet"
+  spec.homepage      = "https://github.com/facano"
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "write_xlsx", "~> 0.76.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: xls_reporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Felipe Cano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: write_xlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+description: Export data to Excel file. Iterate in a collection and map values in
+  each row to fill Excel spreadsheet
+email:
+- felicanoo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xls_reporter.rb
+- lib/xls_reporter/version.rb
+- xls_reporter.gemspec
+homepage: https://github.com/facano
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Export data to Excel file.
+test_files: []