bcms_polling 1.0.3 → 1.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'sqlite3'

data/README.markdown

@@ -21,20 +21,18 @@ vote multiple times from multiple computers or just clear their cookies to revot
 Installation:
 =============
 
-    gem install bcms_polling
+    $ rails g cms:install bcms_polling
+	$ rake db:install
 
  Follow standard module installation after that.
 
- Finally, edit your project's app/helpers/application_helper.rb so it looks like:
-
-    module ApplicationHelper
-        include Cms::PollsHelper
-    end
-
  Finally, add the default stylesheet for polls to your template, tweaking as necessary or inlining into the site's main stylesheet.
 
-     <%= stylesheet_link_tag '/bcms/polling/bcms-polling' %>
+     <%= stylesheet_link_tag 'bcms_polling/bcms-polling' %>
 
+Update your config/application.rb with the following:
+
+	Rails.application.routes.default_url_options[:host] = config.cms.site_domain
 
 
 Bugs:
@@ -43,6 +41,5 @@ Bugs:
 
 BrowserCMS Core Notes:
 ================
-* Using nested_attributes doesn't work without some monkeying around. Specifically, BrowserCMS doesn't consider nested attributes as 'changes', so
-    updates (and a new version) doesn't get saved. Can fix this by timestamping 'updated_at' but the core CMS should be aware of
-    nested_attributes and save correctly if they are present.
+* Using nested_attributes doesn't work without some monkeying around. Specifically, BrowserCMS doesn't consider nested attributes as 'changes', so updates (and a new version) doesn't get saved. Can fix this by timestamping 'updated_at' but the core CMS should be aware of nested_attributes and save correctly if they are present.
+

data/app/assets/javascripts/bcms_polling.js

@@ -0,0 +1,5 @@
+// Manifest file for bcms_polling
+//
+//= require jquery
+//= require jquery.cookie
+//= require_tree .

data/app/assets/stylesheets/bcms_polling/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/bcms_polling/polling_controller.rb

@@ -0,0 +1,46 @@
+# Handles the public submissions of answers to poll questions.
+module BcmsPolling
+  class PollingController < ApplicationController
+    include BcmsPolling::PollsHelper
+    include Cms::Authentication::Controller
+
+    def update
+      @response  = PollResponse.find(params[:id])
+      unique_key = cookie_key(@response.poll)
+
+      if !cookies[unique_key]
+        @response.votes += 1
+        @response.save!
+
+        cookies[unique_key] = {
+            :value   => true,
+            :expires => 1.year.from_now
+        }
+        logger.warn "Saving cookie called '#{unique_key}'"
+      else
+        logger.warn "User attempted to submit another answer to the same poll."
+      end
+
+      render :nothing => true, :status => :ok
+    end
+
+    def results
+      @poll = Poll.find(params[:id])
+      render :layout => false
+    end
+
+    def reset
+      @poll           = Poll.find(params[:id])
+
+      cookie          = cookie_key(@poll)
+      cookies.delete(cookie)
+
+      redirect_to "/"
+    end
+
+    private
+    def cookie_key(poll)
+      cookie_for(poll)
+    end
+  end
+end

data/app/controllers/bcms_polling/polls_controller.rb

@@ -0,0 +1,2 @@
+class BcmsPolling::PollsController < Cms::ContentBlockController
+end

data/app/helpers/bcms_polling/application_helper.rb

@@ -0,0 +1,4 @@
+module BcmsPolling
+  module ApplicationHelper
+  end
+end

data/app/helpers/{cms → bcms_polling}/polls_helper.rb

@@ -1,4 +1,4 @@
-module Cms::PollsHelper
+module BcmsPolling::PollsHelper
   def response_results(response)
     total = response.poll.total_votes == 0 ? 0 : (response.votes.to_f / response.poll.total_votes.to_f) * 100
     "#{response.votes} votes (#{sprintf("%.2f", total)}%)"

data/app/models/bcms_polling/poll.rb

