Rails3 ready, fixed hooks, new button icons

LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.markdown

@@ -1,22 +1,24 @@
 # Highlight Products
 
-This is an extension for [Spree][1], put together by [jomz][2]
+This is an extension for [Spree][1], put together by [jomz][2] and upgraded for Rails 3 by [joshmcarthur][5]
 
 This extension makes it possible to 'highlight' certain products that you can then easily show on the homepage for example. Highlighting a product updates a newly added timestamp on the Product model. There is also a named scope Product.highlighted, which selects all products that have been highlighted, and orders them so that the first in the result is the last one highlighted. There is no 'unhighlight' button.
 
 I started off with [paulcc's promotions extension][3], but the only thing left of it is the best\_sellers method, which I moved to the Product model..
 There is an [other extension also called promotions][4], which better deserves the name, as it's about actual promotions (lowered prices), and not about promoting something to the home page.
 
 ## Installation
+* Add extension to your Gemfile `gem 'highlight_products', :git => 'https://github.com/3months/spree-highlight_products.git', :branch => 'rails3'`
+* Run `bundle install`
+* Copy migrations and assets to your application by running `rake highlight_products:install`
+* Run `rake db:migrate` to update your schema, and reboot the server.
 
-Copy to your project's vendor/extensions dir, and make sure the naming is right (remove the 'spree-' prefix).
-Run rake db:migrate.
-Reboot the server.
 
 [1]: http://spreecommerce.com/ "Spree: Open Source E-Commerce for Ruby on Rails"
 [2]: http://hardcoreforkingaction.com "Hard-core forking action: a low frequency, web-tech blog by Benny Degezelle"
 [3]: http://github.com/paulcc/spree-promotions/network "Promotions extension by Paul Callaghan"
 [4]: http://ext.spreecommerce.com/extensions/46-promotions "Promotions extension by Marcin Raczkowski"
+[5]: http://www.github.com/joshmcarthur
 
 ## Usage
 

Rakefile

@@ -1,120 +1,31 @@
-# 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 File.expand_path('../../config/application', __FILE__)
 
+require 'rubygems'
 require 'rake'
-require 'rake/rdoctask'
 require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
 
-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"
+spec = eval(File.read('highlight_products.gemspec'))
 
-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']
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
 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
+desc "Release to gemcutter"
+task :release => :package do
+  require 'rake/gemcutter'
+  Rake::Gemcutter::Tasks.new(spec).define
+  Rake::Task['gem:push'].invoke
 end
 
-desc 'Generate documentation for the highlight products extension.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'HighlightProductsExtension'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+desc "Default Task"
+task :default => [ :spec ]
 
-# For extensions that are in transition
-desc 'Test the highlight product extension.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-# Load any custom rakefiles for extension
-Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }
+# require 'cucumber/rake/task'
+# Cucumber::Rake::Task.new do |t|
+#   t.cucumber_opts = %w{--format pretty}
+# end

app/views/admin/products/_highlight_product_button.html.erb

@@ -1,12 +1,9 @@
 <% if product.highlighted_at.blank? %>
-  <%= link_to highlight_admin_product_url(product), :class => 'icon-link', :method => :post do -%>
-    <%= image_tag "arrow_up.png", :size => "16x16" -%>
-    <%= t("highlight_products.do_highlight") -%>
+  <%= link_to highlight_admin_product_url(product), :class => 'icon-link' do -%>
+    <%= image_tag "highlight_off.png", :size => "16x16", :title => t("highlight_products.do_highlight") -%>
   <% end unless product.deleted? -%>
 <% else %>
-  <%= link_to unhighlight_admin_product_url(product), :class => 'icon-link', :method => :post do -%>
-    <%= image_tag "arrow_up.png", :size => "16x16" -%>
-    <%= t("highlight_products.do_unhighlight") -%>
+  <%= link_to unhighlight_admin_product_url(product), :class => 'icon-link' do -%>
+    <%= image_tag "highlight_on.png", :size => "16x16", :title => t("highlight_products.do_unhighlight") -%>
   <% end unless product.deleted? -%>
