ajax_modal_rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7e2e50ac6f2bf4d2cb1f30bb650257184e34763
+  data.tar.gz: 13027e7ce01f196e3e3a7163b80ce05acfced388
+SHA512:
+  metadata.gz: 247c34fc573dcf5e5cbd1ab9213c1d303b2b8634fdf7a70b60a4a48f4d8edbdf05d1316a4023b38991a1e8b50aacf2b8a1f9f0d65eeb4924ed74b94d1b6ed674
+  data.tar.gz: e40a97c28651dc565a9e97b5f6057f731018d4d55502289569a9197dd81b024b93c3f99e40de26dd81b199daeeca7bae3c554bb536ca30b268c97c5aab0261c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Rafe Rosen
+
+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,76 @@
+# AjaxModalRails
+This plugin provides a simple way to do common modal interactions in a rails app.  Add a single data attribute to links and forms and include a controller mixin to load pages via ajax in a modal.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ajax_modal_rails', '~> 1.0'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+### Setup Layout and Javascript
+Run `rails generate ajax_modal_rails:install` to require the necessary javascript in `application.js` and add a partial render to the bottom of the body in `layouts/application.html.erb|haml`
+
+#### Manual Installation
+
+Add `//= require ajax_modal_rails` to `app/assets/application.js`
+
+A page that opens a modal should call `render 'ajax_modal_rails/frame'` somewhere on the page.  We recommend you do this in your layout so the modal frame is available for all pages.
+
+## Usage
+
+Once everything is set up, loading to modals is pretty simple
+
+### Views
+
+Add the attribute `data-loads-in-ajax-modal` to a link and it's request will load in a modal over the current page.
+
+Add the attribute `data-submits-to-ajax-modal` to a form and the response from the form's submit will load in the modal frame.
+
+### Controller
+
+A controller that is processing actions to be loaded in a modal should `include AjaxModalRails::Controller`
+
+The mixin sets the appropriate layout for modal requests and adds behavior that allows a modal request that results in a redirect to redirect the whole page.
+
+## Example
+
+These snippets are taken from the included [example application](blob/master/spec/dummy)
+
+*app/controllers/messages_controller.rb*
+```ruby
+class MessagesController < ApplicationController
+  before_action :set_message, only: [:edit, :update, :destroy]
+
+  include AjaxModalRails::Controller
+  ...
+```
+
+*app/views/messages/index.html.erb*
+```erb
+<%= link_to 'New Message', new_message_path, data: {loads_in_ajax_modal: true} %>
+```
+
+*app/views/messages/\_form.html.erb*
+```erb
+<%= form_with(model: message, data: {submits_to_ajax_modal: true}) do |form| %>
+```
+
+## Customization
+
+If you want to customize the behavior of this gem, run `rails generate ajax_modal_rails:customize`.  It will copy the views, javascript, and controller mixin into your application.
+
+## Requirements
+
+The provided modal views and javascript require [Twitter Bootstrap 4.0](https://getbootstrap.com/docs/4.0/getting-started/introduction/).  You can do some customization if your app is using something else (see above).
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Gratitude
+This gem was made possible by a Professional Development benefit from my employer, [Green River](http://www.greenriver.com)

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    = 'AjaxModalRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+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/javascripts/ajax_modal_rails/index.coffee

@@ -0,0 +1,60 @@
+#############
+# Ajax modals
+#############
+class window.AjaxModal
+  constructor: ->
+    @modal = $(".modal[data-ajax-modal]")
+    @content = @modal.find("[data-ajax-modal-content]")
+    @linkTriggersSelector = '[data-loads-in-ajax-modal]'
+    @formTriggersSelector = '[data-submits-to-ajax-modal]'
+    @loading = @modal.find("[data-ajax-modal-loading]")
+    @listen()
+
+  listen: ->
+    @_registerLinks()
+    @_registerForms()
+    @_registerClose()
+
+  _registerLinks: ->
+    $('body').on 'click', @linkTriggersSelector, (e) =>
+      e.preventDefault()
+      @loading.show()
+      @open()
+      @content.load e.currentTarget.getAttribute("href"), (data) =>
+        @loading.hide()
+
+  _registerForms: ->
+    console.log $(@formTriggersSelector).toArray()
+    # scope.find(@formTriggersSelector).attr('data-remote', true)
+    $('body').on 'submit', @formTriggersSelector, (event) =>
+      form = event.currentTarget
+      event.preventDefault()
+      console.log $(form).serialize()
+      $.ajax
+        url: form.getAttribute('action')
+        type: form.getAttribute('method')
+        dataType: 'html',
+        data: $(form).serialize()
+        complete: (xhr, status) =>
+          @loading.hide()
+          @content.html xhr.responseText
+          @open
+          @_registerLinks @content
+      return false
+
+
+    # $('body').on 'ajax:complete', @formTriggersSelector, (event, data, status, xhr) =>
+    #   @_registerForms @content
+      
+  # maybe don't need this for bootstrap
+  _registerClose: ->
+    @modal.on 'click', '[data-ajax-modal-close]', =>
+      @modal.modal('hide')
+      @reset()
+
+  open: ->
+    @modal.modal 'show'
+
+  reset: ->
+    @content.html("")
+    @loading.show()

data/app/controllers/ajax_modal_rails/controller.rb

@@ -0,0 +1,49 @@
+module AjaxModalRails::Controller
+  # This module sets up controllers to load their content in a modal
+  # in response to pjax requests.  See pjax-modals.js.coffee for client side details
+  #
+  # calling render will render a template to the modal
+  # and calling redirect_to will trigger a redirect on the underlying page
+  #
+  # note that inbound links should have `data-loads-in-pjax-modal` attributes
+  # and forms should have `data-submits-to-pjax-modal`
+
+  extend ActiveSupport::Concern
+
+  included do
+    layout ->(c) { ajax_modal_request? ? ajax_modal_layout : nil }
+
+    def form_html_options
+      Hash.new.tap do |result|
+        result['data-submits-to-pjax-modal'] = true if ajax_modal_request?
+      end
+    end
+    helper_method :form_html_options
+
+    def redirect_to_with_xhr_redirect(*args)
+      if ajax_modal_request?
+        flash.merge! args.last if args.length > 1
+        render "ajax_modal_rails/redirect_via_js", layout: ajax_modal_layout, locals: {redirect: url_for(args.first)}
+      else
+        redirect_to_without_xhr_redirect(*args)
+      end
+    end
+    alias_method :redirect_to_without_xhr_redirect, :redirect_to
+    alias_method :redirect_to, :redirect_to_with_xhr_redirect
+
+  end
+
+  private
+
+    def ajax_modal_layout
+      'ajax_modal_rails/content'
+    end
+
+    def ajax_modal_request?
+      # TODO implement w/ special request header just catch all xhr for now
+      # can always override in controller if necessary
+      # request.env['HTTP_X_AJAX_MODAL'].present?
+      request.xhr?
+    end
+
+end

data/app/views/ajax_modal_rails/_frame.html.erb

@@ -0,0 +1,22 @@
+<div class="modal fade" id="ajax-modal" data-ajax-modal tabindex="-1" role="dialog">
+  <div class="modal-dialog modal-lg" role="document">
+    <div class="modal-content" data-ajax-modal-content>
+      <div class="modal-header">
+        <button class="close" aria-label="Close" data-ajax-modal-close type="button">
+          &times;
+        </button>
+        <h4 class="modal-title" data-ajax-modal-title></h4>
+      </div>
+      <div class="modal-body clearfix">
+        <div data-ajax-modal-loading>
+          Loading&hellip;
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+
+
+<script>
+  new AjaxModal()
+</script>

data/app/views/ajax_modal_rails/redirect_via_js.html.erb

@@ -0,0 +1,4 @@
+<script>
+  window.location.href = '<%= redirect %>'
+</script>
+  

data/app/views/layouts/ajax_modal_rails/content.html.erb

@@ -0,0 +1,23 @@
+<div class="modal-header">
+  <h4 class="modal-title" data-ajax-modal-title>
+    <%= yield :modal_title %>
+  </h4>
+  <button class="close" aria-label="Close" data-ajax-modal-close type="button">
+    &times;
+  </button>
+</div>
+<div class="modal-body clearfix">
+  <div data-ajax-modal-body>
+    <%= yield %>
+  </div>
+  <div data-ajax-modal-loading style="display: none;">
+    Loading&hellip;
+  </div>
+</div>
+<% if content_for?(:modal_footer) %>
+  <div class="modal-footer" data-pjax-modal-footer>
+    <%= yield :modal_footer %>
+  </div>
+<% end %>
+
+<%= yield :page_js %>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/ajax_modal_rails/engine.rb

@@ -0,0 +1,8 @@
+module AjaxModalRails
+  class Engine < ::Rails::Engine
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/ajax_modal_rails/version.rb

@@ -0,0 +1,3 @@
+module AjaxModalRails
+  VERSION = '1.0.1'
+end

data/lib/ajax_modal_rails.rb

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

data/lib/generators/ajax_modal_rails/customize/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Copy AjaxModalRails files into your application for customization
+
+Example:
+    rails generate ajax_modal_rails:customize

data/lib/generators/ajax_modal_rails/customize/customize_generator.rb

@@ -0,0 +1,31 @@
+class AjaxModalRails::CustomizeGenerator < Rails::Generators::Base
+
+  class_option :skip_controllers, type: 'boolean', default: false, desc: "Don't copy controller mixin"
+  class_option :skip_views, type: 'boolean', default: false, desc: "Don't copy views"
+  class_option :skip_javascripts, type: 'boolean', default: false, desc: "Don't copy javascripts"
+
+
+  source_root File.expand_path('../../../../../app', __FILE__)
+
+  def copy!
+    copy_controllers unless options.skip_controllers?
+    copy_views unless options.skip_views?
+    copy_javascripts unless options.skip_javascripts?
+  end
+
+  private 
+
+    def copy_controllers
+      directory 'controllers/ajax_modal_rails', 'app/controllers/ajax_modal_rails'
+    end
+
+    def copy_views
+      directory 'views/ajax_modal_rails', 'app/views/ajax_modal_rails'
+    end
+
+    def copy_javascripts
+      directory 'assets/javascripts/ajax_modal_rails', 'app/assets/javascripts/ajax_modal_rails'
+    end
+
+
+end

data/lib/generators/ajax_modal_rails/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Add ajax_modal_rails to the application layout
+
+Example:
+    rails generate ajax_modal_rails:install

data/lib/generators/ajax_modal_rails/install/install_generator.rb

@@ -0,0 +1,42 @@
+class AjaxModalRails::InstallGenerator < Rails::Generators::Base
+
+  def self.default_layout
+    begin
+      Haml
+      return find_default_haml_layout
+    rescue NameError
+      return 'app/views/layouts/application.html.erb'
+    end
+  end
+
+  class_option :skip_layout, type: 'boolean', default: false, desc: "Don't modify application layout"
+  class_option :skip_javascript, type: 'boolean', default: false, desc: "Don't modify application javascript"
+  class_option :layout, type: 'string', default: default_layout, desc: 'Specify a custom layout'
+  class_option :javascript, type: 'string', default: 'app/views/layouts/application.js', desc: 'Specify a custom javascript'
+
+
+  def install
+    install_layout unless options.skip_layout?
+    install_javascript unless options.skip_javascript?
+  end
+
+  private
+
+    def install_layout
+      begin
+        Haml
+        append_to_file options.layout, File.read(File.expand_path('../templates/render_ajax_modal_frame.html.haml', __FILE__))
+      rescue NameError
+        insert_into_file options.layout, File.read(File.expand_path('../templates/render_ajax_modal_frame.html.erb', __FILE__)), before: '</body>'
+      end
+    end
+
+    def install_javascript
+      append_to_file 'app/assets/javascripts/application.js', '//= require ajax_modal_rails'
+    end
+
+    def self.find_default_haml_layout
+      Dir.glob('app/views/layouts/application{.html,}.haml').first
+    end
+
+end

data/lib/generators/ajax_modal_rails/install/templates/render_ajax_modal_frame.html.erb

@@ -0,0 +1 @@
+    <%= render 'ajax_modal_rails/frame' %>

data/lib/generators/ajax_modal_rails/install/templates/render_ajax_modal_frame.html.haml

@@ -0,0 +1 @@
+    = render 'ajax_modal_rails/frame'

data/lib/tasks/ajax_modal_rails_tasks.rake

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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: ajax_modal_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Rafe Rosen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-27 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: coffee-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: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: jquery-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: bootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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'
+description: 
+email:
+- existentialmutt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/ajax_modal_rails_manifest.js
+- app/assets/javascripts/ajax_modal_rails/index.coffee
+- app/controllers/ajax_modal_rails/controller.rb
+- app/views/ajax_modal_rails/_frame.html.erb
+- app/views/ajax_modal_rails/redirect_via_js.html.erb
+- app/views/layouts/ajax_modal_rails/content.html.erb
+- config/routes.rb
+- lib/ajax_modal_rails.rb
+- lib/ajax_modal_rails/engine.rb
+- lib/ajax_modal_rails/version.rb
+- lib/generators/ajax_modal_rails/customize/USAGE
+- lib/generators/ajax_modal_rails/customize/customize_generator.rb
+- lib/generators/ajax_modal_rails/install/USAGE
+- lib/generators/ajax_modal_rails/install/install_generator.rb
+- lib/generators/ajax_modal_rails/install/templates/render_ajax_modal_frame.html.erb
+- lib/generators/ajax_modal_rails/install/templates/render_ajax_modal_frame.html.haml
+- lib/tasks/ajax_modal_rails_tasks.rake
+homepage: http://github.com/existentialmutt/ajax_modal_rails
+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: simple ajax-driven modals for rails
+test_files: []