spree_showcase 0.5.2 → 0.5.3

data/README.md

@@ -1,28 +1,43 @@
 Spree Showcase
 ===========
-
+#### For anyone who recently upgraded on the master, please pull a file from the gem, please pull a file from the lib.
+ 
+    spree_showcase/lib/generators/spree_showcase/install/assets/javascripts/store/showcase.js.erb
+    
 Spree Showcase is a simple extension that allows you to create the good ol' slideshow. The goal is to create a slideshow extension that makes things easy for the users and programmers. Minimal effort needed.
 
 The secondary objective is to create a slideshow template that allows most types of JS slider to be implemented easily into Spree. 
 
-Currently, this is the first iteration of the slideshow extension at v0.1. Contributors are greatly welcomed =)
+#### Screenshot of Frontend:
+![Screenshot of Frontend](https://github.com/downloads/daemonsy/spree_showcase/in%20action.png)
+
+#### Admin Backend: 
+![Screenshot of Backend](https://github.com/downloads/daemonsy/spree_showcase/Screen%20Shot%202012-05-09%20at%202.07.00%20AM.png)
+
+Currently, this is the first iteration of the slideshow extension at v0.5.2. Contributors are greatly welcomed =)
 
 **Next to come:**
 - Adding sliders to different layout positions
 - Enabling more options to be customized in the Admin Menu
 
-Example
+Installation
 =======
 Get a clean Spree Installation
 
-rails new spree_demo
-cd spree_demo
-spree install
+```rails new spree_demo```
+```cd spree_demo```
+```spree install```
+
+```gem 'spree_showcase', :git=>"git://github.com/daemonsy/spree_showcase" # Into Gemfile```
+
+OR 
+
+```gem 'spree_showcase' # Ruby Gems```
 
-gem 'spree_showcase', :git=>"git://github.com/daemonsy/spree_showcase" # Into Gemfile
+```bundle install```
+```rails g spree_showcase:install```
 
-bundle install
-rails g spree_showcase:install
+**Remember** to run ```rake assets:clean```, otherwise the javascript library might not be loaded.
 
 Testing
 -------

data/app/controllers/spree/admin/showcase_settings_controller.rb

@@ -2,11 +2,31 @@ module Spree
   module Admin
     class ShowcaseSettingsController < BaseController
      def show
-        @preferences = [:enabled, :thumbnail_style, :showcase_style, :number_of_slides_to_show]
+        @preferences = [:enabled,
+                        :thumbnail_style,
+                        :showcase_style,
+                        :number_of_slides_to_show,
+                        :slideshow,
+                        :animation_type,
+                        :slideshow_speed,
+                        :animation_duration,
+                        :randomize,
+                        :animation_loop,
+                        :pause_on_hover]
       end
      
       def edit
-        @preferences = [:enabled, :thumbnail_style, :showcase_style, :number_of_slides_to_show]
+        @preferences = [:enabled,
+                        :thumbnail_style,
+                        :showcase_style,
+                        :number_of_slides_to_show,
+                        :slideshow,
+                        :animation_type,
+                        :slideshow_speed,
+                        :animation_duration,
+                        :randomize,
+                        :animation_loop,
+                        :pause_on_hover]
       end
      
       def update

data/app/overrides/add_showcase_to_admin_configuration_menu.rb

@@ -3,7 +3,7 @@ Deface::Override.new(:virtual_path => 'spree/admin/configurations/index',
                      :insert_bottom => "[data-hook='admin_configurations_menu']",
                      :text => %q{
                         <tr>
-                          <td><%= link_to 'Showcase Slider', admin_slides_path %></td>
-                          <td>Showcase Slides & Settings</td>
+                          <td><%= link_to t(:showcase_slider), admin_slides_path %></td>
+                          <td><%= t(:showcase_settings) %></td>
                         </tr> })
 

data/app/overrides/add_showcase_to_admin_configurations_side_menu.rb

@@ -2,6 +2,6 @@ Deface::Override.new(
   :virtual_path => 'spree/admin/shared/_configuration_menu',
   :name => 'add_showcase_to_admin_configurations_side_menu',
   :insert_bottom => "[data-hook='admin_configurations_sidebar_menu']",
-  :text => %q{<%= configurations_sidebar_menu_item 'Showcase Slider', admin_slides_path %>}
+  :text => %q{<%= configurations_sidebar_menu_item t(:showcase_slider), admin_slides_path %>}
 )
 

data/app/views/spree/admin/showcase_settings/edit.html.erb

@@ -8,7 +8,7 @@
       type = SpreeShowcase::Config.preference_type(key) %>
       <%= label_tag(key, t(key) + ': ') + tag(:br) if type != :boolean %>
       <%= preference_field_tag(key, SpreeShowcase::Config[key], :type => type) %>
-      <%= label_tag(key, t(key)) + tag(:br) if type == :boolean %>
+      <%= label_tag(key, t(key)) + tag(:br) if type == :boolean %> <br />
   <% end %>
   </fieldset>
   <p class="form-buttons" data-hook="buttons">

data/app/views/spree/admin/slides/_form.html.erb

@@ -18,7 +18,7 @@
 <% end %>
 
 <%= f.field_container :thumbnail_message do %>
-	<%= f.label "Thumb Message" %>
+	<%= f.label :thumbnail_message, t(:thumbnail_message) %>
 	<%= f.text_field :thumbnail_message %>
 <% end %>
 <%= f.field_container :published do %>

data/app/views/spree/admin/slides/index.html.erb

@@ -3,18 +3,18 @@
 <div class="toolbar" data-hook="toolbar">
   <ul class="actions">
     <li>
-      <p><%= button_link_to 'New Slide', new_object_url, :icon => 'add', :id => 'admin_new_slide_link' %></p>
+      <p><%= button_link_to t(:new_slide), new_object_url, :icon => 'add', :id => 'admin_new_slide_link' %></p>
     </li>
   </ul>
   <br class="clear" />
 </div>
 
-<h1>Showcase </h1>
+<h1><%= t(:showcase) %></h1>
 
 <table class="index sortable" id="listing_slides" data-hook data-sortable-link="<%= update_positions_admin_slides_url %>">
   <thead>
     <tr data-hook="admin_slides_index_headers">
-      <th>Name</th>
+      <th><%= t(:name) %></th>
       <th data-hook="admin_slides_index_header_actions"></th>
     </tr>
   </thead>
@@ -30,5 +30,3 @@
     <% end %>
   </tbody>
 </table>
-
-<p>Showcase is done by Damon Aw - @daemonsy</p>

data/app/views/spree/admin/slides/new.html.erb

@@ -1,6 +1,6 @@
 <%= render :partial => 'spree/admin/shared/configuration_menu' %>
 <%= render :partial=>'spree/admin/shared/showcase_submenu'%>
-<h1>New Showcase Slide</h1>
+<h1><%= t(:new_showcase_slide) %></h1>
 <%= render 'spree/shared/error_messages', :target => @slide %>
 
 <%= form_for [:admin, @slide] , :html => { :multipart => true } do |f| %>

data/app/views/spree/admin/slides/show.html.erb

@@ -28,7 +28,7 @@
     </td>
   </tr>
   <tr data-hook="image_file_name">
-    <th><%= t(:image_file_name) %></th>
+    <th><%= t(:image) %></th>
     <td>
       <%= @slide.image_file_name %>
     </td>

data/config/locales/fr.yml

@@ -0,0 +1,15 @@
+fr:
+  new_slide: "Ajouter une image"
+  showcase: "Diaporama"
+  slides: "Images"
+  slide: "Image"
+  showcase_slider: "Diaporama"
+  showcase_settings: "Options du diaporama"
+  edit_showcase_settings: "Edition des propriétés du diaporama"
+  body: "Corps"
+  target_url: "Cible du lien"
+  image: Image
+  thumbnail_message: "Texte de la miniature"
+  published: "Publiée"
+  new_showcase_slide: "Nouvelle image"
+  edit_showcase_slide: "Edition de l'image"

data/lib/generators/spree_showcase/install/assets/javascripts/store/showcase.js.erb

@@ -0,0 +1,32 @@
+//= require store/jquery.flexslider
+// Put your own showcase trigger here if you wish to use another JS Library. Remember to require it in all.js or this file.
+
+$(window).load(function() {
+  $('.flexslider').flexslider({
+	animation: "<%= SpreeShowcase::Config[:animation_type] %>",                 //String: Select your animation type, "fade" or "slide"
+	slideDirection: "horizontal",                                               //String: Select the sliding direction, "horizontal" or "vertical"
+	slideshow: "<%= SpreeShowcase::Config[:slideshow] %>",                      //Boolean: Animate slider automatically
+	slideshowSpeed: "<%= SpreeShowcase::Config[:slideshow_speed] %>",           //Integer: Set the speed of the slideshow cycling, in milliseconds
+	animationDuration: "<%= SpreeShowcase::Config[:animation_duration] %>",     //Integer: Set the speed of animations, in milliseconds
+	directionNav: false,            //Boolean: Create navigation for previous/next navigation? (true/false)
+	controlNav: true,               //Boolean: Create navigation for paging control of each clide? Note: Leave true for manualControls usage
+	keyboardNav: true,              //Boolean: Allow slider navigating via keyboard left/right keys
+	mousewheel: false,              //Boolean: Allow slider navigating via mousewheel
+	prevText: "Previous",           //String: Set the text for the "previous" directionNav item
+	nextText: "Next",               //String: Set the text for the "next" directionNav item
+	pausePlay: false,               //Boolean: Create pause/play dynamic element
+	pauseText: 'Pause',             //String: Set the text for the "pause" pausePlay item
+	playText: 'Play',               //String: Set the text for the "play" pausePlay item
+	randomize: "<%= SpreeShowcase::Config[:randomize] %>",                      //Boolean: Randomize slide order
+	slideToStart: 0,                //Integer: The slide that the slider should start on. Array notation (0 = first slide)
+	animationLoop: "<%= SpreeShowcase::Config[:animation_loop] %>",             //Boolean: Should the animation loop? If false, directionNav will received "disable" classes at either end
+	pauseOnAction: true,            //Boolean: Pause the slideshow when interacting with control elements, highly recommended.
+	pauseOnHover: "<%= SpreeShowcase::Config[:pause_on_hover] %>",              //Boolean: Pause the slideshow when hovering over slider, then resume when no longer hovering
+	controlsContainer: ".flex-container",                   //Selector: Declare which container the navigation elements should be appended too. Default container is the flexSlider element. Example use would be ".flexslider-container", "#container", etc. If the given element is not found, the default action will be taken.
+	manualControls: ".custom-controls li a",                //Selector: Declare custom control navigation. Example would be ".flex-control-nav li" or "#tabs-nav li img", etc. The number of elements in your controlNav should match the number of slides/tabs.
+	start: function(){},            //Callback: function(slider) - Fires when the slider loads the first slide
+	before: function(){},           //Callback: function(slider) - Fires asynchronously with each slider animation
+	after: function(){},            //Callback: function(slider) - Fires after each slider animation completes
+	end: function(){}               //Callback: function(slider) - Fires when the slider reaches the last slide (asynchronous)
+	});
+});

data/lib/generators/spree_showcase/install/install_generator.rb

@@ -5,17 +5,17 @@ module SpreeShowcase
 
       def add_javascripts
         append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_showcase\n"
-        if copy_file "javascripts/store/showcase.js", "app/assets/javascripts/store/showcase.js"
-          puts "Copied showcase.js into app/assets/javascripts/store/showcase.js\n"
+        if copy_file "javascripts/store/showcase.js.erb", "app/assets/javascripts/store/showcase.js.erb"
+          puts "Copied showcase.js.erb into app/assets/javascripts/store/showcase.js.erb\n"
         else
-          puts "[Failed] File copying showcase.js => app/assets/javascripts/store/showcase.js\n"
+          puts "[Failed] File copying showcase.js.erb => app/assets/javascripts/store/showcase.js.erb\n"
         end
         if copy_file "javascripts/store/jquery.flexslider.js", "app/assets/javascripts/store/jquery.flexslider.js"
           puts "Copied jquery.flexslider.js into app/assets/javascripts/store/jquery.flexslider.js\n"
         else
           puts "[Failed] File copying jquery.flexslider.js => app/assets/javascripts/store/jquery.flexslider.js\n"
         end
-        puts "Copying JS assets into your app's javascripts/store directory. The file showcase.js is required by the extension and is used to activate slideshow.\n"
+        puts "Copying JS assets into your app's javascripts/store directory. The file showcase.js.erb is required by the extension and is used to activate slideshow.\n"
       end
 
       def add_stylesheets
@@ -58,7 +58,8 @@ module SpreeShowcase
       end
       
       def complete
-        puts "\nEverything is done! To summarize, _showcase.html.erb => HTML template, showcase.css.scss & showcase.js => assets. Edit these 3 files to fit run the slideshow."
+        puts "\nEverything is done! To summarize, _showcase.html.erb => HTML template, showcase.css.scss & showcase.js.erb => assets. Edit these 3 files to fit run the slideshow."
+        puts "\nPlease run rake assets:clean (IMPORTANT) to clear any precompiled assets from fresh install of Spree."
       end
     end
   end

data/lib/spree/showcase_configuration.rb

@@ -4,5 +4,13 @@ class Spree::ShowcaseConfiguration < Spree::Preferences::Configuration
   preference :thumbnail_style, :string, :default=>"220x110#"
   preference :showcase_style, :string, :default =>"940x470#"
   preference :number_of_slides_to_show, :integer, :default=>4
+  
+  preference :slideshow, :boolean, :default => true
+  preference :animation_type, :string, :default=>"fade"
+  preference :slideshow_speed, :integer, :default=>3000
+  preference :animation_duration, :integer, :default=>500
+  preference :randomize, :boolean, :default => false
+  preference :animation_loop, :boolean, :default => true
+  preference :pause_on_hover, :boolean, :default => true
 end
 

data/spree_showcase.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_showcase'
-  s.version     = '0.5.2'
+  s.version     = '0.5.3'
   s.summary     = 'A Simple Spree Slider'
   s.description = 'A simple slider accommodator, using Flexslider as default'
   s.required_ruby_version = '>= 1.8.7'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_showcase
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-12 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -146,11 +146,12 @@ files:
 - app/views/spree/slides/_content_insert.html.erb
 - app/views/spree/slides/_showcase.html.erb
 - config/locales/en.yml
+- config/locales/fr.yml
 - config/routes.rb
 - db/migrate/20120506161852_create_slides.rb
 - db/migrate/20120507074922_add_position_to_slide.rb
 - lib/generators/spree_showcase/install/assets/javascripts/store/jquery.flexslider.js
-- lib/generators/spree_showcase/install/assets/javascripts/store/showcase.js
+- lib/generators/spree_showcase/install/assets/javascripts/store/showcase.js.erb
 - lib/generators/spree_showcase/install/assets/partials/_showcase.html.erb
 - lib/generators/spree_showcase/install/assets/stylesheets/store/flexslider.css
 - lib/generators/spree_showcase/install/assets/stylesheets/store/showcase.css.scss
@@ -160,8 +161,6 @@ files:
 - lib/spree_showcase/engine.rb
 - script/rails
 - spec/spec_helper.rb
-- spree_showcase-0.5.0.gem
-- spree_showcase-0.5.1.gem
 - spree_showcase.gemspec
 homepage: http://theidealweb.com
 licenses: []

data/lib/generators/spree_showcase/install/assets/javascripts/store/showcase.js

@@ -1,32 +0,0 @@
-//= require store/jquery.flexslider
-// Put your own showcase trigger here if you wish to use another JS Library. Remember to require it in all.js or this file.
-
-$(window).load(function() {
-  $('.flexslider').flexslider({
-	animation: "slide",              //String: Select your animation type, "fade" or "slide"
-	slideDirection: "horizontal",   //String: Select the sliding direction, "horizontal" or "vertical"
-	slideshow: true,                //Boolean: Animate slider automatically
-	slideshowSpeed: 12000,           //Integer: Set the speed of the slideshow cycling, in milliseconds
-	animationDuration: 500,         //Integer: Set the speed of animations, in milliseconds
-	directionNav: false,             //Boolean: Create navigation for previous/next navigation? (true/false)
-	controlNav: true,               //Boolean: Create navigation for paging control of each clide? Note: Leave true for manualControls usage
-	keyboardNav: true,              //Boolean: Allow slider navigating via keyboard left/right keys
-	mousewheel: false,              //Boolean: Allow slider navigating via mousewheel
-	prevText: "Previous",           //String: Set the text for the "previous" directionNav item
-	nextText: "Next",               //String: Set the text for the "next" directionNav item
-	pausePlay: false,               //Boolean: Create pause/play dynamic element
-	pauseText: 'Pause',             //String: Set the text for the "pause" pausePlay item
-	playText: 'Play',               //String: Set the text for the "play" pausePlay item
-	randomize: false,               //Boolean: Randomize slide order
-	slideToStart: 0,                //Integer: The slide that the slider should start on. Array notation (0 = first slide)
-	animationLoop: true,            //Boolean: Should the animation loop? If false, directionNav will received "disable" classes at either end
-	pauseOnAction: true,            //Boolean: Pause the slideshow when interacting with control elements, highly recommended.
-	pauseOnHover: true,            //Boolean: Pause the slideshow when hovering over slider, then resume when no longer hovering
-	controlsContainer: ".flex-container",          //Selector: Declare which container the navigation elements should be appended too. Default container is the flexSlider element. Example use would be ".flexslider-container", "#container", etc. If the given element is not found, the default action will be taken.
-	manualControls: ".custom-controls li a",             //Selector: Declare custom control navigation. Example would be ".flex-control-nav li" or "#tabs-nav li img", etc. The number of elements in your controlNav should match the number of slides/tabs.
-	start: function(){},            //Callback: function(slider) - Fires when the slider loads the first slide
-	before: function(){},           //Callback: function(slider) - Fires asynchronously with each slider animation
-	after: function(){},            //Callback: function(slider) - Fires after each slider animation completes
-	end: function(){}               //Callback: function(slider) - Fires when the slider reaches the last slide (asynchronous)
-	});
-});