datashift 0.16.0 → 0.40.0

data/spec/exporters/excel_exporter_spec.rb

@@ -0,0 +1,193 @@
+# Copyright:: (c) Autotelik Media Ltd 2015
+# Author ::   Tom Statter
+# License::   MIT
+#
+# Details::   Specs for Excel aspect of Active Record Loader
+#
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'erb'
+require 'excel_exporter'
+
+module  DataShift
+
+  describe 'Excel Exporter' do
+    include_context 'ClearThenManageProject'
+
+    before(:all) do
+      results_clear( '*.xls' )
+    end
+
+    before(:each) do
+      DataShift::Exporters::Configuration.reset
+
+      DataShift::Configuration.reset
+    end
+
+    let(:exporter) { ExcelExporter.new }
+
+    it 'should be able to create a new excel exporter' do
+      expect(exporter).to_not be_nil
+    end
+
+    it 'should handle bad params to export' do
+      expect = result_file('project_first_export_spec.csv')
+
+      expect { exporter.export(expect, nil) }.not_to raise_error
+
+      expect { exporter.export(expect, []) }.not_to raise_error
+
+      puts "Can manually check file @ #{expect}"
+    end
+
+    context 'export model only' do
+      let(:expected_projects)   { 7 }
+
+      before(:each) do
+        create_list(:project, expected_projects)
+      end
+
+      it 'should export model object to .xls file' do
+        expected = result_file('exp_project_first_export.xls')
+
+        exporter.export(expected, Project.all.first)
+
+        expect(File.exist?(expected)).to eq true
+      end
+
+      it 'should export model attributes as headers' do
+        expected = result_file('exp_project_export.xls')
+
+        exporter.export(expected, Project.all)
+
+        excel = Excel.new
+        excel.open(expected)
+
+        expect(excel.row(0)).to match Project.columns.collect(&:name)
+      end
+
+      it 'should export collection of model objects to .xls file' do
+        expected = result_file('exp_project_export.xls')
+
+        exporter.export(expected, Project.all)
+
+        excel = Excel.new
+        excel.open(expected)
+
+        expect(excel.num_rows).to eq expected_projects + 1
+      end
+    end
+
+    context 'project with associations' do
+      let(:expected_projects) { 7 }
+
+      before(:each) do
+
+        create( :project_with_milestones, milestones_count: 4 )
+
+        create_list(:project, expected_projects)
+
+        create( :project_with_user )
+
+        DataShift::Configuration.configure do |config|
+          config.with = :all
+        end
+      end
+
+      it 'should include associations in headers', duff: true do
+        expected = result_file('exp_project_assoc_headers.xls')
+
+        exporter.export_with_associations(expected, Project, Project.all)
+
+        expect(File.exist?(expected)).to eq true
+
+        excel = Excel.new
+        excel.open(expected)
+
+        expect(excel.row(0)).to include 'owner'
+        expect(excel.row(0)).to include 'user'
+      end
+
+      it 'should export a model and associations to .xls file' do
+        expected = result_file('exp_project_plus_assoc.xls')
+
+        exporter.export_with_associations(expected, Project, Project.all)
+
+        expect(File.exist?(expected)).to eq true
+
+        excel = Excel.new
+        excel.open(expected)
+
+        expected_rows = Project.count + 1
+        last_idx = Project.count
+
+        expect(excel.num_rows).to eq expected_rows
+
+        user_inx = excel.row(0).index 'user'
+        owner_inx = excel.row(0).index 'owner'
+
+        expect(user_inx).to be > -1
+        expect(owner_inx).to be > -1
+
+        # not all rows have an Owner
+        expect( excel[3, owner_inx] ).to be_nil
+        expect( excel[3, user_inx] ).to include "title: mr,first_name: ben}"
+
+        # project_with_user has real associated user data
+        expect( excel[last_idx, user_inx] ).to include 'mr'
+
+        owner_idx = excel.row(0).index 'owner'
+
+        expect(owner_idx).to be > -1
+
+        expect( excel[last_idx, owner_idx] ).to include '10000.23'
+      end
+
+      it 'should export associations in hash format by default to .xls file' do
+
+        expected = result_file('project_and_assoc_in_hash_export.xls')
+
+        exporter.export_with_associations(expected, Project, Project.all)
+
+        expect(File.exist?(expected)).to eq true
+
+        excel = Excel.new
+        excel.open(expected)
+
+        milestone_inx = excel.row(0).index 'milestones'
+
+        # project_with_milestones has real associated user data
+        last_row_idx = Project.count
+
+        expect( excel[1, milestone_inx].to_s ).to include ColumnPacker.multi_assoc_delim
+        expect( excel[1, milestone_inx].to_s ).to include '{'
+        expect( excel[1, milestone_inx].to_s ).to match(/name: milestone/)
+        expect( excel[1, milestone_inx].to_s ).to match(/project_id: \d+/)
+      end
+
+      it 'should export a model and  assocs in json to .xls file' do
+
+        expected = result_file('project_and_assoc_in_json_export.xls')
+
+        DataShift::Exporters::Configuration.configure do |config|
+          config.json = true
+        end
+
+        exporter.export_with_associations(expected, Project, Project.all)
+
+        expect(File.exist?(expected)).to eq true
+
+        excel = Excel.new
+        excel.open(expected)
+
+        milestone_inx = excel.row(0).index 'milestones'
+
+        last_row_idx = Project.count
+
+        expect( excel[1, milestone_inx].to_s ).to include '['
+        expect( excel[1, milestone_inx].to_s ).to match(/name\":\"milestone/)
+        expect( excel[1, milestone_inx].to_s ).to match(/"project_id":\d+/)
+      end
+    end
+  end
+end

data/spec/exporters/excel_generator_spec.rb

@@ -0,0 +1,181 @@
+# Copyright:: (c) Autotelik Media Ltd 2015
+# Author ::   Tom Statter
+# License::   MIT
+#
+# Details::   Specs for Excel aspect of Active Record Loader
+#
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'erb'
+require 'excel_generator'
+
+module DataShift
+
+  describe 'Excel Generator' do
+    include_context 'ClearThenManageProject'
+
+    before(:all) do
+      results_clear( '*_template.xls' )
+    end
+
+    before(:each) do
+      DataShift::Exporters::Configuration.reset
+    end
+
+    let(:generator) { ExcelGenerator.new }
+
+    it 'should be able to create a new excel generator' do
+      expect(generator).to_not be_nil
+    end
+
+    it 'should generate template .xls file from model' do
+      expected = result_file('gen_project_template.xls')
+
+      generator.generate(expected, Project)
+
+      expect(File.exist?(expected)).to eq true
+
+      puts "Can manually check file @ #{expected}"
+
+      excel = Excel.new
+      excel.open(expected)
+
+      expect(excel.worksheets.size).to eq 1
+
+      expect(excel.worksheet(0).name).to eq 'Project'
+
+      headers = excel.worksheets[0].row(0)
+
+      expect(headers).to include(*Project.columns.collect(&:name))
+
+    end
+
+    # has_one  :owner
+    # has_many :milestones
+    # has_many :loader_releases
+    # has_many :versions, :through => :loader_releases
+    # has_and_belongs_to_many :categories
+
+    it 'should include all associations in template .xls file from model', duff: true do
+      expected = result_file('gen_project_plus_assoc_template.xls')
+
+      generator.generate_with_associations(expected, Project)
+
+      expect( File.exist?(expected)).to eq true
+
+      excel = Excel.new
+      excel.open(expected)
+
+      expect(excel.worksheets.size).to eq 1
+
+      expect(excel.worksheet(0).name).to eq 'Project'
+
+      headers = excel.worksheets[0].row(0).to_a
+
+      expect(headers).to include(*Project.columns.collect(&:name))
+
+      %w(owner milestones loader_releases versions categories).each do |check|
+        expect(headers.include?(check)).to eq true
+      end
+    end
+
+    it 'should enable us to exclude associations by type in template .xls file' do
+      expected = result_file('gen_project_plus_some_assoc_template.xls')
+
+      DataShift::Configuration.configure do |config|
+        config.exclude = :has_many
+      end
+
+      generator.generate_with_associations(expected, Project)
+
+      expect(File.exist?(expected)).to eq true # , "Failed to find expected result file #{expected}"
+
+      excel = Excel.new
+      excel.open(expected)
+
+      expect(excel.worksheets.size).to eq 1
+
+      expect( excel.worksheet(0).name).to eq 'Project'
+
+      headers = excel.worksheets[0].row(0)
+
+
+      expect(headers).to include(*Project.columns.collect(&:name))
+
+      expect(headers.include?('title')).to eq  true
+      expect(headers.include?('owner')).to eq  true
+
+      %w(milestones loader_releases versions categories).each do |check|
+        expect(headers).to_not include check
+      end
+    end
+
+    it 'should enable us to exclude certain associations in template .xls file ', duff: true do
+      expected = result_file('gen_project_plus_some_assoc_template.xls')
+
+      DataShift::Configuration.call.remove_columns = [:milestones, :versions]
+
+      generator.generate_with_associations(expected, Project)
+
+      expect(File.exist?(expected)).to eq true # , "Failed to find expected result file #{expected}"
+
+      excel = Excel.new
+      excel.open(expected)
+
+      expect(excel.worksheets.size).to eq 1
+
+      expect(excel.worksheet(0).name).to eq 'Project'
+
+      headers = excel.worksheets[0].row(0)
+
+      %w(title loader_releases owner categories).each do |check|
+        expect(headers).to include check
+      end
+
+      %w(milestones versions).each do |check|
+        expect(headers).to_not include check
+      end
+    end
+
+    it 'should enable us to remove standard rails feilds from template .xls file ' do
+      expected = result_file('gen_project_plus_some_assoc_template.xls')
+
+      DataShift::Configuration.call.remove_rails = true
+
+      generator.generate_with_associations(expected, Project)
+
+      expect(File.exist?(expected)).to eq true # , "Failed to find expected result file #{expected}"
+
+      excel = Excel.new
+      excel.open(expected)
+
+      expect(excel.worksheets.size).to eq 1
+
+      expect(excel.worksheet(0).name).to eq 'Project'
+
+      headers = excel.worksheets[0].row(0)
+
+      %w(id updated_at created_at).each do |check|
+        expect(headers).to_not include check
+      end
+    end
+
+    it 'should enable us to autosize columns in the .xls file' do
+      expected = result_file('gen_project_autosized_template.xls')
+
+      pending "Auto sizing of Excel columns"
+
+      DataShift::Exporters::Configuration.configure do |config|
+        config.autosize = true
+      end
+
+      generator.generate_with_associations(expected, Project)
+
+      expect( File.exist?(expected)).to eq true
+
+      excel = Excel.new
+      excel.open(expected)
+    end
+  end
+
+end

data/spec/exporters/generator_base_spec.rb

@@ -0,0 +1,45 @@
+# Copyright:: (c) Autotelik Media Ltd 2015
+# Author ::   Tom Statter
+# License::   MIT
+#
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module DataShift
+
+  describe 'Generator Base' do
+
+    before(:each) do
+      DataShift::Exporters::Configuration.reset
+    end
+
+    it 'should initialize' do
+      expect(GeneratorBase.new).to be
+    end
+=begin Headers moved into Schema
+    context 'generation' do
+      include_context 'ClearThenManageProject'
+
+      let(:gb) { x = GeneratorBase.new; Headers.klass_to_headers(Project); x }
+
+      it 'should create an instance of Headers from a Domain Model' do
+        expect(gb.headers).to be_a Headers
+        expect(gb.headers[0]).to be_a Header
+      end
+
+      it 'sets the source of the Headers to the Domain Model' do
+        expect(gb.headers.source).to eq Project
+      end
+
+      it 'should create one header per Domain Model attribute' do
+        expect(gb.headers.size).to eq Project.new.serializable_hash.keys.size
+      end
+
+      it 'headers are the model method operator name' do
+        expect(gb.headers[0]).to be_a Header
+        expect(gb.headers[0].source).to be_a String
+      end
+
+    end
+=end
+  end
+end

data/spec/factories/categories.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+
+  factory :category do
+    sequence(:reference) { |n| "category_00#{n}" }
+  end
+
+end

data/spec/factories/factories.rb

@@ -0,0 +1,18 @@
+FactoryGirl.define do
+
+  factory :user do
+    title 'mr'
+    first_name 'ben'
+  end
+
+  factory :owner do
+    name 'i am the owner'
+    budget 10000.23
+  end
+
+
+  factory :loader_release do
+    sequence(:name) { |n| "Loader Release V#{n}" }
+  end
+
+end

data/spec/factories/milestone.rb

@@ -0,0 +1,16 @@
+FactoryGirl.define do
+
+  factory :milestone do
+    sequence(:name) { |n| "milestone #{n}" }
+    cost 100
+    datetime Time.new
+
+    association :project, factory: :project
+
+    factory :milestone_with_project do
+      project
+    end
+
+  end
+
+end