spanish_inquisition 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ed41d5bda96b89d370071a7673504bb4d866977
+  data.tar.gz: 63240287af68ad7ea31e3cf77263b71bd896e205
+SHA512:
+  metadata.gz: 8db82ae49a050f989964efb852890d64be8e7fcf3412bcacc471207ee1085ec90d3d5a4959a2fe84744391f0f7962cbc8d09eeed9594391c810c9744c2436a14
+  data.tar.gz: b80da4adcd29e5dc3602aede46ccc4ad2c3f3b308c3806242427c808ff102b338d18b7cb910265cfbaf07cc0ad0e45c34b4840ba4933a218ad9b134ad4e4a760

data/README.textile

@@ -1,7 +1,9 @@
-h1. SpanishInquisition
+h1. Spanish Inquisition
 
 Nobody expects the Spanish Inquisition!
 
+This is a simple and opinionated survey library for Rails. It generates the form using Formtastic, and it does not deal with persistence - the surveys are plain Ruby objects, not ActiveRecord objects. It fulfills our needs at Inspire9 nicely - and perhaps it's what you're looking for too.
+
 h2. Installation
 
 It's a gem - so, like any other gem, add it to your app's Gemfile:

data/lib/spanish_inquisition.rb

@@ -14,9 +14,14 @@ module SpanishInquisition
     @surveys ||= {}
   end
 
+  def self.defaults
+    @defaults ||= {}
+  end
+
   module Presenters; end
 end
 
+require 'spanish_inquisition/attributes'
 require 'spanish_inquisition/page'
 require 'spanish_inquisition/presenter'
 require 'spanish_inquisition/presenters/page_presenter'

data/lib/spanish_inquisition/attributes.rb

@@ -0,0 +1,51 @@
+require 'date'
+
+class SpanishInquisition::Attributes
+  def initialize(values, types)
+    @values = translate values, types
+  end
+
+  def [](key)
+    @values[key]
+  end
+
+  def to_hash
+    @values
+  end
+
+  private
+
+  def translate(values, types)
+    types.keys.inject({}) do |hash, key|
+      case types[key]
+      when :date
+        hash[key] = translate_date key, values
+      when :location
+        hash[key]      = values[key]
+        hash[:lat]     = values[:lat]
+        hash[:lng]     = values[:lng]
+        hash[:state]   = values[:state]
+        hash[:country] = values[:country]
+      else
+        hash[key] = values[key]
+      end
+
+      hash
+    end
+  end
+
+  def translate_date(key, values)
+    case values[key]
+    when String
+      Date.parse values[key]
+    when NilClass
+      parts = ["#{key}(1i)".to_sym, "#{key}(2i)".to_sym, "#{key}(3i)".to_sym]
+
+      unless parts.any? { |part| values[part].nil? || values[part].empty? }
+        Date.new *parts.collect { |part| values[part].to_i }
+      end
+    else
+      values[key]
+    end
+  end
+end

data/lib/spanish_inquisition/presenter.rb

@@ -6,6 +6,9 @@ class SpanishInquisition::Presenter
   include ActiveModel::Conversion
   include ActiveModel::Validations
 
+  LOCATION_IDENTIFIERS = [:lat, :lng, :state, :country]
+  REQUIRED_LOCATION_IDENTIFIERS = [:lat, :lng]
+
   validate :required_answers
 
   delegate :heading, :description, to: :survey
@@ -16,16 +19,18 @@ class SpanishInquisition::Presenter
 
   def initialize(identifier, attributes = {})
     @survey     = SpanishInquisition.surveys[identifier]
-    @attributes = attributes || {}
+    @attributes = SpanishInquisition::Attributes.new(
+      attributes || {}, question_types
+    )
 
     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
+      question_identifiers(question).each do |identifier|
+        hash[identifier] = attributes[identifier]
+      end if question.capture?(attributes)
 
       hash
     end
@@ -45,9 +50,15 @@ class SpanishInquisition::Presenter
     }.join.html_safe
   end
 
+  def respond_to?(method, include_all = false)
+    survey.question_identifiers.include?(method)                  ||
+    (LOCATION_IDENTIFIERS.include?(method) && location_question?) ||
+    super
+  end
+
   def to_json
     questions.collect { |question|
-      SpanishInquisition::Presenters::QuestionPresenter.new(nil, question).to_json(attributes)
+      SpanishInquisition::Presenters::QuestionPresenter.new(nil, question).to_json(attributes.to_hash)
     }
   end
 
@@ -58,11 +69,22 @@ class SpanishInquisition::Presenter
   def invalid_question?(question)
     question.capture?(attributes) &&
     question.required? &&
-    attributes[question.identifier].blank?
+    question_identifiers(question, true).any? { |identifier|
+      attributes[identifier].blank?
+    }
+  end
+
+  def location_question?
+    survey.pages.collect(&:questions).flatten.any? { |question|
+      question.style == :location
+    }
   end
 
   def method_missing(method, *arguments, &block)
-    return attributes[method] if survey.question_identifiers.include?(method)
+    return attributes[method] if survey.question_identifiers.include? method
+    if LOCATION_IDENTIFIERS.include?(method) && location_question?
+      return attributes[method]
+    end
 
     super
   end
@@ -71,11 +93,33 @@ class SpanishInquisition::Presenter
     @questions ||= survey.pages.collect(&:questions).flatten
   end
 
