doop 0.0.1

data/lib/doop/version.rb

@@ -0,0 +1,3 @@
+module Doop
+  VERSION = "0.0.1"
+end

data/lib/doop_controller.rb

@@ -0,0 +1,164 @@
+require 'yaml'
+require 'rails'
+
+module Doop
+
+  class DoopController
+
+    delegate :set_yaml, :unanswer_path, :add, :renumber, :on_answer, :answer_with, :enable, :remove, to: :@doop
+
+    attr_reader :doop
+
+    def initialize application_controller, &block
+      @controller = application_controller
+      @block = block
+      @debug_on_block = nil
+      @current_page_block = method( :default_current_page )
+      @all_pages_block = method( :default_all_pages )
+    end
+
+    def index
+      render_page in_doop { |doop| doop.ask_next }
+    end
+
+    def answer
+      back_val = @controller.params["back_a_page"]
+      nav_path = @controller.params["nav_path"]
+      change_answer_path = @controller.params["change_answer_path"]
+      return back if back_val != nil && !back_val.empty?
+      return change_page nav_path if nav_path != nil && !nav_path.empty?
+      return change change_answer_path if change_answer_path != nil && !change_answer_path.empty?
+
+      render_page in_doop { |doop| doop.answer( @controller.params ) }
+    end
+
+    def back
+      in_doop do |doop|
+        page = get_page_path
+        pages = get_all_pages
+        i = pages.index(page)
+        if i!=0
+          path = pages[i-1]
+          doop.change( path )
+          pages[pages.index(path), pages.length].each do |n|
+            doop[n]["_answered"] = false
+          end
+
+          doop.ask_next
+        end
+      end
+      render_page
+    end
+
+    def change path
+      res = in_doop do
+        |doop| doop.change( path ) 
+      end
+      render_page res
+    end
+
+    def change_page path
+      in_doop do |doop|
+        #path = @controller.params["path"]
+        doop.change( path )
+
+        # unanswer all pages after path
+        pages = @all_pages_block.call 
+        pages[pages.index(path), pages.length].each do |n|
+          doop[n]["_answered"] = false
+        end
+
+        doop.ask_next
+      end
+      render_page
+    end
+
+    def parent_of path
+      p = path.split("/")
+      p.pop
+      p.join("/")
+    end
+
+    def render_page res = {}
+      res[:page] = get_page
+      res[:page_path] = get_page_path
+      res[:page_title] = @doop[res[:page_path]]["_nav_name"]
+      res[:all_pages] = get_all_pages
+      res[:debug_on] = @debug_on_block != nil ? @debug_on_block.call : false
+      @controller.render "index", :locals => { :res => res, :doop => @doop }
+    end
+
+    def load
+      @doop = Doop.new()
+      @self_before_instance_eval = eval "self", @block.binding
+      instance_exec @doop, &@block
+      @doop.yaml = @load_yaml_block.call
+      @doop.init
+      @doop
+    end
+
+    def in_doop
+      load
+      res = yield(@doop)
+      @save_yaml_block.call @doop.dump
+      return res if res.kind_of? Hash
+      {}
+    end
+
+    def evaluate(block)
+      @self_before_instance_eval = eval "self", block.binding
+      instance_eval &block
+    end
+
+    def method_missing(method, *args, &block)
+      @self_before_instance_eval.send method, *args, &block
+    end
+
+    def current_page &block
+      @current_page_block = block
+    end
+
+    def all_pages &block
+      @all_pages_block = block
+    end
+
+    def get_page
+      path = @doop.currently_asked
+      @doop[@current_page_block.call( path )]["_page"]
+    end
+
+    def get_page_path
+      path = @doop.currently_asked
+      @current_page_block.call( path )
+    end
+
+    def get_all_pages
+      @all_pages_block.call
+    end
+
+    def debug_on &block
+      @debug_on_block = block
+    end
+
+    def load_yaml &block
+      @load_yaml_block = block
+    end
+
+    def save_yaml &block
+      @save_yaml_block = block
+    end
+
+    def default_current_page path 
+      a = path.split("/").reject {|s| s.empty? }[1] 
+      "/page/#{a}"
+    end
+
+    def default_all_pages 
+      l = []
+      doop.each_question_with_regex_filter "^\/page/\\w+$" do |question,path|
+        l << path if doop[path]["_enabled"]
+      end
+      l
+    end
+  end
+end

data/lib/generators/doopgovuk/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates a demo govuk questionaire.  It's fully functional and demonstrates the various integration points with the doop framework.
+    
+    Use this as a starting point for generating any govuk branded website.
+
+Example:
+    rails generate doopgovuk dvla
+    rails s
+
+    Naviagte to http://localhost:3000

data/lib/generators/doopgovuk/doopgovuk_generator.rb

