rspec_sequel_matchers 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jonathan Tron, Joseph Halter
+
+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,47 @@
+= rspec_sequel_matchers
+
+Some Sequel Matchers for RSpec, using no other gem than rspec and sequel themself. As a consequence, you can use these matchers with Rails, Sinatra or any other framework. It's pretty feature complete.
+
+Matchers assume that you're using the recommanded validation_helpers plugin. All instance validation methods are supported, namely:
+* validates_exact_length
+* validates_format
+* validates_includes
+* validates_integer
+* validates_length_range
+* validates_max_length
+* validates_min_length
+* validates_not_string
+* validates_numeric
+* validates_presence
+* validates_unique
+
+Each one with all possible options, namely:
+* :allow_blank
+* :allow_missing
+* :allow_nil
+* :message
+
+There're also matchers for associations class methods:
+* :many_to_many
+* :many_to_one
+* :one_to_many
+
+And there's an additionnal matcher have_column to check columns existance and their type, see example usage bellow.
+
+RspecSequel::Matchers has an extensive test suite and will give you as much explanation as possible in failure messages such as expected column type versus column type found in database.
+
+== Install
+
+  sudo gem install openhood-rspec_sequel_matchers
+
+== Example usage
+
+  describe Item do
+    it{ should have_column :name, :type => String }
+    it{ should_not have_column :wrong_name }
+    it{ should_validate_presence :name, :allow_nil => true }
+  end
+
+== Copyright
+
+Copyright (c) 2009 Jonathan Tron - Joseph Halter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require "rubygems"
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.version = "0.2.0"
+    gem.name = "rspec_sequel_matchers"
+    gem.summary = %Q{RSpec Matchers for Sequel}
+    gem.email = "team@openhood.com"
+    gem.homepage = "http://github.com/openhood/rspec_sequel_matchers"
+    gem.authors = ["Jonathan Tron", "Joseph Halter"]
+    gem.add_dependency "rspec", ">= 2.0.0.a"
+    gem.add_dependency "sequel", ">= 3.8.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require "rspec/core/rake_task"
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require "rake/rdoctask"
+Rake::RDocTask.new do |rdoc|
+  if File.exist?("VERSION.yml")
+    config = YAML.load(File.read("VERSION.yml"))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "test #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end

data/lib/rspec_sequel/association.rb

@@ -0,0 +1,30 @@
+module RspecSequel
+
+  class Association < Base
+
+    def description
+      desc = "have a #{association_type} association #{@attribute.inspect}"
+      desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+      desc
+    end
+
+    def valid?(db, i, c, attribute, options)
+      @association = c.association_reflection(attribute) || {}
+      if @association.empty?
+        @suffix << "(no association #{@attribute.inspect} found)"
+        false
+      else
+        matching = @association[:type] == association_type
+        options.each{|key, value|
+          if @association[key]!=value
+            @suffix << "expected #{key.inspect} == #{value.inspect} but found #{@association[key].inspect} instead"
+            matching = false
+          end
+        }
+        matching
+      end
+    end
+
+  end
+
+end

data/lib/rspec_sequel/base.rb

@@ -0,0 +1,33 @@
+require "sequel/extensions/inflector"
+
+module RspecSequel
+
+  class Base
+    def initialize(attribute, options={})
+      raise ArgumentError, "not enough params for matcher, required attribute is missing" if attribute.nil?
+      @attribute = attribute
+      @options = options
+      @description = []
+    end
+    def matches?(target)
+      @suffix = []
+      if target.is_a?(Sequel::Model)
+        @prefix = "expected #{target.inspect} to"
+        valid?(target.db, target, target.class, @attribute, @options)
+      else
+        @prefix = "expected #{target.table_name.to_s.classify} to"
+        valid?(target.db, target.new, target, @attribute, @options)
+      end
+    end
+    def failure_message
+      [@prefix, description, @suffix].flatten.compact.join(" ")
+    end
+    def negative_failure_message
+      [@prefix, "not", description, @suffix].flatten.compact.join(" ")
+    end
+    def hash_to_nice_string(hash)
+      hash.sort{|a,b| a[0].to_s<=>b[0].to_s}.collect{|param| param.collect{|v| v.inspect}.join(" => ")}.join(", ")
+    end
+  end
+
+end

data/lib/rspec_sequel/matchers/have_column.rb

