remote_modal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45753e7f1d575456f8db3c4b17fa5ad1320cf57c984d7e48565adddc092243eb
+  data.tar.gz: 54de352d75570e8fce29b907d1c542789037490d19da095f72b8a0684cc5738e
+SHA512:
+  metadata.gz: 87614edbc9438ac10eacacbc86a3592b229ce28aeb7ae5d4ea5455074fd01523046d13fcd1aeaad5fc5a87b86dadb65bcfad943ce41550351d3c70d36151c6dc
+  data.tar.gz: b9e8bd4bf5c9ced0aaacffe852d97a509b585ff3051dfc9bebf1c346a9fdfe0a63927b8a398cad3badc9d904edddd0f63477c3c76e5796415007e00550277685

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at KyleCRat@me.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in foundation-remote_modal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kyle Ratliff
+
+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,49 @@
+# RemoteModal
+
+RemoteModal is a small gem built to drastically simplify rendering rails partials in `foundation` reveals via a remote Ajax call.
+
+## Installation
+
+Ensure Foundation is fully supported within your application. See [Foundation Rails](https://github.com/zurb/foundation-rails) for more details on setting up and installing foundation inside a Rails application.
+
+Then Add this line to your application's Gemfile:
+
+```ruby
+gem 'remote_modal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remote_modal
+
+## Usage
+
+RemoteModal uses a new helper method `remote_modal` to render any partial within your application into a Foundation Reveal Modal using a remote call to a controller `remote_modals_controller` created by this gem.
+
+1. Create a new partial `static_modals/_my_test_modal.html.erb`
+2. Create a link to open the reveal with `remote_modal('Click Me!', :my_test_modal)`
+  * by default, RemoteModal looks for modals inside of a `static_modals` folder, if you pass a partial to the `remote_modal` method that doesn't exist in the normal context RemoteModal will look in the `static_modals` folder.
+  * `remote_modal` accepts any partial path even ones with `/` in them. e.g. `remote_modal('Click Me!', 'static_modals/my_test_modal')`
+3. Click the link and see your partial get appended to your document and opened with `.foundation('open')`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kylecrat/remote_modal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Foundation::RemoteModal project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kylecrat/remote_modal/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/remote_modal/remote_modals_controller.rb

@@ -0,0 +1,23 @@
+module RemoteModal
+  class RemoteModalsController < ApplicationController
+    before_action :append_view_paths
+
+    def show
+      @remote_modal = CGI.unescape(params[:remote_modal])
+      p @remote_modal
+      respond_to do |format|
+        format.js  { render 'show' }
+        format.all { render nothing: true, status: 200 }
+      end
+    end
+
+    private
+
+    def append_view_paths
+      @default_path = RemoteModal.configuration.default_path
+      return unless @default_path
+
+      append_view_path Rails.root.join('app', 'views', @default_path)
+    end
+  end
+end

data/app/helpers/remote_modal_helper.rb

@@ -0,0 +1,45 @@
+module RemoteModalHelper
+  # Creates a link_to rails helper that will remotely render the partial
+  # specified by :partial_path in a modal.
+  #
+  # options[:remote] will always be set to true, since it is requried to hit the
+  # controller as a js request to remotely render the modal.
+  #
+  # other options can be passed as a hash to remote_modal just like they can be
+  # passed to link_to. See https://apidock.com/rails/ActionView/Helpers/UrlHelper/link_to
+  # for more information on the html_options that can be passed.
+  def remote_modal(text, partial_path, options = {})
+    throw_template_error_if_partial_is_missing(partial_path)
+
+    href = remote_modal_show_path(CGI.escape("/#{partial_path}"))
+    options[:remote] = true
+
+    link_to(text, href, options)
+  end
+
+  private
+
+  # Renders the known missing partial directly so rails will throw a
+  # ActionView::MissingTemplate error on the page trying to render a link_to
+  # with a path to a partial that does not exist. This checks if the partial
+  # exists within <tt>app/views</tt> or in the directory set by the gem's
+  # defualt_path configuration.
+  #
+  # if default_path is set to false, this only checks <tt>app/views</tt>
+  #
+  # TODO: throw an error rather than render the partial for error.
+  def throw_template_error_if_partial_is_missing(partial_path)
+    @raise_err = RemoteModal.configuration.raise_page_error_for_missing_partials
+    return unless @raise_err
+
+    partial = File.basename(partial_path)
+    path = File.dirname(partial_path)
+    default_path = "#{RemoteModal.configuration.default_path}/#{path}"
+
+    return if lookup_context.template_exists?(partial, path, true)
+    return if RemoteModal.configuration.default_path &&
+              lookup_context.template_exists?(partial, default_path, true)
+
+    render "/#{partial_path}"
+  end
+end

data/app/views/remote_modal/remote_modals/_foundation_wrapper.html.erb

@@ -0,0 +1,3 @@
+<div class="reveal ajax-reveal" id="ajax-modal" data-reveal>
+  <%= render remote_modal %>
+</div>

data/app/views/remote_modal/remote_modals/show.js.erb

@@ -0,0 +1,5 @@
+(function($) {
+  // Javascript to append the reveal modal to the body and then open it
+  $('body').append('<%= j(render partial: 'foundation_wrapper', locals: { remote_modal: @remote_modal } ) %>').foundation();
+  $('#ajax-modal').foundation('open');
+})(jQuery);

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "remote_modal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  get '/remote_modals/:remote_modal',
+      to: 'remote_modal/remote_modals#show',
+      as: :remote_modal_show
+end

data/lib/errors/configuration.rb

@@ -0,0 +1,5 @@
+module RemoteModal
+  module Errors
+    class Configuration < StandardError; end
+  end
+end

data/lib/remote_modal/configuration.rb

@@ -0,0 +1,20 @@
+module RemoteModal
+  class Configuration
+    attr_accessor :raise_page_error_for_missing_partials,
+                  :default_path
+
+    def initialize
+      # boolean to tell RemoteModal to throw an error on a page that is trying
+      # to render a non-existant partial or not.
+      @raise_page_error_for_missing_partials = true
+
+      # path that RemoteModal will look in for any partials that are not found
+      # by the default rails partial finder methods.
+      #
+      # Can be set to <tt>false</tt> to not have a default path.
+      #
+      # TODO: Allow arrays for multiple default paths to check
+      @default_path = 'static_modals'
+    end
+  end
+end

data/lib/remote_modal/engine.rb

@@ -0,0 +1,3 @@
+module RemoteModal
+  class Engine < Rails::Engine; end
+end

data/lib/remote_modal/version.rb

@@ -0,0 +1,3 @@
+module RemoteModal
+  VERSION = "0.1.0"
+end

data/lib/remote_modal.rb

@@ -0,0 +1,23 @@
+require 'remote_modal/configuration'
+require 'remote_modal/version'
+require 'remote_modal/engine'
+
+module RemoteModal
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/remote_modal.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "remote_modal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "remote_modal"
+  spec.version       = RemoteModal::VERSION
+  spec.authors       = ["Kyle Ratliff"]
+  spec.email         = ["KyleCRat@me.com"]
+
+  spec.summary       = 'A lightweight dynamic and easy to use implementation of ajax foundation reveals'
+  spec.homepage      = 'https://www.kyleratliff.com'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/KyleCRat/foundation-remote_modal'
+    spec.metadata['changelog_uri'] = 'https://github.com/KyleCRat/foundation-remote_modal/blob/master/README.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: remote_modal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Ratliff
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- KyleCRat@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/remote_modal/remote_modals_controller.rb
+- app/helpers/remote_modal_helper.rb
+- app/views/remote_modal/remote_modals/_foundation_wrapper.html.erb
+- app/views/remote_modal/remote_modals/show.js.erb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/errors/configuration.rb
+- lib/remote_modal.rb
+- lib/remote_modal/configuration.rb
+- lib/remote_modal/engine.rb
+- lib/remote_modal/version.rb
+- remote_modal.gemspec
+homepage: https://www.kyleratliff.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://www.kyleratliff.com
+  source_code_uri: https://github.com/KyleCRat/foundation-remote_modal
+  changelog_uri: https://github.com/KyleCRat/foundation-remote_modal/blob/master/README.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A lightweight dynamic and easy to use implementation of ajax foundation reveals
+test_files: []