refinerycms-page-images 2.0.1 → 2.1.0

data/app/assets/stylesheets/refinery/page-image-picker.css.scss

@@ -54,4 +54,10 @@ a#add_image_link {
   display: inline;
   border-bottom: 0;
   background: image-url('refinery/icons/add.png') no-repeat 0px 6px;
+}
+
+.page-images-caption-modal.plain {
+  textarea {
+    width: 400px;
+  }
 }

data/app/views/refinery/admin/pages/tabs/_images.html.erb

@@ -1,4 +1,5 @@
-<div class='wym_skin_refinery page_part' id='page_image_picker'>
+<div class='wym_skin_refinery page_part' id='page_image_picker'
+     data-input-type="<%= Refinery::PageImages.config.wysiwyg ? 'wym' : 'textarea'%>">
   <%= render '/refinery/admin/pages/tabs/images_bar', :f => f %>
   <%= render '/refinery/admin/pages/tabs/images_field', :f => f %>
 </div>

data/app/views/refinery/admin/pages/tabs/_images_field.html.erb

@@ -1,3 +1,13 @@
+<% form_actions = capture do %>
+  <div class='form-actions'>
+    <div class='form-actions-left'>
+      <a class='button js-page-images-done'><%= I18n.t('refinery.js.admin.page_images.done') %></a>
+    </div>
+  </div>
+<% end %>
+
+<% modal_class = Refinery::PageImages.config.wysiwyg ? 'wym' : 'plain' %>
+
 <div class='wym_box field images_field'>
   <ul id='page_images' class='clearfix'>
     <%= f.fields_for :images do |image_form| %>
@@ -7,25 +17,27 @@
         <% index = image_form.object_name.split('[').last.split(']').first.to_i %>
         <%= hidden_field_tag "#{f.object_name.demodulize}[images_attributes][#{index}][image_page_id]", f.object.image_page_id_for_image_index(index) %>
         <% if Refinery::PageImages.captions %>
-          <div class='textarea_wrapper_for_wym'>
+          <div class='page-images-caption-modal <%= modal_class %>'>
             <%= text_area_tag "#{f.object_name.demodulize}[images_attributes][#{index}][caption]",
                               f.object.caption_for_image_index(index),
                               :style => 'display: none',
                               :id => "page_captions_#{index}",
                               :class => 'page_caption' %>
+            <%= raw form_actions %>
           </div>
         <% end %>
       </li>
     <% end %>
-    <li class='empty'>
+    <li class='js-page-images-template'>
       <%= hidden_field_tag "#{f.object_name.demodulize}[images_attributes][#{f.object.images.size}][id]" %>
       <% if Refinery::PageImages.captions %>
-        <div class='textarea_wrapper_for_wym'>
+        <div class='page-images-caption-modal <%= modal_class %>'>
           <%= text_area_tag "#{f.object_name.demodulize}[images_attributes][#{f.object.images.size}][caption]",
                             '',
                             :style => 'display: none',
                             :id => "page_captions_#{f.object.images.size}",
                             :class => 'page_caption' %>
+          <%= raw form_actions %>
         </div>
       <% end %>
     </li>

data/config/locales/bg.yml

@@ -2,6 +2,7 @@ bg:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Изображения на страница
         title: Изображения на страница
         description: Чрез добавката "Изображения на страница" имате възможност да свържите едно или повече изображения с всяка страница в Refinery. Така лесно ще можете да създавате опростени галерии с изображения, които се отварят в изкачащ прозорец като при lightbox.
     js:

data/config/locales/cs.yml

@@ -2,6 +2,7 @@ cs:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Obrázky stránek
         title: Obrázky stránek
         description: Obrázky stránek vám dovoli připojit jeden či více obrázků ke stránce v Refinery. Umožní tak jednoduše vytvářet například galerie s lightboxem na frontendu.
     js:

data/config/locales/de.yml

@@ -2,7 +2,9 @@ de:
   refinery:
     plugins:
       refinery_page_images:
