dismissible_blocks 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7f626613af83496fe42408bf4e578a4aa19afaac01889691f60500c5a37cf78
-  data.tar.gz: c5cba02f795af41d067fd11bd966168453ca608cd6924accdd804d0838ec92be
+  metadata.gz: 145a0ac22b989d3f165280b7203087d2bc6b5c1b434eceb0875f38b282136134
+  data.tar.gz: 146bec7c1c582eef33bb4367698459dd5e2bfba3ce811ddb9f0766ce5a74f109
 SHA512:
-  metadata.gz: dff7e203a31bbc6a2249f804df4fe8fc265c6f11c3cf53c8491173ef54da2e498cea472064f050328f9f54a3762b018702285d78d1ee6046cb3f67ca76563b95
-  data.tar.gz: 873081056dd3d5a7d461fb417b4ecc4b698b9767c2ae5935ef510f1293ca6987f8912212583f734a90bde3f9007aa951ca87f0a252a8932ca2d97ba532a4534a
+  metadata.gz: f6816d384f8175983ce60b20463ce1c2ab428661d8ebb3f27173ce6be4341e2eb8a4a3adeef0d14ff88f4289b4c66f08e61d8e708dd4e53eac2795e3c0145ddf
+  data.tar.gz: d5d4f21dca16061981216bafccd73e329ec76b5472d940e0cad37872f0dd490fd4ef82af25bf0e033f196fe1fa68263f9de5e350a46005173f2e485ac814e008

data/README.md

@@ -3,13 +3,13 @@
 ## Overview
 [DismissibleBlocks](https://github.com/pbougie/dismissible_blocks) is a simple gem for [Ruby on Rails](http://rubyonrails.org/) projects to add blocks of content to a webpage that can be dismissed by the user. Dismissed blocks are remembered and persisted to the database using [Ajax](https://en.wikipedia.org/wiki/Ajax_%28programming%29). DismissibleBlocks is ORM agnostic and works with MySQL, PostgreSQL, MongoDB, etc.
 
+> **WARNING:** DismissibleBlocks 2+ removed jQuery as a dependency. If you are not using the loader, you will have to make changes to your code. See examples below.
 
 ## Installation
 ### Requirements
-The DismissibleBlocks gem has the following requirements:
+The DismissibleBlocks gem has the following requirement:
 
 - [Ruby on Rails](http://rubyonrails.org/) 3.2 or above
-- [jQuery](http://jquery.com/)
 
 ### Gemfile
 Add the following line to your application's Gemfile:
@@ -35,23 +35,25 @@ 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({
+
+	document.addEventListener('DOMContentLoaded', function() {
+	  document.querySelectorAll('[data-dismissible]').dismissible({
 	    dismiss: function(helper) {
-	      helper.slideUp();
+	      helper.slideUp().then(function(el) {
+	        el.remove();
+	      });
 	    }
 	  });
 	});
 
+**Note:** The above example is using the `slideUp()` method from the [dom-slider](https://github.com/BrentonCozby/dom-slider) JavaScript library by Brenton Cozby.
+
 ### Helper
 DismissibleBlocks uses the `current_user` helper method to access the current user/account. Make sure the helper method is also available in your views:
 
@@ -59,7 +61,7 @@ DismissibleBlocks uses the `current_user` helper method to access the current us
       ...
     end
     helper_method :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
@@ -83,7 +85,7 @@ ActiveRecord's serialization feature can achieve this. First, create a database
 	  def up
 	    add_column :users, :dismissed_blocks, :text
 	  end
-	
+
 	  def down
 	    remove_column :users, :dismissed_blocks
 	  end
@@ -102,7 +104,7 @@ If you are using [PostgreSQL](http://www.postgresql.org/) with native array supp
 	  def up
 	    add_column :users, :dismissed_blocks, :string, :array => true
 	  end
-	
+
 	  def down
 	    remove_column :users, :dismissed_blocks
 	  end

data/app/assets/javascripts/dismissible_blocks.js

@@ -1,37 +1,40 @@
 (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);
-        })
-      });
-    };
+  NodeList.prototype.dismissible = function(options) {
+    this.forEach(function(el) {
+      el.dismissible(options);
+    });
+  }
+
+  HTMLElement.prototype.dismissible = function(options) {
+    this.querySelector('[data-dismissible-hide]').addEventListener('click', function(event) {
+      event.preventDefault();
+      this.dismiss(options);
+    });
+  }
+
+  HTMLElement.prototype.dismiss = function(options) {
+    var block_name = this.getAttribute('data-dismissible-hide');
+    var block = document.querySelector('[data-dismissible=' + block_name + ']');
+    var csrf = document.querySelector('meta[name=csrf-token]');
+    var token = csrf != null ? csrf.getAttribute('content') : null;
+    var xhr = new XMLHttpRequest();
 
-    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)
-      });
+    xhr.open('PUT', '/dismissible_blocks.json');
+    xhr.setRequestHeader('Content-Type', 'application/json');
+    xhr.onload = function() {
+      if (xhr.status === 200) {
+        if (options !== undefined && options.dismiss !== undefined) {
+          return options.dismiss(block);
+        } else {
+          return block.remove();
+        }
+      }
     };
+    xhr.send(JSON.stringify({
+      block: block_name,
+      authenticity_token: token
+    }));
+  }
 
-  })(jQuery);
-}).call(this);
+})();

data/app/assets/javascripts/dismissible_blocks_loader.js

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

data/app/controllers/dismissible_blocks_controller.rb

@@ -1,8 +1,10 @@
 class DismissibleBlocksController < ApplicationController
   def create
     if current_user_available
-      current_user.dismissed_blocks += [ params[:block].to_s ]
-      current_user.save!
+      unless current_user.dismissed_blocks.include?(block)
+        current_user.dismissed_blocks.push(block)
+        current_user.save!
+      end
       render json: {}, status: :ok
     else
       render json: {}, status: :unprocessable_entity
@@ -14,4 +16,8 @@ class DismissibleBlocksController < ApplicationController
     def current_user_available
       respond_to?(:current_user) && current_user.respond_to?(:dismissed_blocks)
     end
+
+    def block
+      params[:block].to_s
+    end
 end

data/config/routes.rb

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

data/dismissible_blocks.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
     'LICENSE.txt'
   ]
 
+  s.post_install_message = 'DismissibleBlocks 2+ removed jQuery as a dependency. See README.'
+
   s.add_runtime_dependency 'rails', '>= 3.2'
-  s.add_runtime_dependency 'jquery-rails'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'

data/lib/dismissible_blocks/version.rb

@@ -1,3 +1,3 @@
 module DismissibleBlocks
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dismissible_blocks
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Patrick Bougie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: jquery-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +146,7 @@ homepage: https://github.com/pbougie/dismissible_blocks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: DismissibleBlocks 2+ removed jQuery as a dependency. See README.
 rdoc_options: []
 require_paths:
 - lib