@@ -0,0 +1,38 @@
+module BcmsPolling
+  class Poll < ActiveRecord::Base
+    acts_as_content_block
+
+    has_many :responses, :class_name => "PollResponse"
+    accepts_nested_attributes_for :responses, :allow_destroy => true
+    attr_accessible :responses_attributes
+    validates_presence_of :question
+
+    after_validation :ensure_responses_save
+    
+    def total_votes
+      self.responses.inject(0) { |sum, r| sum += r.votes }
+    end
+
+    def name
+      question
+    end
+
+    private
+    
+    # This is a work around for bugs in CMS 3.5.x where updates to nested_associations:
+    # 1. Do not count as 'changes' to the parent model (so they don't trigger a version save)
+    # 2. Associated blocks don't save and/or delete themselves like nested_attributes says they should.
+    #
+    # Both of these will require changes to the core CMS to fix.
+    def ensure_responses_save
+      responses.each do |r|
+        if r.changed?
+          r.save 
+        elsif r.marked_for_destruction?
+          responses.delete(r) 
+        end
+      end
+    end
+
+  end
+end

data/app/models/bcms_polling/poll_response.rb

@@ -0,0 +1,9 @@
+module BcmsPolling
+  class PollResponse < ActiveRecord::Base
+    belongs_to :poll
+    validates_presence_of :answer
+  
+    attr_accessible :answer
+  
+  end
+end

data/app/views/{polling → bcms_polling/polling}/results.html.erb

@@ -6,7 +6,7 @@
 <% end %>
 </ul>
 <% if cookies[cookie_for(@poll)] && current_user.able_to?(:edit_content)-%>
-    <%= link_to "Vote Again (Reset Cookie)", poll_reset_path(@poll)  %>
+    <%= link_to "Vote Again (Reset Cookie)", main_app.poll_reset_path(@poll)  %>
 <% end %>
 <% if params[:return] == 'true' %>
     <%= link_to_function "Back to Poll", 'history.go(0);return false;' %>

data/app/views/{cms → bcms_polling}/polls/_form.html.erb

@@ -51,8 +51,7 @@
 
 <div id="responses">
   <% count = 0 -%>
-  <% available_responses = PollResponse.find(:all, :conditions => {:poll_id => f.object.id}) %>
-  <% f.fields_for(:responses, available_responses) do |response_fields| %>
+  <%= f.fields_for :responses do |response_fields| %>
     <%= response_fields.cms_text_field :answer, :label => "Response ##{count = count + 1}" %>
     <%= link_to_function('Delete', 'removeResponse(this)', 'data-count-id'=>count-1, :style=>'position: relative; left: 465px; top: -25px;') %>
     <%= response_fields.check_box :_destroy, :style=>"display:none" %>

data/app/views/{cms → bcms_polling}/polls/render.html.erb

@@ -1,5 +1,5 @@
 <% unless self.controller.instance_variable_defined? :@include_js_http_methods -%>
-    <%= javascript_include_tag 'jquery', '/bcms/polling/bcms-polling', 'jquery.cookie' %>
+    <%= javascript_include_tag 'bcms_polling' %>
     <%= javascript_tag "var AUTH_TOKEN = #{form_authenticity_token.inspect};" if protect_against_forgery? -%>
     <% self.controller.instance_variable_set(:@include_js_http_methods, true) -%>
 <% end -%>
@@ -9,10 +9,10 @@
   <span class="question"><%= @content_block.question %></span>
 
   <ul class="vote-choices">
-    <% for response in PollResponse.find(:all, :conditions => {:poll_id => @content_block.id}) %>
+    <% for response in BcmsPolling::PollResponse.find(:all, :conditions => {:poll_id => @content_block.id}) %>
         <li>
           <span class="response"><%= response.answer %></span>
-          <%= link_to "Vote!", poll_response_url(response), :class => "vote-this", 'data-poll-id'=>@content_block.id %>
+          <%= link_to "Vote!", main_app.poll_response_url(response), :class => "vote-this", 'data-poll-id'=>@content_block.id %>
         </li>
     <% end %>
   </ul>

