govuk_publishing_components 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82791bc5677fa763b86403bba364aca06041d381
-  data.tar.gz: 365d38fbf1bf2e86f653fc1fac4ddce6301aa7c3
+  metadata.gz: fb12fc8693ac887695dfcde1c8faefeeee539dfe
+  data.tar.gz: 45ab14567e89f2a3e27794a281458e03623c4cca
 SHA512:
-  metadata.gz: c4471c1805124fc072d7e6d115b2bd3618c17d0ae2ac151ea8ab7bbef8032b312cd4822d82a004db43e2ffcae2e5c3cc4c2a15ad88ac49b5e479af296b8dd67e
-  data.tar.gz: 5750331c65f4e146b6d392c550d386139f8ad9620ce2bc40f192c3a31249d2ea4aca1754b572b6e32e5cd8f321b7e42f01a81bbfe3f0003e6caa4d2e34a34276
+  metadata.gz: 8b464c0efd5ae644bd424caf161261c2526fcb514f22d290b8ab92e6240b114db19cd8b013ded19edfb360bffe45dd5ee8f02cafcfb316238167e2c652a40775
+  data.tar.gz: d32a0efdfb5b90a50aeeb62761918bbc1f7abce4dea413f9361516f8f318a9837d2c92fbad37cab2bdc3251e77355b5295be521a32bfa70b27122787ec2e553d

data/README.md

@@ -71,6 +71,16 @@ if defined?(GovukPublishingComponents)
 end
 ```
 
+## Component generator
+
+The gem includes a component generator to stub the minimal files required for a component.
+
+```ruby
+rails generate govuk_publishing_components:component [component_name]
+```
+
+This will create a template, scss file and yml documentation file for a new component. It will not create a test file as this cannot be reliably done automatically across applications, but a test file will be necessary.
+
 ## Licence
 
 [MIT Licence](LICENCE.md)

data/lib/generators/govuk_publishing_components/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates a new component
+
+Example:
+    rails generate govuk_publishing_components:component [component_name]

data/lib/generators/govuk_publishing_components/component_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+require 'fileutils'
+
+module GovukPublishingComponents
+  class ComponentGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_component_files
+      @public_name = file_name.dasherize
+
+      template_dir = "app/views/components/"
+      docs_dir = "app/views/components/docs/"
+      scss_dir = "app/assets/stylesheets/components/"
+
+      create_directory_if_not_exists(template_dir)
+      create_directory_if_not_exists(docs_dir)
+      create_directory_if_not_exists(scss_dir)
+
+      template '_component.html.erb', "#{template_dir}_#{@public_name}.html.erb"
+      template 'component.yml.erb', "#{docs_dir}#{@public_name}.yml"
+      template '_component.scss', "#{scss_dir}_#{@public_name}.scss"
+    end
+
+  private
+
+    def create_directory_if_not_exists(dir)
+      if not File.directory?(dir)
+        puts("Directory #{dir} not found, creating")
+        FileUtils::mkdir_p dir
+      end
+    end
+  end
+end

data/lib/generators/govuk_publishing_components/templates/_component.html.erb

@@ -0,0 +1,3 @@
+<div class="app-c-<%= @public_name %>">
+  <h2><a href="https://github.com/alphagov/govuk_publishing_components/blob/master/docs/component_conventions.md">How to build a component</a></h2>
+</div>

data/lib/generators/govuk_publishing_components/templates/_component.scss

@@ -0,0 +1,3 @@
+.app-c-<%= @public_name %> {
+
+}

data/lib/generators/govuk_publishing_components/templates/component.yml.erb

@@ -0,0 +1,12 @@
+name: <%= @public_name %>
+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. For example:
+
+  The link must:
+
+  * be keyboard focusable
+fixtures:
+  default: {}

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -168,6 +168,11 @@ files:
 - app/views/govuk_publishing_components/component_guide/show.html.erb
 - app/views/layouts/govuk_publishing_components/application.html.erb
 - config/routes.rb
+- lib/generators/govuk_publishing_components/USAGE
+- lib/generators/govuk_publishing_components/component_generator.rb
+- lib/generators/govuk_publishing_components/templates/_component.html.erb
+- lib/generators/govuk_publishing_components/templates/_component.scss
+- lib/generators/govuk_publishing_components/templates/component.yml.erb
 - lib/govuk_publishing_components.rb
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb