doop 0.0.4.2 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODYyNmE1ZGQwMjhjNTU4YmMwMjE3NDczZTIyYTIxZDk0Mzg4ZThmYg==
+    ZTdjNDFlZGI4NDA0YTBmZTY1M2MwMTU2ODdlMmIzYmQ4MzgzYThkNw==
   data.tar.gz: !binary |-
-    MTNjN2MwOTY5ODdkOGNiYThhZmVhYTg4NjY3NmJkMTIyNzI4OGUwMA==
+    ZjMxNmI5MmZhNjM3NDM0ZTNlODlkMDNhZjE0MThmMDQ5MDg3YWVlZQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDU0NjI5ZGE2NDZhOGE5ZThmMzU0MzAwNTQ3NTM2NWE3ZWU3MmU2OGUxZmUx
-    YWU3YjA4YWI1YzZkZTlkZmM3M2EzOTA4YWIxOWI0NTZkNjRjOTBkMmRhNzM3
-    ODdmZmNlOTgyYzE3MzhlNjZiY2RhNzdkOTk5MDQwMzJmNzkxYTQ=
+    ZDBjODc4YjYwYTU3NjQ0MjFjMWQzMDU1NmZmNjdkOTZhNGJlNmI4ZWQ1YTIw
+    NTYwYTJmZDVhMDI5MWE4OGZkYTJiMGJiN2E5MmRmYjUxMjJkMDc3NzYxZmEw
+    Y2I0YmQ3OTlhYTE1NDVkNzUzYTM0NWZkM2VjOTAwZDE3YzBhNzc=
   data.tar.gz: !binary |-
-    YTc3ZWU5MTYxNTU0ZTgyMDM0MjRjNTM3Yjg4MmE4MDQzYzc1ZTkwMDgyOGVl
-    YmVmZmNiNzZiNzI1YmMwYzQyYzFiNGM0YjdiZjc1NmQ0Y2Y2ZDBmY2JhNmM1
-    Mzg0YmNmZGQwYzFkOTRlOWQxMzcyMTJlYTgyODhmMGU3NzRiMGM=
+    MzI2Nzk5MjVkZDE5YzhkYWU4N2U3YjcwMTU0YTg2MDgxMzllNmJhYmIzMzUw
+    MmFiYTAxNmE2ZDhkNDQxYTEwYTZjZWY0YzhhNDVhODI3ZWZkNjEwZWExOGU0
+    NTNkZjlhMTAzNzNjZWRiMmZhYzA4ZGQxMjE2ZWNiMDBjZTU1ODc=

data/README.md

@@ -1,10 +1,13 @@
 # Doop
 
-A question framework for govuk sites, inspired by the great work GDS have done to standardize the cross government internet presence.
+A question framework for govuk sites, inspired by the great work [GDS](https://gds.blog.gov.uk) have done to standardize the cross government internet presence.  Try out the demo:
 
-## [Doopgovuk demo](http://blooming-wave-8670.herokuapp.com)
+## [Doopgovuk demo](http://blooming-wave-8670.herokuapp.com/demo/index)
+
+it's hosted on heroku so there may be a initial pause while heroku fires up the dynamo.
+
+<a href="http://blooming-wave-8670.herokuapp.com/demo/index"><img src="https://raw.githubusercontent.com/coder36/doop/master/notes/screenshots/doop_1.png"/></a>
 
-Try out a demo... it's hosted on heroku so there may be a initial pause while heroku fires up the demo:
 
 
 
@@ -29,11 +32,11 @@ This is still in development, so if you want the latest, then add `gem 'doop', g
 
 
 ## Background
-Whilst working with the Student Loans company and GDS we discovered that the best way to get a student to fill a form in was to progressively ask questions, one after the other rather than as one big form.  User experience testing showed this was a far less intimidating experience, and they would more likely stick at it.  Furthermore, based on pevious answers, we  can choose which questions to ask.  This makes each questionaire effectively tailored to the individual student.
+Whilst working with the Student Loans company and [GDS](https://gds.blog.gov.uk) we discovered that the best way to get a student to fill a form in was to progressively ask questions, one after the other rather than as one big form.  User experience testing showed this was a far less intimidating experience, and they would more likely stick at it.  Furthermore, based on pevious answers, we  can choose which questions to ask.  This makes each questionaire effectively tailored to the individual student.
 
 Other things we learned, was that students hate answering lots of questions, only to find at the end they are not eligible.  So the order of questions is very important, and thats why some of the early questions when applying for a student loan may seem a bit obscure, but they are designed to weed out those who are inelligble as soon as possible. 
 
-If you compare the Student loans site and the DVLA site, which are both govuk questionaires you will see that they have been implemented in very different ways, and as a result look fairly different, but essentially do the same thing.  In fact I found that within the same company, you had multiple approaches, and completely different technology stacks to achieve the same thing.  I spent months writing Daone of these sites, 
+If you compare the Student loans site and the [DVLA](https://www.taxdisc.service.gov.uk) site, which are both govuk questionaires you will see that they have been implemented in very different ways, and as a result look fairly different, but essentially do the same thing.  In fact I found that within the same company, you had multiple approaches, and completely different technology stacks to achieve the same thing.  I spent months writing Daone of these sites, 
 
 Designing something from scratch is expensive and time consuming.  This is where GDS have added real value.  They have provided a set of ruby gems to trivialise the production of
 govuk sites.  One thing they are lacking however is a gem to trivialize the creation of complex questionaires.  And this is why government organisations are seemingly reinventing
@@ -49,6 +52,7 @@ If your govuk site requires any kind of questionaire, doop is the answer.
 * Ability to Change answer
 * Summarize answers
 * Broswer backbutton integration
+* File upload capability
 * Stateless
 * Fast
 * Ajax call backs
@@ -157,20 +161,131 @@ on_answer "/page/preamble/enrolled_before"  do |question,path, params, answer|
 end
 ```
 
-
 # Notes
 
-## Performance
+## Javascript
+
+Doop feels fast, because ajax is used to handle button presses.  Only the question pannel section is ever redrawn, and thats
+once the server side processing has completed.  Things to note:
+
+* The navigation links at the top, result in a hidden button being pressed
+* The browser back button, results in a hidden button being pressed.   
+
+### Back button
+
+Doop hijacks the the browser back button.  Pressing it will open the previous pages questions. This is done
+with the following [coffeescript](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/app/assets/javascripts/demo.js.coffee) code:
+
+    $( () ->
+      history.pushState("back", null, null);
+      if typeof history.pushState == "function"
+        history.pushState("back", null, null);
+        window.onpopstate = (evt) ->
+          history.pushState('back', null, null);
+          $( "#back_a_page" ).val( "pressed" )
+          $( "#back_a_page" ).click()
+    )
+
+### No javascript support ?
+
+Doop will work fine with java script disabled.  It still feels fast.  Take note of the following:
+
+* The entire page will be re-rendered when ever a button is pressed.
+* A `back` navigation button will appear at the bottom.  Normally javascript within [app/views/doop/_question_form.html.erb](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/app/views/doop/_question_form.html.erb) would set this to `$("#back_a_page").css( "display", "none" )`
+* The top navigation links will not work, but the website is perfectly usable and still feels fast. 
+
+
+
+## Analytics 
+
+Analytics is provided by [google anaytics](http://www.google.com/analytics/).  When you use the generator, a file named `app/assets/javascript/demo/anayltics.js.erb` will be created.  This contains the javascript code to integrate with google analytics.  Out of the box, the following  events will be recorded:
+
+
+| Event                           | Category    | Action    | Label
+|:--------------------------------|:------------|:----------|:-------- 
+|Backbutton clicked               | button      | click     | back-button
+|Navigation link clicked          | page        | changed   | page_id 
+|Question answered                | question    | answered  | question_id
+|Question re-opened               | question    | reopened  | question_id
+
+To get this working for your project, you will need to update [anayltics.js.erb](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/app/assets/javascripts/demo/analytics.js.erb) with your google Universal Analytics id.  
+
+Typically, jquery is used to dynamically bind the the 'GA send' code to the forms buttons. eg.
+
+     $("[id$=-change]").click( function() {
+       id = $(this).attr('id')
+       ga( 'send', 'event', 'question', 'reopened', id.replace( '-change', '' ) )
+     })
+
+
+# Testing
+
+The generated doopgovuk project, will give you a set of rspec tests, which use capybara, to click buttons, set
+fields etc through a scenario.  These scenarios will form the acceptance tests.  These should be included
+as part of a CI pipeline, on the road to production.  
+
+## Headless web driver
+
+When using TDD, you need to get into a tight feedback loop.  Your tests need to be quick and this means compromises.  
+The compromise doop makes, is to use the `:webkit` headless driver.  This is blisteringly fast, but the downside
+is that you can't see what its doing.  The webkit headless driver relies on a framebuffer, so to get it working,
+ you'll need to install some libraries:
+
+    sudo apt-get install qt4-dev-tools libqt4-dev libqt4-core libqt4-gui xvfb
+
+The driver is defined in [spec/rails_helper.rb](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/spec/rails_helper.rb)
+
+
+## DSL
+
+Doop provides an [inituitive DSL](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/spec/features/demo_spec.rb) for writing acceptance tests.  Try to limit the number of scenarios, to keep the test run as quick as possible.  Perhaps have an end to end scenario which covers every  question and every flow, then have another one which covers the way that 95% people would answer.  The test should work with `:js=>false`, but again, the vast majority of people will be using javascript.  
+
+    feature "Child Benefit online form" do
+      scenario "Complete Child Benefit form", :js => true do
+        before_you_begin
+        preamble
+      end
+      
+      def before_you_begin
+        visit '/demo/index'
+        wait_for_page( "before_you_begin" )
+        click_button "Start"
+      end
+      def preamble
+        wait_for_page( "preamble" )
+        
+        answer_question( "income_more_than_50000")  do
+          click_button "No,"
+          expect( tooltip ).to be_visible
+        end
+        
+        expect( question "do_you_still_want_to_apply" ).to be_disabled
+        
+        change_question( "income_more_than_50000") do
+          expect( change_answer_tooltip ).to be_visible
+          click_button "Yes," 
+        end
+      end
+    end
+
+
+## Testing Gotchas
+
+* The :webkit driver seems to hang when using google analytics, so for development and test, google analytics are
+disabled.
+
+
+
+# Performance
 
 For the demo, the serialized questionaire is stored as a form parameter.  This is a nice approach as a general strategy since its completely stateless and as a result scalable.  
 Its also very fast.  
 
-I've worked with a lot of java farmeworks (I'm thinking JSF!) and in comparison I can assure you that the demo application is fast.  Doop fully supports jruby, so you may get some 
-optimisation going down that route.  As mentioned earlier its completely stateless, so you can scale by simply firing up more servers. 
+I've worked with a lot of java farmeworks (I'm thinking JSF!) and in comparison I can assure you that the demo application is fast.  Doop fully supports jruby, so you may get some optimization going down that route.  As mentioned earlier its completely stateless, so you can scale by simply firing up more servers. 
 
 I tested it with passenger and nginx and it was lightening fast.  Without any optimisation each request was taking about 20ms.
 
