radiant-library-extension 2.0.0

data/README.md

@@ -0,0 +1,112 @@
+# Library
+
+This is a gallery/library displayer. It combines [paperclipped](http://github.com/spanner/paperclipped) (for images and documents) and [taggable](http://github.com/spanner/radiant-taggable-extension) to offer faceted tag-based retrieval of everything through a single page. I use it for image libraries, document downloads, and on big sites just for page-retrieval. Anything that is tagged can be offered through this interface.
+
+## Status 
+
+Fairly mature and in use in the world. I've just rationalised the radius tags to support what has emerged as the likely uses, so the interface is now reliable.
+
+We're now using built-in pagination and gem-based configuration, so radiant 0.9 is required.
+
+The requirement for our fork of paperclipped should soon disappear.
+
+## Requirements
+
+* Radiant 0.9
+* [paperclipped](http://github.com/spanner/paperclipped) (currently, requires our fork) and [taggable](http://github.com/spanner/radiant-taggable-extension) extensions
+
+## Installation
+
+As usual:
+
+	./script/extension install library
+
+or some variation on:
+
+    git submodule add git://github.com/spanner/radiant-library-extension.git vendor/extensions/library
+    rake radiant:extensions:library:update
+    rake radiant:extensions:library:migrate
+    
+## Configuration
+
+You need to make sure that paperclipped and taggable load before this does, and anything that adds content types to paperclipped. This is the most awkward sequence I've had to use:
+
+    config.extensions = [ :share_layouts, :sites, :taggable, :reader, :reader_group, :paperclipped, :paperclipped_gps, :all, :library ]
+    
+## Library pages
+
+The **LibraryPage** page type is a handy cache-friendly way of catching tag parameters and displaying lists of related items: any path following the address of the page is taken as a slash-separated list of tags, so with a tag page at /archive you can call addresses like:
+
+    /archive/lasagne/chips/pudding
+    
+and the right tags will be retrieved, if they exist.
+
+## Examples
+
+This will display a faceted image browser on a library page:
+
+    <r:library:if_requested_tags>
+      <p>Displaying pictures tagged with <r:library:requested_tags /></p>
+    </r:library:if_requested_tags>
+    
+    <r:library:images:each paginated="true" per_page="20">
+      <r:assets:link size="full"><r:assets:image size="small" /></r:assets:link>
+    </r:library:images:each>
+
+    <r:library:tags for="images" />
+    
+And this will automate the illustration of any page based on tag-overlap:
+
+    <r:related_images:each limit="3">
+      <r:assets:image size="standard" />
+      <p class="caption"><r:assets:caption /></p>
+    </r:related_images:each>
+
+## Radius tags
+
+This extension used to define a ridiculous confusion of tags, so I have slimmed it ruthlessly to make likely uses easy rather than to make all uses possible.
+
+### Library page tags
+
+The library tags now focus on two tasks: choosing a set of tags and displaying a set of matching objects.
+
+    <r:library:tags />
+    <r:library:tags:each>...</r:library:tags:each>
+    
+Displays a list of the tags available. If any tags have been requested, this will show the list of coincident tags (that can be used to limit the result set further). If not it shows all the available tags. If a `for` attribute is set:
+
+    <r:library:tags for="images" />
+    <r:library:tags for="pages" />
+
+Then we show only the set of tags attached to any object of that kind.
+
+    <r:library:requested_tags />
+    <r:library:requested_tags:each>...</r:library:requested_tags:each>
+    
+Displays the currently-limiting set of tags.
+
+    <r:library:pages:each>...</r:library:pages:each>
+    <r:library:assets:each>...</r:library:assets:each>
+    <r:library:images:each>...</r:library:images:each>
+    <r:library:videos:each>...</r:library:videos:each>
+
+Display the list of (that kind of) objects associated with the current tag set.
+
+### Tag assets and asset tags
+
+All the page tags have asset equivalents:
+
+    <r:tags:assets:each tags="foo, bar">...</r:tags:assets:each>
+    <r:related_assets:each>...</r:related_assets:each>
+
+and for any `*asset*` tag you can substitute an asset type, so this also works:
+
+    <r:related_images:each>...</r:related_images:each>
+
+Within these lists you can use all the usual page and asset tags.
+
+## Author and copyright
+
+* William Ross, for spanner. will at spanner.org
+* Copyright 2007-2010 spanner ltd
+* released under the same terms as Rails and/or Radiant

data/Rakefile

@@ -0,0 +1,137 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-library-extension"
+    gem.summary = %Q{Library Extension for Radiant CMS}
+    gem.description = %Q{Combines paperclipped and taggable to create a general purpose faceted library}
+    gem.email = "will@spanner.org"
+    gem.homepage = "http://github.com/spanner/radiant-library-extension"
+    gem.authors = ["spanner"]
+    gem.add_dependency "radiant", ">= 0.9.0"
+    gem.add_dependency "radiant-taggable-extension", ">= 1.2.0"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package library as a gem."
+end
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :features => 'spec:integration'
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the library extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LibraryExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the library extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/models/library_page.rb

@@ -0,0 +1,61 @@
+class LibraryPage < Page
+  include Library::LibraryTags
+  include WillPaginate::ViewHelpers
+
+  class RedirectRequired < StandardError
+    def initialize(message = nil); super end
+  end
+
+  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/app/views/admin/assets/_edit_metadata.html.haml

@@ -0,0 +1,20 @@
+- fields_for :asset, @asset do |fields|
+  #extended-metadata{ :class => "row", :style => "display: none" }
+    %table.fieldset{ :cellpadding => "0", :cellspacing => "0", :border => "0" }
+      %tr
+        %td.label
+          = fields.label :caption
+        %td.field
+          = fields.text_field :caption, :class => 'textbox', :maxlength => 255 
+      -if @asset.new_record? || @asset.image?
+        %tr
+          %td.label
+            Display
+          %td.field{:style => 'text-align: left;'}
+            = fields.check_box :furniture
+            = fields.label :furniture, "Site furniture? (not shown in lists and galleries)"
+      = render_region :extended_metadata
+  %p
+    %small
+      %a{ :id => "more-extended-metadata", :href => "#", :onclick => "#{toggle_javascript_for('extended-metadata')}; return false;" } More
+      %a{ :id => "less-extended-metadata", :href => "#", :onclick => "#{toggle_javascript_for('extended-metadata')}; return false;", :style => "display: none" } Less

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

@@ -0,0 +1,31 @@
+- content_for :page_css do
+  :sass 
+    div#a_header
+      :width 99%
+      div#a_title
+        :width 70%
+        :float left
+      div#a_keywords
+        :width 28%
+        :float right
+    div#content 
+      .form-area 
+        .keywords 
+          .textbox
+            :font-family Georgia, Palatino, "Times New Roman", Times, serif
+            :font-size 200%
+            :width 100%
+            :color #c00
+
+- fields_for :asset, @asset do |fields|
+  #a_header
+    #a_title
+      %p.title
+        %label{:for=>"asset_title"}
+          Title
+        = fields.text_field :title, :class => 'textbox', :maxlength => 100
+    #a_keywords
+      %p.keywords
+        %label{:for=>"asset_keywords"}
+          Tags
+        = fields.text_field :keywords, :class => 'textbox'

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

@@ -0,0 +1,22 @@
+- include_stylesheet 'admin/assets' 
+
+- asset_taggings = @tag.taggings.of_a :asset
+- if asset_taggings.any?
+  %h2
+    Tagged assets
+  %table.index
+    - asset_taggings.each do |tagging|
+      - asset = tagging.tagged
+      - if asset
+        - dom_id = "tagging_#{tagging.id}"
+        %tr{:id => dom_id}
+          %td.asset{:style => 'width: 48px'}
+            = link_to image_tag(asset.thumbnail(:icon)), edit_admin_asset_path(asset), :class => 'icon'
+          %td.asset-title
+            = link_to asset.title, edit_admin_asset_path(asset) 
+          %td.actions
+            = link_to_remote image('minus') + ' detach', |
+              :html => { :class => "action", :title => "Detach tag from asset" }, |
+              :url => admin_tagging_url(tagging), :method => :delete, |
+              :after => "Effect.Fade('#{dom_id}', { duration: 0.5 })", |
+              :complete => "Element.remove('#{dom_id}');"

data/cucumber.yml

@@ -0,0 +1 @@
+default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/20091030115120_furniture.rb

@@ -0,0 +1,9 @@
+class Furniture < ActiveRecord::Migration
+  def self.up
+    add_column :assets, :furniture, :boolean, :default => false
+  end
+
+  def self.down
+    remove_column :assets, :furniture
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+# Sets up the Rails environment for Cucumber
+ENV["RAILS_ENV"] = "test"
+# Extension root
+extension_env = File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
+require extension_env+'.rb'
+
+Dir.glob(File.join(RADIANT_ROOT, "features", "**", "*.rb")).each {|step| require step}
+ 
+Cucumber::Rails::World.class_eval do
+  include Dataset
+  datasets_directory "#{RADIANT_ROOT}/spec/datasets"
+  Dataset::Resolver.default = Dataset::DirectoryResolver.new("#{RADIANT_ROOT}/spec/datasets", File.dirname(__FILE__) + '/../../spec/datasets', File.dirname(__FILE__) + '/../datasets')
+  self.datasets_database_dump_path = "#{Rails.root}/tmp/dataset"
+  
+  # dataset :library
+end

data/features/support/paths.rb

@@ -0,0 +1,14 @@
+def path_to(page_name)
+  case page_name
+  
+  when /the homepage/i
+    root_path
+  
+  when /login/i
+    login_path
+  # Add more page name => path mappings here
+  
+  else
+    raise "Can't find mapping from \"#{page_name}\" to a path."
+  end
+end

data/lib/library/library_tag.rb

@@ -0,0 +1,15 @@
+module Library
+  module LibraryTag
+
+    def assets
+      Asset.from_tags([self])
+    end
+    
+    Asset.known_types.each do |type|
+      define_method type.to_s.pluralize.intern do
+        Asset.send("#{type.to_s.pluralize}".intern).from_tags([self])
+      end
+    end
+    
+  end
+end