sequel_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d1cdbc693387bd8389f02b56356ba409fa38eea
+  data.tar.gz: 66ff755f8c42070f4c558a4ca2098802f97c4bb3
+SHA512:
+  metadata.gz: 9e7b4b4065e4b43515e78d05bee8228ff083c20858c0adce136eb763294c1bc2bbb507bb5a4a5f482bfd375dd32b80b969c265d2d274b9620df8682d104730ba
+  data.tar.gz: 2c02bc59848bd3d52c9f81df7347cbfcdcf78cb222247365265fd7d9cc85a667fbd5d9dec2543330abe625eaf58c805d0a7356d313ee1c3e42133a8cc54dd54c

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.db

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel_spec.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adrià Planas, Jonathan Tron, Joseph Halter
+
+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.md

@@ -0,0 +1,91 @@
+# SequelSpec
+
+SequelSpec is a refactor of [rspec_sequel_matchers](https://github.com/openhood/rspec_sequel_matchers) borrowing concepts from [shoulda-matchers](https://github.com/thoughtbot/shoulda-matchers). In contrast with rspec_sequel_matchers it provides a sweeter syntax and it doesn't rely on a specific mocking framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel_spec', :group => :test
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel_spec
+
+## Usage
+
+The matchers are automatically included on RSpec. Just use them at will.
+
+### Association
+
+```ruby
+it { should have_many_to_many :items }
+it { should have_many_to_one :item }
+it { should have_one_to_many :comments }
+it { should have_one_to_one :photo }
+it { should have_one_through_one :author }
+```
+
+You can specify options using ```#with_options```
+
+```ruby
+it { should have_one_through_one(:author).with_options :key => :user_id }
+```
+
+### Validation
+
+```ruby
+# Format
+it { should validate_format_of(:name).with(/\w+/) }
+
+# Inclusion
+it { should ensure_inclusion_of(:name).in(['John', 'Smith']) }
+
+# Integrity (valid integer)
+it { should validate_integrity_of(:age) }
+
+# Length
+it { should validate_length_of(:name).is(20) }
+it { should validate_length_of(:name).is_at_least(20) }
+it { should validate_length_of(:name).is_at_most(20) }
+it { should validate_length_of(:name).is_between(2..20) }
+
+# Not null
+it { should validate_not_null(:category_id) }
+
+# Numericality (valid float)
+it { should validate_numericality_of(:price) }
+
+# Type
+it { should validate_type_of(:birthdate).is Date }
+
+# Uniqueness
+it { should validate_uniqueness_of(:username) }
+```
+
+This matchers accepts options through ```#with_options``` as well
+
+```ruby
+it { should validate_uniqueness_of(:username).with_options :message => "This username is already taken" }
+```
+
+Or with the specialized helpers: ```#allowing_nil```, ```#allowing_blank```, ```#allowing_missing```, and ```#with_message```
+
+```ruby
+it { should validate_length_of(:name).is(20).allowing_nil }
+it { should validate_length_of(:name).is(20).allowing_blank }
+it { should validate_length_of(:name).is(20).allowing_missing }
+it { should validate_length_of(:name).is(20).with_message "Name should be 20 chars long" }
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/sequel_spec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sequel_spec.rb

@@ -0,0 +1,8 @@
+require 'sequel_spec/version'
+require 'sequel_spec/base'
+require 'sequel_spec/association'
+require 'sequel_spec/validation'
+
+if defined?(RSpec)
+  require 'sequel_spec/integration/rspec'
+end

data/lib/sequel_spec/association.rb

@@ -0,0 +1,13 @@
+require 'sequel_spec/association/association_matcher'
+require 'sequel_spec/association/have_many_to_many_matcher'
+require 'sequel_spec/association/have_many_to_one_matcher'
+require 'sequel_spec/association/have_one_to_many_matcher'
+require 'sequel_spec/association/have_one_to_one_matcher'
+require 'sequel_spec/association/have_one_through_one_matcher'
+
+module SequelSpec
+  module Matchers
+    module Association
+    end
+  end
+end

data/lib/sequel_spec/association/association_matcher.rb

@@ -0,0 +1,32 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class AssociationMatcher < 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, instance, klass, attribute, options)
+          @association = klass.association_reflection(attribute) || {}
+
+          if @association.empty?
+            @suffix << "(no association #{@attribute.inspect} found)"
+            false
+          else
+            matching = @association[:type] == association_type
+            options.each do |key, value|
+              if @association[key] != value
+                @suffix << "expected #{key.inspect} == #{value.inspect} but found #{@association[key].inspect} instead"
+                matching = false
+              end
+            end
+
+            matching
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequel_spec/association/have_many_to_many_matcher.rb

@@ -0,0 +1,15 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class HaveManyToManyMatcher < AssociationMatcher
+        def association_type
+          :many_to_many
+        end
+      end
+
+      def have_many_to_many(*args)
+        HaveManyToManyMatcher.new(*args)
+      end
+    end
+  end
+end

data/lib/sequel_spec/association/have_many_to_one_matcher.rb

@@ -0,0 +1,15 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class HaveManyToOneMatcher < AssociationMatcher
+        def association_type
+          :many_to_one
+        end
+      end
+
+      def have_many_to_one(*args)
+        HaveManyToOneMatcher.new(*args)
+      end
+    end
+  end
+end

data/lib/sequel_spec/association/have_one_through_one_matcher.rb

@@ -0,0 +1,15 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class HaveOneThroughOneMatcher < AssociationMatcher
+        def association_type
+          :one_through_one
+        end
+      end
+
+      def have_one_through_one(*args)
+        HaveOneThroughOneMatcher.new(*args)
+      end
+    end
+  end
+end

data/lib/sequel_spec/association/have_one_to_many_matcher.rb

@@ -0,0 +1,15 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class HaveOneToManyMatcher < AssociationMatcher
+        def association_type
+          :one_to_many
+        end
+      end
+
+      def have_one_to_many(*args)
+        HaveOneToManyMatcher.new(*args)
+      end
+    end
+  end
+end

data/lib/sequel_spec/association/have_one_to_one_matcher.rb

@@ -0,0 +1,15 @@
+module SequelSpec
+  module Matchers
+    module Association
+      class HaveOneToOneMatcher < AssociationMatcher
+        def association_type
+          :one_to_one
+        end
+      end
+
+      def have_one_to_one(*args)
+        HaveOneToOneMatcher.new(*args)
+      end
+    end
+  end
+end

data/lib/sequel_spec/base.rb

@@ -0,0 +1,45 @@
+module SequelSpec
+  module Matchers
+    class Base
+      def initialize(attribute)
+        raise ArgumentError, "Attribute not specified" unless attribute
+        @attribute   = attribute
+        @description = []
+        @options     = {}
+
+        self
+      end
+
+      def matches?(subject)
+        @suffix = []
+
+        if subject.is_a?(Sequel::Model)
+          @prefix = "expected #{subject.inspect} to"
+          valid?(subject.db, subject, subject.class, @attribute, @options)
+        else
+          @prefix = "expected #{subject.table_name.to_s.classify} to"
+          valid?(subject.db, subject.new, subject, @attribute, @options)
+        end
+      end
+
+      def with_options(opts)
+        raise ArgumentError, "#with_options expects a hash, #{opts.class} given" unless opts.is_a? Hash
+
+        @options.merge! opts
+        self
+      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
+end

data/lib/sequel_spec/integration/rspec.rb

@@ -0,0 +1,6 @@
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.include SequelSpec::Matchers::Validation
+  config.include SequelSpec::Matchers::Association
+end

data/lib/sequel_spec/validation.rb

@@ -0,0 +1,18 @@
+require 'sequel_spec/validation/validate_matcher'
+require 'sequel_spec/validation/validate_length_matcher'
+require 'sequel_spec/validation/validate_format_matcher'
+require 'sequel_spec/validation/validate_includes_matcher'
+require 'sequel_spec/validation/validate_integer_matcher'
+require 'sequel_spec/validation/validate_numeric_matcher'
+require 'sequel_spec/validation/validate_presence_matcher'
+require 'sequel_spec/validation/validate_unique_matcher'
+require 'sequel_spec/validation/validate_not_null_matcher'
+require 'sequel_spec/validation/validate_type_matcher'
+require 'sequel_spec/validation/validate_schema_types_matcher'
+
+module SequelSpec
+  module Matchers
+    module Validation
+    end
+  end
+end

data/lib/sequel_spec/validation/validate_format_matcher.rb

@@ -0,0 +1,42 @@
+module SequelSpec
+  module Matchers
+    module Validation
+      class ValidateFormatMatcher < ValidateMatcher
+        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_required?
+          true
+        end
+
+        def additionnal_param_check
+          unless @additionnal
+            raise ArgumentError, "You should specify the format using #with"
+          end
+        end
+
+        def with(value)
+          unless value.is_a?(Regexp)
+            raise ArgumentError, "#with expects a Regexp"
+          end
+
+          @additionnal = value
+          self
+        end
+
+        def validation_type
+          :validates_format
+        end
+      end
+
+      def validate_format(attribute)
+        ValidateFormatMatcher.new(attribute)
+      end
+
+      alias :validate_format_of :validate_format
+    end
+  end
+end

data/lib/sequel_spec/validation/validate_includes_matcher.rb

@@ -0,0 +1,43 @@
+module SequelSpec
+  module Matchers
+    module Validation
+      class ValidateIncludesMatcher < ValidateMatcher
+        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
+
+        # temp workaround
+        def additionnal_param_required?
+          true
+        end
+
+        def additionnal_param_check
+          unless @additionnal
+            raise ArgumentError, "You should specify inclusion using #in"
+          end
+        end
+
+        def in(value)
+          unless value.is_a?(Enumerable)
+            raise ArgumentError, "#in expects a #{Enumerable}"
+          end
+
+          @additionnal = value
+          self
+        end
+
+        def validation_type
+          :validates_includes
+        end
+      end
+
+      def validate_includes(attribute)
+        ValidateIncludesMatcher.new(attribute)
+      end
+
+      alias :ensure_inclusion_of :validate_includes
+    end
+  end
+end