lazy_modal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bd9635b880dff28e3703aa326dce4f9fa026812
+  data.tar.gz: c594673c0f7512f1379c66e0f5c129a54baf58ad
+SHA512:
+  metadata.gz: 6a291dd52e6525d3b392d0f7fe6e124c7d312d51901765f8fe3dcfc6be5075a4bf837cdcbc2737b1e4da9819e4cbdeb016c78489252f5f676b8b6a4a8dfd41b1
+  data.tar.gz: eb691f947004141aba6513cacf872050049d3c6c21b265570937ecdd1bdbdf83c38f8de167b5e72b4e10ca408012eba685fde9c2ac701d18027d1db90ec5060e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 LiBo
+
+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,60 @@
+# lazy-modal
+
+show **bootstrap** modal with lazy load. sometimes we have too many modals in html body. and u know always some modal not need rendered. the best pratice to show modal i think is lazy load modal. **bootstrap** modal plugin provide remote away the load modal content when needed.
+this gem provide way load **bootstrap** modal from remote server. so that we can load the modal when needed it. it's start!  
+
+## Usage
+
+How to **lazy-modal** it's too simplest! 
+
+Add this line to your rails application's Gemfile:
+
+```ruby
+gem 'lazy_modal'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Auto init lazy_modal required file
+
+```
+$ rails generate lazy_modal:install
+```
+
+That's all!
+
+Now test if `lazy-modal` installed?
+
+Start server
+
+```bash
+$ rails s 
+```
+
+open below url in any browse [http://localhost:3000/lazy_modal/demo](http://localhost:3000/lazy_modal/demo), u will see a break style modal demo 
+
+##Options
+
+You can trigger `lazy_modal` below way:
+
+```
+<%= link_to 'demo', '#demo', data: {lazy_modal: true, modal_options:{dir: 'custom_modals', title: 'loading', size: 'modal-sm', target: 'demo', id: 'demo'}} %>
+```
+
+You must set `a` tag with **data-lazy-modal=true** and use **modal_options** to custom modal
+
+ModalOptions | Type  | Remark
+------------- | ------------- | -----------
+id/target/href  | string | **required**， modal id like: `#charge_modal`
+dir  | string | **optional**，u should set u modal view dir name like: `users` mean's find modal in `app/views/users/modal_id`
+title  | string | **optional**，before load remote modal, u will see  simple load modal with placeholder, so the options set the modal title
+size  | string | **optional**，before load remote modal, u will see  simple load modal with placeholder, so the options set the modal-content with custom class like: `modal-sm|modal-lg`
+
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+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    = 'LM'
+  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", __FILE__)
+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/javascripts/lazy_modal/application.coffee

@@ -0,0 +1,76 @@
+#= require jquery
+#= require bootstrap/modal
+
+window.LM ||= {}
+
+LM.loadRemoteModalByID = (modalID, modalOptions) ->
+  new LazyModalModal(modalID, modalOptions).show()
+
+LM.triggerLoadRemoteModal = (event) ->
+  event.preventDefault()
+  $target = $(event.currentTarget)
+  modalOptions = $target.data('modal-options')
+  modalID = modalOptions.target || modalOptions.id || $target.attr('href')
+  LM.loadRemoteModalByID modalID, modalOptions
+
+class LazyModalModal
+  constructor: (@originModalID, @modalOptions) ->
+    @modalTitle = @modalOptions?.default_modal?.title || ''
+    alert('u must set modal ID with data-target or href attrs') unless @originModalID
+    if @originModalID.indexOf('#') !=-1
+      @modalID = @originModalID?.split("#").pop()
+    else
+      @modalID = @originModalID
+      @originModalID = "##{@originModalID}"
+
+  show: ->
+    return unless @modalID
+    @_findOrCreateModal()
+    @_showModal()
+
+  _findOrCreateModal: ->
+    if $(@originModalID).length
+      @modal = $(@originModalID)
+    else
+      modalDom = @_createModalDom()
+      @modal = $(modalDom)
+      @_addModalEventListener()
+
+  _showModal: ->
+    @modal?.modal 'show' unless @modal?.isShown
+
+  _createModalDom: ->
+    """
+      <div class="modal light dialog in" tabindex="-1" role="dialog" aria-hidden="true">
+        <div class="modal-dialog #{@modalOptions?.default_modal?.size || ''}">
+	        <div class="modal-content">
+	          <div class="modal-header">
+	            <button type="button" class="close" data-dismiss="modal"><span>×</span></button>
+	            <h4 class="modal-title">#{@modalTitle || ''}</h4>
+	          </div>
+	          <div class="modal-body clearfix">
+	            <h5 class="text-center">loading...</h5>
+	          </div>
+	        </div>
+        </div>
+      </div>
+    """
+
+  _addModalEventListener: ->
+    @modal.on 'shown.bs.modal', =>
+      return if $("##{@modalID}").length
+      data = {modal_dir: @modalOptions?.dir}
+      console.log @modalID, @modalOptions
+      $.get("/lazy_modals/#{@modalID}", data)
+        .done (response) => @_loadRemoteModalSuccessed response
+        .fail (response, xhr, status) =>
+            @modal.find('.modal-body').html response.responseText
+
+  _loadRemoteModalSuccessed: (response)->
+    @modal?.modal 'hide'
+    @modal = $(response)
+    $('body').append @modal
+    @modal.trigger 'LM.modal.content.loaded', @modalOptions
+    @show()
+
+$(document).on 'click', '[data-lazy-modal="true"]', LM.triggerLoadRemoteModal

