spanish_inquisition 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pat Allan and Inspire9
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,83 @@
+h1. SpanishInquisition
+
+Nobody expects the Spanish Inquisition!
+
+h2. Installation
+
+It's a gem - so, like any other gem, add it to your app's Gemfile:
+
+<pre><code>gem 'spanish_inquisition'</code></pre>
+
+And then execute:
+
+<pre><code>$ bundle</code></pre>
+
+Or install it yourself as:
+
+<pre><code>$ gem install spanish_inquisition</code></pre>
+
+h2. Usage
+
+Firstly, you'll want to define your surveys in files within @app/surveys@. Here's a quick example:
+
+<pre><code>SpanishInquisition::Survey.new :inquisition do |survey|
+  survey.page do |page|
+    page.question :weapon do |question|
+      question.text    = 'What is your chief weapon?''
+      question.style   = :one
+      question.answers = ['fear', 'surprise', 'ruthless efficency']
+    end
+
+    page.question :torture do |question|
+      question.text    = 'What do you torture with?'
+      question.style   = :one
+      question.answers = ['The Rack', 'The Cushions', 'The Comfy Chair']
+    end
+  end
+
+  survey.page do |page|
+    page.question :comments do |question|
+      question.text     = 'Do you have any suggestions for better torture devices?'
+      question.style    = :text
+      question.required = false
+    end
+
+    page.question :cardinal do |question|
+      question.text =  'Who is your favourite Cardinal: Ximinex, Biggles or Fang?'
+      question.style = :string
+    end
+  end
+end</code></pre>
+
+Questions are required by default, and currently only three question styles are supported: :string (a standard text field), :text (a multi-line text field, aka the textarea HTML element), and :one (many options, single choice, aka radio inputs). The @answers@ value can be anything that Formtastic accepts as a collection (so both arrays and hashes are valid settings).
+
+Rendering the form is done via a presenter:
+
+<pre><code>survey = SpanishInquisition::Presenter.new :inquisition, params[:survey]</code></pre>
+
+And then, this presenter can be used within a Formtastic-built form in your views:
+
+<pre><code><%= semantic_form_for survey do |form| %>
+  <%= survey.render_to form %>
+  <%= form.actions do %>
+    <%= form.action :submit, :label => 'Save my answers' %>
+  <%- end %>
+<%- end %></code></pre>
+
+When the form is posted back, you will have to persist the results somewhere - they can be obtained via the @answers@ method on the presenter. It will return a hash with each question's identifier as the keys, and the supplied answers as the values.
+
+There's a few more optoins available with questions, but the source is simple and uncomplicated - I'd recommend reading it.
+
+h2. Contributing
+
+This gem is built using "git-flow":https://github.com/nvie/gitflow - so keep in mind that the master branch is the release branch, develop is work-in-progress, and any in-progress features get their own feature branches.
+
+# Fork it
+# Create your feature branch (`git checkout -b feature/name`)
+# Commit your changes (`git commit -am 'Add some feature'`)
+# Push to the branch (`git push origin feature/name`)
+# Create new Pull Request
+
+h2. Licence
+
+Copyright (c) 2013, Spanish Inquisition is developed and maintained by Pat Allan and Inspire9, and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/spanish_inquisition/page.rb

@@ -0,0 +1,14 @@
+class SpanishInquisition::Page
+  attr_reader :questions
+
+  def initialize(&block)
+    @questions = []
+
+    block.call self
+  end
+
+  def question(identifier = nil, &block)
+    identifier ||= "question_#{questions.length}".to_sym
+    questions << SpanishInquisition::Question.new(identifier, &block)
+  end
+end

data/lib/spanish_inquisition/presenter.rb

@@ -0,0 +1,81 @@
+require 'active_model/naming'
+require 'active_model/conversion'
+require 'active_model/validations'
+
+class SpanishInquisition::Presenter
+  include ActiveModel::Conversion
+  include ActiveModel::Validations
+
+  validate :required_answers
+
+  delegate :heading, :description, to: :survey
+
+  def self.model_name
+    ActiveModel::Name.new(self, nil, 'Survey')
+  end
+
+  def initialize(identifier, attributes = {})
+    @survey     = SpanishInquisition.surveys[identifier]
+    @attributes = attributes || {}
+
+    raise SpanishInquisition::SurveyNotFound if @survey.nil?
+  end
+
+  def answers
+    questions.inject({}) do |hash, question|
+      if question.capture?(attributes)
+        hash[question.identifier] = attributes[question.identifier]
+      end
+
+      hash
+    end
+  end
+
+  def id
+    survey.identifier
+  end
+
+  def persisted?
+    true
+  end
+
+  def render_to(form)
+    survey.pages.collect { |page|
+      SpanishInquisition::Presenters::PagePresenter.new(form, page).to_html
+    }.join.html_safe
+  end
+
+  def to_json
+    questions.collect { |question|
+      SpanishInquisition::Presenters::QuestionPresenter.new(nil, question).to_json(attributes)
+    }
+  end
+
+  private
+
+  attr_reader :survey, :attributes
+
+  def invalid_question?(question)
+    question.capture?(attributes) &&
+    question.required? &&
+    attributes[question.identifier].blank?
+  end
+
+  def method_missing(method, *arguments, &block)
+    return attributes[method] if survey.question_identifiers.include?(method)
+
+    super
+  end
+
+  def questions
+    @questions ||= survey.pages.collect(&:questions).flatten
+  end
+
+  def required_answers
+    questions.each do |question|
+      next unless invalid_question?(question)
+
+      errors.add question.identifier, 'must be answered'
+    end
+  end
+end

