remote_bootstrap_modal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33feab5946f4216426bf5461104152fc6caff364
+  data.tar.gz: '0397502932e215ccc5a90598c3c9619ac5c3dd89'
+SHA512:
+  metadata.gz: 66f5bd0f16f08da8e199ef05ff5024032e1c093c34c8b35bc0737f8d8a2b7ae490e37802d932bb1dd2ae4ccf23af5bdfb41788f416e8f7be685acab09d2a63bd
+  data.tar.gz: f672a062917ed95ddb525e4f6031dc1eb09b32b16ddeaa1c953e56b07ffd00ecb8efd4e1af781888f20b51953e77cb996123d4be8991cb784ca7666f1db50ed9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Glauco Custódio
+
+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.md

@@ -0,0 +1,44 @@
+# Remote Bootstrap Modal
+A tiny Rails engine that helps you loading remote links into a bootstrap modal.
+
+It was created based on the following post: https://jtway.co/5-steps-to-add-remote-modals-to-your-rails-app-8c21213b4d0c
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_bootstrap_modal'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install remote_bootstrap_modal
+```
+
+## Requirements
+
+- Rails
+- Bootstrap
+
+## Usage
+
+1. Make sure you have bootstrap in your application
+2. Add this gem to your Gemfile
+3. Add the following div `<div id="modal-holder"></div>` to your application layout (the modal will be rendered inside it)
+4. Add `//= require remote_bootstrap_modal/modal.js` to your `app/assets/javascripts/application.js` (after jquery)
+5. Add `include RemoteBootstrapModal::Responder` to your `ApplicationController`
+6. Set the formats you need to respond with `respond_to` (ex: `respond_to :html, :json`)
+7. Call `respond_modal_with` in your controller passing the arguments you need
+8. Pass `data: { modal: true }` to links you want to load into a modal (ex: `link_to 'Customers', customers_path, class: 'btn btn-default', data: { modal: true }`)
+
+## Customization
+
+It is an engine, you can override any file to customize, you can create a `app/views/layouts/modal.html.erb` for instance with the modal layout you want.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'RemoteBootstrapModal'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/remote_bootstrap_modal_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/remote_bootstrap_modal .js
+//= link_directory ../stylesheets/remote_bootstrap_modal .css

data/app/assets/javascripts/remote_bootstrap_modal/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/app/assets/javascripts/remote_bootstrap_modal/modal.js

@@ -0,0 +1,31 @@
+$(function() {
+  const modal_holder_selector = '#modal-holder';
+  const modal_selector = '.modal';
+
+  $(document).on('click', 'a[data-modal]', function() {
+    const location = $(this).attr('href');
+    // Load modal dialog from server
+    $.get(
+      location,
+      data => { $(modal_holder_selector).html(data).find(modal_selector).modal() }
+    );
+    return false;
+  });
+
+  $(document).on('ajax:success', 'form[data-modal]', function(event){
+    const [data, _status, xhr] = event.detail;
+    const url = xhr.getResponseHeader('Location');
+    if (url) {
+      // Redirect to url
+      window.location = url;
+    } else {
+      // Remove old modal backdrop
+      $('.modal-backdrop').remove();
+      // Update modal content
+      const modal = $(data).find('body').html();
+      $(modal_holder_selector).html(modal).find(modal_selector).modal();
+    }
+
+    return false;
+  });
+});

data/app/assets/stylesheets/remote_bootstrap_modal/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/remote_bootstrap_modal/responder.rb

@@ -0,0 +1,13 @@
+require 'responders'
+
+module RemoteBootstrapModal
+  module Responder
+    extend ActiveSupport::Concern
+
+    def respond_modal_with(*args, &blk)
+      options = args.extract_options!
+      options[:responder] = ModalResponder
+      respond_with *args, options, &blk
+    end
+  end
+end

data/app/controllers/remote_bootstrap_modal/application_controller.rb

@@ -0,0 +1,5 @@
+module RemoteBootstrapModal
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/remote_bootstrap_modal/application_helper.rb

