govuk_publishing_components 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 112d914f742fe9a3fb552c481fd41899c55b1b99
-  data.tar.gz: b5a2aa4d2ad223425a9e9c7fc7174a9663ee499c
+  metadata.gz: 482dfbc7d06559bff8317484a04b836a0f7245e2
+  data.tar.gz: f0ea67a5f4e111ee694a8a57139790fa060ebdc1
 SHA512:
-  metadata.gz: 32fdc5bf20e0541161d5455753bbba1e7de4c5282b4e30ed5f4b7698be3a0cbe7b3f81085da2691fc4c19cef53ec93d51689480103859cff09fabc9a8804684a
-  data.tar.gz: 9337506e241b726f9a03ebb07090d0305fc51da9e02d25b1bcba76c177d413d3ef4fbe235164c5c6c1cdc3b81ac8bd0371a22c51cfe7cd23001b92fa664a6a3f
+  metadata.gz: b1c8c48a5c86712bef8a7150dc6445393dc196a01d42f848ec32b6bb6695e066f6d98f1bf8bc272b9b42a1533ba2c748115dd442878fed7f53edc83a155711ce
+  data.tar.gz: e24e979e709e2cf07582e2029e35ca7a95cd5a543b13870609524e7661ecac60348a2bf602bba51d92e70e8621dafcd04633485c645e9494820585f522d9a000

data/README.md

@@ -2,7 +2,32 @@
 
 A gem to document components in GOV.UK frontend applications.
 
-## Usage
+![Screenshot of component guide](docs/screenshot.png)
+
+## Write components in your application
+
+Components are packages of template, style, behaviour and documentation that live in your application.
+
+A component must:
+* [meet the component principles](docs/component_principles.md)
+* [follow component conventions](docs/component_conventions.md)
+
+A lead paragraph component would be included in a template like this:
+
+```erb
+<%= render 'components/lead-paragraph', text: "A description is one or two leading sentences" %>
+```
+
+## Set up a component guide
+
+This gem creates a component guide for all your application’s components.
+
+An example guide this gem created for government-frontend:
+https://government-frontend.herokuapp.com/component-guide
+
+The guide includes your application’s `application.scss` and `application.js` files by default. This is [configurable](#configuration).
+
+### Install gem
 
 Add this line to your application's Gemfile in the [development and test groups](http://bundler.io/v1.12/groups.html#grouping-your-dependencies):
 
@@ -29,53 +54,9 @@ end
 If your application was government-frontend the component guide would be at:
 http://government-frontend.dev.gov.uk/component-guide
 
-### Write components in your application
-
-Components are partials included by your application:
-```erb
-<%= render 'components/description', { description: "A description is one or two leading sentences." } %>
-```
-
-`govuk_publishing_components` expects the following component structure:
-
-* a partial view in `app/views/components` - The template logic and markup, also defines the arguments expected. Filename must begin with an underscore.
-* a documentation file in `app/views/components/docs` - a `.yml` per component, describing the component and containing fixture data.
-* a SCSS module in `app/assets/stylesheets/components` - The styling of the component
-* [a Javascript module](https://github.com/alphagov/govuk_frontend_toolkit/blob/master/docs/javascript.md#modules) in `app/assets/javascripts/components` - JS behaviour of the component
-* a unit test in `test/components` - testing the component renders correctly based on parameters passed in
-
-For a "print link" component you would have:
-* app/views/components/_print-link.html.erb
-* app/views/components/docs/print-link.yml
-* app/assets/stylesheets/components/_print-link.scss
-* test/components/print_link_test.rb
-
-The component guide will include your application’s styles and scripts. It will include `application.scss` and `application.js` by default but this is [configurable](#configuration).
-
-### Write documentation
-
-The `.yml` file must have:
-* a name
-* a description
-* a default fixture (this can be `{}` if the component takes no parameters)
-
-#### Example documentation
-
-```yaml
-name: Name of component
-description: Short description of component
-body: |
-  Optional markdown providing further detail about the component
-acceptance_criteria: |
-  Markdown listing what this component must do to be accessible
-fixtures:
-  default:
-    some_parameter: 'The parameter value'
-```
-
-### Configuration
+### Configure the gem
 
-Configure the gem with a config block in an initializer:
+Use a config block in an initializer:
 
 ```ruby
 # config/initializers/govuk_publishing_components.rb

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '0.4.1'.freeze
+  VERSION = '0.4.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,16 +34,16 @@ dependencies:
   name: slimmer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement