middleman-aria_current 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff16121cc057d7f72d132ba8babd104ee3a1741f
-  data.tar.gz: 34a9af9b635c01c9bee5e9def7a6f3ec62b27776
+SHA256:
+  metadata.gz: 84cffdd4bf9c52cc6c394ef1b0359cacef0860deff164eb18d43c307fd519631
+  data.tar.gz: aaa0047527f7840a38f6622b87665359f09d56df7bf3db487a38d558730fc732
 SHA512:
-  metadata.gz: 3ff03e7f82183e64b0427745866d4a290011d58856063ea2edce3fd678e2b6bf7df1c195a6459218e05dad7822f32eebeb7be5fb6488b33676e09aab260a2f40
-  data.tar.gz: 9c427e58ee4b02279eb25f6d820d804f49499df4bf705b7a6746d5870c307491bc0ca57b8c0606c48dd51c2152629ec827819b3889455a562b9d1a202b077b7c
+  metadata.gz: dc70df7f9e9745b15e1209da470cc432767d4c5dd12502df0a39e30956618016b88f794e80d89e971acf1b5efc2acc21207aac57ccd576be04d88615eb77ff8b
+  data.tar.gz: e693d2d735fdbf732df9d0d74388b8857732f3d5eb66c881c6ed912c36a9da12388942cb6c1305f79e2069b5d7dec37ff131f6cc2a2f2a0d886b73b0e07a4bd7

data/.gitignore

@@ -1,3 +1,4 @@
 *gem
-/Gemfile.lock
-/pkg
+build
+Gemfile.lock
+pkg

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.6.5

data/CHANGELOG.md

@@ -8,13 +8,26 @@ The format is loosely based on [Keep a Changelog] and this project adheres to
   [Keep a Changelog]: http://keepachangelog.com/
   [Semantic Versioning]: http://semver.org/
 