data/config/routes.rb

@@ -0,0 +1,3 @@
+BcmsPolling::Engine.routes.draw do
+  content_blocks :polls
+end

data/db/bcms_polling.seeds.rb

@@ -0,0 +1 @@
+Cms::ContentType.create!(:name => "BcmsPolling::Poll", :group_name => "Polling")

data/db/migrate/20110216195733_create_polls.rb

@@ -11,13 +11,9 @@ class CreatePolls < ActiveRecord::Migration
       t.belongs_to :poll
     end
     
-    ContentType.create!(:name => "Poll", :group_name => "Polling")
   end
 
   def self.down
-    ContentType.delete_all(['name = ?', 'Poll'])
-    CategoryType.all(:conditions => ['name = ?', 'Poll']).each(&:destroy)
-    #If you aren't creating a versioned table, be sure to comment this out.
     drop_table :poll_responses
     drop_table :poll_versions
     drop_table :polls

data/db/migrate/20120530182315_v110.rb

@@ -0,0 +1,8 @@
+require 'cms/upgrades/v3_5_0'
+class V110 < ActiveRecord::Migration
+  def change
+    v3_5_0_apply_namespace_to_block("BcmsPolling", "Poll")
+    rename_table :poll_responses, :bcms_polling_poll_responses 
+    
+  end
+end

data/lib/bcms_polling.rb

@@ -1 +1,5 @@
-require 'bcms_polling/routes'
+require "bcms_polling/engine"
+require "bcms_polling/route_extensions"
+
+module BcmsPolling
+end

data/lib/bcms_polling/engine.rb

@@ -0,0 +1,27 @@
+require 'browsercms'
+module BcmsPolling
+  class Engine < ::Rails::Engine
+    isolate_namespace BcmsPolling
+		include Cms::Module
+		
+		config.to_prepare do |app|
+		  Cms::ViewContext.send(:include, BcmsPolling::MainAppPatch)
+		  Cms::ViewContext.send(:include, BcmsPolling::PollsHelper)
+		  
+		  ::ApplicationHelper.send(:include, BcmsPolling::PollsHelper)
+	  end
+	  
+	  initializer 'bcms_polling.route_extensions', :after => 'action_dispatch.prepare_dispatcher' do |app|
+      ActionDispatch::Routing::Mapper.send :include, BcmsPolling::RouteExtensions
+    end
+  end
+  
+  # Patches Core CMS so views can access the main_app routes.
+  module MainAppPatch
+    
+    def main_app
+      Rails.application.routes.url_helpers
+    end
+    
+  end
+end

data/lib/bcms_polling/route_extensions.rb

@@ -0,0 +1,13 @@
+module BcmsPolling::RouteExtensions
+  def mount_bcms_polling
+    
+    # These routes are added to the main routes of the application, rather than under the engine
+    #   In retrospect, its probably better to put them into the engine to reduce the chance of conflicts.
+    get '/polls/:id/results', to:"bcms_polling/polling#results", as: 'poll_results' 
+    get '/polls/:id/reset', to:"bcms_polling/polling#reset", as: 'poll_reset' 
+    put '/poll_responses/:id', to:"bcms_polling/polling#update", as: 'poll_response' 
+    
+    mount BcmsPolling::Engine => "/bcms_polling"
+
+  end
+end

data/lib/bcms_polling/version.rb

@@ -0,0 +1,3 @@
+module BcmsPolling
+  VERSION = "1.1.0"
+end

data/lib/generators/bcms_polling/install/USAGE

@@ -0,0 +1,3 @@
+Installs bcms_polling into a project. Typically invoked indirectly via:
+
+   rails generate cms:install bcms_polling

data/lib/generators/bcms_polling/install/install_generator.rb