+  def question_identifiers(question, required = false)
+    return [question.identifier] unless question.style == :location
+
+    if required
+      [question.identifier] + REQUIRED_LOCATION_IDENTIFIERS
+    else
+      [question.identifier] + LOCATION_IDENTIFIERS
+    end
+  end
+
+  def question_types
+    questions.inject({}) do |hash, question|
+      hash[question.identifier] = question.type
+      hash
+    end
+  end
+
   def required_answers
     questions.each do |question|
       next unless invalid_question?(question)
 
-      errors.add question.identifier, 'must be answered'
+      case question.style
+      when :location
+        errors.add question.identifier, 'must be selected from the prompted options'
+      else
+        errors.add question.identifier, 'must be answered'
+      end
     end
   end
 end

data/lib/spanish_inquisition/presenters/question_presenter.rb

@@ -7,10 +7,32 @@ class SpanishInquisition::Presenters::QuestionPresenter
     case question.style
     when :one
       form.input question.identifier, as: :radio, collection: question.answers, label: question.text
+    when :many
+      form.input question.identifier, as: :check_boxes, collection: question.answers, label: question.text
+    when :file
+      form.input question.identifier, as: :file, label: question.text
+    when :password
+      form.input question.identifier, as: :password, label: question.text
+    when :date_select
+      form.input question.identifier,
+        {as: :date_select, label: question.text}.merge(date_options)
+    when :datetime_select
+      form.input question.identifier,
+        {as: :datetime_select, label: question.text}.merge(date_options)
+    when :time_select
+      form.input question.identifier, as: :time_select, 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
+    when :location
+      [
+        form.input(question.identifier, as: :string, label: question.text, input_html: { class: 'location' }),
+        form.input(:lat, as: :hidden, input_html: {class: 'lat'}),
+        form.input(:lng, as: :hidden, input_html: {class: 'lng'}),
+        form.input(:state, as: :hidden, input_html: {class: 'state'}),
+        form.input(:country, as: :hidden, input_html: {class: 'country'})
+      ].join(' ').html_safe
     else
       raise "Unknown question style: #{question.style}"
     end
@@ -28,4 +50,8 @@ class SpanishInquisition::Presenters::QuestionPresenter
   private
 
   attr_reader :form, :question
+
+  def date_options
+    SpanishInquisition.defaults.dup
+  end
 end

data/lib/spanish_inquisition/question.rb

@@ -14,4 +14,11 @@ class SpanishInquisition::Question
   def capture?(responses)
     @capture.nil? || @capture.call(responses)
   end
+
+  def type
+    return :date     if style == :date_select
+    return :location if style == :location
+
+    :string
+  end
 end

data/spanish_inquisition.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = 'spanish_inquisition'
-  gem.version       = '1.0.0'
+  gem.version       = '1.1.0'
   gem.authors       = ['Pat Allan']
   gem.email         = ['pat@freelancing-gods.com']
   gem.summary       = 'Simple Ruby survey DSL'

data/spec/spanish_inquisition/attributes_spec.rb

@@ -0,0 +1,56 @@
+module SpanishInquisition
+end
+
+require './lib/spanish_inquisition/attributes'
+
+describe SpanishInquisition::Attributes do
+  describe '#[]' do
+    it "returns provided attribute values" do
+      SpanishInquisition::Attributes.new(
+        {:foo => 'bar'}, {:foo => :string}
+      )[:foo].should == 'bar'
+    end
+
+    it "returns dates for date params" do
+      SpanishInquisition::Attributes.new({
+        :"created_on(1i)" => '2013',
+        :"created_on(2i)" => '6',
+        :"created_on(3i)" => '11'
+      }, {:created_on => :date})[:created_on].should == Date.new(2013, 6, 11)
+    end
+
+    it "ignores date params if any are blank" do
+      SpanishInquisition::Attributes.new({
+        :"created_on(1i)" => '2013',
+        :"created_on(2i)" => '6',
+        :"created_on(3i)" => ''
+      }, {:created_on => :date})[:created_on].should be_nil
+
+      SpanishInquisition::Attributes.new({
+        :"created_on(1i)" => '2013',
+        :"created_on(2i)" => '',
+        :"created_on(3i)" => '11'
+      }, {:created_on => :date})[:created_on].should be_nil
+
+      SpanishInquisition::Attributes.new({
+        :"created_on(1i)" => '',
+        :"created_on(2i)" => '6',
+        :"created_on(3i)" => '11'
+      }, {:created_on => :date})[:created_on].should be_nil
+    end
+
+    it "translates string date values" do
+      SpanishInquisition::Attributes.new(
+        {:created_on => '2013-06-11'},
+        {:created_on => :date}
+      )[:created_on].should == Date.new(2013, 6, 11)
+    end
+
+    it "accepts date values" do
+      SpanishInquisition::Attributes.new(
+        {:created_on => Date.new(2013, 6, 11)},
+        {:created_on => :date}
+      )[:created_on].should == Date.new(2013, 6, 11)
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: spanish_inquisition
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: formtastic
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -57,6 +52,7 @@ files:
 - README.textile
 - Rakefile
 - lib/spanish_inquisition.rb
+- lib/spanish_inquisition/attributes.rb
 - lib/spanish_inquisition/page.rb
 - lib/spanish_inquisition/presenter.rb
 - lib/spanish_inquisition/presenters/page_presenter.rb
@@ -65,29 +61,29 @@ files:
 - lib/spanish_inquisition/survey.rb
 - lib/spanish_inquisition/survey_not_found.rb
 - spanish_inquisition.gemspec
+- spec/spanish_inquisition/attributes_spec.rb
 homepage: https://github.com/inspire9/spanish_inquisition
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Ruby survey DSL
-test_files: []
-has_rdoc: 
+test_files:
+- spec/spanish_inquisition/attributes_spec.rb