Skip to content

Commit

Permalink
Fix Operations documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
k-dubil authored and flash-gordon committed Jul 7, 2024
1 parent a337920 commit 61bc34a
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions docsite/source/operations.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ is_zero.call(10).success?

> Returns true if one of its arguments is true. Similar to Ruby's `||` operator
Argument 1 | Argument 2 | Result
--- | --- | ---
true | true | true
true | false | true
false | true | true
false | false | false
| Argument 1 | Argument 2 | Result |
| ---------- | ---------- | ------ |
| true | true | true |
| true | false | true |
| false | true | true |
| false | false | false |

``` ruby
is_number = build do
Expand All @@ -31,20 +31,20 @@ end

is_number.call(1).success? # => true
is_number.call(2.0).success? # => true
is_number.call('3').success? # => false
is_number.call('3').success? # => true
is_number.call('four').success? # => false
```

### Implication (`>`, `then`, `implication`)

> Similar to Ruby's `if then` expression
Argument 1 | Argument 2 | Result
--- | --- | ---
true | true | true
true | false | false
false | true | false
false | false | false
| Argument 1 | Argument 2 | Result |
| ---------- | ---------- | ------ |
| true | true | true |
| true | false | false |
| false | true | false |
| false | false | false |

``` ruby
is_empty = build do
Expand All @@ -65,12 +65,12 @@ is_empty.call({key: "value"}).success? # => false

> Returns true if at most one of its arguments are valid; otherwise, false
Argument 1 | Argument 2 | Result
--- | --- | ---
true | true | false
true | false | true
false | true | true
false | false | false
| Argument 1 | Argument 2 | Result |
| ---------- | ---------- | ------ |
| true | true | false |
| true | false | true |
| false | true | true |
| false | false | false |

``` ruby
is_not_zero = build do
Expand All @@ -86,21 +86,21 @@ is_not_zero.call(-1).success? # => true

> Returns true if both of its arguments are true. Similar to Ruby's `&&` operator
Argument 1 | Argument 2 | Result
--- | --- | ---
true | true | true
true | false | false
false | true | false
false | false | false
| Argument 1 | Argument 2 | Result |
| ---------- | ---------- | ------ |
| true | true | true |
| true | false | false |
| false | true | false |
| false | false | false |

``` ruby
is_middle_aged = build do
gt?(30) & lt?(50)
end

is_child.call(20).success? # => false
is_child.call(40).success? # => true
is_child.call(60).success? # => true
is_middle_aged.call(20).success? # => false
is_middle_aged.call(40).success? # => true
is_middle_aged.call(60).success? # => false
```

### Attribute (`attr`)
Expand Down Expand Up @@ -137,13 +137,13 @@ is_only_odd.call([4, 6, 8]).success? # => false
> Applies input to an array of predicates. Returns true if all predicates yield true. Similar to `Array#all?`
``` ruby
is_natrual_and_odd = build do
set(int?, odd?, gt?(1))
is_natural_and_odd = build do
set { [int?, odd?, gt?(1)] }
end

is_natrual_and_odd.call('5').success? # => false
is_natrual_and_odd.call(5).success? # => true
is_natrual_and_odd.call(-1).success? # => false
is_natural_and_odd.call('5').success? # => NoMethodError: undefined method `odd?' for "5":String
is_natural_and_odd.call(5).success? # => true
is_natural_and_odd.call(-1).success? # => false
```

### Negation (`negation`, `not`)
Expand All @@ -152,7 +152,7 @@ is_natrual_and_odd.call(-1).success? # => false
``` ruby
is_present = build do
negation(empty?)
negation { empty? }
end

is_present.call([1]).success? # => true
Expand All @@ -166,7 +166,7 @@ is_present.call("").success? # => false
``` ruby
is_named = build do
key name: [:user, :name] do
str? & negation(empty?)
str? & negation { empty? }
end
end

Expand Down

0 comments on commit 61bc34a

Please sign in to comment.