swim 0.0.1 → 0.0.2

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in swim.gemspec
 gemspec
 
+gem 'rake'
 gem 'activesupport'
 gem 'activerecord'
-gem "sqlite3"
+gem 'multi_json'

data/README.md

@@ -1,6 +1,6 @@
 # Swim
 
-TODO: Write a gem description
+Swim provides tools for synchronizing a tree of ActiveRecord objects with a previously-saved JSON file.
 
 ## Installation
 
@@ -18,7 +18,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Add a settings_file instance method to your ActiveRecord class.
+
+		class Artist < ActiveRecord::Base
+			def settings_file
+				File.expand_path("/sample_files/artist_1_settings.json")
+			end
+		end
+	
+2. Add a sync_settings class method to your ActiveRecord class.
+
+		class Artist < ActiveRecord::Base
+		  def self.sync_settings
+		    { :albums => {} }
+		  end
+		end
 
 ## Contributing
 

data/lib/swim.rb

@@ -1,3 +1,5 @@
+require 'multi_json'
+
 module Swim
   require "swim/version"
   require "swim/change"

data/lib/swim/change.rb

@@ -1,37 +1,36 @@
+# Class to store changes made during SyncTools' import_json_file method.
 class Swim::Change
   attr_accessor :obj_class, :obj_id, :change_type, :key, :old_value, :new_value, :status, :errors
-    
-  def initialize(args)
-    obj_class = args[:obj_class]
-    obj_id      = args[:obj_id]
-    change_type = args[:change_type]
-    key         = args[:key]
-    old_value   = args[:old_value]
-    new_value   = args[:new_value]
-    status      = args[:status]
-    errors      = args[:errors]
-  end
-    
-  def new(args)
-  end
-    
-  def item
-    obj_class.constantize.send(:find, obj_id)
-  end
-    
-  def update(i)
-    i.update_attribute(key, new_value)
+  
+  def initialize(attributes = nil)
+    self.obj_class   = attributes[:obj_class]
+    self.obj_id      = attributes[:obj_id]
+    self.change_type = attributes[:change_type]
+    self.key         = attributes[:key]
+    self.old_value   = attributes[:old_value]
+    self.new_value   = attributes[:new_value]
+    self.status      = attributes[:status]
+    self.errors      = attributes[:errors]
   end
     
-  def delete(i)
-    i.destroy
+  def to_s
+    if status.nil? || status.empty?
+      verb = "would be"
+    elsif status == "succeeded"
+      verb = "was"
+    elsif status == "failed"
+      verb = "could not be"
+    end
+    if change_type == :update
+      "#{obj_class}(#{obj_id})##{key} #{verb} #{old_value} (instead of #{new_value})."
+    else
+      "#{obj_class}(#{obj_id}) #{verb} #{change_type}d (#{ change_type == :insert ? new_value.to_hash : old_value.to_hash })."
+    end
   end
     
-  def insert
-    i = obj_class.constantize.send(:new, new_value)
-    return i
+  def new(args)
   end
-    
+  
   def process
     if change_type == :update
       i = item
@@ -55,4 +54,27 @@ class Swim::Change
       return false
     end
   end
+  
+  private
+  
+  # Convenience method for accessing the changed object in the database 
+  def item
+    obj_class.constantize.send(:find, obj_id)
+  end
+  
+  # Method to execute the attribute update described by the Change  
+  def update(i)
+    i.update_attribute(key, new_value)
+  end
+  
+  # Method to execute the object deletion described by the Change    
+  def delete(i)
+    i.destroy
+  end
+  
+  # Method to execute the object insertion described by the Change  
+  def insert
+    i = obj_class.constantize.send(:new, new_value)
+    return i
+  end
 end

data/lib/swim/sync_tools.rb

@@ -1,25 +1,31 @@
-require 'active_support/all'
-
 class SyncSettingsMissing < StandardError
 end
 
-class SettingsFileMissing < StandardError
+class SettingsPathMissing < StandardError
+end
+
+class ComparisonHashMissing < StandardError
+end
+
+class InvalidSettingsPath < StandardError
 end
 
 
+# Tools for syncing a tree of ActiveRecord objects using a JSON file.
 class SyncTools
-    
-  def self.json_file(settings_filename)
-    file = File.open(settings_filename, "rb")
-    contents = file.read
-    ActiveSupport::JSON.decode(contents)
+  
+  # Save a JSON representaton of the object to a file, specified by  
+  def self.save_settings(obj)
+    str = obj.to_json(:include => obj.class.sync_settings )    
+    File.open(File.expand_path(obj.settings_path), 'w+') {|f| f.write(str) }
   end
