minitest-sequel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2997e3b0fa5879eef663dc938c536c4ce8fd1fd3
-  data.tar.gz: 533196e4a81a67e333c4251d71b2aa48999497e8
+  metadata.gz: d7cc3f41e0816a1d22ae6bad2782fb0d42bbf59a
+  data.tar.gz: 03d217459d38312dca790b3e34209c1f31384774
 SHA512:
-  metadata.gz: 10b33ee43a344c43568e2c7c6207a3bf8fda4fb048e75abe916029a49ab8646d1a3539b84fb3293290a9600f9e05d5a03a8a9650312c7c799428fb0c22a906a9
-  data.tar.gz: 37de04749d64329f6ba80d754643c1633e3880e037a037c54a570570a4165b0758221e1d603ee26dc8dd2f7a56396e3cca782ad1a9795761e744f440b8701293
+  metadata.gz: d2f994c9c68a41e7459d8905bc46fb977bbe81aa36168b479312e9e77eafc8a163db355ad1ec56d0622e577bb666f09f1828a2cd0f87139f0bd903deea7a9c26
+  data.tar.gz: c253fbe46ca52f6d8f298c6625c5232778cbc2057daa9729e3752caff4bc259b6455988210547e28e570f7a4d410272c475640b92c55a7524e04d779da6e33dd

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/rubocop/
+/rubocop/
+/.vscode

data/Gemfile

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

data/README.md

@@ -1,9 +1,9 @@
 # Minitest-Sequel
 