@@ -0,0 +1,34 @@
+class DoopgovukGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :name, :type => :string, :default => "demo"
+
+
+  def generate_layout
+    copy_file "app/assets/stylesheets/demo.css.scss", "app/assets/stylesheets/#{name}.css.scss"
+    template "app/controllers/demo_controller.rb", "app/controllers/#{name}_controller.rb"
+    copy_file "app/views/demo/index.html.erb",  "app/views/#{name}/index.html.erb"
+    copy_file "app/views/demo/index.js.erb",  "app/views/#{name}/index.js.erb"
+    copy_file "app/views/demo/_preamble.html.erb",  "app/views/#{name}/_preamble.html.erb"
+    copy_file "app/views/demo/_summary.html.erb",  "app/views/#{name}/_summary.html.erb"
+    copy_file "app/views/demo/_your_details.html.erb",  "app/views/#{name}/_your_details.html.erb"
+    copy_file "app/views/layouts/application.html.erb",  "app/views/layouts/application.html.erb"
+    copy_file "app/views/doop/_error.html.erb",  "app/views/doop/_error.html.erb"
+    copy_file "app/views/doop/_info_box.html.erb",  "app/views/doop/_info_box.html.erb"
+    copy_file "app/views/doop/_navbar.html.erb",  "app/views/doop/_navbar.html.erb"
+    copy_file "app/views/doop/_question_form.html.erb",  "app/views/doop/_question_form.html.erb"
+    copy_file "app/views/doop/_question.html.erb",  "app/views/doop/_question.html.erb"
+
+
+    route "root '#{name}#index'"
+    route "get '#{name}/index'"
+    route "post '#{name}/answer'"
+
+    gem 'govuk_frontend_toolkit'
+    gem 'govuk_template'
+
+    Bundler.with_clean_env do
+      run "bundle install"
+    end
+
+  end
+end

data/lib/generators/doopgovuk/templates/app/assets/stylesheets/demo.css.scss

