rails-importer 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ee6bdad79ed8a4d980a915735461df003bca4d5
+  data.tar.gz: 2105757e2d2515fdcb8f4e1483df2f85bc683f07
+SHA512:
+  metadata.gz: 046fc96c808dfcce475bd1ada1e0c5467ec78b4d6ccee48a46d9a5029ca25d1d573d252f4f94a02249eaf96e896db33c28d64c63dc7eefa46d831cd1ee5bf996
+  data.tar.gz: 1ff316fc036a83d9a93c82ceb5404441e3cb6a8413e42fff0b9a3969b1b9bf61147589e0321634debb76c14ff6df6f1fcd4cf2f987372e38f7d7378709607f05

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,62 @@
+# Rails Importer 
+
+Rails Importer (XML, XLS, CSV)
+
+## How to install
+
+Add it to your **Gemfile**: 
+```ruby
+gem 'rails-importer'
+```
+
+Run the following command to install it:
+```sh
+$ bundle install
+$ rails generate rails_importer:install
+```
+
+## Generators
+
+You can generate importers `app/importers/example_importer.rb`
+
+```sh
+$ rails generate rails_importer:importer example
+```
+
+Generator will make a file with content like:
+
+```ruby
+class ExampleImporter < RailsImporter::Base
+
+  importer do
+    fields :name, :email, :age
+    each_record do |record, params|
+      MyModel.find_or_create_by(name: record[:name], email: record[:email], age: record[:age])
+    end
+  end
+  
+  # importer :simple do
+  #   xml_structure :root, :row
+  #   fields :name, :email, :age
+  #   each_record do |record, params|
+  #       ...
+  #   end
+  # end
+
+end
+```
+
+### How to use
+
+You can call `import` from **Importers** objects: 
+```erb
+    file = params[:import][:file]
+    records = ExampleImporter.import(file, extra_param: 'Extra')
+```
+
+Or with context:
+
+```erb
+    file = params[:import][:file]
+    records = ExampleImporter.import(file, context: :simple, extra_param: 'Extra')
+```

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    = 'RailsImporter'
+  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/config/initializers/rails_importer.rb

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

data/config/locales/importers.en.yml

@@ -0,0 +1,4 @@
+en:
+  importer:
+    error:
+      invalid_file_type: "Invalid file type allowed: %{file_types}"

data/lib/generators/rails_importer/importer_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module RailsImporter
+  class ImporterGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def generate_importer
+      @importer_name = file_name.classify
+      template "generic_importer.erb", File.join('app/importers', "#{file_name.underscore}_importer.rb")
+    end
+  end
+end

data/lib/generators/rails_importer/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+
+module RailsImporter
+  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_importer.erb

@@ -0,0 +1,18 @@
+class <%= @importer_name %>Importer < RailsImporter::Base
+
+  importer do
+    fields :name, :email, :age
+    each_record do |record, params|
+      MyModel.find_or_create_by(name: record[:name], email: record[:email], age: record[:age])
+    end
+  end
+
+  # importer :simple do
+  #   xml_structure :root, :row
+  #   fields :name, :email, :age
+  #   each_record do |record, params|
+  #       ...
+  #   end
+  # end
+
+end

data/lib/rails-importer.rb

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

data/lib/rails_importer/_importer.rb

