radiant-taggable-extension 2.0.0 → 2.0.1

data/app/models/library_page.rb

@@ -1,60 +1,4 @@
 class LibraryPage < Page
-  include WillPaginate::ViewHelpers
-
-  class RedirectRequired < StandardError
-    def initialize(message = nil); super end
-  end
-
+  include Taggable::FacetedPage
   description %{ Takes tag names in child position or as paramaters so that tagged items can be listed. }
-  
-  attr_accessor :requested_tags, :strict_match
-  
-  def cache?
-    true
-  end
-  
-  def find_by_url(url, live = true, clean = false)
-    url = clean_url(url) if clean
-    my_url = self.url
-    return false unless url =~ /^#{Regexp.quote(my_url)}(.*)/
-    tags = $1.split('/')
-    if slug_child = children.find_by_slug(tags[0])
-      found = slug_child.find_by_url(url, live, clean)
-      return found if found
-    end
-    remove_tags, add_tags = tags.partition{|t| t.first == '-'}
-    add_request_tags(add_tags)
-    remove_request_tags(remove_tags)
-    self
-  end
-  
-  def add_request_tags(tags=[])
-    if tags.any?
-      tags.collect! { |tag| Tag.find_by_title(Rack::Utils::unescape(tag)) }
-      self.requested_tags = (self.requested_tags + tags.select{|t| !t.nil?}).uniq
-    end
-  end
-  
-  def remove_request_tags(tags=[])
-    if tags.any?
-      tags.collect! { |tag|
-        tag.slice!(0) if tag.first == '-' 
-        Tag.find_by_title(Rack::Utils::unescape(tag)) 
-      }
-      self.requested_tags = (self.requested_tags - tags.select{|t| !t.nil?}).uniq
-    end
-  end
-  
-  def requested_tags
-    @requested_tags ||= []
-  end
-  
-  # this isn't very pleasing but it's the best way to let the controller know 
-  # of our real address once tags have been added and removed.
-  
-  def url_with_tags(tags = requested_tags)
-    clean_url( url_without_tags + '/' + tags.uniq.map(&:clean_title).to_param )
-  end
-  alias_method_chain :url, :tags
-  
 end

data/lib/radiant-taggable-extension.rb

@@ -1,5 +1,5 @@
 module RadiantTaggableExtension
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
   SUMMARY = %q{Tagging, clouding and faceting extension for Radiant CMS}
   DESCRIPTION = %q{General purpose tagging and retrieval extension: more versatile but less focused than the tags extension. A good way to support faceted search.}
   URL = "http://spanner.org/radiant/taggable"

data/lib/radius/asset_tags.rb

@@ -26,6 +26,20 @@ module Radius
     tag 'asset:tags:each' do |tag|
       tag.render('tags:each', tag.attr.dup, &tag.block)
     end
+    
+    desc %{
+      Expands if the present asset has any tags.
+    }    
+    tag 'asset:if_tags' do |tag|
+      tag.expand if tag.locals.asset.attached_tags.any?
+    end
+
+    desc %{
+      Expands if the present asset has no tags.
+    }    
+    tag 'asset:unless_tags' do |tag|
+      tag.expand unless tag.locals.asset.attached_tags.any?
+    end
 
     desc %{
       Lists all the assets similar to this asset (based on its tagging), in descending order of relatedness.

data/lib/radius/library_tags.rb

@@ -227,47 +227,78 @@ module Radius
       end
     end
 
-    ############### extra tags:* tags that only make sense on library pages
+    ############### extra tags:* tags that only make sense on library or other faceting pages
 
     desc %{
-      Summarises in a sentence the list of tags currently active, with each one presented as a defaceting link.
-    }    
-    tag 'tags:unlink_list' do |tag| 
-      requested = _get_requested_tags(tag)     
-      if requested.any?
-        requested.map { |t|
-          tag.locals.tag = t
-          tag.render('tag:unlink', tag.attr.dup)
-        }.to_sentence
-      else
-        ""
+      Makes a link that adds the current tag to the active set. Other options are passed through as usual.
+      If the present page is not a library page, or similar, the link will be directed to the first available
+      library page. You can override this behavior by specifying a 'base' parameter, which will force that  
+      path prefix regardless of what page it designates, if any. Remote urls are also possible.
+
+      *Usage:* 
+      <pre><code><r:tag:link base='/library' /></code></pre>
+    }
+    tag 'tag:link' do |tag|
+      options = tag.attr.dup
+      options['class'] ||= 'facet'
+      anchor = options['anchor'] ? "##{options.delete('anchor')}" : ''
+      attributes = options.inject(' ') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
+      text = tag.double? ? tag.expand : tag.render('tag:name')
+      if tag.locals.page.respond_to?(:requested_tags)
+        href = tag.locals.page.path(tag.locals.page.requested_tags + tag.locals.tag)
+      elsif base_path = options.delete('base') 
+        href = clean_path(base_path + '/-' + tag.locals.tag.clean_title)
+      elsif library = LibraryPage.first
+        href = library.path([tag.locals.tag])
+      else 
+        raise TagError "cannot find a LibraryPage to link to."
       end
