govuk_admin_template 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# 0.0.5
+
+* Fix gem.files to include all needed files (routes)
+
+# 0.0.4
+
+* Put style guide through parent application controller for accurate rendering
+
+# 0.0.3
+
+* Make style guide available as a mounted route
+
+# 0.0.2
+
+* Add lightweight Javascript framework and modules, ported from Transition
+
+# 0.0.1
+
+* Original gem release including template, styles, jQuery and Bootstrap

data/JAVASCRIPT.md

@@ -0,0 +1,106 @@
+# Admin Javascript
+
+`govuk_admin_template` comes with a lightweight javascript framework that makes it easy to write re-usable modular components, without having to worry about messy instantiation.
+
+## Usage
+
+Javascript modules are specified in markup using `data-` attributes:
+
+```html
+<div data-module="some-module">
+  <strong>Some other markup inside the module</strong>
+</div>
+```
+
+When javascript runs on the page the framework will look for a module at `GOVUKAdmin.Modules.SomeModule`. Note the value of the data attribute has been converted to _camelCase_.
+
+The module will first be instantiated and then will automatically call the module’s `start` method, passing it the element the `data` attribute is on:
+
+```javascript
+module = new GOVUKAdmin.Modules[type]();
+module.start(element);
+```
+
+This automatically limits modules to their containing elements and removes the need for messy inline script tags.
+
+The simplest of modules looks like this:
+
+```javascript
+(function(Modules) {
+  "use strict";
+  Modules.SomeModule = function() {
+    var that = this;
+    that.start = function(element) {
+      // module code
+    }
+  };
+})(window.GOVUKAdmin.Modules);
+```
+
+## Writing modules
+
+Whilst this isn’t prescriptive, it helps if modules look and behave in a similar manner. Modules should live within your app’s `app\assets\javascripts\modules` directory.
+
+### Use `js-` prefixed classes for interaction hooks
+
+Make it clear where a javascript module will be applying behaviour:
+
+```html
+<div data-module="toggle-thing">
+  <a href="/" class="js-toggle">Toggle</a>
+  <div class="js-toggle-target">Target</div>
+</div>
+```
+
+### Declare event listeners at the start
+
+Beginning with a set of event listeners clearly indicates the module’s intentions.
+
+```js
+that.start = function(element) {
+  element.on('click', '.js-toggle', toggle);
+  element.on('click', '.js-cancel', cancel);
+}
+```
+
+Where possible, assign listeners to the module element to minimise the number of listeners and to allow for flexible markup:
+
+```html
+<div data-module="toggle-thing">
+  <a href="/" class="js-toggle">This toggles</a>
+  <div class="js-toggle-target">
+    <p>Some content</p>
+    <a href="/" class="js-toggle">This also toggles</a>
+  </div>
+</div>
+```
+
+### Use data-attributes for configuration
+
+Keep modules flexible by moving configuration to data attributes on the module’s element:
+
+```html
+<div
+  data-module="html-stream"
+  data-url="/some/endpoint"
+  data-refresh-ms="5000">
+  <!-- updates with content from end point -->
+</div>
+```
+
+### Include Jasmine specs
+
+Modules should have their own tests, whether they’re being included with the gem or are app specific.
+
+## Included modules
+
+Found in the [app/assets/javascripts/modules](app/assets/javascripts/modules) directory, with tests in [spec/javascripts/spec/](spec/javascripts/spec/).
+
+File   | Module | Attribute | Description
+------ | ------ | --------- | -----------
+auto_show_modal.js | AutoShowModal | auto-show-modal | Initialise a Boostrap modal on page load and remove markup when closed
+auto_track_event.js | AutoTrackEvent | auto-track-event | Use data attributes to track events in Google Analytics on page load
+filterable_table.js | FilterableTable | filterable-table | Filter the contents of a table, showing only matching rows
+fixed_table_header.js | FixedTableHeader | fixed-table-header | Fix the `<thead>` portion of a table when scrolling offscreen
+selectable_table.js | SelectableTable | selectable-table | Select rows in a table and perform an action on them
+toggle.js | Toggle | toggle | A simple toggle

data/config/routes.rb

@@ -0,0 +1,3 @@
+GovukAdminTemplate::Engine.routes.draw do
+  root :to => 'govuk_admin_template/style_guide#index'
+end

data/lib/govuk_admin_template/version.rb

@@ -1,3 +1,3 @@
 module GovukAdminTemplate
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_admin_template
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -170,11 +170,14 @@ files:
 - app/assets/javascripts/govuk-admin-template.js
 - app/controllers/govuk_admin_template/application_controller.rb
 - app/controllers/govuk_admin_template/style_guide_controller.rb
+- config/routes.rb
 - lib/govuk_admin_template/engine.rb
 - lib/govuk_admin_template/version.rb
 - lib/govuk_admin_template.rb
-- LICENCE.txt
+- JAVASCRIPT.md
+- CHANGELOG.md
 - README.md
+- LICENCE.txt
 homepage: https://github.com/alphagov/govuk_admin_template
 licenses: []
 post_install_message: 
@@ -189,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1997371940354407231
+      hash: -2415206504534781364
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -198,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1997371940354407231
+      hash: -2415206504534781364
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23