radiant-taggable-extension 1.2.3 → 1.2.4

data/README.md

@@ -7,7 +7,9 @@ This is another way to apply tags to objects in your radiant site and retrieve o
 This extension differs from `tags` in a few ways that matter to me but may not to you:
 
 * We're not so focused on tag clouds - though you can still make them - but more on archival and linking functions.
-* We replace the keywords mechanism on pages rather than adding another one.
+* We subvert the keywords mechanism on pages rather than adding another one.
+* The tag-choosing and tag-removal interface is (about to be) quite nice.
+* It's editorially versatile: tags can be used as page pointers and their visibility is controllable
 * Anything can be tagged. By default we only do pages but other extensions can participate with a single line in a model class. See the [taggable_events](https://github.com/spanner/radiant-taggable_events-extension) extension for a minimal example or just put `is_taggable` at the top of a model class and see what happens.
 * We don't use `has_many_polymorphs` (it burns!)
 * Or any of the tagging libraries: it only takes a few scopes
@@ -17,7 +19,12 @@ When you first install the extension you shouldn't see much difference: all we d
 
 ## New
 
-I've just stripped out quite a lot of display clutter in order to focus on the basic tagging mechanism here. Retrieval and display is now handled by the [library](http://example.com/) extension. The core radius tags remain here. Anything that used to refer to a tag page is probably now handled by the library page.
+The long-promised tag-suggester is there in a useable though slightly basic form. I would prefer it to display a list rather than populating
+the text box, but we're getting there. Migration is required for the metaphone support.
+
+I'm refactoring, or at least tidying up, the great clutter of tag tags. There's a lot more reuse in there now but the documentation may be out of date here and there. Bug reports very welcome.
+
+I've stripped out quite a lot of display clutter in order to focus on the basic tagging mechanism here. Retrieval and display is now handled by the [library](http://example.com/) extension. The core radius tags remain here. Anything that used to refer to a tag page is probably now handled by the library page.
 
 ## Status 
 
@@ -27,10 +34,11 @@ The underlying code is fairly well broken-in and has been in production for a co
 
 Not too bad, I think. Most of the heavy retrieval functions have been squashed down into single queries. Each of these:
 
-	Tag.most_popular(50)
-	Tag.coincident_with(tag1, tag2, tag3)
-	Page.tagged_with(tag1, tag2, tag3)
-	Page.related_pages 								# equivalent to Page.tagged_with(self.attached_tags) - [self]
+    Tag.most_popular(50)
+    Tag.coincident_with(tag1, tag2, tag3)
+    Page.tagged_with(tag1, tag2, tag3)
+    Page.related_pages                              # equivalent to Page.tagged_with(self.attached_tags) - [self]
+	Tag.suggested_by('stem')
 
 is handled in a single pass. 
 
@@ -44,26 +52,26 @@ This extension creates several radius tags. There are two kinds:
 
 are used in the usual to display the properties and associations of a given tag (which can be supplied to a library as a query parameter or just specified in the radius tag)
 
-	<r:tag:title />
-	<r:tag:description />
-	<r:tag:pages:each>...</r:tag:pages:each>
+    <r:tag:title />
+    <r:tag:description />
+    <r:tag:pages:each>...</r:tag:pages:each>
 
 currently only available in a tag cloud (or a `top_tags` list):
 
-	<r:tag:use_count />
+    <r:tag:use_count />
 
 ### presenting page information
 
 These display the tag-associations of a given page.
 
-	<r:if_tags>...</r:if_tags>
-	<r:unless_tags>...</r:unless_tags>
-	<r:tags:each>...</r:tags:each>
-	<r:related_pages:each>...</r:related_pages:each>
-	<r:tag_cloud [url=""] />
+    <r:if_tags>...</r:if_tags>
+    <r:unless_tags>...</r:unless_tags>
+    <r:tags:each>...</r:tags:each>
+    <r:related_pages:each>...</r:related_pages:each>
+    <r:tag_cloud [url=""] />
 
 The library extension adds a lot more ways to retrieve lists of tags and tagged objects, and to work with assets in the same way as we do here with pages.
-	
+    
 ## Note about tag cloud prominence
 
 The calculation of prominence here applies a logarithmic curve to create a more even distribution of weight. It's continuous rather than banded, and sets the font size and opacity for each tag in a style attribute.
@@ -76,27 +84,27 @@ Add tags to your pages by putting a comma-separated list in the 'keywords' box.
 
 Put this in your layout:
 
-	<r:if_tags>
-	  <h3>See also</h3>
-	  <ul>
-	    <r:related_pages.each>
-	      <li><r:link /></li>
-	    </r:related_pages.each>
-	  </ul>
-	</r:if_tags>
+    <r:if_tags>
+      <h3>See also</h3>
+      <ul>
+        <r:related_pages.each>
+          <li><r:link /></li>
+        </r:related_pages.each>
+      </ul>
+    </r:if_tags>
 
 ### To display a tag cloud on a section front page:
 
 Include the sample tagcloud.css in your styles and put this somewhere in the page or layout:
 
-	<r:tag_cloud />
+    <r:tag_cloud />
 
 Seek venture capital immediately.
-	
+    
 ## Next steps
 
 * auto-completer to improve tagging consistency.
-	
+    
 ## Requirements
 
 * Radiant 0.8.1
@@ -107,9 +115,9 @@ This is no longer compatible with 0.7 because we're doing a lot of :having in th
 
 As usual:
 
-	git clone git://github.com/spanner/radiant-taggable-extension.git vendor/extensions/taggable
-	rake radiant:extensions:taggable:migrate
-	rake radiant:extensions:taggable:update
+    git clone git://github.com/spanner/radiant-taggable-extension.git vendor/extensions/taggable
+    rake radiant:extensions:taggable:migrate
+    rake radiant:extensions:taggable:update
 
 The update task will bring over a couple of CSS files for styling tags but you'll want to improve those.
 

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.2.4

data/app/controllers/admin/tags_controller.rb

@@ -1,8 +1,14 @@
 class Admin::TagsController < Admin::ResourceController
+  helper :taggable
   
-  def index 
-    @tags = Tag.with_count.sort
-    response_for :plural
+  def index
+    tags = params[:query] ? Tag.suggested_by(params[:query]) : Tag.with_count
+    @tags = tags.sort
+    respond_to do |wants|
+      wants.xml { render :xml => @tags }
+      wants.json { render :json => { 'query' => params[:query], 'suggestions' => @tags.map(&:title) } }
+      wants.any
+    end
   end
   
   def show

data/app/helpers/taggable_helper.rb

@@ -0,0 +1,21 @@
+module TaggableHelper
+
+  def available_pointer_pages()
+    root = Page.respond_to?(:homepage) ? Page.homepage : Page.find_by_parent_id(nil)
+    options = pointer_option_branch(root)
+    options.unshift ['<none>', nil]
+    options
+  end
+    
+  def pointer_option_branch(page, depth=0)
+    options = []
+    unless page.virtual? || page.sheet? || page.has_pointer?
+      options << ["#{". " * depth}#{h(page.title)}", page.id]
+      page.children.each do |child|
+        options += pointer_option_branch(child, depth + 1)
+      end
+    end
+    options
+  end
+
+end

data/app/models/tag.rb

@@ -1,12 +1,41 @@
+require "text/metaphone"
+
 class Tag < ActiveRecord::Base
   attr_accessor :cloud_band, :cloud_size
   
   belongs_to :created_by, :class_name => 'User'
   belongs_to :updated_by, :class_name => 'User'
+  belongs_to :page
   has_many :taggings, :dependent => :destroy
-  is_site_scoped if respond_to? :is_site_scoped
+  before_save :calculate_metaphone
+  
   has_site if respond_to? :has_site
 
+  # returns the subset of tags meant for public display and selection
+  
+  named_scope :visible, {
+    :conditions => ['visible = 1']
+  }
+
+  # returns the set of hidden editorial tags used for linking and labelling but
+  # not meant for public display.
+
+  named_scope :hidden, {
+    :conditions => ['visible = 0']
+  }
+  
+  # returns the subset of structural tags (ie, those that are page links)
+  
+  named_scope :structural, {
+    :conditions => ['page_id IS NOT NULL']
+  }
+
+  # returns the subset of tags without page links
+  
+  named_scope :descriptive, {
+    :conditions => ['page_id IS NULL']
+  }
+
   # this is useful when we need to go back and add popularity to an already defined list of tags
   
   named_scope :in_this_list, lambda { |tags|
@@ -62,15 +91,32 @@ class Tag < ActiveRecord::Base
       :conditions => "tt.tagged_type = '#{klass}'",
     }
   }