@@ -0,0 +1,138 @@
+require 'ostruct'
+
+module RailsImporter
+
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.define_singleton_method 'colunas' do |*args|
+      @importacao_colunas = nil unless @importacao_colunas.present?
+      if args.present?
+        @importacao_colunas = (args.first.is_a?(Hash) ? args.inject(:merge) : args)
+      else
+        @importacao_colunas
+      end
+    end
+
+    base.define_singleton_method 'estrutura_xml' do |*args|
+      @importacao_estrutura_xml = nil unless @importacao_estrutura_xml.present?
+      if args.present?
+        @importacao_estrutura_xml = args
+      else
+        @importacao_estrutura_xml
+      end
+    end
+
+    base.define_singleton_method 'para_cada_linha' do |&block|
+      define_singleton_method('importar_registro') do |registro, *args|
+        block.call(registro, *args)
+      end
+    end
+
+  end
+
+  def self.tipos_de_arquivos
+    [:csv, :xls, :xml]
+  end
+
+  module ClassMethods
+
+    def importacao(&block)
+      block.call if block_given?
+      self.class.class_eval do
+        define_method :importar do |arquivo, *args|
+          retorno = []
+          begin
+            ext = (File.extname(arquivo.path)[1..-1] rescue nil)
+            if arquivo.respond_to?(:path) and RailsImporter.tipos_de_arquivos.include?(ext.to_sym)
+              registros = self.send("#{ext}_para_array", arquivo)
+              if registros.present? and registros.is_a?(Array)
+                retorno = registros.map do |registro|
+                  importar_registro(registro, *args)
+                end
+              end
+            else
+              raise "Tipo de arquivo inválido. Arquivos permitidos: #{RailsImporter.tipos_de_arquivos.join(', ')}"
+            end
+          rescue Exception => e
+            retorno = e.message
+          end
+          retorno
+        end
+      end
+    end
+
+    private
+    def csv_para_array(arquivo)
+      registros = []
+      linha=0
+      CSV.foreach(arquivo.path, {:headers => false, :col_sep => ';', :force_quotes => true}) do |row|
+        if linha>0
+          registros << object_values(row) unless array_blank?(row)
+        end
+        linha+=1
+      end
+      registros
+    end
+
+    def xml_para_array(arquivo)
+      registros = []
+      estrutura_xml = self.send(:estrutura_xml)
+      if estrutura_xml.present? and estrutura_xml.is_a?(Array) and estrutura_xml.count > 0
+        xml = Hash.from_xml(arquivo.read)
+        estrutura_xml.each do |node|
+          xml = xml[node.to_s]
+        end
+        xml.each do |elem|
+          registros << object_values(elem.values) unless array_blank?(elem.values)
+        end
+      else
+        raise 'Você precisa informar a estrutura_xml no seu Model'
+      end
+      registros
+    end
+
+    def xls_para_array(arquivo)
+      registros = []
+      Spreadsheet.client_encoding = 'UTF-8'
+      documento = Spreadsheet.open(arquivo.path)
+      planilha = documento.worksheet 0
+      planilha.each_with_index do |row, i|
+        next unless i>0
+        registros << object_values(row) unless array_blank?(row)
+      end
+      registros
+    end
+
+    def object_values(array)
+      atributos = self.send(:colunas)
+      atributos = atributos.keys if atributos.is_a?(Hash)
+      args = array[0...atributos.size]
+      hValores = Hash[atributos.zip(args)]
+      #Ajustando valores inválidos
+      atributos.each do |atributo|
+        if hValores[atributo].present?
+          if hValores[atributo].is_a?(Numeric)
+            hValores[atributo] = hValores[atributo].to_i if hValores[atributo].modulo(1).zero?
+            hValores[atributo] = (hValores[atributo].to_s.strip rescue '#ERRO AO CONVERTER NUMERO PARA TEXTO')
+          elsif hValores[atributo].is_a?(Date)
+            hValores[atributo] = (I18n.l(hValores[atributo], format: '%d/%m/%Y') rescue hValores[atributo]).to_s
+          elsif hValores[atributo].is_a?(DateTime)
+            hValores[atributo] = (I18n.l(hValores[atributo], format: '%d/%m/%Y %H:%i:%s') rescue hValores[atributo]).to_s
+          else
+            #PARA QUALQUER OUTRO VALOR, FORÇA CONVERTER PARA STRING
+            hValores[atributo] = (hValores[atributo].to_s.strip rescue '')
+          end
+        else
+          hValores[atributo] = ''
+        end
+      end
+      OpenStruct.new(hValores)
+    end
+
+    def array_blank?(array)
+      array.all? {|i|i.nil? or i==''}
+    end
+
+  end
+end

data/lib/rails_importer/base.rb

