rspec-file_fixtures 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c78567396d3fd63b7f4daafa0cb226bcb0356889a6a55b7998e1121b49c7657e
-  data.tar.gz: 00a465a84406eaa3e859b0c1afc1f1bb9f811d2efe5771c33cfabc31be0c8f48
+  metadata.gz: 5194a0d2db316e9e13a780c7e33a1af9a6ea1869c0ab254ee3e462fceb446ecc
+  data.tar.gz: 734ed79bf2a160cd694cf3a5a8be8eef3278a08ae7c2aae2a00c6d12b263b4ba
 SHA512:
-  metadata.gz: aa6d335a04dc1271cc4f46323ea06f12431edbce2935414e5c7cf838eb5df2d3d945be8b54707292494e3201d26f90d40a8c982c11e371f69b428c0546fe5164
-  data.tar.gz: 04b06c35060234ca74e00bcdc5b747681fc5ae71cd2b184839393f269bb61c23a5bd0524a0675ccb9f838ba7eec878f72e6a5c2be98e2fcdab873d89b0996d20
+  metadata.gz: 1ef7bdc977c831a897242bc1e215865cd7b3c7246cf612e020f51fe1a90242f2e4ce6447eac47c0f0cb654558e44f9b86966166bd3495bf636225c6e441c5e72
+  data.tar.gz: d34793287afaf62c2a5e35c5337031b969ec034917f4a29761eac902325f594f81535d2380e01357c08e6aa2072c0603198a107f1b263783a474ce5c6655a7ed

data/.gitignore

@@ -12,3 +12,4 @@
 *.gem
 
 .byebug_history
+/rspec-documentation/bundle/

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.7.8

data/Gemfile

@@ -5,12 +5,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-file_fixtures.gemspec
 gemspec
 
-gem 'devpack', '~> 0.4.0'
-gem 'nokogiri', '~> 1.11'
-gem 'rake', '~> 12.0'
-gem 'rspec', '~> 3.0'
+gem 'devpack', '~> 0.4.1'
+gem 'nokogiri', '~> 1.15'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.12'
+gem 'rspec-documentation', '~> 0.0.5'
 gem 'rspec-its', '~> 1.3'
-gem 'rubocop', '~> 1.10'
-gem 'rubocop-rake', '~> 0.5.1'
-gem 'rubocop-rspec', '~> 2.1'
+gem 'rubocop', '~> 1.52'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.22'
 gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -2,82 +2,107 @@ PATH
   remote: .
   specs:
     rspec-file_fixtures (0.1.6)
