plumber 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea/

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in plumber.gemspec
+gemspec
+
+group :development do
+  gem "rake"
+end

data/README.markdown

@@ -0,0 +1,3 @@
+# Plumber
+
+A library for connecting external data sources to local ActiveRecord models.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/plumber.rb

@@ -0,0 +1,49 @@
+require "plumber/version"
+require "plumber/context"
+
+require "active_record"
+
+# Provides functionality for creating and updating ActiveRecord model objects. Requires Rails 3+.
+class Plumber
+  # Create a new instance which will act on the given model and log to the given logger.
+  def initialize(model, logger)
+    @model = model
+    @logger = logger
+  end
+
+  def import
+    context = Plumber::Context.new(@model.scoped)
+
+    yield context
+
+    operation = if context.record.new_record?
+                  "Create"
+                else
+                  "Update"
+                end
+
+    changed = context.record.changed
+
+    begin
+      ActiveRecord::Base.transaction do
+        if context.record.save!
+          if changed
+            @logger.info("#{operation} #{context.record.class} #{context.record.id}.")
+          else
+            @logger.debug("#{context.record.class} #{context.record.id} not changed.")
+          end
+        end
+      end
+    rescue ActiveRecord::RecordInvalid => e
+      prefix = "#{e.record.class} #{e.record.id}".strip
+
+      @logger.warn("#{prefix}: #{operation} failed - #{e.record.errors.size} validation errors.")
+
+      context.record.errors.full_messages.each do |message|
+        @logger.warn("#{prefix}: #{message}")
+      end
+    end
+
+    context.record
+  end
+end

data/lib/plumber/context.rb

@@ -0,0 +1,75 @@
+class Plumber
+  class Context
+    MAX_ASSOCIATION_COUNT = 50
+
+    attr_reader :scope, :conditions, :mapping, :associations
+
+    def initialize(scope, parent = nil)
+      @scope = scope
+      @parent = parent
+      @conditions = {}
+      @mapping = {}
+      @associations = []
+    end
+
+    def conditions(hash)
+      @conditions = hash
+    end
+
+    def mapping(hash)
+      @mapping = hash
+    end
+
+    def association(name)
+      scope = record.send(name)
+      context = self.class.new(scope, self)
+
+      yield context
+
+      @associations << context
+
+      # Return the record defined in the yielded context:
+      context.record
+    end
+
+    def record
+      if @record.nil?
+        @record = if @parent.nil?
+                    # If this is a top-level context, use a database query to look up an
+                    # existing record that matches the conditions supplied.
+                    @scope.where(@conditions).first
+                  else
+                    # Because ActiveRecord (currently) doesn't have an "Identity Map" feature,
+                    # unfortunately for associated records we can't run a DB query to find
+                    # existing records.
+                    #
+                    # Instead we load all records in the scope and search for one matching
+                    # the conditions supplied. This is why we check the scope size and raise
+                    # an exception if it's too large - for situations where there are
+                    # potentially large numbers of associated records, a separate Importer
+                    # instance should be defined for handling those records.
+                    if @scope.count > MAX_ASSOCIATION_COUNT
+                      message = "%s scope contains too many records (%s)" % [
+                          @scope.new.class, @scope.count
+                      ]
+
+                      raise RuntimeError, message
+                    end
+
+                    @scope.detect do |record|
+                      @conditions.all? { |k, v| record.send(k) == v }
+                    end
+                  end
+
+        # If an existing record hasn't been found in the scope, build a new one:
+        @record ||= @scope.build
+
+        @conditions.merge(@mapping).each do |key, value|
+          @record.send("#{key}=", value)
+        end
+      end
+
+      @record
+    end
+  end
+end

data/lib/plumber/version.rb

@@ -0,0 +1,3 @@
+class Plumber
+  VERSION = "0.0.1"
+end

data/plumber.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "plumber/version"
+
+Gem::Specification.new do |s|
+  s.name        = "plumber"
+  s.version     = Plumber::VERSION
+  s.authors     = ["Nick Dainty"]
+  s.email       = ["nick@npad.co.uk"]
+  s.homepage    = "https://github.com/nickpad/plumber"
+  s.summary     = %q{Connect anything to an ActiveRecord model}
+  s.description = %q{Plumber is a library for creating and updating ActiveRecord models from external data}
+
+  s.rubyforge_project = "plumber"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "activerecord", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: plumber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Dainty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70177976806580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70177976806580
+description: Plumber is a library for creating and updating ActiveRecord models from
+  external data
+email:
+- nick@npad.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/plumber.rb
+- lib/plumber/context.rb
+- lib/plumber/version.rb
+- plumber.gemspec
+homepage: https://github.com/nickpad/plumber
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: plumber
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Connect anything to an ActiveRecord model
+test_files: []