bcms_news 1.0.0 → 1.2.0

data/README.markdown

@@ -0,0 +1,34 @@
+# News Module for BrowserCMS
+
+A module to create and display News Items or Press Releases content.
+
+## Features
+
+* *News Articles* - Contributors can create News Articles with attributes like release date, title, summary, body and an attachment.
+* *Friendly URLs* - Each news article will have its own unique path created automatically based on its name. Published article can be accessed via these paths.
+* *RSS - Visitors* can subscribe to an RSS feed that displays the most recent 15 News Articles.
+* *Recent News* - Contributors can show the most recent few articles (via a Portlet) on any page. The exact # of articles shown can be configured.
+* *Archive* - Visitors can browse all past articles. By default, the portlet will display articles in reverse chronological order, grouped by month.
+* *Categorized* - Uses the core Category module to allow each News Article to marked for a particular Category. Both the _Recent News_ and _Archive_ can be configured to show articles only in a particular category.
+* *Configurable Views* - Each portlet's view can be edited via the CMS UI to be tweaked for any site design.
+* *News Section* - A top level 'News' section will be created along with several pages designed to handle the above features will be created.
+
+## News Articles
+The News Module defines a new content type, "News Article" which comes with the following fields.
+
+* Name (Textfield)
+* Release Date (Date Picker)
+* Category (Select one)
+* Summary (Textarea) - Appears in summarized lists (like 'Recent News')
+* Body (HTML Editor) - Appears when individual news articles are viewed.
+* File (File Upload) - Allows files attachments like PDF attachments to be added
+* Tags (Free Form Tagging) - Allows multiple free form tags to be applied to any article.
+
+## Installation
+
+The news module uses the standard BrowserCMS module instructions as detailed here: http://guides.browsercms.org/installing_modules.html
+
+### After Installation
+
+The news module will create several pages under a 'News' section in the root of the Sitemap. Contributors will need to publish these pages via the sitemap in order for them to display in the menus.
+

data/app/models/news_article.rb

@@ -8,10 +8,10 @@ class NewsArticle < ActiveRecord::Base
   
   before_validation :set_slug
   
-  named_scope :released, :conditions => 
+  scope :released, :conditions => 
     ["news_articles.published = ? and news_articles.release_date <= ?", true, Time.now]
 
-  named_scope :released_on, lambda {|date|
+  scope :released_on, lambda {|date|
     d = if date.kind_of?(Hash)
       Date.new(date[:year].to_i, date[:month].to_i, date[:day].to_i)
     else
@@ -25,7 +25,7 @@ class NewsArticle < ActiveRecord::Base
     ]}
   }
       
-  named_scope :with_slug, lambda{|slug| {:conditions => ["news_articles.slug = ?",slug]}}
+  scope :with_slug, lambda{|slug| {:conditions => ["news_articles.slug = ?",slug]}}
   
   def category_name
     category ? category.name : nil

data/app/portlets/news_archive_portlet.rb

@@ -1,5 +1,8 @@
 class NewsArchivePortlet < Portlet
 
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
+
   def render
     if self.category_id.blank?
       @articles = NewsArticle.all(:order => "release_date desc", :limit => self.limit)

data/app/portlets/news_article_portlet.rb

@@ -1,4 +1,7 @@
 class NewsArticlePortlet < Portlet
+
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
   
   def render
     # @news_article should already be set by the page route

data/app/portlets/recent_news_portlet.rb

@@ -1,4 +1,7 @@
 class RecentNewsPortlet < Portlet
+
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
   
   def render
     order = "release_date DESC"

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

@@ -1,2 +1,2 @@
 <h2><%=h @content_block.name %></h2>
-<p><%= @content_block.body %></p>
+<p><%= @content_block.body.html_safe %></p>

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

@@ -1,3 +1,3 @@
 <%= f.cms_text_field :name %>
 <%= f.cms_drop_down :category_id, categories_for('News Article').map{|c| [c.path, c.id]}, { :selected=>f.object.category_id.to_i, :include_blank=>"Show News Articles in any Category", :instructions=>"Select a category to show News Articles from only that category." } %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= f.cms_template_editor :template %>

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

@@ -1,5 +1,5 @@
 <% content_for :html_head do %>
-  <%= auto_discovery_link_tag :rss, news_articles_url, "RSS Feed for News Articles" %>
+  <%= auto_discovery_link_tag( :rss, news_articles_url, {:title => "RSS Feed for News Articles"}) %>
 <% end %>
 <div>
   <% @articles.group_by(&:year).sort_by(&:first).reverse.each do |year, year_articles| %>

data/app/views/portlets/news_article/_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/recent_news/_form.html.erb

@@ -4,4 +4,4 @@
 <%= f.cms_drop_down :sort_order, %w(asc desc).collect { |field| ["#{field.titleize}ending", field.upcase] } %>
 <%= f.cms_drop_down :category_id, categories_for('News Article').map{|c| [c.path, c.id]}, {:selected=>f.object.category_id.to_i, :include_blank=>"Show News Articles in any Category", :instructions=>"Select a category to show News Articles from only that category." } %>
 <%= f.cms_text_field :more_link %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= f.cms_template_editor :template %>

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

@@ -1,5 +1,5 @@
 <% content_for :html_head do %>
-  <%= auto_discovery_link_tag :rss, news_articles_url, "RSS Feed for News Articles" %>
+  <%= auto_discovery_link_tag( :rss, news_articles_url, {:title => "RSS Feed for News Articles" }) %>
 <% end %>
 <b>Latest News</b>
 <br/>

data/db/migrate/20090410193313_create_news_articles.rb

@@ -17,7 +17,7 @@ class CreateNewsArticles < ActiveRecord::Migration
     news = Section.create!(:name => "News", 
       :path => "/news", 
       :parent => Section.root.first, 
-      :group_ids => Group.all(&:id))      
+      :group_ids => Group.all.map(&:id))      
 
     # Create the page to display the recent news
     overview = Page.create!(:name => "Overview", 

data/lib/bcms_news/engine.rb

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

data/lib/bcms_news/routes.rb

@@ -1,13 +1,11 @@
-module Cms::Routes
-  def routes_for_bcms_news
+module Cms
+  module Routes
+    def routes_for_bcms_news
     
-    news_articles '/news/articles.rss', 
-      :controller => "news_articles", 
-      :conditions => {:method => :get},
-      :format => "rss"
-    
-    namespace(:cms) do |cms|
-      cms.content_blocks :news_articles
-    end  
+      match '/news/articles.rss', :to=>"news_articles#index", :as=>'news_articles', :method=>:get, :defaults => { :format => 'rss' }
+      namespace(:cms) do 
+        content_blocks :news_articles
+      end  
+    end
   end
 end

data/lib/bcms_news.rb

@@ -1 +1,3 @@
-require 'bcms_news/routes'
+require 'bcms_news/routes'
+require 'bcms_news/engine'
+

data/lib/generators/bcms_news/install/USAGE

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

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

@@ -0,0 +1,8 @@
+require 'cms/module_installation'
+
+class BcmsNews::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+  
+  copy_migration_file '20090410193313_create_news_articles.rb'
+  
+end

data/test/integration/news_articles_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+class NewsArticlesTest < ActionController::IntegrationTest
+ 
+  test "login and browse site" do
+    get "/news/articles.rss"
+    
+    assert_response :success
+    assert_select "rss"
+  end
+  
+  
+end

data/test/performance/browsing_test.rb

@@ -1,8 +1,8 @@
 require 'test_helper'
-require 'performance_test_help'
+require 'rails/performance_test_help'
 
 # Profiling results for each test method are written to tmp/performance.
-class BrowsingTest < ActionController::PerformanceTest
+class BrowsingTest < ActionDispatch::PerformanceTest
   def test_homepage
     get '/'
   end

data/test/test_helper.rb

@@ -1,33 +1,8 @@
 ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-require 'test_help'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/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
-
-  # 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
-
   # 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

data/test/unit/news_article_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '/../test_helper')
+require 'test_helper'
 
 class NewsArticleTest < ActiveSupport::TestCase
   

data/test/unit/recent_news_portlet_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '/../test_helper')
+require 'test_helper'
 
 class RecentNewsArticleTest < ActiveSupport::TestCase
 

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bcms_news
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors: 
 - BrowserMedia
@@ -9,10 +10,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-02 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2011-05-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: browsercms
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
 description: The News Module for BrowserCMS
 email: github@browsermedia.com
 executables: []
@@ -21,7 +64,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README
+- README.markdown
 files: 
 - app/controllers/cms/news_articles_controller.rb
 - app/controllers/news_articles_controller.rb
@@ -40,38 +83,49 @@ files:
 - app/views/portlets/recent_news/render.html.erb
 - db/migrate/20090410193313_create_news_articles.rb
 - lib/bcms_news.rb
+- lib/bcms_news/engine.rb
 - lib/bcms_news/routes.rb
-- rails/init.rb
+- lib/generators/bcms_news/install/USAGE
+- lib/generators/bcms_news/install/install_generator.rb
 - LICENSE.txt
-- README
-has_rdoc: true
+- README.markdown
+- test/integration/news_articles_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/news_article_test.rb
+- test/unit/recent_news_portlet_test.rb
 homepage: http://browsercms.org
+licenses: []
+
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 546851667
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: browsercms
-rubygems_version: 1.3.1
+rubygems_version: 1.7.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: The News Module for BrowserCMS
 test_files: 
-- test/functional/news_articles_controller_test.rb
+- test/integration/news_articles_test.rb
 - test/performance/browsing_test.rb
 - test/test_helper.rb
 - test/unit/news_article_test.rb

data/README

@@ -1,4 +0,0 @@
-BrowserCMS News Module
-======================
-
-This is the BrowserCMS News Module.  This includes...

data/rails/init.rb

@@ -1,3 +0,0 @@
-gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-Cms.add_to_rails_paths gem_root
-Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"

data/test/functional/news_articles_controller_test.rb

@@ -1,13 +0,0 @@
-require File.join(File.dirname(__FILE__), '/../test_helper')
-
-class NewsArticlesControllerTest < ActionController::TestCase
-
-  test "User can call RSS Feed" do
-    get :index, {:format => "rss"}
-    assert :success
-    assert_select "rss"
-
-  end
-
- 
-end