spud_photos 0.1.5 → 0.9.0

data/README.markdown

@@ -30,7 +30,7 @@ Spud Photos accepts the following configuration options:
 	    :large => '400x400#',
 	    :huge => '600x600'
 	  }
-	  self.paperclip_storage = :filesystem #use :s3 to use s3 storage (aws gem required)
+	  config.paperclip_storage = :filesystem #use :s3 to use s3 storage (aws gem required)
     	  config.s3_credentials = "#{Rails.root}/config/s3.yml"
     	  config.storage_path = ":rails_root/public/system/spud_photos/:id/:style/:basename.:extension"
     	  config.storage_url = "/system/spud_photos/:id/:style/:basename.:extension"
@@ -52,4 +52,24 @@ __NOTE:__ The built-in views are likely to undergo changes as features are added
 
 
 [1]:https://github.com/davydotcom/spud_core_admin
-[2]:https://github.com/thoughtbot/paperclip
+[2]:https://github.com/thoughtbot/paperclip
+
+Testing
+-----------------
+
+Spud uses RSpec for testing. Get the tests running with a few short commands:
+
+1. Create and migrate the databases:
+   
+        rake db:create
+        rake db:migrate
+
+2. Load the schema in to the test database:
+
+        rake app:db:test:prepare
+
+3. Run the tests with RSpec
+
+        rspec spec
+
+After the tests have completed the current code coverage stats is available by opening ```/coverage/index.html``` in a browser.

data/Rakefile

@@ -20,21 +20,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+require 'rake'

data/app/assets/javascripts/spud/admin/photos.js

