barnardos-ruby_design_system 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e03581346f2bd984e9f80cf1dcac60707ec00c32264bae1595ed0eab9bea9b8a
-  data.tar.gz: dacbc3dfd60c95e9d89b7057e368a5ad1f533b7719ea3a1260e9a603c4d49aa4
+  metadata.gz: 47b4f37ec6e6bc859ec221278a4559f4cb7932b9e4fa0f6645440bf266ea8f52
+  data.tar.gz: ab1bc3b3ccf5257337c2514bbbc703c6196ffbbd4fd450ce94b4deb760536dc9
 SHA512:
-  metadata.gz: 7dfd3577281af4df7a2f04e46d661293610ff3adcbde20d34fd2fc703549cd943f6226aeba3a9b8d99c18790530198828c1f1c9bf7e02bc1646d24dd858c88ba
-  data.tar.gz: 44405b41e33d7471323516b2885317187204e02ffac3d50474f5516f630a53add3d560b4123742ec37fd095f73199cf665723208ab07fc639b897a4d861272d8
+  metadata.gz: fc37330b0619f259a98642c93a13fe1024a6541a79575bb78fff22e5abeeb098d788e367dd5f118b054caffdd58c5169ef625f717744b793c9291af5d688dd59
+  data.tar.gz: ed9032cc2fba5fd68f533f903e2ed3b8fe2e2b62b5dc947ce5c604aa022a18d97f837fa7e5276efc60f9083e467d116809b2b499eeb8153092760f4088f46904

data/README.md

@@ -2,7 +2,7 @@
 
 Tools for applying Barnardo's Design System to Ruby projects.
 
-The tools include helper methods and modification to simple form to make it Design System compliant.
+The tools include helper methods and modifications to simple_form to make it Design System compliant.
 
 ## Installation
 
@@ -16,7 +16,7 @@ And then execute:
 
     $ bundle
 
-With the gem install, a Rails generator is added that will set up the host app. To run the generator
+With the gem installed, a Rails generator is added that will set up the host app. To run the generator
 execute the following at app root:
 
     $ rails g barnardos:install
@@ -39,29 +39,17 @@ The file `package.json` is updated to include declarations for PostCSS and relat
 
 The PostCSS configuration file `/postcss.config.js` is copied to root
 
-#### Updates `/app/views/layouts/application.html.erb`
-
-All CSS should be defined within the folder `app/javascript` so the `stylesheet_link_tag` declaration can be removed
-from the application template. Also make sure that JavaScript is loaded here with `javascript_pack_tag`. For example:
-
-```
-  <%= javascript_pack_tag 'application' %>
-```
-
 ### Sets up simple form to work with the design system
 
 A set of classes are inserted into `app/inputs`. These modify the rails input classes so that when used
 with simple_form, they create components that match the design system.
 
-## Using the components
-
-### `app/helpers/application_helper.rb`
+### Adds `app/helpers/barnardos_design_system_helper.rb`
 
-To use the helper methods defined in this gem, add the following to `ApplicationHelper`:
+This helper contains the statement `include Barnardos::RubyDesignSystem::ComponentHelper` which makes the helper
+method defined in this gem, available to the views in the host app.
 
-```ruby
-include Barnardos::RubyDesignSystem::ComponentHelper
-```
+## Using the components
 
 ### `/app/javascript/packs/application.js`
 
@@ -87,9 +75,12 @@ placing them in alphabetical order is a good idea as it makes them a little easi
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/barnardos/ruby_design_system/version.rb

@@ -1,5 +1,5 @@
 module Barnardos
   module RubyDesignSystem
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/generators/barnardos/install_generator.rb

@@ -22,14 +22,11 @@ module Barnardos
 
       def install
         directory 'inputs', 'app/inputs'
+        directory 'helpers', 'app/helpers'
 
         `yarn add #{PACKAGES.join(' ')}`
         `yarn add #{DEV_PACKAGES.join(' ')} --dev`
         copy_file 'postcss.config.js', 'postcss.config.js'
-        if File.exist?('app/views/layouts/application.html.erb')
-          gsub_file('app/views/layouts/application.html.erb',
-                    /<%= stylesheet_link_tag[^%]*%>?/, '')
-        end
         rake 'webpacker:clobber'
         `yarn`
       end

data/lib/generators/barnardos/templates/helpers/barnardos_design_system_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BarnardosDesignSystemHelper
+  include Barnardos::RubyDesignSystem::ComponentHelper
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barnardos-ruby_design_system
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rob Nichols
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_form
@@ -201,6 +201,7 @@ files:
 - lib/barnardos/ruby_design_system/version.rb
 - lib/generators/barnardos/USAGE
 - lib/generators/barnardos/install_generator.rb
+- lib/generators/barnardos/templates/helpers/barnardos_design_system_helper.rb
 - lib/generators/barnardos/templates/inputs/collection_check_boxes_input.rb
 - lib/generators/barnardos/templates/inputs/collection_select_input.rb
 - lib/generators/barnardos/templates/inputs/string_input.rb