noodall-articles 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Steve England
+
+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/README.markdown

@@ -0,0 +1,33 @@
+# Noodall Articles
+
+Noodall Articles adds simple blog functionality to Noodall.
+
+## Install
+
+Add to your `Gemfile`
+
+    gem 'noodall-articles', :git => 'git@github.com:noodall/noodall-articles.git'
+
+Run `bundle install`
+
+    bundle install
+
+## Configuration
+
+Noodall Articles adds an `Article` and `ArticleList` Node to Noodall.
+
+`ArticleList` is the classic blog listing page. `Article` is an individual blog post.
+
+In `config/initializers/noodall.rb`
+
+Add the `ArticleList` as a root template
+
+    Noodall::Node.root_templates ArticleList, ContentPage
+
+Noodall Articles also adds a `LatestArticles` component which you can to your slots if required.
+
+    Noodall::Node.slot :large, LatestArticles
+    Noodall::Node.slot :small, LatestArticles
+
+You can now create an `ArticleList` as your blog listing page and `Article` Nodes beneath it.
+

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NoodallArticles'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/noodall-articles/categories.js

@@ -0,0 +1,7 @@
+function categoriesAutocomplete() {
+  formFieldAutocomplete('/admin/categories.json', "input.categories-completer");
+};
+
+$(function() {
+  categoriesAutocomplete();
+});

data/app/controllers/admin/categories_controller.rb

@@ -0,0 +1,7 @@
+module Admin
+  class CategoriesController < ApplicationController
+    def index
+      render :json => Article.all_categories
+    end
+  end
+end

data/app/helpers/articles_helper.rb

@@ -0,0 +1,126 @@
+require 'noodall/articles/custom_link_renderer'
+
+module ArticlesHelper
+  def paginated_articles(pagination_options = {}, &block)
+    options = { :per_page => 10, :page => params[:page] }
+
+    # Add search filters
+    options.merge!(build_query_from_params)
+
+    if params[:year]
+      if params[:month]
+        time = Time.zone.local(params[:year].to_i, params[:month].to_i, 1)
+        options[:published_at] = { :$gt => time.beginning_of_month, :$lt => time.end_of_month }
+      else
+        time = Time.zone.local(params[:year].to_i, 1, 1)
+        options[:published_at] = { :$gt => time.beginning_of_year, :$lt => time.end_of_year }
+      end
+    end
+    articles = @node.articles.paginate(options)
+
+    # Set default will_paginate options
+    paginated_section_options = {
+      :renderer => Noodall::Articles::CustomLinkRenderer,
+      :next_label => "Next",
+      :previous_label => "Previous",
+      :first_label => "First",
+      :last_label => "Last"
+    }
+
+    # Override any options passed in
+    paginated_section_options.merge!(pagination_options)
+    paginated_section(articles, paginated_section_options) { yield(articles) }.html_safe unless articles.empty?
+  end
+
+  def articles_rss_feed(node)
+    node.articles.all(build_query_from_params)
+  end
+
+  def articles_rss_feed_link(text, options = {})
+    link_to(text, articles_rss_feed_url, options)
+  end
+
+  def articles_rss_feed_url
+    querystring = build_querystring
+    querystring[:format] = :rss
+    node_path(@node.list, querystring)
+  end
+
+  def articles_rss_feed_auto_discovery
+    auto_discovery_link_tag(:rss, articles_rss_feed_url, :title => "Articles RSS Feed")
+  end
+
+  def link_to_next_article(label = 'Next')
+    if next_article = @node.articles.where(:position.gt => @node.position).first
+      link_to label, node_path(next_article), class: 'next_page'
+    else
+      content_tag :span, label, class: 'next_page disabled'
+    end
+  end
+
+  def link_to_previous_article(label = 'Previous')
+    if previous_article = @node.articles.where(:position.lt => @node.position).order('position DESC').first
+      link_to label, node_path(previous_article), class: 'previous_page'
+    else
+      content_tag :span, label, class: 'previous_page disabled'
+    end
+  end
+
+  def link_for_filter_text(text, node, current_filter)
+    querystring = build_querystring(current_filter)
+    content_tag(:li) do
+      link_to(text, node_path(node.list, querystring))
+    end
+  end
+
+  def link_for_year_filter(node, year)
+    querystring = build_querystring(:year => year.year)
+    link_to("#{year.year} <span>(#{year.total})</span>".html_safe, node_path(node.list, querystring))
+  end
+
+  def link_for_month_filter(node, year, month, count)
+    querystring = build_querystring(:year => year.year, :month => month + 1)
+    content_tag(:li,
+      link_to("#{t(:'date.month_names')[month+1]} <span>(#{count})</span>".html_safe, node_path(node.list, querystring))
+    ) unless count.zero?
+  end
+
+  def selected_filter(filter)
+    params[filter.downcase] || filter
+  end
+
+  def article_region(node)
+    node.regions.blank? ? "All Regions" : node.regions
+  end
+
+  def authors
+    User.where(tags: 'authors')
+  end
+
+  def author
+    User.first(permalink: params[:author]) if valid_filter?(params[:author])
+  end
+
+  protected
+
+  def build_query_from_params
+    query = {}
+    query[:categories] = params[:category] if valid_filter?(params[:category])
+    query[:creator_id] = author._id unless author.nil?
+    query
+  end
+
+  def build_querystring(current_filter = {})
+    querystring = {
+      category: params[:category],
+      author: params[:author],
+      year: params[:year],
+      month: params[:month]
+    }
+    querystring.merge!(current_filter)
+  end
+
+  def valid_filter?(filter)
+    !filter.blank? && filter != "All"
+  end
+end

data/app/models/article.rb

@@ -0,0 +1,58 @@
+require 'noodall/articles/categories'
+
+class Article < Noodall::Node
+  extend Noodall::Articles::Categories
+
+  delegate :list, :articles, :all_categories, :recent_articles, :archive, :to => :parent
+
+  key :categories, Array, :index => true
+
+  key :asset_id, ObjectId
+  belongs_to :asset
+
+  def category_list=(string)
+    self.categories = string.to_s.split(',').map{ |t| t.strip.titlecase }.reject(&:blank?).compact.uniq
+  end
+
+  def category_list
+    categories.join(',')
+  end
+
+  def related_articles
+    @related_articles ||= begin
+      siblings
+        .published
+        .order('published_date DESC')
+        .where(:tags => /(#{tags.join('|')})/i)
+        .limit(3)
+    end
+  end
+
+  protected
+
+  # A slug for creating the permalink with date
+  def slug
+    (published_at || current_time).strftime('%Y/%m/%d/') + super
+  end
+
+  private
+
+  # Always put a new article at the top of a list
+  def set_position
+    write_attribute :position, 0 if self.position.blank?
+  end
+
+  # Parses body to find first image asset
+  def set_asset
+
+    # get all image assets
+    asset_ids = body.to_s.scan(%r|<img.*id="asset-([^"]*)".*/>|i)
+    if asset_ids.empty?
+      self.asset = nil
+    else
+      # remove prefix and file extension
+      self.asset = Asset.find_by_id(asset_ids.first.first.to_s)
+    end
+  end
+  before_save :set_asset
+end

data/app/models/article_list.rb

@@ -0,0 +1,49 @@
+require 'noodall/articles/archive'
+require 'noodall/articles/categories'
+
+class ArticleList < Noodall::Node
+  include Noodall::Articles::Archive
+  include Noodall::Articles::Categories
+
+  sub_templates Article
+
+  def articles
+    children.published
+  end
+
+  def recent_articles(options = {})
+    options = remove_invalid_filters(options)
+    options[:order] = ['published_at DESC','created_at DESC']
+    children.published.limit(3).all(options)
+  end
+
+  def list
+    self
+  end
+
+  def all_categories
+    super(children.published.criteria.to_hash)
+  end
+
+  def archive(options = {})
+    options = remove_invalid_filters(options)
+
+    criteria = Plucky::CriteriaHash.new(
+      :path => self._id,
+      :_type => 'Article',
+      :published_at => { :$lte => Time.zone.now },
+      :published_to => { :$gte => Time.zone.now }
+    ).to_hash.merge(options)
+
+    result = self.collection.map_reduce(archive_map('published_at'), archive_reduce, {:query => criteria, :finalize => archive_finalize, :out => "tmp_articles"})
+    years = result.find.to_a.map{ |hash| Year.new(hash['_id'],hash['value']) }.sort{ |a,b| b.year <=> a.year }
+
+    years
+  end
+
+  private
+
+  def remove_invalid_filters(query)
+    query.reject {|key, value| value == "All" || value.blank? }
+  end
+end

data/app/models/latest_articles.rb

@@ -0,0 +1,28 @@
+class LatestArticles < Noodall::Component
+
+  key :title, String, :default => "Latest Articles"
+
+  # Keys for filtering articles
+  key :category, String
+  key :article_list_id, ObjectId
+  belongs_to :article_list
+
+  # Returns a filtered list of latest articles
+  def articles
+    return [] if article_list.nil?
+    query = {
+      categories: category,
+      order: ['published_at DESC','created_at DESC']
+    }
+
+    # Remove any filters that are set to "All"
+    query.reject! {|key, value| value == "All" || value.blank? }
+
+    article_list.children.published.limit(3).all(query)
+  end
+
+  def categories
+    Article.all_categories
+  end
+
+end

data/app/views/admin/components/_latest_articles.html.erb

@@ -0,0 +1,21 @@
+<%= fields_for :node do |n| %>
+  <%= n.fields_for slot_name, component do |f| %>
+    <%= f.hidden_field :_type %>
+
+    <p>
+      <%= f.label :title %><br/>
+      <span class="input-wrap"><%= f.text_field :title %></span>
+    </p>
+
+    <p>
+      <%= f.label :article_list_id %><br/>
+      <span class="input-wrap"><%= f.collection_select :article_list_id, ArticleList.published.all, :id, :name, :prompt => 'Choose an Article List' %></span>
+    </p>
+
+    <p>
+      <%= f.label :category %><br/>
+      <span class="input-wrap"><%= f.select :category, component.categories, :include_blank => true %></span>
+    </p>
+
+  <% end %>
+<% end %>

data/app/views/admin/nodes/_article.html.erb

@@ -0,0 +1,55 @@
+<p>
+  <span class="tooltip" title="Enter a comma separated list of categories (e.g: one, two, three)">&nbsp;</span>
+  <%= f.label :category_list, 'Categories' %><br/>
+  <span class="input-wrap">
+    <%= f.text_field :category_list, :class => "categories-completer" %><br/>
+  </span>
+</p>
+
+<%= javascript_include_tag('noodall-articles/categories') %>
+
+<%= render :partial => 'noodall/admin/nodes/body', :locals => { :f => f }  %>
+<% content_for :component_table do %>
+<!--
+  modify this table to look like your template and link slots to correct anchors
+<table class="component-table">
+  <tr>
+    <td rowspan="2" class="content"></td>
+    <td colspan="2" rowspan="4" class="content"></td>
+    <td><a href="#small_component_form_0" class="slot_link">4</a></td>
+  </tr>
+  <tr>
+    <td><a href="#small_component_form_1" class="slot_link">5</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td><a href="#small_component_form_2" class="slot_link">6</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td><a href="#small_component_form_3" class="slot_link">7</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_0" class="slot_link">1</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_1" class="slot_link">2</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_2" class="slot_link">3</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td></td>
+    <td></td>
+    <td></td>
+  </tr>
+</table>
+-->
+<% end -%>

data/app/views/admin/nodes/_article_list.html.erb

@@ -0,0 +1,45 @@
+<%= render :partial => 'noodall/admin/nodes/body', :locals => { :f => f }  %>
+<% content_for :component_table do %>
+<!--
+  modify this table to look like your template and link slots to correct anchors
+<table class="component-table">
+  <tr>
+    <td rowspan="2" class="content"></td>
+    <td colspan="2" rowspan="4" class="content"></td>
+    <td><a href="#small_component_form_0" class="slot_link">4</a></td>
+  </tr>
+  <tr>
+    <td><a href="#small_component_form_1" class="slot_link">5</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td><a href="#small_component_form_2" class="slot_link">6</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td><a href="#small_component_form_3" class="slot_link">7</a></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_0" class="slot_link">1</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_1" class="slot_link">2</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td colspan="2"><a href="#wide_component_form_2" class="slot_link">3</a></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td></td>
+    <td></td>
+    <td></td>
+    <td></td>
+  </tr>
+</table>
+-->
+<% end -%>

data/app/views/application/_article_sidebar.html.erb

@@ -0,0 +1,74 @@
+<!-- FILTER NEWS -->
+<div class="component filter">
+  <h3 class="sup-title">Find News...</h3>
+  <% if @node.all_categories.any? %>
+  <div class="filter-wrap category-list">
+     <h4>Category</h4>
+      <ul id="categories-list">
+        <% for category in @node.all_categories %>
+          <%= link_for_filter_text(category, @node, category: category) %>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+</div>
+
+<% if authors.any? %>
+  <div class="component authors">
+  <h3 class="sup-title">Authors</h3>
+  <ul id="authors-list">
+    <% authors.each do |author| %>
+      <%= link_for_filter_text(author.full_name, @node.list, { :author => author.permalink }) %>
+    <% end %>
+  </ul>
+  </div>
+<% end %>
+
+<!-- RELATED ARTICLES -->
+<% if @node.is_a?(Article) %>
+  <% unless @node.related_articles.empty? %>
+    <div class="component related-articles">
+      <h3 class="sup-title">Related Articles</h3>
+      <ul id="related-articles">
+      <% @node.related_articles.each do |article| %>
+        <li class="<%= cycle("first", "second", "third") %>">
+          <%= link_to article.title, node_path(article), :class => "latest-link" %>
+          <time datetime="<%= article.published_at %>" pubdate><%= l article.published_at, :format => :short %></time>
+        </li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+<% end %>
+
+<!-- RECENT ARTICLES -->
+<div class="component latest-articles">
+  <h3 class="sup-title">Recent Articles</h3>
+  <ul id="latest-article-list">
+  <% @node.recent_articles(categories: params[:category], creator_id: ( author.id if author )).each do |article| %>
+    <li class="<%= cycle("first", "second", "third") %>">
+      <%= link_to article.title, node_path(article), :class => "latest-link" %>
+      <time datetime="<%= article.published_at %>" pubdate><%= l article.published_at, :format => :short %></time>
+    </li>
+  <% end %>
+  </ul>
+</div>
+
+<!-- ARCHIVE -->
+<div class="component archive">
+  <h3 class="sup-title">Archive</h3>
+  <ul id="archive-list">
+    <% @node.archive(categories: params[:category], creator_id: ( author.id if author )).each do |year| %>
+      <li>
+        <%= link_for_year_filter(@node, year) %>
+        <% if (params[:year] || Time.now.year).to_i == year.year %>
+          <ul>
+            <% year.months.each_with_index do |count, month| %>
+              <%= link_for_month_filter(@node, year, month, count) %>
+            <% end -%>
+          </ul>
+        <% end -%>
+      </li>
+    <% end -%>
+  </ul>
+</div>

data/app/views/components/_latest_articles.html.erb

@@ -0,0 +1,18 @@
+<% unless component.article_list.nil? %>
+
+<div id="<%= slot_code %>" class="component latest-articles <%= 'double' if expand %> <%= additional_classes %>">
+  <h3 class="sup-title"><%=h component.title %></h3>
+  <ul id="latest-articles">
+    <% for article in component.articles %>
+      <li class="<%= cycle("first", "second", "third") %>">
+        <a href="<%= node_path(article) %>" title="<%= article.title %>">
+          <span class="article-title"><%= article.title %></span>
+        </a>
+        <time datetime="<%= article.published_at %>" pubdate><%= l article.published_at, :format => :short %></time>
+      </li>
+    <% end %>
+  </ul>
+  <%= link_to 'All Articles', "/news", :class => 'more' %>
+</div>
+
+<% end %>

data/app/views/nodes/article.html.erb

@@ -0,0 +1,31 @@
+<div class="main-content">
+  <div class="section-title">
+    <p><%= @node.list.title %></p>
+    <%= articles_rss_feed_link "RSS", :title => "RSS Feed", :class => "rss" %>
+  </div>
+  <h1><%= @node.title %></h1>
+  <div class="article-body">
+    <%= @node.body.html_safe %>
+  </div>
+  <div class="meta">
+    <span class="date"><%= l @node.published_at, :format => :short %></span>
+    <% if @node.creator %>
+
+      <span class="author"><%= link_to(@node.creator.full_name, node_path(@node.list, { :author => @node.creator.permalink })) %></li>
+    <% end %>
+    <span class="cats">
+      <% unless  @node.categories.empty? %>
+        <% for category in @node.categories %>
+          <%= link_to category, node_path(@node, :category => category) %>,
+        <% end %>
+      <% end %>
+    </span>
+  </div>
+  <div class="pagination">
+    <%= link_to_previous_article %>
+    <%= link_to_next_article %>
+  </div>
+</div>
+<div class="supporting-content">
+  <%= render :partial => 'article_sidebar' %>
+</div>

data/app/views/nodes/article_list.html.erb

@@ -0,0 +1,41 @@
+<% content_for :head do %>
+  <%= articles_rss_feed_auto_discovery %>
+<% end %>
+
+<div class="main-content">
+  <div class="section-title">
+    <p><%= @node.title %></p>
+    <%= articles_rss_feed_link "RSS", :title => "RSS Feed", :class => "rss" %>
+  </div>
+    <%= paginated_articles do |articles| %>
+      <ul id="articles">
+        <% for article in articles %>
+          <li class="<%= 'has-image' unless article.asset.nil? %>" >
+           <% unless article.asset.nil? %>
+            <div class="article-image"><%= image_tag( article.asset.url('80x80#', article.asset.web_image_extension), :alt => article.asset.description.to_s ) %></div>
+            <% end %>
+            <div class="article-content">
+              <h2><%= link_to article.title, node_path(article) %></h2>
+              <p><%= truncate(article.description, :length => 140) %></p>
+              <p class="meta">
+                <span class="date"><%= l article.published_at, :format => :short %></span>
+                <% if article.creator %>
+                  <span class="author"><%= link_to(article.creator.full_name, node_path(@node.list, { :author => article.creator.permalink })) %></li>
+                <% end %>
+                <span class="cats">
+                  <% unless  article.categories.empty? %>
+                    <% for category in article.categories %>
+                      <%= link_to category, node_path(@node.list, :category => category) %>,
+                    <% end %>
+                  <% end %>
+                </span>
+              </p>
+            </div>
+          </li>
+        <% end %>
+      </ul>
+    <% end -%>
+</div>
+<div class="supporting-content">
+  <%= render :partial => 'article_sidebar' %>
+</div>