doop 0.0.2 → 0.0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTllNmZkNDU1YzY3ODNlY2QyYWM4YjVkNmMzYmJiY2I4MzFjM2I1NQ==
+    YTJlNzA0M2EyMWRkMGNhNjIwMzc5YWM2ZmQzNTBiYWFhOGFiYjE4ZA==
   data.tar.gz: !binary |-
-    ZjY5ZjhhYzY3MjQ0NzhhMzgyYzNmZTA1OTkzYjU0ZDkzNTE3YmUzMg==
+    NWMzODdlOWE2ZWMyMWJiZmEwODg2Zjk4MzM3NDNiZjk1NTdmOTM4ZA==
 SHA512:
   metadata.gz: !binary |-
-    ZWMyNzg0MjliNmNkOWQyNDEzNWUyMTEzMjliMGZkOTUzMzBjNmU0NjQyMDg1
-    NDUwMDJmOWIzYzUyOTFjZGM2YmRmZmIxZjAxNmQ5ZDg1ZWMzY2U5ZDgxOTNm
-    OTE2OTM3NzNjODg4YjBmMmZmMDEwOWRlMDczN2IwNGFmOWQ1MzM=
+    YmVhODM2ZjRmNDJiMTllYjM4MjQyMzZkM2ViMGVmYmQzZjE1MzQ3YzA5NjVj
+    MjYzZjAxYTEwNTJkZTc0N2VmNzliYmMwNDRkMDY0MjM0YjgzZTFiOTI3Mjc0
+    YjI5N2JhZjgwYjMyZjQ2NThkZDI1MTA0ZTNiZWVhYWUxM2YwZjg=
   data.tar.gz: !binary |-
-    ZTU3YjUwNDllYjljMTk0ZjhmMDUyZTcxZjcxNzYxZGNhODE3MDY1MTVkN2Nj
-    YmE5YzI2OGQ4MGIyZTk4MzExODg1OWMwNjk0ZmE5MzU0YmU4MTFlZjgxOGRl
-    ODc3NzQ4MjgxYTVkYmVjMWJkMDk1ZmUzZTIzYzU3ZDE1YWM3NDM=
+    MDZmNzBlYzBjMDk0Zjk4OGI2OGExMjEwMDQ0MDIxNjkzOGM1MjlmMzNmMzYx
+    NDlmZDRmOGRlZTQ0YTdhY2MwMjRkZWI0OTA5YjUwNDI0OTIzYThhOTAwY2E0
+    NDE2NWMxODFlNTA4NzNmMzk2YWViM2Y4ZTg5YTg0MjMwZDVmYjU=

data/.gitignore

@@ -14,3 +14,4 @@
 mkmf.log
 *.swp
 doop_demo/
+*.gem

data/README.md

@@ -10,6 +10,10 @@ Try out a demo... it's hosted on heroku so there may be a initial pause while he
 
 Assuming ruby, rails and nodejs is installed:
 
+    $ sudo apt-get install qt4-dev-tools libqt4-dev libqt4-core libqt4-gui xvfb
+
+    These are needed to support the headless capybara test suite.
+
     $ rails new govsite
     $ cd govsite
     $ echo "gem 'doop'" >> Gemfile
@@ -17,13 +21,11 @@ Assuming ruby, rails and nodejs is installed:
     $ rails generate doopgovuk demo
     $ rails s
 
-Navigate to http://localhost:3000
+Navigate to http://localhost:3000/demo/index
 
 This is still in development, so if you want the latest, then add `gem 'doop', git: 'git://github.com/coder36/doop.git'` to your Gemfile.
 
 
-     
-
 ## 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.
 
@@ -58,12 +60,13 @@ If your govuk site requires any kind of questionaire, doop is the answer.
 Make sure that the gemfile contains gem 'doop'.   Then run
 
     $ rails generate doopgovuk demo
+    $ rspec
+    $ rails s
 
