radiant-reader-extension 0.9.2

data/db/migrate/20090921125653_reader_messages.rb

@@ -0,0 +1,27 @@
+class ReaderMessages < ActiveRecord::Migration
+  def self.up
+    create_table :messages do |t|
+      t.column :site_id, :integer
+      t.column :subject, :string
+      t.column :body, :text
+      t.column :filter_id, :text
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+      t.column :created_by_id, :integer
+      t.column :updated_by_id, :integer
+      t.column :lock_version, :integer
+    end
+
+    create_table :message_readers do |t|
+      t.column :site_id, :integer
+      t.column :message_id, :integer
+      t.column :reader_id, :integer
+      t.column :sent_at, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :messages
+    drop_table :message_readers
+  end
+end

data/db/migrate/20090924164413_functional_messages.rb

@@ -0,0 +1,9 @@
+class FunctionalMessages < ActiveRecord::Migration
+  def self.up
+    add_column :messages, :function, :string
+  end
+
+  def self.down
+    remove_column :messages, :function
+  end
+end

data/db/migrate/20090925081225_standard_messages.rb

@@ -0,0 +1,106 @@
+class StandardMessages < ActiveRecord::Migration
+  def self.up
+    Message.reset_column_information
+    messages = []
+    
+    messages.push(Message.create(
+      :subject => 'Welcome!',
+      :function => 'welcome',
+      :filter_id => nil,
+      :body => %{
+<p>Hello <r:recipient:name />.</p>
+
+<p>Welcome to the <strong><a href="<r:site:url />"><r:site:name /></a></strong> site, and thank you for persevering with the registration process. Your account is now active and you will have been logged in automatically.</p>
+
+<p>You can put in a bit more information about yourself at any time by visiting <a href="<r:recipient:edit_url />">your preferences page</a>.</p>
+
+<p>Next time you visit, you will need to log in. Here's another reminder before we discard the plain text version of your password:</p>
+
+<ul>
+  <li>username: <strong><r:recipient:login /></strong></li>
+  <li>password: <strong><r:recipient:password /></strong></li>
+</ul>
+
+<p>Best wishes,</p>
+
+<p><r:sender:name /></p>
+      }
+    ))
+    
+    messages.push(Message.create(
+      :subject => 'Please activate your account',
+      :function => 'activation',
+      :filter_id => nil,
+      :body => %{
+<p>Hello <r:recipient:name />.</p>
+
+<p>Welcome! Your account has been created at the <strong><r:site:name /></strong> site. To activate it, all you have to do is <strong><a href="<r:recipient:activation_url />">click on this link</a></strong>.</p>
+
+<p>On this first visit you'll be logged in automatically, but next time you'll need to know your username and password:</p>
+
+<ul>
+<li>username: <strong><r:recipient:login /></strong></li>
+<li>password: <strong><r:recipient:password /></strong></li>
+</ul>
+
+<p>To see yourself as others might see you, have a look at <a href="<r:recipient:url />">your page</a>. You can change that listing in your <a href="<r:recipient:edit_url />">preferences</a> and if you'd like a picture to appear, you need a <a href="http://www.gravatar.com/signup">gravatar</a>.</p>
+
+<p>We're about to forget your password, so we won't be able to remind you what it is, but if you get stuck you can always make a new one by clicking on the 'forgot my password' link on the login page.</p>
+
+<p>Best wishes,</p>
+
+<p><r:sender:name /></p>
+      }  
+    ))
+    
+    messages.push(Message.create(
+      :subject => 'You are invited!',
+      :function => 'invitation',
+      :filter_id => nil,
+      :body => %{
+<p>Hello <r:recipient:name />.</p>
+
+<p>You are invited to join the <strong><r:site:name /></strong> site. To accept the invitation, all you have to do is  <strong><a href="<r:recipient:activation_url />">click on this link</a></strong>.</p>
+
+<p>On this first visit you'll be logged in automatically, but next time you'll need to know your username and password. Most of this has been generated automatically:</p>
+
+<ul>
+  <li>username: <strong><r:recipient:login /></strong></li>
+  <li>password: <strong><r:recipient:password /></strong></li>
+</ul>
+
+So you will want to change it in your <a href="<r:recipient:edit_url />">preferences</a>, where you can also edit the text that will appear on your <a href="<r:recipient:url />">listing page</a> whenever someone follows a link from one of your contributions to the site.</p>
+
+<p>Once you've logged in we'll forget your password, so we won't be able to remind you what it is. If you get stuck you can always make a new one by clicking on the 'forgot my password' link on the login page.</p>
+
+<p>Best wishes,</p>
+
+<p><r:sender:name /></p>
+      }  
+    ))
+
+    messages.push(Message.create(
+      :subject => 'Reset your password',
+      :function => 'password_reset',
+      :filter_id => nil,
+      :body => %{
+<p>Hello <r:recipient:name />.</p>
+
+<p>Someone has requested that a new password be generated for your account at the <strong><a href="<r:site:url />"><r:site:name /></a></strong> site. If that person wasn't you, please don't be concerned: you are seeing this message, not they, and your password hasn't changed. You can safely delete this message and forget about it.</p>
+
+<p>If that person was you, please <strong><a href="<r:recipient:repassword_url />">click here to enter a new password</a></strong>. Nothing will actually change until you submit the password-reset form.</p>
+
+<p>If you have remembered your current password and all you want to do is change it, you can skip this step and go straight to your <a href="<r:recipient:edit_url />">preferences</a>.</p>
+      }  
+    ))
+    
+    if admin = User.find_by_admin(true)
+      messages.each do |message|
+        message.update_attribute(:created_by_id, admin.id)
+      end
+    end
+  end
+
+  def self.down
+  end
+end

data/db/migrate/20091006102438_message_visibility.rb

@@ -0,0 +1,9 @@
+class MessageVisibility < ActiveRecord::Migration
+  def self.up
+    add_column :messages, :status_id, :integer, :default => 1
+  end
+
+  def self.down
+    remove_column :messages, :status_id
+  end
+end

data/db/migrate/20091010083503_registration_config.rb

@@ -0,0 +1,10 @@
+class RegistrationConfig < ActiveRecord::Migration
+  def self.up
+    if Radiant::Config['reader.allow_registration?'].nil?
+      Radiant::Config['reader.allow_registration?'] = true
+    end
+  end
+
+  def self.down
+  end
+end

data/db/migrate/20091019124021_message_functions.rb

@@ -0,0 +1,9 @@
+class MessageFunctions < ActiveRecord::Migration
+  def self.up
+    rename_column :messages, :function, :function_id
+  end
+
+  def self.down
+    rename_column :messages, :function_id, :function
+  end
+end

data/db/migrate/20091020133533_forenames.rb

@@ -0,0 +1,9 @@
+class Forenames < ActiveRecord::Migration
+  def self.up
+    add_column :readers, :forename, :string
+  end
+
+  def self.down
+    remove_column :readers, :forename
+  end
+end

data/db/migrate/20091020135152_contacts.rb

@@ -0,0 +1,23 @@
+class Contacts < ActiveRecord::Migration
+  def self.up
+    add_column :readers, :phone, :string
+    add_column :readers, :organisation, :string
+    add_column :readers, :post_building, :string
+    add_column :readers, :post_street, :string
+    add_column :readers, :post_place, :string
+    add_column :readers, :post_town, :string
+    add_column :readers, :post_county, :string
+    add_column :readers, :postcode, :string
+  end
+
+  def self.down
+    remove_column :readers, :phone
+    remove_column :readers, :organisation
+    remove_column :readers, :post_building
+    remove_column :readers, :post_street
+    remove_column :readers, :post_place
+    remove_column :readers, :post_town
+    remove_column :readers, :post_county
+    remove_column :readers, :postcode
+  end
+end

data/db/migrate/20091111090819_ensure_functional_messages_visible.rb

@@ -0,0 +1,9 @@
+class EnsureFunctionalMessagesVisible < ActiveRecord::Migration
+  def self.up
+    Message.reset_column_information
+    Message.administrative.each {|m| m.update_attribute(:status_id, 100)}
+  end
+
+  def self.down
+  end
+end

data/db/migrate/20091119092936_messages_have_layout.rb

@@ -0,0 +1,9 @@
+class MessagesHaveLayout < ActiveRecord::Migration
+  def self.up
+    add_column :messages, :layout_id, :integer
+  end
+
+  def self.down
+    remove_column :messages, :layout_id
+  end
+end

data/db/migrate/20100922152338_lock_versions.rb

@@ -0,0 +1,9 @@
+class LockVersions < ActiveRecord::Migration
+  def self.up
+    add_column :readers, :lock_version, :integer, :default => 0
+  end
+
+  def self.down
+    remove_column :readers, :lock_version
+  end
+end

data/db/migrate/20100927095703_default_settings.rb

@@ -0,0 +1,14 @@
+class DefaultSettings < ActiveRecord::Migration
+  def self.up
+    Radiant::Config['reader.allow_registration?'] ||= true
+    Radiant::Config['reader.require_confirmation?'] ||= true
+    Radiant::Config['site.url'] ||= 'www.example.com'
+    Radiant::Config['site.title'] ||= 'Your site name here'
+    Radiant::Config['reader.mail_from_name'] ||= "Administrator"
+    Radiant::Config['reader.mail_from_address'] ||= "admin@example.com"
+    Radiant::Config['reader.layout'] ||= 'undefined'
+  end
+
+  def self.down
+  end
+end

data/db/migrate/20101004074945_unlock_version.rb

@@ -0,0 +1,9 @@
+class UnlockVersion < ActiveRecord::Migration
+  def self.up
+    remove_column :readers, :lock_version
+  end
+
+  def self.down
+    add_column :readers, :lock_version, :integer, :default => 0
+  end
+end

data/lib/config_extensions.rb

@@ -0,0 +1,5 @@
+module ConfigExtensions    # for inclusion into Radiant::Config
+  def boolean?
+    key.ends_with? "?"
+  end
+end

data/lib/controller_extensions.rb

@@ -0,0 +1,77 @@
+module ControllerExtensions    # for inclusion into ApplicationController
+
+  def self.included(base)
+    
+    base.class_eval do
+      before_filter :set_reader_for_user
+      before_filter :set_reader
+      helper_method :current_reader_session, :current_reader, :current_reader=
+    end
+
+  protected
+
+    def current_reader_session
+      return @current_reader_session if @current_reader_session.is_a?(ReaderSession)
+      @current_reader_session = ReaderSession.find
+      Reader.current = @current_reader_session.record if @current_reader_session
+      @current_reader_session
+    end
+
+    def current_reader_session=(reader_session)
+      @current_reader_session = reader_session
+    end
+
+    def current_reader
+      current_reader_session.record if current_reader_session
+    end
+
+    def current_reader=(reader)
+      if reader && reader.is_a?(Reader)
+        current_reader_session = ReaderSession.create!(reader)
+      else
+        current_reader_session.destroy
+      end
+    end
+    
+    def set_reader_for_user
+      if current_user
+        current_reader_session = ReaderSession.create!(Reader.find_or_create_for_user(current_user))
+      end
+    end
+
+    def set_reader
+      Reader.current = current_reader
+    end
+
+    def store_location(location = request.request_uri)
+      session[:return_to] = location
+    end
+
+    def redirect_back_or_to(default)
+      redirect_to(session[:return_to] || default)
+      session[:return_to] = nil
+    end
+
+    def redirect_back_with_format(format = 'html')
+      address = session[:return_to]
+      raise StandardError, "Can't add format to an already formatted url: #{address}" unless File.extname(address).blank?
+      redirect_to address + ".#{format}"    # nasty! but necessary for inline login.
+    end
+
+    def render_page_or_feed(template_name = action_name)
+      respond_to do |format|
+        format.html { render :action => template_name }
+        format.rss  { render :action => template_name, :layout => 'feed' }
+        format.js  { render :action => template_name, :layout => false }
+      end
+    end
+
+  end
+end
+
+
+
+
+
+
+