-    
+  
+  # compares a tree of ActiveRecord objects to a previously-saved JSON file  
   def self.compare_json_file(obj)    
-    unless obj.methods.include?(:settings_file) || obj.methods.include?('settings_file')
-      raise SettingsFileMissing, "#{obj.class.to_s} must define a class method named settings_file."
+    unless obj.methods.include?(:settings_path) || obj.methods.include?('settings_path')
+      raise SettingsPathMissing, "#{obj.class.to_s} must define a class method named settings_file."
     end
-    json = json_file(obj.settings_file)
+    json = json_file(File.expand_path(obj.settings_path))
     
     unless obj.class.methods.include?(:sync_settings) || obj.class.methods.include?("sync_settings")
       raise SyncSettingsMissing, "#{obj.class.to_s} must define a class method named sync_settings that returns a hash."
@@ -32,8 +38,8 @@ class SyncTools
     end
   end
     
-  def self.import_json_file(obj, settings_filename)
-    changes = Swim::SyncTools.compare_json_file(self, settings_file)
+  def self.import_json_file(obj, settings_path)
+    changes = Swim::SyncTools.compare_json_file(self, settings_path)
     completed = []
     not_completed = []
     changes.each do |ch|
@@ -72,6 +78,7 @@ class SyncTools
         value = value.utc.to_s
       end
       unless value == hsh_value
+        # p "#{obj.class.to_s} #{obj.id} #{key} #{value} != #{hsh_value}"
         @changes << Swim::Change.new(:obj_class => obj.class.to_s, :obj_id => obj.id, :change_type => :update, :key => key, :old_value => value, :new_value => hsh_value)
       else
         # p "#{obj.class.to_s} #{key} #{value} == #{hsh_value}"
@@ -84,7 +91,7 @@ class SyncTools
     if arr.length == 0 && hsh.nil?
       return
     elsif hsh.nil?
-      throw "Array (#{arr.collect{|ar| ar.class.to_s }}) has no hash for comparison"
+      raise ComparisonHashMissing, "Array (#{arr.collect{|ar| ar.class.to_s }}) has no hash for comparison"
     end
     hsh_members = hsh.collect{ |h| h["id"] }
     arr.each do |a|
@@ -102,5 +109,11 @@ class SyncTools
       end
     end
   end
-		
+  
+  # loads and decodes a specified json_file  
+  def self.json_file(settings_path)
+    file = File.open(settings_path, "rb")
+    contents = file.read
+    ActiveSupport::JSON.decode(contents)
+  end
 end

data/lib/swim/version.rb

@@ -1,3 +1,3 @@
 module Swim
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/sync_tools_spec.rb

@@ -3,47 +3,55 @@ require 'spec_helper'
 require 'swim/change'
 require 'swim/sync_tools'
 
-class AlmostValidClass
-  def settings_file
-    File.expand_path("#{__FILE__}/../../sample_files/almost_valid_class_settings.json")
-  end
-  
-  # def self.sync_settings
-  #   return Hash.new
-  # end
-end
-
-class InvalidClass
-  # def self.settings_file
-  #   return Hash.new
-  # end
-  # def self.sync_settings
-  #   return Hash.new
-  # end
-end
-
 describe SyncTools do
   
-  it "should require the object to define settings_file" do
-    i_class = InvalidClass.new
-    expect { SyncTools::compare_json_file(i_class) }.to raise_error(
-      SettingsFileMissing
-    )
+  context "necessary settings" do
+    it "should require the object to define settings_path" do
+      expect { SyncTools::compare_json_file(InvalidClass.new) }.to raise_error(
+        SettingsPathMissing
+      )
+    end
+  
+    it "should require the object to define sync_settings" do
+      expect { SyncTools::compare_json_file(AlmostValidClass.new) }.to raise_error(
+        SyncSettingsMissing
+      )
+    end
   end
   
-  it "should require the object to define sync_settings" do
-    i2_class = AlmostValidClass.new
-    expect { SyncTools::compare_json_file(i2_class) }.to raise_error(
-      SyncSettingsMissing
-    )
+  context "compare_json_file" do 
+    it "should return a change when one exists" do
+      artist = Artist.find(1)
+      changes = SyncTools::compare_json_file(artist)
+      changes.should be_an_instance_of(Array)
+      changes.length.should == 1
+      changes.first.should be_an_instance_of(Swim::Change)
+    end
+    
+    it "should correctly identify changes" do
+      artist = Artist.find(2)
+      SyncTools.save_settings(artist)
+      artist.albums.first.title = "The Best of Billy Prestone"
+      changes = SyncTools::compare_json_file(artist)
+      changes.should be_an_instance_of(Array)
+      changes.length.should == 1
+      changes.first.should be_an_instance_of(Swim::Change)
+    end    
   end