@@ -14,12 +14,14 @@ Spud.Admin.Photos = new function(){
     $('body').on('submit', '#spud_admin_photo_album_form', self.submittedPhotoAlbumForm);
     $('body').on('submit', '#spud_admin_photo_gallery_form', self.submittedPhotoGalleryForm);
     $('body').on('submit', '#spud_admin_photo_form', self.submittedPhotoForm);
-    $('body').on('click', '.spud_admin_photos_btn_remove', self.clickedPhotoRemoveFromAlbum)
+    $('body').on('click', '.spud_admin_photos_btn_remove', self.clickedPhotoRemoveFromAlbum);
     $('body').on('click', '.spud_admin_photo_ui_thumbs_selectable .spud_admin_photo_ui_thumb', self.selectedPhotoUiThumb);
     $('body').on('click', '#spud_admin_photo_album_action_library', self.clickedPhotoLibrary);
     $('body').on('click', '#spud_admin_photo_album_action_upload, .spud_admin_photo .spud_admin_photos_btn_edit', self.clickedPhotoAddOrEdit);
+    $('body').on('click', '.spud_admin_photo_library_add_selected', self.addSelectedPhotosFromLibrary);
+    $('body').on('click', '.spud_admin_photo_library_delete_selected', self.deleteSelectedPhotosFromLibrary);
 
-    // html5 drag and drop file 
+    // html5 drag and drop file
     if(typeof(FormData) != 'undefined' && typeof(XMLHttpRequest) != 'undefined' && (droparea = document.getElementById('spud_admin_photo_upload_queue'))){
       html5upload = true;
       $('#spud_admin_photo_upload_queue').show();
@@ -43,7 +45,7 @@ Spud.Admin.Photos = new function(){
 
   this.submittedPhotoGalleryForm = function(e){
     $('#spud_admin_photo_albums_available .spud_admin_photo_ui_thumb').remove();
-  }
+  };
 
   this.clickedPhotoRemoveFromAlbum = function(e){
     $(this).parents('.spud_admin_photo_ui_thumb').fadeOut(200, function(){
@@ -68,7 +70,7 @@ Spud.Admin.Photos = new function(){
       var target = $('#spud_admin_photos_selected, #spud_admin_photos');
       target.prepend(html);
     }
-    $('#dialog').dialog('close');
+    hideModalDialog();
   };
 
   this.selectedPhotoUiThumb = function(e){
@@ -102,14 +104,15 @@ Spud.Admin.Photos = new function(){
     });
   };
 
-  /* 
+  /*
   * Single-Photo Form Upload
   -------------------------------- */
 
   this.submittedPhotoForm = function(e){
     // disable submit button
-    var submit = $(this).find('input[type=submit]');
-    submit.attr('disabled', 'disabled').val(submit.attr('data-loading-text'));
+    // not working in updated bootstrap!
+    // var submit = $(this).find('input[type=submit]');
+    // submit.attr('disabled', 'disabled').val(submit.attr('data-loading-text'));
 
     if(html5upload){
       // create a FormData object and attach form values
@@ -120,20 +123,21 @@ Spud.Admin.Photos = new function(){
       fd.append('spud_photo[title]', form.find('#spud_photo_title').val());
       fd.append('spud_photo[caption]', form.find('#spud_photo_caption').val());
 
-      // progress bar to send events to 
+      // progress bar to send events to
+      var progressBar;
       var file = form.find('#spud_photo_photo')[0].files[0];
       if(file){
-        var progressBar = self.progressBarForUpload(file.fileName);
+        progressBar = self.progressBarForUpload(file.fileName);
         fd.append('spud_photo[photo]', file);
-        form.find('.form-actions').before(progressBar);
+        form.append(progressBar);
       }
       else{
-        var progressBar = self.progressBarForUpload('');
+        progressBar = self.progressBarForUpload('');
       }
 
       // send FormData object as ajax request
       var xhr = new XMLHttpRequest();
-      xhr.upload.addEventListener('progress', function(e){ self.onPhotoUploadProgress(e, progressBar) }, false);
+      xhr.upload.addEventListener('progress', function(e){ self.onPhotoUploadProgress(e, progressBar); }, false);
       xhr.addEventListener('load', function(e){ self.onPhotoUploadComplete(e, progressBar); }, false);
       xhr.addEventListener('error', function(e){ self.onPhotoUploadFailure(e, progressBar); }, false);
       xhr.addEventListener('abort', function(e){ self.onPhotoUploadCancel(e, progressBar); }, false);
@@ -144,7 +148,7 @@ Spud.Admin.Photos = new function(){
     }
   };
 
-  /* 
+  /*
   * Upload Progress Monitoring
   -------------------------------- */
 
@@ -184,18 +188,14 @@ Spud.Admin.Photos = new function(){
         var target = $('#spud_admin_photos_selected, #spud_admin_photos');
         target.prepend(photo.html).fadeIn(200);
       }
-      $('#dialog').dialog('close');
+      hideModalDialog();
     }
     // validation error
     else{
-      $('#dialog').html(photo.html);
+      $("#modal_window .modal-body").html(photo.html);
     }
   };
 
-  this.onPhotoUploadCancel = function(e, progressBar){
-
-  };
-
   this.onPhotoUploadCancel = function(e, progressBar){
     progressBar.find('.spud_admin_photo_progress_status').text('Done!');
     progressBar.find('.progress').addClass('progress-danger');
@@ -203,7 +203,7 @@ Spud.Admin.Photos = new function(){
 
   /*
   * Photo Upload/Edit Form
-  ------------------------------- */  
+  ------------------------------- */
   this.clickedPhotoAddOrEdit = function(e){
     var url = this.href;
     $.ajax({
@@ -214,17 +214,9 @@ Spud.Admin.Photos = new function(){
   };
 
   this.photoUploadFormLoaded = function(html){
-    var dialog = $("#dialog");
-    if(dialog.length == 0){
-      dialog = $('<div id="dialog" style="display:hidden;"></div>').appendTo('body');
-    }
-    dialog.html(html);
-    dialog.dialog({
-      width: 500,
-      modal: true,
-      height: 'auto',
+    displayModalDialogWithOptions({
       title: 'Upload Photo',
-      buttons: {}
+      html: html
     });
   };
 
@@ -242,11 +234,7 @@ Spud.Admin.Photos = new function(){
   };
 
   this.photoLibraryLoaded = function(html){
-    var dialog = $("#dialog");
-    if(dialog.length == 0){
-      dialog = $('<div id="dialog" style="display:hidden;"></div>').appendTo('body');
-    }
-    dialog.html(html);
+    var dialog = $('#modal_window');
     $('#spud_admin_photos_selected .spud_admin_photo_ui_thumb').each(function(){
       var id = $(this).attr('id');
       var dupe = dialog.find('#'+id);
@@ -254,14 +242,12 @@ Spud.Admin.Photos = new function(){
         dupe.remove();
       }
     });
-    dialog.dialog({
-      width: 675,
-      modal: true,
-      height: 450,
+    displayModalDialogWithOptions({
       title: 'My Photo Library',
-      buttons: {
-        'Add Selected': self.addSelectedPhotosFromLibrary,
-        'Delete Selected': self.deleteSelectedPhotosFromLibrary
+      html: html,
+      buttons:{
+        'spud_admin_photo_library_add_selected btn-primary': 'Add Selected',
+        'spud_admin_photo_library_delete_selected btn-danger': 'Delete Selected'
       }
     });
   };
@@ -272,11 +258,11 @@ Spud.Admin.Photos = new function(){
       .prependTo('#spud_admin_photos_selected')
       .hide()
       .fadeIn(200);
-    $(this).dialog('close');
+    hideModalDialog();
   };
 
   this.deleteSelectedPhotosFromLibrary = function(e){
-    var ids = $.map($('.spud_admin_photo_ui_thumb_selected'), function(val, i){ 
+    var ids = $.map($('.spud_admin_photo_ui_thumb_selected'), function(val, i){
       return $(val).attr('rel');
     });
     $.ajax({
@@ -289,10 +275,10 @@ Spud.Admin.Photos = new function(){
         });
       },
       error: function(jqXHR, textStatus, errorThrown){
-        console.log('An error occurred:')
+        console.log('An error occurred:');
         console.log(arguments);
       }
-    })
+    });
 
   };
 
@@ -307,7 +293,7 @@ Spud.Admin.Photos = new function(){
   this.stopDndPropagation = function(e){
     e.stopPropagation();
     e.preventDefault();
-  }
+  };
 
   // add files to queue. starts queue if not started already
   this.droppedFile = function(e){
@@ -324,7 +310,7 @@ Spud.Admin.Photos = new function(){
     if(!this.fileQueueStarted){
       self.uploadNextPhoto();
       if(self.fileQueue.length > 0){
-        self.uploadNextPhoto();  
+        self.uploadNextPhoto();
       }
     }
   };
@@ -334,7 +320,7 @@ Spud.Admin.Photos = new function(){
   };
 
   this.uploadNextPhoto = function(){
-    if(self.fileQueue.length == 0){
+    if(self.fileQueue.length === 0){
       self.fileQueueStarted = false;
       return;
     }
@@ -352,7 +338,7 @@ Spud.Admin.Photos = new function(){
     // send formdata as xhr
     var xhr = new XMLHttpRequest();
     xhr.upload.addEventListener('progress', function(e){ self.onPhotoUploadProgress(e, progressBar); }, false);
-    xhr.addEventListener('load', function(e){ self.onQueuedPhotoUploadComplete(e, progressBar) }, false);
+    xhr.addEventListener('load', function(e){ self.onQueuedPhotoUploadComplete(e, progressBar); }, false);
     xhr.addEventListener('error', function(e){ self.onPhotoUploadFailure(e, progressBar); }, false);
     xhr.addEventListener('abort', function(e){ self.onPhotoUploadCancel(e, progressBar); }, false);
     xhr.open('POST', '/spud/admin/photos');

data/app/assets/stylesheets/spud/admin/photos.css

@@ -63,6 +63,7 @@
   white-space: nowrap;
   overflow: hidden;
   text-overflow: ellipsis;
+  margin: 0;
 }
 .spud_admin_photo_ui_thumb_controls{
   position: absolute;

data/app/controllers/photo_albums_controller.rb

@@ -3,6 +3,12 @@ class PhotoAlbumsController < ApplicationController
   respond_to :html, :json, :xml
   layout Spud::Photos.base_layout
 
+  after_filter :only => [:show, :index] do |c|
+    if Spud::Photos.enable_full_page_caching
+      c.cache_page(nil, nil, false)
+    end
+  end
+
   def index
     if params[:photo_gallery_id]
       @photo_gallery = SpudPhotoGallery.find_by_url_name(params[:photo_gallery_id])

data/app/controllers/photo_galleries_controller.rb

@@ -3,6 +3,12 @@ class PhotoGalleriesController < ApplicationController
   respond_to :html, :json, :xml
   layout Spud::Photos.base_layout
 
+  after_filter :only => [:index] do |c|
+    if Spud::Photos.enable_full_page_caching
+      c.cache_page(nil, nil, false)
+    end
+  end
+
   def index
     @photo_galleries = SpudPhotoGallery.order('created_at desc')
     respond_with @photo_galleries

data/app/controllers/spud/admin/photo_albums_controller.rb

@@ -4,6 +4,7 @@ class Spud::Admin::PhotoAlbumsController < Spud::Admin::ApplicationController
   add_breadcrumb 'Photo Albums', :spud_admin_photo_albums_path
   respond_to :html, :json, :xml
   layout 'spud/admin/spud_photos'
+  cache_sweeper :spud_photo_sweeper, :only => [:create, :update, :destroy]
 
   def index
     @photo_albums = SpudPhotoAlbum.all

data/app/controllers/spud/admin/photo_galleries_controller.rb

@@ -5,6 +5,7 @@ class Spud::Admin::PhotoGalleriesController < Spud::Admin::ApplicationController
   add_breadcrumb 'Photo Galleries', :spud_admin_photo_galleries_path
   respond_to :html, :json, :xml
   layout 'spud/admin/spud_photos'
+  cache_sweeper :spud_photo_sweeper, :only => [:create, :update, :destroy]
 
   def index
     @photo_galleries = SpudPhotoGallery.all

data/app/controllers/spud/admin/photos_controller.rb

@@ -5,6 +5,7 @@ class Spud::Admin::PhotosController < Spud::Admin::ApplicationController
   before_filter :get_photo, :only => [:show, :edit, :update, :destroy]
   respond_to :html, :json, :xml, :js
   layout false
+  cache_sweeper :spud_photo_sweeper, :only => [:create, :update, :destroy]
 
   def index
     @photos = SpudPhoto.all

data/app/models/spud_photo.rb

@@ -9,6 +9,7 @@ class SpudPhoto < ActiveRecord::Base
 
   has_attached_file :photo, 
     :styles => lambda { |attachment| attachment.instance.dynamic_styles },
+    :convert_options => Spud::Photos.config.convert_options,
     :storage => Spud::Photos.paperclip_storage,
     :s3_credentials => Spud::Photos.s3_credentials,
     :url => Spud::Photos.storage_url,
@@ -17,9 +18,10 @@ class SpudPhoto < ActiveRecord::Base
   validates_attachment_presence :photo
 
   def dynamic_styles
+    compress = '-strip -density 72x72'
     admin_styles = {
-      :spud_admin_small => '125x125#',
-      :spud_admin_medium => '300x200'
+      :spud_admin_small => {:geometry => '125x125#', :convert_options => compress},
+      :spud_admin_medium => {:geometry => '300x200', :convert_options => compress}
     }
     return admin_styles.merge(Spud::Photos.config.photo_styles)
   end

data/app/models/spud_photo_sweeper.rb

@@ -0,0 +1,33 @@
+class SpudPhotoSweeper < ActionController::Caching::Sweeper
+
+  observe :spud_photo, :spud_photo_album, :spud_photo_gallery
+
+  def after_create(record)
+    expire_cache_for(record)
+  end
+
+  def before_update(record)
+    expire_cache_for(record)
+  end
+
+  def after_destroy(record)
+    expire_cache_for(record)
+  end
+
+private
+
+  def expire_cache_for(record)
+    if Spud::Photos.config.enable_full_page_caching
+      cache_path = File.join(ActionController::Base.page_cache_directory, Spud::Photos.config.base_path)
+      if File.directory?(cache_path)
+        FileUtils.rm_rf(cache_path)
+      end
+      if !Spud::Photos.config.page_caches_to_sweep.blank?
+        Spud::Photos.config.page_caches_to_sweep.each do |route|
+          expire_page(route)
+        end
+      end
+    end
+  end
+
+end

data/app/views/spud/admin/photos/_form.html.erb

@@ -36,11 +36,6 @@
       <% end %>
   </fieldset>
 
-  <div class="form-actions">
-    <%= f.submit "Save Photo", :class=>"btn btn-primary form-btn", "data-loading-text" => "Saving..." %> 
-    <!--or <%=link_to "cancel", request.referer, :class => "btn" %> -->
-  </div>
-
   <iframe id="spud_admin_photo_form_target" name="spud_admin_photo_form_target" style="display:none;"></iframe>
 
 <% end %>

data/lib/spud_photos/configuration.rb

@@ -1,12 +1,13 @@
 module Spud
   module Photos
     include ActiveSupport::Configurable
-    config_accessor :photo_styles, :galleries_enabled, :base_layout, :base_path,:s3_credentials,:storage_path,:storage_url,:paperclip_storage
+    config_accessor :photo_styles, :convert_options, :galleries_enabled, :base_layout, :base_path,:s3_credentials,:storage_path,:storage_url,:paperclip_storage, :enable_full_page_caching, :page_caches_to_sweep
     self.photo_styles = {
       :small => '50x50#',
       :medium => '200x200#',
       :large => '400x400#'
     }
+    self.convert_options = {}
     self.galleries_enabled = false
     self.base_layout = 'application'
     self.base_path = 'photos'
@@ -14,5 +15,7 @@ module Spud
     self.s3_credentials = "#{Rails.root}/config/s3.yml"
     self.storage_path = ":rails_root/public/system/spud_photos/:id/:style/:basename.:extension"
     self.storage_url = "/system/spud_photos/:id/:style/:basename.:extension"
+    self.enable_full_page_caching = false
+    self.page_caches_to_sweep = []
   end
 end

data/lib/spud_photos/version.rb

@@ -1,5 +1,5 @@
 module Spud
 	module Photos
-	  VERSION = "0.1.5"
+	  VERSION = "0.9.0"
 	end
 end