radiant-library-extension 2.0.0

data/lib/library/library_tags.rb

@@ -0,0 +1,276 @@
+module Library
+  module LibraryTags
+    include Radiant::Taggable
+  
+    class TagError < StandardError; end
+
+    ############### tags for use on library pages
+                  # usually to build a faceted browser
+
+    tag "library" do |tag|
+      raise TagError, "library:* tags can only be used on a LibraryPage" unless tag.locals.page && tag.locals.page.is_a?(LibraryPage)
+      tag.expand
+    end
+
+    desc %{
+      Displays a list of the tags that can be used to narrow the set of results displayed. This begins as a list of 
+      all available tags, and as they are chosen it shrinks to show only the coincident tags that will further reduce the set.
+      
+      This is normally used to display a list or cloud of facets that can be added to a search. The default is to show a cloud.
+      
+      <pre><code>
+        <r:library:tags:each><li><r:tag:link /></li></r:library:tags:each>
+        <r:library:tags:list />
+        <r:library:tags:cloud />
+        <r:library:tags />
+      </code></pre>
+
+      To show only those tags attached to a particular kind of object, supply a 'for' parameter. 
+      The parameter can be 'pages', 'assets' or the plural of any asset type. If you're displaying an image gallery,
+      you may want to start with a cloud of all the tags that have been applied to images:
+      
+      <pre><code>
+        <r:library:tags for="images" />
+      </code></pre>
+      
+      You can still display pages associated with those tags, but the list will not include tags that only have pages.
+    }
+    tag "library:tags" do |tag|
+      tag.locals.tags = _get_coincident_tags(tag)
+      if tag.double?
+        tag.expand
+      else
+        tag.render('tags:cloud', tag.attr.dup)
+      end
+    end
+    tag "library:tags:each" do |tag|
+      tag.render('tags:each', tag.attr.dup, &tag.block)
+    end
+    tag "library:tags:list" do |tag|
+      tag.render('tags:list', tag.attr.dup)
+    end
+    tag "library:tags:cloud" do |tag|
+      tag.render('tags:cloud', tag.attr.dup)
+    end
+    
+    
+    desc %{
+      Expands if there are is more than one tag to show. 
+      (If there is only one tag coincident with the present set then it offers no reduction).
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:if_tags>
+          Displaying items tagged with all of <r:requested_tags />
+        <r:library:if_requested_tags>
+      </code></pre>
+    }
+    tag "library:unless_tags" do |tag|
+      tag.locals.tags = _get_coincident_tags(tag)
+      tag.expand if tag.locals.tags.length > 1
+    end
+    desc %{
+      Expands if there are is more than one tag to show. 
+      (If there is only one tag coincident with the present set then it offers no reduction, so we don't show it).
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:if_tags><r:library:tags /></r:library:if_tags>
+      </code></pre>
+    }
+    tag "library:if_tags" do |tag|
+      tag.locals.tags = _get_coincident_tags(tag)
+      tag.expand if tag.locals.tags.length > 1
+    end
+    
+    desc %{
+      Expands if there are is one or no coincident tags to show. 
+    }
+    tag "library:unless_tags" do |tag|
+      tag.expand unless _get_coincident_tags(tag).length > 1
+    end
+    
+    desc %{
+      Displays a list of the tags requested by the user.
+      To offer links that remove the tag from the current set, these will both work:
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:requested_tags:each><li><r:tag:unlink /></li></r:library:requested_tags:each>
+        <r:library:requested_tags />
+      </code></pre>
+    }
+    tag "library:requested_tags" do |tag|
+      tag.locals.tags = _get_requested_tags(tag)
+      if tag.double?
+        tag.expand
+      else
+        tag.render('tags:unlink_list', tag.attr.dup)
+      end
+    end
+    tag "library:requested_tags:each" do |tag|
+      tag.render('tags:each', tag.attr.dup, &tag.block)
+    end
+
+    desc %{
+      Expands if any tags have been specified:
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:if_requested_tags>
+          Displaying items tagged with all of <r:requested_tags />
+        <r:library:if_requested_tags>
+      </code></pre>
+    }
+    tag "library:if_requested_tags" do |tag|
+      tag.locals.tags = _get_requested_tags(tag)
+      tag.expand if tag.locals.tags.any?
+    end
+    
+    desc %{
+      Expands if no tags have been specified:
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:unless_requested_tags>
+          Showing everything. Choose a tag to start narrowing down the list.
+        <r:library:unless_requested_tags>
+      </code></pre>
+    }
+    tag "library:unless_requested_tags" do |tag|
+      tag.expand unless _get_requested_tags(tag).any?
+    end
+
+    desc %{
+      Displays a list of the pages associated with the current tag set. If no tags are specified, this will show all pages.
+      You can use all the usual r:page tags within the list.
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:pages:each><li><r:link /><br /><r:content part="description" /></li></r:library:pages:each>
+      </code></pre>
+    }
+    tag "library:pages" do |tag|
+      tag.locals.pages = _get_pages(tag)
+      tag.expand
+    end
+    tag "library:pages:each" do |tag|
+      tag.render('page_list', tag.attr.dup, &tag.block)       # r:page_list is defined in taggable
+    end
+
+    desc %{
+      Expands if there are any pages associated with all of the current tag set.
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:if_pages><h2>Pages</h2>...</r:library:if_pages>
+      </code></pre>
+    }
+    tag "library:if_pages" do |tag|
+      tag.expand if _get_pages(tag).any?
+    end
+
+    desc %{
+      Displays a list of the assets associated with the current tag set. If no tags are specified, this will show all assets.
+      You can use all the usual r:assets tags within the list.
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:assets:each><li><r:assets:thumbnail /></li></r:library:assets:each>
+      </code></pre>
+    }
+    tag "library:assets" do |tag|
+      tag.locals.assets = _get_assets(tag)
+      tag.expand
+    end
+    tag "library:assets:each" do |tag|
+      tag.render('asset_list', tag.attr.dup, &tag.block)
+    end
+
+    desc %{
+      Expands if there are any assets associated with all of the current tag set.
+      
+      *Usage:* 
+      <pre><code>
+        <r:library:if_assets><h2>Assets</h2>...</r:library:if_assets>
+      </code></pre>
+    }
+    tag "library:if_assets" do |tag|
+      tag.expand if _get_assets(tag).any?
+    end
+
+    Asset.known_types.each do |type|
+      these = type.to_s.pluralize
+      
+      desc %{
+        Displays a list of the all the #{these} associated with the current tag set. If no tags are specified, this will show all such assets.
+        You can use all the usual r:assets tags within the list.
+
+        *Usage:* 
+        <pre><code>
+          <r:library:#{these}:each><li><r:assets:link /></li></r:library:#{these}:each>
+        </code></pre>
+      }
+      tag "library:#{these}" do |tag|
+        tag.locals.assets = _get_assets(tag).send(these.intern)
+        tag.expand
+      end
+      tag "library:#{these}:each" do |tag|
+        tag.render('asset_list', tag.attr.dup, &tag.block)
+      end
+
+      desc %{
+        Expands if there are any #{these} associated with all of the current tag set.
+
+        *Usage:* 
+        <pre><code>
+          <r:library:if_#{these}><h2>#{these.titlecase}</h2>...</r:library:if_#{these}>
+        </code></pre>
+      }
+      tag "library:if_#{these}" do |tag|
+        tag.locals.assets = _get_assets(tag).send(these.intern)
+        tag.expand if tag.locals.assets.any?
+      end
+
+      private
+
+        def _get_requested_tags(tag)
+          tag.locals.page.requested_tags
+        end
+
+        def _get_coincident_tags(tag)
+          requested = _get_requested_tags(tag)
+          limit = tag.attr['limit'] || 50
+          if requested.any?
+            Tag.coincident_with(requested)
+          else
+            Tag.most_popular(limit)
+          end
+        end
+      end
+
+      # in the absence of any requested tags we default to all, not none
+
+      def _get_pages(tag)
+        requested = _get_requested_tags(tag)
+        if requested.any?
+          Page.tagged_with(requested)
+        else
+          Page.scoped({})   # there must be a better way to return a new scope
+        end
+      end
+
+      def _get_assets(tag)
+        requested = _get_requested_tags(tag)
+        if requested.any?
+          Asset.tagged_with(requested)
+        else
+          Asset.scoped({})
+        end
+      end
+
+    end
+
+end
+
+

data/lib/library/link_renderer.rb

@@ -0,0 +1,22 @@
+# This handy simplification is adapted from SphinxSearch (thanks)
+# and originally came from Ultrasphinx
+# it saves us a lot of including and bodging to make will_paginate's template calls work in the Page model
+
+module Library
+  class LinkRenderer < WillPaginate::LinkRenderer
+    def initialize(tag)
+      @tag = tag
+    end
+  
+    def page_link(page, text, attributes = {})
+      linkclass = %{ class="#{attributes[:class]}"} if attributes[:class]
+      linkrel = %{ rel="#{attributes[:rel]}"} if attributes[:rel]
+      %Q{<a href="#{@tag.locals.page.url}?page=#{page}"#{linkrel}#{linkclass}>#{text}</a>}
+    end
+
+    def page_span(page, text, attributes = {})
+      spanclass = attributes[:class]
+      %{<span class="#{attributes[:class]}">#{text}</span>}
+    end
+  end
+end

data/lib/library/more_asset_tags.rb

@@ -0,0 +1,151 @@
+module Library
+  module MoreAssetTags
+    include Radiant::Taggable
+  
+    class TagError < StandardError; end
+
+    ############### assets: tags for displaying tags and relatives when we have an asset
+                  # similar tags already exist for pages
+  
+    desc %{
+      Cycles through all tags attached to present asset.
+    
+      *Usage:* 
+      <pre><code><r:assets:tags><r:tag:title /></r:assets:tags></code></pre>
+    }    
+    tag 'assets:tags' do |tag|
+      raise TagError, "asset must be defined for asset:tags tag" unless tag.locals.asset
+      tag.locals.tags = tag.locals.asset.tags
+      tag.expand
+    end
+    tag 'assets:tags:each' do |tag|
+      tag.render('tags:each', tag.attr.dup, &tag.block)
+    end
+
+    desc %{
+      Lists all the assets similar to this asset (based on its tagging), in descending order of relatedness.
+    
+      *Usage:* 
+      <pre><code><r:related_assets:each>...</r:related_assets:each></code></pre>
+    }
+    tag 'related_assets' do |tag|
+      raise TagError, "asset must be defined for related_assets tag" unless tag.locals.asset
+      tag.locals.assets = tag.locals.asset.related_assets
+      tag.expand
+    end
+    tag 'related_assets:each' do |tag|
+      tag.render('assets:each', tag.attr.dup, &tag.block)
+    end
+
+    ############### extra asset fields
+
+    [:copyright].each do |method|
+      desc %{
+        Expands if the asset has a #{method} notice.
+        The 'title' attribute is required on this tag or the parent tag.
+      }
+      tag "assets:if_#{method.to_s}" do |tag|
+        options = tag.attr.dup
+        asset = find_asset(tag, options)
+        tag.expand if asset.respond_to?(method) && asset.send(method)
+      end
+      
+      desc %{
+        Expands unless the asset has a #{method} notice.
+        The 'title' attribute is required on this tag or the parent tag.
+      }
+      tag "assets:unless_#{method.to_s}" do |tag|
+        options = tag.attr.dup
+        asset = find_asset(tag, options)
+        tag.expand unless asset.respond_to?(method) && asset.send(method)
+      end
+
+      desc %{
+        Renders the `#{method.to_s}' attribute of the asset.
+        The 'title' attribute is required on this tag or the parent tag.
+      }
+      tag "assets:#{method.to_s}" do |tag|
+        options = tag.attr.dup
+        asset = find_asset(tag, options)
+        asset.send(method) rescue nil
+      end
+    end
+
+    ############### useful shorthands
+
+    desc %{
+      Renders an illustration block for the asset, with image and caption.
+
+      *Usage:* 
+      <pre><code><r:assets:image [title="asset_title"] [size="icon|thumbnail"]></code></pre>
+    }    
+    tag "assets:illustration" do |tag|
+      options = tag.attr.dup
+      options['size'] ||= 'illustration'
+      tag.locals.asset = find_asset(tag, options)
+      if tag.locals.asset.image?
+        result = %{<div class="illustration">}
+        result << tag.render('assets:image', options)
+        result << %{<p class="caption">#{tag.render('assets:caption', options)}</p>}
+        result << "</div>"
+        result
+      end
+    end
+    
+    desc %{ 
+      Presents a standard marginal gallery block suitable for turning unobtrusively into a rollover or lightbox gallery. 
+      We need to be able to work out a collection of assets: that can be defined already (eg by assets:all) or come from the current page.
+      Default preview size is 'large' and thumbnail size 'thumbnail' but you can specify any of your asset sizes.
+
+      *Usage:*
+      <pre><code>
+        <r:assets:images>
+          <r:assets:minigallery [size="..."] [thumbnail_size="..."] [tags="one,or,more,tags"] />
+        </r:assets:images>
+      </code></pre>
+
+    }
+    tag 'assets:minigallery' do |tag|
+      options = tag.attr.dup.symbolize_keys
+      raise TagError, "asset collection must be available for assets:minigallery tag" unless tag.locals.assets or tag.locals.page or tag.attr[:tags]
+      if options[:tags] && tags = Tag.from_list(options[:tags])
+        tag.locals.assets = Asset.images.from_all_tags(tags)
+      else
+        tag.locals.assets = tag.locals.page.assets
+      end
+      tag.locals.assets.images.to_a     # because we can't let empty? trigger a call to count
+
+      unless tag.locals.assets.empty?
+        size = tag.attr['size'] || 'illustration'
+        thumbsize = tag.attr['thumbnail_size'] || 'icon'
+        result = ""
+        result << %{
+  <div class="minigallery">}
+        tag.locals.asset = tag.locals.assets.first
+        result << tag.render('assets:image', {'size' => size})
+        result << %{
+    <p class="caption">#{tag.render('assets:caption')}</p>
+    <ul class="thumbnails">}
+        if tag.locals.assets.size > 1
+          tag.locals.assets.each do |asset|
+            tag.locals.asset = asset
+            result << %{
+      <li class="thumbnail">
+        <a href="#{tag.render('assets:url', 'size' => 'illustration')}" title="#{asset.caption}" id="thumbnail_#{asset.id}">
+          }
+            result << tag.render('assets:image', {'size' => thumbsize, 'alt' => asset.title})
+            result << %{
+        </a>
+      </li>}
+          end
+        end
+        result << %{
+    </ul>
+  </div>}
+        result
+      end
+    end
+
+  end
+end
+