-
-  it "should return a change when one exists" do
-    artist = Artist.find(1)
-    changes = SyncTools::compare_json_file(artist)
-    changes.should be_an_instance_of(Array)
-    changes.length.should == 1
-    changes.first.should be_an_instance_of(Swim::Change)
-  end   
-
+  
+  context "#save_settings" do
+    it "should save settings in a json file" do
+      artist = Artist.find(2)
+      expect { SyncTools.save_settings(artist) }
+    end
+    
+    it "settings and object should be identical" do
+      artist = Artist.find(2)
+      SyncTools.save_settings(artist)
+      changes = SyncTools::compare_json_file(artist)
+      changes.should be_an_instance_of(Array)
+      changes.length.should == 0
+    end
+  end
+  
 end

data/spec/sample_files/artist_2_settings.json

@@ -0,0 +1 @@
+{"artist":{"created_at":"2012-07-03T14:02:14-04:00","id":2,"name":"Billy Preston","updated_at":"2012-07-03T14:02:14-04:00","albums":[{"artist_id":2,"created_at":"2012-07-03T14:02:14-04:00","id":2,"title":"The Best of Billy Preston","updated_at":"2012-07-03T14:02:14-04:00"}]}}

data/spec/sample_models/almost_valid_class.rb

@@ -0,0 +1,9 @@
+class AlmostValidClass
+  def settings_path
+    "#{__FILE__}/../../sample_files/almost_valid_class_settings.json"
+  end
+  
+  # def self.sync_settings
+  #   return Hash.new
+  # end
+end

data/spec/sample_models/artist.rb

@@ -1,8 +1,8 @@
 class Artist < ActiveRecord::Base
   has_many :albums
   
-  def settings_file
-    File.expand_path("#{__FILE__}/../../sample_files/artist_settings.json")
+  def settings_path
+    "#{__FILE__}/../../sample_files/artist_#{id}_settings.json"
   end
 
   def self.sync_settings

data/spec/sample_models/invalid_class.rb

@@ -0,0 +1,8 @@
+class InvalidClass
+  # def self.settings_file
+  #   return Hash.new
+  # end
+  # def self.sync_settings
+  #   return Hash.new
+  # end
+end

data/swim.gemspec

@@ -6,9 +6,10 @@ Gem::Specification.new do |gem|
   gem.email         = ["jerry@disruptiveventures.com"]
   gem.description   = %q{Sync or Swim}
   gem.summary       = %q{Synchronize ActiveRecord Objects Across Environments with JSON and git}
-  gem.homepage      = ""
+  gem.homepage      = "http://disruptive.github.com/swim"
 
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swim
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-03 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    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'
 description: Sync or Swim
 email:
 - jerry@disruptiveventures.com
@@ -48,12 +64,15 @@ files:
 - spec/lib/swim_spec.rb
 - spec/lib/sync_tools_spec.rb
 - spec/sample_files/almost_valid_class_settings.json
-- spec/sample_files/artist_settings.json
+- spec/sample_files/artist_1_settings.json
+- spec/sample_files/artist_2_settings.json
 - spec/sample_models/album.rb
+- spec/sample_models/almost_valid_class.rb
 - spec/sample_models/artist.rb
+- spec/sample_models/invalid_class.rb
 - spec/spec_helper.rb
 - swim.gemspec
-homepage: ''
+homepage: http://disruptive.github.com/swim
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -65,15 +84,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3293738542906190303
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3293738542906190303
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Synchronize ActiveRecord Objects Across Environments with JSON and git
@@ -82,7 +107,10 @@ test_files:
 - spec/lib/swim_spec.rb
 - spec/lib/sync_tools_spec.rb
 - spec/sample_files/almost_valid_class_settings.json
-- spec/sample_files/artist_settings.json
+- spec/sample_files/artist_1_settings.json
+- spec/sample_files/artist_2_settings.json
 - spec/sample_models/album.rb
+- spec/sample_models/almost_valid_class.rb
 - spec/sample_models/artist.rb
+- spec/sample_models/invalid_class.rb
 - spec/spec_helper.rb