poormans_export 0.1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0512d8f5b14c154addca9d079e50f10ed70ff42be9f298d16be0e43303fb9513
+  data.tar.gz: ba9db716689c2666e67d44720f27f76d46335db2bcb090f3bc9e7bc0722aef86
+SHA512:
+  metadata.gz: 9c82d6e3676b9b1e01c9d678bbc98a088f107f1859ea433b2c3f1ac5fb029ae52baac922ee5bf8f6f99adfbb3f9397404d2a187064c97c4059e5a634091ce0b0
+  data.tar.gz: eebb11a1e9a02174092893a57db84a717fd30691c37ffda89ab0c6b209dc551d8cdfe8e9168a052a4af71312c653a906f044edeb4259edbe7451ebf404f4087f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Usabi
+
+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,64 @@
+# Poorman's Export
+Poorman's Export is a simple but powerful CSV and XLS exporter.
+
+## Usage
+Poorman's Export transforms a collection of objects into a CSV or a XLS file that can be sent to the browser just like this:
+```ruby
+def index
+  @collection = Article.all
+  fields_to_export = %i[id title body created_at published_at]
+
+  respond_to do |format|
+    format.html
+    format.csv do
+      send_data(
+        PoormansExport::Exporter.new(@collection, fields_to_export).csv_string,
+        type: 'text/csv; charset=utf-16le; header=present',
+        disposition: 'attachment',
+        filename: 'articles.csv'
+      )
+    end
+    format.xls do
+      send_data(
+        PoormansExport::Exporter.new(@collection, fields_to_export).xls_string,
+        type: 'application/xls',
+        disposition: 'attachment',
+        filename: 'articles.xls'
+      )
+    end
+  end
+end
+```
+
+Poorman's Export will process the collection and convert its fields into something readable by a human, automatically processing dates, times, booleans and even relations, by using the `to_s` method of the related object.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poormans_export'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install poormans_export
+```
+
+After installing the gem, register the CSV and XLS MIME types in your application by adding these lines to your `config/initializers/mime_types.rb` file:
+```ruby
+Mime::Type.register 'text/csv; charset=utf-16le; header=present', :csv
+Mime::Type.register 'application/xls', :xls
+```
+
+And you're good to go!
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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    = 'PoormansExport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/poormans_export.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'poormans_export/exporter'
+
+module PoormansExport
+end

data/lib/poormans_export/exporter.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'spreadsheet'
+
+module PoormansExport
+  class Exporter
+    def initialize(collection, fields, headers = [])
+      @collection = collection
+      @head = []
+      @fields = []
+      @types = []
+      fields.each do |f|
+        if f.is_a?(Symbol) || f.is_a?(String)
+          @head << f.to_s
+          @fields << f
+        elsif f.is_a?(Hash)
+          @head << f.keys.first
+          @fields << f.values.first
+          @types << f[:type]
+        end
+      end
+      @headers = headers
+    end
+
+    def csv_string(params = {})
+      options = { col_sep: ',' }
+      options.merge! params
+      csv_string = CSV.generate(options) do |csv|
+        if @collection.first.class.nil?
+          class_name = @collection
+        elsif @collection.first.class != NilClass
+          class_name = @collection.first.class
+        end
+
+        header = []
+        @head.each do |header_field|
+          header <<
+            if class_name
+              class_name.human_attribute_name(header_field.gsub(/_ids?/, ''))
+            else
+              header_field
+            end
+        end
+        csv << header
+
+        @collection.each do |item|
+          row_array = []
+          @fields.each do |field|
+            row_array << Exporter.field_value(item, field)
+          end
+          csv << row_array
+        end
+      end
+      csv_string
+    end
+
+    def xls_string(params = {})
+      template_path = params[:template]
+      start_on_row = params[:start_on_row] || 0
+      formats = params[:formats] || { 0 => { weight: :bold } }
+      formats[@headers.size + 1] = { weight: :bold } unless @headers.empty?
+      workbook = params[:workbook]
+      workbook ||=
+        if template_path.present?
+          ::Spreadsheet.open(template_path)
+        else
+          ::Spreadsheet::Workbook.new
+        end
+      sheet = template_path ? workbook.worksheet(0) : workbook.create_worksheet
+      sheet.name = params[:sheet_name] if params[:sheet_name]
+      current_row = start_on_row
+
+      if @collection.first.class.nil?
+        class_name = @collection
+      elsif @collection.first.class != NilClass
+        class_name = @collection.first.class
+      end
+
+      unless @headers.empty?
+        if @headers[0]
+          sheet.row(current_row).concat [@headers[0]]
+          current_row += 1
+        end
+        sheet.row(current_row).concat [I18n.l(Time.zone.now, format: :compact)]
+        current_row += 1
+        if @headers[1]
+          sheet.row(current_row).concat [@headers[1]]
+          current_row += 1
+        end
+      end
+
+      header = []
+      @head.each do |header_field|
+        header <<
+          if class_name
+            class_name.human_attribute_name(header_field.gsub(/_ids?/, ''))
+          else
+            header_field
+          end
+      end
+      sheet.row(current_row).concat header
+      current_row += 1
+
+      @collection.each do |item|
+        row_array = []
+        @fields.each do |field|
+          row_array << Exporter.field_value(item, field)
+        end
+        sheet.row(current_row).replace row_array
+        @types.each_with_index do |type, idx|
+          case type
+          when Date
+            cell_format = 'DD-MM-YYYY'
+          when Time
+            cell_format = 'DD-MM-YYYY HH:MM:SS'
+          end
+          next unless cell_format
+
+          sheet.row(current_row).set_format(
+            idx,
+            Spreadsheet::Format.new(number_format: cell_format)
+          )
+        end
+        current_row += 1
+      end
+
+      formats.each do |k, v|
+        format = Spreadsheet::Format.new(v)
+        if k.respond_to?(:each)
+          k.each do |sub_k|
+            sheet.row(sub_k).default_format = format
+          end
+        else
+          sheet.row(k).default_format = format
+        end
+      end
+
+      if params[:format] == :object
+        workbook
+      else
+        output = StringIO.new
+        workbook.write(output)
+        output.string
+      end
+    end
+
+    def self.field_value(item, field)
+      if item && field.is_a?(Proc)
+        Exporter.format field.call(item)
+      elsif field =~ /(.+)_id$/
+        Exporter.format item.send(Regexp.last_match(1))
+      elsif field =~ /(.+)_ids$/
+        item.send(Regexp.last_match(1)).map do |f|
+          Exporter.format f
+        end.join('; ')
+      elsif field.in? %w[status state]
+        I18n.t(item.send(field), scope: field.to_sym)
+      elsif item.is_a?(Hash)
+        Exporter.format item[field]
+      else
+        Exporter.format item.send(field)
+      end
+    end
+
+    def self.format(val)
+      val = Time.zone.parse(val) if val.is_a?(String) && val =~ /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}/
+
+      if val.is_a?(ActiveRecord::Base)
+        val.try(:to_s)
+      elsif val.is_a? Time
+        I18n.l(val, format: :compact)
+      elsif val.is_a? Date
+        I18n.l(val, format: :default)
+      elsif val.is_a? BigDecimal
+        val.to_f
+      elsif val.is_a?(FalseClass) || val.is_a?(TrueClass)
+        I18n.t(val ? 'yes' : 'no')
+      elsif val.nil?
+        '-'
+      else
+        val
+      end
+    end
+  end
+end

data/lib/poormans_export/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PoormansExport
+  VERSION = '0.1.0.1'
+end

data/lib/tasks/poormans_export_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :poormans_export do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: poormans_export
+version: !ruby/object:Gem::Version
+  version: 0.1.0.1
+platform: ruby
+authors:
+- Imobach González Sosa
+- Ignacio Aliende García
+- Adán Alonso Salvador
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Poorman's Export is a simple but powerful CSV and XLS exporter
+email:
+- imobachgs@banot.net
+- ialiendeg@gmail.com
+- adan.alonso.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/poormans_export.rb
+- lib/poormans_export/exporter.rb
+- lib/poormans_export/version.rb
+- lib/tasks/poormans_export_tasks.rake
+homepage: https://github.com/Usabi/poormans_export
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple but powerful exporter
+test_files: []