accessible-bootstrap3-rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f78520a528d0ce96ea66cc5b05268c6bc73479
-  data.tar.gz: 554f7932620ecfd1f36114fe73c184a631a03940
+  metadata.gz: 52857fb329541dbe468e9db7315672801d9349be
+  data.tar.gz: 63835b60b3f44c98c5857e5a0a10718ca566af63
 SHA512:
-  metadata.gz: f38e58ae121d8b11db37328469c8ebec2e1e51a6267c540a811ad3712625ac7a7ecc99f5a7209a886b97bab9b8288e126696a17a4d0487f7f48202b393d2b766
-  data.tar.gz: e5d9bee78afae880386eb185269835441a0c95b33283f45a2ddb002a89d4efecddc61049d27f8581a1f8474751e6a370a12ea1df3b83d55e770bfbb52622f856
+  metadata.gz: 6678ef35160766dd6719b8024f2ffea08952b44205a7943af16ecfa0cc4fcc0a597aa3013356d3d7de180d81f69fd07b2287bcdbee80175f434f670b39c00aa8
+  data.tar.gz: ced1c7f876e0ceac9aa8e41138ce6606854c8a07143a027668ebc218922e3927777b35698d059aac92a21d7028a854333cca42ab678e0bcfad2e17e5374990ee

data/README.md

@@ -1,6 +1,13 @@
 # Accessible::Bootstrap3::Rails
 
-#### A gem to bring npm package bootstrap3-accessibility-patches into your rails project.
+#### A gem to bring the npm package, accessible-bootstrap3, into your rails project.
+This gem will do it's best to keep the version number in alignment with the accessible-bootstrap3 package version.
+Any changes made the this gem that aren't fallowing a change from the npm package will be denoted with a slight version bump. Then on the next npm package version update we will bring them back into alignment. The versioning may look something like this when they diverge.
+  * accessible-bootstrap3
+    `"version": "0.1.5"`
+  * accessible-bootstrap3-rails
+    `"version": "0.1.51"`
+
 
 ## Installation
 
@@ -10,7 +17,7 @@ Add this line to your application's Gemfile:
 gem 'accessible-bootstrap3-rails'
 ```
 
-And then execute:
+And then run.
 
     $ bundle
 
@@ -24,14 +31,60 @@ Add it and the jQuery dependency to your `application.js`:
 ```
   //= require accessible-bootstrap3/index
 ```
-## If your already using 'jquery >=1.9.1 < 2.0.0' you can leave out the next line
+If you're already using **'jquery >=1.9.1 < 2.0.0'** you can leave out the next line
 
 `//= require jquery/dist/jquery.min.js`
 
-## Usage specs are specified in bootstrap3-accessibility-patches npm package.
+### Rails View Helpers
+
+This Gem ships with a couple view helpers. The first helps with implementing the skip navigation
+feature that comes with accessible-bootstrap3. The second is an method to wrap abbreviations in
+`<abbr>` tags with proper titles. This way screen readers will properly announce the abbreviations one letter at a time.
+
+#### page_header helper
+1) To make use of this feature add the skip navigation link in your application.html.haml
+right at the top of the view template like so.
+
+````
+%body
+  .container
+    = link_to "Skip Navigation", "#heading", id: "skip-nav"
+```
+2) Add the content_for? block at the top of the page under your navigation.
+
+```
+- if content_for?(:page_header)
+    %h1#heading
+      = yield :page_header
+````
+
+3) In each of your view templates that will render inside off the application.html.haml you can then utilize the **page_header** method to set your page heading like so.
+  * The page headers are automatically processed with the wrap_abbrevations method that is described bellow.
+
+```
+## index.html.haml
+
+- page_header "The Heading of Your Choosing (SAAS). Homepage."
+
+%div.landing-page
+  %div
+    %p ...your sites content...
+```
+Now on any page that has a **page_header** you will be able to use the skip navigation link to move passed the navigation and focus directly onto the page_header.
+
+#### wrap_abbrevations helper
+1) Any strings that may contain abbreviations can be processed by the **wrap_abbreviations**
+method like so.
+```ruby
+wrap_abbreviations("NASA homepage.")
+## returns "<abbr title='N A S A'>NASA</abbr> homepage"
+```
+* This method searches the string for groups of uppercase letter characters in groups of two or more and wraps them with the `<abbr>` tag and title. It works on strings with multiple abbreviations and is really useful for dynamically generated strings coming from the database. All the strings are returned with html_safe method already called on them so be careful when using this with dynamic content.
+
 
-> https://www.npmjs.com/package/bootstrap3-accessibility-patches
+## Usage specs as specified in accessible-bootstrap3 npm package.
 
+> https://www.npmjs.com/package/accessible-bootstrap3
 # bootstrap3-accessibility-patches
 
 A package for making your bootstrap3 web app more accessible.

data/accessible-bootstrap3-package.json

@@ -13,14 +13,14 @@
     ]
   ],
   "_from": "accessible-bootstrap3@latest",
-  "_id": "accessible-bootstrap3@0.1.3",
+  "_id": "accessible-bootstrap3@0.1.4",
   "_inCache": true,
   "_installable": true,
   "_location": "/accessible-bootstrap3",
   "_nodeVersion": "5.10.0",
   "_npmOperationalInternal": {
     "host": "packages-12-west.internal.npmjs.com",
-    "tmp": "tmp/accessible-bootstrap3-0.1.3.tgz_1465835491845_0.7610545591451228"
+    "tmp": "tmp/accessible-bootstrap3-0.1.4.tgz_1466028275296_0.4808651462662965"
   },
   "_npmUser": {
     "email": "the-team@reax.io",
@@ -39,8 +39,8 @@
   "_requiredBy": [
     "/"
   ],
-  "_resolved": "https://registry.npmjs.org/accessible-bootstrap3/-/accessible-bootstrap3-0.1.3.tgz",
-  "_shasum": "7b97db39c0aaa695f77bdefa429340ab67a7bf0c",
+  "_resolved": "https://registry.npmjs.org/accessible-bootstrap3/-/accessible-bootstrap3-0.1.4.tgz",
+  "_shasum": "e8e23918f9a71647707429916f581ce585fcbab8",
   "_shrinkwrap": null,
   "_spec": "accessible-bootstrap3@latest",
   "_where": "/Users/brandonhoward/Desktop/code/reax_code/accessible-bootstrap3-rails",
@@ -59,13 +59,13 @@
   "devDependencies": {},
   "directories": {},
   "dist": {
-    "shasum": "7b97db39c0aaa695f77bdefa429340ab67a7bf0c",
-    "tarball": "https://registry.npmjs.org/accessible-bootstrap3/-/accessible-bootstrap3-0.1.3.tgz"
+    "shasum": "e8e23918f9a71647707429916f581ce585fcbab8",
+    "tarball": "https://registry.npmjs.org/accessible-bootstrap3/-/accessible-bootstrap3-0.1.4.tgz"
   },
   "engines": {
     "node": ">=4.2.4"
   },
-  "gitHead": "153a35f08be1997edcb56c36f350194bf49162ff",
+  "gitHead": "78acce28e2df90c9a478e0b69ec77a6c67b098ec",
   "homepage": "https://github.com/ReaxDev/accessible-bootstrap3#readme",
   "license": "MIT",
   "main": "index.js",
@@ -89,5 +89,5 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "version": "0.1.3"
+  "version": "0.1.4"
 }

data/gem-instructions.md

@@ -1,6 +1,13 @@
 # Accessible::Bootstrap3::Rails
 
-#### A gem to bring npm package bootstrap3-accessibility-patches into your rails project.
+#### A gem to bring the npm package, accessible-bootstrap3, into your rails project.
+This gem will do it's best to keep the version number in alignment with the accessible-bootstrap3 package version.
+Any changes made the this gem that aren't fallowing a change from the npm package will be denoted with a slight version bump. Then on the next npm package version update we will bring them back into alignment. The versioning may look something like this when they diverge.
+  * accessible-bootstrap3
+    `"version": "0.1.5"`
+  * accessible-bootstrap3-rails
+    `"version": "0.1.51"`
+
 
 ## Installation
 
@@ -10,7 +17,7 @@ Add this line to your application's Gemfile:
 gem 'accessible-bootstrap3-rails'
 ```
 
-And then execute:
+And then run.
 
     $ bundle
 
@@ -24,11 +31,57 @@ Add it and the jQuery dependency to your `application.js`:
 ```
   //= require accessible-bootstrap3/index
 ```
-## If your already using 'jquery >=1.9.1 < 2.0.0' you can leave out the next line
+If you're already using **'jquery >=1.9.1 < 2.0.0'** you can leave out the next line
 
 `//= require jquery/dist/jquery.min.js`
 
-## Usage specs are specified in bootstrap3-accessibility-patches npm package.
+### Rails View Helpers
+
+This Gem ships with a couple view helpers. The first helps with implementing the skip navigation
+feature that comes with accessible-bootstrap3. The second is an method to wrap abbreviations in
+`<abbr>` tags with proper titles. This way screen readers will properly announce the abbreviations one letter at a time.
+
+#### page_header helper
+1) To make use of this feature add the skip navigation link in your application.html.haml
+right at the top of the view template like so.
+
+````
+%body
+  .container
+    = link_to "Skip Navigation", "#heading", id: "skip-nav"
+```
+2) Add the content_for? block at the top of the page under your navigation.
+
+```
+- if content_for?(:page_header)
+    %h1#heading
+      = yield :page_header
+````
+
+3) In each of your view templates that will render inside off the application.html.haml you can then utilize the **page_header** method to set your page heading like so.
+  * The page headers are automatically processed with the wrap_abbrevations method that is described bellow.
+
+```
+## index.html.haml
+
+- page_header "The Heading of Your Choosing (SAAS). Homepage."
+
+%div.landing-page
+  %div
+    %p ...your sites content...
+```
+Now on any page that has a **page_header** you will be able to use the skip navigation link to move passed the navigation and focus directly onto the page_header.
+
+#### wrap_abbrevations helper
+1) Any strings that may contain abbreviations can be processed by the **wrap_abbreviations**
+method like so.
+```ruby
+wrap_abbreviations("NASA homepage.")
+## returns "<abbr title='N A S A'>NASA</abbr> homepage"
+```
+* This method searches the string for groups of uppercase letter characters in groups of two or more and wraps them with the `<abbr>` tag and title. It works on strings with multiple abbreviations and is really useful for dynamically generated strings coming from the database. All the strings are returned with html_safe method already called on them so be careful when using this with dynamic content.
+
 
-> https://www.npmjs.com/package/bootstrap3-accessibility-patches
+## Usage specs as specified in accessible-bootstrap3 npm package.
 
+> https://www.npmjs.com/package/accessible-bootstrap3

data/lib/accessible/bootstrap3/rails.rb

@@ -1,4 +1,5 @@
 require "accessible/bootstrap3/rails/version"
+require "accessible/bootstrap3/rails/railtie" if defined?(Rails::Railtie)
 
 module Accessible
   module Bootstrap3

data/lib/accessible/bootstrap3/rails/railtie.rb

@@ -0,0 +1,13 @@
+require_relative 'view_helper'
+
+module Accessible
+  module Bootstrap3
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer "accessible.bootstrap3.rails.view_helpers" do
+          ActionView::Base.send :include, ViewHelpers
+        end
+      end
+    end
+  end
+end

data/lib/accessible/bootstrap3/rails/view_helper.rb

@@ -0,0 +1,17 @@
+module Accessible
+  module Bootstrap3
+    module Rails
+      module ViewHelpers
+        def wrap_abbreviations(string)
+          string.enum_for(:scan, /([A-Z]{2,})/).reduce(string) do |acc, _|
+            acc.gsub $1, "<abbr title='#{$1.chars.to_a.join(' ')}'>#{$1}</abbr>"
+          end.html_safe
+        end
+
+        def page_header(header)
+          content_for(:page_header) {wrap_abbreviations(header)}
+        end
+      end
+    end
+  end
+end

data/package.json

@@ -9,6 +9,6 @@
   "author": "Brandon Howard <brandon@reax.io> (brandonrhoward.com)",
   "license": "MIT",
   "dependencies": {
-    "accessible-bootstrap3": "0.1.3"
+    "accessible-bootstrap3": "0.1.4"
   }
 }

data/vendor/assets/javascripts/accessible-bootstrap3/index.js

@@ -7,6 +7,10 @@ $(document).ready(function() {
     return event.keyCode || event.which;
   }
 
+///// Make sure all submenu links are focusable
+  $(".trigger").each(function() {
+    $(this).attr("tabindex", false);
+  });
   //////////////////////////////////////////////////////////////////
   // This code removes the open class from a .dropdown menu,
   // or adds {"display": "none"} css to .sub-menu menu

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accessible-bootstrap3-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - brayhoward
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,9 @@ files:
 - copy.sh
 - gem-instructions.md
 - lib/accessible/bootstrap3/rails.rb
+- lib/accessible/bootstrap3/rails/railtie.rb
 - lib/accessible/bootstrap3/rails/version.rb
+- lib/accessible/bootstrap3/rails/view_helper.rb
 - package.json
 - vendor/assets/javascripts/accessible-bootstrap3/index.js
 - vendor/assets/javascripts/jquery/jquery.js