+
+  # this should probably be sorted better but I want to keep it as quick an operation as possible
+  # so only the one query is allowed
+  
+  named_scope :suggested_by, lambda { |term|
+    metaphone = Text::Metaphone.metaphone(term)
+    {
+      :conditions => ["tags.title LIKE ? OR tags.metaphone LIKE ?", "%#{term}%", "&#{metaphone}%"]
+    }
+  }
   
   def <=>(othertag)
-    String.natcmp(self.title, othertag.title)
+    String.natcmp(self.title, othertag.title)   # natural sort method defined in lib/natcomp.rb
   end
   
   def to_s
     title
   end
   
+  # returns true if this tag points to a page
+  
+  def structural
+    !page_id.nil?
+  end
+  alias :structural? :structural
+  
   # Standardises formatting of tag name in urls
   
   def clean_title
@@ -83,6 +129,8 @@ class Tag < ActiveRecord::Base
     taggings.map {|t| t.tagged}
   end
   
+  # Returns a list of all the page tagged with this tag.
+  
   def pages
     Page.from_tags([self])
   end
@@ -100,7 +148,7 @@ class Tag < ActiveRecord::Base
   # Returns a list of all the tags that have been applied alongside _all_ of the supplied tags.
   # used to offer reductive facets on library pages
   # not very efficient at the moment, largely thanks to polymorphic tagging relationship
-  # TODO: omit tags with no reductive power (ie applied to all the tagged items)
+  # TODO: omit tags with no reductive power (ie those applied to all the tagged items)
   
   def self.coincident_with(tags)
     related_tags = []
@@ -155,6 +203,7 @@ class Tag < ActiveRecord::Base
     end
   end
   
+  # applies a more sophisticated logarithmic weighting algorithm to a set of tags.
   # derived from here:
   # http://stackoverflow.com/questions/604953/what-is-the-correct-algorthm-for-a-logarthmic-distribution-curve-between-two-poin
   
@@ -181,6 +230,7 @@ class Tag < ActiveRecord::Base
   end
   
   # takes a list of tags and reaquires it from the database, this time with incidence.
+  # cheap call because it returns immediately if the list is already cloudable.
   
   def self.for_cloud(tags)
     return tags if tags.empty? || tags.first.cloud_size
@@ -193,11 +243,16 @@ class Tag < ActiveRecord::Base
   
   # adds retrieval methods for a taggable class to this class and to Tagging.
   
-  def self.define_class_retrieval_methods(classname)
-    Tagging.send :named_scope, "of_#{classname.downcase.pluralize}".intern, :conditions => { :tagged_type => classname.to_s }
-    define_method("#{classname.downcase}_taggings") { self.taggings.send "of_#{classname.downcase.pluralize}".intern }
-    define_method("#{classname.downcase.pluralize}") { self.send("#{classname.to_s.downcase}_taggings".intern).map{|l| l.tagged} }
+  def self.define_retrieval_methods(classname)
+    define_method classname.downcase.pluralize.to_sym do
+      classname.constantize.send :from_tag, self
+    end
+  end
+
+protected
+  
+  def calculate_metaphone
+    self.metaphone = Text::Metaphone.metaphone(self.title)
   end
-      
 end
 

data/app/views/admin/pages/_edit_title.html.haml

@@ -1,28 +1,12 @@
-- content_for :page_css do
-  :sass 
-    p.title
-      :width 70%
-    p.keywords
-      :width 28%
-      :float right
-      :margin 0 1% 0 0
-    #content 
-      form
-        .keywords 
-          .textbox
-            :font-family Georgia, Palatino, "Times New Roman", Times, serif
-            :font-size 200%
-            :width 100%
-            :color #c00
-            :margin-top 4px
-    #attributes
-      :clear both
-            
+- include_stylesheet 'admin/taggable'
+- include_javascript 'autocomplete'
+- include_javascript 'admin/taggable'
+
 - fields_for :page, @page do |fields|
   %p.keywords
     %label{:for=>"page_keywords"}
-      Tags
-    = fields.text_field :keywords, :class => 'textbox'
+      =t('tags')
+    = fields.text_field :keywords, :class => 'textbox tagger'
   %p.title
     %label{:for=>"page_title"}= t('page_title')
     = fields.text_field :title, :class => 'textbox', :maxlength => 255

data/app/views/admin/tags/_form.html.haml

@@ -1,23 +1,37 @@
-= render_region :form_top
-- render_region :form do |form_region|
-  .form-area
-    - form_region.edit_name do
-      %p.title
-        = form.label :title
-        = form.text_field :title, :class => 'textbox', :maxlength => 255
+- form_for [:admin, @tag], :html => {'data-onsubmit_status' => onsubmit_status(@tag)} do |f|
+  = render_region :form_top
+  - render_region :form do |form_region|
+    .form-area
+      - form_region.edit_name do
+        %p.title
+          = f.label :title
+          = f.text_field :title, :class => 'textbox', :maxlength => 255
 
-    - form_region.edit_description do
-      %div
-        = form.label :description
-        = form.text_area :description, :class => "textarea", :style => "width: 100%"
+      - form_region.edit_role do
+        %p
+          = check_box_tag :structural, 1, @tag.structural?, {:class => 'toggle', :rel => 'toggle[pointer]'}
+          = f.label :structural, nil, :class => 'checkbox'
+        %div#pointer
+          %p
+            = f.label :page_id
+            = f.select :page_id, available_pointer_pages
+        
+      - form_region.edit_description do
+        %p
+          = f.check_box :visible, {:class => 'toggle', :rel => 'toggle[description]'}
+          = f.label :visible, nil, :class => 'checkbox'
+        %div#description
+          %p.description
+            = f.label :description
+            = f.text_area :description, :class => "textarea", :style => "width: 100%"
 
-- render_region :form_bottom do |form_bottom_region|
-  - form_bottom_region.edit_timestamp do
-    = updated_stamp @tag  
+  - render_region :form_bottom do |form_bottom_region|
+    - form_bottom_region.edit_timestamp do
+      = updated_stamp @tag  
 
-  - form_bottom_region.edit_buttons do
-    %p.buttons
-      = save_model_button(@tag)
-      = save_model_and_continue_editing_button(@tag)
-      or
-      = link_to "Cancel", admin_tags_url
+    - form_bottom_region.edit_buttons do
+      %p.buttons
+        = save_model_button(@tag)
+        = save_model_and_continue_editing_button(@tag)
+        or
+        = link_to "Cancel", admin_tags_url

data/app/views/admin/tags/cloud.html.haml

@@ -1,11 +1,6 @@
 - include_stylesheet 'admin/tags'
 - url = Radiant::Config['tags.page'] || '/tags'
 
-%h1 Tag cloud
-
-%p
-  = link_to "← view as list", admin_tags_url
-
 %div.cloud
   - @tags.each do |tag|
     = link_to tag.title, admin_tag_url(tag), :style => "font-size: #{tag.cloud_size.to_f * 2.5}em;"
@@ -13,5 +8,3 @@
 #actions
   %ul
     %li= link_to image('plus') + " " + "new tag", new_admin_tag_url
-    %li= link_to "tag list", admin_tags_url, :class => 'minor'
-    %li= link_to "tag cloud", cloud_admin_tags_url, :class => 'minor'

data/app/views/admin/tags/edit.html.haml

@@ -1,4 +1,6 @@
-- include_stylesheet 'admin/tags' 
+- @page_title = 'Tag: ' + @tag.title + ' - ' + default_page_title
+- include_stylesheet 'admin/taggable'
+- include_javascript 'admin/taggable'
 
 - render_region :main do |main|
   - main.edit_header do
@@ -6,9 +8,4 @@
       Edit Tag
     
   - main.edit_form do
-    - form_for :tag, :url => admin_tag_path(@tag), :html => { :method => "put", :multipart => true } do |form|
-      = render :partial => 'form', :object => form
-
-    
-    
-    
+    = render :partial => 'form'

data/app/views/admin/tags/index.html.haml

@@ -1,4 +1,7 @@
-- include_stylesheet 'admin/tags'
+- include_stylesheet 'admin/taggable'
+- include_javascript 'admin/taggable'
+
+- @page_title = t('tags') + ' - ' + default_page_title
 = render_region :top 
 
 #tags_table.outset
@@ -8,6 +11,8 @@
         - render_region :thead do |thead|
           - thead.title_header do
             %th.tag-title Title
+          - thead.link_header do
+            %th.tag-link Pointer
           - thead.description_header do
             %th.tag-description Description
           - thead.usage_header do
@@ -17,13 +22,20 @@
 
     %tbody
       - for tag in @tags 
-        %tr.node.level-1
+        %tr{:class => tag.visible? ? 'visible' : 'secret'}
           - render_region :tbody do |tbody|
             - tbody.title_cell do
               %td.tag-title
                 = link_to image('tag', :alt => ''), edit_admin_tag_url(:id => tag.id) 
                 = link_to tag.title, edit_admin_tag_url(:id => tag.id) 
 
+            - tbody.link_cell do
+              %td.tag-link
+                - if tag.page
+                  = link_to tag.page.title, tag.page.url
+                - else
+                  —
+
             - tbody.description_cell do
               %td.tag-description
                 = tag.description
@@ -44,10 +56,3 @@
     #actions
       %ul
         %li= link_to image('plus') + " " + "new tag", new_admin_tag_url
-        %li= link_to "tag list", admin_tags_url, :class => 'minor'
-        %li= link_to "tag cloud", cloud_admin_tags_url, :class => 'minor'
-   
-%script{ :type => "text/javascript"}
-  // <! [CDATA[
-  new RuledTable('tags')
-  //]