middleman-aria_current 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed1a17eadfd68508ba8bf1c572cdfa910b878f9a
+  data.tar.gz: 86d2dfaa60bc5fb9d7f8c9344f4b00783bc26052
+SHA512:
+  metadata.gz: db356f86365f428dba966a77b1d9399d7ccd3ab307a1a6a2e30c1f5e5f51167152c3ffcd812b8d3babe388b8e75daa12ca06364963cc4f99bf3b4dfe60ef76fc
+  data.tar.gz: 3d10bf8cd475d29f1e0012f943b35ba88a03a6bde11e706cb360d6aaf82808bbc079afed1a3d9ba418d4f3dde1312fd171958284ba4396aeac3cbd8dba68fc21

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/pkg

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change log
+
+All notable changes to this project will be documented in this file.
+
+The format is loosely based on [Keep a Changelog] and this project adheres to
+[Semantic Versioning].
+
+  [Keep a Changelog]: http://keepachangelog.com/
+  [Semantic Versioning]: http://semver.org/
+
+## 0.1.0 - 2017-03-17
+
+### Added
+
+- First release!

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "middleman-cli"
+end
+
+group :development do
+  gem "rake"
+  gem "rdoc"
+  gem "yard"
+end
+
+group :test do
+  gem "cucumber"
+  gem "aruba"
+  gem "rspec"
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Tyson Gach and thoughtbot, inc.
+
+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/README.md

@@ -0,0 +1,57 @@
+# middleman-aria_current
+
+A [Middleman] extension for indicating a current (active) link using
+[`aria-current`][spec].
+
+If you're new to `aria-current`, [Léonie Watson wrote a _wonderful_ article
+detailing its usage][article].
+
+  [Middleman]: https://middlemanapp.com/
+  [spec]: https://www.w3.org/TR/wai-aria-1.1/#aria-current
+  [article]: http://tink.uk/using-the-aria-current-attribute/
+
+# Install
+
+1. Add middleman-aria_current to your `Gemfile`:
+
+  ```
+  gem "middleman-aria_current"
+  ```
+
+1. Run:
+
+  ```
+  bundle install
+  ```
+
+## Usage
+
+```erb
+<%= current_link_to "Home", "/" %>
+```
+
+```html
+<a href="/" aria-current="page">Home</a>
+```
+
+## License
+
+middleman-aria_current is Copyright (c) 2017 Tyson Gach and thoughtbot, inc.
+It is free software, and may be redistributed
+under the terms specified in the [LICENSE] file.
+
+  [LICENSE]: LICENSE.md
+
+## About
+
+![thoughtbot](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg)
+
+middleman-aria_current is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community]
+or [hire us][hire] to help build your product.
+
+  [community]: https://thoughtbot.com/community?utm_source=github
+  [hire]: https://thoughtbot.com/hire-us?utm_source=github

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new(:cucumber, "Run features that should pass") do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict"
+end
+
+require "rake/clean"
+
+task test: ["cucumber"]
+
+task default: :test

data/features/aria_current.feature

@@ -0,0 +1,41 @@
+Feature: ARIA current link
+
+  Scenario: Without the aria_current parameter
+    Given a fixture app "aria_current-app"
+    Given a successfully built app at "aria_current-app" with flags "--verbose"
+    Then the file "build/without-params.html" should contain:
+    """
+    <a href="/without-params" aria-current="page">Home</a>
+    """
+
+  Scenario: With the aria_current parameter
+    Given a fixture app "aria_current-app"
+    Given a successfully built app at "aria_current-app" with flags "--verbose"
+    Then the file "build/with-params.html" should contain:
+    """
+    <a href="/with-params" aria-current="step">Home</a>
+    """
+
+  Scenario: when the link's URL is not the current page's URL
+    Given a fixture app "aria_current-app"
+    Given a successfully built app at "aria_current-app" with flags "--verbose"
+    Then the file "build/different-url.html" should contain:
+    """
+    <a href="/other-page">Home</a>
+    """
+
+  Scenario: when the helper is invoked with a block
+    Given a fixture app "aria_current-app"
+    Given a successfully built app at "aria_current-app" with flags "--verbose"
+    Then the file "build/with-block.html" should contain:
+    """
+    <a href="/with-block" aria-current="page">Hello</a>
+    """
+
+  Scenario: when the current page's URL contains a portion of the link's URL (i.e. /foo-bar and /foo)
+    Given a fixture app "aria_current-app"
+    Given a successfully built app at "aria_current-app" with flags "--verbose"
+    Then the file "build/foo-bar.html" should contain:
+    """
+    <a href="/foo">Hello</a>
+    """

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-aria_current')

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

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

data/fixtures/aria_current-app/config.rb

@@ -0,0 +1 @@
+activate :aria_current

data/fixtures/aria_current-app/source/different-url.html.erb

@@ -0,0 +1 @@
+<%= current_link_to "Home", "/other-page" %>

data/fixtures/aria_current-app/source/foo-bar.html.erb

@@ -0,0 +1 @@
+<%= current_link_to "Hello", "/foo" %>

data/fixtures/aria_current-app/source/with-block.html.erb

@@ -0,0 +1 @@
+<%= current_link_to("/with-block") { "Hello" } %>

data/fixtures/aria_current-app/source/with-params.html.erb

@@ -0,0 +1 @@
+<%= current_link_to "Home", "/with-params", aria_current: "step" %>

data/fixtures/aria_current-app/source/without-params.html.erb

@@ -0,0 +1 @@
+<%= current_link_to "Home", "/without-params" %>

data/lib/middleman-aria_current.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+Middleman::Extensions.register :aria_current do
+  require "middleman-aria_current/extension"
+  AriaCurrent
+end

data/lib/middleman-aria_current/extension.rb

@@ -0,0 +1,26 @@
+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, "")
+
+      if current_path == path
+        link_options.merge!("aria-current" => aria_current)
+      end
+
+      link_to(text, path, link_options)
+    end
+  end
+end

data/middleman-aria_current.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-aria_current"
+  s.version     = "0.1.0"
+  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
+A Middleman extension for indicating a current (active) link
+using `aria-current`.
+  HERE
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "middleman-core", "~> 4.2"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: middleman-aria_current
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyson Gach
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- tyson@thoughtbot.com
+- sean@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- 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
+- fixtures/aria_current-app/source/with-block.html.erb
+- fixtures/aria_current-app/source/with-params.html.erb
+- fixtures/aria_current-app/source/without-params.html.erb
+- lib/middleman-aria_current.rb
+- lib/middleman-aria_current/extension.rb
+- middleman-aria_current.gemspec
+homepage: https://github.com/thoughtbot/middleman-aria_current
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Middleman extension for indicating a current (active) link using `aria-current`.
+test_files:
+- features/aria_current.feature
+- features/support/env.rb