-## Jruby
+# Jruby
 
 The yaml serialization uses encryption, so you will need to tell java to allow unlimted strength cryptography.  Create a file config/initializers/unlimited_strength_cryptography
 
@@ -207,8 +322,7 @@ Don't forget to deal with database drivers.  In your Gemfile, you will need to u
 ## TODO
 
 * Refactor -  make the code, simpler and read better
-* Doop-Rspec - it would be nice to have a DSL to drive answering questions.  This could be extended to capybara.
-* Responsive - on the whole the govuk frontend is responsive, fonts resize etc.  But there is still some work to be done.
+* Language localisation
 
 
 ## Contributing

data/app/helpers/doop_helper.rb

@@ -1,5 +1,9 @@
 module DoopHelper
 
+  def file_uploader answer
+    render "doop/file_uploader", :answer => answer
+  end
+
   def info_box &block
     render "doop/info_box", :content => block
   end

data/demo/.gitignore

@@ -0,0 +1,19 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp
+*.swp
+/public/assets
+/public/uploads

data/demo/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/demo/Gemfile

@@ -0,0 +1,70 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.1.6'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.3'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer',  platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
+
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring',        group: :development
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+#gem 'doop', :git => "git://github.com/coder36/doop.git"
+
+gem "govuk_frontend_toolkit", "~> 1.6"
+gem "govuk_template", "~> 0.9"
+gem "jquery-ui-rails", "~> 5.0"
+gem "blueimp-gallery", "~> 2.11.0"
+gem "jquery-fileupload-rails", "~> 0.4"
+
+
+group :production do
+  gem 'rails_12factor', "~> 0.0"
+  gem 'pg', "~> 0.17"
+end
+
+group :development do
+  gem 'sqlite3', "~> 1.3"
+  gem 'rspec-rails', "~> 3.1"
+  gem 'guard-rspec', "~> 4.3"
+  gem 'capybara', "~> 2.4"
+  gem 'pry', "~> 0.10"
+  gem 'pry-nav', "~> 0.2"
+  gem 'capybara-webkit', "~> 1.3"
+  gem 'headless', "~> 1.0"
+  gem 'capybara-screenshot', "~> 1.0"
+end
+
+if File.exists?( "heroku")
+  gem 'doop', :git => "git://github.com/coder36/doop.git"
+elsif File.exists?( "../../doop" )
+  gem 'doop', :path => "../"
+else
+  gem 'doop'
+end

data/demo/Gemfile.lock

@@ -0,0 +1,237 @@
+PATH
+  remote: ../
+  specs:
+    doop (0.0.5)
+      rails (>= 4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activerecord (4.1.6)
+      activemodel (= 4.1.6)
+      activesupport (= 4.1.6)
+      arel (~> 5.0.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    blueimp-gallery (2.11.0.1)
+      railties (>= 3.1.0)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-screenshot (1.0.3)
+      capybara (>= 1.0, < 3)
+      colored
+      launchy
+    capybara-webkit (1.3.1)
+      capybara (>= 2.0.2, < 2.5.0)
+      json
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.8.0)
+    colored (1.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    execjs (2.2.2)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    govuk_frontend_toolkit (1.6.2)
+      rails (>= 3.1.0)
+      sass (>= 3.2.0)
+    govuk_template (0.9.1)
+      rails (>= 3.1)
+    guard (2.7.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    headless (1.0.2)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    i18n (0.6.11)
+    jbuilder (2.2.2)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    jquery-fileupload-rails (0.4.1)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+    jquery-rails (3.1.2)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.2)
+      railties (>= 3.2.16)
+    json (1.8.1)
+    launchy (2.4.2)
+      addressable (~> 2.3)
+    listen (2.7.11)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    mail (2.6.1)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.4.2)
+    mini_portile (0.6.0)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    pg (0.17.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.6)
+      actionmailer (= 4.1.6)
+      actionpack (= 4.1.6)
+      actionview (= 4.1.6)
+      activemodel (= 4.1.6)
+      activerecord (= 4.1.6)
+      activesupport (= 4.1.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.6)
+      sprockets-rails (~> 2.0)
+    rails_12factor (0.0.3)
+      rails_serve_static_assets
+      rails_stdout_logging
+    rails_serve_static_assets (0.0.2)
+    rails_stdout_logging (0.0.3)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-rails (3.1.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sass (3.2.19)
+    sass-rails (4.0.3)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.0)
+      sprockets (~> 2.8, <= 2.11.0)
+      sprockets-rails (~> 2.0)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    slop (3.6.0)
+    spring (1.1.3)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    turbolinks (2.4.0)
+      coffee-rails
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (2.5.3)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blueimp-gallery (~> 2.11.0)
+  capybara (~> 2.4)
+  capybara-screenshot (~> 1.0)
+  capybara-webkit (~> 1.3)
+  coffee-rails (~> 4.0.0)
+  doop!
+  govuk_frontend_toolkit (~> 1.6)
+  govuk_template (~> 0.9)
+  guard-rspec (~> 4.3)
+  headless (~> 1.0)
+  jbuilder (~> 2.0)
+  jquery-fileupload-rails (~> 0.4)
+  jquery-rails
+  jquery-ui-rails (~> 5.0)
+  pg (~> 0.17)
+  pry (~> 0.10)
+  pry-nav (~> 0.2)
+  rails (= 4.1.6)
+  rails_12factor (~> 0.0)
+  rspec-rails (~> 3.1)
+  sass-rails (~> 4.0.3)
+  sdoc (~> 0.4.0)
+  spring
+  sqlite3 (~> 1.3)
+  turbolinks
+  uglifier (>= 1.3.0)