@@ -0,0 +1,35 @@
+module RspecSequel
+  module Matchers
+
+    class HaveColumnMatcher < RspecSequel::Base
+      def description
+        desc = "have a column #{@attribute.inspect}"
+        desc << " with type #{@options[:type]}" if @options[:type]
+        desc
+      end
+
+      def valid?(db, i, c, attribute, options)
+
+        # check column existance
+        col = db.schema(c.table_name).detect{|col| col[0]==attribute}
+        matching = !col.nil?
+
+        # check type
+        if @options[:type]
+          expected = db.send(:type_literal, {:type => options[:type]}).to_s
+          if matching
+            found = [col[1][:type].to_s, col[1][:db_type].to_s]
+            @suffix << "(type found: #{found.uniq.join(", ")})"
+            matching &&= found.include?(expected)
+          end
+        end
+        matching
+      end
+    end
+
+    def have_column(*args)
+      HaveColumnMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/have_many_to_many.rb

@@ -0,0 +1,22 @@
+module RspecSequel
+  module Matchers
+
+    class HaveManyToManyMatcher < RspecSequel::Association
+      def association_type
+        :many_to_many
+      end
+      
+      def valid?(db, i, c, attribute, options)
+        matching = super
+
+        # check that association model exists, etc.
+        matching
+      end
+    end
+
+    def have_many_to_many(*args)
+      HaveManyToManyMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/have_many_to_one.rb

@@ -0,0 +1,22 @@
+module RspecSequel
+  module Matchers
+
+    class HaveManyToOneMatcher < RspecSequel::Association
+      def association_type
+        :many_to_one
+      end
+      
+      def valid?(db, i, c, attribute, options)
+        matching = super
+
+        # check that association model exists, etc.
+        matching
+      end
+    end
+
+    def have_many_to_one(*args)
+      HaveManyToOneMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/have_one_to_many.rb

@@ -0,0 +1,22 @@
+module RspecSequel
+  module Matchers
+
+    class HaveOneToManyMatcher < RspecSequel::Association
+      def association_type
+        :one_to_many
+      end
+      
+      def valid?(db, i, c, attribute, options)
+        matching = super
+
+        # check that association model exists, etc.
+        matching
+      end
+    end
+
+    def have_one_to_many(*args)
+      HaveOneToManyMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_exact_length.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateExactLengthMatcher < RspecSequel::Validation
+      def description
+        desc = "validate length of #{@attribute.inspect} is exactly #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Fixnum
+      end
+
+      def validation_type
+        :validates_exact_length
+      end
+    end
+
+    def validate_exact_length(*args)
+      ValidateExactLengthMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_format.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateFormatMatcher < RspecSequel::Validation
+      def description
+        desc = "validate format of #{@attribute.inspect} against #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Regexp
+      end
+
+      def validation_type
+        :validates_format
+      end
+    end
+
+    def validate_format(*args)
+      ValidateFormatMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_includes.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateIncludesMatcher < RspecSequel::Validation
+      def description
+        desc = "validate that #{@attribute.inspect} is included in #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Enumerable
+      end
+
+      def validation_type
+        :validates_includes
+      end
+    end
+
+    def validate_includes(*args)
+      ValidateIncludesMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_integer.rb

@@ -0,0 +1,21 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateIntegerMatcher < RspecSequel::Validation
+      def description
+        desc = "validate that #{@attribute.inspect} is a valid integer"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def validation_type
+        :validates_integer
+      end
+    end
+
+    def validate_integer(*args)
+      ValidateIntegerMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_length_range.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateLengthRangeMatcher < RspecSequel::Validation
+      def description
+        desc = "validate length of #{@attribute.inspect} is included in #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Enumerable
+      end
+
+      def validation_type
+        :validates_length_range
+      end
+    end
+
+    def validate_length_range(*args)
+      ValidateLengthRangeMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_max_length.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateMaxLengthMatcher < RspecSequel::Validation
+      def description
+        desc = "validate length of #{@attribute.inspect} is less than or equal to #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Fixnum
+      end
+
+      def validation_type
+        :validates_max_length
+      end
+    end
+
+    def validate_max_length(*args)
+      ValidateMaxLengthMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_min_length.rb

@@ -0,0 +1,25 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateMinLengthMatcher < RspecSequel::Validation
+      def description
+        desc = "validate length of #{@attribute.inspect} is greater than or equal to #{@additionnal.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def additionnal_param_type
+        Fixnum
+      end
+
+      def validation_type
+        :validates_min_length
+      end
+    end
+
+    def validate_min_length(*args)
+      ValidateMinLengthMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_not_string.rb