-<% end %>
-
+<% end %>

config/routes.rb

@@ -1,3 +1,10 @@
-map.namespace :admin do |admin|
-  admin.resources :products, :member => {:highlight => :post, :unhighlight => :post}
-end
+Rails.application.routes.draw do
+  namespace :admin do
+    resources :products do
+      member do
+        get 'highlight'
+        get 'unhighlight'
+      end
+    end
+  end
+end

highlight_products.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'highlight_products'
+  s.version     = '1.0.0'
+  s.summary     = 'Spree extension, simple way to select products to highlight.'
+  #s.description = 'Add (optional) gem description here'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author            = 'jomz, priidikvaikla, joshmcarthur'
+
+
+  s.files        = Dir['CHANGELOG', 'README.md', 'LICENSE', 'lib/**/*', 'app/**/*']
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.has_rdoc = true
+
+  s.add_dependency('spree_core', '>= 0.30.1')
+end
+

lib/highlight_products.rb

@@ -0,0 +1,23 @@
+require 'spree_core'
+require 'highlight_products_hooks'
+
+module HighlightProducts
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+
+      #Include code
+      Admin::ProductsController.send(:include, HighlightProducts::AdminProductsControllerExt)
+      Product.send(:include, HighlightProducts::ProductModelExt)
+
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end
+

lib/highlight_products/admin_products_controller_ext.rb

@@ -0,0 +1,22 @@
+module HighlightProducts
+  module AdminProductsControllerExt
+    def self.included(base)
+      base.class_eval do
+        def highlight
+          load_object
+          @product.highlight
+          flash[:notice] = t("highlight_products.product_has_been_highlighted")
+          redirect_to admin_products_url
+        end
+
+        def unhighlight
+          load_object
+          @product.unhighlight
+          flash[:notice] = t("highlight_products.product_has_been_unhighlighted")
+          redirect_to admin_products_url
+        end
+      end
+    end
+  end
+end
+

lib/highlight_products/product_model_ext.rb

@@ -0,0 +1,37 @@
+module HighlightProducts
+  module ProductModelExt
+    def self.included(base)
+      base.class_eval do
+        scope :highlighted, where("products.highlighted_at IS NOT NULL").order("highlighted_at DESC")
+
+        def highlight
+          self.update_attribute(:highlighted_at, Time.current)
+        end
+
+        def unhighlight
+          self.update_attribute(:highlighted_at, nil)
+        end
+
+        private
+
+        def self.best_sellers(n, start = 1.week.ago, finish = Time.now)
+          # most ordered items
+          # looks for completed orders from date range (default: the past week)
+          # then gets top N sellers by quantity
+          # query: need to filter out cancelled orders?
+          #
+          # Jul09: had problem with :select vs :include in checkout_complete, hence the DIY
+          best_n = Order.between(start,finish).find(:all,
+                             :joins => "INNER JOIN checkouts ON orders.id = checkouts.order_id AND checkouts.state = 'complete'" +
+                                       " INNER JOIN line_items ON orders.id = line_items.order_id" +
+                                       " INNER JOIN variants ON variant_id = variants.id",
+                             :select => "product_id, SUM(quantity) sum",
+                             :group => "product_id ORDER BY sum DESC",
+                             :limit => n)
+            best_n.map {|o| [o.sum, Product.find(o.product_id)] }
+        end
+      end
+    end
+  end
+end
+

lib/highlight_products_hooks.rb

@@ -0,0 +1,4 @@
+class HighlightProductsHooks < Spree::ThemeSupport::HookListener
+  insert_before :admin_products_index_row_actions, 'admin/products/highlight_product_button'
+end
+

lib/tasks/highlight_products.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

lib/tasks/install.rake

@@ -0,0 +1,26 @@
+namespace :highlight_products do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['highlight_products:install:migrations'].invoke
+    Rake::Task['highlight_products:install:assets'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+
+    desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end