maac 1.0.1 → 2.0.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46cb9df9785d419525d2d47133e5f2219229bfec
-  data.tar.gz: 8a0d3d6c3c91cd3e108d509b31f409142dd7c240
+  metadata.gz: 7a55633ff282d4a350ae99e7be839675b285381d
+  data.tar.gz: d8eab4a2387e037cd27d3a9d0945c6ce2088b592
 SHA512:
-  metadata.gz: 72c69ee734da00acacd3067d78f8f13dfa5bf560f9199da12b79b6037ca46b9f6fd1692096d844b40ca569bd65b6c00b85b24b64aed20015f7d151e7c6b9ac95
-  data.tar.gz: a9f409b6c5e7d3811e75be282fa32b4e5426489ec9569b7d06b83a58b4298158d7a3f394cf2fe6eaf7590a0cafc974596020bbb852ef32663c98ee5f5604077d
+  metadata.gz: 7d0240b46213423cd440533f30272b73a298ba76f1f96f6e6e64e7d7fc015300ca65ce70b4c452ccbf494bbc6454696f2da6e0bc2f1bd2acb22bdd0bd51387ff
+  data.tar.gz: c45086746cb712a3721297a97b218e5a077f61873c7daf77e54b52de1ee596fbca71594c1c2357870688c803edf1c221e3a5705d854345624af4f13601f913d3

data/README.md