data/lib/reader_admin_ui.rb

@@ -0,0 +1,64 @@
+module ReaderAdminUI
+
+ def self.included(base)
+   base.class_eval do
+
+      attr_accessor :reader, :message, :reader_setting
+      alias_method :readers, :reader
+      alias_method :messages, :message
+      alias_method :reader_settings, :reader_setting
+
+      def load_reader_extension_regions
+        reader = load_default_reader_regions
+        message = load_default_message_regions
+        reader_setting = load_default_reader_setting_regions
+      end
+
+      def load_default_regions_with_reader
+        load_default_regions_without_reader
+        load_reader_extension_regions
+      end
+      alias_method_chain :load_default_regions, :reader
+
+    protected
+
+      def load_default_reader_regions
+        returning OpenStruct.new do |reader|
+          reader.edit = Radiant::AdminUI::RegionSet.new do |edit|
+            edit.main.concat %w{edit_header edit_form}
+            edit.form.concat %w{edit_name edit_email edit_username edit_password edit_description edit_notes}
+            edit.form_bottom.concat %w{edit_timestamp edit_buttons}
+          end
+          reader.index = Radiant::AdminUI::RegionSet.new do |index|
+            index.thead.concat %w{title_header description_header modify_header}
+            index.tbody.concat %w{title_cell description_cell modify_cell}
+            index.bottom.concat %w{buttons}
+          end
+          reader.remove = reader.index
+          reader.new = reader.edit
+        end
+      end
+
+      def load_default_reader_setting_regions
+        returning OpenStruct.new do |reader_settings|
+          reader_settings.index = Radiant::AdminUI::RegionSet.new do |index|
+            index.settings.concat %w{registration site sender}
+            index.messages.concat %w{administration}
+          end
+        end
+      end
+
+      def load_default_message_regions
+        returning OpenStruct.new do |message|
+          message.edit = Radiant::AdminUI::RegionSet.new do |edit|
+            edit.main.concat %w{edit_header edit_form edit_footer}
+            edit.form.concat %w{edit_subject edit_body}
+            edit.form_bottom.concat %w{edit_timestamp edit_buttons}
+          end
+          message.new = message.edit
+        end
+      end
+    end
+  end
+end
+

data/lib/reader_helper.rb

@@ -0,0 +1,36 @@
+require 'sanitize'
+module ReaderHelper
+  def self.included(base)
+
+    base.module_eval do
+
+      # wraps the block in a p with the right class and shows the errors nicely, if there are any
+
+      def with_error_report(errors, &block)
+        render({:layout => 'wrappers/field_errors', :locals => {:errors => errors}}, {}, &block)
+      end
+  
+      def clean_textilize(text)
+        Sanitize.clean(textilize(text), Sanitize::Config::RELAXED)
+      end
+
+      def clean_textilize_without_paragraph(text)
+        textiled = clean_textilize(text)
+        if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
+        if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
+        return textiled
+      end
+  
+      def truncate_words(text='', length=64, omission="...")
+        return '' if text.blank?
+        words = text.split
+        omission = '' unless words.size > length
+        words[0..(length-1)].join(" ") + omission
+      end 
+      
+      def truncate_and_textilize(text, length=64)
+        clean_textilize( truncate_words(text, length) )
+      end
+    end
+  end
+end