csv_import_magic 0.0.1

data/spec/fixtures/companies.csv

@@ -0,0 +1,3 @@
+nome,rua,numero,bairro,cidade ,estado ,cod,pais
+foo,R: Teste,1,Joao de Barro,Birigui,SP ,,Brasil
+bar,R: Teste,2,Joao de Barro,Aracatuba,SP ,,Brasil

data/spec/fixtures/companies_invalid.csv

@@ -0,0 +1,3 @@
+nome,rua,numero,bairro,cidade ,estado ,cod,pais
+foo,R: Teste,1,Joao de Barro,Birigui,SP ,,Brasil
+bar,R: Teste,2a,Joao de Barro,Aracatuba,SP ,,Brasil

data/spec/lib/csv_import_magic/models_spec.rb

@@ -0,0 +1,51 @@
+require 'rails_helper'
+
+RSpec.describe CsvImportMagic::Models, type: :lib do
+  context 'with normal parser' do
+    let(:foo_model) do
+      class FooParser; end
+
+      Class.new do
+        extend CsvImportMagic::Models
+        csv_import_magic foo: [:foo, :bar]
+
+        def self.name
+          'Foo'
+        end
+      end
+    end
+
+    describe '#csv_parser_names' do
+      it { expect(foo_model.new.csv_parser_names).to eq('foo_parser' => FooParser) }
+    end
+
+    describe '#columns_names' do
+      it { expect(foo_model.columns_names(:foo)).to match_array([:foo, :bar]) }
+    end
+
+    describe '#csv_parser_default_name' do
+      it { expect(foo_model.csv_parser_default_name).to eq('foo_parser') }
+    end
+  end
+
+  context 'with multiple parser' do
+    let(:bar_model) do
+      class BarParser; end
+      class FooParser; end
+
+      Class.new do
+        extend CsvImportMagic::Models
+        csv_import_magic foo: [:foo, :bar], bar: [:foo]
+      end
+    end
+
+    describe '#csv_parser_names' do
+      it { expect(bar_model.new.csv_parser_names).to eq('foo_parser' => FooParser, 'bar_parser' => BarParser) }
+    end
+
+    describe '#columns_names' do
+      it { expect(bar_model.columns_names(:foo)).to match_array([:foo, :bar]) }
+      it { expect(bar_model.columns_names(:bar)).to match_array([:foo]) }
+    end
+  end
+end

data/spec/lib/generators/active_record/csv_import_magic_generator_spec.rb

@@ -0,0 +1,74 @@
+require 'rails_helper'
+require 'generators/active_record/csv_import_magic_generator'
+
+RSpec.describe ActiveRecord::Generators::CsvImportMagicGenerator, type: :generator do
+  destination File.expand_path('../../../../../tmp', __FILE__)
+  arguments ['foo', '-c', 'foo', 'bar']
+
+  before do
+    prepare_destination
+
+    FileUtils.mkdir_p('tmp/app/models')
+    out_file = File.new(File.join(ENGINE_RAILS_ROOT, 'tmp/app/models/foo.rb'), 'w+')
+    out_file.puts("class Foo\nend")
+    out_file.close
+
+    run_generator
+  end
+
+  after { prepare_destination }
+
+  specify 'check structure of model' do
+    model_content = <<-EOF
+class Foo
+  csv_import_magic :foo, :bar
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'models' do
+          file 'foo.rb' do
+            contains model_content
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of parser' do
+    parser_content = <<-EOF
+class FooParser
+  include ::CSVImporter
+
+  model Foo
+
+  # will update_or_create via :foo
+  identifier :foo
+
+  # Examples of columns declaration
+  # column :foo, to: ->(foo) { foo.downcase }, required: true
+  # column :foo, as: [ /first.?name/i, /pr(é|e)nom/i ]
+  # column :foo,  as: [ /last.?name/i, "nom" ]
+  # column :foo,  to: ->(foo, record) { record.foo = foo ?  'a' : 'b' }
+
+  column :foo, required: true
+
+  column :bar, required: true
+
+  # or :abort
+  #  when_invalid :skip
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'csv_parsers' do
+          file 'foo_parser.rb' do
+            contains parser_content
+          end
+        end
+      end
+    }
+  end
+end

