dismissible_helpers 0.1.5 → 0.2.0

data/README.md

@@ -35,18 +35,33 @@ the dismissed helpers.
 
 To add a dismissible helper to the page, call
 `render_dismissible_helper`. This helper method will only display the
-help text if it has not been dismissed by the user. The string passed to
-the method will be processed by the I18n method `t`, so the content of
-the help message should be stored in your localization file.
+help text if it has not been dismissed by the user.
+
+#### Without a block
+
+The string passed to the method will be processed by the I18n method `t`, so the content of the help message should be stored in your localization file.
 
 ```erb
 <h2>Sample Page</h2>
 <%= render_dismissible_helper 'sample_page.help_text' %>
 ```
 
+#### With a block
+
+The string passed to the method will be used as a key, to track whether or not the user has dismissed it. The contents of the block will appear inside the dismissible div. This is particularly useful if you want to have a more complex structure in the block.
+
+```erb
+<%= render_dismissible_helper 'how_to_buy' do %>
+  <h2>How to buy stuff</h2>
+  <p>To buy stuff, click look at this:</p>
+  <img src="http://domain.com/img.jpg">
+<% end %>
+```
+
+
 ### Including the routes ###
 
-Add `dismissible_helper_routes` to your `config/routes.rb` file.
+Add `dismissible_helpers_routes` to your `config/routes.rb` file.
 
 ### Including the JavaScript ##
 
