first version of code

very simple!

README.markdown

@@ -1,8 +1,21 @@
-Promotions
-==========
+= Promotions
+
+Basic support for selecting a group of products to highlight
+
+- usage
+
+set promotions by calling "Promotions.create :product => some_prod" in the 
+console etc (no nice admin interface yet)
+
+call Promotions.random_subset(n) to get n products
+
+
+- implementation etc
+
+at present: just a table of ids, with no uniqueness checking
+
+please see the TODO list
 
-Provides basic support for highlighting products, eg for a front page 
 
-Currently experimental, as I migrate to 0.6.x
 
 

Rakefile

@@ -0,0 +1,120 @@
+# 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? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require File.dirname(ENV["SPREE_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/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(SPREE_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the SPREE_ROOT constant so specs will load the environment
+Object.send(:remove_const, :SPREE_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 promotions extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PromotionsExtension'
+  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 promotions 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 }

TODO

@@ -0,0 +1,11 @@
+
+0. admin interface
+   flag on each product? or drop-down list?
+
+1. get top N products in terms of popularity (from order data)
+
+2. filter this by taxons??
+
+3. maybe extend to "also bought"?
+
+

app/controllers/promotions_controller.rb

@@ -0,0 +1,2 @@
+class PromotionsController < ApplicationController
+end

app/helpers/promotions_helper.rb

@@ -0,0 +1,2 @@
+module PromotionsHelper
+end

app/models/promotions.rb

@@ -0,0 +1,11 @@
+class Promotions < ActiveRecord::Base
+  belongs_to :product
+
+  def self.random_subset(n)
+    # randomize a small list, courtesy of
+    # http://redcorundum.blogspot.com/2006/12/randomizing-array-and-other-faqs.html
+    promos = n <= 0 ? [] : Promotions.find(:all).sort_by {rand}[0..n-1]
+    promos.map {|p| p.product }
+  end 
+
+end

db/migrate/20081017005121_create_promotions.rb

@@ -0,0 +1,12 @@
+class CreatePromotions < ActiveRecord::Migration
+  def self.up
+    create_table :promotions do |t|
+      t.integer :product_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :promotions
+  end
+end

lib/tasks/promotions_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :spree do
+  namespace :extensions do
+    namespace :promotions do
+      desc "Copies public assets of the Promotions to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[PromotionsExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(PromotionsExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

promotions_extension.rb

@@ -0,0 +1,23 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application'
+
+class PromotionsExtension < Spree::Extension
+  version "1.0"
+  description "select a subset of products for front-page display"
+  url "http://yourwebsite.com/promotions"
+
+  # define_routes do |map|
+  #   map.namespace :admin do |admin|
+  #     admin.resources :whatever
+  #   end  
+  # end
+
+  def activate
+    # admin.tabs.add "Promotions", "/admin/promotions", :after => "Layouts", :visibility => [:all]
+  end
+
+  def deactivate
+    # admin.tabs.remove "Promotions"
+  end
+
+end

spec/controllers/promotions_controller_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe PromotionsController do
+
+  #Delete this example and add some real ones
+  it "should use PromotionsController" do
+    controller.should be_an_instance_of(PromotionsController)
+  end
+
+end

spec/helpers/promotions_helper_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe PromotionsHelper do
+
+  #Delete this example and add some real ones or delete this file
+  it "should include the PromotionsHelper" do
+    included_modules = self.metaclass.send :included_modules
+    included_modules.should include(PromotionsHelper)
+  end
+
+end

spec/models/promotions_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Promotions do
+  before(:each) do
+    @promotions = Promotions.new
+  end
+
+  it "should be valid" do
+    @promotions.should be_valid
+  end
+end

spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

spec/spec_helper.rb

@@ -0,0 +1,37 @@
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require ENV["SPREE_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{SPREE_ROOT}/spec/spec_helper"
+
+if File.directory?(File.dirname(__FILE__) + "/scenarios")
+  Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+end
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end