@@ -0,0 +1,21 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateNotStringMatcher < RspecSequel::Validation
+      def description
+        desc = "validate that #{@attribute.inspect} is not a string"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def validation_type
+        :validates_not_string
+      end
+    end
+
+    def validate_not_string(*args)
+      ValidateNotStringMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_numeric.rb

@@ -0,0 +1,21 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateNumericMatcher < RspecSequel::Validation
+      def description
+        desc = "validate that #{@attribute.inspect} is a valid float"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def validation_type
+        :validates_numeric
+      end
+    end
+
+    def validate_numeric(*args)
+      ValidateNumericMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_presence.rb

@@ -0,0 +1,21 @@
+module RspecSequel
+  module Matchers
+
+    class ValidatePresenceMatcher < RspecSequel::Validation
+      def description
+        desc = "validate presence of #{@attribute.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def validation_type
+        :validates_presence
+      end
+    end
+
+    def validate_presence(*args)
+      ValidatePresenceMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/matchers/validate_unique.rb

@@ -0,0 +1,33 @@
+module RspecSequel
+  module Matchers
+
+    class ValidateUniqueMatcher < RspecSequel::Validation
+      def description
+        desc = "validate uniqueness of #{@attribute.inspect}"
+        desc << " with option(s) #{hash_to_nice_string @options}" unless @options.empty?
+        desc
+      end
+
+      def validation_type
+        :validates_unique
+      end
+
+      def valid_options
+        [:message]
+      end
+
+      def args_to_called_attributes(args)
+        called_attributes = []
+        until args.empty?
+          called_attributes << args.shift
+        end
+        called_attributes
+      end
+    end
+
+    def validate_unique(*args)
+      ValidateUniqueMatcher.new(*args)
+    end
+
+  end
+end

data/lib/rspec_sequel/validation.rb

@@ -0,0 +1,77 @@
+module RspecSequel
+
+  class Validation < Base
+
+    def initialize(*args)
+      # initialize Base
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      super(args.pop, options)
+
+      # check additionnal param
+      if additionnal_param_required?
+        if args.size>1
+          raise ArgumentError, "too many params for matcher"
+        else
+          @additionnal = args.pop
+          raise ArgumentError, "expected matcher first parameter to be #{additionnal_param_type.inspect} but received #{@additionnal.class.inspect} instead" unless @additionnal.kind_of?(additionnal_param_type)
+        end
+      else
+        raise ArgumentError, "too many params for matcher" unless args.empty?
+      end
+    end
+
+    def additionnal_param_type
+      NilClass
+    end
+
+    def additionnal_param_required?
+      additionnal_param_type!=NilClass
+    end
+
+    def valid_options
+      [:allow_blank, :allow_missing, :allow_nil, :message]
+    end
+
+    def valid?(db, i, c, attribute, options)
+      # check options
+      invalid_options = options.keys.reject{|o| valid_options.include?(o)}
+      invalid_options.each{|o|
+        @suffix << "but option #{o.inspect} is not valid"
+      }
+      return false unless invalid_options.empty?
+
+      # check validation itself
+      called_count = 0
+      i = i.dup
+      i.class.columns # ensure colums are read again after .dup
+      i.stub!(validation_type).and_return{|*args|
+        called_options = args.last.is_a?(Hash) ? args.pop : {}
+        called_attributes = args_to_called_attributes(args)
+        called_additionnal = args.shift if additionnal_param_required?
+        if !args.empty?
+          @suffix << "but called with too many params"
+        elsif called_attributes.include?(attribute)
+          if additionnal_param_required? && @additionnal!=called_additionnal
+            @suffix << "but called with #{called_additionnal} instead"
+          elsif !options.empty? && called_options!=options
+            @suffix << "but called with option(s) #{hash_to_nice_string called_options} instead"
+          else
+            called_count += 1
+          end
+        end
+      }
+      i.valid?
+      if called_count>1
+        @suffix << "but validation is called too many times"
+        return false
+      end
+      called_count==1
+    end
+    
+    def args_to_called_attributes(args)
+      [args.pop].flatten
+    end
+
+  end
+
+end

data/lib/rspec_sequel_matchers.rb

@@ -0,0 +1,9 @@
+# Load base
+["base", "association", "validation"].each do |file|
+  require File.join(File.dirname(__FILE__), "rspec_sequel", file)
+end
+
+# Add matchers
+Dir[File.join(File.dirname(__FILE__), "rspec_sequel", "matchers", "*.rb")].each do |file|
+  require file
+end