-Navigate to http://localhost:3000 and you will see the demo questionaire.  
+Navigate to http://localhost:3000/demo/index and you will see the demo questionaire.  
     
 See the [demo rails controller](https://github.com/coder36/doop/blob/master/lib/generators/doopgovuk/templates/app/controllers/demo_controller.rb) to get a feel for the DSL.
 
-
 ## Yaml
 
 Doop is initiated with a Yaml data structure:
@@ -191,6 +194,13 @@ Don't forget to deal with database drivers.  In your Gemfile, you will need to u
     end
 ```
 
+## Creating and publishing doop gem
+
+    git submodule init    <-- to load doop_demo
+    gem build doop.gemspec
+    gem push doop-<version>.gem
+
+
 
 ## TODO
 

data/doop.gemspec

@@ -13,6 +13,7 @@ if !Dir['doop_demo/*'].empty?
   FileUtils.cp "doop_demo/app/views/layouts/application.html.erb", "#{dest}/app/views/layouts/application.html.erb"
   FileUtils.cp_r "doop_demo/app/views/doop", "#{dest}/app/views"
   FileUtils.cp_r "doop_demo/app/views/demo", "#{dest}/app/views"
+  FileUtils.cp_r "doop_demo/spec", "#{dest}"
 end
 
 Gem::Specification.new do |spec|

data/lib/doop/version.rb

@@ -1,3 +1,3 @@
 module Doop
-  VERSION = "0.0.2"
+  VERSION = "0.0.3.1"
 end

data/lib/generators/doopgovuk/doopgovuk_generator.rb

@@ -12,14 +12,32 @@ class DoopgovukGenerator < Rails::Generators::Base
     directory "app/views/demo", "app/views/#{name}"
     gsub_file "app/controllers/#{name}_controller.rb", /DemoController/, "#{name.capitalize}Controller"
 
+    copy_file "spec/rails_helper.rb"
+    copy_file "spec/spec_helper.rb"
+    copy_file "spec/features/demo_spec.rb", "spec/features/#{name}_spec.rb"
+    gsub_file "spec/features/#{name}_spec.rb", /\/demo\/harness/, "/#{name}/harness"
+    gsub_file "spec/features/#{name}_spec.rb", /\/demo\/index/, "/#{name}/index"
 
-    route "root '#{name}#index'"
     route "get '#{name}/index'"
+    route "post '#{name}/index'"
     route "post '#{name}/answer'"
+    route "get '#{name}/harness'"
 
     gem 'govuk_frontend_toolkit'
     gem 'govuk_template'
 
+    gem_group :development do
+      gem 'rspec-rails'
+      gem 'guard-rspec'
+      gem 'capybara'
+      gem 'pry'
+      gem 'pry-nav'
+      gem 'capybara-webkit'
+      gem 'headless'
+      gem 'capybara-screenshot'
+      gem 'selenium-webdriver'
+    end
+
     Bundler.with_clean_env do
       run "bundle install"
     end

data/lib/generators/doopgovuk/templates/app/controllers/demo_controller.rb

@@ -13,8 +13,11 @@ class DemoController < ApplicationController
       load_yaml do
         data = params["doop_data"] 
         if data != nil
-          crypt = ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base)
-          next crypt.decrypt_and_verify data
+          if Rails.env.development? || Rails.env.test?
+            next data
+          else
+            next ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base).decrypt_and_verify data if !Rails.env.development?
+          end
         end
 
         <<-EOS
@@ -66,9 +69,13 @@ class DemoController < ApplicationController
       end
 
       save_yaml do |yaml|
-        crypt = ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base)
-        data = crypt.encrypt_and_sign(yaml)
-        request["doop_data"] = data
+        if Rails.env.development? || Rails.env.test?
+          request["doop_data"] = yaml
+        else
+          crypt = ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base)
+          data = crypt.encrypt_and_sign(yaml)
+          request["doop_data"] = data
+        end
       end
 
       debug_on do 

data/lib/generators/doopgovuk/templates/app/views/demo/harness.html.erb

@@ -0,0 +1,6 @@
+<h1>YAML:</h1>
+<%=form_tag( {action: "index"}, :authenticity_token => true, :remote => false ) do %>
+  <textarea cols="140" rows="40" name="doop_data" id="doop_data"></textarea>
+  <br/>
+  <button id="render" >Render</button>
+<% end %>

data/lib/generators/doopgovuk/templates/app/views/doop/_question.html.erb

@@ -1,7 +1,7 @@
 <% if root["_open"] %>
   <% if indent %><div class="indent"><% end %>
     <div class="question-open">
-      <h2><%=title != nil ? title : root["_question"]%></h2>
+      <h2 class="question_title"><%=title != nil ? title : root["_question"]%></h2>
       <% content.call(root, answer) %>
     </div>
   <% if indent %> </div"><% end %>
@@ -10,7 +10,7 @@
 <% if !root["_open"] && root["_answered"] %>
   <% if indent %><div class="indent"><% end %>
     <div class="question-closed">
-      <div class="title"><%=title != nil ? title : root["_question"]%></div>
+      <div class="title question_title"><%=title != nil ? title : root["_question"]%></div>
       <div class="answer">
         <a href="#" class="button" onclick="$('#change_answer_path').val('<%=path %>').click(); return false"><%=root['_summary']%></a>
       </div>

data/lib/generators/doopgovuk/templates/app/views/doop/_question_form.html.erb

@@ -1,7 +1,7 @@
 <%=form_tag( {action: "answer"}, :authenticity_token => true, :remote => true ) do %>
   <div class="question_form">
     <%=render "doop/navbar", :res => res, :doop => doop %> 
-    <h1><%=res[:page_title]%></h1>
+    <h1 id="page_title"><%=res[:page_title]%></h1>
     <% content.call %>
   </div>
 
@@ -11,5 +11,5 @@
   <button id="nav_path" style="display: none;" name="nav_path"></button>
   <button id="back_a_page" name="back_a_page" style="display: none;"></button>
   <button id="change_answer_path" style="display: none;" name="change_answer_path"></button>
-  <input type="hidden" name="doop_data" value="<%=request["doop_data"]%>"/>
+  <input type="hidden" id="doop_data" name="doop_data" value="<%=request["doop_data"]%>"/>
 <% end %>

data/lib/generators/doopgovuk/templates/spec/features/demo_spec.rb

@@ -0,0 +1,70 @@
+require 'rails_helper'
+require 'pry'
+
+
+feature "Doop questionnaire" do
+
+  scenario "Quick run through", :js => true do
+    load_completed_form
+  end
+
+  scenario "Changing an answer, causes change_answer_tool_tip_text to appear", :js => true do
+    load_completed_form
+    change_page( "Apply Online" )
+    change_question( "Have you enrolled for this service before") do 
+      expect(change_answer_tooltip_text).to match /additional questions may be asked/
+    end
+  end
+
+  scenario "Answering a question results in a tooltip appearing", :js => true do
+    load_completed_form
+    change_page( "Apply Online" )
+    change_question( "Turn debug on") do 
+      click_button "No" 
+      expect(tooltip_text).to match /Are you sure/
+    end
+  end
+
+  scenario "Answering a question results in a new question being asked", :js => true do
+    load_completed_form
+    change_page( "Apply Online" )
+    change_question( "Have you enrolled for this service before")  { click_button "Yes" }
+    expect( question "What year did you last apply" ).to be_enabled
+    change_question( "Have you enrolled for this service before")  { click_button "No" }
+    expect( question "What year did you last apply" ).to be_disabled
+  end
+
+  def load_completed_form
+    
+    if $completed_form_yaml != nil
+      visit '/demo/harness'
+      fill_in( "doop_data", :with => $completed_form_yaml )
+      click_button "Render"
+      return
+    end
+
+    visit '/demo/index'
+    wait_for_page( "Apply Online" )
+    answer_question( "Turn debug on") { click_button "Yes" }
+    answer_question( "Have you enrolled for this service before")  { click_button "Yes" }
+    answer_question( "What year did you last apply")  { select( '2012', :from => 'b_answer' ); click_button "Continue"  }
+    answer_question( "Why are you applying")  { fill_in( 'b_answer', :with => "My circumstances have changed" ); click_button "Continue"}
+    click_button "Continue and Save"
+
+    wait_for_page( "Your Details" )
+    answer_question( "What is your name") do 
+      b_fill_in( "firstname" => "mark", "surname" => "middleton" )
+      click_button "Continue" 
+      expect(rollup_text).to be == "Mark Middleton" 
+    end
+    address = { "address1" => "1 Runswick Avenue", "address2" => "Telford", "address3" => "Shropshire", "postcode" => "T56 HDJ" }
+    answer_question( "Address 1") { b_fill_in( address); click_button "Continue" }
+    click_button "Continue"
+    click_button "Continue and Save"
+
+    wait_for_page( "Summary" )
+    answer_question( "Terms and conditions") { click_button "I have read" }
+    $completed_form_yaml = page.find_by_id( "doop_data", :visible => false).value
+  end
+
+end

data/lib/generators/doopgovuk/templates/spec/rails_helper.rb

@@ -0,0 +1,142 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../../config/environment", __FILE__)
+require 'capybara'
+require 'capybara/rails'
+require 'capybara/rspec'
+require 'capybara-webkit'
+require 'headless'
+require 'capybara-screenshot/rspec'
+
+
+Capybara.javascript_driver = :webkit
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    @headless = Headless.new
+    @headless.start
+  end
+
+  config.after(:suite) do
+    @headless.destroy
+  end
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  #config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  #config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  #config.infer_spec_type_from_file_location!
+end
+
+RSpec::Matchers.define :be_asked do 
+  match do |q_title|
+    page.has_css?( '.question-open h2', :text => q_title )
+  end
+
+  failure_message do |q_title|
+    actual = page.all( '.question-open h2', ).last.text
+    "Expected question to be asked: #{q_title}, but was asked #{actual}"
+  end
+
+end
+
+RSpec::Matchers.define :be_enabled do 
+  match do |q_title|
+    page.has_css?( '.question_title', :text => q_title )
+  end
+end
+
+RSpec::Matchers.define :be_disabled do 
+  match do |q_title|
+    page.has_no_css?( '.question_title', :text => q_title )
+  end
+end
+
+def question text
+  text
+end
+
+def change_question q_title, &block
+  @q_title = q_title
+  page.find( '.question-closed div.title', :text => q_title ).find(:xpath, "..").find( 'div.answer a' ).click
+  expect( question q_title ).to be_asked
+  yield block
+end
+
+def answer_question q_title, &block
+  @q_title = q_title
+  expect( question q_title ).to be_asked
+  yield block
+  page.find( '.question-closed div.title', :text => q_title )
+end
+
+def rollup_text
+  page.find( '.question-closed div.title', :text => @q_title ).find(:xpath, '..').find( 'div.answer').text
+end
+
+def tooltip_text
+  page.find( '.tooltip' ).text
+end
+
+def change_answer_tooltip_text
+  page.find( '.change_answer_tooltip' ).text
+end
+
+def wait_for_page p_title
+  page.find_by_id( "page_title", :text=>p_title)
+end
+
+def page_title
+  page.find_by_id( "page_title").text
+end
+
+def b_fill_in options = {}
+  options.keys.each do |key|
+    page.fill_in( "b_#{key}", :with => options[key] )
+  end
+end
+
+def change_page page_name
+  page.find_link( page_name ).click
+  wait_for_page page_name
+end

data/lib/generators/doopgovuk/templates/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require 'capybara/rspec'
+#
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doop
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.1
 platform: ruby
 authors:
 - Mark Middleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/generators/doopgovuk/templates/app/views/demo/_preamble.html.erb
 - lib/generators/doopgovuk/templates/app/views/demo/_summary.html.erb
 - lib/generators/doopgovuk/templates/app/views/demo/_your_details.html.erb
+- lib/generators/doopgovuk/templates/app/views/demo/harness.html.erb
 - lib/generators/doopgovuk/templates/app/views/demo/index.html.erb
 - lib/generators/doopgovuk/templates/app/views/demo/index.js.erb
 - lib/generators/doopgovuk/templates/app/views/doop/_change_answer_tooltip.html.erb
@@ -108,6 +109,9 @@ files:
 - lib/generators/doopgovuk/templates/app/views/doop/_question_form.html.erb
 - lib/generators/doopgovuk/templates/app/views/doop/_tooltip.html.erb
 - lib/generators/doopgovuk/templates/app/views/layouts/application.html.erb
+- lib/generators/doopgovuk/templates/spec/features/demo_spec.rb
+- lib/generators/doopgovuk/templates/spec/rails_helper.rb
+- lib/generators/doopgovuk/templates/spec/spec_helper.rb
 - spec/doop_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/coder36/doop