census 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Envy Labs LLC
+
+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.rdoc

@@ -0,0 +1,5 @@
+= Census
+
+Census is a Rails plugin that collects searchable demographics data for each
+of your application's users. The data to be collected is defined using a simple
+admin interface that Census provides.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "census"
+    gem.summary     = %Q{Rails user demographics collection and searching}
+    gem.description = %Q{Census is a Rails plugin that collects searchable demographics data for each of your application's users.}
+    gem.email       = "mark@envylabs.com"
+    gem.homepage    = "http://github.com/envylabs/census"
+    gem.authors     = ["Mark Kendall"]
+    gem.files       = FileList["[A-Z]*", "{app,config,generators,lib,shoulda_macros,rails}/**/*"]
+    
+    gem.add_dependency "acts_as_list", ">= 0.1.2"
+    gem.add_dependency "inverse_of", ">= 0.0.1"
+    
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "factory_girl", ">= 0"    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+namespace :test do
+  Rake::TestTask.new(:basic => ["check_dependencies",
+                                "generator:cleanup",
+                                "generator:census"]) do |task|
+    task.libs << "lib"
+    task.libs << "test"
+    task.pattern = "test/{controllers,models}/*_test.rb"
+    task.verbose = false
+  end
+end
+
+task :default => ['test:basic']
+
+generators = %w(census)
+
+namespace :generator do
+  desc "Cleans up the test app before running the generator"
+  task :cleanup do
+    FileList["test/rails_root/db/**/*"].each do |each|
+      FileUtils.rm_rf(each)
+    end
+    
+    FileUtils.rm_rf("test/rails_root/vendor/plugins/census")
+    FileUtils.mkdir_p("test/rails_root/vendor/plugins")
+    census_root = File.expand_path(File.dirname(__FILE__))
+    system("ln -s \"#{census_root}\" test/rails_root/vendor/plugins/census")
+  end
+  
+  desc "Run the census generator"
+  task :census do
+    system "cd test/rails_root && ./script/generate census -f && rake gems:unpack && rake db:migrate db:test:prepare"
+  end
+  
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "Census #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/census/data_groups_controller.rb

@@ -0,0 +1,44 @@
+class Census::DataGroupsController < ApplicationController
+  
+  def index
+    @data_groups = DataGroup.all(:order => :position)
+  end
+
+  def new
+    @data_group = DataGroup.new(params[:data_group])
+  end
+  
+  def create
+    @data_group = DataGroup.new(params[:data_group])
+    
+    if @data_group.save
+      flash[:notice] = "Created #{@data_group.name}"
+      redirect_to census_admin_path
+    else
+      render :action => 'new', :status => :unprocessable_entity
+    end
+  end
+  
+  def edit
+    @data_group = DataGroup.find(params[:id])
+  end
+  
+  def update
+    @data_group = DataGroup.find(params[:id])
+    
+    if @data_group.update_attributes(params[:data_group])
+      flash[:notice] = "Saved #{@data_group.name}"
+      redirect_to census_admin_path
+    else
+      render :action => 'edit', :status => :unprocessable_entity
+    end
+  end
+  
+  def destroy
+    @data_group = DataGroup.find(params[:id])
+    @data_group.destroy
+    flash[:notice] = "Deleted #{@data_group.name}"
+    redirect_to census_admin_path
+  end
+
+end

data/app/helpers/census_helper.rb

@@ -0,0 +1,15 @@
+module CensusHelper
+  
+  def link_to_remove_fields(name, form)
+    form.hidden_field(:_destroy) + link_to_function(name, "remove_fields(this)")
+  end
+  
+  def link_to_add_fields(name, form, association)
+    new_object = form.object.class.reflect_on_association(association).klass.new
+    fields = form.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
+      render(association.to_s.singularize + "_fields", :form => builder)
+    end
+    link_to_function(name, h("add_fields(this, \"#{association}\", \"#{escape_javascript(fields)}\")"))
+  end
+  
+end

data/app/models/answer.rb

@@ -0,0 +1,43 @@
+class Answer < ActiveRecord::Base
+
+  belongs_to :question
+  belongs_to :user
+  
+  validates_presence_of :question,
+                        :user
+                        
+  validate :ensure_valid_choice
+  validate :ensure_valid_data_type
+  validate :check_multiple_answers
+  
+  named_scope :for_user, lambda { |user| { :conditions => {:user_id => user.id} } }
+  
+  def formatted_data
+    question.format_data(self.data)
+  end
+
+  def to_s
+    question.to_s(self.data)
+  end
+  
+  
+  private
+  
+  
+  def ensure_valid_choice
+    return if question.blank? || data.blank?
+    errors.add_to_base("Invalid choice for #{question.prompt}") if question.restrict_values? && !question.choices.map(&:value).include?(self.data)
+  end
+  
+  def ensure_valid_data_type
+    return if question.blank? || data.blank?
+    message = question.validate_data(data)
+    errors.add_to_base("#{question.prompt} #{message}") if message
+  end
+  
+  def check_multiple_answers
+    return if question.blank? || user.blank?
+    errors.add_to_base("Only one answer allowed for #{question.prompt}") if new_record? && question.answers.for_user(user).size > 0 && !question.multiple?
+  end
+  
+end

data/app/models/choice.rb

@@ -0,0 +1,9 @@
+class Choice < ActiveRecord::Base
+
+  belongs_to :question, :inverse_of => :choices
+  acts_as_list :scope => :question
+  
+  validates_presence_of :value,
+                        :question
+  
+end

data/app/models/data_group.rb

@@ -0,0 +1,10 @@
+class DataGroup < ActiveRecord::Base
+
+  acts_as_list
+
+  has_many :questions, :dependent => :destroy, :inverse_of => :data_group
+  accepts_nested_attributes_for :questions, :reject_if => lambda { |a| a[:prompt].blank? }, :allow_destroy => true
+  
+  validates_presence_of :name
+  
+end

data/app/models/question.rb

@@ -0,0 +1,54 @@
+class Question < ActiveRecord::Base
+
+  belongs_to :data_group, :inverse_of => :questions
+  acts_as_list :scope => :data_group
+  
+  has_many :choices, :dependent => :destroy, :inverse_of => :question
+  accepts_nested_attributes_for :choices, :reject_if => lambda { |a| a[:value].blank? }, :allow_destroy => true
+  
+  has_many :answers, :dependent => :destroy
+  
+  validates_presence_of :prompt,
+                        :data_group
+                 
+  def sql_transform(column_name = '?')
+    data_type_definition.sql_transform.call(column_name)
+  end
+  
+  def format_data(data)
+    data_type_definition.format_data.call(data)
+  end
+  
+  def validate_data(data)
+    data_type_definition.validate_data.call(data)
+  end
+  
+  def to_s(data)
+    format_data(data).to_s
+  end
+  
+  def find_answers_matching(value)
+    answers.find(:all, :conditions => conditions_for(value), :include => :user)
+  end
+  
+  def restrict_values?
+    choices.present? && !other?
+  end
+
+
+  private
+  
+  
+  def data_type_definition
+    Census::DataType.find(data_type) || Census::DataType.find('String')
+  end
+  
+  def conditions_for(value)
+    if value.kind_of?(Range) || value.kind_of?(Array)
+      ["#{sql_transform('data')} IN (?)", value]
+    else
+      ["#{sql_transform('data')} = #{sql_transform}", value]
+    end
+  end
+  
+end

data/app/views/census/_question_fields.html.erb

@@ -0,0 +1,40 @@
+<% if question.choices.empty? -%>
+  <% answer = user.first_answer_for(question) -%>
+  <% fields_for "user[answers_attributes][#{user.answers.index(answer)}]", answer do |builder| -%>
+    <%= builder.hidden_field :id %>
+    <%= builder.hidden_field :question_id %>
+    <div class="text_field">
+      <%= builder.label :data, question.prompt %>
+      <%= builder.text_field :data %>
+    </div>
+  <% end -%>
+
+<% elsif question.multiple? -%>
+  <div class="checkboxes">
+    <%= label_tag question.prompt %>
+    <ul>
+      <% question.choices.each do |choice| -%>
+        <% answer = user.answer_for_choice(choice) -%>
+        <% fields_for "user[answers_attributes][#{user.answers.index(answer)}]", answer do |builder| -%>
+          <%= builder.hidden_field :id %>
+          <%= builder.hidden_field :question_id %>
+          <li>
+            <%= builder.check_box :data, {}, choice.value, '' %>
+            <%= builder.label :data, choice.value %>
+          </li>
+        <% end -%>
+      <% end -%>
+    </ul>
+  </div>
+
+<% else -%>
+  <% answer = user.first_answer_for(question) -%>
+  <% fields_for "user[answers_attributes][#{user.answers.index(answer)}]", answer do |builder| -%>
+    <%= builder.hidden_field :id %>
+    <%= builder.hidden_field :question_id %>
+    <div class="select_field">
+      <%= builder.label :data, question.prompt %>
+      <%= builder.collection_select :data, question.choices, :value, :value, :include_blank => true %>
+    </div>
+  <% end -%>
+<% end -%>

data/app/views/census/_user_answers.html.erb

@@ -0,0 +1,10 @@
+<div class="census_answers">
+  <% DataGroup.all.each do |group| -%>
+    <h3><%=h group.name %></h3>
+    <ul>
+      <% group.questions.each do |question| -%>
+        <li><b><%=h question.prompt %></b> <%=h user.all_answers_for(question).map(&:data).join(', ') %></li>
+      <% end -%>
+    </ul>
+  <% end -%>
+</div>

data/app/views/census/_user_questions.html.erb

@@ -0,0 +1,10 @@
+<div class="census_questions">
+  <% DataGroup.all.each do |group| -%>
+    <fieldset>
+      <legend><%=h group.name %></legend>
+      <% group.questions.each do |question| -%>
+        <%= render 'census/question_fields', :question => question, :user => user %>
+      <% end -%>
+    </fieldset>
+  <% end -%>
+</div>

data/app/views/census/data_groups/_choice_fields.html.erb

@@ -0,0 +1,4 @@
+<div class="fields">
+  <%= form.text_field :value %>
+  <%= link_to_remove_fields "remove", form %>
+</div>

data/app/views/census/data_groups/_form.html.erb

@@ -0,0 +1,11 @@
+<%= form.error_messages %>
+<div class="text_field">
+  <%= form.label :name, "Group Name" %>
+  <%= form.text_field :name %>
+</div>
+<% form.fields_for :questions do |builder| %>
+  <%= render "question_fields", :form => builder %>
+<% end %>
+<div>
+  <%= link_to_add_fields "Add Question", form, :questions %>
+</div>

data/app/views/census/data_groups/_question_fields.html.erb

@@ -0,0 +1,22 @@
+<fieldset class="fields">
+  <legend>Question <%= form.object.position %></legend>
+  <div class="question">
+    <%= form.label :prompt, "Label" %>
+    <%= form.text_field :prompt %>
+    <%= link_to_remove_fields "remove", form %>
+    <br/>
+    <%= form.label :data_type %>
+    <%= form.collection_select :data_type, Census::DataType.all, :name, :name %>
+  </div>
+  <fieldset>
+    <legend>Answer Choices (leave empty to allow freeform text entry)</legend>
+    <% form.fields_for :choices do |builder| %>
+      <%= render 'choice_fields', :form => builder %>
+    <% end %>
+    <div>
+      <%= link_to_add_fields "Add Answer", form, :choices %>
+    </div>
+    <%= form.check_box :multiple %>
+    <%= form.label :multiple, "Allow multiple selections" %>
+  </fieldset>
+</fieldset>

data/app/views/census/data_groups/edit.html.erb

@@ -0,0 +1,7 @@
+<% form_for [:census, @data_group], :html => { :class => "census_data_group_form" } do |form| %>
+<fieldset>
+  <legend>Edit Census Data Group</legend>
+  <%= render :partial => 'form', :object => form %>
+  <%= form.submit 'Save', :disable_with => 'Please wait...' %>
+</fieldset>
+<% end %>

data/app/views/census/data_groups/index.html.erb

@@ -0,0 +1,10 @@
+<h2>Census Data Groups</h2>
+<ul class="census_data_group_list">
+  <% @data_groups.each do |group| %>
+    <li>
+      <%=link_to group.name, edit_census_data_group_path(group) %> 
+    </li>
+  <% end %>
+</ul>
+
+<%= link_to 'New Group', new_census_data_group_path %>

data/app/views/census/data_groups/new.html.erb

@@ -0,0 +1,7 @@
+<% form_for [:census, @data_group], :html => { :class => "census_data_group_form" } do |form| %>
+<fieldset>
+  <legend>New Census Data Group</legend>
+  <%= render :partial => 'form', :object => form %>
+  <%= form.submit 'Save', :disable_with => 'Please wait...' %>
+</fieldset>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+
+  map.namespace :census do |census|
+    census.resources :data_groups, :except => [:index, :show]
+    census.admin 'admin', :controller => 'data_groups', :action => 'index'
+  end
+
+end

data/generators/census/USAGE

@@ -0,0 +1 @@
+script/generate census

data/generators/census/census_generator.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class CensusGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory File.join("config", "initializers")
+      m.file "census.rb",  "config/initializers/census.rb"
+      
+      m.directory File.join("public", "javascripts")
+      m.file "census.js", "public/javascripts/census.js"
+      
+      user_model = "app/models/user.rb"
+      if File.exists?(user_model)
+        m.insert_into user_model, "include Census::User"
+      else
+        m.directory File.join("app", "models")
+        m.file "user.rb", user_model
+      end
+
+      m.directory File.join("test", "factories")
+      m.file "factories.rb", "test/factories/census.rb"
+
+      if ActiveRecord::Base.connection.table_exists?(:users)
+        m.migration_template "migrations/without_users.rb",
+                             'db/migrate',
+                             :migration_file_name => "create_census_tables"
+      else
+        m.migration_template "migrations/with_users.rb",
+                             'db/migrate',
+                             :migration_file_name => "create_census_tables"
+      end
+      
+      m.readme "README"
+    end
+  end
+
+end

data/generators/census/lib/insert_commands.rb

@@ -0,0 +1,33 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      gsub_file file, /^(class|module|.*Routes).*$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/census/lib/rake_commands.rb

@@ -0,0 +1,22 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+    unless system("rake db:migrate")
+      logger.rake "db:migrate failed. Rolling back"      
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake_db_migrate
+    logger.rake "db:rollback"  
+    system "rake db:rollback"  
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"    
+  end
+end

data/generators/census/templates/README

@@ -0,0 +1,29 @@
+
+*******************************************************************************
+
+Next:
+
+1. In order for the question admin views to work, you'll need to include both
+   jQuery and the census.js file in your application layout:
+
+     <%= javascript_include_tag 'http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js' %>
+     <%= javascript_include_tag 'census' %>
+
+2. Add a link to the question admin page somewhere in your app:
+
+     <%= link_to 'Set up questions', census_admin_path %>
+
+3. Include the partial that displays answers in your user show page:
+
+     <%= render 'census/user_answers', :user => @user %>
+
+4. Include the partial that allows the user to enter answers in your user
+   edit page:
+
+     <%= render 'census/user_questions', :user => @user %>
+
+5. Migrate your database:
+
+     rake db:migrate
+
+*******************************************************************************

data/generators/census/templates/census.js

@@ -0,0 +1,10 @@
+function remove_fields(link) {
+  $(link).prev("input[type=hidden]").val("1");
+  $(link).closest(".fields").hide();
+}
+
+function add_fields(link, association, content) {
+  var new_id = new Date().getTime();
+  var regexp = new RegExp("new_" + association, "g")
+  $(link).parent().before(content.replace(regexp, new_id));
+}

data/generators/census/templates/census.rb

@@ -0,0 +1,14 @@
+Census::DataType.define("String")
+
+Census::DataType.define(
+  "Number",
+  :sql_transform  => lambda {|column_name| "CAST(#{column_name} AS SIGNED INTEGER)"},
+  :format_data    => lambda {|data| data.to_i unless data.blank? },
+  :validate_data  => lambda {|data| "must be a number" unless data =~ /^\d*$/}
+)
+
+Census::DataType.define(
+  "Yes/No",
+  :sql_transform  => lambda {|column_name| "CAST(#{column_name} AS CHAR)"},
+  :format_data    => lambda {|data| %w(1 T t Y y).include?(data) unless data.blank? }
+)

data/generators/census/templates/factories.rb

@@ -0,0 +1,24 @@
+Factory.define :answer do |answer|
+  answer.association :question
+  answer.association :user
+  answer.data        'Factory Answer'
+end
+
+Factory.define :choice do |choice|
+  choice.association  :question
+  choice.value        'Factory Choice'
+end
+
+Factory.define :data_group do |group|
+  group.name 'Factory Data Group'
+end
+
+Factory.define :question do |question|
+  question.association  :data_group
+  question.prompt       'Enter your response'
+  question.multiple     false
+  question.other        false
+end
+
+Factory.define :user do |user|
+end

data/generators/census/templates/migrations/with_users.rb

@@ -0,0 +1,60 @@
+class CreateCensusTables < ActiveRecord::Migration
+  def self.up
+    create_table :data_groups do |t|
+      t.string  :name
+      t.integer :position
+      t.timestamps
+    end
+
+    create_table :questions do |t|
+      t.integer :data_group_id
+      t.string  :data_type
+      t.string  :prompt
+      t.boolean :multiple
+      t.boolean :other
+      t.integer :position
+      t.timestamps
+    end
+    
+    add_index :questions, :data_group_id
+    
+    create_table :choices do |t|
+      t.integer :question_id
+      t.string  :value
+      t.integer :position
+      t.timestamps
+    end
+    
+    add_index :choices, :question_id
+    
+    create_table(:users) do |t|
+      t.timestamps
+    end
+
+    create_table :answers do |t|
+      t.integer :question_id
+      t.integer :user_id
+      t.string  :data
+    end
+    
+    add_index :answers, :question_id
+    add_index :answers, :user_id
+    
+  end
+
+  def self.down
+    remove_index :answers, :question_id
+    remove_index :answers, :user_id
+    drop_table :answers
+    
+    drop_table :users
+    
+    remove_index :choices, :question_id
+    drop_table :choices
+    
+    remove_index :questions, :data_group_id
+    drop_table :questions
+    
+    drop_table :data_groups
+  end
+end