bcms_event 1.0.0 → 1.1.0

data/Gemfile

@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end
+
+gem "mysql"
+gemspec

data/README.markdown

@@ -0,0 +1,44 @@
+# Event Module for BrowserCMS
+
+An Event Module for BrowserCMS. Allows contributors to create and post new upcoming events. 
+
+## Features
+
+* Events - Contributors can create Event content that represent Single or Multiday Events.
+* Event Lists - Allows a complete listing of all published events in a reverse chronological order along with names and descriptions.
+* Event Details - Allows visitors to see the complete details for each Event, including the ability link to external Event Registration pages.
+* SEO Friendly URLs - Each event will have its own custom URL to display itself.
+* Customizable Views - Event listings and detail pages can be styled using editable Portlet views.
+
+## Installation
+
+The Event module installs like other BrowserCMS modules.
+
+    gem install bcms_event
+	rails g cms:install bcms_event
+
+See http://guides.browsercms.org/installing_modules.html for further details.
+
+### What's installed
+
+When installing this module, it will create the following new pages/blocks.
+
+* Event Page - A new Page 'Event' will be created at the root of the site, with an 'Event' portlet added. (Allows this page to display any Event)
+* Events Page - A new Page 'Events' that will list all published events in a list.
+* Event Route - A dynamic route to allow specific events to be shown by the Event page using a route like /events/:year/:month/:day/:slug
+
+## Event Details
+
+This module includes a new Event Content Type, with the following fields:
+
+* Name
+* Start and End Dates
+* Location
+* Contact Email
+* Description - Used on the Event listing to summarize the Event.
+* More Info URL
+* Registration URL - Allows a link to external sites for registration.
+* Category
+* Tags
+* Body - For the detailed view page.
+

data/app/models/event.rb

@@ -5,7 +5,7 @@ class Event < ActiveRecord::Base
   before_validation :set_slug
   validates_presence_of :name, :slug, :starts_on
 