data/spec/lib/generators/active_record/namespaced/csv_import_magic_generator_spec.rb

@@ -0,0 +1,78 @@
+require 'rails_helper'
+require 'generators/active_record/csv_import_magic_generator'
+
+RSpec.describe ActiveRecord::Generators::CsvImportMagicGenerator, type: :generator do
+  destination File.expand_path('../../../../../tmp', __FILE__)
+  arguments ['foo::bar', '-c', 'foo', 'bar']
+
+  before do
+    prepare_destination
+
+    FileUtils.mkdir_p('tmp/app/models/foo')
+    out_file = File.new(File.join(ENGINE_RAILS_ROOT, 'tmp/app/models/foo/bar.rb'), 'w+')
+    out_file.puts("class Foo::Bar\nend")
+    out_file.close
+
+    run_generator
+  end
+
+  after { prepare_destination }
+
+  specify 'check structure of model' do
+    model_content = <<-EOF
+class Foo::Bar < ActiveRecord::Base
+  csv_import_magic :foo, :bar
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'models' do
+          directory 'foo' do
+            file 'bar.rb' do
+              contains model_content
+            end
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of parser' do
+    parser_content = <<-EOF
+class Foo::BarParser
+  include ::CSVImporter
+
+  model Foo::Bar
+
+  # will update_or_create via :foo
+  identifier :foo
+
+  # Examples of columns declaration
+  # column :foo, to: ->(foo) { foo.downcase }, required: true
+  # column :foo, as: [ /first.?name/i, /pr(é|e)nom/i ]
+  # column :foo,  as: [ /last.?name/i, "nom" ]
+  # column :foo,  to: ->(foo, record) { record.foo = foo ?  'a' : 'b' }
+
+  column :foo, required: true
+
+  column :bar, required: true
+
+  # or :abort
+  #  when_invalid :skip
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'csv_parsers' do
+          directory 'foo' do
+            file 'bar_parser.rb' do
+              contains parser_content
+            end
+          end
+        end
+      end
+    }
+  end
+end

data/spec/lib/generators/csv_import_magic/controllers_generator_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+require 'generators/csv_import_magic/controllers_generator'
+
+RSpec.describe CsvImportMagic::Generators::ControllersGenerator, type: :generator do
+  destination File.expand_path('../../../../../tmp', __FILE__)
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  after { prepare_destination }
+
+  specify 'check structure of base_controller' do
+    base_controller_content = <<-EOF
+module CsvImportMagic
+  class BaseController < ActionController::Base
+  end
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'controllers' do
+          directory 'csv_import_magic' do
+            file 'base_controller.rb' do
+              contains base_controller_content
+            end
+          end
+        end
+      end
+    }
+  end
+end

data/spec/lib/generators/csv_import_magic/install_generator_spec.rb