@@ -0,0 +1,136 @@
+require 'builder'
+require 'spreadsheet'
+
+module RailsImporter
+  class Base
+    class_attribute :importers
+
+    class << self
+      def import(file, *args)
+        context = args.try(:context) || :default
+        result = []
+        begin
+          ext = (File.extname(file.path)[1..-1] rescue nil)
+          if file.respond_to?(:path) and self.file_types.include?(ext.to_sym)
+            rows = self.send("import_from_#{ext}", file)
+            if rows.present? and rows.is_a?(Array)
+              result = rows.map do |record|
+                self.importers[context][:each_record].call(record, *args) if self.importers[context][:each_record].is_a?(Proc)
+              end.compact
+            end
+          else
+            I18n.t(:invalid_file_type, file_types: self.file_types.join(', '), scope: [:importer, :error])
+          end
+        rescue Exception => e
+          result = e.message
+        end
+        result
+      end
+
+      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 importer(name=:default, &block)
+        (self.importers ||= {})[name] ||= {fields: [], xml_structure: [:records, :record], each_record: nil}
+        @importer_name = name
+        block.call if block_given?
+        self.importers[name]
+      end
+
+      def fields(*attributes)
+        importer_value(:fields, attributes)
+      end
+
+      def xml_structure(*attributes)
+        importer_value(:xml_structure, attributes)
+      end
+
+      def each_record(&block)
+        importer_value(:each_record, block)
+      end
+
+      private
+      def import_from_csv(file, context=:default)
+        records = []
+        line = 0
+        CSV.foreach(file.path, {:headers => false, :col_sep => ';', :force_quotes => true}) do |row|
+          if line>0
+            records << object_values(row, context) unless array_blank?(row)
+          end
+          line+=1
+        end
+        records
+      end
+
+      def import_from_xml(file, context=:default)
+        records = []
+        xml_structure = self.importers[context][:xml_structure]
+        xml = Hash.from_xml(file.read)
+        xml_structure.each do |node|
+          xml = xml[node.to_s]
+        end
+        xml.each do |elem|
+          records << object_values(elem.values, context) unless array_blank?(elem.values)
+        end
+        records
+      end
+
+      def import_from_xls(file, context=:default)
+        records = []
+        Spreadsheet.client_encoding = 'UTF-8'
+        document = Spreadsheet.open(file.path)
+        spreadsheet = document.worksheet 0
+        spreadsheet.each_with_index do |row, i|
+          next unless i>0
+          records << object_values(row, context) unless array_blank?(row)
+        end
+        records
+      end
+
+      def object_values(array, context=:default)
+        attributes = self.importers[context][:fields]
+        attributes = attributes.keys if attributes.is_a?(Hash)
+        args = array[0...attributes.size]
+        hValues = Hash[attributes.zip(args)]
+        attributes.each do |attr|
+          if hValues[attr].present?
+            if hValues[attr].is_a?(Numeric)
+              hValues[attr] = hValues[attr].to_i if hValues[attr].modulo(1).zero?
+              hValues[attr] = (hValues[attr].to_s.strip rescue '#ERRO AO CONVERTER NUMERO PARA TEXTO')
+            elsif hValues[attr].is_a?(Date)
+              hValues[attr] = (I18n.l(hValues[attr], format: '%d/%m/%Y') rescue hValues[attr]).to_s
+            elsif hValues[attr].is_a?(DateTime)
+              hValues[attr] = (I18n.l(hValues[attr], format: '%d/%m/%Y %H:%i:%s') rescue hValues[attr]).to_s
+            else
+              #PARA QUALQUER OUTRO VALOR, FORÇA CONVERTER PARA STRING
+              hValues[attr] = (hValues[attr].to_s.strip rescue '')
+            end
+          else
+            hValues[attr] = ''
+          end
+        end
+        OpenStruct.new(hValues)
+      end
+
+      def array_blank?(array)
+        array.all? {|i|i.nil? or i==''}
+      end
+
+      def importer_value(key, attributes)
+        if attributes.present?
+          self.importers[@importer_name][key] = attributes
+        else
+          self.importers[@importer_name][key]
+        end
+      end
+    end
+
+  end
+end

data/lib/rails_importer/engine.rb

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

data/lib/rails_importer/version.rb

@@ -0,0 +1,3 @@
+module RailsImporter
+  VERSION = "0.0.6"
+end

data/lib/rails_importer.rb

@@ -0,0 +1,5 @@
+require 'rails_importer/engine'
+require 'rails_importer/base'
+
+module RailsImporter
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rails-importer
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Bruno Porto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+description: Rails Importer (CSV, XLS, XML)
+email:
+- brunotporto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/rails_importer.rb
+- config/locales/importers.en.yml
+- lib/generators/rails_importer/importer_generator.rb
+- lib/generators/rails_importer/install_generator.rb
+- lib/generators/templates/generic_importer.erb
+- lib/rails-importer.rb
+- lib/rails_importer.rb
+- lib/rails_importer/_importer.rb
+- lib/rails_importer/base.rb
+- lib/rails_importer/engine.rb
+- lib/rails_importer/version.rb
+homepage: https://github.com/brunoporto/rails-importer
+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 Importer
+test_files: []