tb_banners 1.0.2 → 1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjQ3MjEyYWJkZjdiNjEyN2VjMjQ1NWJlMzVmMjYyNTcxYWNhOTY1Yg==
-  data.tar.gz: !binary |-
-    ZDE5OTMxYmEyYWUyOWVjNWMwZmFiMDQwMWY3MmU5YWQwZTk5OWQwOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTdjMmJiNzI0YTI1MzQ4MDY1ODFkZDM3ZGM3ZGM1N2U4OTYzZWQ2ZjZlZDI0
-    NTkwM2NlMGQyOWNlODg3MWNkZTk4NWFiNmY3MGU0NWM0NTY5YmU5ZGE3YjM3
-    ZDNhODJjYWZjZTc1MzkwOTlhYTE0M2EzYzAwZGQ0ZWM3MzE2NjA=
-  data.tar.gz: !binary |-
-    ZGRjZTQ1NjNkMzFjNjcyODBiNGI0MGRlOTU1MjU0Yzk2YTMzN2UwY2Y3MTY1
-    ZTI2YmVkZTk0NTljMjczNzVjM2M1ZGYwZjRmZTljZmQ1NmRjMGQ4MTkwNDlh
-    NDhmYmU4YjI0YWVkNmJiYmVkOTk3YTM2OWNkMWUyNmVkYzdhOTk=
+SHA1:
+  metadata.gz: 8e831e21b2d55bc27d1fb1309f285fd88778c73b
+  data.tar.gz: 7c21487ee577fce3696d40aa050eaa700c69e5b8
+SHA512:
+  metadata.gz: f7ecbd063a6ad0896cb314af51b07292c145f2e25b9ddc7ce1635f589410f560cea040cc64d647643083336906df1d59ff29dcb61506c864cb96c2a224d8cc49
+  data.tar.gz: 20ce6d2036099e7e5e431e68f9ab8f71609df53c7c08b8e7758ae4387e35311ed5e7b0fd1cba3e0e72fe19f8a7fe516d0423fbbb4c2d7b3c35f3ffda6cda91f9

data/README.markdown

@@ -1,12 +1,12 @@
-# Spud Banners
+# Twice Baked Banners
 
-Spud Banners is an engine for creating and managing rotating banner sets, designed for use with [Spud][spud].
+TB Banners is an engine for creating and managing rotating banner sets, designed for use with [Twice Baked][tb].
 
 ## Installation/Usage
 
 1. In your Gemfile add the following
 
-		gem 'spud_banners'
+		gem 'tb_banners'
 
 2. Run bundle install
 3. Copy in database migrations to your new rails project
@@ -14,11 +14,11 @@ Spud Banners is an engine for creating and managing rotating banner sets, design
 		bundle exec rake railties:install:migrations
 		rake db:migrate
 
-4. Run a rails server instance and point your browser to `/spud/admin`
+4. Run a rails server instance and point your browser to `/admin`
 
 ## Configuration
 
-Spud Banners accepts the following configuration options:
+TB Banners accepts the following configuration options:
 
 ```ruby
 Spud::Banners.configure do |config|
@@ -31,7 +31,7 @@ end
 
 ## Creating a Banner Set
 
-Banner Sets are created in the Spud admin. When creating a Set, you have the following options:
+Banner Sets are created in the admin dashboard. When creating a Set, you have the following options:
 
 - **Name:** The unique identifier used to render this set
 - **Width:** Maximum width of uploaded banners
@@ -99,7 +99,7 @@ Displaying banners using the helper, with a block for even more custom html.
 
 ## Liquid
 
-Spud Banners comes with its own custom [Liquid][liquid] tag. For now the liquid tag only supports rendering the standard html as generated by the `spud_banners_for_set`. Will provide support more advanced options in the future.
+TB Banners comes with its own custom [Liquid][liquid] tag. For now the liquid tag only supports rendering the standard html as generated by the `spud_banners_for_set`. Will provide support more advanced options in the future.
 
 Usage:
 
@@ -107,9 +107,28 @@ Usage:
 	<%= raw Liquid::Template.parse("{% spud_banner_set Promotions %}").render %>
 ```
 
