census 0.4.1 → 0.4.2

data/README.rdoc

@@ -103,6 +103,27 @@ you can access the user's answers using strings, like this:
   user.census_data['Physical Attributes']['Weight']
   user.census_data['Physical Attributes']['Hair Color']
 
+== Exposing census answers as model attributes
+
+Starting with version 0.4.2, census allows you to expose its data as attributes
+directly on your model class.  This is especially useful if you're trying to display
+census answers in forms and you'd like Rails' default form handling to work for
+that data.
+
+If we assume that you have census questions defined as in the previous section,
+you can add the following in your User class:
+
+  expose_census_data('Physical Attributes', 'Weight', :weight)
+  expose_census_data('Physical Attributes', 'Hair Color', :hair_color)
+
+And then you can get or set the census answers directly on the user, like this:
+
+  user.weight = 148          # set the user's weight
+  user.weight                # returns 148
+
+  user.hair_color = "Blond"  # set the user's hair color
+  user.hair_color            # returns "Blond"
+
 == Searching
 
 Census provides a search interface for finding users whose answers match a list

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

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

@@ -16,7 +16,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :questions, :data_group_id
+    add_index :questions, :data_group_id, :name => "idx_qstns_datagrpid"
     
     create_table :choices do |t|
       t.integer :question_id
@@ -25,7 +25,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :choices, :question_id
+    add_index :choices, :question_id, :name => "idx_choices_qstnid"
     
     create_table(:users) do |t|
       t.timestamps
@@ -37,22 +37,22 @@ class CreateCensusTables < ActiveRecord::Migration
       t.string  :data
     end
     
-    add_index :answers, :question_id
-    add_index :answers, :user_id
+    add_index :answers, :question_id, :name => "idx_answrs_qstnid"
+    add_index :answers, :user_id, :name => "idx_answrs_usrid"
     
   end
 
   def self.down
-    remove_index :answers, :question_id
-    remove_index :answers, :user_id
+    remove_index :answers, :name => "idx_answrs_qstnid"
+    remove_index :answers, :name => "idx_answrs_usrid"
     drop_table :answers
     
     drop_table :users
     
-    remove_index :choices, :question_id
+    remove_index :choices, :name => "idx_choices_qstnid"
     drop_table :choices
     
-    remove_index :questions, :data_group_id
+    remove_index :questions, :name => "idx_qstns_datagrpid"
     drop_table :questions
     
     drop_table :data_groups

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

@@ -16,7 +16,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :questions, :data_group_id
+    add_index :questions, :data_group_id, :name => "idx_qstns_datagrpid"
     
     create_table :choices do |t|
       t.integer :question_id
@@ -25,7 +25,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :choices, :question_id
+    add_index :choices, :question_id, :name => "idx_choices_qstnid"
     
     create_table :answers do |t|
       t.integer :question_id
@@ -33,20 +33,20 @@ class CreateCensusTables < ActiveRecord::Migration
       t.string  :data
     end
     
-    add_index :answers, :question_id
-    add_index :answers, :user_id
+    add_index :answers, :question_id, :name => "idx_answrs_qstnid"
+    add_index :answers, :user_id, :name => "idx_answrs_usrid"
     
   end
 
   def self.down
-    remove_index :answers, :question_id
-    remove_index :answers, :user_id
+    remove_index :answers, :name => "idx_answrs_qstnid"
+    remove_index :answers, :name => "idx_answrs_usrid"
     drop_table :answers
     
-    remove_index :choices, :question_id
+    remove_index :choices, :name => "idx_choices_qstnid"
     drop_table :choices
     
-    remove_index :questions, :data_group_id
+    remove_index :questions, :name => "idx_qstns_datagrpid"
     drop_table :questions
     
     drop_table :data_groups

data/lib/census/user.rb

@@ -87,6 +87,20 @@ module Census
     end
 
     module ClassMethods
+      #
+      # Expose a census data value as an attribute on the model class
+      #
+      def expose_census_data(group, data, attribute)
+        instance_eval do
+          define_method attribute.to_s do
+            self.census_data[group.to_s][data.to_s]
+          end
+          
+          define_method "#{attribute.to_s}=" do |value|
+            self.census_data[group.to_s][data.to_s] = value
+          end
+        end
+      end
     end
 
   end

