balinterdi-acts_as_trivia 0.1 → 0.1.3

data/CHANGELOG

@@ -1 +1,2 @@
-v0.1  Initial release.
+v0.1.3  acts_as_trivia generator does not automatically create a trivia instance. There is acts_as_trivia_record for that.
+v0.1    Initial release.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Balint Erdi (balint@bucionrails.com)
+
+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/Manifest

@@ -1,3 +1,4 @@
+acts_as_trivia.gemspec
 CHANGELOG
 generators/acts_as_trivia/acts_as_trivia_generator.rb
 generators/acts_as_trivia/templates/answers_controller.rb
@@ -8,12 +9,14 @@ generators/acts_as_trivia/USAGE
 generators/acts_as_trivia_record/acts_as_trivia_record_generator.rb
 generators/acts_as_trivia_record/templates/migration.rb
 generators/acts_as_trivia_record/USAGE
+generators/lib/acts_as_trivia_commands.rb
 lib/acts_as_trivia/trivia.rb
 lib/acts_as_trivia/trivia_answer.rb
 lib/acts_as_trivia/trivia_answers_controller.rb
 lib/acts_as_trivia/trivias_helper.rb
 lib/acts_as_trivia/user.rb
 lib/acts_as_trivia.rb
+LICENSE
 Manifest
 Rakefile
 README.markdown

data/README.markdown