-[Minitest](https://github.com/seattlerb/minitest) assertions to speed-up development and testing of 
+[Minitest](https://github.com/seattlerb/minitest) assertions to speed-up development and testing of
 [Sequel](http://sequel.jeremyevans.net/) database setups.
 
-The general hope is that this gem will contain a variety of useful assertions in all areas of testing Sequel database 
+The general hope is that this gem will contain a variety of useful assertions in all areas of testing Sequel database
 code within your apps, gems, etc.
 
 Please help out with missing features / functionality.
@@ -23,17 +23,19 @@ let(:m) { Post.first }
 it { assert_have_column(m, :title, type: :string, db_type: 'varchar(250)', allow_null: :false) }
 
 it { m.must_have_column(:title, type: :string, allow_null: :false) }
-    
- # definition of args
-assert_have_column(
-  <instance>, 
-  <column_name>, 
-  <options>, 
-  <custom_error_message>
-)
+
+it { m.must_have_column(:title, { type: :string, allow_null: :false }, "Custom messsage goes here") }
+
+# definition of args
+# assert_have_column(
+#   <instance>,
+#   <column_name>,
+#   <options>,
+#   <custom_error_message>
+# )
 ```
 
-The `assert_have_column()` method first tests if the column name is defined in the Model and then checks all passed options. 
+The `assert_have_column()` method first tests if the column name is defined in the Model and then checks all passed options.
 
 
 The following options are valid and checked:
@@ -47,7 +49,7 @@ The following options are valid and checked:
  * `:auto_increment`
 
 
-In the event the specs differ from the actual database implementation an extensive error message with the 
+In the event the specs differ from the actual database implementation an extensive error message with the
 differing option(s) is provided to help speed up debugging the issue:
 
 ```
@@ -58,7 +60,7 @@ Expected Post model to have column: :title with: \
 
 **Please NOTE!**
 
-To test options with a value that is either `nil`, `true` or `false`, please use `:nil`, `:false` or `:true` and provide 
+To test options with a value that is either `nil`, `true` or `false`, please use `:nil`, `:false` or `:true` and provide
 numbers as 'strings' instead, ie: `'1'` instead of `1`.
 
 
@@ -70,7 +72,7 @@ numbers as 'strings' instead, ie: `'1'` instead of `1`.
 <br>
 
 
-## Associations 
+## Associations
 
 Conveniently test model associations quickly and easily with these Minitest assertions:
 
@@ -104,15 +106,15 @@ Can be easily and quickly tested with `assert_association_one_to_one()` like thi
 
 ```ruby
 let(:m) { Post.first }
-    
+
 it { assert_association_one_to_one(m, :first_comment)
  # or
 it { m.must_have_one_to_one_association(:first_comment) }
-    
-    
+
+
  # definition of args
-assert_association_one_to_one( 
-  <model_instance>, 
+assert_association_one_to_one(
+  <model_instance>,
   <association_name>,   # ie: :first_comment
   <options>,
   <custom_error_message>
@@ -123,7 +125,7 @@ In the event of errors an extensive error message is provided:
 
 ```
  # example error message
-    
+
 Expected Author to have a :one_to_one association :key_posts but no association \
  ':key_posts' was found - available associations are: [ \
   {:attribute=>:posts, :type=>:one_to_many, :class=>:Post, :keys=>[:author_id]}, \
@@ -148,7 +150,7 @@ Can be easily and quickly tested with `assert_association_one_to_many()` like th
 
 ```ruby
 let(:p) { Post.first }
-  
+
 it { assert_association_one_to_many(p, :comments) }
  # or
 it { m.must_have_one_to_many_association(:comments) }
@@ -173,7 +175,7 @@ Can be easily and quickly tested with `assert_association_many_to_one()` like th
 
 ```ruby
 let(:p) { Post.first }
-  
+
 it { assert_association_many_to_one(p, :author) }
  # or
 it { m.must_have_many_to_one_association(:author) }
@@ -199,7 +201,7 @@ Can be easily and quickly tested with `assert_association_many_to_many()` like t
 
 ```ruby
 let(:p) { Post.first }
- 
+
 it { assert_association_many_to_many(p, :categories) }
  # or
 it { m.must_have_many_to_many_association(:categories) }
@@ -211,15 +213,15 @@ If something is wrong an extensive error message is provided:
 Expected Category to have a :many_to_many association :posts with given options: \
   {:class_name=>'Posts'} but should be {:class_name=>'Post' }
 ```
-  
+
 or
-  
+
 ```
 Expected Category to have a :many_to_many association :post but no association \
  ':post' was found - available associations are: [ \
   { :attribute=>:posts, :type=>:many_to_many, :class=>:Post, :join_table=>:categories_posts, \
     :left_keys=>[:category_id], :right_keys=>[:post_id]
-  } 
+  }
  ]
 ```
 
@@ -240,10 +242,10 @@ end
 
  # definition of args
 assert_association(
-  <model_class>, 
-  <association_type>, 
-  <association_name>, 
-  <options>, 
+  <model_class>,
+  <association_type>,
+  <association_name>,
+  <options>,
   <custom_error_message>
 )
 ```
@@ -260,38 +262,38 @@ assert_association(
 If you are using the recommended `:validation_class_methods` plugin in your app, the following instance validation methods are supported:
 
  * `assert_validates_presence()`
- 
+
  * `assert_validates_exact_length()`
- 
+
  * `assert_validates_length_range()`
- 
+
  * `assert_validates_max_length()`
- 
+
  * `assert_validates_min_length()`
- 
+
  * `assert_validates_format()`
- 
+
  * `assert_validates_inclusion()`
- 
+
  * `assert_validates_integer()`
- 
+
  * `assert_validates_numericality()`
- 
+
  * `assert_validates_uniqueness()`
 
  * `assert_validates_acceptance()`
- 
+
  * `assert_validates_confirmation()`
 
 With all valid options checked
 
 ---
 
-### `assert_validates_presence(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_presence(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_presence_of`
 
 Test for validating presence of a model attribute
-    
+
 ```ruby
 it { assert_validates_presence(model, :title) }
 it { model.must_validate_presence_of(:title, { message: '...' }) }
@@ -299,7 +301,7 @@ it { model.must_validate_presence_of(:title, { message: '...' }) }
 <br>
 
 
-### `assert_validates_length(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_length(obj, attribute, opts = {}, msg = nil)`
 alias `:assert_validates_length_of`
 
 Test for validating the length of a model's attribute.
@@ -333,7 +335,7 @@ it { model.must_validate_length_of(:title, { within: 4..12 }) }
 <br>
 
 
-### `assert_validates_exact_length(obj, attribute, exact_length, opts = {}, msg = nil)`
+#### `assert_validates_exact_length(obj, attribute, exact_length, opts = {}, msg = nil)`
 alias: `:assert_validates_exact_length_of`
 
 Test for validating the exact length of a model's attribute.
@@ -345,7 +347,7 @@ it { model.must_validate_exact_length_of(:title, 12, { message: '...' }) }
 <br>
 
 
-### `assert_validates_length_range(obj, attribute, range, opts = {}, msg = nil)`
+#### `assert_validates_length_range(obj, attribute, range, opts = {}, msg = nil)`
 alias: `:assert_validates_length_range_of`
 
 Test for validating the exact length of a model's attribute.
@@ -358,7 +360,7 @@ it { model.must_validate_length_range_of(:title, 4..12, { message: '...' }) }
 <br>
 
 
-### `assert_validates_max_length(obj, attribute, max_length, opts = {}, msg = nil)`
+#### `assert_validates_max_length(obj, attribute, max_length, opts = {}, msg = nil)`
 alias: `:assert_validates_max_length_of`
 
 Test for validating the maximum length of a model's attribute.
@@ -371,7 +373,7 @@ it { model.must_validate_max_length_of(:title, 12, { message: '...' }) }
 <br>
 
 
-### `assert_validates_min_length(obj, attribute, min_length, opts = {}, msg = nil)`
+#### `assert_validates_min_length(obj, attribute, min_length, opts = {}, msg = nil)`
 alias: `:assert_validates_min_length_of`
 
 Test for validating the minimum length of a model's attribute.
@@ -384,7 +386,7 @@ it { model.must_validate_min_length_of(:title, 12, { message: '...' }) }
 <br>
 
 
-## `assert_validates_format(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_format(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_format_of`
 
 Test for validating the format of a model's attribute with a regexp.
@@ -397,7 +399,7 @@ it { model.must_validate_format_of(:title, 12, { with: /[a-z]+/ }) }
 <br>
 
 
-### `assert_validates_inclusion(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_inclusion(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_inclusion_of`
 
 Test for validating that a model's attribute is within a specified range or set of values.
@@ -410,7 +412,7 @@ it { model.must_validate_inclusion_of(:status, { in: [:a, :b, :c] }) }
 <br>
 
 
-### `assert_validates_integer(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_integer(obj, attribute, opts = {}, msg = nil)`
 alias: none
 
 Test for validating that a a model's attribute is an integer.
@@ -423,7 +425,7 @@ it { model.must_validate_integer_of(:author_id, { message: '...' }) }
 <br>
 
 
-### `assert_validates_numericality(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_numericality(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_numericality_of`
 
 Test for validating that a model's attribute is numeric (number).
@@ -436,7 +438,7 @@ it { model.must_validate_numericality_of(:author_id, { message: '...' }) }
 <br>
 
 
-### `assert_validates_uniqueness(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_uniqueness(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_uniqueness_of`
 
 Test for validating that a model's attribute is unique.
@@ -444,12 +446,12 @@ Test for validating that a model's attribute is unique.
 ```ruby
 it { assert_validates_uniqueness(model, :urlslug, { message: '...' }) }
 it { model.must_validate_uniqueness_of(:urlslug, { message: '...' }) }
-``` 
+```
 
 <br>
 
 
-### `assert_validates_acceptance(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_acceptance(obj, attribute, opts = {}, msg = nil)`
 alias: `assert_validates_acceptance_of`
 
 Test for validating the acceptance of a model's attribute.
@@ -462,7 +464,7 @@ it { model.must_validate_acceptance_of(:toc, { message: '...' }) }
 <br>
 
 
-### `assert_validates_confirmation(obj, attribute, opts = {}, msg = nil)`
+#### `assert_validates_confirmation(obj, attribute, opts = {}, msg = nil)`
 alias: `:assert_validates_confirmation_of`
 
 Test for validating the confirmation of a model's attribute.
@@ -478,8 +480,6 @@ it { User.new.must_validate_confirmation_of(:password, { message: '...' }) }
 Each validation assertion have a responding negative test, ie: `refute_validate_presence()`
 
 
-
-
 ### Usage
 
 A model defined with validations like this:
@@ -487,7 +487,7 @@ A model defined with validations like this:
 ```ruby
 class Post < Sequel::Model
   plugin :validation_helpers
-  
+
   def validate
     super
     validates_presence(:title)
@@ -500,18 +500,188 @@ Can be quickly tested like this:
 
 ```ruby
  # <snip...>
-    
+
 let(:m) { Post.first }
-    
-it "shoud validate presence of :title column" do
+
+it "should validate presence of :title column" do
   assert_validates_presence(m, :title)
 end
-    
-it "shoud validate format of :title column with regexp" do
+
+it "should validate format of :title column with regexp" do
   assert_validates_format(m, :title, /\w+/)
 end
 ```
 
+<br>
+<br>
+
+----
+
+<br>
+
+## Plugins
+
+This gem also contains a collection of "helpers" that aid working with Sequel models:
+
+
+#### `assert_timestamped_model(model, opts = {}, msg = nil)`
+
+Quickly test if a model class is timestamped with .plugin(:timestamps) with [Sequel-Timestamps](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/Timestamps.html)
+
+
+```ruby
+ # Declared locally in the Model
+ class Comment < Sequel::Model
+   plugin(:timestamps)
+ end
+ proc { assert_timestamped_model(Comment) }.wont_have_error
+
+ # on a non-timestamped model
+ class Post < Sequel::Model; end
+ proc { assert_timestamped_model(Post) }.must_have_error(/Not a \.plugin\(:timestamps\) model, available plugins are/)
+```
+
+**NOTE!**
+
+You can also pass attributes to the created model in the tests via the `opts` hash like this:
+
+```ruby
+proc { assert_timestamped_model(Comment, {body: "I think...", email: "e@email.com"}) }.wont_have_error
+```
+   
+Timestamps can be declared globally for all models via `Sequel::Model.plugin(:timestamps)` before the models are migrated.
+
+
+#### `assert_timestamped_model_instance(model, opts = {}, msg = nil)`
+
+Test if a model instance is timestamped with the .plugin(:timestamps) via [Sequel-Timestamps](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/Timestamps.html)
+
+```ruby
+let(:m) { Post.create(title: "Dummy") }
+proc { assert_timestamped_model_instance(m) }.wont_have_error
+```
+
+
+You can also test if an updated record is correctly timestamped
+
+```ruby
+m.title = "Updated"
+m.save
+proc { assert_timestamped_model_instance(m, updated_record: true) }.wont_have_error
+```
+
+Or alternatively test if an updated record is wrongly timestamped
+
+```ruby
+let(:m) { Post.create(title: "Dummy", updated_at: Time.now) }
+proc { assert_timestamped_model_instance(m, updated_record: false) }.must_have_error(/expected #.updated_at to be NIL on new record/)
+```
+
+
+<br>
+
+#### `assert_paranoid_model(model, opts = {}, msg = nil)`
+
+Test if a model class is paranoid with .plugin(:paranoid) via [Sequel-Paranoid](https://github.com/sdepold/sequel-paranoid)
+
+```ruby
+# Declared locally in the Model
+class Comment < Sequel::Model
+ plugin(:paranoid)
+end
+proc { assert_paranoid_model(Comment) }.wont_have_error
+
+# on a non-paranoid model
+class Post < Sequel::Model; end
+proc { assert_paranoid_model(Post) }.must_have_error(/Not a plugin\(:paranoid\) model, available plugins are/)
+```
+
+**NOTE!**
+
+You can also pass attributes to the created model in the tests via the `opts` hash like this:
+
+```ruby
+proc { assert_timestamped_model(Comment, {body: "I think...", email: "e@email.com"}) }.wont_have_error
+```
+
+
+<br>
+
+#### `refute_timestamped_model(model, msg = nil)`
+
+Test to ensure a model is NOT declared with .plugin(:timestamps) using [Sequel-Timestamps](http://sequel.jeremyevans.net/rdoc-plugins/classes/Sequel/Plugins/Timestamps.html)
+
+
+Test if a model class is paranoid with .plugin(:paranoid) via [Sequel-Paranoid](https://github.com/sdepold/sequel-paranoid)
+
+```ruby
+class Comment < Sequel::Model
+ plugin(:timestamps)
+end
+proc { refute_timestamped_model(Comment) }.must_have_error(/expected Comment to NOT be a :timestamped model, but it was/)
+
+# on a non-timestamped model
+class Post < Sequel::Model; end
+it { refute_timestamped_model(Post) }
+```
+
+<br>
+
+#### `refute_paranoid_model(model, msg = nil)`
+
+Test to ensure a model is NOT declared with .plugin(:paranoid) using [Sequel-Paranoid](https://github.com/sdepold/sequel-paranoid)
+
+```ruby
+class Comment < Sequel::Model
+ plugin(:paranoid)
+end
+proc { refute_paranoid_model(Comment) }.must_have_error(/expected Comment to NOT be a :paranoid model, but it was/)
+
+# on a non-paranoid model
+class Post < Sequel::Model; end
+it { refute_paranoid_model(Post) }
+```
+
+
+<br>
+
+<br>
+<br>
+
+----
+
+<br>
+
+## Miscellaneous Helpers
+
+This gem also contains a collection of "helpers" that aid working with Sequel models:
+
+<br>
+
+#### `ensure_working_CRUD(obj, attribute)`
+
+Enables quick tests to ensure that the basic CRUD functionality is working correctly for a Model
+
+```ruby
+ensure_working_CRUD(User, :name)
+```
+
+**NOTE!**
+* the passed `_model` argument must be the actual Model class and NOT a string or symbol
+* the passed attribute `_attr` must be a String attribute or the tests will fail
+
+**DEPENDENCIES**
+
+This test depends upon being able to create a new model instance for each test via using
+[Sequel Factory's](https://github.com/mjackson/sequel-factory) `#make()` method
+
+
+<br>
+<br>
+
+----
+
+<br>
 
 ## Installation
 
@@ -537,28 +707,28 @@ $ gem install minitest-sequel
 
 In your project's `spec/spec_helper.rb` or `test/test_helper.rb` file ensure the following code is present:
 
- 
+
 ```ruby   
 gem 'minitest'
-    
+
 require 'minitest/autorun'
 require 'minitest/sequel'  # NB!! can be loaded after minitest/autorun
- 
+
 require 'sqlite3' # using sqlite for tests
-    
+
  # The preferred default validations plugin, which uses class-level methods.
 Sequel::Model.plugin(:validation_class_methods)
-    
+
  # connect to database
 DB = Sequel.sqlite # :memory
-    
+
  ## add migrations and seeds below
-    
+
 DB.create_table(:posts) do
   primary_key :id
   # <snip...>
 end
-    
+
  # <snip...>
 ```
 
@@ -568,24 +738,23 @@ Then in your tests you should be good to go when using the sequel assertions.
 
 ## Development
 
-After checking out the repo, run `bundle install` to install all dependencies. Then, run `rake spec` to run the tests. 
+After checking out the repo, run `bundle install` to install all dependencies. Then, run `rake spec` to run the tests.
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
-which will create a git tag for the version, push git commits and tags, and push the `.gem` file to 
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kematzy/minitest-sequel/issues. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/kematzy/minitest-sequel/issues.
 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-