@@ -0,0 +1,188 @@
+// Place all the styles related to the demo controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
+
+@import "design-patterns/alpha-beta";
+@import "_conditionals";
+@import "_typography";
+@import "_colours";
+@import "_css3";
+@import "design-patterns/buttons";
+
+$question_completed_color: #D2E6DB;
+$question_completed_line_color: #84BA9D;
+$question_completed_font_color: $black;
+$question-fg-color: #014c73;
+
+
+* {
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+.phase-banner {
+  @include phase-banner(alpha);
+}
+
+.outer-block {
+  @include outer-block;
+}
+
+.inner-block {
+  @include inner-block;
+  margin: 0 0 15px 0;
+}
+
+.info_box {
+  display: block;
+  margin: 15px 0 15px 0;
+  max-width: 100%;
+  min-height: 60px;
+  //outline: solid #a1bfd8 1px;
+  border: solid #d1e4f2 5px;
+  padding: 0 0 0 0;
+  background: #e1effa;
+  border-radius: 0.15em;
+  p {
+    margin: 0.75em 0.75em 0.75em 0.75em;
+  }
+
+  .info_img {
+    float: right;
+    margin: 10px 10px 10px 10px;
+  }
+}
+
+.question-open {
+  margin: 16px 0 16px 0;
+
+}
+
+.indent {
+  margin: 0 0 0 10px;
+}
+
+.question-closed {
+  background: $question_completed_color;
+  border-bottom: solid $question_completed_line_color 1px;
+  color: $question_completed_font_color;
+  display: table;
+  padding: 0.5em 0.5em 0.5em 0.5em;
+  margin: 0 0 0 0;
+  width: 100%;
+
+  .title {
+     padding: 0 0 0 0;
+     display: table-cell;
+     width: 80%;
+     vertical-align: middle;
+  }
+
+  .answer {
+    display: table-cell;
+    max-width: 20%;
+    text-align: right;
+    vertical-align: middle;
+    .button {
+      @include button($question-fg-color);
+      margin: 0 0 0 0;
+    }
+  }
+
+}
+
+.question_form {
+  @include core-16();
+  width: 100%;
+  h1 { 
+    @include bold-36();
+    border-width: 0 0 2px 0;
+    border-style: solid;
+    border-color: #d43783;
+    margin: 0 0 0 0;
+    padding: 5px 0 5px 0;
+  }
+
+  h2 {
+    @include bold-27();
+    padding: 0 0 10px 0;
+  }
+
+  input {
+    @include core-16();
+    width: 200px;
+  }
+
+}
+
+
+.textfield {
+
+  margin: 0 0 10px 0;
+
+  label {
+    display: block;
+    @include bold-16();
+    margin: 0 0 1px 0;
+  }
+
+}
+
+button {
+  @include button;
+  margin: 16px 0 0 0;
+
+}
+
+.button-secondary{
+  @include button($grey-3);
+}
+
+.button-warning {
+@include button($red);
+}
+
+.error {
+  margin: 0 0 10px 0;
+  span {
+    color: red;
+    border: 1px solid #B01117;
+    background-color: #FFF3CF;
+    padding: 5px 5px 5px 5px;
+    border-radius: 5px;
+
+  }
+}
+
+.navbar {
+
+  border-width: 0 0 1px 0;
+  border-style: dotted;
+  border-color: #bfc1c3;
+
+  ol {
+    list-style-type: none;
+    margin: 0;
+    padding: 10px;
+    text-align: center;
+  }
+  li.todo {
+    display: inline;
+    margin: 0 30px 0 0;
+    @include core-16();
+  }
+
+  li.doing {
+    display: inline;
+    margin: 0 30px 0 0;
+    @include bold-16();
+  }
+
+  li.done {
+    display: inline;
+    margin: 0 30px 0 0;
+    @include core-16();
+  }
+}
+

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

@@ -0,0 +1,155 @@
+
+require 'doop'
+require 'yaml'
+
+class <%=name.capitalize%>Controller < ApplicationController
+
+  delegate :index, :answer, to: :@doop_controller
+  before_filter :setup_doop
+
+  def setup_doop
+    @doop_controller = Doop::DoopController.new self do |doop|
+
+      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
+        end
+
+        <<-EOS
+          page: {
+            preamble: {
+              _page: "preamble",
+              _nav_name: "Apply Online",
+
+              debug_on: {
+                _question: "Turn debug on ?",
+                _answer: "No"
+              },
+              enrolled_before: {
+                _question: "Have you enrolled for this service before ?"
+              },
+              year_last_applied: {
+                _question: "What year did you last apply?"
+              },
+              reason_for_applying: {
+                _question: "Why are you applying?"
+              }
+            },
+            your_details: {
+              _page: "your_details",
+              _nav_name: "Your Details",
+
+              your_name: {
+                _question: "What is your name?",
+                _answer: {},
+              },
+              address_history: {
+                _question: "What is your address ?",
+                address__1: { _answer: {} }
+              }
+
+            },
+            summary: {
+              _page: "summary",
+              _nav_name: "Summary",
+
+              terms_and_conditions: {
+                _question: "Terms and conditions"
+              }
+            }
+
+          }
+        EOS
+
+      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
+      end
+
+      debug_on do 
+        doop["/page/preamble/debug_on/_answer"] == "Yes"
+      end
+
+      # On answer call backs
+
+      on_answer "/page/preamble/debug_on"  do |question,path, params, answer|
+        answer_with( question, { "_summary" => answer } )
+      end
+
+      on_answer "/page/preamble/enrolled_before"  do |question,path, params, answer|
+        answer_with( question, { "_summary" => answer } )
+        enable( "/page/preamble/year_last_applied", answer == "Yes" )
+      end
+
+      on_answer "/page/preamble/year_last_applied" do |question,path,params,answer|
+        answer_with( question, { "_summary" => answer } )
+      end
+
+      on_answer "/page/preamble/reason_for_applying" do |question,path,params,answer|
+        if answer.empty? 
+          next { :reason_for_applying_error => "This can not be blank" }
+        end
+
+        answer_with( question, { "_summary" => "Provided" } )
+      end
+
+      on_answer( "/page/preamble" ) do |question, path, params, answer|
+        answer_with( question, { "_summary" => "Provided" } )
+      end
+
+      on_answer( "/page/your_details/your_name" ) do |question, path, params, answer|
+        firstname = answer["firstname"].capitalize
+        surname = answer["surname"].capitalize
+        answer_with( question, { "_summary" => "#{firstname} #{surname}" } )
+      end
+
+      on_answer( "/page/your_details/address_history/address__(\\d+)" ) do |question, path, params, answer|
+
+        if params.include?("remove_address")
+          remove path
+          next
+        end
+
+        address1 = answer["address1"]
+        address2 = answer["address2"]
+        address3 = answer["address3"]
+        postcode = answer["postcode"]
+        summary = [address1, address2, address3, postcode].select{ |n| !n.empty? }.join( ", ")
+        answer_with( question, { "_summary" => summary } )
+
+      end
+
+      on_answer( "/page/your_details/address_history" ) do |question, path, params, answer|
+        if params.include?("add_address")
+          address = YAML.load("{ _answer: {}}")
+          add( "/page/your_details/address_history/address__99", address )
+          renumber( "/page/your_details/address_history" )
+          next
+        end
+
+        answer_with( question, { "_summary" => "Provided" } )
+      end
+
+      on_answer( "/page/your_details" ) do |question, path, params, answer|
+        answer_with( question, { "_summary" => "Provided" } )
+      end
+
+      on_answer( "/page/your_details" ) do |question, path, params, answer|
+        answer_with( question, { "_summary" => "Provided" } )
+      end
+
+      on_answer( "/page/summary/terms_and_conditions" ) do |question, path, params, answer|
+        answer_with( question, { "_summary" => "Accepted" } )
+      end
+
+    end
+  end
+
+
+end
+