rails-exporter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48735310c85efae63e71d3e708ae1ca823fca999
+  data.tar.gz: 4e368937e4d37ff016e9c7b51e0126d1000eb3b3
+SHA512:
+  metadata.gz: af019d22486e8ef81d42f0a63736cd0d8e3df0a49ce30ef5b591a3b9e9e0ba24106d72aaadcfc7b9d2051e7a358c1112a79bf1dac720fe9869f6323b78a29329
+  data.tar.gz: 4df6e08bed7e5a1d873e6be0409a8451dacb7ef437a9780b2e4fc7250d6b093703f08f4307a7bef1bed62e15a2be60201d712881d0422d28278943c9abba269d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Bruno Porto
+
+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,82 @@
+# Rails Exporter 
+
+Rails Exporter
+
+## How to install
+
+Add it to your **Gemfile**: 
+```ruby
+gem 'rails-exporter'
+```
+
+Run the following command to install it:
+```sh
+$ bundle install
+$ rails generate rails_exporter:install
+```
+
+## Generators
+
+You can generate exporters `app/exporters/example_exporter.rb`
+
+```sh
+$ rails generate rails_exporter:exporter example
+```
+
+Generator will make a file with content like:
+
+```ruby
+class ExampleExporter < RailsExporter::Base
+
+  exporter do
+    column :name
+    column :email
+    column :price => :currency
+    column :is_admin => :boolean
+    column :birthday => :date
+    column :created_at => :datetime
+    column(:account) {|record| record.account.name}
+    column(:updated_at) do |record|
+      record.updated_at.strftime("%d/%m/%Y %H:%M:%S")
+    end
+  end
+
+  # exporter :simple do
+  #   column :nome
+  #   column :email
+  # end
+
+end
+```
+
+### How to use
+
+You can call `export_to` from **Array** or **ActiveRecord::Relation** objects: 
+```erb
+    records = MyModel.all
+    records.export_to(:csv) # or MyModelExporter.export_to_csv(records)
+    
+    records = [MyModel.first, MyModel.last]
+    records.export_to(:xml) # or MyModelExporter.export_to_xml(records)
+```
+
+### Controller Example
+
+```erb
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+    respond_to do |format|
+      format.html
+      format.csv { send_data @users.export_to(:csv) }
+      format.xml { send_data @users.export_to(:xml) }
+      format.xls { send_data @users.export_to(:xls) }
+    end
+  end
+end
+```
+
+For `format.xls` maybe you need to declare XLS mimetype in `config/initializers/mime_types` :
+```erb
+    Mime::Type.register "application/xls", :xls
+```

data/Rakefile

@@ -0,0 +1,29 @@
+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    = 'RailsExporter'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.rdoc')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+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/config/initializers/rails_exporter.rb

@@ -0,0 +1,6 @@
+class Railtie < ::Rails::Railtie
+  initializer 'activeservice.autoload', :before => :set_autoload_paths do |app|
+    raise app.inspect
+    app.config.autoload_paths += %( #{Rails.application.config.root}/app/exporters )
+  end
+end

data/config/locales/exporters.en.yml

@@ -0,0 +1,8 @@
+en:
+  exporters:
+    spreadsheet_name: 'Spreadsheet'
+    example:
+      name: 'Name'
+    another_example:
+      name: 'Name'
+      age: 'Age'

data/lib/generators/rails_exporter/exporter_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module RailsExporter
+  class ExporterGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def generate_exporter
+      @exporter_name = file_name.classify
+      template "generic_exporter.erb", File.join('app/exporters', "#{file_name.underscore}_exporter.rb")
+    end
+  end
+end

data/lib/generators/rails_exporter/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+
+module RailsExporter
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../config", __FILE__)
+
+      def copy_locales
+        directory 'locales', 'config/locales'
+      end
+
+    end
+
+  end
+end

data/lib/generators/templates/generic_exporter.erb

@@ -0,0 +1,21 @@
+class <%= @exporter_name %>Exporter < RailsExporter::Base
+
+  exporter do
+    column :name
+    column :email
+    column :price => :currency
+    column :is_admin => :boolean
+    column :birthday => :date
+    column :created_at => :datetime
+    column(:account) {|record| record.account.name}
+    column(:updated_at) do |record|
+      record.updated_at.strftime("%d/%m/%Y %H:%M:%S")
+    end
+  end
+
+  # exporter :simple do
+  #   column :nome
+  #   column :email
+  # end
+
+end

data/lib/rails-exporter.rb

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

data/lib/rails_exporter/base.rb

@@ -0,0 +1,58 @@
+require 'rails_exporter/exporter'
+
+module RailsExporter
+  class Base
+    include RailsExporter::Exporter
+
+    class_attribute :exporters
+
+    class << self
+      def file_types
+        [:csv, :xls, :xml]
+      end
+
+      # def method_missing(m, *args, &block)
+      #   if m =~ /_url|_path/
+      #     Rails.application.routes.url_helpers.send(m, args)
+      #   end
+      # end
+
+      def exporter(name=:default, &block)
+        (self.exporters ||= {})[name] ||= []
+        @exporter_name = name
+        block.call if block_given?
+        self.exporters[name]
+      end
+
+      def column(attr, &block)
+        if attr.is_a?(Hash)
+          attribute = attr.keys.first.to_s.to_sym
+          type = attr.values.first.to_s.to_sym
+        else
+          attribute = attr.to_sym
+          type = :string
+        end
+
+        label = I18n.t(attribute, default: [attribute.to_s.humanize], scope: [:exporters, @exporter_name])
+        self.exporters[@exporter_name] << {column: attribute, label: label, type: normalize_type(type), block: block}
+      end
+
+      def columns(exporter_name=:default)
+        self.exporters[exporter_name].map do |attribute|
+          attribute.slice(:column, :label, :type)
+        end
+      end
+
+      private
+      def normalize_type(type)
+        if [:currency, :boolean, :date, :datetime, :string].include?(type.to_s.to_sym)
+          type.to_s.to_sym
+        else
+          :string
+        end
+      end
+
+    end
+
+  end
+end

data/lib/rails_exporter/engine.rb

@@ -0,0 +1,4 @@
+module RailsExporter
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_exporter/exporter.rb

@@ -0,0 +1,112 @@
+require 'builder'
+
+module RailsExporter
+  module Exporter
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def export_to_csv(records, context=:default)
+        #Gerando CSV com separador ; e usando " nos campos por padrão.
+        CSV.generate({:col_sep => ';', :force_quotes => true}) do |csv|
+          #Cabeçalho
+          csv << get_columns(context).map do |attr|
+            attr_name(attr)
+          end
+          #DADOS
+          records.each do |record|
+            csv << get_values(record, context)
+          end
+        end
+      end
+
+      def export_to_xml(records, context=:default)
+        #Gerando arquivo XML
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        #Formando tipo de saida de dados
+        xml.instruct! :xml, :encoding => "UTF-8"
+        xml.records do
+          #Gerando cada linha de record
+          records.each do |record|
+            get_values = get_values(record, context)
+            xml.record do |r|
+              i = 0
+              get_columns(context).map do |attr|
+                attr = attr.keys.first if attr.is_a?(Hash)
+                xml.tag!(attr, get_values[i], {title: attr_name(attr)})
+                i+=1
+              end
+            end
+          end
+        end
+      end
+
+      def export_to_xls(records, context=:default)
+        #FILE
+        file_contents = StringIO.new
+        #CHARSET
+        Spreadsheet.client_encoding = 'UTF-8'
+        #NEW document/spreadsheet
+        document = Spreadsheet::Workbook.new
+        spreadsheet = document.create_worksheet
+        spreadsheet.name = I18n.t(:spreadsheet_name, default: ['Spreadsheet'], scope: [:exporters])
+        #HEADER FORMAT
+        spreadsheet.row(0).default_format = Spreadsheet::Format.new :weight => :bold
+        #HEADER
+        get_columns(context).each_with_index do |attr, i|
+          attr = attr.keys.first if attr.is_a?(Hash)
+          spreadsheet.row(0).insert i, (self.human_attribute_name(attr) || attr)
+        end
+        #ROWS
+        records.each_with_index do |record, i|
+          values = get_values(record, context)
+          spreadsheet.row(i+1).push(*values)
+        end
+        #SAVE spreadsheet
+        document.write file_contents
+        #RETURN STRING
+        file_contents.string.force_encoding('binary')
+      end
+
+      private
+      def get_columns(context)
+        self.send(:columns, context) || []
+      end
+
+      def attr_name(attr)
+        attr[:label] || attr[:column]
+      end
+
+      def get_values(record, context)
+        get_columns(context).map do |attribute|
+          if attribute[:block].is_a?(Proc)
+            value = attribute[:block].call(record)
+            value.to_s
+          else
+            value = (record.send(attribute[:column]) rescue '')
+            normalize_value(value, attribute[:type])
+          end
+        end
+      end
+
+      def normalize_value(value, type=nil)
+        type = type.present? ? type.to_sym : :unknown
+        if type==:currency
+          ActionController::Base.helpers.number_to_currency(value)
+        elsif type==:boolean
+          (value==true or value=='true' or value=='1') ? 'S' : 'N'
+        elsif type==:date
+          (I18n.l(value, format: '%d/%m/%Y') rescue value).to_s
+        elsif type==:datetime
+          (I18n.l(value, format: '%d/%m/%Y %H:%i:%s') rescue value).to_s
+        else
+          (I18n.l(value) rescue value)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/rails_exporter/helper.rb

@@ -0,0 +1,36 @@
+require 'rails_exporter/base'
+
+module RailsExporter
+  module Helper
+
+    define_method "export_to" do |ext, context=:default|
+      exec_method(ext, context)
+    end
+
+    private
+    def get_obj_class
+      (self.first.class rescue nil)
+    end
+    def exec_method(ext, context)
+      klass = get_obj_class
+      exporter_klass = "#{klass.name}_exporter".classify.constantize
+      # RailsExporter::Base.file_types
+      if exporter_klass and exporter_klass.respond_to?("export_to_#{ext}")
+        exporter_klass.send("export_to_#{ext}", self, context)
+      end
+    end
+  end
+
+end
+
+#INJETANDO METODO para_* em um conjunto de array
+class Array
+  include RailsExporter::Helper
+end
+
+#INJETANDO METODO para_* em um conjunto de registros ActiveRecord::Relation
+module ActiveRecord
+  class Relation
+    include RailsExporter::Helper
+  end
+end

data/lib/rails_exporter/version.rb

@@ -0,0 +1,3 @@
+module RailsExporter
+  VERSION = "0.0.2"
+end

data/lib/rails_exporter.rb

@@ -0,0 +1,7 @@
+require 'rails_exporter/engine'
+require 'rails_exporter/helper'
+require 'rails_exporter/exporter'
+require 'rails_exporter/base'
+
+module RailsExporter
+end

data/lib/tasks/rails_exporter_tasks.rake

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rails-exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bruno Porto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails Exporter
+email:
+- brunotporto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/rails_exporter.rb
+- config/locales/exporters.en.yml
+- lib/generators/rails_exporter/exporter_generator.rb
+- lib/generators/rails_exporter/install_generator.rb
+- lib/generators/templates/generic_exporter.erb
+- lib/rails-exporter.rb
+- lib/rails_exporter.rb
+- lib/rails_exporter/base.rb
+- lib/rails_exporter/engine.rb
+- lib/rails_exporter/exporter.rb
+- lib/rails_exporter/helper.rb
+- lib/rails_exporter/version.rb
+- lib/tasks/rails_exporter_tasks.rake
+homepage: https://github.com/brunoporto/rails-exporter
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails Exporter
+test_files: []