data/lib/census/user_data.rb

@@ -8,7 +8,7 @@ module Census
         @questions = {}
         define_question_methods(data_group)
       else
-        @data_groups = {}
+        @data_groups = Hash.new { |h,v| h[v] = {} }
         define_data_group_methods
       end
     end
@@ -17,7 +17,15 @@ module Census
       if @data_groups
         @data_groups[key]
       else
-        @user.first_answer_for(@questions[key]).formatted_data
+        @user.first_answer_for(@questions[key]).formatted_data if @questions[key]
+      end
+    end
+
+    def []=(key, value)
+      if @data_groups
+        @data_groups[key] = value
+      else
+        @user.first_answer_for(@questions[key]).update_attribute(:data, @questions[key].format_data(value).to_s) if @questions[key]
       end
     end
     
@@ -45,6 +53,10 @@ module Census
           define_method question.prompt.parameterize.underscore do
             @user.first_answer_for(question).formatted_data
           end
+
+          define_method "#{question.prompt.parameterize.underscore}=" do |value|
+            @user.first_answer_for(question).update_attribute(:data, question.format_data(value).to_s)
+          end
         end
       end
     end

data/test/models/user_test.rb

@@ -42,6 +42,82 @@ class UserTest < ActiveSupport::TestCase
       
     end
     
+    context 'using expose_census_data' do
+      
+      setup do
+        @user.class.expose_census_data('Physical Attributes', 'Hair Color', :hair_color)
+        @user.class.expose_census_data('Physical Attributes', 'Weight', :weight)
+      end
+      
+      should 'return string values for string data types' do
+        assert_equal 'Brown', @user.hair_color
+      end
+    
+      should 'return integer values for numeric data types' do
+        assert_equal 150, @user.weight
+      end
+            
+    end
+    
+  end
+
+  context 'Setting answers' do
+    
+    setup do
+      @data_group = Factory(:data_group, :name => 'Physical Attributes')
+      @question1 = Factory(:question, :prompt => 'Hair Color', :data_group => @data_group)
+      @question2 = Factory(:question, :prompt => 'Weight', :data_type => 'Number', :data_group => @data_group)
+
+      @user = Factory(:user)
+    end
+    
+    context 'using auto-generated methods' do
+      
+      should 'allow string values for string data types' do
+        @user.census_data.physical_attributes.hair_color = 'Brown'
+        assert_equal 'Brown', @user.first_answer_for(@question1).formatted_data
+      end
+    
+      should 'allow integer values for numeric data types' do
+        @user.census_data.physical_attributes.weight = 210
+        assert_equal 210, @user.first_answer_for(@question2).formatted_data
+      end
+      
+    end
+
+    context 'using data group and question strings' do
+      
+      should 'allow string values for string data types' do
+        @user.census_data["Physical Attributes"]["Hair Color"] = 'Brown'
+        assert_equal 'Brown', @user.first_answer_for(@question1).formatted_data
+      end
+    
+      should 'allow integer values for numeric data types' do
+        @user.census_data["Physical Attributes"]["Weight"] = 210
+        assert_equal 210, @user.first_answer_for(@question2).formatted_data
+      end
+      
+    end
+    
+    context 'using expose_census_data' do
+      
+      setup do
+        @user.class.expose_census_data('Physical Attributes', 'Hair Color', :hair_color)
+        @user.class.expose_census_data('Physical Attributes', 'Weight', :weight)
+      end
+      
+      should 'allow string values for string data types' do
+        @user.hair_color = 'Brown'
+        assert_equal 'Brown', @user.first_answer_for(@question1).formatted_data
+      end
+    
+      should 'allow integer values for numeric data types' do
+        @user.weight = 210
+        assert_equal 210, @user.first_answer_for(@question2).formatted_data
+      end
+            
+    end
+    
   end
 
 end

data/test/rails_root/config/environment.rb

@@ -1,8 +1,41 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.8' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')
 
 Rails::Initializer.run do |config|
-  config.load_paths += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'gems', '*', 'lib'))
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
 
-  config.gem "acts_as_list", :version => '>= 0.1.2'
-  config.gem "inverse_of", :version => '>= 0.0.1'
-end
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/test/rails_root/config/environments/test.rb

@@ -27,6 +27,6 @@ config.action_mailer.delivery_method = :test
 # like if you have constraints or database-specific column types
 # config.active_record.schema_format = :sql
 
-config.gem 'shoulda', :version => '>= 2.10.3'
-config.gem 'factory_girl', :version => '>= 1.2.3'
-config.gem 'webrat', :lib => false, :version => '>= 0.7.0'
+config.gem 'shoulda'
+config.gem 'factory_girl'
+config.gem 'mocha'

data/test/rails_root/config/initializers/cookie_verification_secret.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.cookie_verifier_secret = '2d56da98a398d6d2a9ad9a4d2862c0afda91439d7633973d3b1cfae673a58d0d5e0b943febae8b1c1c6d5fc0137f0bd79bfa043410ab39d19bf14e41f63b0a42';

data/test/rails_root/config/initializers/session_store.rb

@@ -6,7 +6,7 @@
 # no regular words or you'll be exposed to dictionary attacks.
 ActionController::Base.session = {
   :key         => '_rails_root_session',
-  :secret      => 'f5e62297edabd22e6bc30523f11d269988fc120ba875d6f57770c7f2b39cd5ef64915367f1dda1408a61f02ab594b7adf13ede44c9af82564a525f388dedec71'
+  :secret      => '75301db3e3c3065fb802090805a911fe15c7594132f1db32461a3834ec0f6614b1532b7afa98b33f25e44751b49837482a7e483f901610a62cbb3222c9d2108d'
 }
 
 # Use the database for sessions instead of the cookie-based default,

data/test/rails_root/db/migrate/{20100421154808_create_census_tables.rb → 20100526201135_create_census_tables.rb}

@@ -16,7 +16,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :questions, :data_group_id
+    add_index :questions, :data_group_id, :name => "idx_qstns_datagrpid"
     
     create_table :choices do |t|
       t.integer :question_id
@@ -25,7 +25,7 @@ class CreateCensusTables < ActiveRecord::Migration
       t.timestamps
     end
     
-    add_index :choices, :question_id
+    add_index :choices, :question_id, :name => "idx_choices_qstnid"
     
     create_table(:users) do |t|
       t.timestamps
@@ -37,22 +37,22 @@ class CreateCensusTables < ActiveRecord::Migration
       t.string  :data
     end
     
-    add_index :answers, :question_id
-    add_index :answers, :user_id
+    add_index :answers, :question_id, :name => "idx_answrs_qstnid"
+    add_index :answers, :user_id, :name => "idx_answrs_usrid"
     
   end
 
   def self.down
-    remove_index :answers, :question_id
-    remove_index :answers, :user_id
+    remove_index :answers, :name => "idx_answrs_qstnid"
+    remove_index :answers, :name => "idx_answrs_usrid"
     drop_table :answers
     
     drop_table :users
     
-    remove_index :choices, :question_id
+    remove_index :choices, :name => "idx_choices_qstnid"
     drop_table :choices
     
-    remove_index :questions, :data_group_id
+    remove_index :questions, :name => "idx_qstns_datagrpid"
     drop_table :questions
     
     drop_table :data_groups

data/test/rails_root/db/schema.rb

@@ -9,7 +9,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20100421154808) do
+ActiveRecord::Schema.define(:version => 20100526201135) do
 
   create_table "answers", :force => true do |t|
     t.integer "question_id"
@@ -17,8 +17,8 @@ ActiveRecord::Schema.define(:version => 20100421154808) do
     t.string  "data"
   end
 
-  add_index "answers", ["question_id"], :name => "index_answers_on_question_id"
-  add_index "answers", ["user_id"], :name => "index_answers_on_user_id"
+  add_index "answers", ["question_id"], :name => "idx_answrs_qstnid"
+  add_index "answers", ["user_id"], :name => "idx_answrs_usrid"
 
   create_table "choices", :force => true do |t|
     t.integer  "question_id"
@@ -28,7 +28,7 @@ ActiveRecord::Schema.define(:version => 20100421154808) do
     t.datetime "updated_at"
   end
 