+      
+      %{<a href="#{href}#{anchor}"#{attributes}>#{text}</a>}
+    end
+
+    desc %{
+      Summarises in a sentence the list of attached, with each one presented as a faceting link.
+    }    
+    tag 'tags:link_list' do |tag| 
+      _get_requested_tags(tag).map { |t|
+        tag.locals.tag = t
+        tag.render('tag:link', tag.attr.dup)
+      }.join(' | ')
     end
 
     desc %{
-      Makes a link that removes the current tag from the active set. Other options as for tag:link.
+      Makes a link that removes the current tag from the active set. Other options as for tag:link. 
+      This only really makes sense in the context of a requested_tags list, since no other tag can be unlinked.
 
       *Usage:* 
-      <pre><code><r:tag:unlink linkto='/library' /></code></pre>
+      <pre><code><r:requested_tags:each><r:tag:unlink base='/library' /></r:requested_tags:each></code></pre>
     }
     tag 'tag:unlink' do |tag|
-      raise TagError, "tag must be defined for tag:unlink tag" unless tag.locals.tag
+      raise TagError "unlinking a tag requires a library page or similar" unless tag.locals.page.respond_to?(:requested_tags)
+
       options = tag.attr.dup
-      options['class'] ||= 'detag'
+      options['class'] ||= 'defacet'
       anchor = options['anchor'] ? "##{options.delete('anchor')}" : ''
-      attributes = options.inject('') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
-      attributes = " #{attributes}" unless attributes.empty?
+      attributes = options.inject(' ') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
       text = tag.double? ? tag.expand : tag.render('tag:name')
+      href = tag.locals.page.path(tag.locals.page.requested_tags - [tag.locals.tag])
+      %{<a href="#{href}#{anchor}"#{attributes}>#{text}</a>}
+    end
 
-      if tag.locals.page.is_a?(LibraryPage)
-        href = tag.locals.page.url(tag.locals.page.requested_tags - [tag.locals.tag])
-      elsif page_url = (options.delete('tagpage') || Radiant::Config['tags.page'])
-        href = clean_url(page_url + '/-' + tag.locals.tag.clean_title)
-      else 
-        href ||= Rack::Utils.escape("-#{tag.locals.tag.title}") + '/'
+    desc %{
+      Summarises in a sentence the list of tags currently active, with each one presented as a defaceting link.
+    }    
+    tag 'tags:unlink_list' do |tag| 
+      requested = _get_requested_tags(tag)     
+      if requested.any?
+        requested.map { |t|
+          tag.locals.tag = t
+          tag.render('tag:unlink', tag.attr.dup)
+        }.to_sentence
+      else
+        ""
       end
-
-      %{<a href="#{href}#{anchor}"#{attributes}>#{text}</a>}
     end
 
   private

data/lib/taggable/faceted_page.rb

@@ -0,0 +1,98 @@
+module Taggable
+  class RedirectRequired < StandardError
+    def initialize(message = nil); super end
+  end
+  
+  module FacetedPage
+    
+    # This module can be mixed into any Page subclass to give it mystical web 2.0 faceting powers.
+    # Any nonexistent child path is assumed to be a tag set, and methods are provided for reading
+    # that set, and adding and removing tags.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval {
+        include InstanceMethods
+        alias_method_chain :path, :tags
+      }
+    end
+    
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      # Faceted pages map nicely onto urls and are cacheable. 
+      # There can be redundancy if tags are specified in varying order,
+      # but the site controller tries to normalize everything.
+      #
+      def cache?
+        true
+      end
+
+      # We override the normal Page#find_by_path mechanism and treat nonexistent child paths
+      # are understood as tag sets. Note that the extended site_controller will add to this set
+      # any tags that have been supplied in query string parameters. This may trigger a redirect
+      # to bring the request path into line with the consolidated tag set.
+      #
+      def find_by_path(path, live = true, clean = false)
+        path = clean_path(path) if clean
+        return false unless path =~ /^#{Regexp.quote(self.path)}(.*)/
+        tags = $1.split('/')
+        if slug_child = children.find_by_slug(tags[0])
+          found = slug_child.find_by_url(path, live, clean)
+          return found if found
+        end
+        remove_tags, add_tags = tags.partition{|t| t.first == '-'}
+        add_request_tags(add_tags)
+        remove_request_tags(remove_tags)
+        self
+      end
+      alias_method :find_by_url, :find_by_path
+
+      # The set of tags attached to the page request.
+      #
+      def requested_tags
+        @requested_tags ||= []
+      end
+
+      # The normal `path` method is extended to append the (sorted and deduped) tags attached to the page request
+      #
+      def path_with_tags(tags = requested_tags)
+        clean_path( path_without_tags + '/' + tags.uniq.sort.map(&:clean_title).to_param )
+      end
+
+    private
+  
+      # @requested_tags is the set of Tag objects attached to the page request.
+      #
+      def requested_tags=(tags)
+        @requested_tags = tags
+      end
+
+      # We hold in memory a list of the tags that were appended to the path when this page was selected.
+      # This method adds tags to that list. It is normally called only once, to populate the list.
+      #
+      def add_request_tags(tags=[])
+        if tags.any?
+          tags.collect! { |tag| Tag.find_by_title(Rack::Utils::unescape(tag)) }
+          self.requested_tags = (self.requested_tags + tags.select{|t| !t.nil?}).uniq
+        end
+      end
+
+      # This method removes tags from the appended list. Normally only used to handle defaceting links
+      # (in the form /path/to/page/tag1/tag2/tag3/-tag2).
+      #
+      def remove_request_tags(tags=[])
+        if tags.any?
+          tags.collect! { |tag|
+            tag.slice!(0) if tag.first == '-' 
+            Tag.find_by_title(Rack::Utils::unescape(tag)) 
+          }
+          self.requested_tags = (self.requested_tags - tags.compact).uniq
+        end
+      end
+    end
+
+  end
+end

data/lib/taggable/model.rb

@@ -1,5 +1,5 @@
 module Taggable
-  module Model      # for inclusion into ActiveRecord::Base
+  module Model
   
     def self.included(base)
       base.extend ClassMethods

data/lib/taggable/page.rb

@@ -1,5 +1,5 @@
 module Taggable
-  module Page      # for inclusion into Page
+  module Page
 
     # here we have a few special cases for page tags.
     # because of the page tree

data/lib/taggable/site_controller.rb

@@ -5,26 +5,37 @@ module Taggable
   
       base.class_eval {
 
-        def find_page_with_tags(url)
-          url = clean_url(url)
-          page = find_page_without_tags(url)
-          return page unless page.is_a?(LibraryPage)
-          page.add_request_tags(Tag.in_this_list(params[:tag])) if params[:tag]      
-          raise LibraryPage::RedirectRequired, page.url unless page.url == url     # to handle removal of tags and ensure consistent addressing. should also allow cache hit.
+        # We override find_page to handle the combination of url tags and parameter tags.
+        # If this results in a change to the compound path for this page/tag combination, 
+        # we raise a RedirectRequired error.
+        #
+        def find_page_with_tags(path)
+          path = clean_path(path)
+          page = find_page_without_tags(path)
+          if page.respond_to?(:requested_tags)
+            page.add_request_tags(Tag.in_this_list(params[:tag])) if params[:tag]      
+            raise Taggable::RedirectRequired, page.path unless page.path == path
+          end
           page
         end
         alias_method_chain :find_page, :tags
 
+        # Extends show_page to catch any redirect error raised by find_page, and redirect to the specified path.
+        # The effect of this is to standardise all tag-appended requests, which improves cache performance and
+        # allows us to defacet by adding -tag parameters.
+        #
+        # (I can't remember why that was necessary: it may no longer be, so don't rely on it!).
+        #
         def show_page_with_tags
           show_page_without_tags
-        rescue LibraryPage::RedirectRequired => e
+        rescue Taggable::RedirectRequired => e
           redirect_to e.message
         end
         alias_method_chain :show_page, :tags
     
       protected
-        def clean_url(url)
-          "/#{ url.strip }/".gsub(%r{//+}, '/')
+        def clean_path(path)
+          "/#{ path.strip }/".gsub(%r{//+}, '/')
         end
     
       }

data/spec/controllers/site_controller_spec.rb

@@ -70,21 +70,27 @@ describe SiteController do
     end
     
     describe "with tags requested" do
-      it "should add a default Cache-Control header with public and max-age of 5 minutes" do
+      it "should redirect to a normalised form of the requested address" do
         get :show_page, :url => '/library/green/furiously'
+        response.should be_redirect
+        response.should redirect_to 'http://test.host/library/furiously/green'
+      end
+
+      it "should add a default Cache-Control header with public and max-age of 5 minutes" do
+        get :show_page, :url => '/library/furiously/green'
         response.headers['Cache-Control'].should =~ /public/
         response.headers['Cache-Control'].should =~ /max-age=300/
       end
 
       it "should pass along the etag set by the page" do
-        get :show_page, :url => '/library/green/furiously'
+        get :show_page, :url => '/library/furiously/green'
         response.headers['ETag'].should be
       end
 
       it "should return a not-modified response when the sent etag matches" do
         response.stub!(:etag).and_return("foobar")
         request.if_none_match = 'foobar'
-        get :show_page, :url => '/library/green/furiously'
+        get :show_page, :url => '/library/furiously/green'
         response.response_code.should == 304
         response.body.should be_blank
       end

data/spec/models/library_page_spec.rb

@@ -11,12 +11,14 @@ describe LibraryPage do
   describe "on request" do
     describe "with one tag" do
       before do
-        @page = Page.find_by_url('/library/colourless')
+        @page = Page.find_by_path('/library/colourless')
       end
   
-      it "should interrupt find_by_url" do
+      it "should interrupt find_by_path" do
+        @page.should_not be_nil
         @page.should == pages(:library)
         @page.is_a?(LibraryPage).should be_true
+        @page.respond_to?(:requested_tags).should be_true
       end
 
       it "should set tag context correctly" do
@@ -26,18 +28,20 @@ describe LibraryPage do
     
     describe "with several tags" do
       before do
-        @page = Page.find_by_url('/library/colourless/green/ideas')
+        @page = Page.find_by_path('/library/colourless/green/ideas')
       end
       it "should set tag context correctly" do
+        @page.should_not be_nil
         @page.requested_tags.should == [tags(:colourless), tags(:green), tags(:ideas)]
       end
     end
     
     describe "with several tags and one tag negation" do
       before do
-        @page = Page.find_by_url('/library/colourless/green/ideas/-green')
+        @page = Page.find_by_path('/library/colourless/green/ideas/-green')
       end
       it "should set tag context correctly" do
+        @page.should_not be_nil
         @page.requested_tags.should == [tags(:colourless), tags(:ideas)]
       end
     end

data/taggable_extension.rb

@@ -13,7 +13,7 @@ class TaggableExtension < Radiant::Extension
     Asset.send :include, Taggable::Asset                                  # assets are taggable (and a fake keywords column is provided)
     Page.send :include, Radius::TaggableTags                              # adds the basic radius tags for showing page tags and tag pages
     Page.send :include, Radius::AssetTags                                 # adds some asset:* tags
-    LibraryPage.send :include, Radius::LibraryTags                        #
+    Page.send :include, Radius::LibraryTags
     SiteController.send :include, Taggable::SiteController                # some path and parameter handling in support of library pages
     Admin::PagesController.send :include, Taggable::AdminPagesController  # tweaks the admin interface to make page tags more prominent
     UserActionObserver.instance.send :add_observer!, Tag                  # tags get creator-stamped

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: radiant-taggable-extension
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 0
-  - 0
-  version: 2.0.0
+  - 1
+  version: 2.0.1
 platform: ruby
 authors: 
 - William Ross
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-06 00:00:00 +01:00
-default_executable: 
+date: 2011-10-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sanitize
@@ -76,6 +75,7 @@ files:
 - lib/taggable/admin_pages_controller.rb
 - lib/taggable/admin_ui.rb
 - lib/taggable/asset.rb
+- lib/taggable/faceted_page.rb
 - lib/taggable/model.rb
 - lib/taggable/page.rb
 - lib/taggable/site_controller.rb
@@ -100,11 +100,10 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - taggable_extension.rb
-has_rdoc: true
 homepage: http://spanner.org/radiant/taggable
 licenses: []
 
-post_install_message: "\n  Add this to your Gemfile with:\n\n    gem 'radiant-taggable-extension', '~> 2.0.0'\n\n  "
+post_install_message: "\n  Add this to your Gemfile with:\n\n    gem 'radiant-taggable-extension', '~> 2.0.1'\n\n  "
 rdoc_options: []
 
 require_paths: 
@@ -130,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Tagging, clouding and faceting extension for Radiant CMS