data/lib/spanish_inquisition/presenters/page_presenter.rb

@@ -0,0 +1,23 @@
+class SpanishInquisition::Presenters::PagePresenter
+  def initialize(form, page)
+    @form, @page = form, page
+  end
+
+  def to_html
+    form.inputs do
+      question_presenters.each do |presenter|
+        form.template.concat presenter.to_html
+      end
+    end
+  end
+
+  private
+
+  attr_reader :form, :page
+
+  def question_presenters
+    @question_presenters ||= page.questions.collect { |question|
+      SpanishInquisition::Presenters::QuestionPresenter.new(form, question)
+    }
+  end
+end

data/lib/spanish_inquisition/presenters/question_presenter.rb

@@ -0,0 +1,31 @@
+class SpanishInquisition::Presenters::QuestionPresenter
+  def initialize(form, question)
+    @form, @question = form, question
+  end
+
+  def to_html
+    case question.style
+    when :one
+      form.input question.identifier, as: :radio, collection: question.answers, label: question.text
+    when :string
+      form.input question.identifier, as: :string, label: question.text
+    when :text
+      form.input question.identifier, as: :text, label: question.text
+    else
+      raise "Unknown question style: #{question.style}"
+    end
+  end
+
+  def to_json(responses = [])
+    {
+      'identifier' => question.identifier,
+      'text'       => question.text,
+      'required'   => question.required,
+      'capture'    => question.capture?(responses)
+    }
+  end
+
+  private
+
+  attr_reader :form, :question
+end

data/lib/spanish_inquisition/question.rb

@@ -0,0 +1,17 @@
+class SpanishInquisition::Question
+  attr_reader   :identifier
+  attr_accessor :text, :style, :answers, :capture, :required
+
+  alias_method :required?, :required
+
+  def initialize(identifier, &block)
+    @identifier = identifier
+    @required   = true
+
+    block.call self
+  end
+
+  def capture?(responses)
+    @capture.nil? || @capture.call(responses)
+  end
+end

data/lib/spanish_inquisition/survey.rb

@@ -0,0 +1,32 @@
+class SpanishInquisition::Survey
+  attr_reader   :identifier, :pages
+  attr_accessor :heading, :description
+
+  def initialize(identifier, &block)
+    @identifier = identifier
+    @pages      = []
+
+    block.call self if block
+
+    SpanishInquisition.surveys[identifier] = self
+  end
+
+  def duplicate_to(identifier)
+    duplicate = self.class.new(identifier)
+
+    duplicate.pages.replace pages.dup
+    duplicate.heading     = heading.dup
+    duplicate.description = description.dup
+
+    duplicate
+  end
+
+  def page(&block)
+    pages << SpanishInquisition::Page.new(&block)
+  end
+
+  def question_identifiers
+    @question_identifiers ||= pages.collect(&:questions).flatten.
+      collect(&:identifier)
+  end
+end

data/lib/spanish_inquisition/survey_not_found.rb

@@ -0,0 +1,3 @@
+class SpanishInquisition::SurveyNotFound < StandardError
+  #
+end

data/lib/spanish_inquisition.rb

@@ -0,0 +1,26 @@
+module SpanishInquisition
+  def self.load
+    return if @loaded
+
+    Dir[Rails.root.join('app', 'surveys', '*.rb')].each do |file|
+      ActiveSupport::Dependencies.require_or_load file
+    end
+
+    @loaded = true
+  end
+
+  def self.surveys
+    load
+    @surveys ||= {}
+  end
+
+  module Presenters; end
+end
+
+require 'spanish_inquisition/page'
+require 'spanish_inquisition/presenter'
+require 'spanish_inquisition/presenters/page_presenter'
+require 'spanish_inquisition/presenters/question_presenter'
+require 'spanish_inquisition/question'
+require 'spanish_inquisition/survey'
+require 'spanish_inquisition/survey_not_found'

data/spanish_inquisition.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = 'spanish_inquisition'
+  gem.version       = '1.0.0'
+  gem.authors       = ['Pat Allan']
+  gem.email         = ['pat@freelancing-gods.com']
+  gem.summary       = 'Simple Ruby survey DSL'
+  gem.description   = 'A simple Ruby survey DSL which handles questions and answers. You need to manage persistence yourself.'
+  gem.homepage      = 'https://github.com/inspire9/spanish_inquisition'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'activemodel', '~> 3.2'
+  gem.add_runtime_dependency 'formtastic',  '~> 2.2'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: spanish_inquisition
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: formtastic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A simple Ruby survey DSL which handles questions and answers. You need
+  to manage persistence yourself.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- lib/spanish_inquisition.rb
+- lib/spanish_inquisition/page.rb
+- lib/spanish_inquisition/presenter.rb
+- lib/spanish_inquisition/presenters/page_presenter.rb
+- lib/spanish_inquisition/presenters/question_presenter.rb
+- lib/spanish_inquisition/question.rb
+- lib/spanish_inquisition/survey.rb
+- lib/spanish_inquisition/survey_not_found.rb
+- spanish_inquisition.gemspec
+homepage: https://github.com/inspire9/spanish_inquisition
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple Ruby survey DSL
+test_files: []
+has_rdoc: