dismissible_helpers 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33c181da8b0704b9cd1d3861ca021b2d462cb141
+  data.tar.gz: 3322542ee6be7c5b4271802213b971cbf6eecc8d
+SHA512:
+  metadata.gz: 0e20a08284ecfc77fc89ab11c793f9497dc3eb823d479def4e23c6560364f7796c2de1dbcac325cf735536f556780e0d891a99103bec83cdde0c08db9ce9051b
+  data.tar.gz: 2ffea3bd4cd56bda7d14c03d6edab5b8023fa1c23d4daf376034cd5c8c6ac651d6d84200e97837c2f77b9beb26b8eee507c0eddf38523a01b981156d70205f86

data/README.md

@@ -29,7 +29,7 @@ with the helpers
 ### Default Behavior ###
 
 By default, DismissibleHelpers will use cookies to track the state of
-the dismissed helpers. 
+the dismissed helpers.
 
 ### Adding a dismissible helper to your page ###
 
@@ -58,6 +58,19 @@ The string passed to the method will be used as a key, to track whether or not t
 <% end %>
 ```
 
+#### Restoring helpers
+
+You can allow users to restore a helper if you pass `restorable: true` as an argument after the name of the helper.
+
+```erb
+<%= render_dismissible_helper 'how_to_buy', restorable: true do %>
+  <h2>How to buy stuff</h2>
+  <p>To buy stuff, click look at this:</p>
+  <img src="http://domain.com/img.jpg">
+<% end %>
+```
+
+This will allow the user to hide the helper, as well as display a restore link to display the helper again.
 
 ### Including the routes ###
 
@@ -85,15 +98,33 @@ following call'
 ```javascript
 $(function(){
   $('.dismissible').dismissible({
-    success: function(helper){
+    dismiss: function(helper){
+      helper.slideUp(); //'helper' is the jQuery-wrapped element
+    }
+  });
+});
+```
+
+If you are working with restorable helpers the helper will be hidden instead
+and a show link will be revealed.
+There's a second callback when the show event was invoked as well.
+
+```javascript
+$(function(){
+  $('.dismissible').dismissible({
+    dismiss: function(helper){
       helper.slideUp(); //'helper' is the jQuery-wrapped element
+    },
+    show: function(helper){
+      helper.slideDown();
     }
   });
 });
 ```
+
 ### Using authenticated user ###
 
-DismissibleHelpers will store the dismissed helpers on a model. 
+DismissibleHelpers will store the dismissed helpers on a model.
 If the helper method `current_user` is available, DismissibleHelpers
 will use this to retrieve the current user/account.
 

data/app/assets/javascripts/dismissible_helpers.coffee

@@ -1,29 +1,52 @@
 (($) ->
   $.fn.dismissible = (options) ->
     options = {} if options == undefined
-    if options.closeSelector?
-      closeSelector = options.closeSelector
-    else
-      closeSelector = '.close'
+    options.closeSelector ?= '.close'
+    options.openSelector ?= '.open'
+    options.name = @.attr('data-dismissible-name')
 
-    @find(closeSelector).click (event)  ->
+    @find(options.closeSelector).click (event) ->
       $target = $ event.target
       $helper = $target.parent()
       event.preventDefault()
 
       $helper.dismiss(options)
 
+    @find(options.openSelector).click (event) ->
+      $target = $ event.target
+      $helper = $target.parent()
+      event.preventDefault()
+
+      $helper.restore(options)
+
   $.fn.dismiss = (options) ->
-    name = @.attr('data-dismissible-name') 
-    $.ajax
+    restorable = @.attr('data-restorable') is 'true'
+    $.rails.ajax
       url:       '/dismissed_helpers'
       type:      'POST'
       dataType:  'json'
       data:
-        helper: name
+        helper: options.name
+      success: =>
+        if options? and options.dismiss != undefined
+          options.dismiss(@)
+        else
+          if restorable
+            $(@).children().each ->
+              $(@).toggle()
+          else
+            $(@).remove()
+
+
+  $.fn.restore = (options) ->
+    $.rails.ajax
+      url:       '/dismissed_helpers/' + options.name
+      type:      'DELETE'
+      dataType:  'json'
       success: =>
-        if options? and options.success != undefined
-          options.success(@)
+        if options? and options.show != undefined
+          options.show(@)
         else
-          @.remove()
+          $(@).children().each ->
+            $(@).toggle()
 )(jQuery)

data/config/locales/en.yml

@@ -1,4 +1,5 @@
 en:
   dismissible_helpers:
     actions:
-      close: "Close"
+      close: "Close"
+      open: "Open"

data/lib/dismissible_helpers/content_builder.rb

@@ -7,31 +7,46 @@ class DismissibleHelpers::ContentBuilder
     self.new(*args).build
   end
 
-  def initialize(name, contents=nil)
+  def initialize(name, contents=nil, options={})
     @name = name
     @contents = contents
+    @options = options
   end
 
   def build
     options = {}
     options[:class] = 'dismissible'
-    options[:data] = {:dismissible_name => @name}
-    html = [content_str, close_str].join.html_safe
+    options[:data] = {:dismissible_name => @name, :restorable => restorable?}
+    html = build_markup
     content_tag :div, html, options
   end
 
-  private
+  def build_markup
+    return [content_str, dismissed? ? '' : close_str].join.html_safe
+  end
+
+  protected
+
+  def restorable?
+    return false
+  end
+
+  def dismissed?
+    return @options[:dismissed]
+  end
 
   def content_str
-    @content_str ||= if @contents
-                       @contents
-                     else
-                       t(@name)
-                     end
+    @content_str ||= begin
+      content = if @contents
+                  @contents
+                else
+                  t(@name)
+                end
+      dismissed? ? nil : content
+    end
   end
 
   def close_str
     content_tag(:a, I18n.t(:"dismissible_helpers.actions.close"), :class => 'close', :href => '#')
   end
-
-end
+end

data/lib/dismissible_helpers/controllers/dismissed_helpers.rb

@@ -6,13 +6,35 @@ module DismissibleHelpers::Controllers::DismissedHelpers
     else
       if cookies[:dismissed_helpers].present?
         dismissed_helpers = cookies[:dismissed_helpers].split '|'
-        dismissed_helpers += [params[:helper]]
+        dismissed_helpers += [ current_helper ]
       else
-        dismissed_helpers = [params[:helper]]
+        dismissed_helpers = [ current_helper ]
       end
       cookies[:dismissed_helpers] = dismissed_helpers.join '|'
     end
 
     render :json => {}, :status => :ok
   end
+
+  def destroy
+    Rails.logger.info "destroy '#{current_helper}'"
+    if respond_to?(:current_user) && current_user && current_user.respond_to?(:dismissed_helpers)
+      current_user.dismissed_helpers = current_user.dismissed_helpers.reject { |helper| helper == current_helper }
+      current_user.save!
+    else
+      if cookies[:dismissed_helpers].present?
+        dismissed_helpers = cookies[:dismissed_helpers].split '|'
+        dismissed_helpers = dismissed_helpers - [ current_helper ]
+      end
+      dismissed_helpers ||= []
+      cookies[:dismissed_helpers] = dismissed_helpers.join('|')
+    end
+
+    render :json => {}, :status => :ok
+  end
+
+  private
+  def current_helper
+    return params[:helper].to_s
+  end
 end

data/lib/dismissible_helpers/helpers/dismissible_helpers.rb

@@ -1,10 +1,10 @@
 module DismissibleHelpers::Helpers::DismissibleHelpers
 
-  def render_dismissible_helper(name, &block)
-    unless dismissed?(name)
-      contents = block_given? ? capture(&block) : nil
-      DismissibleHelpers::ContentBuilder.build(name, contents)
-    end
+  def render_dismissible_helper(name, options = {}, &block)
+    contents = block_given? ? capture(&block) : nil
+    restorable = options.fetch(:restorable) { false }
+    builder = restorable ? DismissibleHelpers::RestorableContentBuilder : DismissibleHelpers::ContentBuilder
+    builder.build(name, contents, options.merge({ dismissed: dismissed?(name) }))
   end
 
   private

data/lib/dismissible_helpers/restorable_content_builder.rb

@@ -0,0 +1,32 @@
+module DismissibleHelpers
+  class RestorableContentBuilder < ContentBuilder
+    def build_markup
+      return [content_str, open_str, close_str].join.html_safe
+    end
+
+    protected
+
+    def restorable?
+      return true
+    end
+
+    def open_str
+      content_tag(:a, I18n.t(:"dismissible_helpers.actions.open"), :class => 'open', style: (dismissed? ? '' : 'display: none'), :href => '#')
+    end
+
+    def content_str
+      @content_str ||= begin
+        content = if @contents
+                    @contents
+                  else
+                    t(@name)
+                  end
+        content_tag :div, content, style: (dismissed? ? 'display: none' : '')
+      end
+    end
+
+    def close_str
+      content_tag(:a, I18n.t(:"dismissible_helpers.actions.close"), :class => 'close', style: (dismissed? ? 'display: none' : ''), :href => '#')
+    end
+  end
+end

data/lib/dismissible_helpers/routes.rb

@@ -1,5 +1,6 @@
 module DismissibleHelpers::Routes
   def dismissible_helpers_routes
     post '/dismissed_helpers' => 'dismissed_helpers#create', :as => :dismissed_helpers
+    delete '/dismissed_helpers/:helper' => 'dismissed_helpers#destroy'
   end
 end

data/lib/dismissible_helpers/version.rb

@@ -1,3 +1,3 @@
 module DismissibleHelpers
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/dismissible_helpers.rb

@@ -7,6 +7,7 @@ module DismissibleHelpers
   autoload :Routes
   autoload :Helpers
   autoload :ContentBuilder
+  autoload :RestorableContentBuilder
   autoload :DismissedChecker
   autoload :DismissedHelpersExtractor
 

data/spec/dummy/app/views/landing/restorable.html.erb

@@ -0,0 +1 @@
+<%= render_dismissible_helper 'restorable', restorable: true %>

data/spec/dummy/app/views/landing/show.html.erb

@@ -1 +1 @@
-<%= render_dismissible_helper 'hello' %>
+<%= render_dismissible_helper 'hello' %>

data/spec/dummy/config/locales/en.yml

@@ -3,3 +3,4 @@
 
 en:
   hello: "Hello world"
+  restorable: "Click to Dismiss or Show"

data/spec/dummy/config/routes.rb

@@ -2,6 +2,7 @@ Dummy::Application.routes.draw do
   dismissible_helpers_routes
   easy_auth_routes
 
+  match 'landing/restorable', :to => 'landing#restorable'
   match 'landing/block', :to => 'landing#block'
   root :to => 'landing#show'
 end

data/spec/requests/authenticated_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-feature 'Signed in user', :js do
+feature 'Signed in user', :js => true do
   scenario 'Sees and dismisses helper' do
     sign_in_as(create(:user))
     page.should have_content 'Hello world'
@@ -12,4 +12,31 @@ feature 'Signed in user', :js do
     visit sign_out_path
     page.should have_content 'Hello world'
   end
+
+  scenario 'Sees, dismisses and restores a restorable helper', :js => true do
+    sign_in_as(create(:user))
+    visit '/landing/restorable'
+
+    # hide a restorable helper
+    page.should have_content 'Click to Dismiss or Show'
+    click_on 'Close'
+    sleep 1
+    page.should_not have_content 'Click to Dismiss or Show'
+    page.should have_content 'Open'
+    visit '/landing/restorable'
+    page.should_not have_content 'Click to Dismiss or Show'
+    page.should have_content 'Open'
+
+    # restore a hidden restorable helper
+    click_on 'Open'
+    sleep 1
+    page.should have_content 'Click to Dismiss or Show'
+    page.should_not have_content 'Open'
+    page.should have_content 'Close'
+
+    visit '/landing/restorable'
+    page.should have_content 'Click to Dismiss or Show'
+    page.should_not have_content 'Open'
+    page.should have_content 'Close'
+  end
 end

data/spec/requests/unauthenticated_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-feature 'Signed out user', :js do
+feature 'Signed out user', :js => true do
   scenario 'Sees and dismisses helper' do
     visit root_path
     page.should have_content 'Hello world'
@@ -10,4 +10,30 @@ feature 'Signed out user', :js do
     visit root_path
     page.should_not have_content 'Hello world'
   end
+
+  scenario 'Sees, dismisses and restores a restorable helper', :js => true do
+    visit '/landing/restorable'
+
+    # hide a restorable helper
+    page.should have_content 'Click to Dismiss or Show'
+    click_on 'Close'
+    sleep 1
+    page.should_not have_content 'Click to Dismiss or Show'
+    page.should have_content 'Open'
+    visit '/landing/restorable'
+    page.should_not have_content 'Click to Dismiss or Show'
+    page.should have_content 'Open'
+
+    # restore a hidden restorable helper
+    click_on 'Open'
+    sleep 1
+    page.should have_content 'Click to Dismiss or Show'
+    page.should_not have_content 'Open'
+    page.should have_content 'Close'
+
+    visit '/landing/restorable'
+    page.should have_content 'Click to Dismiss or Show'
+    page.should_not have_content 'Open'
+    page.should have_content 'Close'
+  end
 end

data/spec/restorable_content_builder_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe DismissibleHelpers::RestorableContentBuilder do
+
+  describe '#build' do
+    context 'given a string' do
+      it 'should build a dismissible div containing the string as its contents' do
+        content = "<p>Great</p>"
+        builder = described_class.new(content)
+        html = builder.build
+        doc = Capybara.string(html)
+        p_el = doc.find('div.dismissible p')
+        p_el.text.should == 'Great'
+      end
+    end
+
+    it 'should have a close button' do
+      builder = described_class.new('something')
+      html = builder.build
+      doc = Capybara.string(html)
+      close_el = doc.find('div a.close')
+      close_el[:href].should == '#'
+    end
+
+    it 'should have a open button' do
+      builder = described_class.new('something')
+      html = builder.build
+      doc = Capybara.string(html)
+      close_el = doc.find('div a.open')
+      close_el[:href].should == '#'
+    end
+  end
+
+end

data/spec/views/landing/restorable_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'landing/restorable.html.erb' do
+
+  it 'should display the dismissible helper rendered with a block' do
+    render
+
+    doc = Capybara.string(rendered)
+    wrapper = doc.find('.dismissible')
+    wrapper.should have_selector('.open')
+    wrapper.should have_selector('.close')
+    wrapper.find("div:first").should have_content 'Click to Dismiss or Show'
+  end
+
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: dismissible_helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Dan McClain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-28 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,103 +27,90 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -158,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -166,7 +146,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -174,17 +153,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Simple Dismissible help text for your Rails projects
@@ -206,6 +183,7 @@ files:
 - lib/dismissible_helpers/engine.rb
 - lib/dismissible_helpers/helpers/dismissible_helpers.rb
 - lib/dismissible_helpers/helpers.rb
+- lib/dismissible_helpers/restorable_content_builder.rb
 - lib/dismissible_helpers/routes.rb
 - lib/dismissible_helpers/version.rb
 - lib/dismissible_helpers.rb
@@ -229,6 +207,7 @@ files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/landing/block.html.erb
+- spec/dummy/app/views/landing/restorable.html.erb
 - spec/dummy/app/views/landing/show.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config/application.rb
@@ -289,38 +268,33 @@ files:
 - spec/requests/authenticated_spec.rb
 - spec/requests/step_helpers/authentication.rb
 - spec/requests/unauthenticated_spec.rb
+- spec/restorable_content_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
 - spec/views/landing/block_spec.rb
+- spec/views/landing/restorable_spec.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3362041527304697344
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3362041527304697344
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Dismissible help text for your Rails projects
 test_files:
 - spec/config/active_record.rb
@@ -340,6 +314,7 @@ test_files:
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/landing/block.html.erb
+- spec/dummy/app/views/landing/restorable.html.erb
 - spec/dummy/app/views/landing/show.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config/application.rb
@@ -400,6 +375,8 @@ test_files:
 - spec/requests/authenticated_spec.rb
 - spec/requests/step_helpers/authentication.rb
 - spec/requests/unauthenticated_spec.rb
+- spec/restorable_content_builder_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
 - spec/views/landing/block_spec.rb
+- spec/views/landing/restorable_spec.rb