Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby Other
branch: master
Failed to load latest commit information.
app Menion that the secret values are overwritten on deploy
bin Add binstubs as advised by rails 4.2
config Set production log_level to info (addresses deprecation warning)
db Initial blank rails app.
doc Document how to archive a Smart Answer
lib Merge pull request #1580 from alphagov/tt_publish_uk_visa_checker_april
log Initial blank rails app.
public Remove dangling symlinks
script Initial blank rails app.
test Merge pull request #1580 from alphagov/tt_publish_uk_visa_checker_april
vendor Fix js errors in chrome 35
.disabled-rubocop.yml Whitespace
.gitignore Don't track coverage directory
.rubocop.yml remove comment spacing
.ruby-version Bump ruby to 2.1.5
CONTRIBUTING.md Define contributing guide
Gemfile Update poltergeist to work with latest version of phantomjs.
Gemfile.lock Update poltergeist to work with latest version of phantomjs.
LICENSE.md Correct attribution of copyright
README.md Add information about testing Smartdown to README
Rakefile Disable logging in test
config.ru Initial blank rails app.
install.sh Make install.sh executable
jenkins.sh Clean files from previous builds
jenkins_branches.sh Add jenkins_branches.sh
startup.sh Add a handy script to start up the app in development.

README.md

Smart Answers

Smart answers are a great tool for content designers to present complex information in a quick and simple way. Defining what they are – decision trees? calculators? tools? is immaterial – what they do is provide a reusable technical framework to build a quick and simple answer to a complex question.

Read more in a blog post.

Have a look at test/unit/flow_test.rb for example usage.

This application supports two styles of writing and executing smart answers:

Ruby and YAML-based smart answer flows

For more information, please go to the Ruby/YAML SmartAnswer README

Smartdown-based smart answer flows

For more information, please go to the Smartdown SmartAnswer README

Switching from one style to another

Smart answers are by default expected to be in Ruby/YAML style. To transition a smart answer from Ruby/YML to Smartdown style, register it in the smartdown registry (lib/smartdown/registry.rb).

Debugging current state

If you have a URL of a Smart answer and want to debug the state of it i.e. to see PhraseList keys, saved inputs, the outcome name, append debug=1 query parameter to the URL in development mode. This will render debug information on the Smart answer page.

Visualising a flow

To see a visualisation of a smart answer flow, append /visualise to the root of a smartanswer URL e.g. http://smartanswers.dev.gov.uk/<my-flow>/visualise/

Installing and running

NB: this assumes you are running on the GOV.UK virtual machine, not your host.

  ./install # git fetch from each dependency dir and bundle install

Run using bowler on VM from cd /var/govuk/development:

bowl smartanswers

Viewing a Smart Answer

To view a smart answer locally if running using bowler http://smartanswers.dev.gov.uk/register-a-birth

Testing

Run unit tests by executing the following:

bundle exec rake

** Fixtures **

If you need to add a new worldwide organisations fixture find it here by the country name or its capital city, navigate to <found_url>.json, most likely it will be of the following format https://www.gov.uk/api/world/organisations/british-[embassy|high-commission]-<capital city>, copy over the JSON to test/fixtures/worldwide/<country>_organisations.json and change it to reflect the expected format based on other examples in the directory.

Testing Smartdown flows

Smartdown flows are tested using scenarios in the flow directories.

Test all Smartdown flows by running:

bundle exec ruby -Itest test/unit/smartdown_content/smartdown_scenarios_test.rb

Test a single Smartdown flow by running:

 SMARTDOWN_FLOW_TO_TEST=<name-of-smartdown-flow> \
 bundle exec ruby -Itest test/unit/smartdown_content/smartdown_scenarios_test.rb

Issues/todos

Please see the github issues page.

Making bigger changes

When making bigger changes that need to be tested before they go live it is best to release them as a draft first. There is a rake task for creating a draft flow rake version:v2[flow]. This is not ideal, but it allows to check the changes in the UI in the development and preview environments without affecting the production environment.

Once reviewed, the draft can be published by running rake version:publish[flow]. This merges V2 changes into the original files. Take a look at the rake task to see the details. If you used any other V2 files that are not covered by the rake task, make sure to process them manually.

Commiting V2 -> V1 changes

To help developers track changes in files easily, it is best if you commit V2 files' removal in one commit, then commit the modifications to the original files. This creates an easy to browse diff of all the changes being published. Write a descriptive message for the second commit, as this is what the other developers will see in the file history.

Detailed documentation

Something went wrong with that request. Please try again.