importu 0.1.0 → 0.2.0

data/spec/support/book_importer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require "importu/importer"
+
+module BookImporterDefinition
+  def self.included(base)
+    base.class_eval do
+      allow_actions :create, :update
+
+      find_by :isbn10
+
+      fields :title, :isbn10, :pages, :release_date, :authors
+
+      field :pages, required: false, &convert_to(:integer)
+      field :release_date, &convert_to(:date)
+
+      field :authors, label: "author" do
+        authors = trimmed(:authors).to_s.split(/(?:, )|(?: and )|(?: & )/i)
+        raise ArgumentError, "at least one author is required" if authors.none?
+        authors
+      end
+
+      field :by_matz, abstract: true do
+        field_value(:authors).include?("Yukihiro Matsumoto")
+      end
+    end
+  end
+end
+
+class BookImporter < Importu::Importer
+  include BookImporterDefinition
+end

data/spec/support/dummy_backend.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require "importu/backends"
+
+class DummyBackend
+  def self.supported_by_definition?(_definition)
+    false
+  end
+
+  def initialize(finder_fields:, **)
+    @finder_fields = finder_fields
+    @objects = []
+    @max_id = 0
+  end
+
+  def find(record)
+    @finder_fields.detect do |field_group|
+      if field_group.respond_to?(:call) # proc
+        raise "proc-based finder scopes not supported for dummy backend"
+      else
+        values = record.values_at(*Array(field_group))
+        object = @objects.detect {|o| values == o.values_at(*Array(field_group)) }
+        break object if object
+      end
+    end
+  end
+
+  def unique_id(object)
+    object[:id]
+  end
+
+  def create(record)
+    object = { id: @max_id += 1 }.merge(record.to_hash)
+    @objects << object
+    [:created, object]
+  end
+
+  def update(record, object)
+    new_object = object.merge(record.to_hash)
+
+    if new_object == object
+      [:unchanged, new_object]
+    else
+      @objects[object[:id] - 1] = new_object
+      [:updated, new_object]
+    end
+  end
+
+end
+
+Importu::Backends.registry.register(:dummy, DummyBackend)

data/spec/support/fixtures_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module FixturesHelper
+  def infile(name, ext)
+    File.join(fixtures_path, name, "infile.#{ext}")
+  end
+
+  def expected_model_json(name)
+    load_fixture_json(name, "model.json")
+  end
+
+  def expected_record_json(name)
+    load_fixture_json(name, "record.json")
+  end
+
+  def expected_record_json!(name, records)
+    # Dump and re-parse to ensure everything is JSON types w/ string keys
+    record_json = JSON.parse(JSON.dump(records.map(&:to_hash)))
+    expect(record_json).to eq expected_record_json(name)
+  end
+
+  def expected_summary_json(name)
+    load_fixture_json(name, "summary.json")
+  end
+
+  def expected_summary_json!(name, summary)
+    summary_json = JSON.parse(JSON.dump(summary.to_hash))
+    expect(summary_json).to eq expected_summary_json(name)
+  end
+
+  def fixtures_path
+    File.expand_path("../fixtures", __dir__)
+  end
+
+  private def load_fixture_json(*path_parts)
+    @fixture_json_cache ||= Hash.new do |_hash, _name|
+      data = File.read(File.join(fixtures_path, *path_parts))
+      JSON.parse(data)
+    end
+
+    @fixture_json_cache[path_parts]
+  end
+
+end

data/spec/support/matchers/delegate_matcher.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # https://gist.github.com/807456
 
 # RSpec matcher to spec delegations.
@@ -12,28 +13,33 @@
 
 RSpec::Matchers.define :delegate do |method|
   match do |delegator|
+    # Ensure instance vars are defined to suppress warnings about accessing
+    # undefined instance variables later on; values get set in matcher chains.
+    @prefix = false unless instance_variable_defined?(:@prefix)
+    @to = nil unless instance_variable_defined?(:@to)
+
     @method = @prefix ? :"#{@to}_#{method}" : method
     @delegator = delegator
     begin
       @delegator.send(@to)
     rescue NoMethodError
-      raise "#{@delegator} does not respond to #{@to}!" 
+      raise "#{@delegator} does not respond to #{@to}!"
     end
-    @delegator.stub(@to).and_return double('receiver')
-    @delegator.send(@to).stub(method).and_return :called
+    allow(@delegator).to receive(@to).and_return double("receiver")
+    allow(@delegator.send(@to)).to receive(method).and_return :called
     @delegator.send(@method) == :called
   end
 
   description do
-    "delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
+    "delegate :#{@method} to its #{@to}#{@prefix ? " with prefix" : ""}"
   end
 
-  failure_message_for_should do |text|
-    "expected #{@delegator} to delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
+  failure_message do |_text|
+    "expected #{@delegator} to delegate :#{@method} to its #{@to}#{@prefix ? " with prefix" : ""}"
   end
 
-  failure_message_for_should_not do |text|
-    "expected #{@delegator} not to delegate :#{@method} to its #{@to}#{@prefix ? ' with prefix' : ''}"
+  failure_message_when_negated do |_text|
+    "expected #{@delegator} not to delegate :#{@method} to its #{@to}#{@prefix ? " with prefix" : ""}"
   end
 
   chain(:to) { |receiver| @to = receiver }

metadata

@@ -1,218 +1,291 @@
 --- !ruby/object:Gem::Specification
 name: importu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Hedlund
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: csv
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.18.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.18.4
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.70'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
-description: Importu is a framework for importing data
+        version: '0'
+description: Importu simplifies the process of defining and sharing contracts that
+  structured data must conform to in order to be importable into your application.
 email:
-- daniel@lincracy.com
+- daniel@digitree.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".editorconfig"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".yardstick.yml"
+- Appraisals
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE
 - README.md
+- Rakefile
+- UPGRADING.md
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_7_2.gemfile.lock
+- gemfiles/rails_8_0.gemfile
+- gemfiles/rails_8_0.gemfile.lock
+- gemfiles/rails_8_1.gemfile
+- gemfiles/rails_8_1.gemfile.lock
+- gemfiles/standalone.gemfile
+- gemfiles/standalone.gemfile.lock
 - importu.gemspec
 - lib/importu.rb
+- lib/importu/backends.rb
+- lib/importu/backends/active_record.rb
+- lib/importu/backends/middleware.rb
+- lib/importu/backends/middleware/duplicate_manager_proxy.rb
+- lib/importu/backends/middleware/enforce_allowed_actions.rb
+- lib/importu/config_dsl.rb
+- lib/importu/converter_context.rb
 - lib/importu/converters.rb
-- lib/importu/core_ext.rb
-- lib/importu/core_ext/array/deep_freeze.rb
-- lib/importu/core_ext/deep_freeze.rb
-- lib/importu/core_ext/hash/deep_freeze.rb
-- lib/importu/core_ext/object/deep_freeze.rb
-- lib/importu/dsl.rb
+- lib/importu/definition.rb
+- lib/importu/duplicate_manager.rb
 - lib/importu/exceptions.rb
 - lib/importu/importer.rb
-- lib/importu/importer/csv.rb
-- lib/importu/importer/json.rb
-- lib/importu/importer/xml.rb
 - lib/importu/record.rb
+- lib/importu/sources.rb
+- lib/importu/sources/csv.rb
+- lib/importu/sources/json.rb
+- lib/importu/sources/ruby.rb
+- lib/importu/sources/xml.rb
+- lib/importu/summary.rb
 - lib/importu/version.rb
