radiant-banner_rotator-extension 1.0.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/plugins/make_resourceful"]
+	path = vendor/plugins/make_resourceful
+	url = git://github.com/hcatlin/make_resourceful.git

data/HELP.textile

@@ -0,0 +1,87 @@
+The *Banner Rotator* extension, as its name implies, enables rotating banners on pages.  Banners can be enabled and disabled for specific pages via the page-edit admin interface.  One banner can be assigned to any number of pages.  Banners are randomly selected based on weights you assign, between 1 and 10 - 1 being least likely, 10 most likely to appear.  Banner rotation is enabled for a page in the "meta" drawer on the page-edit screen.  When not directly associated with a page with banner rotator enabled, banners are inherited from the nearest ancestor page.  Banners work by specifying a background image, with optional foreground image and link.
+
+This extension does not support file uploads, and therefore should be used in concert with an asset management extension if direct file upload access is not available.
+
+h2. Usage
+
+h3. Viewing Banners
+
+The banner tab appears under *Content*, to the right of Pages.  Clicking that tab takes you to the Banners Index view.  You may filter the listed banners by showing All, Active only, or Inactive only (controls upper left).  
+
+Default sorting is in alphabetical order by name, but you may also sort by the names of the pages to which they are assigned (upper right).
+
+The default index view filter and sorting also includes pagination.
+
+h4. Index View Actions
+
+* Edit a banner - click on the banner thumbnail or Name
+* Remove a banner - click 'Remove'.  You will see a warning page advising you that deletion is permanent, and will remove the banner from all pages to which it is assigned.
+* Deactivate a banner - click 'Deactivate'.  You will see a warning page advising you that the banner will not be deleted, but it will be removed from all pages to which it is assigned.
+
+h3. Creating or Editing a Banner
+
+* To create a new banner, click the New Banner button at the lower left of the Index page.
+* To edit an existing banner, click the banner thumbnail or name.
+
+h4. Banner Fields
+
+* Required fields are _Name_ and _Background Image_
+* You may optionally add _Description_, _Foreground Image_, _Link URL_, and _Image Style_
+* You may specify the target for the link as the default '_blank' for a new window, or '_top' for the same window
+
+h3. Assigning Banners to pages
+
+Use the 'Assigned Pages' control to add a banner to specific page(s).  Assign a selection weight of 1-10 (1 is low, 10 is high).  1 is the default.  Statistically a banner with a weight of 10 will appear approximately 10 times more often than a banner with a weight of one.
+
+h4. Enabling Banner rotation on a page
+
+* On the Page edit screen for a specific page, check the "Enable Banner Rotator" checkbox.
+* If banners have been assigned to this page, their thumbnails will be displayed after "Banners Assigned".  Each thumbnail is also a link to the Edit page for that banner.
+* If no banners have been assigned, then thumbnails from the inherited banners will be displayed after "Banners Inherited".  These are also link to banner-edit.
+
+h4. Disabling Banner rotation
+
+* Simply uncheck the "Enable Banner Rotation" checkbox on the Page edit screen.
+* You can leave all existing banner assignments in place.  If you re-enable banner rotation, these will all be in the rotation again.
+
+h3. Using the Radius tags to display your banners
+
+In your Layout, Snippet, or Page, you use the <r:banner> Radius tags to set up your rotating banners.  
+
+Within the @<r:banner>@ tag, you do need to prefix your tags, e.g. you can use @<r:background_image />@ instead of @<r:banner:background_image />@
+
+h4. Simple banner rotator using a link
+
+Clicking on the banner links to the link_url defined with the banner.
+
+<pre><code>
+<div class="banner_rotator"
+  <r:banner>
+    <a href='<r:link_url />'> <img src='<r:background_image />'/> </a>
+  </r:banner>
+</div>
+</code></pre>
+
+
+h4. Banner rotator using a link, which will display banners with foreground image, if present
+
+Note the that image style is applied to the foreground image.  This way you position the foreground image relative to the background image, e.g. by defining the banner with image style "left: 100px" the foreground image is superimposed 100 pixel from the left border of the background image.
+
+<pre><code>
+<div class="banner_rotator"
+  <r:banner>
+    <r:if_foreground_image>
+      <div style="background: url(<r:background_image />) top left no-repeat;">  
+        <a href="<r:link_url />" target="<r:link_target/>">
+          <img src="<r:foreground_image />" alt="" style="<r:image_style />" />
+        </a>
+      </div>
+    </r:if_foreground_image>
+    <r:unless_foreground_image>
+      <a href="<r:link_url />" target="<r:link_target/>" >
+        <img src="<r:background_image />" alt="" />
+      </a>
+    </r:unless_foreground_image>
+  </r:banner>
+</div>
+</code></pre>

data/README.textile

@@ -0,0 +1,68 @@
+h1. Banner Rotator
+
+The *Banner Rotator* extension, as its name implies, enables rotating banners on pages.  Banners can be enabled and disabled for specific pages via the page-edit admin interface.  One banner can be assigned to any number of pages.  Banners are randomly selected based on weights you assign, between 1 and 10 - 1 being least likely, 10 most likely to appear.  Banner rotation is enabled for a page in the "meta" drawer on the page-edit screen.  When not directly associated with a page with banner rotator enabled, banners are inherited from the nearest ancestor page.  Banners work by specifying a background image, with optional foreground image and link.
+
+This extension does not support file uploads, and therefore should be used in concert with an asset management extension if direct file upload access is not available.
+
+h2. History
+
+* 2011-04-06 - add help doc, expand README, move banner list out of drawer, add pagination to index, other UI tweaks, gemify 1.0.0 release
+* 2010-12-30 - 0.9 compatibility, blade UI, i18n
+* 2010-11-17 - enabled admin ability to protect certain banners from deletion, by adding comma-delimited banner names to Radiant::Config['admin.protected_banners']
+* 2009-06-22 - Deactivate banner functionality removes a banner from all pages
+* 2009-02-07 - 0.7 compatible
+* 2008-10-01 - First release
+
+h2. Installation
+
+h3. From the Radiant Extension Registry
+
+# From your RAILS_ROOT run:
+<pre>script/extension install banner_rotator</pre>
+# Restart your app
+NOTE: In some earlier versions of Radiant, the migrations may not run, and the assets may not be copied and you may therefore need to run:
+<pre>rake radiant:extensions:banner_rotator:migrate
+rake radiant:extensions:banner_rotator:update</pre>
+
+h3. From Github
+
+# From your RAILS_ROOT run:
+<pre>cd vendor/extensions
+git clone git://github.com/avonderluft/radiant-banner_rotator-extension.git ./banner_rotator
+cd ../../
+rake radiant:extensions:banner_rotator:migrate
+rake radiant:extensions:banner_rotator:update
+</pre>
+# Restart your app
+
+h3. Using the gem
+
+# Install the gem
+<pre>gem install radiant-banner_rotator-extension</pre>
+# Update your Radiant config:  add to environment.rb with other gem.configs
+<pre>config.gem 'radiant-banner_rotator-extension', :lib => false</pre>
+# Run database migrations
+<pre>rake db:migrate:extensions</pre>
+# Copy assets
+<pre>rake radiant:extensions:update_all</pre>
+# Restart your app
+
+h2. Usage
+
+See HELP doc
+
+h2. To do
+
+* Extend pagination to other index views
+* javascript image popup in index view
+* Make banners and banner placements draftable via the concurrent_draft extension
+
+h2. Contributors
+
+* Sean Cribbs
+* Andrew vonderLuft
+* Jeffrey Jones
+
+h2. Acknowledgments
+
+Thanks to "Con-way":http://www.con-way.com for funding the initial development of this extension.

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-banner_rotator-extension"
+    gem.summary = %Q{Banner Rotator Extension for Radiant CMS}
+    gem.description = %Q{Allows addition and independent management of rotating banners on pages.}
+    gem.email = "avonderluft@avlux.net"
+    gem.homepage = "https://github.com/avonderluft/radiant-banner_rotator-extension"
+    gem.authors = ['Andrew vonderLuft','Sean Cribbs']
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package banner_rotator as a gem."
+end
+
+# I think this is the one that should be moved to the extension Rakefile template
+
+# 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 'spec/translator'
+
+# 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
+
+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
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # 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 banner_rotator extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BannerRotatorExtension'
+  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 banner_rotator 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/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/admin/banners_controller.rb

@@ -0,0 +1,61 @@
+class Admin::BannersController < Admin::ResourceController
+  model_class Banner
+  # TODO: Find out why the banner_placements are only updated when one is added.
+  paginate_models
+  login_required
+  only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy, :deactivate, :remove_all_placements!,
+    :when => [:designer, :admin],
+    :denied_url => { :controller => 'admin/pages', :action => 'index' },
+    :denied_message => 'You must have designer privileges to perform this action.'
+
+  before_filter :check_cookie, :only => [:index]
+  skip_after_filter :clear_model_cache, :only => [:destroy]
+
+  def check_cookie
+    unless params[:sort]
+      params[:sort] = cookies['banner_sort'] ? cookies['banner_sort'] : 'name'
+    end
+    %w(active inactive).each do |view|
+      if cookies['banner_view'] == view && params[:view] != view
+        flash.keep
+        redirect_to :view => view and return
+      end
+    end
+  end
+
+  def deactivate
+    @banner = Banner.find(params[:id])
+    case true
+      when request.post? && @banner.unprotected?
+        @banner.remove_all_placements!
+        redirect_to admin_banners_url
+      when @banner.protected?
+        flash[:error] = @banner.cannot_be_deactivated_msg
+        redirect_to admin_banners_url
+      else
+        response_for :deactivate
+    end
+  end
+
+  def remove
+    @banner = Banner.find(params[:id])
+    if @banner.unprotected?
+      response_for :remove
+    else
+      flash[:error] = @banner.cannot_be_removed_msg
+      redirect_to admin_banners_url
+    end
+  end
+
+  def destroy
+    @banner = Banner.find(params[:id])
+    if @banner.unprotected?
+      super
+      clear_model_cache
+    else
+      flash[:error] = @banner.cannot_be_removed_msg
+      redirect_to admin_banners_url
+    end
+  end
+
+end