-        title: Das Seitenbilder-Plugin erlaubt dir ein oder mehrere Bilder einer Seite zuzuordnen. Damit ist es möglich Bildergalerien in der Frontendansicht darzustellen.
+        tab_name: Seitenbilder
+        title: Seitenbilder
+        description: Das Seitenbilder-Plugin erlaubt dir ein oder mehrere Bilder einer Seite zuzuordnen. Damit ist es möglich Bildergalerien in der Frontendansicht darzustellen.
     admin:
       pages:
         tabs:

data/config/locales/en.yml

@@ -2,7 +2,9 @@ en:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Page Images
         title: Page Images
+        tab_name: Images
         description: Page Images allows you to relate one or more images to any page in Refinery which makes it really easy for you to create simple image galleries with lightbox style popups on the front end page views.
     js:
       admin:

data/config/locales/es.yml

@@ -0,0 +1,19 @@
+es:
+  refinery:
+    plugins:
+      refinery_page_images:
+        tab_name: Imágenes de Página
+        title: Imágenes de Página
+        tab_name: Imágenes
+        description: Imágenes de página te permite relacionar una o más imagenes a cualquier página en Refinery lo que hace realmente fácil crear galerías de imágenes con diferentes estilos
+    js:
+      admin:
+        page_images:
+          add_caption: Añadir Imagen
+          done: Hecho
+    admin:
+      pages:
+        tabs:
+          images_bar:
+            add: Añadir Imagen
+               

data/config/locales/fr.yml

@@ -2,6 +2,7 @@ fr:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Page Images
         title: Page Images
         description: "Page Images vous permet de lier une ou plusieurs images à n'importe quelle page dans Refinery, cela vous permet de créer très facilement des galeries d'images qui peuvent s'afficher dans une lightbox ou popups pour le front end"
     js:

data/config/locales/ja.yml

@@ -0,0 +1,18 @@
+ja:
+  refinery:
+    plugins:
+      refinery_page_images:
+        tab_name: ページ画像
+        title: ページ画像
+        tab_name: 画像
+        description: 一つのページに対して、複数または一つの画像を設定することが出来ます。
+    js:
+      admin:
+        page_images:
+          add_caption: キャプションを追加
+          done: 保存
+    admin:
+      pages:
+        tabs:
+          images_bar:
+            add: 画像を追加

data/config/locales/nl.yml

@@ -2,6 +2,7 @@ nl:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Pagina Afbeeldingen
         title: Pagina Afbeeldingen
         description: Pagina Afbeeldingen stelt u in staat op afbeeldingen te koppelen aan een specifieke pagina.
     admin:

data/config/locales/pt-BR.yml

@@ -2,6 +2,7 @@ pt-BR:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Imagens da Página
         title: Imagens da Página
         description: Imagens da Página te permite relacionar uma ou mais imagens a qualquer página no Refinery, tornando muito simples a criação de galerias de imagem no front end com popus no estilo lightbox.
     js:

data/config/locales/ru.yml

@@ -2,6 +2,7 @@ ru:
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Изображения страницы
         title: Изображения страницы
         description: Плагин работы с изображениями страницы "Page Images" позволяет связывать одно или несколько изображений с любой страницей в Refinery. С помощью плагина можно с легкостью создавать простые галереи изображений с поддержкой всплывающих полноразмерных изображений в стиле lightbox.
     admin:

data/config/locales/sk.yml

@@ -2,6 +2,7 @@
   refinery:
     plugins:
       refinery_page_images:
+        tab_name: Obrázky stránok
         title: Obrázky stránok
         description: Obrázky stránok vám umožnia pridať jeden alebo viac obrázkov k stránke v Refinery. Umožnia vám tak jednoducho vytvárať napríklad galérie v spojení s lightboxom.
     js:

data/lib/generators/refinery/templates/config/initializers/refinery/page_images.rb.erb

@@ -1,3 +1,5 @@
 Refinery::PageImages.configure do |config|
   # config.captions = <%= Refinery::PageImages.captions.inspect %>
+  # config.enable_for = <%= Refinery::PageImages.enable_for.inspect %>
+  # config.wysiwyg = true
 end

data/lib/refinery/page_images.rb

@@ -13,10 +13,23 @@ module Refinery
       def factory_paths
         @factory_paths ||= [ root.join('spec', 'factories').to_s ]
       end
+
+      def attach!
+        require 'refinery/page'
+        require 'refinery/page_images/extension'
+
+        config.enabled_models.each do |model_class_name|
+          unless (model_class = model_class_name.safe_constantize)
+            Rails.logger.warn "PageImages is unable to find model class: #{model_class_name}"
+            next
+          end
+          model_class.send :has_many_page_images
+        end
+
+        Refinery::Image.send :has_many, :image_pages, :dependent => :destroy
+      end
     end
 
-    require 'refinery/page_images/configuration'
     require 'refinery/page_images/engine'
-    require 'refinery/page_images/extension'
   end
 end

data/lib/refinery/page_images/configuration.rb

@@ -2,8 +2,32 @@ module Refinery
   module PageImages
     include ActiveSupport::Configurable
 
-    config_accessor :captions
+    config_accessor :captions, :enable_for, :wysiwyg
 
     self.captions = false
+    self.wysiwyg = true
+    self.enable_for = [
+      { :model => 'Refinery::Page', :tab => 'Refinery::Pages::Tab' },
+    ]
+
+    if defined?(Refinery::Blog)
+      self.enable_for << { :model => 'Refinery::Blog::Post', :tab => 'Refinery::Blog::Tab' }
+    end
+
+    config.instance_eval do
+      def enabled_tabs
+        extract_enabled_option(:tab)
+      end
+
+      def enabled_models
+        extract_enabled_option(:model)
+      end
+
+      private
+      def extract_enabled_option(key)
+        enable_for.map { |enable_for| enable_for[key] }.compact
+      end
+    end
+
   end
 end

data/lib/refinery/page_images/engine.rb

@@ -1,3 +1,5 @@
+require 'refinery/page_images/configuration'
+
 module Refinery
   module PageImages
     class Engine < Rails::Engine
@@ -8,10 +10,20 @@ module Refinery
       engine_name :refinery_page_images
 
       def self.register(tab)
-        tab.name = "images"
+        tab.name = ::I18n.t(:'refinery.plugins.refinery_page_images.tab_name')
         tab.partial = "/refinery/admin/pages/tabs/images"
       end
 
+      def self.initialize_tabs!
+        PageImages.config.enabled_tabs.each do |tab_class_name|
+          unless (tab_class = tab_class_name.safe_constantize)
+            Rails.logger.warn "PageImages is unable to find tab class: #{tab_class_name}"
+            next
+          end
+          tab_class.register { |tab| register tab }
+        end
+      end
+
       initializer "register refinery_page_images plugin" do
         Refinery::Plugin.register do |plugin|
           plugin.name = "page_images"
@@ -20,27 +32,13 @@ module Refinery
       end
 
       config.to_prepare do
-        require 'refinerycms-pages'
-        Refinery::Page.send :has_many_page_images
-        Refinery::Blog::Post.send :has_many_page_images if defined?(::Refinery::Blog)
-        Refinery::Image.module_eval do
-          has_many :image_pages, :dependent => :destroy
-        end
+        Refinery::PageImages.attach!
       end
 
       config.after_initialize do
-        Refinery::Pages::Tab.register do |tab|
-          register tab
-        end
-
-        if defined?(Refinery::Blog::Tab)
-          Refinery::Blog::Tab.register do |tab|
-            register tab
-          end
-        end
-
-        Refinery.register_engine(Refinery::PageImages)
+        initialize_tabs!
+        Refinery.register_engine Refinery::PageImages
       end
     end
   end
-end
+end

data/lib/refinery/page_images/extension.rb

@@ -2,8 +2,8 @@ module Refinery
   module PageImages
     module Extension
       def has_many_page_images
-        has_many :image_pages, :as => :page, :order => 'position ASC'
-        has_many :images, :through => :image_pages, :order => 'position ASC'
+        has_many :image_pages, :as => :page, :class_name => 'Refinery::ImagePage', :order => 'position ASC'
+        has_many :images, :through => :image_pages, :class_name => 'Refinery::Image', :order => 'position ASC'
         # accepts_nested_attributes_for MUST come before def images_attributes=
         # this is because images_attributes= overrides accepts_nested_attributes_for.
 

data/readme.md

@@ -32,6 +32,24 @@ rake db:migrate
 
 Now when you start up your Refinery application, edit a page and there should be a new "Images" tab.
 
+# Deploying to Heroku
+
+In order to properly precompile assets on Heroku, config vars be present in the environment during slug compilation. 
+
+```bash
+heroku labs:enable user-env-compile -a myapp
+```
+
+otherwise you may experience the following error:
+```
+could not connect to server: Connection refused
+Is the server running on host "127.0.0.1" and accepting
+TCP/IP connections on port 5432?
+```
+
+
+["More Details"](https://devcenter.heroku.com/articles/labs-user-env-compile)
+
 ## Enable Captions
 
 You can enable captions using an initializer containing the following configuration:
@@ -40,16 +58,44 @@ You can enable captions using an initializer containing the following configurat
 Refinery::PageImages.captions = true
 ```
 
+By default, captions are WYM editors. Prefer `textarea`s ? Gotcha :
+
+```ruby
+Refinery::PageImages.wysiwyg = false
+```
+
 ## Usage
 
 `app/views/refinery/pages/show.html.erb`
 
+If you don't have this file then Refinery will be using its default. You can override this with
+
+```bash
+rake refinery:override view=refinery/pages/show
+```
+
+```erb
+<% content_for :body_content_right do %>
+  <ul id='gallery'>
+    <% @page.images.each do |image| %>
+      <li>
+        <%= link_to image_tag(image.thumbnail("200x200#c").url), image.thumbnail("900x600").url %>
+      </li>
+   <% end %>
+  </ul>
+<% end %>
+<%= render :partial => "/refinery/content_page" %>
+```
+
+If you have enabled captions, you can show them like this
+
 ```erb
 <% content_for :body_content_right do %>
   <ul id='gallery'>
-    <% @page.images.each do |i| %>
+    <% @page.images.each_with_index do |image, index| %>
       <li>
-        <%= link_to image_tag(i.thumbnail("200x200#c").url), i.thumbnail("900x600").url %>
+        <%= link_to image_tag(image.thumbnail("200x200#c").url), image.thumbnail("900x600").url %>
+        <span class='caption'><%=raw @page.caption_for_image_index(index) %></span>
       </li>
    <% end %>
   </ul>

data/refinerycms-page-images.gemspec

@@ -1,17 +1,16 @@
 Gem::Specification.new do |s|
   s.name              = %q{refinerycms-page-images}
-  s.version           = %q{2.0.1}
-  s.description       = %q{Page Images Engine for Refinery CMS}
-  s.date              = Date.today.strftime("%Y-%m-%d")
-  s.summary           = %q{Page Images Engine for Refinery CMS}
-  s.email             = %q{dave@resolvedigital.com}
-  s.homepage          = %q{http://github.com/resolve/refinerycms-page-images}
+  s.version           = %q{2.1.0}
+  s.description       = %q{Attach images to pages ins Refinery CMS}
+  s.summary           = %q{Page Images extension for Refinery CMS}
+  s.email             = %q{info@refinerycms.com}
+  s.homepage          = %q{http://github.com/refinery/refinerycms-page-images}
   s.authors           = ['Philip Arndt', 'David Jones']
   s.require_paths     = %w(lib)
+  s.license            = %q{MIT}
 
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- spec/*`.split("\n")
 
-  s.add_dependency    'refinerycms-pages', '~> 2.0.0'
-  s.add_development_dependency 'refinerycms-testing', '~> 2.0.0'
+  s.add_dependency    'refinerycms-pages', '~> 2.1.0'
 end

data/spec/factories/page-images.rb

@@ -1,9 +1,9 @@
 FactoryGirl.define do
   factory :page_with_image, :parent => :page do
-    after_create { |p| p.images << Factory(:image) }
+    after(:create) { |p| p.images << FactoryGirl.create(:image) }
   end
 
   factory :blog_post_with_image, :parent => :blog_post do
-    after_create { |b| b.images << Factory(:image) }
+    after(:create) { |b| b.images << FactoryGirl.create(:image) }
   end if defined? Refinery::Blog::Post
 end