dismissible_helpers 0.1.0

data/README.md

@@ -0,0 +1,146 @@
+# DismissibleHelpers #
+
+[![Build Status](https://travis-ci.org/dockyard/dismissible_helpers.png?branch=master)](https://travis-ci.org/dockyard/dismissible_helpers)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/dismissible_helpers)
+
+
+
+## Installation ##
+
+In your Gemfile add the following:
+
+```ruby
+gem 'dismissible_helpers'
+```
+
+## What you get ##
+
+## Usage ##
+
+DismissibleHelpers includes:
+
+  * DismissibleHelpers View Helper - Renders the helper only if the
+visitor has not dismissed it
+  * DismissedHelpers Routes and controller - Handles the JavaScript
+requests to store the dismissal state
+  * DismissedHelpers Javascript - Handles the front end interactions
+with the helpers
+
+### Default Behavior ###
+
+By default, DismissibleHelpers will use cookies to track the state of
+the dismissed helpers. 
+
+### Adding a dismissible helper to your page ###
+
+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.
+
+```html
+<h2>Sample Page</h2>
+<%= render_dismissible_helper 'sample_page.help_text' %>
+```
+
+### Including the routes ###
+
+Add `dismissible_helper_routes` to your `config/routes.rb` file.
+
+### Including the JavaScript ##
+
+Add the following to your `app/assets/javascripts/application.js`
+
+```javascript
+// Your other require file statements
+//= require dismissed_helpers
+
+$(function(){
+  $('.dismissible').dismissible(); //The view helper applies a
+                                   //'dismissible' class to each helper div
+});
+```
+
+By default, the dismissed helper is removed from the page via
+`$().remove()`. This can be customized by passing a callback to the
+`.dismissible()` call. To use jQuery's `.slideUp()` you would use the
+following call'
+
+```javascript
+$(function(){
+  $('.dismissible').dismissible({
+    success: function(helper){
+      helper.slideUp(); //'helper' is the jQuery-wrapped element
+    }
+  });
+});
+```
+### Using authenticated user ###
+
+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.
+
+The model should have an attribute called `dismissed_helpers` which should
+be an array type. You can use ActiveRecord's serialization to achieve this:
+
+ 1 Add this `dismissed_helpers` column as a `text` column
+
+```ruby
+class AddDismissedHelpersToAccounts < ActiveRecord::Migration
+  def up
+    add_column :accounts, :dismissed_helpers, :text
+  end
+
+  def down
+    remove_column :accounts, :dismissed_helpers
+  end
+end
+```
+
+ 2 Add the serization call to the model
+
+```ruby
+class Account < ActiveRecord::Base
+  serialize :dismissed_helpers, Array
+end
+```
+
+If you are using PostgreSQL as your database, you could use
+`postgres_ext` to add native array support to your models. You would
+just need the following migration to add the dismissed_helpers attribute
+to your model:
+
+```ruby
+class AddDismissedHelpersToAccounts < ActiveRecord::Migration
+  def up
+    add_column :accounts, :dismissed_helpers, :string, :array => true
+  end
+
+  def down
+    remove_column :accounts, :dismissed_helpers
+  end
+end
+```
+
+Your model does not need to be called Account, it just needs the
+`dismissed_helpers` attribute.
+
+## Authors ##
+
+[Dan McClain](http://twitter.com/_danmcclain)
+
+[We are very thankful for the many contributors](https://github.com/dockyard/dismissible_helpers/graphs/contributors)
+
+## Versioning ##
+
+This gem follows [Semantic Versioning](http://semver.org)
+
+## Legal ##
+
+[DockYard](http://dockyard.com), LLC &copy; 2012
+
+[@dockyard](http://twitter.com/dockyard)
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new('default') do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'

data/app/assets/javascripts/dismissible_helpers.coffee

@@ -0,0 +1,26 @@
+(($) ->
+  $.fn.dismissible = (options) ->
+    options = {} if options == undefined
+    if options.closeSelector?
+      closeSelector = options.closeSelector
+    else
+      closeSelector = '.close'
+
+    @find(closeSelector).click (event)  =>
+      event.preventDefault()
+      @.dismiss(options)
+
+  $.fn.dismiss = (options) ->
+    name = @.attr('data-dismissible-name') 
+    $.ajax
+      url:       '/dismissed_helpers'
+      type:      'POST'
+      dataType: 'json'
+      data:
+        helper: name
+      success: =>
+        if options? and options.success != undefined
+          options.success(@)
+        else
+          @.remove()
+)(jQuery)

data/app/controllers/dismissed_helpers_controller.rb

@@ -0,0 +1,3 @@
+class DismissedHelpersController < ApplicationController
+  include DismissibleHelpers::Controllers::DismissedHelpers
+end

data/app/helpers/dismissible_helpers_helper.rb

@@ -0,0 +1,3 @@
+module DismissibleHelpersHelper
+  include DismissibleHelpers::Helpers::DismissibleHelpers
+end

data/lib/dismissible_helpers/controllers/dismissed_helpers.rb

@@ -0,0 +1,18 @@
+module DismissibleHelpers::Controllers::DismissedHelpers
+  def create
+    if respond_to?(:current_account) && current_user && current_user.respond_to?(:dismissed_helpers)
+      current_user.dismissed_helpers += [ params[:helper] ]
+      current_user.save!
+    else
+      if cookies[:dismissed_helpers].present?
+        dismissed_helpers = YAML.load cookies[:dismissed_helpers]
+        dismissed_helpers += [params[:helper]]
+      else
+        dismissed_helpers = [params[:helper]]
+      end
+      cookies[:dismissed_helpers] = dismissed_helpers.to_yaml
+    end
+
+    render :json => {}, :status => :ok
+  end
+end

data/lib/dismissible_helpers/controllers.rb

@@ -0,0 +1,4 @@
+module DismissibleHelpers::Controllers
+  extend ActiveSupport::Autoload
+  autoload :DismissedHelpers
+end

data/lib/dismissible_helpers/engine.rb

@@ -0,0 +1,7 @@
+module DismissibleHelper
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+  end
+end

data/lib/dismissible_helpers/helpers/dismissible_helpers.rb

@@ -0,0 +1,26 @@
+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 => '#')
+      end
+    end
+  end
+
+  private
+
+  def has_been_dismissed?(name)
+    if respond_to?(:current_account) && current_user && current_user.respond_to?(:dismissed_helpers)
+      dismissed_helpers = current_user.dismissed_helpers
+    else
+      if cookies[:dismissed_helpers].present?
+        dismissed_helpers = YAML.load cookies[:dismissed_helpers]
+      else
+        dismissed_helpers = []
+      end
+    end
+    dismissed_helpers.include? name
+  end
+end

data/lib/dismissible_helpers/helpers.rb

@@ -0,0 +1,4 @@
+module DismissibleHelpers::Helpers
+  extend ActiveSupport::Autoload
+  autoload :DismissibleHelpers
+end

data/lib/dismissible_helpers/routes.rb

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

data/lib/dismissible_helpers/version.rb

@@ -0,0 +1,3 @@
+module DismissibleHelpers
+  VERSION = '0.1.0'
+end

data/lib/dismissible_helpers.rb

@@ -0,0 +1,11 @@
+require 'dismissible_helpers/engine'
+
+module DismissibleHelpers
+  extend ActiveSupport::Autoload
+
+  autoload :Controllers
+  autoload :Routes
+  autoload :Helpers
+end
+
+ActionDispatch::Routing::Mapper.send(:include, DismissibleHelpers::Routes)

data/lib/tasks/dismissible_helpers_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dismissible_helpers do
+#   # Task goes here
+# end

data/spec/config/active_record.rb

@@ -0,0 +1,9 @@
+class ActiveRecord::Base
+  mattr_accessor :shared_connection
+  @@shared_connection = nil
+
+  def self.connection
+    @@shared_connection || retrieve_connection
+  end
+end
+ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection

data/spec/config/capybara.rb

@@ -0,0 +1,7 @@
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Capybara.server_port = 3999
+  end
+end

data/spec/config/cookie_jar.rb

@@ -0,0 +1,9 @@
+module CookieJar
+  def cookies
+    Capybara.current_session.driver.browser.current_session.instance_variable_get(:@rack_mock_session).cookie_jar
+  end
+end
+
+RSpec.configure do |config|
+  config.include CookieJar, :type => :request
+end

data/spec/config/database_cleaner.rb

@@ -0,0 +1,20 @@
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.clean
+    DatabaseCleaner.strategy = :deletion
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+  at_exit do
+    DatabaseCleaner.clean
+  end
+end

data/spec/config/poltergeist.rb

@@ -0,0 +1,7 @@
+require 'capybara/poltergeist'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Capybara.javascript_driver = :poltergeist
+  end
+end

data/spec/config/rspec.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.coffee

@@ -0,0 +1,6 @@
+#= require jquery
+#= require jquery_ujs
+#= require dismissible_helpers
+#= require_tree .
+$ ->
+  $('.dismissible').dismissible()

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  include EasyAuthHelper
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/landing_controller.rb

@@ -0,0 +1,2 @@
+class LandingController < ApplicationController
+end

data/spec/dummy/app/controllers/sessions_controller.rb

@@ -0,0 +1,9 @@
+class SessionsController < ApplicationController
+  include EasyAuth::Controllers::Sessions
+
+  private
+
+  def after_successful_sign_in_url(identity)
+    root_path
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end