topographer 0.0.1

data/spec/Cartographer/importer/strategy/base_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Importer::Strategy::Base do
+  let(:mapper) do
+    double('Mapper')
+  end
+  let(:strategy) { Importer::Strategy::Base.new(mapper) }
+  let(:status) do
+    double 'Status',
+           errors?: false
+  end
+  let(:bad_status) do
+    double 'Status',
+           errors?: true
+  end
+  describe '#initialize' do
+    it 'creates a new Strategy instance with the given mapper' do
+      strategy = Importer::Strategy::Base.new(mapper)
+      strategy.instance_variable_get(:@mapper).should be(mapper)
+    end
+  end
+  describe '#import_record' do
+    it 'should raise NotImplementedError' do
+      expect { strategy.import_record(nil) }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#should_persist_import?' do
+    it 'returns true if the status has no errors and the import is not a dry run' do
+      expect(strategy.should_persist_import?(status)).to be_true
+    end
+    it 'returns false if the status has errors regardless of whether the import is a dry run or not' do
+      expect(strategy.should_persist_import?(bad_status)).to be_false
+      strategy.dry_run = true
+      expect(strategy.should_persist_import?(bad_status)).to be_false
+    end
+    it 'returns false if the status has no errors and the import is a dry run' do
+      strategy.dry_run = true
+      expect(strategy.should_persist_import?(status)).to be_false
+    end
+  end
+
+end

data/spec/Cartographer/importer/strategy/create_or_update_record_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'ostruct'
+require_relative 'mapped_model'
+
+describe Importer::Strategy::CreateOrUpdateRecord do
+
+  let(:strategy) { Importer::Strategy::CreateOrUpdateRecord.new(MappedModel.get_mapper) }
+  let(:input) do
+    double 'Data',
+           source_identifier: 'record',
+           data: {'Field1' => 'datum1',
+                  'Field2' => 'datum2'}
+  end
+  let(:invalid_input) do
+    double 'Data',
+           source_identifier: 'bad record',
+           data: {'Field1' => 'datum1'}
+  end
+
+
+  describe '#import_record' do
+    it 'should return an ImportStatus object' do
+      expect(strategy.import_record(input)).to be_a Importer::Strategy::ImportStatus
+    end
+    it 'should import a record from valid input' do
+      MappedModel.any_instance.should_receive(:save).once
+      import_status = strategy.import_record(input)
+      expect(import_status.errors?).to be false
+    end
+    it 'should not import a record from invalid input' do
+
+      MappedModel.any_instance.should_not_receive(:save)
+      import_status = strategy.import_record(invalid_input)
+      expect(import_status.errors?).to be true
+      expect(import_status.errors[:mapping]).to include('Missing required input(s): `Field2` for `field_2`')
+      expect(import_status.errors[:validation]).to include('Field 2 is not datum2')
+    end
+    it 'should not save a record on a dry run' do
+      MappedModel.any_instance.should_not_receive(:save)
+      strategy.dry_run = true
+      import_status = strategy.import_record(input)
+      expect(import_status.errors?).to be false
+    end
+  end
+
+end

data/spec/Cartographer/importer/strategy/import_new_records_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'ostruct'
+require_relative 'mapped_model'
+
+describe Importer::Strategy::ImportNewRecord do
+  let(:valid_status) do
+    double 'Result',
+           source_identifier: 'row1',
+           data: {'field_1' => 'datum1', 'field_2' => 'datum2'},
+           errors?: false,
+           errors: {}
+  end
+  let(:invalid_result) do
+    double 'Result',
+           source_identifier: 'row1',
+           data: {'field_1' => 'dataum1'},
+           errors?: true,
+           errors: {'field_2' => 'Missing input(s): `Field2` for `field_2`'}
+
+  end
+  let(:mapper) do
+    double('Mapper', map_input: valid_status, model_class: MappedModel)
+  end
+
+  let(:strategy) { Importer::Strategy::ImportNewRecord.new(MappedModel.get_mapper) }
+  let(:input) do
+    double 'Data',
+           source_identifier: 'record',
+           data: {'Field1' => 'datum1',
+                  'Field2' => 'datum2'}
+  end
+
+  describe '#initialize' do
+    it 'creates a new Strategy instance with the given mapper' do
+      strategy = Importer::Strategy::ImportNewRecord.new(mapper)
+      strategy.instance_variable_get(:@mapper).should be(mapper)
+    end
+  end
+
+  describe '#import_record' do
+    it 'should return an ImportStatus object' do
+      expect(strategy.import_record(input)).to be_a Importer::Strategy::ImportStatus
+    end
+    it 'should import a record from valid input' do
+      MappedModel.any_instance.should_receive(:save).once
+      result = strategy.import_record(input)
+      expect(result.errors?).to be false
+    end
+    it 'should not import a record from invalid input' do
+      mapper.stub(:map_input).and_return(invalid_result)
+      strategy = Importer::Strategy::ImportNewRecord.new(mapper)
+      MappedModel.any_instance.should_not_receive(:save)
+      import_status = strategy.import_record(input)
+      expect(import_status.errors?).to be true
+      expect(import_status.errors[:mapping]).to include('Missing input(s): `Field2` for `field_2`')
+      expect(import_status.errors[:validation]).to include('Field 2 is not datum2')
+    end
+    it 'should not save a record on a dry run' do
+      MappedModel.any_instance.should_not_receive(:save)
+      strategy.dry_run = true
+      import_status = strategy.import_record(input)
+      expect(import_status.errors?).to be false
+    end
+  end
+
+end

data/spec/Cartographer/importer/strategy/import_status_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Importer::Strategy::ImportStatus do
+  let(:status) {Importer::Strategy::ImportStatus.new('row1')}
+  describe '#add_error' do
+    it 'should add errors' do
+      status.add_error(:validation, 'ERROR')
+      expect(status.error_count).to be 1
+    end
+  end
+  describe '#set_timestamp' do
+    it 'should set the timestamp the first time it is called' do
+      expect(status.timestamp).to be_nil
+      status.set_timestamp
+      expect(status.timestamp).to be_a DateTime
+    end
+    it 'should not change the timestamp after it has been called' do
+      status.set_timestamp
+      timestamp = status.timestamp
+      status.set_timestamp
+      expect(timestamp).to eql(status.timestamp)
+    end
+  end
+end

data/spec/Cartographer/importer/strategy/mapped_model.rb

@@ -0,0 +1,41 @@
+class MappedModel < OpenStruct
+  def self.create(params)
+    self.new(params)
+  end
+
+  def first
+    self
+  end
+
+  def valid?
+    self.errors = OpenStruct.new(full_messages: [])
+    if field_2 == 'datum2'
+      true
+    else
+      self.errors = OpenStruct.new(full_messages: ['Field 2 is not datum2'])
+      false
+    end
+  end
+
+  def save
+    true
+  end
+
+  def self.get_mapper
+    Importer::Mapper.build_mapper(MappedModel) do |mapping|
+      mapping.required_mapping 'Field1', 'field_1'
+      mapping.required_mapping 'Field2', 'field_2'
+      mapping.optional_mapping 'Field3', 'field_3'
+      mapping.key_field 'field_1'
+      mapping.key_field 'field_2'
+    end
+  end
+
+  def self.where(params)
+    return self.new(params)
+  end
+
+  def self.find_or_initialize_by(params)
+    return self.new(params)
+  end
+end

data/spec/Cartographer/importer/strategy/update_record_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'ostruct'
+require_relative 'mapped_model'
+
+describe Importer::Strategy::UpdateRecord do
+
+  let(:strategy) { Importer::Strategy::UpdateRecord.new(MappedModel.get_mapper) }
+  let(:input) do
+    double 'Data',
+           source_identifier: 'record',
+           data: {'Field1' => 'datum1',
+                  'Field2' => 'datum2'}
+  end
+  let(:invalid_input) do
+    double 'Data',
+           source_identifier: 'bad record',
+           data: {'Field1' => 'datum1'}
+  end
+
+  describe '#import_record' do
+    it 'should return an ImportStatus object' do
+      expect(strategy.import_record(input)).to be_a Importer::Strategy::ImportStatus
+    end
+    it 'should import a record from valid input' do
+      MappedModel.any_instance.should_receive(:save).once
+      result = strategy.import_record(input)
+      expect(result.errors?).to be false
+    end
+    it 'should not import a record from invalid input' do
+
+      MappedModel.any_instance.should_not_receive(:save)
+      import_status = strategy.import_record(invalid_input)
+      expect(import_status.errors?).to be true
+      expect(import_status.errors[:mapping]).to include('Missing required input(s): `Field2` for `field_2`')
+      expect(import_status.errors[:validation]).to include('Field 2 is not datum2')
+    end
+    it 'should not save a record on a dry run' do
+      MappedModel.any_instance.should_not_receive(:save)
+      strategy.dry_run = true
+      import_status = strategy.import_record(input)
+      expect(import_status.errors?).to be false
+    end
+  end
+
+end

data/spec/spec_helper.rb

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

