codebrulee-attr_remote 0.0.2

data/LICENSE

@@ -0,0 +1,7 @@
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1 @@
+= attr_remote - Painlessly integrate ActiveResource into ActiveRecord.

data/attr_remote.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name     = "attr_remote"
+  s.version  = "0.0.2"
+  s.date     = "2008-01-06"
+  s.summary  = "Painlessly integrate ActiveResource into ActiveRecord."
+  s.email    = "smithk14@gmail.com"
+  s.homepage = "http://github.com/codebrulee/attr_remote"
+  s.description = "Painlessly integrate ActiveResource into ActiveRecord."
+  s.has_rdoc = true
+  s.authors  = ["Kevin Smith"]
+  s.files    = [
+  	"README.rdoc",
+  	"attr_remote.gemspec",
+    "LICENSE",
+    "lib/attr_remote.rb"
+  ]
+  
+  s.test_files = [
+    "test/test_attr_remote.rb",
+    "test/helper.rb",
+    "test/factories.rb",
+    "test/db/test.db",
+    "test/models/bob.rb",
+    "test/models/remote_bob.rb",
+    "test/models/user.rb",
+    "test/models/remote_user.rb",
+  ]
+
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc"]
+end

data/lib/attr_remote.rb

@@ -0,0 +1,102 @@
+require 'active_record'
+require 'active_support'
+require 'active_resource'
+
+module AttrRemote
+  module ClassMethods
+    def attr_remote(*remote_attrs)
+      remote_class = "Remote#{self.to_s}"
+      remote_instance_meth = remote_class.underscore
+      remote_instance_id = remote_class.foreign_key
+    
+      class_eval <<-remote_access
+      # def remote_user
+      #   @remote_user ||= RemoteUser.find(self.remote_user_id) rescue nil
+      # end
+        def #{remote_instance_meth}
+          @#{remote_instance_meth} ||= #{remote_class}.find(self.#{remote_instance_id}) rescue nil
+        end
+      
+      # before_create :create_remote_user
+        before_create :create_#{remote_instance_meth}
+      
+      # def create_remote_user
+      #   unless self.remote_user_id
+      #     remote_hash = {}
+      #     self.class.remote_attributes.each do |attr|
+      #       remote_hash[attr.to_sym] = self.send(attr.to_sym)
+      #     end
+      #     remote_hash[:validate_only] = true if validate_only
+      #     @remote_user = RemoteUser.create(remote_hash)
+      #     
+      #     unless @remote_user.valid?
+      #       @remote_user.errors.each do |attr, err|
+      #         errors.add(attr, err)
+      #       end
+      #       return false
+      #     else
+      #       self.remote_user_id = @remote_user.id
+      #     end
+      #   end
+      # end
+        def create_#{remote_instance_meth}
+          unless self.#{remote_instance_id}
+            remote_hash = {}
+            self.class.remote_attributes.each do |attr|
+              remote_hash[attr.to_sym] = self.send(attr.to_sym)
+            end
+            @#{remote_instance_meth} = #{remote_class}.create(remote_hash)
+            
+            unless @#{remote_instance_meth}.valid?
+              @#{remote_instance_meth}.errors.each do |attr, err|
+                errors.add(attr, err)
+              end
+              return false
+            else
+              self.#{remote_instance_id} = @#{remote_instance_meth}.id
+            end
+          end
+        end
+        private :create_#{remote_instance_meth}
+        
+      # validate_on_create :validate_remote_user_on_create
+        validate_on_create :validate_#{remote_instance_meth}_on_create
+        
+      # def validate_remote_user_on_create; end  
+        def validate_#{remote_instance_meth}_on_create; end
+      remote_access
+    
+      @remote_attributes = remote_attrs
+      remote_attributes.each do |attr|      
+        class_eval <<-remote_attribute
+          def #{attr}                             # def username
+            remote_#{attr} || ''                  #   remote_username || ''
+          end                                     # end
+    
+          def remote_#{attr}                      # def remote_username
+            if @#{attr}                           #   if @username
+              @#{attr}                            #     @username
+            elsif self.#{remote_instance_meth}    #   elsif self.remote_user
+              @#{attr} = self.                    #     @username = self.
+                         #{remote_instance_meth}. #                 remote_user.
+                         #{attr}                  #                 username
+            else                                  #   else
+              nil                                 #     nil
+            end                                   #   end
+          end                                     # end
+        
+          def #{attr}=(attr_value)                # def username=(attr_value)
+            @#{attr} = attr_value                 #   @username = attr_value
+          end                                     # end
+        remote_attribute
+      end
+    end
+    
+    def remote_attributes
+      @remote_attributes ||= []
+    end
+    
+  end
+end
+
+ActiveRecord::Base.extend AttrRemote::ClassMethods

data/test/factories.rb

@@ -0,0 +1,3 @@
+Factory.define :user do |u|
+  u.name "Kevin"
+end

data/test/helper.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'rubygems'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'attr_remote')
+require 'active_resource/http_mock'
+
+Dir['**/models/*.rb'].each do |model|
+  require model
+end
+
+require 'redgreen'
+require 'context'
+require 'factory_girl'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'sqlite3', 
+  :dbfile => File.dirname(__FILE__) + '/db/test.db'
+})
+
+ActiveResource::HttpMock.respond_to do |mock|
+  # user is a successful creation
+  mock.get "/users/1.xml", {}, {
+    :name => "Kevin"
+  }.to_xml(:root => "user")
+  
+  mock.post "/users.xml", {}, {
+    :name => "Kevin"
+  }.to_xml(:root => "user"), 200, {
+    'Location' => 'http://0.0.0.0:3000/users/1'
+  }
+  
+  # bob is not so lucky
+  mock.post "/bobs.xml", 
+            {}, 
+            returning(ActiveRecord::Errors.new(Bob.new)) { |errors|
+              errors.add(:email, "can't be blank")
+            }.to_xml, 422
+end
+
+class Test::Unit::TestCase
+  def teardown
+    # cleanup all our test data
+    User.delete_all
+    Bob.delete_all
+  end
+end

data/test/models/bob.rb

@@ -0,0 +1,9 @@
+class Bob < ActiveRecord::Base
+  validates_presence_of :title
+  
+  attr_remote :email, :foo
+  
+  def validate_remote_bob_on_create
+    errors.add(:foo, "has already been taken") if foo == "taken"
+  end
+end

data/test/models/remote_bob.rb

@@ -0,0 +1,4 @@
+class RemoteBob < ActiveResource::Base
+  self.site = "http://0.0.0.0:3000/"
+  self.element_name = "bob"
+end

data/test/models/remote_user.rb

@@ -0,0 +1,4 @@
+class RemoteUser < ActiveResource::Base
+  self.site = "http://0.0.0.0:3000/"
+  self.element_name = "user"
+end

data/test/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  attr_remote :name
+end

data/test/test_attr_remote.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestAttrRemote < Test::Unit::TestCase
+  context "remote object access" do
+    before do
+      @user = Factory(:user)
+    end
+    test "that an instance should have a method for the remote object" do
+      assert @user.respond_to?(:remote_user)
+    end
+    test "that the remote object should be looked up based on the id" do
+      assert_equal "Kevin", @user.remote_user.name
+    end
+  end
+  
+  context "reading" do
+    test "that an instance should have a read method for the attribute" do
+      user = Factory(:user)
+      assert user.respond_to?(:name)
+    end
+    
+    test "that the read method returns the correct value" do
+      user = Factory(:user)
+      assert_equal "Kevin", user.name
+    end
+    
+    test "that after first read, an instance variable contains the value" do
+      user = Factory.build(:user, :name => nil, :remote_user_id => 1)
+      assert_nil user.instance_variable_get('@name')
+      user.name
+      assert_equal "Kevin", user.instance_variable_get('@name')
+    end
+    
+    test "that an attribute will be empty if the remote side does not exist" do
+      user = Factory.build(:user, :remote_user_id => 666, :name => nil)
+      assert_equal '', user.name
+    end
+  end
+  
+  context "creation" do
+    test "that an instance should have a writer method for the attribute" do
+      user = Factory(:user)
+      assert user.respond_to?(:name=)
+    end
+    test "that an instance reads correctly after writing" do
+      user = Factory.build(:user, :name => "test")
+      assert_equal "test", user.name
+    end
+    test "that the remote object id is set after creation" do
+      user = Factory(:user, :name => "Kevin")
+      assert_equal 1, user.remote_user_id
+    end
+    
+    test "that remote errors halt save process" do
+      bob = Bob.new(:title => "title")
+      assert !bob.save
+      assert_not_nil bob.errors.on(:email)
+    end
+    
+    test "that failure of local validations halts remote creation and therefore remote errors do not show up" do
+      bob = Bob.create(:title => nil)
+      assert !bob.save
+      assert_not_nil bob.errors.on(:title)
+      assert_nil bob.errors.on(:email)
+    end
+  end
+  
+  context "updates" do
+  end
+  
+  context "deletes" do
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: codebrulee-attr_remote
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kevin Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-06 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Painlessly integrate ActiveResource into ActiveRecord.
+email: smithk14@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- attr_remote.gemspec
+- LICENSE
+- lib/attr_remote.rb
+has_rdoc: true
+homepage: http://github.com/codebrulee/attr_remote
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Painlessly integrate ActiveResource into ActiveRecord.
+test_files: 
+- test/test_attr_remote.rb
+- test/helper.rb
+- test/factories.rb
+- test/db/test.db
+- test/models/bob.rb
+- test/models/remote_bob.rb
+- test/models/user.rb
+- test/models/remote_user.rb