@@ -0,0 +1,4 @@
+module RemoteBootstrapModal
+  module ApplicationHelper
+  end
+end

data/app/jobs/remote_bootstrap_modal/application_job.rb

@@ -0,0 +1,4 @@
+module RemoteBootstrapModal
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/remote_bootstrap_modal/application_mailer.rb

@@ -0,0 +1,6 @@
+module RemoteBootstrapModal
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/remote_bootstrap_modal/application_record.rb

@@ -0,0 +1,5 @@
+module RemoteBootstrapModal
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/responders/remote_bootstrap_modal/modal_responder.rb

@@ -0,0 +1,26 @@
+module RemoteBootstrapModal
+  class ModalResponder < ::ActionController::Responder
+    cattr_accessor :modal_layout
+    self.modal_layout = 'modal'
+
+    def render(*args)
+      options = args.extract_options!
+      if request.xhr?
+        options.merge! layout: modal_layout
+      end
+      controller.render *args, options
+    end
+
+    def default_render(*args)
+      render(*args)
+    end
+
+    def redirect_to(options)
+      if request.xhr?
+        head :ok, location: controller.url_for(options)
+      else
+        controller.redirect_to(options)
+      end
+    end
+  end
+end

data/app/views/layouts/modal.html.erb

@@ -0,0 +1,13 @@
+<div class="modal" id="mainModal" tabindex="-1" role="dialog" aria-labelledby="mainModalLabel" aria-hidden="true">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+        <h4 class="modal-title" id="mainModalLabel">
+          <%= yield :title if content_for? :title %>&nbsp;
+        </h4>
+      </div>
+      <%= yield %>
+    </div>
+  </div>
+</div>

data/app/views/layouts/remote_bootstrap_modal/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Remote bootstrap modal</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "remote_bootstrap_modal/application", media: "all" %>
+  <%= javascript_include_tag "remote_bootstrap_modal/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RemoteBootstrapModal::Engine.routes.draw do
+end

data/lib/remote_bootstrap_modal/engine.rb

@@ -0,0 +1,5 @@
+module RemoteBootstrapModal
+  class Engine < ::Rails::Engine
+    isolate_namespace RemoteBootstrapModal
+  end
+end

data/lib/remote_bootstrap_modal/version.rb

@@ -0,0 +1,3 @@
+module RemoteBootstrapModal
+  VERSION = '0.0.1'
+end

data/lib/remote_bootstrap_modal.rb

@@ -0,0 +1,5 @@
+require "remote_bootstrap_modal/engine"
+
+module RemoteBootstrapModal
+  # Your code goes here...
+end

data/lib/tasks/remote_bootstrap_modal_tasks.rake

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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: remote_bootstrap_modal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Glauco Custódio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A tiny Rails engine that helps you loading remote links into a bootstrap
+  modal
+email:
+- glauco.custodio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/remote_bootstrap_modal_manifest.js
+- app/assets/javascripts/remote_bootstrap_modal/application.js
+- app/assets/javascripts/remote_bootstrap_modal/modal.js
+- app/assets/stylesheets/remote_bootstrap_modal/application.css
+- app/controllers/concerns/remote_bootstrap_modal/responder.rb
+- app/controllers/remote_bootstrap_modal/application_controller.rb
+- app/helpers/remote_bootstrap_modal/application_helper.rb
+- app/jobs/remote_bootstrap_modal/application_job.rb
+- app/mailers/remote_bootstrap_modal/application_mailer.rb
+- app/models/remote_bootstrap_modal/application_record.rb
+- app/responders/remote_bootstrap_modal/modal_responder.rb
+- app/views/layouts/modal.html.erb
+- app/views/layouts/remote_bootstrap_modal/application.html.erb
+- config/routes.rb
+- lib/remote_bootstrap_modal.rb
+- lib/remote_bootstrap_modal/engine.rb
+- lib/remote_bootstrap_modal/version.rb
+- lib/tasks/remote_bootstrap_modal_tasks.rake
+homepage: http://github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tiny Rails engine that helps you loading remote links into a bootstrap
+  modal
+test_files: []