data/app/assets/stylesheets/lazy_modal/application.scss

@@ -0,0 +1,18 @@
+// Core variables and mixins
+@import "bootstrap/variables";
+@import "bootstrap/mixins";
+
+// Core CSS
+@import "bootstrap/buttons";
+@import "bootstrap/type";
+
+// Components
+@import "bootstrap/component-animations";
+@import "bootstrap/close";
+
+// Components w/ JavaScript
+@import "bootstrap/modals";
+
+// Utility classes
+@import "bootstrap/utilities";
+@import "bootstrap/responsive-utilities";

data/app/controllers/lazy_modal/lazy_modals_controller.rb

@@ -0,0 +1,18 @@
+module LazyModal
+  class LazyModalsController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    rescue_from ActionView::MissingTemplate do
+      render plain: 'modal missing', status: :not_found
+    end
+
+    def show
+      tmpl = if params[:modal_dir]
+               "#{params[:modal_dir]}/#{params[:id]}"
+             else
+               "/lazy_modal/modals/#{params[:id]}"
+             end
+      render tmpl, layout: nil
+    end
+  end
+end

data/app/views/lazy_modal/modals/demo.erb

@@ -0,0 +1,18 @@
+<div class="modal fade" id="lazy_modal_demo">
+  <div class="modal-dialog">
+    <div class="modal-content">
+      <div class="modal-header">
+        <button type="button" class="close" data-dismiss="modal" aria-label="Close">
+          <span aria-hidden="true">&times;</span></button>
+        <h4 class="modal-title">Demo</h4>
+      </div>
+      <div class="modal-body">
+        <p>This is Lazy Modal Demo, you can custom the modal by <%= link_to 'Readme', '#' %></p>
+      </div>
+      <div class="modal-footer">
+        <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+        <button type="button" class="btn btn-primary">OK I Got It!</button>
+      </div>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,3 @@
+LazyModal::Engine.routes.draw do
+  resources :lazy_modals, only: [:show]
+end

data/lib/generators/lazy_modal/install_generator.rb

@@ -0,0 +1,34 @@
+module LazyModal
+  class InstallGenerator < Rails::Generators::Base
+
+    desc 'install lazy modal'
+    def install
+      route("mount LazyModal::Engine => '/'")
+    end
+
+    def inject_js_asset_file
+      %w(js coffee).each do |ext|
+        dest_file_path = "app/assets/javascripts/application.#{ext}"
+        if File.exist? "#{destination_root}/#{dest_file_path}"
+          insert_into_file dest_file_path, :before => "//= require_tree" do
+            "//= require lazy_modal/application\n"
+          end
+          break
+        end
+      end
+    end
+
+    def inject_css_asset_file
+      %w(css scss sass).each do |ext|
+        dest_file_path = "app/assets/stylesheets/application.#{ext}"
+        if File.exist? "#{destination_root}/#{dest_file_path}"
+          insert_into_file dest_file_path, :before => "*= require_self" do
+            "*= require lazy_modal/application\n"
+          end
+          break
+        end
+      end
+    end
+
+  end
+end

data/lib/lazy_modal/engine.rb

@@ -0,0 +1,7 @@
+require 'bootstrap-sass'
+require 'jquery-rails'
+module LazyModal
+  class Engine < ::Rails::Engine
+    isolate_namespace LazyModal
+  end
+end

data/lib/lazy_modal/version.rb

@@ -0,0 +1,3 @@
+module LazyModal
+  VERSION = '0.1.0'
+end

data/lib/lazy_modal.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: lazy_modal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MixBo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-18 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: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.1
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: bootstrap-sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.7
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: lazy load bootstrap modal when u needed!
+email:
+- lb563@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/lazy_modal/application.coffee
+- app/assets/stylesheets/lazy_modal/application.scss
+- app/controllers/lazy_modal/lazy_modals_controller.rb
+- app/views/lazy_modal/modals/demo.erb
+- config/routes.rb
+- lib/generators/lazy_modal/install_generator.rb
+- lib/lazy_modal.rb
+- lib/lazy_modal/engine.rb
+- lib/lazy_modal/version.rb
+homepage: https://github.com/lihlio/lazy_modal
+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.5.2
+signing_key: 
+specification_version: 4
+summary: lazy load bootstrap modals
+test_files: []
+has_rdoc: