refinerycms-photo-gallery 0.0.2.dev → 0.1.0

data/Changelog.md

@@ -0,0 +1,18 @@
+## 0.1.0 [24 September 2012]
+* drop collection thumbnail version
+* support for old fancybox v1.3
+* auto photo orientation, by default
+* added admin tab to pages, enable attach photo album to page
+* added fragment caching for photos on frontend
+* added ajaxified pagination with history.pushState for photos on frontend
+* taking filename before uploading as photo title (fixes problems with filenames with diacritic - it took filename after carrierwave preprocessing as photo title - with broken diacritic)
+* fixed backend searching
+
+## 0.0.3.dev [16 August 2012]
+* bugfixes 
+
+## 0.0.2.dev [11 August 2012]
+* bugfixes 
+
+## 0.0.1.dev [8 August 2012]
+* initial commit

data/README.md

@@ -6,23 +6,22 @@ __Photo gallery engine for Refinery CMS.__
 
 This version of refinerycms-photo-gallery supports Rails 3.2.x and Refinery CMS ~> 2.0.3.
 
-Client side image resizing with Plupload is possible on Firefox 3.5+ (with fixed quality) and Chrome.
-Safari doesn't support direct data access to the selected files. Opera 12.00 + supports drag&drop and also client side image resizing.
-
-
 ## Features
 
 * Multiple photo uploading with [Plupload](http://www.plupload.com/) 1.5.4
-* Support for multiple runtimes (because of bug now works only HTML5): HTML5, Flash, Gears, Silverlight, HTML4
+* Currently supported HTML5 runtime, flash implementation is broken
 * Client side photo resizing to do faster uploading on slow connections
 * Server side resizing with Carrierwave
+* Attach album to page. One album can be attached to many pages.
 * Grouping albums to collections. Album can be placed in one or more collections.
-* Ajax photo edit during uploading
+* Ajaxified photo editation during uploading
 * Reading EXIF records from file - GPS latitude/longitude, photo title, photo description (In Linux you can put EXIF data using [digiKam](www.digikam.org/) )
 * Multiple photo editing at once
-* Fully configurable, fully translatable, searchable
+* Fully configurable, searchable
 * Using [Fancybox](http://fancyapps.com/fancybox/) 2.0.6 for frontend image slideshow. Read Fancybox license before you
 use it on profit websites.
+* Fragment caching on frontend
+* Ajaxified pagination with history.pushState on frontend
 
 ## Screenshots
 
@@ -53,11 +52,10 @@ TODO
 Gem is fully translated to slovak and english. Plupload is translated to 24 languages. You can add your own to
 photo_gallery/app/assets/javascripts/refinery/photo_gallery/admin/plupload/i18n and enable it in config.plupload_locale
 
+## Browser support
+Client side image resizing with Plupload is possible on Firefox 3.5+ (with fixed quality) and Chrome.
+Safari doesn't support direct data access to the selected files. Opera 12.00 + supports drag&drop and also client side image resizing.
 
-## Working status
-
-This is development snapshot. It is not suitable to production now, I'm going to fix bug list and todo list and then I will create stable branch/version.
-But gem works, so if you want, feel free to try it and contribute :).
 
 ## Installation
 
@@ -75,7 +73,7 @@ Instructions for installation you can find under [www.sno.phy.queensu.ca/~phil/e
 Open up your ``Gemfile`` and add at the bottom this line:
 
 ```ruby
-gem 'refinerycms-photo-gallery', '~> 0.0.1.dev', :git => 'git://github.com/Matho/refinerycms-photo-gallery.git'
+gem 'refinerycms-photo-gallery', '~> 0.1.0', :git => 'git://github.com/Matho/refinerycms-photo-gallery.git', :branch=>'0-1-stable'
 ```
 
 Now, run 
@@ -104,6 +102,8 @@ rake db:seed
 
 You can configure gem in ``your_app_name/config/initializers/refinery/photo_gallery.rb``
 
+If you want to use ajaxy pagination, copy ``app/assets/javascripts/refinery/photo_gallery/photo_gallery.js`` to your app's asset and add to manifest.
+
 Check, if you have ``jquery.js`` included in your backend.
 
 If you want to use Fancybox in frontend, copy ``photo_gallery/app/assets/images/refinery/photo_gallery/fancybox``, ``photo_gallery/app/assets/javascripts/refinery/photo_gallery/fancybox``, ``photo_gallery/app/assets/refinery/photo_gallery/stylesheets/fancybox`` to your
@@ -154,6 +154,30 @@ in your app, override it using rake refinery:override command and add this line
 </script>
 ```
 
+If you want to use Fancybox 1.3, use this javascipt to initialize:
+```javascript
+<script type="text/javascript">
+    $(document).ready(function() {
+        var load_fancybox = function loadFancybox() {
+            $("a[rel=group]").fancybox({
+                'transitionIn'		: 'none',
+                'transitionOut'		: 'none',
+                'titlePosition' 	: 'over',
+                'titleFormat'		: function(title, currentArray, currentIndex, currentOpts) {
+                    return '<span id="fancybox-title-over">Image ' + (currentIndex + 1) + ' / ' + currentArray.length + (title.length ? ' &nbsp; ' + title : '') + '</span>';
+                }
+            });
+        };
+        load_fancybox();
+
+        $("#photo_gallery").on("gallery_loaded", function() {
+            load_fancybox();
+        });
+
+    });
+</script>
+```
+
 Before production, don't forget to precompile assets by:
 
 ```ruby
@@ -185,17 +209,13 @@ Remove gem from Gemfile
 
 ## Todo list
 
-* fix support for refinerycms-search gem in backend/frontend
-* add support for amazon S3 storage
 * create app tests
-* repair problems with Flash runtime and test gears, silverlight and HTML4 runtime
 * show live links in admin
-* allow to check which photo is photo album preview
-* set albums public/not public.
+* create pop-up window to upload photos from pages area, like page-images
 * add checkboxes to delete multiple/all photos in album
 * stop uploading
+* add support for amazon S3 storage
 * travis, codeclimate
-* push to rubygem
 
 
 ## Known bugs
@@ -208,11 +228,9 @@ file extensions to upload queue. ( But server side validation reject these files
 
 ## Road map ?
 
-* album/photo tags using acts_as_taggable
-* show photo location on google maps
-* caching ?
 * GPS editing in degrees,minute,seconds format 
-* album grouping by year (configurable)
+* album/photo tags using acts_as_taggable ?
+* show photo location on google maps ?
 
 ## Testing
 

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+ENGINE_PATH = File.dirname(__FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+if File.exists?(APP_RAKEFILE)
+  load 'rails/tasks/engine.rake'
+end
+
+require "refinerycms-testing"
+Refinery::Testing::Railtie.load_tasks
+Refinery::Testing::Railtie.load_dummy_tasks(ENGINE_PATH)
+
+load File.expand_path('../tasks/testing.rake', __FILE__)
+load File.expand_path('../tasks/rspec.rake', __FILE__)

data/app/assets/javascripts/refinery/photo_gallery/admin/{photo_gallery.js → photo_gallery.js.erb}

@@ -1,3 +1,5 @@
+<%# encoding: utf-8 %>
+
 $(function() {
     $('form#form_edit_photos').on("click", ".form-photo-field .form-actions-right .confirm-delete", function() {
         if ( confirm( $(this).attr('data-confirm') ) ) {
@@ -23,6 +25,29 @@ $(function() {
         }, 250);
     });
 
-    $(".chzn-select").chosen();
+    $(".chzn-select").chosen(
+            {
+                no_results_text: "<%= I18n.t('chosen.no_results') %>"
+            }
+    );
+
+
+    $(".chzn-select-deselect").chosen({
+                no_results_text: "<%=  I18n.t('chosen.no_results') %>",
+                allow_single_deselect:true}
+    );
+
+
+    $('#photo_gallery_wym_editation').on("click", ".form-actions .button", function() {
+
+        $.ajax({
+            type: "POST",
+            dataType: 'script',
+            data: { '_method': $(this).attr('data-method') },
+            url: this.href
+        });
+
+        return false;
+    });
 
 });

data/app/assets/javascripts/refinery/photo_gallery/photo_gallery.js

@@ -0,0 +1,28 @@
+if (history && history.pushState) {
+    function slide_to(target){
+        var scrollToPosition = $(target).offset().top;
+        console.log(scrollToPosition);
+
+        $('html').animate({ 'scrollTop': scrollToPosition }, 600, function(){
+            //window.location.hash = "" + target;
+            // This hash change will jump the page to the top of the div with the same id
+            // so we need to force the page to back to the end of the animation
+            $('html').animate({ 'scrollTop': scrollToPosition }, 0);
+        });
+
+    }
+
+    $(document).ready(function(){
+
+        $('#photo_gallery').on("click", ".pagination a[href]", function() {
+            slide_to($('#photo_gallery'));
+            $.getScript(this.href);
+            history.pushState(null,"",this.href);
+            return false;
+        });
+
+        $(window).bind("popstate", function() {
+            $.getScript(location.href);
+        });
+    });
+}

data/app/controllers/refinery/photo_gallery/admin/albums_controller.rb

@@ -2,7 +2,7 @@ module Refinery
   module PhotoGallery
     module Admin
       class AlbumsController < ::Refinery::AdminController
-
+        cache_sweeper AlbumSweeper
         crudify :'refinery/photo_gallery/album', :order => "created_at DESC" , :xhr_paging => true
 
         def create
@@ -17,6 +17,7 @@ module Refinery
           end
         end
 
+
       end
     end
   end

data/app/controllers/refinery/photo_gallery/admin/photos_controller.rb

@@ -6,6 +6,7 @@ module Refinery
       class PhotosController < ::Refinery::AdminController
         include PhotosHelper
         helper :"refinery/photo_gallery/admin/photos"
+        cache_sweeper PhotoSweeper
 
         #TODO delete update method from routes
         #TODO delete edit action from routes
@@ -19,6 +20,7 @@ module Refinery
         def create
           @photo = Photo.new(params[:photo])
           @photo.file = params[:file]
+          @photo.title = get_filename_part(params[:name])
 
           if @photo.save!
             render :partial=> 'form_fields', :locals => {:photo => @photo }

data/app/helpers/refinery/photo_gallery/admin/photos_helper.rb

@@ -3,8 +3,10 @@ module Refinery
     module Admin
       module PhotosHelper
 
-
+        def get_filename_part(filename)
+          filename[0, filename.rindex('.') ]
+        end
       end
     end
   end
-end
+end

data/app/helpers/refinery/photo_gallery/photo_gallery_helper.rb

@@ -2,57 +2,8 @@ module Refinery
   module PhotoGallery
     module PhotoGalleryHelper
 
-      def message_albums_length_is_zero
-        if @albums.length == 0
-          t('.no_albums')
-        end
-      end
 
-      def message_photos_length_is_zero
-        if @photos.length == 0
-          t('.no_photos')
-        end
-      end
 
-      def message_collections_length_is_zero
-        if @collections.length == 0
-          t('.no_collections')
-        end
-      end
-
-
-
-      def generate_photo_gallery_menu( collections, albums, options = {} )
-        content_tag(:ul, {}, options[:ul] ) do
-          collections.each do |collection|
-
-            if params[:collection_id].present? &&  params[:id].present? # in albums controller
-              collection_id = params[:collection_id]
-            elsif params[:id].present? #in collection controller
-              collection_id = params[:id]
-            else
-              collection_id = 0 #only ensure initialization
-            end
-
-            concat(content_tag(:li,  {}, options[:li]) do
-              concat(link_to collection.title, refinery.photo_gallery_collection_path(collection))
-
-              # display albums of active collection
-              concat(content_tag(:ul, {}, options[:ul] ) do
-                if collection_id  == collection.id.to_s
-                  albums.each do |album|
-                    concat(content_tag(:li,  {}, options[:li]) do
-                      link_to album.title, refinery.photo_gallery_collection_album_path({:id=> album.id, :collection_id => collection_id})
-                    end )
-                  end
-                end
-              end )
-
-
-            end)
-          end
-        end
-      end
     end
   end
-end
+end

data/app/models/refinery/album_page.rb

@@ -0,0 +1,11 @@
+module Refinery
+    class AlbumPage < Refinery::Core::BaseModel
+
+      belongs_to  :album , :class_name => Refinery::PhotoGallery::Album
+      belongs_to :page, :polymorphic => true
+
+
+      attr_accessible :page_id, :page_type, :album_id
+
+    end
+end

data/app/models/refinery/photo_gallery/album.rb

@@ -5,6 +5,7 @@ module Refinery
       has_many :collection_albums , :dependent => :destroy
       has_many :collections, :through => :collection_albums
 
+
       before_validation :set_path
       validates :title, :presence => true
       validates :path, :presence => true, :uniqueness => true
@@ -15,26 +16,18 @@ module Refinery
 
       self.per_page = Refinery::PhotoGallery.albums_per_page
 
+
+      def self.with_collection_id
+        select("refinery_photo_gallery_albums.*, refinery_photo_gallery_collection_albums.collection_id ").joins(:collection_albums)
+      end
+
       scope :find_by_collection_id, lambda {|collection_id|
-            select("refinery_photo_gallery_albums.*").
+        select("refinery_photo_gallery_albums.*").
             joins(:collection_albums).
             where("refinery_photo_gallery_collection_albums.collection_id = ?
                     ", collection_id).
             order('created_at DESC, title ASC')
       }
-=begin
-#TODO marked photo as photo album preview
-      scope :find_by_collection_id, lambda {|collection_id|
-        select("refinery_photo_gallery_albums.*, refinery_photo_gallery_photos.file").
-            joins(:collection_albums, :photos).
-            where("refinery_photo_gallery_collection_albums.collection_id = ? AND
-                   refinery_photo_gallery_photos.album_id  = refinery_photo_gallery_albums.id AND
-                   refinery_photo_gallery_photos.preview_image = true
-                    ", collection_id).
-            order('created_at DESC, title ASC')
-      }
-=end
-
 
       def collection_ids
         Refinery::PhotoGallery::CollectionAlbum.select('collection_id').where("album_id = ?", self.id ).map{|ca| ca.collection_id }

data/app/models/refinery/photo_gallery/collection.rb

@@ -13,11 +13,12 @@ module Refinery
 
       self.per_page = Refinery::PhotoGallery.collections_per_page
 
-      scope :has_albums, lambda {
+      def self.has_albums
         select("refinery_photo_gallery_collections.*").uniq.
             joins(:collection_albums).
             order('created_at DESC, title ASC')
-      }
+      end
+
 =begin
       def to_param
         "#{id}-#{title.parameterize}"

data/app/models/refinery/photo_gallery/photo.rb

@@ -27,22 +27,23 @@ module Refinery
       end
 
       def exif_read
-      	 begin
+        begin
           photo = MiniExiftool.new(self.file.file.file, {:numerical=> true})
 
+          self.title = photo.DocumentName  if !photo.DocumentName.nil?
           self.longitude = photo.GPSLongitude if self.longitude.nil?
           self.latitude = photo.GPSLatitude if self.latitude.nil?
-          self.title = photo.DocumentName if photo.DocumentName.present?
           self.description = photo.ImageDescription if self.description.nil? && photo.ImageDescription != 'Exif_JPEG_PICTURE'
-          # TODO read keywords from exif
+            # TODO read keywords from exif
         rescue
           p "ERROR raised exception during MiniExiftool reading"
-	ensure
+
+        ensure
           self.description = "" if self.description.nil?  # Because description is concating in helpers, this can't be null
         end
-        end
       end
 
+
 =begin
       #TODO add checkbox to check if it should be writed to exif, globally on/off writing
       def exif_write
@@ -60,3 +61,4 @@ module Refinery
     end
   end
 end
+

data/app/sweepers/refinery/photo_gallery/admin/album_sweeper.rb

@@ -0,0 +1,33 @@
+module Refinery
+  module PhotoGallery
+    module Admin
+      class AlbumSweeper < ActionController::Caching::Sweeper
+        observe Album
+
+
+        def sweep_album(album)
+          expire_fragment("refinery/photo_gallery/albums/#{album.id}")
+        end
+
+        def sweep_album_with_photos(album)
+          sweep_album(album)
+
+          # only file store supports regexp
+          begin
+            # This is slow, but I was unable to get the actual cache folder path.
+            expire_fragment( %r{refinery/photo_gallery/albums/#{photo.album_id}/page/\d*})
+          rescue NotImplementedError
+            Rails.cache.clear
+            warn "**** [REFINERY PHOTO GALLERY] The cache store you are using is not compatible with this engine. Only file_store is supported. Clearing entire cache instead ***"
+          ensure
+            return true
+          end
+        end
+
+        alias_method :after_create,  :sweep_album
+        alias_method :after_update,  :sweep_album
+        alias_method :after_destroy, :sweep_album_with_photos
+      end
+    end
+  end
+end