radiant-taggable-extension 1.2.0

data/lib/taggable_tags.rb

@@ -0,0 +1,456 @@
+module TaggableTags
+  include Radiant::Taggable
+  
+  class TagError < StandardError; end
+
+  # tag sets.
+
+  desc %{
+    The root 'tags' is not usually called directly. 
+    All it does is default to the list of page tags.
+    Most tags:* methods are called indirectly: eg 'requested_tags:list'
+    will set context to the requested tags and then render tags:list.
+    In that case we just oblige by expanding.
+  }
+  tag 'tags' do |tag|
+    tags ||= _get_tags(tag);
+    tag.expand
+  end
+  
+  desc %{
+    Contents are rendered only if a set of tags is available.
+    
+    *Usage:* 
+    <pre><code><r:if_tags>...</r:if_tags></code></pre>
+  }    
+  tag 'if_tags' do |tag|
+    tag.expand if tag.locals.tags && tag.locals.tags.any?
+  end
+  
+  desc %{
+    Contents are rendered only if no set of tags is available.
+    
+    *Usage:* 
+    <pre><code><r:unless_tags>...</r:unless_tags></code></pre>
+  }    
+  tag 'unless_tags' do |tag|
+    tag.expand unless tag.locals.tags && tag.locals.tags.any?
+  end
+  
+  ################# list-display tags: take a set and display it somehow. Because they're in the tags: namespace they default to tag.locals.page.tags.
+
+  desc %{
+    Summarises in a sentence the list of tags currently active.
+
+    *Usage:* 
+    <pre><code>Pages tagged with <r:tags:summary />:</code></pre>
+    
+    And the output would be "Pages tagged with tag1, tag2 and tag3:".
+  }    
+  tag 'tags:summary' do |tag|
+    if tag.locals.tags && tag.locals.tags.any?
+      options = tag.attr.dup
+      tag.locals.tags.map { |t|
+        tag.locals.tag = t
+        tag.render('tag:title', options)
+      }.to_sentence
+    else
+      "no tags"
+    end
+  end
+
+  desc %{
+    Cycles through all tags in context. You can also specify a set of tags, which is occasionally 
+    a useful shortcut for building a topic list.
+
+    *Usage:* 
+    <pre><code><r:tags:each tags="foo, bar">...</r:tags:each></code></pre>
+  }    
+  tag 'tags:each' do |tag|
+    result = []
+    tag.locals.tags.each do |item|
+      tag.locals.tag = item
+      result << tag.expand
+    end 
+    result
+  end
+
+
+  # These are never called directly: but are separated here to dry out the tag handling
+  # see r:tag_cloud, or in the library extension, compound forms like r:coincident_tags:tag_cloud and r:requested_tags:list
+  # same goes for r:tags:summary but that's occasionally useful on a page too.
+  
+  tag 'tags:cloud' do |tag|
+    if tag.locals.tags && tag.locals.tags.length > 1
+      options = tag.attr.dup
+      tag.locals.tags = Tag.for_cloud(tag.locals.tags).sort_by{|t| t.title.downcase}                          # nb. for_cloud immediately returns list if already sized
+      result = []
+      result << %{<div class="cloud">}
+      tag.locals.tags.each do |t|
+        tag.locals.tag = t
+        result << tag.render("tag:link", options.merge('style' => "font-size: #{t.cloud_size.to_f * 2.5}em;"))
+      end 
+      result << "</div>"
+      result.join(" ")
+    else
+      "No tags"
+    end
+  end
+  
+  tag 'tags:list' do |tag|
+    if tag.locals.tags && tag.locals.tags.any?
+      options = tag.attr.dup
+      show_checkboxes = (options.delete('checklist') == 'true')
+      listclass = options.delete('listclass') || 'taglist'
+      result = %{<ul class="#{listclass}">}
+      tag.locals.tags.each do |t|
+        tag.locals.tag = t
+        result << %{<li>#{tag.render('tag:link', options)}</li>}
+      end 
+      result << "</ul>"
+      result
+    else
+      "No tags"
+    end
+  end
+
+
+
+  ################# page-candy: these are high level tags that bring in a whole block of stuff. 
+                  # most can be built out of the smaller tags if you need them to work differently
+
+  desc %{
+    Returns a tag-cloud showing all the tags attached to this page and its descendants, 
+    with cloud band css classes determined by popularity *within the group*. This is intended as a way to
+    show what subjects are relevant here, as in the original delicio.us tag clouds. You can achieve similar 
+    results with tags like r:all_tags:cloud, but with important differences:
+    
+    * here prominence depends on popularity within the retrieved set of tags (not overall)
+    * here we climb down the page tree to build the set of tags: useful for eg. a section front page.
+    
+    *Usage:* 
+    <pre><code><r:tag_cloud /></code></pre>
+    
+    You can supply a url parameter to work from a page other than the present one. 
+    
+    <pre><code><r:tag_cloud url="/elsewhere" /></code></pre>
+
+    So if you want to show all the tags attached to any page (but ignore their attachment to anything else):
+    
+    <pre><code><r:tag_cloud url="/" /></code></pre>
+        
+    As usual you can limit the size of the cloud (the most popular will be shown) and set the destination of tag links:
+    
+    <pre><code><r:tag_cloud limit="200" linkto="/archive" /></code></pre>
+  }    
+  tag 'tag_cloud' do |tag|
+    options = tag.attr.dup
+    limit = options.delete('limit')
+    if url = options.delete('url')
+      found = Page.find_by_url(absolute_path_for(tag.locals.page.url, url))
+      raise TagError, "no page at url #{url}" unless page_found?(found)
+      tag.locals.page = found
+    end
+    raise TagError, "no page for tag_cloud" unless tag.locals.page
+    tag.locals.tags = tag.locals.page.tags_for_cloud(limit)   # page.tags_for_cloud does a lot of inheritance work
+    tag.render('tags:cloud', options)
+  end
+
+  desc %{
+    Returns a list of tags showing all the tags attached to this page and its descendants. It's essentially the same
+    as the tag cloud without the band formatting, but accepts the same options as tags:list.
+    
+    *Usage:* 
+    <pre><code><r:tag_list /></code></pre>
+    
+    As usual you can limit the size of the list (the most popular will be shown) and set the destination of tag links:
+    
+    <pre><code><r:tag_list limit="200" linkto="/archive" /></code></pre>    
+  }    
+  tag 'tag_list' do |tag|
+    options = tag.attr.dup
+    limit = options.delete('limit')
+    if url = options.delete('url')
+      found = Page.find_by_url(absolute_path_for(tag.locals.page.url, url))
+      raise TagError, "no page at url #{url}" unless page_found?(found)
+      tag.locals.page = found
+    end
+    raise TagError, "no page for tag_list" unless tag.locals.page
+    tag.locals.tags = tag.locals.page.tags_for_cloud(limit)   # page.tags_for_cloud does a lot of inheritance work
+    tag.render('tags:list', options)
+  end
+  
+  
+  
+  ################# tagged pages. Other extensions define similar tags for eg tagged assets.
+  
+  # general purpose pages lister
+  
+  desc %{
+    This is a general purpose page lister. It wouldn't normally be accessed directly but a lot of other tags make use of it.
+  }
+  tag 'page_list' do |tag|
+    raise TagError, "no pages for page_list" unless tag.locals.pages
+    result = []
+    tag.locals.pages.each do |page|
+      tag.locals.page = page
+      result << tag.expand
+    end 
+    result
+  end
+  
+  desc %{
+    Lists all the pages associated with a set of tags, in descending order of relatedness.
+    
+    *Usage:* 
+    <pre><code><r:tags:pages:each>...</r:tags:pages:each></code></pre>
+  }
+  tag 'tags:pages' do |tag|
+    tag.locals.pages = Page.from_tags(tag.locals.tags)
+    tag.expand
+  end
+  tag 'tags:pages:each' do |tag|
+    tag.render('pages:each', tag.attr.dup, &tag.block)
+  end
+  
+  desc %{
+    Renders the contained elements only if there are any pages associated with the current set of tags.
+
+    *Usage:* 
+    <pre><code><r:tags:if_pages>...</r:tags:if_pages></code></pre>
+  }
+  tag "tags:if_pages" do |tag|
+    tag.locals.pages = Page.from_tags(tag.locals.tags)
+    tag.expand if tag.locals.pages.to_a.any?
+  end
+
+  desc %{
+    Renders the contained elements only if there are no pages associated with the current set of tags.
+
+    *Usage:* 
+    <pre><code><r:tags:unless_pages>...</r:tags:unless_pages></code></pre>
+  }
+  tag "tags:unless_pages" do |tag|
+    tag.locals.pages = Page.from_tags(tag.locals.tags)
+    tag.expand unless tag.locals.pages.to_a.any?
+  end
+  
+  # just a shortcut, but a useful one
+  
+  desc %{
+    Lists all the pages similar to this page (based on its tagging), in descending order of relatedness.
+    
+    *Usage:* 
+    <pre><code><r:related_pages:each>...</r:related_pages:each></code></pre>
+  }
+  tag 'related_pages' do |tag|
+    raise TagError, "page must be defined for related_pages tag" unless tag.locals.page
+    tag.locals.pages = tag.locals.page.related_pages
+    tag.expand
+  end
+  tag 'related_pages:each' do |tag|
+    tag.render('pages:each', tag.attr.dup, &tag.block)
+  end
+  
+  
+  desc %{
+    Shows a link to the target page with a (non-linked) breadcrumb trail to give it context.
+    This is the opposite of r:breadcrumbs, which shows a linked trail but doesn't link the current page.
+    Link and breadcrumb attributes should work in the usual way, and by default we omit the home page
+    from the list since it adds no information. pass omit_root='false' to show the whole chain.
+    
+    *Usage:* 
+    <pre><code><r:tag:pages:each>
+      <r:crumbed_link [omit_root="false"] [separator=" &rarr; "] />
+      <r:crumbed_link>Link text</r:crumbed_link>
+      etc
+    </r:tag:pages:each></code></pre>
+  }    
+  tag 'crumbed_link' do |tag|
+    page = tag.locals.page
+    ancestors = page.ancestors
+    ancestors.pop unless tag.attr['omit_root'] == 'false'
+    breadcrumbs = [tag.render('link')]
+    ancestors.each do |ancestor|
+      tag.locals.page = ancestor
+      breadcrumbs.unshift tag.render('breadcrumb')
+    end
+    separator = tag.attr['separator'] || ' &gt; '
+    breadcrumbs.join(separator)
+  end
+
+
+
+  ################# single tag expansion for simple lists of tagged items or for customised display of each item in a list or cloud context
+
+  desc %{
+    This is the namespace for referencing a single tag. It's not usually called directly, 
+    but you can supply a 'title' or 'id' attribute.
+    
+    *Usage:* 
+    <pre><code><r:tag [title="tag_title"]>...</r:tag></code></pre>
+  }    
+  tag 'tag' do |tag|    
+    tag.locals.tag ||= _get_tag(tag, tag.attr.dup)
+    tag.expand
+  end
+
+  desc %{
+    Contents are rendered if a tag is currently defined. Useful on a LibraryPage page where you may or
+    may not have received a tag parameter.
+    
+    *Usage:* 
+    <pre><code><r:if_tag>...</r:if_tag></code></pre>
+  }    
+  tag 'if_tag' do |tag|
+    tag.locals.tag ||= _get_tag(tag, tag.attr.dup)
+    tag.expand if tag.locals.tag
+  end
+  
+  desc %{
+    Contents are rendered if no tag is currently defined. Useful on a LibraryPage page where you may or
+    may not have a tag parameter.
+    
+    *Usage:* 
+    <pre><code><r:unless_tag>...</r:unless_tag></code></pre>
+  }    
+  tag 'unless_tag' do |tag|
+    tag.locals.tag ||= _get_tag(tag, tag.attr.dup)
+    tag.expand unless tag.locals.tag
+  end
+  
+  desc %{
+    Shows name of current tag.
+    
+    *Usage:* 
+    <pre><code><r:tag:name /></code></pre>
+  }    
+  tag 'tag:name' do |tag|    
+    raise TagError, "tag must be defined for tag:title tag" unless tag.locals.tag
+    tag.locals.tag.title
+  end
+
+  desc %{
+    Makes a link to the current tag. If the current page is a library page, we amend the 
+    list of requested tags. Otherwise, the 'linkto' parameter can be the address of a 
+    LibraryPage, or you can specify a global tags page with a 'library.path' config entry.
+    
+    If no destination is specified we return a relative link to the escaped name of the tag.
+    
+    *Usage:* 
+    <pre><code><r:tag:link linkto='/library' /></code></pre>
+  }
+  tag 'tag:link' do |tag|
+    raise TagError, "tag must be defined for tag:link tag" unless tag.locals.tag
+    options = tag.attr.dup
+    anchor = options['anchor'] ? "##{options.delete('anchor')}" : ''
+    attributes = options.inject('') { |s, (k, v)| s << %{#{k.downcase}="#{v}" } }.strip
+    attributes = " #{attributes}" unless attributes.empty?
+    text = tag.double? ? tag.expand : tag.render('tag:name')
+    if tag.locals.page.is_a? LibraryPage
+      tagset = tag.locals.page.requested_tags + [tag.locals.tag]
+      destination = tag.locals.page.url(tagset)
+    elsif page_url = (options.delete('linkto') || Radiant::Config['library.path'])
+      destination = clean_url(page_url + '/' + tag.locals.tag.clean_title)
+    else
+      # note that this only works if you're at a url with a trailing slash...
+      destination = Rack::Utils.escape("#{tag.locals.tag.title}") + '/'
+    end
+    %{<a href="#{destination}#{anchor}"#{attributes}>#{text}</a>}
+  end
+
+  desc %{
+    Shows description of current tag.
+    
+    *Usage:* 
+    <pre><code><r:tag:description /></code></pre>
+  }    
+  tag 'tag:description' do |tag|    
+    raise TagError, "tag must be defined for tag:description tag" unless tag.locals.tag
+    tag.locals.tag.description
+  end
+
+  desc %{
+    Shows use_count of current tag (which will normally only be set if we're within a tag_cloud tag)
+    
+    *Usage:* 
+    <pre><code><r:tag:use_count /></code></pre>
+  }    
+  tag 'tag:use_count' do |tag|
+    raise TagError, "tag must be defined for tag:use_count tag" unless tag.locals.tag
+    tag.locals.tag.use_count
+  end
+
+  desc %{
+    Contents are rendered if the current tag has been applied to any pages.
+    
+    *Usage:* 
+    <pre><code><r:tag:if_pages>...</r:tag:if_pages></code></pre>
+  }    
+  tag 'tag:if_pages' do |tag|
+    tag.expand if tag.locals.tag.pages.any?
+  end
+  
+  desc %{
+    Contents are rendered unless the current tag has been applied to any pages.
+    
+    *Usage:* 
+    <pre><code><r:tag:unless_pages>...</r:tag:unless_pages></code></pre>
+  }    
+  tag 'tag:unless_pages' do |tag|
+    tag.expand unless tag.locals.tag.pages.any?
+  end
+
+  desc %{
+    Loops through the pages to which this tag has been applied
+    setting page context for all contained tags. Works just like children:each 
+    or other page tags.
+    
+    *Usage:* 
+    <pre><code><r:tag:pages:each>...</r:tag:pages:each></code></pre>
+  }    
+  tag 'tag:pages' do |tag|
+    raise TagError, "tag must be defined for tag:pages tag" unless tag.locals.tag
+    tag.expand
+  end
+  tag 'tag:pages:each' do |tag|
+    result = []
+    tag.locals.tag.pages.each do |page|
+      tag.locals.page = page
+      result << tag.expand
+    end 
+    result
+  end
+
+
+
+private
+
+  def _get_tag(tag, options)
+    if title = options.delete('title')
+      tag.locals.tag ||= Tag.find_by_title(title)
+    end
+    if tag.locals.page.respond_to? :requested_tags
+      tag.locals.tag ||= tag.locals.page.requested_tags.first
+    end
+    tag.locals.tag
+  end
+  
+  # this is the default used for bare tags:* tags.
+  # among other things it catches the tags="" attribute
+  # but change is likely here and anything not documented shouldn't be relied upon.
+  
+  def _get_tags(tag)
+    tags = if tag.attr['tags'] && !tag.attr['tags'].blank?
+      Tag.from_list(tag.attr['tags'], false)    # false parameter -> not to create missing tags
+    elsif tag.locals.page.respond_to?(:requested_tags)
+      tag.locals.page.requested_tags
+    elsif tag.locals.page
+      tag.locals.page.attached_tags
+    else
+      []
+    end
+    tags = tags.uniq.select{|t| !t.nil? }
+  end  
+
+end

data/lib/tasks/taggable_extension_tasks.rake

@@ -0,0 +1,55 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :taggable do
+      
+      desc "Runs the migration of the Taggable extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          TaggableExtension.migrator.migrate(ENV["VERSION"].to_i)
+          Rake::Task['db:schema:dump'].invoke
+        else
+          TaggableExtension.migrator.migrate
+          Rake::Task['db:schema:dump'].invoke
+        end
+      end
+      
+      desc "Copies public assets of the Taggable to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from TaggableExtension"
+        Dir[TaggableExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(TaggableExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+        unless TaggableExtension.root.starts_with? RAILS_ROOT # don't need to copy vendored tasks
+          puts "Copying rake tasks from TaggableExtension"
+          local_tasks_path = File.join(RAILS_ROOT, %w(lib tasks))
+          mkdir_p local_tasks_path, :verbose => false
+          Dir[File.join TaggableExtension.root, %w(lib tasks *.rake)].each do |file|
+            cp file, local_tasks_path, :verbose => false
+          end
+        end
+      end  
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = TaggableExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+    end
+  end
+end

data/public/stylesheets/admin/tags.css

@@ -0,0 +1,20 @@
+#tags-table table { margin-bottom: 0; }
+td.tag-title { font-size: 115%; font-weight: bold;}
+td.tag-title a { text-decoration: none; color: black; }
+td.tag-description {
+  font-size: 80%;
+  color: #999;
+}
+
+ul.cloud {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+  line-height: 20px; }
+  ul.cloud li {
+    display: inline;
+    font-family: "Lucida Grande", "Bitstream Vera Sans", Helvetica, Verdana, Arial, sans-serif;
+    letter-spacing: -0.04em;
+    white-space: nowrap;
+    line-height: 20px;
+    margin: 0; }

data/public/stylesheets/sass/tagcloud.sass

@@ -0,0 +1,29 @@
+ul.cloud
+  :position relative
+  :list-style none
+  :margin 0
+  :padding 0
+  :overflow hidden
+  :line-height 1.6em
+  :margin-left -5px
+
+  li
+    :display inline
+    :float left
+    :letter-spacing -0.04em
+    :height 1.6em
+
+    a
+      :display inline
+      :white-space nowrap
+      :padding 5px
+
+a.filter, a.defilter
+  :padding-left 11px
+  :font-size 12px
+a.filter
+  :background transparent url(/images/furniture/entag.png) no-repeat top left
+  :color #5da454
+a.defilter
+  :background transparent url(/images/furniture/detag.png) no-repeat top left
+  :color #9d313d

data/radiant-taggable-extension.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-taggable-extension}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["spanner"]
+  s.date = %q{2010-09-10}
+  s.description = %q{General purpose tagging extension: more versatile but less focused than the tags extension}
+  s.email = %q{will@spanner.org}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/admin/taggings_controller.rb",
+     "app/controllers/admin/tags_controller.rb",
+     "app/models/tag.rb",
+     "app/models/tagging.rb",
+     "app/views/admin/pages/_edit_title.html.haml",
+     "app/views/admin/tags/_form.html.haml",
+     "app/views/admin/tags/_search_results.html.haml",
+     "app/views/admin/tags/cloud.html.haml",
+     "app/views/admin/tags/edit.html.haml",
+     "app/views/admin/tags/index.html.haml",
+     "app/views/admin/tags/new.html.haml",
+     "app/views/admin/tags/show.html.haml",
+     "config/routes.rb",
+     "db/migrate/001_create_tags.rb",
+     "db/migrate/002_import_keywords.rb",
+     "lib/taggable_admin_page_controller.rb",
+     "lib/taggable_admin_ui.rb",
+     "lib/taggable_model.rb",
+     "lib/taggable_page.rb",
+     "lib/taggable_tags.rb",
+     "lib/tasks/taggable_extension_tasks.rake",
+     "pkg/radiant-taggable-extension-1.2.0.gem",
+     "public/images/admin/new-tag.png",
+     "public/images/admin/tag.png",
+     "public/images/furniture/detag.png",
+     "public/stylesheets/admin/tags.css",
+     "public/stylesheets/sass/tagcloud.sass",
+     "radiant-taggable-extension.gemspec",
+     "spec/datasets/tag_sites_dataset.rb",
+     "spec/datasets/tags_dataset.rb",
+     "spec/lib/taggable_page_spec.rb",
+     "spec/models/tag_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "taggable_extension.rb"
+  ]
+  s.homepage = %q{http://github.com/spanner/radiant-taggable-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Taggable Extension for Radiant CMS}
+  s.test_files = [
+    "spec/datasets/tag_sites_dataset.rb",
+     "spec/datasets/tags_dataset.rb",
+     "spec/lib/taggable_page_spec.rb",
+     "spec/models/tag_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<radiant>, [">= 0.9.0"])
+    else
+      s.add_dependency(%q<radiant>, [">= 0.9.0"])
+    end
+  else
+    s.add_dependency(%q<radiant>, [">= 0.9.0"])
+  end
+end
+

data/spec/datasets/tag_sites_dataset.rb

@@ -0,0 +1,9 @@
+class TagSitesDataset < Dataset::Base
+  
+  def load
+    create_record Site, :mysite, :name => 'My Site', :domain => 'mysite.domain.com', :base_domain => 'mysite.domain.com', :position => 1
+    create_record Site, :yoursite, :name => 'Your Site', :domain => '^yoursite', :base_domain => 'yoursite.test.com', :position => 2
+    create_record Site, :test, :name => 'Test host', :domain => '^test\.', :base_domain => 'test.host', :position => 3
+    Page.current_site = sites(:test) if defined? Site
+  end
+end