data/app/helpers/admin/banners_helper.rb

@@ -0,0 +1,62 @@
+module Admin::BannersHelper
+
+  def link_or_span_unless_current(params, text, url, options)
+    if options[:id] == params[options[:param]]
+      content_tag(:span, text)
+    else
+      link_to text, url, options
+    end
+  end
+
+  def pages_for_select
+    @pages_for_select ||= begin
+      collect_children = lambda do |page|
+        [page] + (page.children.any? ? page.children.map(&collect_children) : [])
+      end
+      collect_children[Page.find_by_parent_id(nil)].flatten.uniq.map do |page|
+        name = page.parent ? "#{'--' * page.ancestors.size} #{page.title}" : page.title
+        [name, page.id]
+      end
+    end
+  end
+  
+  def updated_stamp(model)
+    unless model.new_record?
+      updated_by = (model.updated_by || model.created_by) if model.respond_to?(:updated_by)
+      login = updated_by ? updated_by.login : nil
+      time = (model.updated_at || model.created_at)
+      # promoted_at = model.draft_promoted_at if model.respond_to?(:draft_promoted_at)
+      html = %{<p style="clear: left"><small>}
+      if login or time
+        html << 'Last updated ' 
+        html << %{by #{login} } if login
+        html << %{at #{ timestamp(time) }} if time
+        html << '. '
+      end
+      # if promoted_at
+      #   html << %{Last promoted at #{ timestamp(promoted_at) }.}
+      # end
+      html << %{</small></p>}
+      html
+    else
+      %{<p class="clear">&nbsp;</p>}
+    end
+  end
+
+  def banner_edit_javascripts
+    <<-CODE
+      var AddSelector = Behavior.create({
+        initialize: function(type){
+          this.template = $(type + '_select_template');
+        },
+        onclick: function(event) {
+          event.stop();
+          var newField = new Element("p").update(this.template.innerHTML);
+          this.element.up("div").insert(newField);
+        }
+      });
+      Event.addBehavior({ '#add-page-link': AddSelector('placement')});
+    CODE
+  end
+
+end

data/app/models/banner.rb

@@ -0,0 +1,101 @@
+class Banner < ActiveRecord::Base
+
+  # Default Order & Custome scopes
+  default_scope :order => "name"
+
+  # Associations
+  has_many :banner_placements, :dependent => :destroy
+  has_many :pages, :through => :banner_placements
+
+  # Validations
+  validates_presence_of :name, :background_image
+
+  attr_writer :placements
+  after_save :create_placements
+
+  %w(removed deactivated).each do |action|
+    method_name = "cannot_be_#{action}_msg".to_sym
+    send :define_method, method_name do
+      "Foot-shooting protection enabled:  The '#{name}' banner cannot be #{action}. Contact a site administrator if you have questions."
+    end
+  end
+
+  def placements
+    @placements || banner_placements
+  end
+
+  def active?
+    banner_placements.size > 0
+  end
+
+  def inactive?
+    ! active?
+  end
+  
+  def protected?
+    if name.downcase.include?('protected')
+      true
+    else
+      protected_banners = []
+      if Radiant::Config['admin.protected_banners']
+        protected_banners = Radiant::Config['admin.protected_banners'].split(',').map { |b| b.downcase.strip }
+      end
+      protected_banners.include?(name.downcase)
+    end
+  end
+
+  def unprotected?
+    ! protected?
+  end
+
+  def self.find_all_by_pages
+    self.find_active_by_pages.concat(self.find_inactive)
+  end
+  
+  def self.find_active
+    @banners = []
+    self.find(:all, :order => "name asc").each do |banner|
+      @banners << banner if banner.active?
+    end
+    @banners
+  end
+  
+  def self.find_active_by_pages
+    self.find_active.sort { |a,b| a.pages[0].breadcrumb <=> b.pages[0].breadcrumb }
+  end
+
+  def self.find_inactive
+    @banners = []
+    self.find(:all, :order => "name asc").each do |banner|
+      @banners << banner if banner.inactive?
+    end
+    @banners
+  end
+
+  def self.total_count
+    self.find(:all).size
+  end
+
+  def self.total_active_count
+    self.find_active.size
+  end
+
+  def self.total_inactive_count
+    self.find_inactive.size
+  end
+  
+  def remove_all_placements!
+    banner_placements.each { |placement| placement.destroy }
+  end
+
+  private
+    def create_placements
+      self.banner_placements.clear
+      if @placements
+        @placements.each do |hash|
+          self.banner_placements.create(hash)
+        end
+      end
+      @placements = nil
+    end
+end