site_prism-all_there 3.0.8 → 3.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +23 -10
  3. data/lib/site_prism/all_there/version.rb +1 -1
  4. metadata +11 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: acfee24852397b1f4171c9a78365c00f6ea367fb45b64fdd69000e1dd2d5645a
4
- data.tar.gz: 924d966cec06c08da104b0f05e38fb081be4e853f5ca4fc3be66acc1623c64ec
3
+ metadata.gz: bb6c402600520cac3c37f8d97bc3422bf6dcca85e21a5342cc2a913d31d14d57
4
+ data.tar.gz: 4363643353c7bd018c76b2befc65cf4012d679d286b9b225d82e7992c936b32d
5
5
  SHA512:
6
- metadata.gz: 54e430f744b6342f466f1b884955f9554be4ff9810ba6e4996389e56c8fc74b43d207ea59b34a6c75eb7593cc18d7e4974c8e7ada4a718e78b4170b92e51bc72
7
- data.tar.gz: cfb6b03d5030a33011ec48f4baf038d950f0802620784f0b38c11238f54850826bc67ee53621612c3099da20edc2adf0e25329c0948659a87c7f3bf08f4db9c9
6
+ metadata.gz: dfbab9692891e842304945f2b8927ba5d59e4ba2b098a68182f96c362cb60bf6e5c07b0e1a8f1fe3e180411cee51e8a5d9e7f6a6e3ee5259ef455547fc1461ae
7
+ data.tar.gz: 70740a85f3fdd540ef0d174ec14b507ee27551fb673150362b26fdc43eadef4fc1a2bc137c6c9f8b851b2f227b82fd7b96e2bcffbcd02999123c36f788836922
data/README.md CHANGED
@@ -7,34 +7,47 @@
7
7
 
8
8
  ## History
9
9
 
10
- This is the breakout gem from SitePrism to perform recursion checks in the `#all_there?` method
10
+ This is the breakout gem from SitePrism to perform recursion checks in the `#all_there?` method.
11
11
 
12
- This gem is a breakout from `SitePrism::Page#all_there?` and `SitePrism::Section#all_there?` methods from site_prism v2
12
+ This gem was originally broken out from `SitePrism::Page#all_there?` and `SitePrism::Section#all_there?` which were
13
+ methods present in the v2 revision of `site_prism` proper.
13
14
 
14
- The gem is version stable. It is default enabled in `site_prism` v4 and above, no configuration is required!
15
+ The gem is version stable. It is configured by default from `site_prism` v4 onwards, no configuration is required!
15
16
 
16
17
  ## Usage
17
18
 
18
- You can perform recursion either using an in-line keyword arg `recursion` or using a global setting
19
+ You can perform recursion either using an in-line keyword argument (`recursion`), or using a global setting.
19
20
 
20
- When using both it will always look **first** for an in-line parameter
21
+ When using both it will always look **initially** at the in-line supplied keyword argument.
21
22
 
22
23
  ### In-line parameter
23
24
 
24
25
  ```rb
25
26
  your_page = YourPage.new
26
27
 
27
- your_page.all_there?(recursion: :none) # This will do the standard `#all_there?` check on the current page
28
- your_page.all_there?(recursion: :one) # This will do the standard `#all_there?` check on the current page as well recursing into all `:section` or `:sections` objects and then doing the standard `#all_there?` check on those `Section` instances
29
- your_page.all_there?(recursion: :invalid) # This will not perform any checks and just log an error
28
+ # This will do the standard `#all_there?` check on the current page **ONLY**. It will not recurse into
29
+ # any `:section` or `:sections` objects that were defined on the page. It will only perform the `#all_there?` check on
30
+ # the supplied `SitePrism::Section` or `SitePrism::Page`.
31
+ your_page.all_there?(recursion: :none)
32
+
33
+ # This will do the standard `#all_there?` check on the current page as well recursing into all `:section` or `:sections`
34
+ # objects that were defined on the page. It will then perform the `#all_there?` check on all `SitePrism::Section` instances
35
+ your_page.all_there?(recursion: :one)
36
+
37
+ # This will not perform any checks and just log an error
38
+ your_page.all_there?(recursion: :invalid)
30
39
  ```
31
40
 
32
41
  ### Global setting
33
42
 
43
+ Both of these options will do the standard `#all_there?` check on the current page as well recursing into all
44
+ `:section` or `:sections` objects that were defined on the page. It will then perform the `#all_there?` check on all
45
+ `SitePrism::Section` instances found.
46
+
34
47
  ```rb
35
48
  SitePrism.recursion_setting = :one
36
49
  your_page = YourPage.new
37
- your_page.all_there? # This will do the standard `#all_there?` check on the current page as well recursive checks on all `:section` or `:sections` objects -> doing the standard `#all_there?` check on those `SitePrism::Section` instances
50
+ your_page.all_there?
38
51
 
39
52
  # or...
40
53
 
@@ -43,5 +56,5 @@ SitePrism.configure do |config|
43
56
  end
44
57
 
45
58
  your_page = YourPage.new
46
- your_page.all_there? # This will do the standard `#all_there?` check on the current page as well recursive checks on all `:section` or `:sections` objects -> doing the standard `#all_there?` check on those `SitePrism::Section` instances
59
+ your_page.all_there?
47
60
  ```
data/lib/site_prism/all_there/version.rb CHANGED
@@ -4,6 +4,6 @@ module SitePrism
4
4
  module AllThere
5
5
  # @return [String]
6
6
  # Version of the gem
7
- VERSION = '3.0.8'
7
+ VERSION = '3.0.9'
8
8
  end
9
9
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: site_prism-all_there
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.8
4
+ version: 3.0.9
5
5
  platform: ruby
6
6
  authors:
7
7
  - Luke Hill
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-04 00:00:00.000000000 Z
11
+ date: 2026-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rspec
@@ -30,42 +30,42 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 1.84.2
33
+ version: 1.87.0
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 1.84.2
40
+ version: 1.87.0
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rubocop-performance
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 1.26.0
47
+ version: 1.26.1
48
48
  type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 1.26.0
54
+ version: 1.26.1
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: rubocop-rspec
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 3.9.0
61
+ version: 3.10.2
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 3.9.0
68
+ version: 3.10.2
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: site_prism
71
71
  requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
75
75
  version: '4'
76
76
  - - "<"
77
77
  - !ruby/object:Gem::Version
78
- version: '6'
78
+ version: '7'
79
79
  type: :development
80
80
  prerelease: false
81
81
  version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
85
85
  version: '4'
86
86
  - - "<"
87
87
  - !ruby/object:Gem::Version
88
- version: '6'
88
+ version: '7'
89
89
  - !ruby/object:Gem::Dependency
90
90
  name: yard
91
91
  requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
138
138
  - !ruby/object:Gem::Version
139
139
  version: '0'
140
140
  requirements: []
141
- rubygems_version: 3.3.27
141
+ rubygems_version: 3.5.22
142
142
  signing_key:
143
143
  specification_version: 4
144
144
  summary: An extension to SitePrism that enables you to recurse through SitePrism Pages