+## master
+
+## [0.1.2] - 2020-04-03
+
+- Yield block as contents 
+
+- Instead of determining the "current" resource through `String` comparison
+  (including incorporating the resource file's extension), make use of the
+  [`sitemap`][sitemap].
+
+  [sitemap]: [sitemap]: https://middlemanapp.com/advanced/sitemap/#accessing-the-sitemap-from-code
+
+
 ## [0.1.1] - 2017-03-19
 
 ### Changed
 
 - Relaxed `middleman-core` dependency from `~> 4.2` to `~> 4.0`. ([#13])
 
-  [0.1.1]: https://github.com/thoughtbot/middleman-aria_current/compare/v0.1.0...v0.1.1
+  [0.1.1]: https://github.com/thoughtbot/middleman-aria_current/compare/0.1.0...v0.1.1
   [#13]: https://github.com/thoughtbot/middleman-aria_current/pull/13
 
 ## 0.1.0 - 2017-03-17

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+
+We love contributions from everyone.
+By participating in this project,
+you agree to abide by the thoughtbot [code of conduct].
+
+  [code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+
+We expect everyone to follow the code of conduct
+anywhere in thoughtbot's project codebases,
+issue trackers, chatrooms, and mailing lists.
+
+## Contributing Code
+
+1. Fork the repo.
+
+1. Install dependencies:
+
+    ```
+    bundle install
+    ```
+
+1. Make sure the tests pass:
+
+    ```
+    bundle exec rake test
+    ```
+
+1. Make your change, with new passing tests. Follow the [style guide][style].
+
+1. Mention how your changes affect the project to other developers and users in
+   the `CHANGELOG.md` file.
+
+1. Write a [good commit message][commit]. Push to your fork. Submit a pull
+   request.
+
+Others will give constructive feedback.
+This is a time for discussion and improvements,
+and making the necessary changes will be required before we can
+merge the contribution.
+
+  [style]: https://github.com/thoughtbot/guides/tree/master/style
+  [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/README.md

@@ -32,16 +32,74 @@ detailing its usage][article].
 
 ## Usage
 
+middleman-aria_current provides a `current_link_to` helper, which wraps the
+built-in `link_to` helper. It checks the URL of the current visited page and
+outputs an `aria-current` attribute if it matches the URL in the link.
+
+As an example, below is a typical website navigation where we use
+`current_link_to` for each link (using ERB):
+
 ```erb
-<%= current_link_to "Home", "/" %>
-<%= current_link_to "About", "/about" %>
+<nav>
+  <%= current_link_to "Home", "/" %>
+  <%= current_link_to "About", "/about" %>
+</nav>
 ```
 
+Now, when you visit `/about`, the link for that page will be given the
+`aria-current` attribute:
+
 ```html
-<a href="/" aria-current="page">Home</a>
-<a href="/about">About</a>
+<nav>
+  <a href="/">Home</a>
+  <a href="/about" aria-current="page">About</a>
+</nav>
 ```
 
+---
+
+By default, `current_link_to` will output the `page` value for `aria-current`.
+You can also pass it one of `aria-current`’s other accepted values: `step`,
+`location`, `date`, `time`, `true`, or `false`:
+
+```erb
+<%= current_link_to "Step 1", "/step-1", aria_current: "step" %>
+<%= current_link_to "Step 2", "/step-2", aria_current: "step" %>
+<%= current_link_to "Step 3", "/step-3", aria_current: "step" %>
+```
+
+Provided that you are currently visiting `/step-2`, the output will be:
+
+```html
+<a href="/step-1">Step 1</a>
+<a href="/step-2" aria-current="step">Step 2</a>
+<a href="/step-3">Step 3</a>
+```
+
+---
+
+For styling current links, you can use a [CSS attribute selector][selector_mdn]:
+
+```css
+[aria-current]:not([aria-current="false"]) {
+  font-weight: bold;
+}
+```
+
+Note that we _exclude_ styling the link if `aria-current` has a value of
+`false`. This is because `false` is a valid and useful value for denoting a link
+that does not represent the current item within a set.
+
+  [selector_mdn]: https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors
+
+## Contributing
+
+See the [contributing document].
+Thank you, [contributors]!
+
+  [contributing document]: CONTRIBUTING.md
+  [contributors]: https://github.com/thoughtbot/middleman-aria_current/graphs/contributors
+
 ## License
 
 middleman-aria_current is copyright © 2017 Tyson Gach and thoughtbot, inc.

data/lib/middleman-aria_current/extension.rb

@@ -1,26 +1,23 @@
 require "middleman-core"
 
 class AriaCurrent < ::Middleman::Extension
-  FILE_EXTENSION = /\.(\w*)$/
-
   helpers do
     def current_link_to(*arguments, aria_current: "page", **options, &block)
       if block_given?
-        text = capture(&block)
         path = arguments[0]
       else
-        text = arguments[0]
         path = arguments[1]
       end
 
-      link_options = options
-      current_path = current_page.url.to_s.gsub(FILE_EXTENSION, "")
+      link_options = options.dup
+
+      uri = URI.parse(path.to_s)
 
-      if current_path == path
+      if current_resource == sitemap.find_resource_by_path(uri.path)
         link_options.merge!("aria-current" => aria_current)
       end
 
-      link_to(text, path, link_options)
+      link_to(*arguments, link_options, &block)
     end
   end
 end

data/middleman-aria_current.gemspec

@@ -3,15 +3,20 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-aria_current"
-  s.version     = "0.1.1"
+  s.version     = "0.1.2"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Tyson Gach", "Sean Doyle"]
   s.email       = ["tyson@thoughtbot.com", "sean@thoughtbot.com"]
   s.homepage    = "https://github.com/thoughtbot/middleman-aria_current"
-  s.summary     = <<-HERE
+  s.summary     = <<-SUM
 A Middleman extension for indicating a current (active) link
 using `aria-current`.
-  HERE
+  SUM
+  s.summary     = <<-DESC
+middleman-aria_current provides a `current_link_to` helper, which wraps the
+built-in `link_to` helper. It checks the URL of the current visited page and
+outputs an `aria-current` attribute if it matches the URL in the link.
+  DESC
   s.license     = "MIT"
 
   s.files         = `git ls-files`.split("\n")
@@ -19,7 +24,6 @@ using `aria-current`.
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "aruba", "~> 0.14"
   s.add_development_dependency "capybara", "~> 2.13"
   s.add_development_dependency "cucumber", "~> 2.4"
   s.add_development_dependency "middleman-cli", "~> 4.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-aria_current
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tyson Gach
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +107,7 @@ files:
 - ".hound.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.md
 - README.md
@@ -128,7 +115,6 @@ files:
 - circle.yml
 - features/aria_current.feature
 - features/support/env.rb
-- fixtures/aria_current-app/build/index.html
 - fixtures/aria_current-app/config.rb
 - fixtures/aria_current-app/source/different-url.html.erb
 - fixtures/aria_current-app/source/foo-bar.html.erb
@@ -157,11 +143,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A Middleman extension for indicating a current (active) link using `aria-current`.
+summary: middleman-aria_current provides a `current_link_to` helper, which wraps the
+  built-in `link_to` helper. It checks the URL of the current visited page and outputs
+  an `aria-current` attribute if it matches the URL in the link.
 test_files:
 - features/aria_current.feature
 - features/support/env.rb

data/fixtures/aria_current-app/build/index.html

@@ -1 +0,0 @@
-<a href="/" aria_current="page">Home</a>