radiant-reader-extension 2.0.0.rc4 → 3.0.0.rc3

data/lib/reader_tags.rb

@@ -1,12 +1,13 @@
 module ReaderTags
   include Radiant::Taggable
   include ReaderHelper
+  include ActionView::Helpers::TextHelper
   include GroupTags
   include MessageTags
   
   class TagError < StandardError; end
 
-  # I need to find a better way to do this, but this gives a starting point
+  ### standard reader css and javascript is just a starting point.
 
   tag 'reader_css' do |tag|
     %{<link rel="stylesheet" href="/stylesheets/reader.css" media="all" />}
@@ -16,15 +17,63 @@ module ReaderTags
     %{<script type="text/javascript" src="/javascripts/reader.js"></script>}
   end
 
+  ### tags displaying the set of readers
+  
+  desc %{
+    Cycles through the (paginated) list of readers available for display. You can do this on 
+    any page but if it's a ReaderPage you also get some access control and the ability to 
+    click through to an individual reader.
+    
+    Please note that if you use this tag on a normal radiant page, all registered readers
+    will be displayed, regardless of group-based or other access limitations. You really
+    want to keep this tag for ReaderPages and GroupPages.
+    
+    *Usage:* 
+    <pre><code><r:readers:each [limit=0] [offset=0] [order="asc|desc"] [by="position|title|..."] [extensions="png|pdf|doc"]>...</r:readers:each></code></pre>
+  }    
+  tag 'readers' do |tag|
+    tag.expand
+  end
+  tag 'readers:each' do |tag|
+    tag.locals.readers = get_readers(tag)
+    tag.render('reader_list', tag.attr.dup, &tag.block)
+  end
+
+  # General purpose paginated reader lister. Potentially useful dryness.
+  # Tag.locals.readers must be defined but can be empty.
+
+  tag 'reader_list' do |tag|
+    raise TagError, "r:reader_list: no readers to list" unless tag.locals.readers
+    options = tag.attr.symbolize_keys
+    result = []
+    paging = pagination_find_options(tag)
+    readers = paging ? tag.locals.readers.paginate(paging) : tag.locals.readers.all
+    readers.each do |reader|
+      tag.locals.reader = reader
+      result << tag.expand
+    end
+    if paging && readers.total_pages > 1
+      tag.locals.paginated_list = readers
+      result << tag.render('pagination', tag.attr.dup)
+    end
+    result
+  end
+
+  ### Displaying or addressing an individual reader
+  ### See also the r:recipient tags for use in email messages.
+
   desc %{
     The root 'reader' tag is not meant to be called directly.
     All it does is summon a reader object so that its fields can be displayed with eg.
     <pre><code><r:reader:name /></code></pre>
     
-    This will only work on an access-protected page and should never be used on a cached page, because everyone will see it.
+    On a ReaderPage, this will be the reader designated by the url. 
+    
+    Anywhere else, it will be the current reader (ie the one reading), provided
+    we are on an uncached page.
   }
   tag 'reader' do |tag|
-    tag.expand if !tag.locals.page.cache? && tag.locals.reader = Reader.current
+    tag.expand if get_reader(tag)
   end
 
   [:name, :forename, :email, :description, :login].each do |field|
@@ -33,44 +82,8 @@ module ReaderTags
       <pre><code><r:reader:#{field} /></code></pre>
     }
     tag "reader:#{field}" do |tag|
-      tag.locals.reader.send(field)
-    end
-  end
-
-  desc %{
-    Expands if the current reader has been sent any messages.
-    
-    <pre><code><r:reader:if_messages>...</r:reader:if_messages /></code></pre>
-  }
-  tag "reader:if_messages" do |tag|
-    tag.expand if tag.locals.reader.messages.any?
-  end
-
-  desc %{
-    Expands if the current reader has not been sent any messages.
-    
-    <pre><code><r:reader:unless_messages>...</r:reader:unless_messages /></code></pre>
-  }
-  tag "reader:unless_messages" do |tag|
-    tag.expand unless tag.locals.reader.messages.any?
-  end
-
-  desc %{
-    Loops through the messages that belong to this reader (whether they have been sent or not, so at the moment this may include drafts).
-    
-    <pre><code><r:reader:messages:each>...</r:reader:messages:each /></code></pre>
-  }
-  tag "reader:messages" do |tag|
-    tag.locals.messages = tag.locals.reader.messages
-    tag.expand if tag.locals.messages.any?
-  end
-  tag "reader:messages:each" do |tag|
-    result = []
-    tag.locals.messages.each do |message|
-      tag.locals.message = message
-      result << tag.expand
+      tag.locals.reader.send(field) if tag.locals.reader
     end
-    result
   end
   
   desc %{
@@ -80,6 +93,7 @@ module ReaderTags
     <pre><code><r:reader:controls /></code></pre>
   }
   tag "reader:controls" do |tag|
+    # if there's no reader, the reader: stem will not expand to render this tag.
     tag.render('reader_welcome')
   end
   
@@ -88,7 +102,7 @@ module ReaderTags
     If there is no reader, this will show a 'login or register' invitation, provided the reader.allow_registration? config entry is true. 
     If you don't want that, use @r:reader:controls@ instead: the reader: prefix means it will only show when a reader is present.
     
-    If this tag appears on a cached page, we return an empty @<div class="remote_controls">@ into which you can drop whatever you like.
+    If this tag appears on a cached page, we return an empty @<div class="remote_controls">@ suitable for ajaxing.
     
     <pre><code><r:reader_welcome /></code></pre>
   }
@@ -97,38 +111,91 @@ module ReaderTags
       %{<div class="remote_controls"></div>}
     else
       if tag.locals.reader = Reader.current
-        welcome = %{<span class="greeting">Hello #{tag.render('reader:name')}.</span> }
+        welcome = %{<span class="greeting">#{I18n.t('reader_extension.navigation.greeting', :name => reader.name)}</span> }
         links = []
         if tag.locals.reader.activated?
-          links << %{<a href="#{edit_reader_path(tag.locals.reader)}">Preferences</a>}
-          links << %{<a href="#{reader_path(tag.locals.reader)}">Your page</a>}
-          links << %{<a href="/admin">Admin</a>} if tag.locals.reader.is_user?
-          links << %{<a href="#{reader_logout_path}">Log out</a>}
+          links << %{<a href="#{edit_reader_path(tag.locals.reader)}">#{I18n.t('reader_extension.navigation.preferences')}</a>}
+          links << %{<a href="#{reader_path(tag.locals.reader)}">#{I18n.t('reader_extension.navigation.account')}</a>}
+          links << %{<a href="/admin">#{I18n.t('reader_extension.navigation.admin')}</a>} if tag.locals.reader.is_user?
+          links << %{<a href="#{reader_logout_path}">#{I18n.t('reader_extension.navigation.log_out')}</a>}
         else
-          welcome << "Please check your email and activate your account."
+          welcome << I18n.t('reader_extension.navigation.activate')
         end
         %{<div class="controls"><p>} + welcome + links.join(%{<span class="separator"> | </span>}) + %{</p></div>}
       elsif Radiant::Config['reader.allow_registration?']
-        %{<div class="controls"><p><span class="greeting">Welcome!</span> To take part, please <a href="#{reader_login_path}">log in</a> or <a href="#{reader_register_path}">register</a>.</p></div>}
+        %{<div class="controls"><p>#{I18n.t('reader_extension.navigation.welcome_please_log_in', :login_url => reader_login_url, :register_url => new_reader_url)}</p></div>}
       end
     end
   end
     
   desc %{
-    Expands only if there is a reader and we are on an uncached page.
+    Expands if there is a reader and we are on an uncached page.
     
     <pre><code><r:if_reader><div id="controls"><r:reader:controls /></r:if_reader></code></pre>
   }
   tag "if_reader" do |tag|
-    tag.expand if !tag.locals.page.cache? && tag.locals.reader = Reader.current
+    tag.expand if get_reader(tag)
   end
   
   desc %{
-    Expands only if there is no reader or we are not on an uncached page.
+    Expands if there is no reader or we are on a cached page.
     
     <pre><code><r:unless_reader>Please log in</r:unless_reader></code></pre>
   }
   tag "unless_reader" do |tag|
-    tag.expand unless Reader.current && !tag.locals.page.cache?
+    tag.expand unless get_reader(tag)
+  end
+
+  desc %{
+    Truncates the contained text or html to the specified length. Unless you supply a 
+    html="true" parameter, all html tags will be removed before truncation. You probably
+    don't want to do that: open tags will not be closed and the truncated
+    text length will vary.
+    
+    <pre><code>
+      <r:truncated words="30"><r:content part="body" /></r:truncated>
+      <r:truncated chars="100" omission=" (continued)"><r:post:body /></r:truncated>
+      <r:truncated words="100" allow_html="true"><r:reader:description /></r:truncated>
+    </code></pre>
+  }
+  tag "truncated" do |tag|
+    content = tag.expand
+    tag.attr['words'] ||= tag.attr['length']
+    omission = tag.attr['omission'] || '&hellip;'
+    content = scrub_html(content) unless tag.attr['allow_html'] == 'true'
+    if tag.attr['chars']
+      truncate(content, :length => tag.attr['chars'].to_i, :omission => omission)
+    else
+      truncate_words(content, :length => tag.attr['words'].to_i, :omission => omission)   # defined in ReaderHelper
+    end
   end
+  
+  deprecated_tag "truncate", :substitute => "truncated"
+
+private
+
+  def get_reader(tag)
+    tag.locals.reader ||= if tag.attr['id']
+      Reader.find_by_id(tag.attr['id'].to_i)
+    elsif tag.locals.page.respond_to? :reader
+      tag.locals.page.reader
+    elsif !tag.locals.page.cache?
+      Reader.current
+    end
+  end
+
+  def get_readers(tag)
+    attr = tag.attr.symbolize_keys
+    readers = tag.locals.page.respond_to?(:reader) ? tag.locals.page.readers : Reader.scoped({})
+    readers = readers.in_group(group) if group = attr[:group]
+    by = attr[:by] || 'name'
+    order = attr[:order] || 'ASC'
+    readers = readers.scoped({
+      :order => "#{by} #{order.upcase}",
+      :limit => attr[:limit] || nil,
+      :offset => attr[:offset] || nil
+    })
+    readers
+  end
+  
 end

data/lib/site_controller_extensions.rb

@@ -7,13 +7,13 @@ module SiteControllerExtensions
       
       def find_page_with_group_check(url)
         page = find_page_without_group_check(url)
-        raise ReaderGroup::PermissionDenied if page && !page.visible_to?(current_reader)
+        raise ReaderError::AccessDenied if page && !page.visible_to?(current_reader)
         page
       end
         
       def show_page_with_group_check
         show_page_without_group_check
-      rescue ReaderGroup::PermissionDenied
+      rescue ReaderError::AccessDenied
         if current_reader
           flash[:error] = t("reader_extension.access_denied")
           redirect_to reader_permission_denied_url

data/public/stylesheets/sass/reader.sass

@@ -122,3 +122,52 @@ form.friendly
         color: white
         text-decoration: none
     
+.dashboard_module
+  margin-top: 2em
+  &:first-child
+    margin-top: 0
+  ul
+    margin: 1em 0
+    padding-left: 16px
+  h3:first-child
+    margin-top: 0
+
+address
+  width: 75%
+  border: 1px solid $paler
+  padding: 1em
+  margin: 1em -1em
+  +border-radius(5px)
+  
+a.vcard
+  padding-left: 25px
+  background: transparent url(/images/furniture/vcard_tiny.png) no-repeat 0 3px
+  
+h3.vcard
+  padding-left: 40px
+  background: transparent url(/images/furniture/vcard.png) no-repeat 0 3px
+
+a.mailto
+  color: $mid
+  
+.reader
+  margin-bottom: 1em
+  h2
+    margin-bottom: 0
+  .context
+    margin-top: 0
+  
+.column
+  float: left
+  width: 45%
+  margin-right: 3%
+  
+ul.groups
+  padding: 0
+  margin: 0 0 1em 0
+  li
+    margin-right: 1em
+    display: inline
+
+.cleared
+  clear: left

data/radiant-reader-extension.gemspec

@@ -12,10 +12,13 @@ Gem::Specification.new do |s|
   s.summary     = RadiantReaderExtension::SUMMARY
   s.description = RadiantReaderExtension::DESCRIPTION
 
-  s.add_dependency 'radiant-layouts-extension', "~> 0.9.1"
+  s.add_dependency 'radiant-layouts-extension', "~> 1.1.3"
   s.add_dependency 'radiant-mailer_layouts-extension', "~> 0.1.1"
   s.add_dependency 'authlogic', "~> 2.1.6"
   s.add_dependency 'sanitize', "~> 2.0.1"
+  s.add_dependency 'snail', "~> 0.5.5"
+  s.add_dependency 'vcard', "~> 0.1.1"
+  s.add_dependency 'fastercsv', "~> 1.5.4"
 
   ignores = if File.exist?('.gitignore')
     File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }

data/reader_extension.rb

@@ -7,8 +7,11 @@ class ReaderExtension < Radiant::Extension
   url RadiantReaderExtension::URL
   
   extension_config do |config|
-    config.gem "authlogic"
-    config.gem 'sanitize'
+    config.gem 'authlogic', :version => "~> 2.1.6"
+    config.gem 'sanitize', :version => "~> 2.0.1"
+    config.gem 'snail', :version => "~> 0.5.5"
+    config.gem 'vcard', :version => "~> 0.1.1"
+    config.gem 'fastercsv', :version => "~> 1.5.4"
   end
   
   migrate_from 'Reader Group', 20110214101339
@@ -37,7 +40,7 @@ class ReaderExtension < Radiant::Extension
       add_item("Settings", "/admin/readers/reader_configuration")
     end
     tab("Settings") do
-      add_item("Reader", "/admin/readers/reader_configuration")
+      add_item("Readers", "/admin/readers/reader_configuration")
     end
   end
   
@@ -46,11 +49,8 @@ class ReaderExtension < Radiant::Extension
   end
 end
 
-module ReaderGroup
-  class Exception < StandardError
-    def initialize(message = "Sorry: group problem"); super end
-  end
-  class PermissionDenied < Exception
-    def initialize(message = "Sorry: you don't have access to that"); super end
+module ReaderError
+  class AccessDenied < StandardError
+    def initialize(message = "Sorry: you have to log in to see that"); super end
   end
 end

data/spec/controllers/{readers_controller_spec.rb → accounts_controller_spec.rb}

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe ReadersController do
+describe AccountsController do
   dataset :readers
   
   before do
@@ -32,8 +32,12 @@ describe ReadersController do
     end
   end
   
+  describe "listing readers" do
+    it "should respond to csv requests"
+    it "should respond to vcard requests"
+  end
+  
   describe "with a registration" do
-    
     describe "that validates" do
       before do
         session[:email_field] = 'gibberish'
@@ -115,11 +119,11 @@ describe ReadersController do
       end
   
       it "should route '/account' to my account" do
-        params_from(:get, '/account').should == {:controller => 'readers', :action => 'edit'}
+        params_from(:get, '/account').should == {:controller => 'accounts', :action => 'edit'}
       end
 
       it "should route '/profile' to my account" do
-        params_from(:get, '/profile').should == {:controller => 'readers', :action => 'show'}
+        params_from(:get, '/profile').should == {:controller => 'accounts', :action => 'show'}
       end
 
       it "should consent to show another reader page" do 
@@ -178,7 +182,7 @@ describe ReadersController do
 
       it "should redirect to the reader page" do 
         response.should be_redirect
-        response.should redirect_to(reader_url(@reader))
+        response.should redirect_to(dashboard_url)
       end
       
     end

data/spec/controllers/groups_controller_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe GroupsController do
+  dataset :readers
+  
+  before do
+    controller.stub!(:request).and_return(request)
+    Page.current_site = sites(:test) if defined? Site
+    Radiant::Config['reader.allow_registration?'] = true
+  end
+    
+  describe "listing groups" do
+    it "should respond to csv requests"
+    it "should respond to vcard requests"
+  end
+
+end

data/spec/controllers/reader_activations_controller_spec.rb

@@ -21,9 +21,9 @@ describe ReaderActivationsController do
       @reader.activated_at.should be_close((Time.now).utc, 1.minute)
     end
 
-    it "should show the show page" do
-      response.should be_success
-      response.should render_template("show")
+    it "should redirect to the dashboard" do
+      response.should be_redirect
+      response.should redirect_to(dashboard_url)
     end
   end
 

data/spec/datasets/readers_dataset.rb

@@ -5,6 +5,8 @@ class ReadersDataset < Dataset::Base
   uses :users, :pages
 
   def load
+    create_page "People", :slug => "directory", :class_name => 'ReaderPage'
+    
     create_reader "Normal"
     create_reader "Another"
     create_reader "Visible"
@@ -90,6 +92,7 @@ From <r:sender:name />
     def default_group_attributes(name="Group")
       attributes = { 
         :name => name,
+        :slug => name.downcase,
         :description => "#{name} group"
       }
       attributes[:site_id] ||= site_id(:test) if defined? Site

data/spec/lib/reader_tags_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Reader Tags" do
+  dataset :readers
+
+  let(:person){ readers(:normal) }
+  let(:another){ readers(:another) }
+  let(:page){ pages(:first) }
+  
+  describe "r:readers tags" do
+    subject { page }
+    it { should render(%{<r:readers:each><r:reader:name /></r:readers:each>}).as(Reader.all.map(&:name).join('')) }
+  end
+
+  describe "r:reader tags" do 
+    describe "on a ReaderPage" do
+      before do
+        @page = pages(:people)
+        @page.stub!(:reader).and_return(person)
+      end
+      subject { @page }
+      it { should render(%{<r:reader:name />}).as(person.name) }
+      it { should render(%{<r:if_reader>hello</r:if_reader>}).as('hello') }
+      it { should render(%{<r:unless_reader>hello</r:unless_reader>}).as('') }
+      [:name, :forename, :email, :description, :login].each { |field| it { should render(%{<r:reader:#{field} id="#{person.id}" />}).as(person.send(field)) } }
+    end
+
+    describe "on an uncached page" do
+      before do
+        @uncached_page = pages(:another)
+        @uncached_page.stub!(:cache?).and_return(false)
+        Reader.stub!(:current).and_return(readers(:another))
+      end
+      subject { @uncached_page }
+      it { should render(%{<r:reader:name />}).as(another.name) }
+      it { should_not render(%{<r:reader:welcome />}).as('') }
+    end
+
+    describe "on a cached page" do
+      subject { page }
+      it { should render(%{<r:reader:name />}).as('') }
+      it { should render(%{<r:reader:welcome />}).as('') }
+      it { should render(%{<r:reader_welcome />}).as(%{<div class="remote_controls"></div>}) }
+      [:name, :forename, :email, :description, :login].each { |field| it { should render(%{<r:reader id="#{another.id}"><r:#{field} /></r:reader>}).as(another.send(field)) } }
+    end
+  end
+
+  describe "utility tags" do 
+    subject { page }
+    it { should render(%{<r:truncated chars="50">All happy families are alike; each unhappy family is unhappy in its own way.</r:truncated>}).as(' All happy families are alike; each unhapp&hellip;') }
+    it { should render(%{<r:truncated words="5" omission="">All happy families are alike; each unhappy family is unhappy in its own way.</r:truncated>}).as('All happy families are alike;') }
+    it { should render(%{<r:truncated words="5" allow_html="true" omission=" (tbc)">All <em>happy families</em> are alike; each unhappy family is unhappy in its own way.</r:truncated>}).as('All <em>happy families</em> are alike; (tbc)') }
+  end
+
+end

data/spec/matchers/reader_login_system_matcher.rb

@@ -10,13 +10,13 @@ module Spec
           proc.call
           @response = @example.response
           @was_redirect = @response.redirect?
-          @was_redirect_to_login = @response.redirect_url_match?("/readers/login")
+          @was_redirect_to_login = @response.redirect_url_match?("/login")
           @was_redirect && @was_redirect_to_login
         end
 
         def failure_message
           if @was_redirect
-            "expected to redirect to /readers/login but redirected to #{@response.redirect_url}"
+            "expected to redirect to /login but redirected to #{@response.redirect_url}"
           else
             "expected to require reader login but did not redirect"
           end

data/spec/models/group_spec.rb

@@ -43,4 +43,10 @@ describe Group do
     group.pages.any?.should be_true
     group.pages.size.should == 2
   end
+  
+  it "should give itself a slug if none is present" do
+    g = Group.new(:name => 'testy group')
+    g.valid?.should be_true
+    g.slug.should == 'testy-group'
+  end
 end

data/spec/models/reader_page_spec.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ReaderPage do
+  dataset :readers
+  activate_authlogic
+  
+  let(:page) { Page.find_by_path('/directory') }
+  let(:page_with_group) { Page.find_by_path('/directory/normal') }
+  let(:page_with_reader) { Page.find_by_path("/directory/#{reader_id(:normal)}") }
+  let(:page_with_reader_and_group) { Page.find_by_path("/directory/special/#{reader_id(:another)}") }
+  
+  it "should be a Page" do
+    page.is_a?(Page).should be_true
+  end
+  
+  describe "reading parameters" do
+    before do
+      Radiant.config['readers.public?'] = true
+    end
+
+    it "should interrupt the find_by_path cascade" do
+      page.should == pages(:people)
+      page.should == pages(:people)
+      page_with_reader_and_group.is_a?(ReaderPage).should be_true
+      page.reader.should be_nil
+      page.group.should be_nil
+    end
+
+    it "should read a group slug parameter" do
+      page_with_group.group.should == groups(:normal)
+      page_with_reader_and_group.group.should == groups(:special)
+      page_with_reader.group.should be_nil
+    end
+
+    it "should read a reader id parameter" do
+      page_with_reader.reader.should == readers(:normal)
+      page_with_reader_and_group.reader.should == readers(:another)
+      page_with_group.reader.should be_nil
+    end
+    
+    it "should take exception to mismatched reader and group" do
+      lambda { Page.find_by_path("/directory/special/#{reader_id(:ungrouped)}") }.should raise_error(ActiveRecord::RecordNotFound)
+    end
+    
+    it "should list readers and groups" do
+      page.readers.should =~ Reader.all
+      page.groups.should =~ Group.all
+    end
+  end
+  
+  describe "when the readership is private" do
+    before do
+      Radiant.config['readers.public?'] = false
+    end
+    
+    describe "and no reader is logged in" do
+      before do
+        logout_reader
+        Reader.current = nil
+      end
+      
+      it "should deny access completely" do
+        lambda { Page.find_by_path("/directory") }.should raise_error(ReaderError::AccessDenied)
+        lambda { Page.find_by_path("/directory/normal") }.should raise_error(ReaderError::AccessDenied)
+      end
+    end
+    
+    describe "and a reader is logged in" do
+      before do
+        Reader.current = login_as_reader(readers(:normal))
+      end
+      
+      it "should allow access to the reader list" do
+        lambda { Page.find_by_path("/directory") }.should_not raise_error
+      end
+
+      it "should allow access to a group" do
+        lambda { Page.find_by_path("/directory/normal").group.should == groups(:normal) }.should_not raise_error
+      end
+
+      it "should allow access to a reader" do
+        lambda { Page.find_by_path("/directory/#{reader_id(:normal)}").reader.should == readers(:normal) }.should_not raise_error
+      end
+
+      describe "but confined to his groups" do
+        before do
+          Radiant.config['readers.confine_to_groups?'] = true
+          Reader.current = login_as_reader(readers(:normal))
+        end
+
+        it "should allow access only to readers with group overlap" do
+          lambda { Page.find_by_path("/directory/#{reader_id(:inactive)}").reader.should == readers(:inactive) }.should_not raise_error
+          lambda { Page.find_by_path("/directory/#{reader_id(:another)}") }.should raise_error
+        end
+
+        it "should allow access only to groups to which the reader belongs" do
+          lambda { Page.find_by_path("/directory/normal") }.should_not raise_error
+          lambda { Page.find_by_path("/directory/special") }.should raise_error(ReaderError::AccessDenied)
+          Page.find_by_path("/directory").groups.should =~ [groups(:normal), groups(:homed)]
+          Page.find_by_path("/directory").readers.should =~ (groups(:normal).readers + groups(:homed).readers).uniq
+        end
+      end
+
+    end
+  end
+end