dismissible_blocks 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 790003b0d118f8a317c7a4ddfd43d7492314b8b1
+  data.tar.gz: 45a0169db67ceb236117ac3cf76cfcbdf80e5d77
+SHA512:
+  metadata.gz: c9d9e57eb204c9071580e8d405aa91b871e2cec3127cc5f9c0953afc0e0aaabd70f182650cd6d9de7af8db86ac9c16b6295e5c3c2af6df710d94b1ab598949b0
+  data.tar.gz: 41d4a657714f5df13227ac55ba2ab443dd382ef453019b869c3091280d3c2e5a5fd28375a1241186b3c316b01ded4ad9b79923c2b16959500dd35b378b84a018

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# jquery-rails is used by the Dummy app
+# https://github.com/rails/rails/commit/007f5670
+gem 'jquery-rails'

data/LICENSE.text

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Patrick Bougie
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,152 @@
+# DismissibleBlocks
+
+## Overview
+**DismissibleBlocks** is a Ruby on Rails engine that allows for dismissible blocks of HTML code whose state is saved in the database per user.
+
+
+## Installation
+### Requirements
+The DismissibleBlocks gem has the following requirements:
+
+- [Ruby on Rails](http://rubyonrails.org/) 3.2 or above
+- [jQuery](http://jquery.com/)
+
+### Gemfile
+Add the following line to your application's Gemfile:
+
+    gem 'dismissible_blocks'
+
+And then execute:
+
+    $ bundle install
+
+### Manual Installation
+Install it yourself:
+
+    $ gem install dismissible_blocks
+
+
+## Usage
+### Routes
+DismissibleBlocks automatically adds the required routes when the gem is added to your project.
+
+### Views
+Adding dismissible blocks of HTML code is very easy. DismissibleBlocks does not generate any extra HTML and therefore gives you complete control over your code.
+
+To add a dismissible block to a view, use the `render_dismissible_block` helper method. This will create a dismissible block named `lorem`:
+
+	<%= render_dismissible_block 'lorem' do %>
+	  ...
+	<% end %>
+
+This alone isn't enough, you need to identify the container and button HTML. This is done using HTML5 `data-` attributes. There are two attributes that you must add to the HTML to make everything work as expected:
+
+1. `data-dismissible`: attribute for the container of the HTML block.
+2. `data-dismissible-hide`: attribute for the button to hide the HTML block.
+
+For example:
+
+	<%= render_dismissible_block 'lorem' do %>
+	  <div data-dismissible>
+	    <p>...</p>
+	    <a href="#" data-dismissible-hide>Hide</a>
+	  </div>
+	<% end %>
+
+Also make sure the [Cross-Site Request Forgery](http://guides.rubyonrails.org/security.html#cross-site-request-forgery-csrf) (CSRF) token is included in your layout:
+
+	<%= csrf_meta_tags %>
+
+### JavaScript
+Add the following JavaScript to `app/assets/javascripts/application.js`.
+
+In its simplest form, you can require all the needed JavaScript using:
+
+	//= require jquery
+	//= require dismissible_blocks
+	//= require dismissible_blocks_loader
+
+If you want to customize how a block of HTML is hidden using — for example — a slide up effect, you can customize the JavaScript like so:
+
+	//= require jquery
+	//= require dismissible_blocks
+	
+	$(document).ready(function() {
+	  $('[data-dismissible]').dismissible({
+	    dismiss: function(helper) {
+	      helper.slideUp();
+	    }
+	  });
+	});
+
+### Model
+
+DismissibleBlocks saves the dismissed blocks on a model. It uses the `current_user` helper method to access the current user/account.
+
+The model must have an attributed named `dismissed_blocks` and be of type Array.
+
+#### ActiveRecord
+ActiveRecord's serialization feature can achieve this. First, create a database migration to add the required field:
+
+	class AddDismissedBlocksToUsers < ActiveRecord::Migration
+	  def up
+	    add_column :users, :dismissed_blocks, :text
+	  end
+	
+	  def down
+	    remove_column :users, :dismissed_blocks
+	  end
+	end
+
+Then add the serialization to the model:
+
+	class User < ActiveRecord::Base
+	  serialize :dismissed_blocks, Array
+	end
+
+#### ActiveRecord (using PostgreSQL)
+If you are using [PostgreSQL](http://www.postgresql.org/) with native array support using [PostgresExt](https://github.com/dockyard/postgres_ext), your database migration would simply be:
+
+	class AddDismissedBlocksToUsers < ActiveRecord::Migration
+	  def up
+	    add_column :users, :dismissed_blocks, :string, :array => true
+	  end
+	
+	  def down
+	    remove_column :users, :dismissed_blocks
+	  end
+	end
+
+#### Mongoid
+To add MongoDB support using [Mongoid](mongoid.org), add this to the user/account model:
+
+	field :dismissed_blocks, type: Array, default: []
+
+#### Helper Method Not `current_user`
+By default, DismissibleBlocks saves the state to the database using the `current_user` helper method. If your user/account helper method is named something else — for example `current_employee`:
+
+	def current_employee
+	  ...
+	end
+    helper_method :current_employee
+
+Use `alias_method` to create an alias to your helper method; don't forget to also include `helper_method` to make your helper available from your views:
+
+	alias_method :current_user, :current_employee
+    helper_method :current_user
+
+## Author
+[Patrick Bougie](http://patrickbougie.com/)
+
+
+## Contributing
+
+1. Fork DismissibleBlocks: `https://github.com/pbougie/dismissible_blocks`
+2. Create your feature branch: `git checkout -b new-feature`
+3. Commit your changes: `git commit -am 'New feature description'`
+4. Push to the branch: `git push origin new-feature`
+5. Create a new Pull Request on [GitHub](https://github.com/)
+
+
+## Legal
+DismissibleBlocks is copyright © 2014 [Patrick Bougie](http://patrickbougie.com/). It is free software and may be redistributed under the terms specified in the LICENSE.text file.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DismissibleBlocks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/dismissible_blocks.js

@@ -0,0 +1,37 @@
+(function() {
+  (function($) {
+
+    $.fn.dismissible = function(options) {
+      return this.each(function() {
+        var _this = $(this);
+        $('[data-dismissible-hide]', this).click(function(event) {
+          event.preventDefault();
+          return _this.dismiss(options);
+        })
+      });
+    };
+
+    return $.fn.dismiss = function(options) {
+      return $.ajax({
+        type: 'POST',
+        url: '/dismissible_blocks.json',
+        dataType: 'json',
+        contentType: 'application/json',
+        data: JSON.stringify({
+          block: $(this).attr('data-dismissible'),
+          authenticity_token: $('meta[name=csrf-token]').attr('content')
+        }),
+        success: (function(_this) {
+          return function() {
+            if ((options != null) && options.dismiss !== void 0) {
+              return options.dismiss(_this);
+            } else {
+              return $(_this).remove();
+            }
+          }
+        })(this)
+      });
+    };
+
+  })(jQuery);
+}).call(this);

data/app/assets/javascripts/dismissible_blocks_loader.js

@@ -0,0 +1,3 @@
+$(document).ready(function() {
+  $('[data-dismissible]').dismissible();
+});

data/app/controllers/dismissible_blocks_controller.rb

@@ -0,0 +1,3 @@
+class DismissibleBlocksController < ApplicationController
+  include DismissibleBlocks::Controller
+end

data/app/helpers/dismissible_blocks_helper.rb

@@ -0,0 +1,3 @@
+module DismissibleBlocksHelper
+  include DismissibleBlocks::Helper
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  post '/dismissible_blocks' => 'dismissible_blocks#create'
+end

data/lib/dismissible_blocks/controller.rb

@@ -0,0 +1,18 @@
+module DismissibleBlocks::Controller
+
+  def create
+    if current_user_available
+      current_user.dismissed_blocks += [ params[:block].to_s ]
+      current_user.save!
+      render :json => {}, :status => :ok
+    else
+      render :json => {}, :status => :unprocessable_entity
+    end
+  end
+
+  private
+
+    def current_user_available
+      respond_to?(:current_user) && current_user.respond_to?(:dismissed_blocks)
+    end
+end

data/lib/dismissible_blocks/engine.rb

@@ -0,0 +1,4 @@
+module DismissibleBlocks
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/dismissible_blocks/helper.rb

@@ -0,0 +1,34 @@
+module DismissibleBlocks::Helper
+
+  def render_dismissible_block(name, &block)
+    unless dismissed?(name)
+      if block_given?
+        contents = capture(&block)
+        add_block_name_to_attributes(contents, name)
+      else
+        raise DismissibleBlocks::ContentMissing
+      end
+    end
+  end
+
+  private
+
+    def dismissed?(name)
+      if respond_to?(:current_user)
+        if !current_user.respond_to?(:dismissed_blocks)
+          raise DismissibleBlocks::AttributeUnavailable
+        elsif !current_user.dismissed_blocks.is_a?(Array)
+          raise DismissibleBlocks::AttributeNotArray
+        else
+          current_user.dismissed_blocks.include?(name)
+        end
+      else
+        raise DismissibleBlocks::ModelUnavailable
+      end
+    end
+
+    def add_block_name_to_attributes(contents, name)
+      contents.gsub! /(data-dismissible)(-hide)?(?!-)/, "\\1\\2='#{name}'"
+      contents.html_safe
+    end
+end

data/lib/dismissible_blocks/version.rb

@@ -0,0 +1,3 @@
+module DismissibleBlocks
+  VERSION = '0.0.2'
+end

data/lib/dismissible_blocks.rb

@@ -0,0 +1,13 @@
+require 'dismissible_blocks/engine'
+
+module DismissibleBlocks
+  extend ActiveSupport::Autoload
+
+  class ModelUnavailable < StandardError; end
+  class AttributeUnavailable < StandardError; end
+  class AttributeNotArray < StandardError; end
+  class ContentMissing < StandardError; end
+
+  autoload :Controller
+  autoload :Helper
+end

data/test/capybara_helper.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'capybara/rails'
+
+class ActionDispatch::IntegrationTest
+  include Capybara::DSL
+
+  def login(user)
+    visit login_path
+    fill_in 'Username', with: user.username
+    fill_in 'Password', with: user.password
+    click_button 'Login'
+    assert current_path == landing_path
+    assert page.has_content? 'You have been logged in.'
+  end
+
+  def logout
+    visit logout_path
+    assert current_path == login_path
+    assert page.has_content? 'You have been logged out.'
+  end
+end
+
+# Prevent database locks when testing AJAX features
+# https://github.com/jnicklas/capybara#transactions-and-database-setup
+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/test/controllers/dismissible_blocks_controller_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class DismissibleBlocksControllerTest < ActionController::TestCase
+
+  test "dismiss block via ajax" do
+    session[:username] = users(:one).username # Login
+    refute users(:one).dismissed_blocks.include?('lorem')
+    xhr :post, :create, block: 'lorem', format: 'json'
+    users(:one).reload
+    assert users(:one).dismissed_blocks.include?('lorem')
+    assert_response :ok
+  end
+
+  test "dismiss block fails via ajax; not logged in" do
+    xhr :post, :create, block: 'lorem', format: 'json'
+    assert_response :unprocessable_entity
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,3 @@
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require dismissible_blocks
+//= require dismissible_blocks_loader

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

@@ -0,0 +1,17 @@
+/*
+ *= require_self
+ */
+
+.flash, .block {
+  border: 2px solid #333;
+  padding: 10px 20px;
+  background-color: #eee;
+}
+.flash-alert {
+  border-color: #ebccd1;
+  background-color: #f2dede;
+}
+.flash-notice {
+  border-color: #bce8f1;
+  background-color: #d9edf7;
+}

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

@@ -0,0 +1,29 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  def current_user
+    if session[:username].present?
+      @current_user ||= User.find_by(username: session[:username])
+    end
+  end
+  helper_method :current_user
+
+  def check_authentication
+    unless session[:username].present?
+      raise Dummy::Unauthorized
+    end
+  end
+
+  def authenticated?
+    session[:username].present?
+  end
+
+
+  def signin(username)
+    session[:username] = username
+  end
+
+  def signout
+    reset_session
+  end
+end

data/test/dummy/app/controllers/landings_controller.rb

@@ -0,0 +1,6 @@
+class LandingsController < ApplicationController
+  before_filter :check_authentication
+
+  def show
+  end
+end

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

@@ -0,0 +1,28 @@
+class SessionsController < ApplicationController
+  before_filter :check_authentication, only: :destroy
+
+  def new
+    if authenticated?
+      flash[:notice] = 'You are already logged in.'
+      redirect_to landing_url
+    end
+  end
+
+  def create
+    user = User.authenticate params[:username], params[:password]
+    if user
+      signin user.username
+      flash[:notice] = 'You have been logged in.'
+      redirect_to landing_url
+    else
+      flash.now[:alert] = 'Your username and/or password are incorrect.'
+      render :new
+    end
+  end
+
+  def destroy
+    signout
+    flash[:notice] = 'You have been logged out.'
+    redirect_to login_url
+  end
+end

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

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

data/test/dummy/app/helpers/landings_helper.rb

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

data/test/dummy/app/helpers/sessions_helper.rb

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

data/test/dummy/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  serialize :dismissed_blocks, Array
+
+  validates :username, uniqueness: true
+
+  def self.authenticate(username, password)
+    User.find_by username: username, password: password
+  end
+end

data/test/dummy/app/views/landings/show.html.erb

@@ -0,0 +1,10 @@
+<h1>Dummy</h1>
+
+<%= render_dismissible_block 'lorem' do %>
+  <div class="block" data-dismissible>
+    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras vitae.</p>
+    <p><a href="#" data-dismissible-hide>Hide</a></p>
+  </div>
+<% end %>
+
+<p><%= link_to 'Logout', logout_path %></p>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,18 @@
+<!doctype html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag 'application' %>
+  <%= javascript_include_tag 'application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <% flash.each do |name, message| %>
+    <%= content_tag :p, class: "flash flash-#{name}" do %>
+      <%= message %>
+    <% end %>
+  <% end %>
+
+  <%= yield %>
+</body>
+</html>

data/test/dummy/app/views/sessions/new.html.erb

@@ -0,0 +1,15 @@
+<%= form_tag login_path do %>
+  <p>
+    <%= label_tag :username %>
+    <%= text_field_tag :username, params[:username] %>
+  </p>
+
+  <p>
+    <%= label_tag :password %>
+    <%= password_field_tag :password %>
+  </p>
+
+  <p>
+    <%= submit_tag 'Login' %>
+  </p>
+<% end %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../boot', __FILE__)
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require 'dismissible_blocks'
+
+module Dummy
+  class Unauthorized < StandardError; end
+  class Application < Rails::Application; end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,11 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../application', __FILE__)
+
+Dummy::Application.initialize!

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

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end