@@ -0,0 +1,79 @@
+require 'rails_helper'
+require 'generators/csv_import_magic/install_generator'
+
+RSpec.describe CsvImportMagic::Generators::InstallGenerator, type: :generator do
+  destination File.expand_path('../../../../../tmp', __FILE__)
+
+  before do
+    travel_to Time.zone.parse('20170101235959')
+    prepare_destination
+
+    FileUtils.mkdir_p('tmp/config')
+
+    out_file = File.new(File.join(ENGINE_RAILS_ROOT, 'tmp/config/routes.rb'), 'w+')
+    out_file.puts("Rails.application.routes.draw do\nend")
+    out_file.close
+
+    run_generator
+  end
+
+  after do
+    prepare_destination
+    travel_back
+  end
+
+  specify 'check structure of routes' do
+    expect(destination_root).to have_structure {
+      directory 'config' do
+        file 'routes.rb' do
+          contains "mount CsvImportMagic::Engine => '/csv_import_magic'"
+        end
+      end
+    }
+  end
+
+  specify 'check structure of migrateion' do
+    migration_content = <<-EOF
+class CreateImporters < ActiveRecord::Migration
+  def change
+    create_table :importers do |t|
+      t.attachment :attachment
+      t.attachment :attachment_error
+      t.string :source
+      t.string :parser
+      t.string :columns
+      t.string :message
+      t.string :status, default: 'pending'
+      t.references :importable, polymorphic: true
+      t.timestamps null: false
+    end
+
+    add_index :importers, [:importable_id, :importable_type]
+  end
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'db' do
+        directory 'migrate' do
+          file '20170101235959_create_importers.rb'
+          migration 'create_importers' do
+            contains migration_content
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of locale' do
+    expect(destination_root).to have_structure {
+      directory 'config' do
+        directory 'locales' do
+          file 'csv_import_magic.en.yml' do
+            contains 'en:'
+          end
+        end
+      end
+    }
+  end
+end

data/spec/lib/generators/csv_import_magic/rails_5/install_generator_spec.rb

@@ -0,0 +1,62 @@
+require 'rails_helper'
+require 'generators/csv_import_magic/install_generator'
+
+RSpec.describe CsvImportMagic::Generators::InstallGenerator, type: :generator do
+  destination File.expand_path('../../../../../../tmp', __FILE__)
+
+  before do
+    travel_to Time.zone.parse('20170101235959')
+
+    allow(Rails).to receive(:version).and_return('5.1')
+    Rails::VERSION::MAJOR = 5
+    Rails::VERSION::MINOR = 1
+
+    prepare_destination
+
+    FileUtils.mkdir_p('tmp/config')
+
+    out_file = File.new(File.join(ENGINE_RAILS_ROOT, 'tmp/config/routes.rb'), 'w+')
+    out_file.puts("Rails.application.routes.draw do\nend")
+    out_file.close
+
+    run_generator
+  end
+
+  after do
+    travel_back
+    prepare_destination
+  end
+
+  specify 'check migrations' do
+    migration_content = <<-EOF
+class CreateImporters < ActiveRecord::Migration[5.1]
+  def change
+    create_table :importers do |t|
+      t.attachment :attachment
+      t.attachment :attachment_error
+      t.string :source
+      t.string :parser
+      t.string :columns
+      t.string :message
+      t.string :status, default: 'pending'
+      t.references :importable, polymorphic: true
+      t.timestamps null: false
+    end
+
+    add_index :importers, [:importable_id, :importable_type]
+  end
+end
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'db' do
+        directory 'migrate' do
+          file '20170101235959_create_importers.rb'
+          migration 'create_importers' do
+            contains migration_content
+          end
+        end
+      end
+    }
+  end
+end

data/spec/lib/generators/csv_import_magic/views_generator_spec.rb

