refinerycms-news 2.0.1 → 2.1.0

data/config/routes.rb

@@ -1,12 +1,12 @@
 Refinery::Core::Engine.routes.draw do
   namespace :news do
     root :to => "items#index"
-    get 'archive/:year(/:month)', :to => 'items#archive', :as => 'items_archive'
+    get 'archive/:year(/:month)', :to => 'items#archive', :as => 'items_archive', :constraints => { :year => /\d{4}/, :month => /\d{1,2}/ }
     resources :items, :only => [:show, :index], :path => ''
   end
 
   namespace :news, :path => '' do
-    namespace :admin, :path => 'refinery' do
+    namespace :admin, :path => Refinery::Core.backend_route do
       scope :path => 'news' do
         root :to => "items#index"
         resources :items, :except => :show

data/readme.md

@@ -19,7 +19,9 @@ Key features:
 
 Include the latest [gem](http://rubygems.org/gems/refinerycms-news) into your Refinery CMS application's Gemfile:
 
-    gem "refinerycms-news", '~> 2.0.0'
+```ruby
+gem "refinerycms-news", '~> 2.0.0'
+```
 
 Then type the following at command line inside your Refinery CMS application's root directory:
 
@@ -28,6 +30,45 @@ Then type the following at command line inside your Refinery CMS application's r
     rake db:migrate
     rake db:seed
 
+## How to display a news feed on the homepage:
+
+Assuming you've already overridden the homepage view:
+
+    $ rake refinery:override view=refinery/pages/home
+
+You can render the `recent_posts` partial. However, you will need to set the recent News items manually, since this is normally handled in the News::Items controller:
+
+```erb
+<% @items = Refinery::News::Item.latest(5) %>
+<%= render :partial => '/refinery/news/items/recent_posts' %>
+```
+
+## Configuring the number of items per page
+
+To modify the number of items per page for the news items index without
+affecting the archive page you must override the method in the controller that
+sets `@items` for the index: `find_published_news_items`.
+
+Currently the method body is:
+```ruby
+@items = Item.published.translated.page(params[:page])
+```
+
+The `page` convenience method needs to be replaced with `paginate` and
+`per_page` passed as an option.  Add a decorator for the items controller with
+the following contents:
+
+```ruby
+module Refinery::News
+  ItemsController.class_eval do
+    def find_published_news_items
+      @items = Item.published.translated.paginate :page => params[:page],
+                                                  :per_page => 8
+    end
+  end
+end
+```
+
 ## Customising the views
 
 Type this command at your project root to override the default front end views:
@@ -42,4 +83,12 @@ Type this command at your project root to override the default front end views:
 
 To get RSS for your entire site, insert this into the head section of your layout after installing:
 
-    <%= auto_discovery_link_tag(:rss, refinery.news_items_url(:format => 'rss')) %>
+```erb
+<%= auto_discovery_link_tag(:rss, refinery.news_items_url(:format => 'rss')) %>
+```
+
+## More Information
+* Check out our [Website](http://refinerycms.com/)
+* Refinery Documentation is available in the [guides](http://refinerycms.com/guides)
+* Questions can be asked on our [Google Group](http://group.refinerycms.org)
+* Questions can also be asked in our IRC room, [#refinerycms on freenode](irc://irc.freenode.net/refinerycms)

data/refinerycms-news.gemspec

@@ -2,9 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name              = %q{refinerycms-news}
-  s.version           = %q{2.0.1}
+  s.version           = %q{2.1.0}
   s.description       = %q{A really straightforward open source Ruby on Rails news engine designed for integration with Refinery CMS.}
-  s.date              = "#{Date.today.strftime("%Y-%m-%d")}"
   s.summary           = %q{Ruby on Rails news engine for Refinery CMS.}
   s.email             = %q{info@refinerycms.com}
   s.homepage          = %q{http://refinerycms.com}
@@ -14,7 +13,7 @@ Gem::Specification.new do |s|
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- spec/*`.split("\n")
 
-  s.add_dependency    'refinerycms-core',     '~> 2.0.1'
-  s.add_dependency    'refinerycms-settings', '~> 2.0.0'
-  s.add_dependency    'friendly_id',          '~> 4.0.1'
+  s.add_dependency    'refinerycms-core',     '~> 2.1.0'
+  s.add_dependency    'refinerycms-settings', '~> 2.1.0'
+  s.add_dependency    'friendly_id',          '~> 4.0.9'
 end

data/spec/controllers/refinery/news/items_controller_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+module Refinery
+  module News
+    describe ItemsController do
+      let!(:item) { FactoryGirl.create(:news_item) }
+      let(:refinery_page) { Refinery::Page.where(:link_url => "/news").first }
+
+      describe "#index" do
+        it "assigns items and page" do
+          get :index
+          assigns(:items).first.should eq(item)
+          assigns(:page).should eq(refinery_page)
+        end
+
+        it "renders 'index' template" do
+          get :index
+          response.should render_template(:index)
+        end
+      end
+
+      describe "#show" do
+        it "assigns item and page" do
+          get :show, :id => item.id
+          assigns(:item).should eq(item)
+          assigns(:page).should eq(refinery_page)
+        end
+
+        it "renders 'show' template" do
+          get :show, :id => item.id
+          response.should render_template(:show)
+        end
+      end
+
+      describe "#archive" do
+        context "when month is present" do
+          it "assigns archive_date and items" do
+            Refinery::News::Item.stub_chain(:archived, :translated, :by_archive, :page).and_return(item)
+            get :archive, :month => 05, :year => 1999
+            assigns(:archive_date).should eq(Time.parse("05/1999"))
+            assigns(:items).should eq(item)
+            assigns(:archive_for_month).should be_true
+          end
+        end
+
+        context "when month isnt present" do
+          it "assigns archive_date and items" do
+            Refinery::News::Item.stub_chain(:archived, :translated, :by_year, :page).and_return(item)
+            get :archive, :year => 1999
+            assigns(:archive_date).should eq(Time.parse("01/1999"))
+            assigns(:items).should eq(item)
+          end
+        end
+
+        it "renders 'archive' template" do
+          get :archive, :year => 1999
+          response.should render_template(:archive)
+        end
+
+        it "assigns page" do
+          get :archive, :year => 1999
+          assigns(:page).should eq(refinery_page)
+        end
+      end
+    end
+  end
+end

data/spec/{requests → features}/manage_news_items_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "manage news items" do
-  login_refinery_user
+  refinery_login_with :refinery_user
 
   context "when no news items" do
     it "invites to create one" do
@@ -16,7 +16,7 @@ describe "manage news items" do
 
       within "#actions" do
         page.should have_content("Add News Item")
-        page.should have_selector("a[href='/refinery/news/items/new']")
+        page.should have_selector("a[href='/#{Refinery::Core.backend_route}/news/items/new']")
       end
     end
   end
@@ -35,7 +35,7 @@ describe "manage news items" do
       page.should have_content("'My first news item' was successfully added.")
       page.body.should =~ /Remove this news item forever/
       page.body.should =~ /Edit this news item/
-      page.body.should =~ %r{/refinery/news/items/my-first-news-item/edit}
+      page.body.should =~ %r{/#{Refinery::Core.backend_route}/news/items/my-first-news-item/edit}
       page.body.should =~ /View this news item live/
       page.body.should =~ %r{/news/items/my-first-news-item}
 
@@ -44,7 +44,7 @@ describe "manage news items" do
   end
 
   describe "edit/update" do
-    before(:each) { Factory(:news_item, :title => "Update me") }
+    before { FactoryGirl.create(:news_item, :title => "Update me") }
 
     it "updates news item" do
       visit refinery.news_admin_items_path
@@ -61,7 +61,7 @@ describe "manage news items" do
   end
 
   describe "destroy" do
-    before(:each) { Factory(:news_item, :title => "Delete me") }
+    before { FactoryGirl.create(:news_item, :title => "Delete me") }
 
     it "removes news item" do
       visit refinery.news_admin_items_path
@@ -75,7 +75,7 @@ describe "manage news items" do
   end
 
   context "duplicate news item titles" do
-    before(:each) { Factory(:news_item, :title => "I was here first") }
+    before { FactoryGirl.create(:news_item, :title => "I was here first") }
 
     it "isn't a problem" do
       visit refinery.new_news_admin_item_path

data/spec/{requests → features}/visit_news_items_spec.rb

@@ -1,13 +1,11 @@
 require "spec_helper"
 
 describe "visit news items" do
-  login_refinery_user
-
-  before(:each) do
-    Factory.create(:page, :link_url => "/")
-    Factory.create(:page, :link_url => "/news", :title => "News")
-    @published_news_item = Factory.create(:news_item, :title => "published", :source => "http://refinerycms.com", :publish_date => 1.hour.ago)
-    @unpublished_news_item = Factory.create(:news_item, :title => "unpublished", :publish_date => 1.day.from_now)
+  before do
+    FactoryGirl.create(:page, :link_url => "/")
+    FactoryGirl.create(:page, :link_url => "/news", :title => "News")
+    FactoryGirl.create(:news_item, :title => "unpublished", :publish_date => 1.day.from_now)
+    @published_news_item = FactoryGirl.create(:news_item, :title => "published", :source => "http://refinerycms.com", :publish_date => 1.hour.ago)
   end
 
   it "shows news link in menu" do

data/spec/helpers/refinery/news/items_helper_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Refinery
+  module News
+    describe ItemsHelper do
+      describe '#news_item_archive_links' do
+        before do
+          2.times { FactoryGirl.create(:news_item, :publish_date => Time.utc(2012, 05)) }
+          3.times { FactoryGirl.create(:news_item, :publish_date => Time.utc(2012, 04)) }
+        end
+
+        it 'returns list of links to archives' do
+          expected = '<ul><li><a href="/news/archive/2012/5">May 2012 (2)</a></li><li><a href="/news/archive/2012/4">April 2012 (3)</a></li></ul>'
+          helper.news_item_archive_links.should eq(expected)
+        end
+      end
+
+      describe "#archive_date_format" do
+        context "when date_for_month is true" do
+          it "returns month and year" do
+            expect(helper.archive_date_format(true)).to eq("%B %Y")
+          end
+        end
+
+        context "when date_for_month is nil" do
+          it "returns year" do
+            expect(helper.archive_date_format(nil)).to eq("%Y")
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/models/refinery/news/item_spec.rb

@@ -5,7 +5,20 @@ module Refinery
     describe Item do
 
       let(:time_now) { Time.now }
-      let(:news_item) { Factory(:news_item) }
+      let(:news_item) { FactoryGirl.create(:news_item) }
+
+      describe "#archive" do
+        let(:publish_date) { Time.utc(2012,1,15) }
+        let(:future_date) { Time.utc(2012,2,15) }
+        let(:archive_range) { Time.parse("2012-01-17") }
+
+        it "should show 5 news items with publish dates in same month" do
+          5.times { FactoryGirl.create(:news_item, :publish_date => publish_date) }
+          2.times { FactoryGirl.create(:news_item, :publish_date => future_date) }
+
+          Refinery::News::Item.by_archive(archive_range).count.should == 5
+        end
+      end
 
       describe "validations" do
         subject do
@@ -29,8 +42,8 @@ module Refinery
 
       describe "default scope" do
         it "orders by publish date in DESC order" do
-          news_item1 = Factory(:news_item, :publish_date => 1.hour.ago)
-          news_item2 = Factory(:news_item, :publish_date => 2.hours.ago)
+          news_item1 = FactoryGirl.create(:news_item, :publish_date => 1.hour.ago)
+          news_item2 = FactoryGirl.create(:news_item, :publish_date => 2.hours.ago)
           news_items = Refinery::News::Item.all
           news_items.first.should == news_item1
           news_items.second.should == news_item2
@@ -38,7 +51,7 @@ module Refinery
       end
 
       describe ".not_expired" do
-        let!(:news_item) { Factory(:news_item) }
+        let!(:news_item) { FactoryGirl.create(:news_item) }
 
         specify "expiration date not set" do
           Refinery::News::Item.not_expired.count.should == 1
@@ -59,33 +72,44 @@ module Refinery
 
       describe ".published" do
         it "returns only published news items" do
-          Factory(:news_item)
-          Factory(:news_item, :publish_date => Time.now + 1.hour)
+          FactoryGirl.create(:news_item)
+          FactoryGirl.create(:news_item, :publish_date => Time.now + 1.hour)
           Refinery::News::Item.published.count.should == 1
         end
       end
 
       describe ".latest" do
         it "returns 10 latest news items by default" do
-          5.times { Factory(:news_item) }
-          5.times { Factory(:news_item, :publish_date => Time.now + 1.hour) }
+          5.times { FactoryGirl.create(:news_item) }
+          5.times { FactoryGirl.create(:news_item, :publish_date => Time.now + 1.hour) }
           Refinery::News::Item.latest.count.should == 5
-          7.times { Factory(:news_item) }
-          Refinery::News::Item.latest.length.should == 10
+          7.times { FactoryGirl.create(:news_item) }
+          Refinery::News::Item.latest.count.should == 10
         end
 
         it "returns latest n news items" do
-          4.times { Factory(:news_item) }
-          Refinery::News::Item.latest(3).length.should == 3
+          4.times { FactoryGirl.create(:news_item) }
+          Refinery::News::Item.latest(3).count.should == 3
         end
       end
 
       describe ".not_published?" do
         it "returns not published news items" do
-          news_item = Factory(:news_item, :publish_date => Time.now + 1.hour)
+          news_item = FactoryGirl.create(:news_item, :publish_date => Time.now + 1.hour)
           news_item.not_published?.should be_true
         end
       end
+
+      describe ".archived" do
+        it "returns all published/expired news items" do
+          expired = FactoryGirl.create(:news_item, :publish_date => Time.now - 2.months, :expiration_date => Time.now - 1.months)
+          published = FactoryGirl.create(:news_item, :publish_date => Time.now - 1.month)
+          not_published = FactoryGirl.create(:news_item, :publish_date => Time.now + 1.month)
+          expect(Refinery::News::Item.archived).to include(expired)
+          expect(Refinery::News::Item.archived).to include(published)
+          expect(Refinery::News::Item.archived).to_not include(not_published)
+        end
+      end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,56 +1,30 @@
 require 'rubygems'
 
-def setup_environment
-  # Configure Rails Environment
-  ENV["RAILS_ENV"] ||= 'test'
+# Configure Rails Environment
+ENV["RAILS_ENV"] ||= 'test'
 
-  require File.expand_path("../dummy/config/environment", __FILE__)
+require File.expand_path("../dummy/config/environment", __FILE__)
 
-  require 'rspec/rails'
-  require 'capybara/rspec'
-  require 'factory_girl_rails'
+require 'rspec/rails'
+require 'capybara/rspec'
+require 'factory_girl_rails'
 
-  Rails.backtrace_cleaner.remove_silencers!
+Rails.backtrace_cleaner.remove_silencers!
 
-  RSpec.configure do |config|
-    config.mock_with :rspec
-    config.treat_symbols_as_metadata_keys_with_true_values = true
-    config.filter_run :focus => true
-    config.run_all_when_everything_filtered = true
-  end
-
-  # set javascript driver for capybara
-  Capybara.javascript_driver = :selenium
-end
-
-def each_run
-  ActiveSupport::Dependencies.clear
-
-  FactoryGirl.reload
-
-  # Requires supporting files with custom matchers and macros, etc,
-  # in ./support/ and its subdirectories including factories.
-  ([Rails.root.to_s] | ::Refinery::Plugins.registered.pathnames).map{|p|
-    Dir[File.join(p, 'spec', 'support', '**', '*.rb').to_s]
-  }.flatten.sort.each do |support_file|
-    require support_file
-  end
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
 end
 
-# If spork is available in the Gemfile it'll be used but we don't force it.
-unless (begin; require 'spork'; rescue LoadError; nil end).nil?
-  Spork.prefork do
-    # Loading more in this block will cause your tests to run faster. However,
-    # if you change any configuration or code from libraries loaded here, you'll
-    # need to restart spork for it take effect.
-    setup_environment
-  end
+# set javascript driver for capybara
+Capybara.javascript_driver = :selenium
 
-  Spork.each_run do
-    # This code will be run each time you run your specs.
-    each_run
-  end
-else
-  setup_environment
-  each_run
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories including factories.
+([Rails.root.to_s] | ::Refinery::Plugins.registered.pathnames).map{|p|
+  Dir[File.join(p, 'spec', 'support', '**', '*.rb').to_s]
+}.flatten.sort.each do |support_file|
+  require support_file
 end