-  named_scope :starts_on, lambda {|date|
+  scope :starts_on, lambda {|date|
     d = if date.kind_of?(Hash)
       Date.new(date[:year].to_i, date[:month].to_i, date[:day].to_i)
     else
@@ -15,7 +15,7 @@ class Event < ActiveRecord::Base
     {:conditions => ["events.starts_on = ?", d]}
   }
       
-  named_scope :with_slug, lambda{|slug| {:conditions => ["events.slug = ?",slug]}}  
+  scope :with_slug, lambda{|slug| {:conditions => ["events.slug = ?",slug]}}  
 
   def self.default_order
     "starts_on desc"

data/app/portlets/event_portlet.rb

@@ -1,5 +1,7 @@
 class EventPortlet < Portlet
     
+  enable_template_editor true
+  
   def render
     # @event should already be set by the page route
     if !@event && params[:event_id]

data/app/portlets/events_portlet.rb

@@ -1,5 +1,7 @@
 class EventsPortlet < Portlet
     
+  enable_template_editor true
+    
   def render
     if self.category_id.blank?
       @events = Event.published.all

data/app/views/cms/events/render.html.erb

@@ -3,8 +3,8 @@
 <p><b>Ends On:</b> <%= @content_block.ends_on %></p>
 <p><b>Location:</b> <%= @content_block.location %></p>
 <p><b>Contact Email:</b> <%= @content_block.contact_email %></p>
-<p><b>Description:</b> <%= simple_format h(@content_block.description) %></p>
+<p><b>Description:</b> <%= simple_format @content_block.description %></p>
 <p><b>More Info Url:</b> <%= @content_block.more_info_url %></p>
 <p><b>Registration Url:</b> <%= @content_block.registration_url %></p>
 <p><b>Category:</b> <%= @content_block.category_name %></p>
-<p><b>Body:</b> <%= @content_block.body %></p>
+<p><b>Body:</b> <%= @content_block.body.html_safe %></p>

data/app/views/layouts/templates/default.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <title><%= page_title %></title>
+    <%= yield :html_head %>
+  </head>
+  <body style="margin: 0; padding: 0; text-align: center;">
+    <%= cms_toolbar %>
+    <div id="wrapper" style="width: 700px; margin: 0 auto; text-align: left; padding: 30px">
+      Breadcrumbs: <%= render_breadcrumbs %>
+      Main Menu: <%= render_menu %>
+      <h1><%= page_title %></h1>
+      <%= container :main %>
+    </div>
+  </body>
+</html>

data/app/views/portlets/event/_form.html.erb

@@ -1,2 +1,2 @@
 <%= f.cms_text_field :name %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= f.cms_template_editor :template %>

data/app/views/portlets/event/render.html.erb

@@ -1,4 +1,5 @@
-<p><b>Name:</b> <%= @event.name %></p>
+<% if @event %>
+<p><b>Name:</b> <%= @event.name.html_safe %></p>
 <p><b>Starts On:</b> <%= @event.starts_on %></p>
 <p><b>Ends On:</b> <%= @event.ends_on %></p>
 <p><b>Location:</b> <%= @event.location %></p>
@@ -7,4 +8,8 @@
 <p><b>More Info Url:</b> <%= @event.more_info_url %></p>
 <p><b>Registration Url:</b> <%= @event.registration_url %></p>
 <p><b>Category:</b> <%= @event.category_name %></p>
-<p><b>Body:</b> <%= @event.body %></p>
+<p><b>Body:</b> <%= @event.body.html_safe %></p>
+<% else -%>
+  <b>Missing required parameter</b><br/>
+  This portlet expects a request parameter 'event_id'. Be sure the calling page provides it.
+<% end -%>

data/app/views/portlets/events/_form.html.erb

@@ -1,3 +1,3 @@
 <%= f.cms_text_field :name %>
 <%= f.cms_drop_down :category_id, categories_for('Event').map{|c| [c.path, c.id]}, :include_blank => true %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= f.cms_template_editor :template %>

data/app/views/portlets/events/render.html.erb

@@ -7,9 +7,9 @@
         <div id="event_<%= event.id %>" class="event">
           <span class="event_starts_on"><b><%= event.starts_on.to_s(:long) %></b></span>
           <br/>
-          <%= link_to "<b>#{h(event.name)}</b>", event_path(event.route_params) %><br/>
+          <%= link_to "<b>#{h(event.name)}</b>".html_safe, event_path(event.route_params) %><br/>
           <% unless event.description.blank? -%>
-            <p><%= simple_format h(event.description) %></p>
+            <p><%= simple_format(event.description).html_safe %></p>
           <% end %>
         </div>
       <% end %>

data/db/bcms_event.seeds.rb

@@ -0,0 +1,44 @@
+# Load the seed data specifically for the Event Module
+# Add the following line to your seeds.rb to make db:seed run this file:
+#   load File.expand_path('../bcms_event.seeds.rb', __FILE__)
+unless CategoryType.named('Event').exists?
+  CategoryType.create!(:name => "Event")
+end
+
+ContentType.create!(:name => "Event", :group_name => "Event")
+
+event_page = Page.create!(
+  :name => "Event", 
+  :path => "/event", 
+  :section => Section.root.first,
+  :template_file_name => "default.html.erb")
+  
+EventPortlet.create!(
+  :name => "Event Details",
+  :template => EventPortlet.default_template,
+  :connect_to_page_id => event_page.id,
+  :connect_to_container => "main",
+  :publish_on_save => true)
+  
+events_page = Page.create!(
+    :name => "Events", 
+    :path => "/events", 
+    :section => Section.root.first,
+    :template_file_name => "default.html.erb")
+    
+EventsPortlet.create!(
+  :name => "Event List",
+  :template => EventsPortlet.default_template,
+  :connect_to_page_id => events_page.id,
+  :connect_to_container => "main",
+  :publish_on_save => true)      
+  
+route = event_page.page_routes.build(
+  :name => "Event",
+  :pattern => "/events/:year/:month/:day/:slug",
+  :code => "@event = Event.published.starts_on(params).with_slug(params[:slug]).first")
+route.add_condition(:method, "get")
+route.add_requirement(:year, '\d{4,}')
+route.add_requirement(:month, '\d{2,}')
+route.add_requirement(:day, '\d{2,}')
+route.save!

data/db/migrate/20090504174621_create_events.rb

@@ -13,42 +13,6 @@ class CreateEvents < ActiveRecord::Migration
       t.belongs_to :category 
       t.text :body, :size => (64.kilobytes + 1) 
     end
-    unless CategoryType.named('Event').exists?
-      CategoryType.create!(:name => "Event")
-    end
-    
-    ContentType.create!(:name => "Event", :group_name => "Event")
-    
-    event_page = Page.create!(
-      :name => "Event", 
-      :path => "/event", 
-      :section => Section.root.first,
-      :template_file_name => "default.html.erb")
-      
-    EventPortlet.create!(
-      :name => "Event Details",
-      :template => EventPortlet.default_template,
-      :connect_to_page_id => event_page.id,
-      :connect_to_container => "main",
-      :publish_on_save => true)
-      
-    EventsPortlet.create!(
-      :name => "Event List",
-      :template => EventsPortlet.default_template,
-      :connect_to_page_id => event_page.id,
-      :connect_to_container => "main",
-      :publish_on_save => true)      
-      
-    route = event_page.page_routes.build(
-      :name => "Event",
-      :pattern => "/events/:year/:month/:day/:slug",
-      :code => "@event = Event.published.starts_on(params).with_slug(params[:slug]).first")
-    route.add_condition(:method, "get")
-    route.add_requirement(:year, '\d{4,}')
-    route.add_requirement(:month, '\d{2,}')
-    route.add_requirement(:day, '\d{2,}')
-    route.save!    
-    
   end
 
   def self.down

data/lib/bcms_event/engine.rb

@@ -0,0 +1,7 @@
+require 'browsercms'
+
+module BcmsEvent
+  class Engine < Rails::Engine
+    include Cms::Module
+  end
+end

data/lib/bcms_event/routes.rb

@@ -1,7 +1,7 @@
 module Cms::Routes
   def routes_for_bcms_event
-    namespace(:cms) do |cms|
-      cms.content_blocks :events
+    namespace(:cms) do
+      content_blocks :events
     end  
   end
 end

data/lib/bcms_event/version.rb

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

data/lib/bcms_event.rb

@@ -1 +1,2 @@
+require 'bcms_event/engine'
 require 'bcms_event/routes'

data/lib/generators/bcms_event/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs the bcms_event module.
+
+Example:
+    rails generate bcms_event:install
+
+    This will:
+		1. Copy any migrations from the gem into the project.
+		2. Add the routes to the config/routes.rb
+

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

@@ -0,0 +1,13 @@
+require 'cms/module_installation'
+
+class BcmsEvent::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+
+  # Add migrations to be copied, by uncommenting the following file and editing as needed.
+  copy_migration_file '20090504174621_create_events.rb'
+
+  def add_seed_data_to_project
+    copy_file "../bcms_event.seeds.rb", "db/bcms_event.seeds.rb"
+    append_to_file "db/seeds.rb", "load File.expand_path('../bcms_event.seeds.rb', __FILE__)"
+  end
+end

metadata

@@ -1,72 +1,86 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bcms_event
-version: !ruby/object:Gem::Version 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - BrowserMedia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-07-02 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: The Event Module for BrowserCMS
+date: 2012-01-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: browsercms
+  requirement: &70147159461800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70147159461800
+description: 
 email: github@browsermedia.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README
-files: 
+extra_rdoc_files:
+- README.markdown
+files:
 - app/controllers/cms/events_controller.rb
 - app/models/event.rb
 - app/portlets/event_portlet.rb
 - app/portlets/events_portlet.rb
 - app/views/cms/events/_form.html.erb
 - app/views/cms/events/render.html.erb
+- app/views/layouts/templates/default.html.erb
 - app/views/portlets/event/_form.html.erb
 - app/views/portlets/event/render.html.erb
 - app/views/portlets/events/_form.html.erb
 - app/views/portlets/events/render.html.erb
 - db/migrate/20090504174621_create_events.rb
-- lib/bcms_event.rb
+- db/bcms_event.seeds.rb
+- lib/bcms_event/engine.rb
 - lib/bcms_event/routes.rb
-- rails/init.rb
+- lib/bcms_event/version.rb
+- lib/bcms_event.rb
+- lib/generators/bcms_event/install/install_generator.rb
+- lib/generators/bcms_event/install/USAGE
+- Gemfile
 - LICENSE.txt
-- README
-has_rdoc: true
-homepage: http://browsercms.org
+- COPYRIGHT.txt
+- GPL.txt
+- README.markdown
+homepage: http://www.github.com/browsermedia/bcms_event
+licenses: []
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2581123145499977071
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2581123145499977071
 requirements: []
-
-rubyforge_project: browsercms
-rubygems_version: 1.3.1
+rubyforge_project: bcms_event
+rubygems_version: 1.8.10
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: The Event Module for BrowserCMS
-test_files: 
-- test/functional/events_portlet_test.rb
-- test/performance/browsing_test.rb
-- test/test_helper.rb
-- test/test_logging.rb
+test_files: []