-  add_index "choices", ["question_id"], :name => "index_choices_on_question_id"
+  add_index "choices", ["question_id"], :name => "idx_choices_qstnid"
 
   create_table "data_groups", :force => true do |t|
     t.string   "name"
@@ -48,7 +48,7 @@ ActiveRecord::Schema.define(:version => 20100421154808) do
     t.datetime "updated_at"
   end
 
-  add_index "questions", ["data_group_id"], :name => "index_questions_on_data_group_id"
+  add_index "questions", ["data_group_id"], :name => "idx_qstns_datagrpid"
 
   create_table "users", :force => true do |t|
     t.datetime "created_at"

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: census
 version: !ruby/object:Gem::Version 
+  hash: 11
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - Mark Kendall
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 -04:00
+date: 2010-05-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: acts_as_list
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
         segments: 
         - 0
         - 1
@@ -35,9 +38,11 @@ dependencies:
   name: inverse_of
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 29
         segments: 
         - 0
         - 0
@@ -49,9 +54,11 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -61,9 +68,11 @@ dependencies:
   name: factory_girl
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -119,6 +128,35 @@ files:
 - lib/census/user_data.rb
 - rails/init.rb
 - shoulda_macros/census.rb
+- test/controllers/data_groups_controller_test.rb
+- test/models/answer_test.rb
+- test/models/choice_test.rb
+- test/models/data_group_test.rb
+- test/models/question_test.rb
+- test/models/search_test.rb
+- test/models/user_test.rb
+- test/rails_root/app/controllers/application_controller.rb
+- test/rails_root/app/helpers/application_helper.rb
+- test/rails_root/app/models/user.rb
+- test/rails_root/config/boot.rb
+- test/rails_root/config/environment.rb
+- test/rails_root/config/environments/development.rb
+- test/rails_root/config/environments/production.rb
+- test/rails_root/config/environments/test.rb
+- test/rails_root/config/initializers/backtrace_silencers.rb
+- test/rails_root/config/initializers/census.rb
+- test/rails_root/config/initializers/cookie_verification_secret.rb
+- test/rails_root/config/initializers/inflections.rb
+- test/rails_root/config/initializers/mime_types.rb
+- test/rails_root/config/initializers/new_rails_defaults.rb
+- test/rails_root/config/initializers/session_store.rb
+- test/rails_root/config/routes.rb
+- test/rails_root/db/migrate/20100526201135_create_census_tables.rb
+- test/rails_root/db/schema.rb
+- test/rails_root/test/factories/census.rb
+- test/rails_root/test/performance/browsing_test.rb
+- test/rails_root/test/test_helper.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/envylabs/census
 licenses: []
@@ -129,23 +167,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Rails user demographics collection and searching
@@ -167,29 +209,15 @@ test_files:
 - test/rails_root/config/environments/test.rb
 - test/rails_root/config/initializers/backtrace_silencers.rb
 - test/rails_root/config/initializers/census.rb
+- test/rails_root/config/initializers/cookie_verification_secret.rb
 - test/rails_root/config/initializers/inflections.rb
 - test/rails_root/config/initializers/mime_types.rb
 - test/rails_root/config/initializers/new_rails_defaults.rb
 - test/rails_root/config/initializers/session_store.rb
 - test/rails_root/config/routes.rb
-- test/rails_root/db/migrate/20100421154808_create_census_tables.rb
+- test/rails_root/db/migrate/20100526201135_create_census_tables.rb
 - test/rails_root/db/schema.rb
 - test/rails_root/test/factories/census.rb
 - test/rails_root/test/performance/browsing_test.rb
 - test/rails_root/test/test_helper.rb
-- test/rails_root/vendor/gems/acts_as_list-0.1.2/lib/acts_as_list.rb
-- test/rails_root/vendor/gems/acts_as_list-0.1.2/test/list_test.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/install.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/lib/inverse_of.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/rails/init.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/cases/helper.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/cases/inverse_associations_test.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/club.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/face.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/interest.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/man.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/sponsor.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/models/zine.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/test/schema/schema.rb
-- test/rails_root/vendor/gems/inverse_of-0.0.1/uninstall.rb
 - test/test_helper.rb