ixtlan-datamapper 0.1.0

data/lib/ixtlan/datamapper/stale_check.rb~

@@ -0,0 +1,49 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# 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.
+#
+require 'ixtlan/datamapper/object_stale_exception'
+module Ixtlan
+  module Optimistic
+    module StaleCheck
+
+      def __check( updated_at )
+        unless updated_at
+          raise ObjectStaleException.new "no 'updated_at' given for #{self}."
+        end
+      end
+      
+      def __check_stale( updated_at, result )
+        if updated_at.is_a? String
+          updated_at = DateTime.parse( updated_at.sub(/[.][0-9]+/, '') )
+        end
+        # rails hack-de-hack
+        if defined?( ActiveSupport::TimeWithZone ) && updated_at.is_a?( ActiveSupport::TimeWithZone )
+          updated_at = updated_at.to_datetime
+        end
+        updated_at = updated_at.new_offset(0)
+        if updated_at != result.updated_at && updated_at.strftime("%Y:%m:%d %H:%M:%S") != result.updated_at.strftime("%Y:%m:%d %H:%M:%S")
+          
+          raise ObjectStaleException.new "#{result.model} with key [#{result.id}] was updated at #{result.updated_at} is newer than the given one which was updated at #{updated_at}."
+        end
+        result
+      end
+    end
+  end
+end

data/lib/ixtlan/datamapper/stale_object_exception.rb

@@ -0,0 +1,26 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# 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.
+#
+module Ixtlan
+  module DataMapper
+    class StaleObjectException < StandardError
+    end
+  end
+end

data/lib/ixtlan/datamapper/stale_object_exception.rb~

@@ -0,0 +1,26 @@
+#
+# Copyright (C) 2012 mkristian
+#
+# 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.
+#
+module Ixtlan
+  module Optimistic
+    class ObjectStaleException < StandardError
+    end
+  end
+end

data/lib/ixtlan/datamapper/use_utc.rb

@@ -0,0 +1,4 @@
+ENV['TZ'] = 'UTC'
+if defined? JRUBY_VERSION
+  org.joda.time.DateTimeZone.setDefault(org.joda.time.DateTimeZone.forID('UTC'))
+end

data/lib/ixtlan/datamapper/use_utc.rb~

@@ -0,0 +1,5 @@
+
+ENV['TZ'] = 'UTC'
+if defined? JRUBY_VERSION
+  org.joda.time.DateTimeZone.setDefault(org.joda.time.DateTimeZone.forID('UTC'))
+end

data/lib/ixtlan/datamapper/validations_ext.rb

@@ -0,0 +1,61 @@
+require 'dm-core'
+module DataMapper
+  module ValidationsExt
+    def _save(execute_hooks = true)
+      result = super
+
+      # TODO: should we wrap it with run_once?
+      unless result
+        validate          if dirty_self?
+        validate_parents  if dirty_parents?
+        validate_children if dirty_children?
+      end
+
+      result
+    end
+
+    # Run validations on the resource
+    #
+    # @return [Boolean]
+    #   true if the resource is valid
+    #
+    # @api public
+    def validate
+      valid?
+    end
+
+    # Run validations on the associated parent resources
+    #
+    # @api semipublic
+    def validate_parents
+      parent_relationships.each do |relationship|
+        parent = relationship.get(self)
+        unless parent.valid?
+          unless errors[relationship.name].include?(parent.errors)
+            errors[relationship.name] = parent.errors
+          end
+        end
+      end
+    end
+
+    # Run validations on the associated child resources
+    #
+    # @api semipublic
+    def validate_children
+      child_associations.each do |collection|
+        if collection.dirty?
+          collection.each do |child|
+            unless child.valid?
+              relationship_errors = (errors[collection.relationship.name] ||= [])
+              unless relationship_errors.include?(child.errors)
+                relationship_errors << child.errors
+              end
+            end
+          end
+        end
+      end
+    end
+
+    Model.append_inclusions self
+  end # ValidationsExt
+end # DataMapper

data/spec/collection_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'spec_helper'
+
+require 'ixtlan/datamapper/collection'
+
+class E
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+class ECollection < Ixtlan::DataMapper::Collection
+  attribute :list, Array[E]
+  def data=( d )
+    self.list = d
+  end
+end
+
+describe Ixtlan::DataMapper::Collection do
+
+  before do
+    (1..3).each do |i|
+      unless d = E.get( i )
+        d = E.new :name => 'huffalump', :id => i
+        d.save!
+      end
+    end
+  end
+
+  it 'defaults to the complete set' do
+    c = ECollection.new( E.all )
+    c.total_count.must_equal E.count
+    c.offset.must_equal 0
+    c.list.must_equal E.all
+  end
+
+  it 'skips with given offset' do
+    c = ECollection.new( E.all, offset = E.count )
+    c.total_count.must_equal E.count
+    c.offset.must_equal E.count
+    c.list.must_equal []
+  end
+
+  (1..3).each do |i|
+    it 'has only one element with offset and limit' do
+      c = ECollection.new( E.all, offset = i - 1, 1 )
+      c.total_count.must_equal E.count
+      c.offset.must_equal i - 1
+      c.list.must_equal [E.get( i )]
+    end
+  end
+
+end

data/spec/collection_spec.rb~

@@ -0,0 +1,54 @@
+require_relative 'spec_helper'
+
+require 'ixtlan/datamapper/modified_by'
+
+class D
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+  
+  modified_by D
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+describe Ixtlan::DataMapper::ModifiedBy do
+
+  subject do 
+    unless d = D.get( 1 )
+      d = D.new :name => 'huffalump', :id => 1, :modified_by_id => 1
+      d.save!
+    end
+    d
+  end
+
+  it 'is valid per default' do
+    subject.current_user.must_be_nil
+    subject.persistence_state?.must_equal true
+    subject.dirty?.must_equal false
+    subject.valid?.must_equal true
+  end
+
+  it 'is not valid when dirty' do
+    subject.name = 'asd'
+    subject.current_user.must_be_nil
+    subject.dirty?.must_equal true
+    subject.valid?.must_equal false
+  end
+
+  it 'is valid when dirty and current_user set' do
+    subject.name = 'asd'
+    subject.current_user = subject
+    subject.dirty?.must_equal true
+    subject.valid?.must_equal true
+  end
+
+  it 'is valid after setting current user' do
+    subject.current_user = subject
+    subject.dirty?.must_equal false
+    subject.valid?.must_equal true
+  end
+
+end

data/spec/conditional_get_spec.rb

@@ -0,0 +1,69 @@
+require_relative 'spec_helper'
+
+require 'ixtlan/datamapper/conditional_get'
+
+class B
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+  
+  timestamps :at
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+describe Ixtlan::DataMapper::ConditionalGet do
+
+  subject { B.create :name => 'huffalump' }
+
+  describe "#conditional_get" do
+
+    it 'returns false if everything is up-to-date' do
+      B.conditional_get(subject.updated_at.to_s, subject.id).must_equal false
+    end
+
+    it 'returns false if everything is up-to-date with DateTime parameter' do
+      B.conditional_get!(subject.updated_at, subject.id).must_equal false
+    end
+    
+    it 'returns object for given id when there is no modified date' do
+      B.conditional_get(nil, subject.id).must_equal subject
+    end
+
+    it 'returns nil on stale modified date' do
+      B.conditional_get(subject.updated_at + 1, subject.id).must_equal subject
+    end
+
+    it 'returns nil on non-existing id' do
+      B.conditional_get(subject.updated_at.to_s, subject.id + 987).must_be_nil
+    end
+
+  end
+
+  describe "#conditional_get!" do
+
+    it 'returns false if everything is up-to-date' do
+      B.conditional_get!(subject.updated_at.to_s, subject.id).must_equal false
+    end
+    
+    it 'returns false if everything is up-to-date with DateTime parameter' do
+      B.conditional_get!(subject.updated_at, subject.id).must_equal false
+    end
+    
+    it 'fails with not-found exception with non-existing id' do
+      lambda { B.conditional_get!(subject.updated_at.to_s, subject.id + 987) }.must_raise DataMapper::ObjectNotFoundError
+    end
+    
+    it 'retuens object with stale modified parameter' do
+      B.conditional_get!((subject.updated_at - 1000).to_s, subject.id).must_equal subject
+    end
+
+    it 'returns object without modified parameter given' do
+      B.conditional_get!(nil, subject.id).must_equal subject
+    end
+
+  end
+
+end

data/spec/conditional_get_spec.rb~

@@ -0,0 +1,70 @@
+require_relative 'spec_helper'
+
+require 'ixtlan/datamapper/use_utc'
+require 'ixtlan/datamapper/conditional_get'
+
+class B
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :name, String
+  
+  timestamps :at
+end
+
+DataMapper.finalize
+DataMapper.auto_migrate!
+
+describe Ixtlan::DataMapper::ConditionalGet do
+
+  subject { B.create :name => 'huffalump' }
+
+  describe "#conditional_get" do
+
+    it 'returns false if everything is up-to-date' do
+      B.conditional_get(subject.updated_at.to_s, subject.id).must_equal false
+    end
+
+    it 'returns false if everything is up-to-date with DateTime parameter' do
+      B.conditional_get!(subject.updated_at, subject.id).must_equal false
+    end
+    
+    it 'returns object for given id when there is no modified date' do
+      B.conditional_get(nil, subject.id).must_equal subject
+    end
+
+    it 'returns nil on stale modified date' do
+      B.conditional_get(subject.updated_at + 1, subject.id).must_equal subject
+    end
+
+    it 'returns nil on non-existing id' do
+      B.conditional_get(subject.updated_at.to_s, subject.id + 987).must_be_nil
+    end
+
+  end
+
+  describe "#conditional_get!" do
+
+    it 'returns false if everything is up-to-date' do
+      B.conditional_get!(subject.updated_at.to_s, subject.id).must_equal false
+    end
+    
+    it 'returns false if everything is up-to-date with DateTime parameter' do
+      B.conditional_get!(subject.updated_at, subject.id).must_equal false
+    end
+    
+    it 'fails with not-found exception with non-existing id' do
+      lambda { B.conditional_get!(subject.updated_at.to_s, subject.id + 987) }.must_raise DataMapper::ObjectNotFoundError
+    end
+    
+    it 'retuens object with stale modified parameter' do
+      B.conditional_get!((subject.updated_at - 1000).to_s, subject.id).must_equal subject
+    end
+
+    it 'returns object without modified parameter given' do
+      B.conditional_get!(nil, subject.id).must_equal subject
+    end
+
+  end
+
+end

data/spec/datamapper_spec.rb~

@@ -0,0 +1,74 @@
+require 'controller'
+
+shared_examples 'a X-Headers' do
+
+  it 'should be able to switch off' do
+    subject.send method, :inline => "asd", :x_frame_headers => :off, :x_content_type_headers => :off, :x_xss_protection_headers => :off
+    subject.response.headers.should == {}
+  end
+
+end
+
+class MyController < Controller
+  x_frame_headers :sameorigin
+  x_content_type_headers :off
+  x_xss_protection_headers :disabled
+end
+
+[:render, :send_file, :send_data].each do |method|
+  describe "x-headers using controller method #{method}" do
+    context "with simple controller" do
+      before do
+        Rails.configuration.x_frame_headers = nil
+        Rails.configuration.x_content_type_headers = nil
+        Rails.configuration.x_xss_protection_headers = nil
+      end
+      subject { Controller.new }
+      
+      it 'should use default' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"DENY", "X-Content-Type-Options"=>"nosniff", "X-XSS-Protection"=>"1; mode=block"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+    
+    context "with controller with header configuration" do
+      before do
+        Rails.configuration.x_frame_headers = nil
+        Rails.configuration.x_content_type_headers = nil
+        Rails.configuration.x_xss_protection_headers = nil
+      end
+      subject { MyController.new }
+      
+      it 'should use configuration' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"0"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+    
+    context "with simple controller with rails configuration" do
+      before do
+        Rails.configuration.x_frame_headers = :sameorigin
+        Rails.configuration.x_content_type_headers = :off
+        Rails.configuration.x_xss_protection_headers = :disabled
+      end
+      subject { Controller.new }
+      
+      it 'should use configuration' do
+        subject.send method, :inline => "asd"
+        subject.response.headers.should == {"X-Frame-Options"=>"SAMEORIGIN", "X-XSS-Protection"=>"0"}
+      end
+      
+      it_behaves_like "a X-Headers" do
+        let(:method) { method }
+      end
+    end
+  end
+end