-      rspec (~> 3.0)
+      rspec (~> 3.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    concurrent-ruby (1.1.8)
-    devpack (0.4.0)
-    diff-lcs (1.4.4)
-    i18n (1.8.9)
+    concurrent-ruby (1.2.2)
+    devpack (0.4.1)
+    diff-lcs (1.5.0)
+    htmlbeautifier (1.4.2)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.5.0)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mini_portile2 (2.8.2)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    paint (2.2.1)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    paint (2.3.0)
+    paintbrush (0.1.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redcarpet (3.6.0)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rouge (4.1.2)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-documentation (0.0.5)
+      htmlbeautifier (~> 1.4)
+      kramdown (~> 2.4)
+      kramdown-parser-gfm (~> 1.1)
+      nokogiri (~> 1.15)
+      paintbrush (~> 0.1.3)
+      redcarpet (~> 3.6)
+      rouge (~> 4.1)
+      rspec (~> 3.12)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
+      rspec-support (~> 3.12.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.10.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     strong_versions (0.4.5)
       i18n (>= 0.5)
       paint (~> 2.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  devpack (~> 0.4.0)
-  nokogiri (~> 1.11)
-  rake (~> 12.0)
-  rspec (~> 3.0)
+  devpack (~> 0.4.1)
+  nokogiri (~> 1.15)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rspec-documentation (~> 0.0.5)
   rspec-file_fixtures!
   rspec-its (~> 1.3)
-  rubocop (~> 1.10)
-  rubocop-rake (~> 0.5.1)
-  rubocop-rspec (~> 2.1)
+  rubocop (~> 1.52)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.22)
   strong_versions (~> 0.4.5)
 
 BUNDLED WITH
-   2.2.33
+   2.4.13

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Bob Farrell
+Copyright (c) 2023 Robert Farrell
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -1,3 +1,5 @@
+project=rspec-file_fixtures
+
 .PHONY: all
 all: test
 
@@ -6,3 +8,10 @@ test:
 	bundle exec rspec
 	bundle exec rubocop
 	bundle exec strong_versions
+	bundle exec rspec-documentation
+
+.PHONY: publish
+publish:
+	@RSPEC_DOCUMENTATION_URL_ROOT='/$(project)' bundle exec rspec-documentation
+	@rsync --delete -r rspec-documentation/bundle/ docs01.bob.frl:/mnt/docs/$(project)/
+	@echo 'Published.'

data/README.md

@@ -2,73 +2,13 @@
 
 A simple and convenient file fixture loader for [_RSpec_](https://rspec.info/).
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rspec-file_fixtures', '~> 0.1.6'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rspec-file_fixtures
-
-## Usage
-
-Load the gem in your test environment (e.g. in `spec/spec_helper.rb`):
-
-```ruby
-require 'rspec/file_fixtures'
-```
-
-Use the `fixture` helper method to load a fixture from `spec/fixtures`:
-
-```ruby
-let(:my_fixture) { fixture('fixture.json') }
-```
-
-Use the returned `Fixture` object's various methods in your tests:
-
-```ruby
-it 'parses JSON data' do
-  expect(subject.load(my_fixture.read)).to eql my_fixture.from_json
-end
-```
-
 ```ruby
-it 'contains same filenames as fixture directory' do
-  # `#dirname` delegated to underlying `Pathname` object, returning a new `Pathname` instance:
-  expect(subject.created_files).to eql my_fixture.dirname.entries
-end
+let(:my_fixture) { fixture('my_fixture.json').read }
 ```
 
-The following methods are provided on the `Fixture` object:
-
-|Method|Definition|
-|-|-|
-|`#read`|Read the contents of the fixture file as a string|
-|`#path`|The absolute path to the fixture file|
-|`#from_json`|The parsed _JSON_ content from the file|
-|`#from_yaml`|The parsed _YAML_ content from the file (aliased as `#from_yml`)|
-|`#from_xml`|The parsed _XML_ content from the file (requires the [_Nokogiri_](https://nokogiri.org/) gem and returns a `Nokogiri::XML::Document`)|
-
-Methods not specifically defined above are delegated to the underlying `Pathname` object (`#join`, `#dirname`, `#mkpath`, etc.). See the [Pathname documentation](https://ruby-doc.org/stdlib-2.7.5/libdoc/pathname/rdoc/Pathname.html) for more details.
-
-### Symbolize Names
+## Documentation
 
-By default `Fixture#from_yaml` and `Fixture#from_json` symbolize all keys in their output. To disable this behaviour, pass `symbolize_names: false` to either method. A shorthand version of this is available by simply passing `false` as the only parameter:
-
-```ruby
-  expect(subject.load(my_fixture.from_yaml(symbolize_names: false))).to eql({ 'foo' => 'bar' })
-  expect(subject.load(my_fixture.from_json(symbolize_names: false))).to eql({ 'foo' => 'bar' })
-  expect(subject.load(my_fixture.from_yaml(false))).to eql({ 'foo' => 'bar' })
-  expect(subject.load(my_fixture.from_json(false))).to eql({ 'foo' => 'bar' })
-```
+Visit the [Documentation](https://docs.bob.frl/rspec-file_fixtures) for full setup and usage instructions.
 
 ## License
 

data/lib/rspec_file_fixtures/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RSpecFileFixtures
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/rspec-documentation/pages/000-Introduction.md

@@ -0,0 +1,33 @@
+# Introduction
+
+_RSpec::FileFixtures_ provides convenient and consistent access to fixture data in _RSpec_.
+
+## Installation
+
+Add the following to your `Gemfile` in your `:test` group:
+
+```ruby
+gem 'rspec-file_fixtures', '~> 0.1.6'
+```
+
+## Setup
+
+Enable the _RSpec_ extension is your spec helper:
+
+```ruby
+# spec/spec_helper.rb
+
+require 'rspec/file_fixtures'
+```
+
+## Usage
+
+Use the provided `fixture` helper anywhere in your tests to load content from `spec/fixtures/`:
+
+```rspec:json
+subject { fixture('example.json').read }
+
+it { is_expected.to include '{"key":"value"}' }
+```
+
+See the [Usage](usage.html) section for available extensions.

data/rspec-documentation/pages/010-Usage/010-JSON.md

@@ -0,0 +1,21 @@
+# JSON
+
+_JSON_ fixtures can be parsed into a _Ruby_ object using the `#from_json` method.
+
+This is equivalent to `JSON.parse(..., symbolize_names: true)`.
+
+```rspec
+subject { fixture('example.json').from_json }
+
+it { is_expected.to eql({ key: 'value' }) }
+```
+
+## Symbolized Names
+
+Keys are symbolized by default. If you prefer to work with strings, pass `symbolize_names: false`:
+
+```rspec
+subject { fixture('example.json').from_json(symbolize_names: false) }
+
+it { is_expected.to eql({ 'key' => 'value' }) }
+```

data/rspec-documentation/pages/010-Usage/020-YAML.md

@@ -0,0 +1,21 @@
+# YAML
+
+_YAML_ fixtures can be parsed into a _Ruby_ object using the `#from_yaml` method.
+
+This is equivalent to `YAML.safe_load(..., symbolize_names: true)`.
+
+```rspec
+subject { fixture('example.yaml').from_yaml }
+
+it { is_expected.to eql({ key: 'value' }) }
+```
+
+## Symbolized Names
+
+Keys are symbolized by default. If you prefer to work with strings, pass `symbolize_names: false`:
+
+```rspec
+subject { fixture('example.yaml').from_yaml(symbolize_names: false) }
+
+it { is_expected.to eql({ 'key' => 'value' }) }
+```

data/rspec-documentation/pages/010-Usage/030-XML.md

@@ -0,0 +1,11 @@
+# XML
+
+_XML_ fixtures can be parsed into a _Ruby_ [Nokogiri::XML::Document](https://nokogiri.org/rdoc/Nokogiri/XML/Document) object using the `#from_yaml` method.
+
+_Nokogiri_ is not a hard dependency of _Rspec::FileFixtures_ so you must install and require _Nokogiri_ yourself to use this feature.
+
+```rspec
+subject { fixture('example.xml').from_xml }
+
+it { is_expected.to be_a Nokogiri::XML::Document }
+```

data/rspec-documentation/pages/010-Usage/040-Pathname.md

@@ -0,0 +1,21 @@
+# Pathname
+
+The object returned from each call to `fixture` delegates to its underlying [`Pathname`](https://docs.ruby-lang.org/en/3.2/Pathname.html) object, so you can call `#path`, `#read`, `#dirname` etc. just like a regular _Ruby_ `Pathname` object.
+
+```rspec:xml
+subject { fixture('example.xml').read }
+
+it { is_expected.to include '<a type="integer">1</a>' }
+```
+
+```rspec
+subject { fixture('example.json').dirname.to_s }
+
+it { is_expected.to eql 'spec/fixtures' }
+```
+
+```rspec
+subject { fixture('example.json').relative? }
+
+it { is_expected.to be true }
+```

data/rspec-documentation/pages/010-Usage.md

@@ -0,0 +1,21 @@
+# Usage
+
+_RSpec::FileFixtures_ provides a helper named `fixture` available in all specs. This method receives a filename as a string and the provided file is loaded from `spec/fixtures/`.
+
+Fetch the fixture's path:
+
+```rspec
+subject { fixture('example.yaml').path }
+
+it { is_expected.to end_with '/spec/fixtures/example.yaml' }
+```
+
+Read the fixture's content:
+
+```rspec:yaml
+subject { fixture('example.yaml').read }
+
+it { is_expected.to include 'key: value' }
+```
+
+A number of extensions are provided to assist dealing with common data types. See each item in the Usage section for details.

data/rspec-documentation/pages/500-License.md

@@ -0,0 +1,25 @@
+# License
+
+## MIT
+
+The MIT License (MIT)
+
+Copyright (c) 2023 Robert Farrell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/rspec-documentation/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rspec/file_fixtures'

data/rspec-file_fixtures.gemspec

@@ -7,15 +7,17 @@ Gem::Specification.new do |spec|
   spec.version       = RSpecFileFixtures::VERSION
   spec.authors       = ['Bob Farrell']
   spec.email         = ['git@bob.frl']
+  spec.licenses      = ['MIT']
 
   spec.summary       = 'Simple file fixture loader for RSpec'
   spec.description   = 'Load files from test fixtures directory quickly and conveniently'
   spec.homepage      = 'https://github.com/bobf/rspec-file_fixtures'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -23,5 +25,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = []
   spec.require_paths = ['lib']
-  spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'rspec', '~> 3.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-file_fixtures
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 description: Load files from test fixtures directory quickly and conveniently
 email:
 - git@bob.frl
@@ -47,6 +47,14 @@ files:
 - lib/rspec_file_fixtures.rb
 - lib/rspec_file_fixtures/fixture.rb
 - lib/rspec_file_fixtures/version.rb
+- rspec-documentation/pages/000-Introduction.md
+- rspec-documentation/pages/010-Usage.md
+- rspec-documentation/pages/010-Usage/010-JSON.md
+- rspec-documentation/pages/010-Usage/020-YAML.md
+- rspec-documentation/pages/010-Usage/030-XML.md
+- rspec-documentation/pages/010-Usage/040-Pathname.md
+- rspec-documentation/pages/500-License.md
+- rspec-documentation/spec_helper.rb
 - rspec-file_fixtures.gemspec
 homepage: https://github.com/bobf/rspec-file_fixtures
 licenses:
@@ -54,6 +62,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/bobf/rspec-file_fixtures
   source_code_uri: https://github.com/bobf/rspec-file_fixtures
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -62,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Simple file fixture loader for RSpec