@@ -0,0 +1,204 @@
+require 'rails_helper'
+require 'generators/csv_import_magic/views_generator'
+
+RSpec.describe CsvImportMagic::Generators::ViewsGenerator, type: :generator do
+  destination File.expand_path('../../../../../tmp', __FILE__)
+  arguments ['foo']
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  after { prepare_destination }
+
+  specify 'check structure of show view' do
+    show_content = <<-EOF
+<h2 class='page-title'>
+  <%= t('csv_import_magic.views.importers.show.title', model_translated: t("activemodel.models.#\{@importer.source\}.other")) %>
+</h2>
+
+<form style='text-align: center'>
+  <div class='form-row' id="<%= @importer.status %>">
+    <% if @importer.status == 'pending' %>
+      <%= t('csv_import_magic.views.importers.show.waiting') %>
+    <% else %>
+      <%= @importer.message %>
+    <% end %>
+  </div>
+
+  <% if @importer.status == 'pending' %>
+    <span class='loading'></span>
+  <% end %>
+
+  <% if @importer.attachment_error.present? %>
+    <%= link_to t('csv_import_magic.views.importers.show.buttons.error_file'), @importer.attachment_error.url, class: 'button button--secondary' %>
+  <% end %>
+
+  <%= link_to t('csv_import_magic.views.importers.show.buttons.back'), '/', class: 'button button--primary' %>
+</form>
+
+<script>
+  if (document.getElementById('pending') != void 0) {
+    setInterval(function(){
+      location.reload();
+    }, 5000);
+  }
+</script>
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'views' do
+          directory 'csv_import_magic' do
+            directory 'importers' do
+              file 'show.html.erb' do
+                contains show_content
+              end
+            end
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of edit view' do
+    edit_content = <<-EOF
+<% columns = @importer.importable_columns(@importer.parser).map { |column| [@importer.source_klass.human_attribute_name(column), column] }.unshift([t('csv_import_magic.views.importers.edit.ignore_column_label'), :ignore]) %>
+
+<h3 class='page-title'>
+  <%= t('csv_import_magic.views.importers.edit.title') %>
+  </br>
+  <small><%= t('csv_import_magic.views.importers.edit.description') %></small>
+</h3>
+
+<%= simple_form_for @importer, url: importer_path(@importer) do |f| %>
+  <div class="row csv_import">
+    <% import_file_csv.headers.each_with_index do |header, i| %>
+    <div class="column">
+      <div class="portlet light bordered">
+        <div class="portlet-body form">
+          <header>
+            <%= t('csv_import_magic.views.importers.edit.column') %> <b><%= header %></b>
+          </header>
+
+          <% selected = columns.find { |c| c.join(' ').match(/#\{header\}/i) }.try(:last).presence || :ignore %>
+          <%= f.input "columns][", as: :select, collection: columns, label: false, hint: t('csv_import_magic.views.importers.edit.hint'), include_blank: false, selected: f.object.columns[i] || selected %>
+
+          <header class="examples"><%= t('csv_import_magic.views.importers.edit.example_of_values') %></header>
+          <table>
+            <tbody>
+              <% import_file_csv.first(5).each_with_index do |row, c| %>
+                <tr>
+                  <td class="number"><%= c + 1 %></td>
+                  <td><%= row[header] || t('csv_import_magic.views.importers.edit.empty_values') %></td>
+                </tr>
+              <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </div>
+    <% end %>
+  </div>
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'views' do
+          directory 'csv_import_magic' do
+            directory 'importers' do
+              file 'edit.html.erb' do
+                contains edit_content
+              end
+            end
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of layout view' do
+    layout_content = <<-EOF
+<!DOCTYPE html>
+<html lang="pt">
+  <head>
+    <meta charset="utf-8">
+    <title>Title</title>
+
+    <link href="/favicon.ico" rel="shortcut icon">
+
+    <%= stylesheet_link_tag "application", :media => "all" %>
+    <%= csrf_meta_tags %>
+  </head>
+
+  <body class="csv_import_magic">
+    <%- if flash %>
+      <% flash.each do |key, value| %>
+        <div class="flash-message <%= key %>"><%= value %></div>
+      <% end %>
+    <% end %>
+
+    <div class="wrapper">
+      <main>
+        <div class="container">
+          <%= yield %>
+        </div>
+      </main>
+    </div>
+
+    <%= javascript_include_tag "application" %>
+    <%= yield :javascript %>
+  </body>
+</html>
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'views' do
+          directory 'layouts' do
+            file 'csv_import_magic.html.erb' do
+              contains layout_content
+            end
+          end
+        end
+      end
+    }
+  end
+
+  specify 'check structure of partial view' do
+    partial_view_content = <<-EOF
+<h1 class="page-title">
+  <%= t('csv_import_magic.views.importers.new.title', model_translated: t('activemodel.models.foo.other')) %>
+  <br/>
+  <small><%= t('csv_import_magic.views.importers.new.description', model_translated: t('activemodel.models.foo.other').downcase) %></small>
+</h1>
+
+<%= simple_form_for(Importer.new, url: csv_import_magic.importers_path) do |f| %>
+  <%= f.input :importable_type, as: :hidden, input_html: { value: '<change this value>' } %>
+  <%= f.input :importable_id, as: :hidden, input_html: { value: '<change this value>' } %>
+  <%= f.input :source, as: :hidden, input_html: { value: 'foo' } %>
+
+  <div class="form-row">
+    <%= f.input :attachment, as: :file, hint: t('csv_import_magic.views.importers.new.hint').html_safe, required: true %>
+  </div>
+
+  <div class='form-row actions'>
+    <%= f.submit t('csv_import_magic.views.importers.new.buttons.import'), class: 'button button--primary' %>
+  </div>
+<% end %>
+    EOF
+
+    expect(destination_root).to have_structure {
+      directory 'app' do
+        directory 'views' do
+          directory 'foos' do
+            file '_csv_importer.html.erb' do
+              contains partial_view_content
+            end
+          end
+        end
+      end
+    }
+  end
+end

data/spec/models/importer_spec.rb

@@ -0,0 +1,82 @@
+require 'rails_helper'
+
+RSpec.describe Importer, type: :model do
+  describe 'validations' do
+    subject { build(:importer, parser: 'company_parser') }
+
+    it { is_expected.to validate_presence_of(:source) }
+    it { is_expected.to validate_inclusion_of(:status).in_array(%w(pending success error)) }
+    it { is_expected.to have_attached_file(:attachment) }
+    it { is_expected.to validate_attachment_presence(:attachment) }
+    it do
+      is_expected.to validate_attachment_content_type(:attachment)
+        .allowing('text/plain', 'text/csv', 'application/vnd.ms-excel')
+        .rejecting('image/png', 'image/gif', 'text/xml')
+    end
+
+    it { is_expected.to have_attached_file(:attachment_error) }
+    it do
+      is_expected.to validate_attachment_content_type(:attachment_error)
+        .allowing('text/plain', 'text/csv', 'application/vnd.ms-excel')
+        .rejecting('image/png', 'image/gif', 'text/xml')
+    end
+
+    context '#uniqueness_columns' do
+      it 'not accept the same column name unless is ignore' do
+        expect(build(:importer, columns: %w(name number city state))).to be_valid
+        expect(build(:importer, columns: %w(name number city state state))).to be_invalid
+      end
+    end
+
+    context '#required_columns' do
+      it 'not accept no select columns are required' do
+        importer = create(:importer, columns: [])
+
+        importer.columns = %w(name number city state)
+        expect(importer).to be_valid
+
+        importer.columns = %w(name number city ignore)
+        expect(importer).to be_invalid
+      end
+    end
+  end
+
+  describe 'associations' do
+    it { is_expected.to belong_to(:importable) }
+  end
+
+  describe 'callbacks' do
+    context '.before_validation #set_parser' do
+      let(:importer) { build(:importer, parser: nil) }
+
+      it 'set default parser when nil' do
+        expect do
+          importer.save
+          importer.reload
+        end.to change(importer, :parser).from(nil).to('company_parser')
+      end
+
+      it 'not change when parser is present' do
+        class Foo
+        end
+
+        expect do
+          importer.parser = 'foo_parser'
+          importer.save
+          importer.reload
+        end.to change(importer, :parser).to('foo_parser')
+      end
+    end
+  end
+
+  context '#source_klass' do
+    let(:importer) { create(:importer, source: 'company') }
+
+    it { expect(importer.source_klass).to eq(Company) }
+  end
+
+  context '#importable_columns' do
+    let(:importer) { create(:importer, source: 'company') }
+    it { expect(importer.importable_columns).to match_array([:name, :street, :number, :neighborhood, :city, :state, :country]) }
+  end
+end