-- spec/factories/importer.rb
-- spec/factories/importer_record.rb
-- spec/factories/json_importer.rb
-- spec/factories/xml_importer.rb
+- spec/fixtures/books-duplicates/README.md
+- spec/fixtures/books-duplicates/infile.csv
+- spec/fixtures/books-duplicates/model.json
+- spec/fixtures/books-duplicates/summary.json
+- spec/fixtures/books-valid/README.md
+- spec/fixtures/books-valid/infile.csv
+- spec/fixtures/books-valid/infile.json
+- spec/fixtures/books-valid/infile.xml
+- spec/fixtures/books-valid/model.json
+- spec/fixtures/books-valid/record.json
+- spec/fixtures/books-valid/summary.json
+- spec/fixtures/source-empty-file/infile.csv
+- spec/fixtures/source-empty-file/infile.json
+- spec/fixtures/source-empty-file/infile.xml
+- spec/fixtures/source-empty-records/infile.csv
+- spec/fixtures/source-empty-records/infile.json
+- spec/fixtures/source-empty-records/infile.xml
+- spec/fixtures/source-malformed/infile.csv
+- spec/fixtures/source-malformed/infile.json
+- spec/fixtures/source-malformed/infile.xml
+- spec/fixtures/source-no-records/infile.csv
+- spec/fixtures/source-no-records/infile.json
+- spec/fixtures/source-no-records/infile.xml
+- spec/lib/importu/backends/active_record_spec.rb
+- spec/lib/importu/backends/middleware/duplicate_manager_proxy_spec.rb
+- spec/lib/importu/backends/middleware/enforce_allowed_actions_spec.rb
+- spec/lib/importu/backends_spec.rb
 - spec/lib/importu/converters_spec.rb
-- spec/lib/importu/dsl_spec.rb
+- spec/lib/importu/definition_spec.rb
+- spec/lib/importu/duplicate_manager_spec.rb
 - spec/lib/importu/exceptions_spec.rb
-- spec/lib/importu/importer/json_spec.rb
-- spec/lib/importu/importer/xml_spec.rb
+- spec/lib/importu/import_context_spec.rb
+- spec/lib/importu/importer_spec.rb
+- spec/lib/importu/integration_spec.rb
 - spec/lib/importu/record_spec.rb
+- spec/lib/importu/sources/csv_spec.rb
+- spec/lib/importu/sources/importer_source_examples.rb
+- spec/lib/importu/sources/json_spec.rb
+- spec/lib/importu/sources/ruby_spec.rb
+- spec/lib/importu/sources/xml_spec.rb
+- spec/lib/importu/summary_spec.rb
 - spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/support/book_importer.rb
+- spec/support/dummy_backend.rb
+- spec/support/fixtures_helper.rb
 - spec/support/matchers/delegate_matcher.rb
-homepage: https://github.com/lincracy/importu
+homepage: https://github.com/dhedlund/importu
 licenses:
 - MIT
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/dhedlund/importu
+  source_code_uri: https://github.com/dhedlund/importu
+  changelog_uri: https://github.com/dhedlund/importu/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/dhedlund/importu/issues
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
-summary: A framework for importing data
-test_files:
-- spec/factories/importer.rb
-- spec/factories/importer_record.rb
-- spec/factories/json_importer.rb
-- spec/factories/xml_importer.rb
-- spec/lib/importu/converters_spec.rb
-- spec/lib/importu/dsl_spec.rb
-- spec/lib/importu/exceptions_spec.rb
-- spec/lib/importu/importer/json_spec.rb
-- spec/lib/importu/importer/xml_spec.rb
-- spec/lib/importu/record_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/delegate_matcher.rb
-has_rdoc: 
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Because an import should be defined by a contract, not a sequence of commands
+test_files: []

data/lib/importu/core_ext/array/deep_freeze.rb

@@ -1,7 +0,0 @@
-class Array
-  def deep_freeze
-    return self if frozen?
-    each(&:deep_freeze)
-    freeze
-  end
-end

data/lib/importu/core_ext/deep_freeze.rb

@@ -1,3 +0,0 @@
-require 'importu/core_ext/object/deep_freeze'
-require 'importu/core_ext/array/deep_freeze'
-require 'importu/core_ext/hash/deep_freeze'

data/lib/importu/core_ext/hash/deep_freeze.rb

@@ -1,7 +0,0 @@
-class Hash
-  def deep_freeze
-    return self if frozen?
-    values.each(&:deep_freeze)
-    freeze
-  end
-end

data/lib/importu/core_ext/object/deep_freeze.rb

@@ -1,6 +0,0 @@
-class Object
-  def deep_freeze
-    instance_variables.each{|v| instance_variable_get(v).freeze }
-    freeze
-  end
-end

data/lib/importu/core_ext.rb

@@ -1,3 +0,0 @@
-Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].sort.each do |path|
-  require "importu/core_ext/#{File.basename(path, '.rb')}"
-end