@@ -1,97 +1,62 @@
-* NoMethodError (undefined method `acts\_as\_trivia' for #<Class:0x253e9fc>):
+# Acts As Trivia
 
-  Make sure you have the config.gem "acts\_as\_trivia" line in your environment.rb
+This gem adds a full-fletched trivia game to your Rails application. It only needs a (or more) model class(es) to operate on (the instances of which can be the subjects of the trivia) and an attribute of this class which is comparable.
 
-* Trivia will have its own model:
-
-  create_table :trivias, :force => true do |t|
-    t.string  :on, :null => false
-    t.string  :about, :null => false
-  end
-  
-  e.g
-  
-  Trivia.new(:on => "country", :about => "hdi")
-  
-  class Trivia < ActionRecord::Base
-  
-    def to\_param
-      #{on}-#{about} # e.g country-hdi
-    end
+## Installation
     
-  And requests to trivias will have a routing like this:
-  
-  /trivias/1, or which is the same
-  /trivias/country-hdi (and that latter will be generated)
-  
+Put the following line in your environment.rb:
 
-* The User class will have the following added associations:
-
-  class User < ActiveRecord::Base
-  
-    has_many :trivia_answers
-    has_many :trivias, :through => :trivia_answers
-    has_many :correct_trivia_answers, :through => :trivia_answers, :condition => { "state = ?", 'correct' }
+    config.gem "balinterdi-acts_as_trivia", :source => http://gems.github.com, :lib => "acts_as_trivia"
     
-* And the join model will be the TriviaAnswers class:
+And then install it systemwide:
 
-    create_table :trivia_answers, :force => true do |t|
-      t.string  :trivia_id, :null => false
-      t.string  :user_id, :null => false
-      t.integer :points # how many points the user received for his answer
-    end
+    rake gems:install
+    
+Or bundled with your app:
 
-* when the geneation script is called with the following:
+    rake gems:unpack
 
-  ./script/generate acts_as_trivia country hdi
+On Rails < 2.1 you can install it like this, too:
 
-  then the following things will be generated:
+    gem install balinterdi-acts_as_trivia --source http://gems.github.com
+    
+However, I have run into some issues this way so I recommend using the config.gem way.
 
-* a new trivia model OK
+### Make your Rails app a trivia game
 
-  class Trivia < ActiveRecord::Base
-    def to\_param
-      #{on}-#{about} # e.g country-hdi
-    end
-  end
+Once you have the gem installed you should run the **acts\_as\_trivia** generator:
 
-* a new controller (if it does not exist yet) OK
+    ./script/generate acts_as_trivia
 
-  class TriviaController
-  end
+This will "trivialize" your application, creating migrations for the new trivia-related classes, stub out the empty controllers and generate routes for them. Use _rake db:migrate_ to create the trivia-related classes in the database.
 
-* new resource routes for trivia OK
+Now you can start adding trivia with the help of the **acts\_as\_trivia\_record** generator:
 
-  map.resources :trivias
+    ./script/generate acts_as_trivia_record country area name
+    
+This generator will add an acts\_as\_trivia call into your Country class (acts_as_trivia :area) and create migration for the actual trivia instance (_Trivia.create(:on => "country", :about => "area", :displayed => "name")_). To have the new trivia available in your app, don't forget to _rake db:migrate_
 
-* in the model (country.rb) OK:
+Create the TriviaAnswers _new_ and _create_ actions and some simple views for them. A quick way is to use the ones provided [in the rails application template](http://gist.github.com/raw/107361/f31caad451f0cca699288700aa3d98291a259fd1/gistfile1.rb).
+(note: I am planning to modify the template so it can be applied just to create these actions and views)
 
-  class Country < ActiveRecord::Base
-    acts_as_trivia :hdi
-    ...
-  end
+Now go to
 
-* added associations in the user model OK
+  /users/:user_id/trivias/1/trivia_answers/new
+  
+to test your knowledge!
 
-  has_many :trivia_answers
-  has_many :trivias, :through => :trivia_answers
-  <!-- has_many :correct_trivia_answers, :through => :trivia_answers, :condition => { "state = ?", 'correct' }   -->
+### Rails application template
 
-* db migrations
+If you want a "quick-start" course or got to like the gem so much you would like to have it in your app from start, fear not. I assembled an application template just for this task (this will work starting from Rails 2.3):
 
-  * for the trivia class itself OK
+    rails my_shiny_new_app -m http://gist.github.com/raw/107361/f31caad451f0cca699288700aa3d98291a259fd1/gistfile1.rb
+    
+## How does it work
 
-    create_table :trivias, :force => true do |t|
-      t.string  :on, :null => false
-      t.string  :about, :null => false
-      t.timestamps
-    end
+Acts\_as\_trivia uses instances of the Trivia and TriviaAnswer classes to assess the knowledge of users. It only supposes that you have a User class of which the instances are the users of your application. 
 
-  * for the join model between the user and the trivia OK
+It tries to mingle with your application as little as possible and provide a clean interface to work with. (if you feel this is not so, please let me know) It adds a couple of helper methods you can use in your views to create a trivia answer (trivia\_user\_panel and trivia_dropdown) and to show the correct answer (with\_each\_solution\_value).
 
-    create_table :trivia_answers, :force => true do |t|
-      t.string  :trivia_id, :null => false
-      t.string  :user_id, :null => false
-      t.integer :points # how many points the user received for his answer
-    end
+## Disclaimer
 
+Please consider this an early release and thus count on some bumps on the way. If you find one, let me know (<balint@bucionrails.com>).

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('acts_as_trivia', '0.1') do |p|
+Echoe.new('acts_as_trivia', '0.1.3') do |p|
   p.description    = <<-EOS
     This gem will add the possibility to turn your Rails application into a trivia game with the ease of generating a migration. The only thing you need is a model class with a sortable attribute and this gem.
   EOS

data/acts_as_trivia.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_trivia}
-  s.version = "0.1"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Balint Erdi"]
-  s.date = %q{2009-05-04}
+  s.date = %q{2009-05-06}
   s.description = %q{This gem will add the possibility to turn your Rails application into a trivia game with the ease of generating a migration. The only thing you need is a model class with a sortable attribute and this gem.}
   s.email = %q{balint.erdi@gmail.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/acts_as_trivia/trivia.rb", "lib/acts_as_trivia/trivia_answer.rb", "lib/acts_as_trivia/trivia_answers_controller.rb", "lib/acts_as_trivia/trivias_helper.rb", "lib/acts_as_trivia/user.rb", "lib/acts_as_trivia.rb", "README.markdown", "tasks/acts_as_trivia.rake"]
-  s.files = ["CHANGELOG", "generators/acts_as_trivia/acts_as_trivia_generator.rb", "generators/acts_as_trivia/templates/answers_controller.rb", "generators/acts_as_trivia/templates/controller.rb", "generators/acts_as_trivia/templates/trivias_migration.rb", "generators/acts_as_trivia/templates/view.html.erb", "generators/acts_as_trivia/USAGE", "generators/acts_as_trivia_record/acts_as_trivia_record_generator.rb", "generators/acts_as_trivia_record/templates/migration.rb", "generators/acts_as_trivia_record/USAGE", "lib/acts_as_trivia/trivia.rb", "lib/acts_as_trivia/trivia_answer.rb", "lib/acts_as_trivia/trivia_answers_controller.rb", "lib/acts_as_trivia/trivias_helper.rb", "lib/acts_as_trivia/user.rb", "lib/acts_as_trivia.rb", "Manifest", "Rakefile", "README.markdown", "spec/acts_as_trivia_spec.rb", "spec/database.yml", "spec/spec_helper.rb", "tasks/acts_as_trivia.rake", "todos.markdown", "acts_as_trivia.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/acts_as_trivia/trivia.rb", "lib/acts_as_trivia/trivia_answer.rb", "lib/acts_as_trivia/trivia_answers_controller.rb", "lib/acts_as_trivia/trivias_helper.rb", "lib/acts_as_trivia/user.rb", "lib/acts_as_trivia.rb", "LICENSE", "README.markdown", "tasks/acts_as_trivia.rake"]
+  s.files = ["acts_as_trivia.gemspec", "CHANGELOG", "generators/acts_as_trivia/acts_as_trivia_generator.rb", "generators/acts_as_trivia/templates/answers_controller.rb", "generators/acts_as_trivia/templates/controller.rb", "generators/acts_as_trivia/templates/trivias_migration.rb", "generators/acts_as_trivia/templates/view.html.erb", "generators/acts_as_trivia/USAGE", "generators/acts_as_trivia_record/acts_as_trivia_record_generator.rb", "generators/acts_as_trivia_record/templates/migration.rb", "generators/acts_as_trivia_record/USAGE", "generators/lib/acts_as_trivia_commands.rb", "lib/acts_as_trivia/trivia.rb", "lib/acts_as_trivia/trivia_answer.rb", "lib/acts_as_trivia/trivia_answers_controller.rb", "lib/acts_as_trivia/trivias_helper.rb", "lib/acts_as_trivia/user.rb", "lib/acts_as_trivia.rb", "LICENSE", "Manifest", "Rakefile", "README.markdown", "spec/acts_as_trivia_spec.rb", "spec/database.yml", "spec/spec_helper.rb", "tasks/acts_as_trivia.rake", "todos.markdown"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/balinterdi/acts_as_trivia}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_trivia", "--main", "README.markdown"]

data/generators/acts_as_trivia/USAGE

@@ -10,13 +10,4 @@ Example:
         create  app/views/country_trivia/population.html.erb
         create  app/views/country_trivia/gdp.html.erb
         route   map.with_options(:controller => 'country_trivia') do ...
-        
-In routes.rb it will add the following:
-
-    ActionController::Routing::Routes.draw do |map|
-      
-      map.with_options(:controller => 'country_trivia') do |trivia|
-        trivia.country_hdi_trivia '/countries/trivia/hdi', :action => "hdi"
-        trivia.country_hdi_trivia '/countries/trivia/population', :action => "population"
-        trivia.country_hdi_trivia '/countries/trivia/hdi', :action => "gdp"
-      end
+        

data/generators/acts_as_trivia/acts_as_trivia_generator.rb

@@ -1,75 +1,11 @@
 require 'rails_generator'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'acts_as_trivia_commands'))
 
-module ActsAsTriviaAddedContent
-
-  def route_trivia_answers_as_nested_resource
-    sentinel = "ActionController::Routing::Routes.draw do |map|"
-    unless options[:pretend]
-      gsub_file "config/routes.rb", /(#{Regexp.escape(sentinel)})/mi do |match|
-<<-EOS
-#{match}
-  map.resources :users do |users|
-    users.resources :trivias do |trivias|
-      trivias.resources :trivia_answers
-    end
-  end
-  
-EOS
-      end
-    end
-    
-  end
-  
-  def model_acts_as_trivia_includes(questions)
-    acts_as_trivia_calls = questions.map do |question|
-      "acts_as_trivia :#{question}"
-    end
-    logger.modify acts_as_trivia_calls.join(", ")
-
-    sentinel = "class #{class_name} < ActiveRecord::Base"
-    unless options[:pretend]
-      gsub_file File.join("app/models", class_path, "#{singular_name}.rb"), /(#{Regexp.escape(sentinel)})/mi do |match|
-<<-EOS
-#{match}
-  #{acts_as_trivia_calls.join("\n")}
-EOS
-      end
-    end
-  end
-
-end
-
-class ActsAsTriviaGenerator < Rails::Generator::NamedBase # ControllerGenerator
+class ActsAsTriviaGenerator < Rails::Generator::Base # ControllerGenerator
 
   # this is snatched from the resource generator in the Rails source
   default_options :skip_timestamps => false, :skip_migration => false
 
-  attr_reader   :controller_name,
-                :controller_class_path,
-                :controller_file_path,
-                :controller_class_nesting,
-                :controller_class_nesting_depth,
-                :controller_class_name,
-                :controller_singular_name,
-                :controller_plural_name
-  alias_method  :controller_file_name,  :controller_singular_name
-  alias_method  :controller_table_name, :controller_plural_name
-
-  def initialize(runtime_args, runtime_options = {})
-    super
-
-    @controller_name = @name.pluralize
-
-    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
-    @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
-
-    if @controller_class_nesting.empty?
-      @controller_class_name = @controller_class_name_without_nesting
-    else
-      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
-    end
-  end
-
   def manifest
     record do |m|
       # Check whether the given class names are already taken by
@@ -90,14 +26,9 @@ class ActsAsTriviaGenerator < Rails::Generator::NamedBase # ControllerGenerator
       m.route_resources "trivias"
       m.route_trivia_answers_as_nested_resource
 
-      m.model_acts_as_trivia_includes actions
-
       unless options[:skip_migration]
         m.migration_template 'trivias_migration.rb', 'db/migrate', :assigns => {
           :migration_name => "CreateTrivias",
-          :trivia_on => singular_name,
-          :trivia_about => actions.first,
-          :trivia_displayed => actions.last,
         }, :migration_file_name => "create_trivias"
       end
 
@@ -107,4 +38,4 @@ class ActsAsTriviaGenerator < Rails::Generator::NamedBase # ControllerGenerator
   end
 end
 
-Rails::Generator::Commands::Base.send(:include, ActsAsTriviaAddedContent)
+Rails::Generator::Commands::Base.send(:include, ActsAsTriviaCommands)

data/generators/acts_as_trivia/templates/trivias_migration.rb

@@ -19,7 +19,6 @@ class <%= migration_name %> < ActiveRecord::Migration
 <% end -%>
     end
 
-    Trivia.create(:on => <%= %("#{trivia_on}") %>, :about => <%= %("#{trivia_about}") %>, :displayed => <%= %("#{trivia_displayed}") %>)
   end
 
   def self.down

data/generators/acts_as_trivia_record/acts_as_trivia_record_generator.rb

@@ -1,6 +1,13 @@
+require 'rails_generator'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'acts_as_trivia_commands'))
+
 class ActsAsTriviaRecordGenerator < Rails::Generator::NamedBase
+  
   def manifest
     record do |m|
+      trivia_about = actions.first
+      m.model_acts_as_trivia_includes trivia_about
+      
       m.migration_template 'migration.rb', 'db/migrate', :assigns => {
         :migration_name => "CreateTriviaFor#{plural_name.capitalize}#{actions.first.capitalize}",
         :trivia_on => singular_name,
@@ -9,4 +16,6 @@ class ActsAsTriviaRecordGenerator < Rails::Generator::NamedBase
       }, :migration_file_name => "create_trivia_for_#{plural_name}_#{actions.first}"
     end
   end
-end
+end
+
+Rails::Generator::Commands::Base.send(:include, ActsAsTriviaCommands)

data/generators/lib/acts_as_trivia_commands.rb

@@ -0,0 +1,36 @@
+module ActsAsTriviaCommands
+
+  def route_trivia_answers_as_nested_resource
+    sentinel = "ActionController::Routing::Routes.draw do |map|"
+    unless options[:pretend]
+      gsub_file "config/routes.rb", /(#{Regexp.escape(sentinel)})/mi do |match|
+<<-EOS
+#{match}
+  map.resources :users do |users|
+    users.resources :trivias do |trivias|
+      trivias.resources :trivia_answers
+    end
+  end
+  
+EOS
+      end
+    end
+    
+  end
+  
+  def model_acts_as_trivia_includes(question)
+    acts_as_trivia_call = "acts_as_trivia :#{question}"
+    logger.modify acts_as_trivia_call
+
+    sentinel = "class #{class_name} < ActiveRecord::Base"
+    unless options[:pretend]
+      gsub_file File.join("app/models", class_path, "#{singular_name}.rb"), /(#{Regexp.escape(sentinel)})/mi do |match|
+<<-EOS
+#{match}
+  #{acts_as_trivia_call}
+EOS
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: balinterdi-acts_as_trivia
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  version: 0.1.3
 platform: ruby
 authors: 
 - Balint Erdi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-04 00:00:00 -07:00
+date: 2009-05-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -27,9 +27,11 @@ extra_rdoc_files:
 - lib/acts_as_trivia/trivias_helper.rb
 - lib/acts_as_trivia/user.rb
 - lib/acts_as_trivia.rb
+- LICENSE
 - README.markdown
 - tasks/acts_as_trivia.rake
 files: 
+- acts_as_trivia.gemspec
 - CHANGELOG
 - generators/acts_as_trivia/acts_as_trivia_generator.rb
 - generators/acts_as_trivia/templates/answers_controller.rb
@@ -40,12 +42,14 @@ files:
 - generators/acts_as_trivia_record/acts_as_trivia_record_generator.rb
 - generators/acts_as_trivia_record/templates/migration.rb
 - generators/acts_as_trivia_record/USAGE
+- generators/lib/acts_as_trivia_commands.rb
 - lib/acts_as_trivia/trivia.rb
 - lib/acts_as_trivia/trivia_answer.rb
 - lib/acts_as_trivia/trivia_answers_controller.rb
 - lib/acts_as_trivia/trivias_helper.rb
 - lib/acts_as_trivia/user.rb
 - lib/acts_as_trivia.rb
+- LICENSE
 - Manifest
 - Rakefile
 - README.markdown
@@ -54,7 +58,6 @@ files:
 - spec/spec_helper.rb
 - tasks/acts_as_trivia.rake
 - todos.markdown
-- acts_as_trivia.gemspec
 has_rdoc: true
 homepage: http://github.com/balinterdi/acts_as_trivia
 post_install_message: