radiant-library-extension 2.0.0

data/lib/library/more_tag_tags.rb

@@ -0,0 +1,179 @@
+module Library
+  module MoreTagTags
+    include Radiant::Taggable
+  
+    class TagError < StandardError; end
+
+    ############### overriding standard taggable links
+
+    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
+    end
+    
+    desc %{
+      Makes a link that removes the current tag from the active set. Other options as for tag:link.
+
+      *Usage:* 
+      <pre><code><r:tag:unlink linkto='/library' /></code></pre>
+    }
+    tag 'tag:unlink' do |tag|
+      raise TagError, "tag must be defined for tag:unlink tag" unless tag.locals.tag
+      options = tag.attr.dup
+      options['class'] ||= 'detag'
+      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)
+        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}") + '/'
+      end
+
+      %{<a href="#{href}#{anchor}"#{attributes}>#{text}</a>}
+    end
+
+
+    ############### asset-listing equivalents of existing page tags
+                  # the main use for these tags is to pull related images and documents into pages
+                  # in the same way as you would pull in related pages
+  
+    desc %{
+      Lists all the assets associated with a set of tags, in descending order of relatedness.
+    
+      *Usage:* 
+      <pre><code><r:tags:assets:each>...</r:tags:assets:each></code></pre>
+    }
+    tag 'tags:assets' do |tag|
+      tag.expand
+    end
+    tag 'tags:assets:each' do |tag|
+      tag.locals.assets ||= _asset_finder(tag)
+      tag.render('asset_list', tag.attr.dup, &tag.block)
+    end
+
+    desc %{
+      Renders the contained elements only if there are any assets associated with the current set of tags.
+
+      *Usage:* 
+      <pre><code><r:tags:if_assets>...</r:tags:if_assets></code></pre>
+    }
+    tag "tags:if_assets" do |tag|
+      tag.locals.assets = _assets_for_tags(tag.locals.tags)
+      tag.expand if tag.locals.assets.any?
+    end
+
+    desc %{
+      Renders the contained elements only if there are no assets associated with the current set of tags.
+
+      *Usage:* 
+      <pre><code><r:tags:unless_assets>...</r:tags:unless_assets></code></pre>
+    }
+    tag "tags:unless_assets" do |tag|
+      tag.locals.assets = _assets_for_tags(tag.locals.tags)
+      tag.expand unless tag.locals.assets.any?
+    end
+  
+    desc %{
+      Lists all the assets similar to this page (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, "page must be defined for related_assets tag" unless tag.locals.page
+      tag.locals.assets = Asset.not_furniture.from_tags(tag.locals.page.attached_tags)
+      tag.expand
+    end
+    tag 'related_assets:each' do |tag|
+      tag.render('asset_list', tag.attr.dup, &tag.block)
+    end
+  
+    Asset.known_types.each do |type|
+      desc %{
+        Lists all the #{type} assets similar to this page (based on its tagging), in descending order of relatedness.
+
+        *Usage:* 
+        <pre><code><r:related_#{type.to_s.pluralize}:each>...</r:related_#{type.to_s.pluralize}:each></code></pre>
+      }
+      tag "related_#{type.to_s.pluralize}" do |tag|
+        raise TagError, "page must be defined for related_#{type.to_s.pluralize} tag" unless tag.locals.page
+        tag.locals.assets = Asset.not_furniture.from_tags(tag.locals.page.attached_tags).send("#{type.to_s.pluralize}".intern)
+        tag.expand
+      end
+      tag "related_#{type.to_s.pluralize}:each" do |tag|
+        tag.render('asset_list', tag.attr.dup, &tag.block)
+      end
+    end
+
+    ############### tags: tags for displaying assets when we have a tag
+                  # similar tags already exist for pages
+
+    desc %{
+      Loops through the assets to which the present tag has been applied
+    
+      *Usage:* 
+      <pre><code><r:tag:assets:each>...</r:tag:assets:each></code></pre>
+    }    
+    tag 'tag:assets' do |tag|
+      raise TagError, "tag must be defined for tag:assets tag" unless tag.locals.tag
+      tag.locals.assets = tag.locals.tag.assets
+      tag.expand
+    end
+    tag 'tag:assets:each' do |tag|
+      tag.render('assets:each', tag.attr.dup, &tag.block)
+    end
+  
+    desc %{
+      Renders the contained elements only if there are any assets associated with the current tag.
+
+      *Usage:* 
+      <pre><code><r:tag:if_assets>...</r:tag:if_assets></code></pre>
+    }
+    tag "tag:if_assets" do |tag|
+      raise TagError, "tag must be defined for tag:if_assets tag" unless tag.locals.tag
+      tag.locals.assets = tag.locals.tag.assets
+      tag.expand if tag.locals.assets.any?
+    end
+
+    desc %{
+      Renders the contained elements only if there are no assets associated with the current tag.
+
+      *Usage:* 
+      <pre><code><r:tag:unless_assets>...</r:tag:unless_assets></code></pre>
+    }
+    tag "tag:unless_assets" do |tag|
+      raise TagError, "tag must be defined for tag:unless_assets tag" unless tag.locals.tag
+      tag.locals.assets = tag.locals.tag.assets
+      tag.expand unless tag.locals.assets.any?
+    end
+    
+    
+
+  private
+
+    def _asset_finder(tag)
+      if (tag.locals.tags)
+        Asset.from_all_tags(tag.locals.tags).not_furniture
+      else
+        Asset.not_furniture
+      end
+    end
+
+  end
+end
+

data/lib/library/site_controller.rb

@@ -0,0 +1,33 @@
+module Library
+  module SiteController
+  
+    def self.included(base)
+    
+      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.
+          page
+        end
+        alias_method_chain :find_page, :tags
+
+        def show_page_with_tags
+          show_page_without_tags
+        rescue LibraryPage::RedirectRequired => e
+          redirect_to e.message
+        end
+        alias_method_chain :show_page, :tags
+      
+      protected
+        def clean_url(url)
+          "/#{ url.strip }/".gsub(%r{//+}, '/')
+        end
+      
+      }
+    end
+  end
+end

data/lib/library/tagged_asset.rb

@@ -0,0 +1,42 @@
+module Library
+  module TaggedAsset
+  
+    def self.included(base)
+
+      base.class_eval {
+        named_scope :furniture, {:conditions => 'assets.furniture = 1'}
+        named_scope :not_furniture, {:conditions => 'assets.furniture = 0 or assets.furniture is null'}
+        named_scope :newest_first, { :order => 'created_at DESC'} do
+          def paged (options={})
+            paginate({:per_page => 20, :page => 1}.merge(options))
+          end
+        end
+
+        extend TaggablePage::ClassMethods
+        include TaggablePage::InstanceMethods
+      }
+    end
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+
+      # just keeping compatibility with page tags
+      # so as to present the same interface
+
+      def keywords 
+        self.attached_tags.map {|t| t.title}.join(', ')
+      end
+    
+      def keywords=(somewords="")
+        self.attached_tags = Tag.from_list(somewords)
+      end
+    
+      def keywords_before_type_cast   # called by form_helper
+        keywords
+      end
+
+    end
+  end
+end

data/lib/tasks/library_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :library do
+      
+      desc "Runs the migration of the Library extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          LibraryExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          LibraryExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Library to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        puts "Copying assets from LibraryExtension"
+        Dir[LibraryExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(LibraryExtension.root, '')
+          directory = File.dirname(path)
+          mkdir_p RAILS_ROOT + directory, :verbose => false
+          cp file, RAILS_ROOT + path, :verbose => false
+        end
+      end  
+    end
+  end
+end

data/library_extension.rb

@@ -0,0 +1,24 @@
+require_dependency 'application_controller'
+
+class LibraryExtension < Radiant::Extension
+  version "2.0.0"
+  description "Combines paperclipped and taggable to create a general purpose faceted library"
+  url "http://github.com/spanner/radiant-library-extension"
+    
+  def activate
+    Asset.send :is_taggable                                            # make assets taggable
+    Asset.send :include, Library::TaggedAsset                          # add a keywords method for likeness with pages
+    Tag.send :include, Library::LibraryTag                             # adds assets and asset-type methods to Tag
+    LibraryPage                                                        # page type that reads tags/from/url and prepares paginated lists of matching pages and assets
+    SiteController.send :include, Library::SiteController              # intervene to catch tag[]= parameters too
+    Page.send :include, Library::MoreAssetTags                         # defines a few more r:assets:* radius tags
+    Page.send :include, Library::MoreTagTags                           # defines a few more r:tag:* radius tags
+    
+    admin.tag.show.add :main, "/admin/tags/show_assets", :after => "show_pages"
+  end
+  
+  def deactivate
+    admin.tabs.remove "Library" unless respond_to?(:tab)
+  end
+  
+end

data/spec/controllers/library_site_controller_spec.rb

@@ -0,0 +1,97 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+Radiant::Config['reader.layout'] = 'Main'
+
+describe SiteController do
+  dataset :library_pages
+
+  describe "on get to a library page" do
+    before do
+      get :show_page, :url => '/library/'
+    end
+    
+    it "should render the tag page" do
+      response.should be_success      
+      response.body.should == 'Shhhhh. body.'
+    end
+    
+    describe "with tags in child position" do
+      before do
+        get :show_page, :url => '/library/colourless/green/'
+      end
+
+      it "should still render the tag page" do
+        response.should be_success
+        response.body.should == 'Shhhhh. body.'
+      end
+    end
+
+    describe "with tags in child position and missing final /" do
+      before do
+        get :show_page, :url => '/library/colourless/green'
+      end
+
+      it "should still render the tag page" do
+        response.should be_success
+        response.body.should == 'Shhhhh. body.'
+      end
+    end
+
+    describe "with tag negation" do
+      before do
+        get :show_page, :url => '/library/colourless/green/-colourless'
+      end
+
+      it "should redirect to the reduced address" do
+        response.should be_redirect      
+        response.should redirect_to('http://test.host/library/green/')
+      end
+    end
+  end
+
+  describe "caching" do
+    describe "without tags requested" do
+      it "should add a default Cache-Control header with public and max-age of 5 minutes" do
+        get :show_page, :url => '/library/'
+        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/'
+        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/'
+        response.response_code.should == 304
+        response.body.should be_blank
+      end
+    end
+    
+    describe "with tags requested" do
+      it "should add a default Cache-Control header with public and max-age of 5 minutes" do
+        get :show_page, :url => '/library/green/furiously'
+        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'
+        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'
+        response.response_code.should == 304
+        response.body.should be_blank
+      end
+    end
+    
+    
+  end
+    
+end

data/spec/datasets/library_pages_dataset.rb

@@ -0,0 +1,10 @@
+require 'digest/sha1'
+
+class LibraryPagesDataset < Dataset::Base
+  uses :library_tags
+  
+  def load
+    create_page "library", :slug => "library", :class_name => 'LibraryPage', :body => 'Shhhhh.'
+  end
+ 
+end

data/spec/datasets/library_sites_dataset.rb

@@ -0,0 +1,9 @@
+class LibrarySitesDataset < 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

data/spec/datasets/library_tags_dataset.rb

@@ -0,0 +1,43 @@
+require 'digest/sha1'
+
+class LibraryTagsDataset < Dataset::Base
+  datasets = [:pages]
+  datasets << :library_sites if defined? Site
+  uses *datasets
+  
+  def load
+    create_tag "colourless"
+    create_tag "green"
+    create_tag "ideas"
+    create_tag "sleep"
+    create_tag "furiously"
+    
+    apply_tag :colourless, pages(:first)
+    apply_tag :ideas, pages(:first), pages(:another), pages(:grandchild)
+    apply_tag :sleep, pages(:first)
+    apply_tag :furiously, pages(:first)
+  end
+  
+  helpers do
+    def create_tag(title, attributes={})
+      attributes = tag_attributes(attributes.update(:title => title))
+      tag = create_model Tag, title.symbolize, attributes
+    end
+    
+    def tag_attributes(attributes={})
+      title = attributes[:name] || "Tag"
+      attributes = { 
+        :title => title
+      }.merge(attributes)
+      attributes[:site] = sites(:test) if defined? Site
+      attributes
+    end
+        
+    def apply_tag(tag, *items)
+      tag = tag.is_a?(Tag) ? tag : tags(tag)
+      items.each { |i| i.attached_tags << tag }
+    end
+    
+  end
+ 
+end