DUI 0.9.0 → 1.0.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-head
+  - ree

data/DUI.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "minitest"
   s.add_runtime_dependency "hashie"
+  s.add_development_dependency "rake"
 end

data/README.md

@@ -0,0 +1,88 @@
+#DUI [![Build Status](https://secure.travis-ci.org/darrencauthon/DUI.png?branch=master)](http://travis-ci.org/darrencauthon/DUI)
+## Delete, Update, and Insert
+
+The purpose of this gem is to make it easy to compare two datasets to see what operations would be necessary to merge the new data into the old.
+
+Way back in my stored procedure days, we'd write this type of update by:
+
+1.) Deleting any current records that aren't in the new set,
+2.) Updating the current records with any matches in the new set, and
+3.) Inserting any new records into the current set.
+
+This gem helps to run this process by doing the comparison for you, giving you three sets of data that you can use to make the appropriate data changes.
+
+**Warning:** All of the work is done in memory, so I would not run it against millions of records.  But for small-to-medium sets of data, it might be of some help.
+
+### My inspiration? ###
+
+Two things:
+
+1.) I love that Ruby's syntax makes it easy to write code that executes a *process*, regardless of the objects being used (and without going crazy with things like generics). We'd used to write these DUI sprocs by hand, different for each table. I guess object-oriented languages have some benefits...
+
+2.) I've seen a number of imports that start with an call to **destroy_all**, so an import is essentially a DELETE EVERYTHING, THEN IMPORT EVERYTHING AS NEW process.  Yikes.  After having to fix a few issues where the system would fail *after* the data was deleted but *before* the import was finished, I had to take action.
+
+Simple Example:
+
+```ruby
+require 'DUI'
+require 'awesome_print'
+
+class Person
+  attr_accessor :name, :email
+  def initialize(hash = {})
+    hash.each_pair { |k,v| self.send((k.to_s+"=").to_sym, v)}
+  end
+end
+
+current_data = [Person.new(:email => 'john@galt.com', :name => "JG"),
+                Person.new(:email => 'howard@roark.com', :name => "H Roark"),
+                Person.new(:email => 'peter@keating.com', :name => "Peter Keating")]
+
+new_data = [{:email => "howard@roark.com", :name => "Howard Roark"},
+            {:email => "john@galt.com", :name => "John Galt"},
+            {:email => "hank@rearden.com", :name => "Hank Rearden"}]
+
+a_way_to_match_the_records = lambda {|current, new| current.email == new[:email]}
+
+# create a matcher, provide it with a way to compare the two records
+matcher = DUI::Matcher.new(&a_way_to_match_the_records)
+
+# get the results of the matches between the two sets
+results = matcher.get_results current_data, new_data
+
+# now we know which records to delete, update, or insert, so let's do it
+
+results.records_to_delete.each do |delete_me|
+  current_data.delete delete_me # bye peter!
+end
+
+results.records_to_update.each do |match|
+  match.current.name = match.new[:name] #fix those names!
+end
+
+results.records_to_insert.each do |add_me|
+  new_person = Person.new :email => add_me[:email], :name => add_me[:name]
+  current_data << new_person # hello hank!
+end
+
+ap current_data
+
+```
+Here's the final result:
+
+```ruby
+[
+    [0] #<Person:0x7ffae4937920
+        attr_accessor :email = "john@galt.com",
+        attr_accessor :name = "John Galt"
+    >,
+    [1] #<Person:0x7ffae49376c8
+        attr_accessor :email = "howard@roark.com",
+        attr_accessor :name = "Howard Roark"
+    >,
+    [2] #<Person:0x7ffae4966bf8
+        attr_accessor :email = "hank@rearden.com",
+        attr_accessor :name = "Hank Rearden"
+    >
+]
+```

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/DUI/*_spec.rb', 'test/DUI/test_*.rb']
+  t.verbose = true
+end

data/lib/DUI/matcher.rb

@@ -3,7 +3,7 @@ module DUI
   class Matcher
 
     def initialize(&compare_method)
-      @compare_method = compare_method || Proc.new {|c, n| c.id == n.id }
+      @compare_method = compare_method || Proc.new { |c, n| c.id == n.id }
     end
 
     def get_results(current_data, new_data)
@@ -28,8 +28,8 @@ module DUI
 
     def all_current_data_with_possible_matches_in_new_data(current_data, new_data)
       current_data.map do |c| 
-        an_object_with({:current => c}) do |result|
-          result.new = new_data.select {|n| @compare_method.call(c, n) }.first
+        an_object_with( {:current => c} ) do |result|
+          result.new = new_data.select { |n| @compare_method.call(c, n) }.first
           result.current_not_found_in_new = result.new.nil?
         end
       end
@@ -37,7 +37,7 @@ module DUI
 
     def get_records_to_insert(results, new_data)
       current_records = results.records_to_update.map{|u| u.current}
-      new_data.select {|n| current_records.select {|c| @compare_method.call(c, n) }.count == 0 }
+      new_data.select { |n| current_records.select { |c| @compare_method.call(c, n) }.count == 0 }
     end
 
     def an_object_with(hash)

data/lib/DUI/version.rb

@@ -1,3 +1,3 @@
 module DUI
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/spec/DUI/matcher_spec.rb

@@ -1,3 +1,4 @@
+require 'hashie/hash'
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe "Matcher" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: DUI
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Darren Cauthon
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-01 00:00:00 Z
+date: 2012-08-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -29,12 +27,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id001
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: minitest
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -43,8 +41,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id002
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  name: hashie
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  type: :development
+  prerelease: false
+  name: rake
 description: |-
   This gem provides a small API for comparing two datasets, 
                        for determining what records should be deleted, updated, or inserted.
@@ -59,9 +73,11 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- .travis.yml
 - DUI.gemspec
 - Gemfile
 - Guardfile
+- README.md
 - Rakefile
 - lib/DUI.rb
 - lib/DUI/matcher.rb