@@ -54,7 +69,7 @@ Add the following to your `app/assets/javascripts/application.js`
 
 ```javascript
 // Your other require file statements
-//= require dismissed_helpers
+//= require dismissible_helpers
 
 $(function(){
   $('.dismissible').dismissible(); //The view helper applies a

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  dismissible_helpers:
+    actions:
+      close: "Close"

data/lib/dismissible_helpers.rb

@@ -6,6 +6,10 @@ module DismissibleHelpers
   autoload :Controllers
   autoload :Routes
   autoload :Helpers
+  autoload :ContentBuilder
+  autoload :DismissedChecker
+  autoload :DismissedHelpersExtractor
+
 end
 
 ActionDispatch::Routing::Mapper.send(:include, DismissibleHelpers::Routes)

data/lib/dismissible_helpers/content_builder.rb

@@ -0,0 +1,37 @@
+class DismissibleHelpers::ContentBuilder
+  include ActionView::Context
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TranslationHelper
+
+  def self.build(*args)
+    self.new(*args).build
+  end
+
+  def initialize(name, contents=nil)
+    @name = name
+    @contents = contents
+  end
+
+  def build
+    options = {}
+    options[:class] = 'dismissible'
+    options[:data] = {:dismissible_name => @name}
+    html = [content_str, close_str].join.html_safe
+    content_tag :div, html, options
+  end
+
+  private
+
+  def content_str
+    @content_str ||= if @contents
+                       @contents
+                     else
+                       t(@name)
+                     end
+  end
+
+  def close_str
+    content_tag(:a, I18n.t(:"dismissible_helpers.actions.close"), :class => 'close', :href => '#')
+  end
+
+end

data/lib/dismissible_helpers/dismissed_checker.rb

@@ -0,0 +1,23 @@
+class DismissibleHelpers::DismissedChecker
+
+  def self.dismissed?(*args)
+    self.new(*args).dismissed?
+  end
+
+  def initialize(key, user=nil, dismissed=nil)
+    @key = key
+    @dismissed_helpers = DismissibleHelpers::DismissedHelpersExtractor.
+      extract(user, dismissed)
+  end
+
+  def dismissed?
+    dismissed_helpers.include? @key
+  end
+
+  private
+
+  def dismissed_helpers
+    @dismissed_helpers
+  end
+
+end

data/lib/dismissible_helpers/dismissed_helpers_extractor.rb

@@ -0,0 +1,24 @@
+class DismissibleHelpers::DismissedHelpersExtractor
+
+  def self.extract(*args)
+    self.new(*args).extract
+  end
+
+  def initialize(user, cookie)
+    @user = user
+    @cookie = cookie
+  end
+
+  def extract
+    if @user && @user.respond_to?(:dismissed_helpers)
+      @user.dismissed_helpers
+    else
+      if @cookie.present?
+        @cookie.split '|'
+      else
+        []
+      end
+    end
+  end
+
+end

data/lib/dismissible_helpers/helpers/dismissible_helpers.rb

@@ -1,27 +1,21 @@
 module DismissibleHelpers::Helpers::DismissibleHelpers
-  def render_dismissible_helper(name)
-    unless has_been_dismissed?(name)
-      content_tag :div, :class => 'dismissible', :data => { :dismissible_name => name } do
-        html = t(name)
-        html << "\n"
-        html << content_tag(:a, 'Close', :class => 'close', :href => '#')
-        html.html_safe
-      end
+
+  def render_dismissible_helper(name, &block)
+    unless dismissed?(name)
+      contents = block_given? ? capture(&block) : nil
+      DismissibleHelpers::ContentBuilder.build(name, contents)
     end
   end
 
   private
 
-  def has_been_dismissed?(name)
-    if respond_to?(:current_user) && current_user && current_user.respond_to?(:dismissed_helpers)
-      dismissed_helpers = current_user.dismissed_helpers
-    else
-      if cookies[:dismissed_helpers].present?
-        dismissed_helpers = cookies[:dismissed_helpers].split '|'
-      else
-        dismissed_helpers = []
-      end
-    end
-    dismissed_helpers.include? name
+  def dismissed?(name)
+    user = respond_to?(:current_user) ? current_user : nil
+    DismissibleHelpers::DismissedChecker.dismissed?(
+      name,
+      user,
+      cookies[:dismissed_helpers]
+    )
   end
+
 end

data/lib/dismissible_helpers/version.rb

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

data/spec/content_builder_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe DismissibleHelpers::ContentBuilder 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
+  end
+
+end

data/spec/dismissed_checker_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe DismissibleHelpers::DismissedChecker do
+
+  describe '#dismissed?' do
+    context 'when the dismissed_helpers includes the key' do
+      it 'should return true' do
+        checker = described_class.new('a')
+        checker.stubs(:dismissed_helpers).returns(['a'])
+        checker.should be_dismissed
+      end
+    end
+
+    context 'the dismissed_helpers does not include the key' do
+      it 'should return false' do
+        checker = described_class.new('a')
+        checker.stubs(:dismissed_helpers).returns([])
+        checker.should_not be_dismissed
+      end
+    end
+
+  end
+end

data/spec/dismissed_helpers_extractor_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe DismissibleHelpers::DismissedHelpersExtractor do
+
+  describe '#extract' do
+    context 'the user exists and has the dismissed_helpers field' do
+      it 'should return the user#dismissed_helpers' do
+        user = build_stubbed(:user, :dismissed_helpers => ['a'])
+        extractor = described_class.new(user, nil)
+        extractor.extract.should == ['a']
+      end
+    end
+
+    context 'the user does not exist or exists but does not have the dismissed_helpers field' do
+      context 'the cookie exists' do
+        it 'should return the cookie split into an array' do
+          extractor = described_class.new(nil, 'a|c|b')
+          extractor.extract.should == %w(a c b)
+        end
+      end
+
+      context 'the cookie does not exist' do
+        it 'should return an empty array' do
+          extractor = described_class.new(nil, nil)
+          extractor.extract.should == []
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,3 @@
+<%= render_dismissible_helper 'helper_block' do %>
+  <p>Amazing matey!</p>
+<% end %>

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

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

data/spec/dummy/config/routes.rb

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

data/spec/requests/authenticated_spec.rb

@@ -3,13 +3,13 @@ require 'spec_helper'
 feature 'Signed in user', :js do
   scenario 'Sees and dismisses helper' do
     sign_in_as(create(:user))
-    page.should have_content 'Helper'
+    page.should have_content 'Hello world'
     click_link 'Close'
     sleep 1
-    page.should_not have_content 'Helper'
+    page.should_not have_content 'Hello world'
     visit root_path
-    page.should_not have_content 'Helper'
+    page.should_not have_content 'Hello world'
     visit sign_out_path
-    page.should have_content 'Helper'
+    page.should have_content 'Hello world'
   end
 end

data/spec/requests/unauthenticated_spec.rb

@@ -3,11 +3,11 @@ require 'spec_helper'
 feature 'Signed out user', :js do
   scenario 'Sees and dismisses helper' do
     visit root_path
-    page.should have_content 'Helper'
+    page.should have_content 'Hello world'
     click_link 'Close'
     sleep 1
-    page.should_not have_content 'Helper'
+    page.should_not have_content 'Hello world'
     visit root_path
-    page.should_not have_content 'Helper'
+    page.should_not have_content 'Hello world'
   end
 end

data/spec/views/landing/block_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'landing/block.html.erb' do
+
+  it 'should display the dismissible helper rendered with a block' do
+    render
+    doc = Capybara.string(rendered)
+    p = doc.find('p')
+    p.text.should include('Amazing matey!')
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dismissible_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -197,8 +197,12 @@ files:
 - app/assets/javascripts/dismissible_helpers.coffee
 - app/controllers/dismissed_helpers_controller.rb
 - app/helpers/dismissible_helpers_helper.rb
+- config/locales/en.yml
+- lib/dismissible_helpers/content_builder.rb
 - lib/dismissible_helpers/controllers/dismissed_helpers.rb
 - lib/dismissible_helpers/controllers.rb
+- lib/dismissible_helpers/dismissed_checker.rb
+- lib/dismissible_helpers/dismissed_helpers_extractor.rb
 - lib/dismissible_helpers/engine.rb
 - lib/dismissible_helpers/helpers/dismissible_helpers.rb
 - lib/dismissible_helpers/helpers.rb
@@ -214,6 +218,9 @@ files:
 - spec/config/database_cleaner.rb
 - spec/config/poltergeist.rb
 - spec/config/rspec.rb
+- spec/content_builder_spec.rb
+- spec/dismissed_checker_spec.rb
+- spec/dismissed_helpers_extractor_spec.rb
 - spec/dummy/app/assets/javascripts/application.coffee
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -221,6 +228,7 @@ files:
 - spec/dummy/app/controllers/sessions_controller.rb
 - 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/show.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config/application.rb
@@ -283,6 +291,7 @@ files:
 - spec/requests/unauthenticated_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
+- spec/views/landing/block_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -297,7 +306,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3152705794345596771
+      hash: -3362041527304697344
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -306,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3152705794345596771
+      hash: -3362041527304697344
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -320,6 +329,9 @@ test_files:
 - spec/config/database_cleaner.rb
 - spec/config/poltergeist.rb
 - spec/config/rspec.rb
+- spec/content_builder_spec.rb
+- spec/dismissed_checker_spec.rb
+- spec/dismissed_helpers_extractor_spec.rb
 - spec/dummy/app/assets/javascripts/application.coffee
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -327,6 +339,7 @@ test_files:
 - spec/dummy/app/controllers/sessions_controller.rb
 - 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/show.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/config/application.rb
@@ -389,3 +402,4 @@ test_files:
 - spec/requests/unauthenticated_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
+- spec/views/landing/block_spec.rb