data/topographer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Topographer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'topographer'
+  spec.version       = Topographer::VERSION
+  spec.authors       = ['Mike Simpson', 'Emerson Huitt']
+  spec.email         = ['mjs2600@gmail.com', 'ehuitt@gmail.com']
+  spec.description   = %q{Topographer enables importing of models from various input sources.}
+  spec.summary       = %q{Topographer allows the mapping of columnar input data to fields for active record models. This facilitates importing from a variety of sources.}
+  spec.homepage      = ""
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('activesupport', ['>= 3'])
+
+  spec.add_development_dependency('bundler', ['~> 1.3'])
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: topographer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Simpson
+- Emerson Huitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Topographer enables importing of models from various input sources.
+email:
+- mjs2600@gmail.com
+- ehuitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/Topographer/exceptions.rb
+- lib/Topographer/importer.rb
+- lib/Topographer/importer/helpers.rb
+- lib/Topographer/importer/helpers/write_log_to_csv.rb
+- lib/Topographer/importer/importable.rb
+- lib/Topographer/importer/input.rb
+- lib/Topographer/importer/input/base.rb
+- lib/Topographer/importer/input/roo.rb
+- lib/Topographer/importer/input/source_data.rb
+- lib/Topographer/importer/logger.rb
+- lib/Topographer/importer/logger/base.rb
+- lib/Topographer/importer/logger/fatal_error_entry.rb
+- lib/Topographer/importer/logger/file.rb
+- lib/Topographer/importer/logger/log_entry.rb
+- lib/Topographer/importer/logger/simple.rb
+- lib/Topographer/importer/mapper.rb
+- lib/Topographer/importer/mapper/default_field_mapping.rb
+- lib/Topographer/importer/mapper/field_mapping.rb
+- lib/Topographer/importer/mapper/ignored_field_mapping.rb
+- lib/Topographer/importer/mapper/result.rb
+- lib/Topographer/importer/mapper/validation_field_mapping.rb
+- lib/Topographer/importer/strategy.rb
+- lib/Topographer/importer/strategy/base.rb
+- lib/Topographer/importer/strategy/create_or_update_record.rb
+- lib/Topographer/importer/strategy/import_new_record.rb
+- lib/Topographer/importer/strategy/import_status.rb
+- lib/Topographer/importer/strategy/update_record.rb
+- lib/Topographer/version.rb
+- lib/topographer.rb
+- spec/Cartographer/importer/helpers/write_log_to_csv_spec.rb
+- spec/Cartographer/importer/helpers_spec.rb
+- spec/Cartographer/importer/importable_spec.rb
+- spec/Cartographer/importer/importer_spec.rb
+- spec/Cartographer/importer/logger/base_spec.rb
+- spec/Cartographer/importer/logger/fatal_error_entry_spec.rb
+- spec/Cartographer/importer/logger/simple_spec.rb
+- spec/Cartographer/importer/mapper/default_field_mapping_spec.rb
+- spec/Cartographer/importer/mapper/field_mapping_spec.rb
+- spec/Cartographer/importer/mapper/validation_field_mapping_spec.rb
+- spec/Cartographer/importer/mapper_spec.rb
+- spec/Cartographer/importer/strategy/base_spec.rb
+- spec/Cartographer/importer/strategy/create_or_update_record_spec.rb
+- spec/Cartographer/importer/strategy/import_new_records_spec.rb
+- spec/Cartographer/importer/strategy/import_status_spec.rb
+- spec/Cartographer/importer/strategy/mapped_model.rb
+- spec/Cartographer/importer/strategy/update_record_spec.rb
+- spec/spec_helper.rb
+- topographer.gemspec
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Topographer allows the mapping of columnar input data to fields for active
+  record models. This facilitates importing from a variety of sources.
+test_files:
+- spec/Cartographer/importer/helpers/write_log_to_csv_spec.rb
+- spec/Cartographer/importer/helpers_spec.rb
+- spec/Cartographer/importer/importable_spec.rb
+- spec/Cartographer/importer/importer_spec.rb
+- spec/Cartographer/importer/logger/base_spec.rb
+- spec/Cartographer/importer/logger/fatal_error_entry_spec.rb
+- spec/Cartographer/importer/logger/simple_spec.rb
+- spec/Cartographer/importer/mapper/default_field_mapping_spec.rb
+- spec/Cartographer/importer/mapper/field_mapping_spec.rb
+- spec/Cartographer/importer/mapper/validation_field_mapping_spec.rb
+- spec/Cartographer/importer/mapper_spec.rb
+- spec/Cartographer/importer/strategy/base_spec.rb
+- spec/Cartographer/importer/strategy/create_or_update_record_spec.rb
+- spec/Cartographer/importer/strategy/import_new_records_spec.rb
+- spec/Cartographer/importer/strategy/import_status_spec.rb
+- spec/Cartographer/importer/strategy/mapped_model.rb
+- spec/Cartographer/importer/strategy/update_record_spec.rb
+- spec/spec_helper.rb