@@ -0,0 +1,21 @@
+require 'cms/module_installation'
+
+class BcmsPolling::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+  
+  
+  def copy_migrations
+    rake 'bcms_polling:install:migrations'
+  end
+
+  # Uncomment to add module specific seed data to a project.
+  def add_seed_data_to_project
+    copy_file "../bcms_polling.seeds.rb", "db/bcms_polling.seeds.rb"
+    append_to_file "db/seeds.rb", "load File.expand_path('../bcms_polling.seeds.rb', __FILE__)\n"
+  end
+  
+  def add_routes
+    route 'mount_bcms_polling'
+  end
+    
+end

data/test/bcms_polling_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BcmsPollingTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BcmsPolling
+  end
+end

data/test/test_helper.rb

@@ -1,38 +1,15 @@
+# Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-require 'test_help'
 
-class ActiveSupport::TestCase
-  # Transactional fixtures accelerate your tests by wrapping each test method
-  # in a transaction that's rolled back on completion.  This ensures that the
-  # test database remains unchanged so your fixtures don't have to be reloaded
-  # between every test method.  Fewer database queries means faster tests.
-  #
-  # Read Mike Clark's excellent walkthrough at
-  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
-  #
-  # Every Active Record database supports transactions except MyISAM tables
-  # in MySQL.  Turn off transactional fixtures in this case; however, if you
-  # don't care one way or the other, switching from MyISAM to InnoDB tables
-  # is recommended.
-  #
-  # The only drawback to using transactional fixtures is when you actually 
-  # need to test transactions.  Since your test is bracketed by a transaction,
-  # any transactions started in your code will be automatically rolled back.
-  self.use_transactional_fixtures = true
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
 
-  # Instantiated fixtures are slow, but give you @david where otherwise you
-  # would need people(:david).  If you don't want to migrate your existing
-  # test cases which use the @david style and don't mind the speed hit (each
-  # instantiated fixtures translates to a database query per test method),
-  # then set this back to true.
-  self.use_instantiated_fixtures  = false
+Rails.backtrace_cleaner.remove_silencers!
 
-  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
-  #
-  # Note: You'll currently still have to declare fixtures explicitly in integration tests
-  # -- they do not yet inherit this setting
-  fixtures :all
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
-  # Add more helper methods to be used by all tests here...
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
 end

data/test/unit/models/bcms_polling/poll_response_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module BcmsPolling
+  class PollResponseTest < ActiveSupport::TestCase
+
+    test "should be able to create new block" do
+      assert PollResponse.create!(:answer=>"Non-blank")
+    end
+  
+  end
+end

data/test/unit/models/bcms_polling/poll_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module BcmsPolling
+  class PollTest < ActiveSupport::TestCase
+
+    test "should be able to create new block" do
+      assert Poll.create!(:question=>"A?")
+    end
+
+
+    test "Should have responses" do
+      p = Poll.create!(:question=>"What color?")
+
+      p.responses << PollResponse.create!(:answer=>"Red")
+      p.responses << PollResponse.create!(:answer=>"Blue")
+
+      found = Poll.find(p.id)
+      assert_equal 2, p.responses.size
+
+    end
+
+    test "Should have responses unpublished" do
+      p = Poll.create!(:question=>"What color?")
+
+      p.responses << PollResponse.create!(:answer=>"Red")
+      p.responses << PollResponse.create!(:answer=>"Blue")
+
+      found = Poll.find(p.id)
+      found = found.as_of_draft_version
+      assert_equal 2, p.responses.size
+
+    end
+
+    test "Binding responses as nested attributes for new object" do
+      poll = Poll.create!(:question=>"Are you different?")
+      poll.update_attributes({ :responses_attributes=>{"0"=>{"answer"=>"Answer 1"}}})
+      assert_equal 1, poll.responses.size
+      assert_equal 1, PollResponse.count
+
+    end
+
+    test "Delete a response" do
+      poll = Poll.create!(:question=>"Are you different?")
+      poll.update_attributes({ :responses_attributes=>{"0"=>{"answer"=>"Answer 1"}}})
+      
+      poll.update_attributes({ :responses_attributes=>{"0"=>{"id"=>PollResponse.first.id, "answer"=>"Answer 1", "_destroy" => "1"}}})
+
+      assert_equal 0, poll.responses.size
+
+    end
+  end
+end