@@ -5,9 +5,33 @@
 [![Gem](https://img.shields.io/gem/v/maac.svg)](https://rubygems.org/gems/maac)
 
 This gem allows you to replace standard confirm() call for data-confirm'ed page elements,
-with a bootstrap modal. I.e. instead of calling confirm("Are you sure?") this code will draw
-a bootstrap yes-no modal after clicking the link.
-For now, you can customize dialog texts using following attributes:
+with a html modal (Bootstrap modal or a custom markup). I.e. instead of calling confirm("Are you sure?") this code will draw
+a yes-no popup after clicking the link.
+
+```rhtml
+<%= link_to 'A very dangerous action',
+        dangerous_action_path,
+        data: {
+            method: :delete,
+            confirm: 'Are you sure?'
+        } %>
+```
+
+```rhtml
+<%= link_to 'A very dangerous action',
+        dangerous_action_path,
+        data: {
+            method: :delete,
+            'confirm-title': 'Oh, no!',
+            confirm: 'Are you sure?'
+        } %>
+``` 
+
+There are lots of gems for the similar purposes, but I found nothing appropriate for Rails 5.1
+So I've made it for my own purposes. I'll be happy if you find it useful.
+
+## Run-time configuration
+You can simply customize titles via link attributes:
 
 - **data-confirm-title** - *dialog title text: default value is "Confirm"*
 
@@ -22,11 +46,73 @@ For now, you can customize dialog texts using following attributes:
         dangerous_action_path,
         data: {
             method: :delete,
-            confirm: 'Are you sure?'
+            confirm: 'Are you sure?',
+            'confirm-title': 'Important!',
+            'confirm-yes': 'Proceed',
+            'confirm-no': 'Dismiss',
+            'confirm-close': 'Never mind'
         } %>
 ```
-There are lots of gems for the same purpose, but I found nothing appropriate for Rails 5.
-So I've made it for my purposes. I'll be happy if you find it useful.
+
+## Initialization
+If your gemfile includes a gem, which is named with something containing "bootstrap",
+the bootstrap modal'll be used by default. Otherwise it will use the following template code:
+
+```html
+<div class="maac-popup">
+    <div class="maac-popup_inner">
+        <div class="maac-popup_header">
+            <div class="maac-popup_header_title">%{title}</div>
+            <div class="maac-popup_header_buttons">
+                <a id="js-maac-close" href="javascript:void(0)" class="maac-popup_header_buttons_button maac-popup_header_buttons_button__close">%{close}</a>
+            </div>
+        </div>
+        <div class="maac-popup_body">%{text}</div>
+        <div class="maac-popup_footer">
+            <div class="maac-popup_footer_buttons">
+                <a id="js-maac-yes" href="javascript:void(0)" class="maac-popup_footer_buttons_button maac-popup_footer_buttons_button__yes">%{yes}</a>
+                <a id="js-maac-no" href="javascript:void(0)" class="maac-popup_footer_buttons_button maac-popup_footer_buttons_button__no">%{no}</a>
+            </div>
+        </div>
+    </div>
+</div>
+```
+
+You can add an initializer, i.e.:
+*/config/initializers/maac.rb*:
+```ruby
+Maac.configure do |config|
+  # Strings to be substituted into template
+  # (using %{key}). You can define your own set of keys
+  config.strings = {
+    title: 'A default title value',
+    yes:   'A default Yes button text',
+    no:    'A default No button text',
+    close: 'A default Close button text'
+  }
+
+  # A modal' template code
+  config.template      = '<div class="my-modal"><span id="js-yes">%{yes}</span><span id="js-no">%{no}</span></div>'
+
+  # A modal' selector – used to remove the modal code and
+  # for event bindings 
+  config.selector      = '.my-modal'
+
+  # Selector of a yes button 
+  config.selector_y    = '#js-yes'
+
+  # Selector of a no button
+  config.selector_n    = '#js-no'
+  
+  # Callback, which is called just after the modal code
+  # appended to a page
+  config.after_append  = 'function () {}'
+
+  # Async handler, called before code removement.
+  # After your code completes the execution call cb()
+  config.before_remove = 'function (cb) { cb(); }'
+end
+```
 
 ## Installation
 
@@ -85,21 +171,26 @@ Most important steps are described below. You can also look at defined rake task
 
 ### Setup
 
-You must perform a few simple steps to prepare the project for development:
+Simply run:
 
     $ bundle install
-    $ rake db:migrate
+    $ rake dummy:dep
     $ rake
 
+And rake will compile the .coffee.erb code and run all tests for you.
+
 ### Testing
 
 The project uses automated testing. The RSpec is used.
 The /spec directory contents:
 
-- **/spec/dummy** - *a simple rails app used for gem testing*
-- **/spec/factories** - *factory_bot factory descriptions*
-- **/spec/features/maac_features_spec.rb** - *gem specifications*
-- **/spec/spec_helper.rb** - *a helper file*
+- **/spec/features/client_spec.rb** - the main behaviour testing
+- **/spec/features/config_spec.rb** - the gem' configuration testing
+- **/spec/features/host_application_spec.rb** - dummy application, which uses the maac, testing
+ 
+- **/spec/support/dummy** - dummy applications
+- **/spec/support/dummy/vanilla** - a dummy app, which uses neither jQuery nor Bpptstrap
+- **/spec/support/dummy/bs3** - a dummy app, which uses both jQuery and Bpptstrap
 
 To start automated testing just type:
 

data/app/assets/javascripts/maac.js.erb

@@ -0,0 +1,82 @@
+
+/*!
+ * Modal As A Confirm (MAAC) 2.0.0.pre.alpha (2018-02-06 18:59:03 +0300)
+ * https://github.com/igorakaamigo/maac
+ * Released under the MIT license:
+ * https://github.com/igorakaamigo/maac/blob/master/MIT-LICENSE
+ */
+
+(function() {
+  this.Maac = (function() {
+    function Maac() {}
+
+    Maac.version = '2.0.0.pre.alpha';
+
+    Maac.strings = <%= Maac.strings.to_json %>;
+
+    Maac.template = <%= Maac.template.to_json %>;
+
+    Maac.selector = <%= Maac.selector.to_json %>;
+
+    Maac.selector_y = <%= Maac.selector_y.to_json %>;
+
+    Maac.selector_n = <%= Maac.selector_n.to_json %>;
+
+    Maac.after_append = <%= Maac.after_append %>;
+
+    Maac.before_remove = <%= Maac.before_remove %>;
+
+    Maac.show = function() {
+      if (!document.querySelector(Maac.selector)) {
+        document.body.innerHTML += Maac.html();
+        return Maac.after_append();
+      }
+    };
+
+    Maac.hide = function(confirmed) {
+      return Maac.before_remove(function() {
+        document.querySelector(Maac.selector).remove();
+        if (confirmed) {
+          Maac._link.removeAttribute('data-confirm');
+          return Maac._link.click();
+        }
+      });
+    };
+
+    Maac.avalue = function(key) {
+      if (key === 'text') {
+        return Maac._link.getAttribute('data-confirm');
+      } else {
+        return Maac._link.getAttribute("data-confirm-" + key) || Maac.strings[key];
+      }
+    };
+
+    Maac.html = function() {
+      return Maac.template.replace(/%{(.*?)}/g, function(_, key) {
+        return Maac.avalue(key);
+      });
+    };
+
+    Maac.initialize = function() {
+      Rails.delegate(document, 'a[data-confirm]', 'confirm', function() {
+        Maac._link = this;
+        Maac.show();
+        return false;
+      });
+      Rails.delegate(document, Maac.selector_n, 'click', function(event) {
+        Rails.stopEverything(event);
+        return Maac.hide();
+      });
+      return Rails.delegate(document, Maac.selector_y, 'click', function(event) {
+        Rails.stopEverything(event);
+        return Maac.hide(true);
+      });
+    };
+
+    return Maac;
+
+  })();
+
+  Maac.initialize();
+
+}).call(this);

data/lib/maac.rb

@@ -1,4 +1,30 @@
+# frozen_string_literal: true
+
+require 'maac/engine'
+require 'maac/config'
+
 module Maac
-  class Engine < ::Rails::Engine
+  class << self
+    def configure
+      yield config
+    end
+
+    def respond_to_missing?(symbol)
+      config.respond_to?(symbol) || super
+    end
+
+    def method_missing(symbol, *args)
+      if config.respond_to?(symbol)
+        config.send(symbol, *args)
+      else
+        super
+      end
+    end
+
+    private
+
+    def config
+      @config ||= Config.new
+    end
   end
 end

data/lib/maac/config.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+
+module Maac
+  class Config
+    OPTIONS = %i[
+      strings
+      template
+      selector
+      selector_y
+      selector_n
+      after_append
+      before_remove
+    ].freeze
+
+    OPTIONS.each do |option|
+      attr_accessor option
+    end
+
+    def initialize
+      @strings = {
+        title: 'Confirm',
+        yes:   'Yes',
+        no:    'No',
+        close: 'Close'
+      }
+
+      @selector   = '.maac-popup'
+      @selector_y = '#js-maac-yes'
+
+      bsgems = Gem::Specification.reject { |s| s.name.match(/bootstrap/i).nil? }
+      if bsgems.count > 0
+        @template      = File.new(File.expand_path('../../../tpl/bs3.html', __FILE__)).read
+        @selector_n    = '#js-maac-no,#js-maac-close'
+        @after_append  = 'function () { $(".maac-popup").modal({"backdrop": "static"}); }'
+        @before_remove = 'function (cb) { $(".maac-popup").modal("hide"); cb(); }'
+      else
+        @template      = File.new(File.expand_path('../../../tpl/vanilla.html', __FILE__)).read
+        @selector_n    = '#js-maac-no,#js-maac-close'
+        @after_append  = 'function () { /* After append */; }'
+        @before_remove = 'function (cb) { /* Before remove */; cb(); }'
+      end
+    end
+  end
+end

data/lib/maac/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Maac
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/maac/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Maac
+  VERSION = '2.0.0.pre.alpha'
+end

data/tpl/bs3.html

@@ -0,0 +1,19 @@
+<div class="modal maac-popup" tabindex="-1" role="dialog">
+    <div class="modal-dialog" role="document">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h5 class="modal-title">%{title}</h5>
+                <button id="js-maac-close" type="button" class="close" aria-label="%{close}">
+                    <span aria-hidden="true">&times;</span>
+                </button>
+            </div>
+            <div class="modal-body">
+                <p>%{text}</p>
+            </div>
+            <div class="modal-footer">
+                <button id="js-maac-yes" type="button" class="btn btn-primary">%{yes}</button>
+                <button id="js-maac-no" type="button" class="btn btn-secondary">%{no}</button>
+            </div>
+        </div>
+    </div>
+</div>

data/tpl/vanilla.html

@@ -0,0 +1,17 @@
+<div class="maac-popup">
+    <div class="maac-popup_inner">
+        <div class="maac-popup_header">
+            <div class="maac-popup_header_title">%{title}</div>
+            <div class="maac-popup_header_buttons">
+                <a id="js-maac-close" href="javascript:void(0)" class="maac-popup_header_buttons_button maac-popup_header_buttons_button__close">%{close}</a>
+            </div>
+        </div>
+        <div class="maac-popup_body">%{text}</div>
+        <div class="maac-popup_footer">
+            <div class="maac-popup_footer_buttons">
+                <a id="js-maac-yes" href="javascript:void(0)" class="maac-popup_footer_buttons_button maac-popup_footer_buttons_button__yes">%{yes}</a>
+                <a id="js-maac-no" href="javascript:void(0)" class="maac-popup_footer_buttons_button maac-popup_footer_buttons_button__no">%{no}</a>
+            </div>
+        </div>
+    </div>
+</div>

metadata

@@ -1,115 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: maac
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0.pre.alpha
 platform: ruby
 authors:
 - Igor M Osipov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.1.4
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coffee-script
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: poltergeist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies: []
 description: This gem allows you to replace standard confirm() call for data-confirm'ed
-  page elements, with a bootstrap modal.
+  page elements, with a nice styled modal.
 email:
 - osipov.igor.amigo@gmail.com
 executables: []
@@ -118,8 +20,13 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/assets/javascripts/maac.js.erb
 - lib/maac.rb
-- vendor/assets/javascripts/maac.js
+- lib/maac/config.rb
+- lib/maac/engine.rb
+- lib/maac/version.rb
+- tpl/bs3.html
+- tpl/vanilla.html
 homepage: https://github.com/igorakaamigo/maac
 licenses:
 - MIT
@@ -135,13 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Bootstrap confirmation modal for data-confirm'ed links @ Rails 5 projects
+summary: Configurable confirmation modal (Bootstrap or custom markup) for data-confirm'ed
+  links @ Rails 5 projects
 test_files: []

data/vendor/assets/javascripts/maac.js

@@ -1,55 +0,0 @@
-
-/*!
-Modal As A Confirm (MAAC) v1.0.1 (2018-02-02T21:36:12+03:00)
-https://github.com/igorakaamigo/maac
-Released under the MIT license:
-https://github.com/igorakaamigo/maac/blob/master/MIT-LICENSE
- */
-
-(function() {
-  var safeBsModal, showAModal;
-
-  Rails.delegate(document, 'a[data-confirm]', 'confirm', function(event) {
-    showAModal(this, 'Yes', 'No', 'Close', 'Confirm');
-    return false;
-  });
-
-  safeBsModal = function(arg) {
-    if (this.jQuery && this.jQuery.fn.modal) {
-      return this.jQuery('.modal').modal(arg);
-    }
-  };
-
-  showAModal = function(link, defaultYes, defaultNo, defaultClose, defaultTitle) {
-    var close, dialogClose, dialogNo, dialogTitle, dialogYes, modal;
-    modal = document.createElement('div');
-    modal.className = 'modal';
-    modal.setAttribute('tabindex', '-1');
-    modal.setAttribute('role', 'dialog');
-    dialogYes = link.getAttribute('data-confirm-yes') || defaultYes;
-    dialogNo = link.getAttribute('data-confirm-no') || defaultNo;
-    dialogClose = link.getAttribute('data-confirm-close') || defaultClose;
-    dialogTitle = link.getAttribute('data-confirm-title') || defaultTitle;
-    modal.innerHTML = '<div class="modal-dialog" role="document"> <div class="modal-content"> <div class="modal-header"> <h5 class="modal-title"></h5> <button type="button" class="close" aria-label=""> <span aria-hidden="true">&times;</span> </button> </div> <div class="modal-body"> <p></p> </div> <div class="modal-footer"> <button type="button" class="btn btn-secondary"></button> <button type="button" class="btn btn-primary"></button> </div> </div> </div>';
-    modal.querySelector('.modal-body > p').innerText = link.getAttribute('data-confirm');
-    modal.querySelector('.modal-footer > .btn-secondary').innerText = dialogYes;
-    modal.querySelector('.modal-footer > .btn-primary').innerText = dialogNo;
-    modal.querySelector('.modal-header > button').setAttribute('aria-label', dialogClose);
-    modal.querySelector('.modal-header > h5').innerText = dialogTitle;
-    close = function() {
-      Rails.stopEverything(event);
-      safeBsModal('hide');
-      return modal.remove();
-    };
-    Rails.delegate(modal, '.close,.btn-primary', 'click', close);
-    Rails.delegate(document, '.modal-backdrop', 'click', close);
-    Rails.delegate(modal, '.btn-secondary', 'click', function(event) {
-      close();
-      link.removeAttribute('data-confirm');
-      return Rails.fire(link, 'click');
-    });
-    document.body.appendChild(modal);
-    return safeBsModal();
-  };
-
-}).call(this);