Skip to content

Update readme to make it clear how to use this gem #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme to make it clear how to use this gem #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,30 @@ Currently compatible Rspec 3.

Here are some examples of the matchers in use:

``` ruby
it { is_expected.to represent(:date_of_birth).as(:birthday) }
it { is_expected.to_not represent(:name).as(:birthday) }
it { is_expected.to_not represent(:date_of_birth) }
```ruby
RSpec.describe TestEntity do

it { is_expected.to represent(:secret).when( :authorized? => true ) }
it { is_expected.to_not represent(:secret).when( :authorized? => false ) }
subject(:entity) { TestEntity }

it { is_expected.to represent(:super_dooper_secret).as(:top_secret).when( :authorized? => true ) }
it { is_expected.to_not represent(:super_dooper_secret).as(:top_secret).when( :authorized? => false ) }
it { is_expected.to represent(:date_of_birth).as(:birthday) }
it { is_expected.to_not represent(:name).as(:birthday) }
it { is_expected.to_not represent(:date_of_birth) }

it { is_expected.to represent(:dog).using(PetEntity) }
it { is_expected.to represent(:cat).as(:kitty).using(PetEntity) }
it { is_expected.to represent(:secret).when(:authorized? => true) }
it { is_expected.to_not represent(:secret).when(:authorized? => false) }

it { is_expected.to represent(:name).with_documentation(type: String) }
it { is_expected.to represent(:super_dooper_secret).as(:top_secret).when(:authorized? => true) }
it { is_expected.to_not represent(:super_dooper_secret).as(:top_secret).when(:authorized? => false) }

it { is_expected.to document(:name).with(type: String, desc: 'Name of the person') }
it { is_expected.to document(:name).type(String).desc('Name of the person') }
it { is_expected.to represent(:dog).using(PetEntity) }
it { is_expected.to represent(:cat).as(:kitty).using(PetEntity) }

it { is_expected.to represent(:name).with_documentation(type: String) }

it { is_expected.to document(:name).with(type: String, desc: 'Name of the person') }
it { is_expected.to document(:name).type(String).desc('Name of the person') }

end
```

## Support for Rspec 2.0.0
Expand Down