validation_examples_matcher 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7883e01d96808f47da22c229ee42a0cf054bdbc2
-  data.tar.gz: edf4af4c65455002654798c338b2ffd811d706f6
+  metadata.gz: 3ace3e8e1efed6fca03a249353e5be6eb1db18d0
+  data.tar.gz: bd3acefb442dfe8d8c6ad997f48f6d881096faf5
 SHA512:
-  metadata.gz: 4c90c3240a86fe87c46eb14f6d2af3b293f8d0542255e3c7851e55602af61b5abe92dd1b84a98b4ba729701ee54301f61db5d698ea2bf2a9b54de3f2fea20901
-  data.tar.gz: badbf6c6b8f23cad31e8e805b863bc9bc9610bfb26a4adc3cc413820898d693d5c03798eb80d7cf6521ef53202e790083d60d594983120533dbc9326ea74dc12
+  metadata.gz: 54d61c7ae81f88aeb9ca2878c12a1799b42c0eeed86d7f4950e23e7d328fde77f8b1b72e764224022670c932c65cefb0da6590e2bdf8476b0d1a079441dc953f
+  data.tar.gz: b21a715342da52f17a716506291f40f9cba03164933fb751a6e151c202cc21b0c40509b4b88a0aa23b20b776e908dbc7de4379e86742753ca7987c8df16c0794

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [v1.0.1](https://github.com/nisshiee/validation_examples_matcher/tree/v1.0.1)
+
+2016-01-31
+
+- NOTHING changed in production code
+- [[#6](https://github.com/nisshiee/validation_examples_matcher/pull/6)] Add README
+- [[#8](https://github.com/nisshiee/validation_examples_matcher/pull/8)] Mesure coverage
+
+## [v1.0.0](https://github.com/nisshiee/validation_examples_matcher/tree/v1.0.0)
+
+2016-01-26
+
+- First Release

data/README.md

@@ -2,9 +2,22 @@
 
 [![Build Status](https://travis-ci.org/nisshiee/validation_examples_matcher.svg?branch=master)](https://travis-ci.org/nisshiee/validation_examples_matcher)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validation_examples_matcher`. To experiment with that code, run `bin/console` for an interactive prompt.
+ValidationExamplesMatcher supports writing rails model's validation specs.
 
-TODO: Delete this and the text above, and describe your gem
+e.g.
+
+```ruby
+RSpec.describe MyModel do
+  ...
+
+  it { is_expected.to be_invalid_on(:name).with(nil) }
+  it { is_expected.to be_invalid_on(:name).with('') }
+  it { is_expected.to be_valid_on(:name).with('my name') }
+end
+```
+
+ValidationExamplesMatcher sets a particular value ― nil, empty string and 'my name' ― actually.
+Then the matcher calls `valid?` or `invalid?` method and checks results of validation.
 
 ## Installation
 
@@ -18,26 +31,71 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+
+Let me show how to use ValidationExamplesMatcher in case of following model.
+
+```ruby
+class MyModel < ActiveRecord::Base
+  validates :name, presence: true
+  validates :name, length: { maxmum: 4 }, on: :create
+end
+```
 
-    $ gem install validation_examples_matcher
+First, you have to define `subject` as target model object.
+It's good to define it as *valid* object.
+Creating object with [factory_girl](https://github.com/thoughtbot/factory_girl) is very nice.
 
-## Usage
+```ruby
+RSpec.define MyModel do
+  subject { FactoryGirl.build(:my_model) }
+  # subject { MyModel.new } => also ok but not recommended
+end
+```
+
+Second, write *invalid case examples* and *valid case examples* using ValidationExamplesMatcher.
+In case of `MyModel`, `:name` attribute is invalid when its' value is nil or empty string.
+`'my name'` is typical valid example.
+
+```ruby
+RSpec.define MyModel do
+  subject { FactoryGirl.build(:my_model) }
+
+  it { is_expected.to be_invalid_on(:name).with(nil) }
+  it { is_expected.to be_invalid_on(:name).with('') }
+  it { is_expected.to be_valid_on(:name).with('my name') }
+end
+```
 
-TODO: Write usage instructions here
+Arguments of `be_invalid_on` or `be_valid_on` indicate attribute name.
+And arguments of `with` chain is a value which will be set to the attribute.
 
-## Development
+`ActiveModel::Validations` can define validations on specific contexts.
+`MyModel` has `length` validation only on `:create` context.
+You can also define validation spec for such case using `on_context` chain.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+RSpec.define MyModel do
+  subject { FactoryGirl.build(:my_model) }
+
+  it { is_expected.to be_invalid_on(:name).with(nil) }
+  it { is_expected.to be_invalid_on(:name).with('') }
+  it { is_expected.to be_valid_on(:name).with('my name') }
+
+  it { is_expected.to be_valid_on(:name).with('4cha').on_context(:create) }
+  it { is_expected.to be_invalid_on(:name).with('5char').on_context(:create) }
+end
+```
+
+## Changelog
 
-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 [rubygems.org](https://rubygems.org).
+see [CHANGELOG.md](./CHANGELOG.md)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validation_examples_matcher.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nisshiee/validation_examples_matcher.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/validation_examples_matcher/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ValidationExamplesMatcher
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/validation_examples_matcher.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '>= 0.11.1', '< 0.12.0'
   spec.add_development_dependency 'activemodel', '~> 4.2.5'
   spec.add_development_dependency 'pry-byebug', '~> 3.3.0'
   spec.add_development_dependency 'rubocop', '>= 0.36.0', '< 0.37.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: validation_examples_matcher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Hirokazu Nishioka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
@@ -66,6 +66,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +147,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md