+## Rich Text
+
+Banner Sets contain a configuration for rich text. Turning this feature on will enable a rich text editor on individual banners. The default setting for this option is off. 
+
+Rich text is intended to be more of an edge case feature, and should be used only if your banner needs to include an editable HTML block. The built-in helpers described earlier will not automatically include your rich text; If you want to use this feature, you should supply a block to the helper and render the rich text yourself. 
+
+```erb
+	<ul id="slides">
+		<% spud_banners_for_set(:promotions) do |banner| %>
+			<li class="custom_slide">
+				<%= spud_banner_tag(banner) %>
+				<div class="custom_slide_rich_text">
+					<%= raw(banner.rich_text) %>
+				</div>
+			</li>
+		<% end %>
+	</ul>
+```
+
 ## Slideshows
 
-Spud Banners does not provide a built-in slideshow animation library. Instead, we make it easy for you to integrate into any number of popular JavaScript slideshow plugins available on the web, or even to write your own from scratch.
+TB Banners does not provide a built-in slideshow animation library. Instead, we make it easy for you to integrate into any number of popular JavaScript slideshow plugins available on the web, or even to write your own from scratch.
 
 Below is an example of integration with [SlidesJs][slidesjs], a jQuery plugin.
 
@@ -131,7 +150,7 @@ Below is an example of integration with [SlidesJs][slidesjs], a jQuery plugin.
 	<script src="/slides.jquery.js" type="text/javascript"></script>
 	<script>
 		$(document).ready(function(){
-			$("#banners").slides({
+			$("#banners").slidesjs({
 				play: 5000,
 				container: 'spud_banner_set'
 			});
@@ -139,6 +158,6 @@ Below is an example of integration with [SlidesJs][slidesjs], a jQuery plugin.
 	</script>
 ```
 
-[spud]:https://github.com/spud-rails/spud_core_admin
+[tb]:https://bitbucket.org/westlakedesign/tb_core
 [slidesjs]:http://www.slidesjs.com
 [liquid]:https://github.com/Shopify/liquid

data/app/controllers/admin/banner_sets_controller.rb

@@ -1,6 +1,5 @@
 class Admin::BannerSetsController < Admin::ApplicationController
 
-  cache_sweeper :spud_banner_sweeper, :only => [:create, :update, :destroy]
   before_filter :get_record, :only => [:show, :edit, :update, :destroy]
   respond_to :html
   belongs_to_spud_app :banner_sets
@@ -22,7 +21,7 @@ class Admin::BannerSetsController < Admin::ApplicationController
   end
 
   def create
-    @banner_set = SpudBannerSet.new(params[:spud_banner_set])
+    @banner_set = SpudBannerSet.new(banner_set_params)
     if @banner_set.save
       flash.now[:notice] = 'BannerSet created successfully' 
       render 'create'
@@ -36,9 +35,8 @@ class Admin::BannerSetsController < Admin::ApplicationController
   end
 
   def update
-    if @banner_set.update_attributes(params[:spud_banner_set])
+    if @banner_set.update_attributes(banner_set_params)
       flash.now[:notice] = 'BannerSet updated successfully'
-      @banner_set.reprocess_banners!
       render 'create'
     else
       render 'edit', :status => 422
@@ -65,4 +63,8 @@ private
     end
   end
 
+  def banner_set_params
+    params.require(:spud_banner_set).permit(:cropped, :height, :name, :short_name, :width, :has_rich_text)
+  end
+
 end

data/app/controllers/admin/banners_controller.rb

@@ -2,7 +2,6 @@ class Admin::BannersController < Admin::ApplicationController
 
   include RespondsToParent
 
-  cache_sweeper :spud_banner_sweeper, :only => [:create, :update, :destroy]
   before_filter :get_set, :only => [:new, :create]
   before_filter :get_record, :only => [:edit, :update, :destroy]
   respond_to :html
@@ -15,7 +14,7 @@ class Admin::BannersController < Admin::ApplicationController
 
   def create
     @banner = @banner_set.banners.build
-    @banner.attributes = params[:spud_banner]
+    @banner.attributes = banner_params
 
     last_banner = SpudBanner.select('sort_order').where(:spud_banner_set_id => @banner_set.id).order('sort_order desc').first
     if last_banner
@@ -43,14 +42,14 @@ class Admin::BannersController < Admin::ApplicationController
 
   def update
     if request.xhr?
-      if @banner.update_attributes(params[:spud_banner])
+      if @banner.update_attributes(banner_params)
         flash.now[:notice] = 'SpudBanner created successfully' 
         render 'show'
       else
         render 'edit', :status => 422
       end
     else
-      @banner.update_attributes(params[:spud_banner])
+      @banner.update_attributes(banner_params)
       respond_to_parent do
         render 'legacy', :formats => [:js]
       end
@@ -101,4 +100,8 @@ private
     end
   end
 
+  def banner_params
+    params.require(:spud_banner).permit(:banner, :link_to, :link_target, :title, :alt, :sort_order, :rich_text)
+  end
+
 end

data/app/helpers/spud_banners_helper.rb

@@ -1,13 +1,19 @@
 module SpudBannersHelper
 
   def spud_banners_for_set(set_or_identifier, options = {})
-    limit = options[:limit] || false
     if set_or_identifier.is_a?(SpudBannerSet)
       banner_set = set_or_identifier
     else
       banner_set = SpudBannerSet.find_by_identifier(set_or_identifier)
     end
     return '' if banner_set.blank?
+    cache(banner_set) do
+      concat spud_banners_set_tag(banner_set, options)
+    end
+  end
+
+  def spud_banners_set_tag(banner_set, options = {})
+    limit = options[:limit] || false
     if block_given?
       banner_set.banners.limit(limit).each do |banner|
         yield(banner)

data/app/models/spud_banner.rb

@@ -1,6 +1,5 @@
 class SpudBanner < ActiveRecord::Base
-  attr_accessible :banner, :link_to, :link_target, :title, :alt, :sort_order, :rich_text
-  belongs_to :owner, :class_name => 'SpudBannerSet', :foreign_key => 'spud_banner_set_id', :inverse_of => :banners
+  belongs_to :owner, :class_name => 'SpudBannerSet', :foreign_key => 'spud_banner_set_id', :inverse_of => :banners, :touch => true
 
   has_attached_file :banner, 
     :styles => lambda { |attachment| attachment.instance.dynamic_styles },

data/app/models/spud_banner_set.rb

@@ -1,11 +1,14 @@
 class SpudBannerSet < ActiveRecord::Base
-  attr_accessible :cropped, :height, :name, :short_name, :width, :has_rich_text
-  has_many :banners, :class_name => 'SpudBanner', :order => 'sort_order asc', :dependent => :destroy, :inverse_of => :owner
+  has_many :banners, ->{ order('sort_order asc') }, :class_name => 'SpudBanner', :dependent => :destroy, :inverse_of => :owner
 
   validates_presence_of :name
   validates_uniqueness_of :name
   validates_numericality_of :width, :height
 
+  acts_as_spud_liquid_tag :spud_banner_set, :name
+
+  after_update :check_for_dimension_change
+
   def self.find_by_identifier(identifier)
     if identifier.class == String
       banner_set = SpudBannerSet.find_by_name(identifier)
@@ -27,4 +30,12 @@ class SpudBannerSet < ActiveRecord::Base
     return name
   end
 
+private
+
+  def check_for_dimension_change
+    if self.height_changed? || self.width_changed? || self.cropped_changed?
+      self.reprocess_banners!
+    end
+  end
+
 end

data/lib/spud_banners/liquid_tags.rb

@@ -5,8 +5,7 @@ module Spud
   module Banners
     class BannerSetTag < Liquid::Tag
 
-      include Sprockets::Helpers::RailsHelper
-      include Sprockets::Helpers::IsolatedHelper
+      include Sprockets::Rails::Helper
       include ActionView::Helpers
       include ActionView::Context
       include SpudBannersHelper
@@ -16,7 +15,7 @@ module Spud
       end
 
       def tag_name
-        return 'banner_set'
+        return 'spud_banner_set'
       end
 
       def tag_value
@@ -24,9 +23,9 @@ module Spud
       end
 
       def render(context)
-        return spud_banners_for_set(@banner_set)
+        return spud_banners_set_tag(@banner_set)
       end
 
     end
   end
-end
+end

data/lib/spud_banners/version.rb

@@ -1,5 +1,5 @@
 module Spud
   module Banners
-    VERSION = "1.0.2"
+    VERSION = "1.1"
   end
 end

data/spec/dummy/config/application.rb

@@ -28,6 +28,7 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
+    config.i18n.enforce_available_locales = true
 
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
@@ -43,12 +44,6 @@ module Dummy
     # like if you have constraints or database-specific column types
     # config.active_record.schema_format = :sql
 
-    # Enforce whitelist mode for mass assignment.
-    # This will create an empty whitelist of attributes available for mass-assignment for all models
-    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
-    # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
-
     # Enable the asset pipeline
     config.assets.enabled = true
 

data/spec/dummy/config/environments/test.rb

@@ -11,8 +11,15 @@ Dummy::Application.configure do
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
 
+  # Deprecated
   # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  # config.whiny_nils = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
 
   # Show full error reports and disable caching
   config.consider_all_requests_local       = true
@@ -29,8 +36,9 @@ Dummy::Application.configure do
   # ActionMailer::Base.deliveries array.
   config.action_mailer.delivery_method = :test
 
+  # Deprecated
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/spec/dummy/config/initializers/secret_token.rb

@@ -5,3 +5,4 @@
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
 Dummy::Application.config.secret_token = 'dacbd8a483ea9645b13e97018089cbc9da8bf98f99a0be873cdb565d8f64c066974f37cbe7e8b4fedaadd057bce78d1d9326b0768120d2a693de8165df286693'
+Dummy::Application.config.secret_key_base = 'b43711419c807b9c9efe9365dd79f87ebe31e9f72e1aa6744c1ecac68aace664c0a3a4f791d92bd2fa324fce1d6d09701a54b88453f131b7c460eeb9c530bd72'

data/spec/dummy/db/migrate/20140120174546_create_tb_liquid_spud_liquid_tags.tb_liquid.rb

@@ -0,0 +1,13 @@
+# This migration comes from tb_liquid (originally 20140110142037)
+class CreateTbLiquidSpudLiquidTags < ActiveRecord::Migration
+  def change
+    create_table :spud_liquid_tags do |t|
+      t.integer :attachment_id
+      t.string :attachment_type
+      t.string :tag_name
+      t.string :value
+      t.timestamps
+    end
+    add_index :spud_liquid_tags, [:tag_name, :value]
+  end
+end

data/spec/dummy/db/schema.rb

@@ -9,99 +9,110 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
-
-ActiveRecord::Schema.define(:version => 20130920154448) do
-
-  create_table "spud_banner_sets", :force => true do |t|
-    t.string   "name",                             :null => false
-    t.integer  "width",                            :null => false
-    t.integer  "height",                           :null => false
-    t.boolean  "cropped",       :default => true
-    t.datetime "created_at",                       :null => false
-    t.datetime "updated_at",                       :null => false
-    t.boolean  "has_rich_text", :default => false
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20140120174546) do
+
+  create_table "spud_banner_sets", force: true do |t|
+    t.string   "name",                          null: false
+    t.integer  "width",                         null: false
+    t.integer  "height",                        null: false
+    t.boolean  "cropped",       default: true
+    t.datetime "created_at",                    null: false
+    t.datetime "updated_at",                    null: false
+    t.boolean  "has_rich_text", default: false
   end
 
-  add_index "spud_banner_sets", ["name"], :name => "index_spud_banner_sets_on_name", :unique => true
+  add_index "spud_banner_sets", ["name"], name: "index_spud_banner_sets_on_name", unique: true, using: :btree
 
-  create_table "spud_banners", :force => true do |t|
-    t.integer  "spud_banner_set_id",                       :null => false
+  create_table "spud_banners", force: true do |t|
+    t.integer  "spud_banner_set_id",                    null: false
     t.string   "link_to"
-    t.string   "link_target",         :default => "_self"
+    t.string   "link_target",         default: "_self"
     t.string   "title"
     t.string   "alt"
-    t.integer  "sort_order",          :default => 0
+    t.integer  "sort_order",          default: 0
     t.string   "banner_file_name"
     t.string   "banner_content_type"
     t.integer  "banner_file_size"
     t.datetime "banner_updated_at"
-    t.datetime "created_at",                               :null => false
-    t.datetime "updated_at",                               :null => false
+    t.datetime "created_at",                            null: false
+    t.datetime "updated_at",                            null: false
     t.text     "rich_text"
   end
 
-  add_index "spud_banners", ["spud_banner_set_id"], :name => "index_spud_banners_on_spud_banner_set_id"
+  add_index "spud_banners", ["spud_banner_set_id"], name: "index_spud_banners_on_spud_banner_set_id", using: :btree
+
+  create_table "spud_liquid_tags", force: true do |t|
+    t.integer  "attachment_id"
+    t.string   "attachment_type"
+    t.string   "tag_name"
+    t.string   "value"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "spud_liquid_tags", ["tag_name", "value"], name: "index_spud_liquid_tags_on_tag_name_and_value", using: :btree
 
-  create_table "spud_permissions", :force => true do |t|
-    t.string   "name",       :null => false
-    t.string   "tag",        :null => false
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+  create_table "spud_permissions", force: true do |t|
+    t.string   "name",       null: false
+    t.string   "tag",        null: false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  add_index "spud_permissions", ["tag"], :name => "index_spud_permissions_on_tag", :unique => true
+  add_index "spud_permissions", ["tag"], name: "index_spud_permissions_on_tag", unique: true, using: :btree
 
-  create_table "spud_role_permissions", :force => true do |t|
-    t.integer  "spud_role_id",        :null => false
-    t.string   "spud_permission_tag", :null => false
-    t.datetime "created_at",          :null => false
-    t.datetime "updated_at",          :null => false
+  create_table "spud_role_permissions", force: true do |t|
+    t.integer  "spud_role_id",        null: false
+    t.string   "spud_permission_tag", null: false
+    t.datetime "created_at",          null: false
+    t.datetime "updated_at",          null: false
   end
 
-  add_index "spud_role_permissions", ["spud_permission_tag"], :name => "index_spud_role_permissions_on_spud_permission_tag"
-  add_index "spud_role_permissions", ["spud_role_id"], :name => "index_spud_role_permissions_on_spud_role_id"
+  add_index "spud_role_permissions", ["spud_permission_tag"], name: "index_spud_role_permissions_on_spud_permission_tag", using: :btree
+  add_index "spud_role_permissions", ["spud_role_id"], name: "index_spud_role_permissions_on_spud_role_id", using: :btree
 
-  create_table "spud_roles", :force => true do |t|
+  create_table "spud_roles", force: true do |t|
     t.string   "name"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
   end
 
-  create_table "spud_user_settings", :force => true do |t|
+  create_table "spud_user_settings", force: true do |t|
     t.integer  "spud_user_id"
     t.string   "key"
     t.string   "value"
-    t.datetime "created_at",   :null => false
-    t.datetime "updated_at",   :null => false
+    t.datetime "created_at",   null: false
+    t.datetime "updated_at",   null: false
   end
 
-  create_table "spud_users", :force => true do |t|
+  create_table "spud_users", force: true do |t|
     t.string   "first_name"
     t.string   "last_name"
     t.boolean  "super_admin"
-    t.string   "login",                              :null => false
-    t.string   "email",                              :null => false
-    t.string   "crypted_password",                   :null => false
-    t.string   "password_salt",                      :null => false
-    t.string   "persistence_token",                  :null => false
-    t.string   "single_access_token",                :null => false
-    t.string   "perishable_token",                   :null => false
-    t.integer  "login_count",         :default => 0, :null => false
-    t.integer  "failed_login_count",  :default => 0, :null => false
+    t.string   "login",                           null: false
+    t.string   "email",                           null: false
+    t.string   "crypted_password",                null: false
+    t.string   "password_salt",                   null: false
+    t.string   "persistence_token",               null: false
+    t.string   "single_access_token",             null: false
+    t.string   "perishable_token",                null: false
+    t.integer  "login_count",         default: 0, null: false
+    t.integer  "failed_login_count",  default: 0, null: false
     t.datetime "last_request_at"
     t.datetime "current_login_at"
     t.datetime "last_login_at"
     t.string   "current_login_ip"
     t.string   "last_login_ip"
-    t.datetime "created_at",                         :null => false
-    t.datetime "updated_at",                         :null => false
+    t.datetime "created_at",                      null: false
+    t.datetime "updated_at",                      null: false
     t.string   "time_zone"
     t.integer  "spud_role_id"
   end
 
-  add_index "spud_users", ["email"], :name => "index_spud_users_on_email"
-  add_index "spud_users", ["login"], :name => "index_spud_users_on_login"
-  add_index "spud_users", ["spud_role_id"], :name => "index_spud_users_on_spud_role_id"
+  add_index "spud_users", ["email"], name: "index_spud_users_on_email", using: :btree
+  add_index "spud_users", ["login"], name: "index_spud_users_on_login", using: :btree
+  add_index "spud_users", ["spud_role_id"], name: "index_spud_users_on_spud_role_id", using: :btree
 
 end