ajax_error_renderer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 958d956880a60a471ed3beca4298c61b36c2ff18dd214df644e7903ad0021508
+  data.tar.gz: e800de870af5c1236d08df7fd03a4e54d8d3989faebd605d5148896c0598bfc7
+SHA512:
+  metadata.gz: 0e9d4ec34b94ee4696e22f7d217b9f3a2b8958a192155784bda7ee6ae4890e9542b71f0a8c8bfcd94085ff023b7bbd5f97a72250526e2266c2cb95a11c61299a
+  data.tar.gz: b0b7e3ba2393a731fa7fa0f45a8ee087b36b566a18434eb856b69b999dab046afaefc0d6e763922dfd35b130f5b113c1b4a01bca1a011d3cde1d5cd96b64b8dd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 willnet
+
+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,90 @@
+# AjaxErrorRenderer
+
+[![CircleCI](https://circleci.com/gh/willnet/ajax_error_renderer/tree/master.svg?style=svg)](https://circleci.com/gh/willnet/ajax_error_renderer/tree/master)
+
+AjaxErrorRenderer is a validation error renderer for ajax request.
+
+If you use turbolinks and form_with, you may need SJR(Server-generated JavaScript Responses) on validation errors. But it's a pain to add similar SJR code with every forms. AjaxErrorRenderer gives you render_ajax_error method to remove duplicated SJR.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ajax_error_renderer'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+First, `include AjaxErrorRenderer` in your controller like following.
+
+```ruby
+class ApplicationController < ActionController::Base
+  include AjaxErrorRenderer
+end
+```
+
+Then you can use render_ajax_error method like following.
+
+```ruby
+class UsersController < ApplicationController
+  def new
+    @user = User.new
+  end
+
+  def create
+    @user = User.new(params.require(:user).permit(:name))
+    if @user.save
+      redirect_to users_path, notice: 'You created a user successfully!'
+    else
+      render_ajax_error model: @user
+    end
+  end
+end
+```
+
+So error messages display within `#error` by default.
+
+```erb
+<%= form_with(model: @user) do |form| %>
+  <div id="error">
+    <%# Error Messages display here! %>
+  </div>
+
+  <div class="field">
+    <%= form.label :name %>
+    <%= form.text_field :name %>
+  </div>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>
+```
+
+If you want to display the messages in other place, you can do it by passing `location` option to `render_ajax_error` with css like following.
+
+
+```ruby
+render_ajax_error model: @user, location: '.error_messages'
+```
+
+### Custom Template
+
+You can create custome template with a generator like following.
+
+```sh
+./bin/rails g ajax_error_renderer:view
+```
+
+This generator command generates `app/views/ajax_errors/_error.html.erb`, and you can customize it freely.
+
+## 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    = 'AjaxErrorRenderer'
+  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/views/ajax_errors/_error.html.erb

@@ -0,0 +1,9 @@
+<% if model.errors.any? %>
+  <div id="error_explanation" class="alert alert-danger">
+    <ul>
+      <% model.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/app/views/ajax_errors/error.js.erb

@@ -0,0 +1 @@
+document.querySelector('<%= @location %>').innerHTML = "<%= j(render('ajax_errors/error', model: @model)) %>";

data/lib/ajax_error_renderer.rb

@@ -0,0 +1,9 @@
+require "ajax_error_renderer/engine"
+
+module AjaxErrorRenderer
+  def render_ajax_error(location: '#error', model:)
+    @location = location
+    @model = model
+    render 'ajax_errors/error', formats: :js
+  end
+end

data/lib/ajax_error_renderer/engine.rb

@@ -0,0 +1,4 @@
+module AjaxErrorRenderer
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/ajax_error_renderer/version.rb

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

data/lib/generators/ajax_error_renderer/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate custom error template for AjaxErrorRenderer
+
+Example:
+    rails generate ajax_error_renderer:view
+
+    This will create:
+        app/views/ajax_errors/_error.html.erb

data/lib/generators/ajax_error_renderer/templates/error.html.erb

@@ -0,0 +1,9 @@
+<% if model.errors.any? %>
+  <div id="error_explanation" class="alert alert-danger">
+    <ul>
+      <% model.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+    </ul>
+  </div>
+<% end %>

data/lib/generators/ajax_error_renderer/view_generator.rb

@@ -0,0 +1,11 @@
+module AjaxErrorRenderer
+  class ViewGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_view_file
+      directory = Rails.root.join('app', 'views', 'ajax_errors').to_s
+      Dir.mkdir(directory) unless Dir.exist?(directory)
+      copy_file 'error.html.erb', File.join(directory, '_error.html.erb')
+    end
+  end
+end

data/lib/tasks/ajax_error_renderer_tasks.rake

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: ajax_error_renderer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- willnet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: validation error renderer for ajax request
+email:
+- netwillnet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/views/ajax_errors/_error.html.erb
+- app/views/ajax_errors/error.js.erb
+- lib/ajax_error_renderer.rb
+- lib/ajax_error_renderer/engine.rb
+- lib/ajax_error_renderer/version.rb
+- lib/generators/ajax_error_renderer/USAGE
+- lib/generators/ajax_error_renderer/templates/error.html.erb
+- lib/generators/ajax_error_renderer/view_generator.rb
+- lib/tasks/ajax_error_renderer_tasks.rake
+homepage: https://github.com/willnet/ajax_error_renderer
+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.7.6
+signing_key: 
+specification_version: 4
+summary: a friend with turbolinks and form_with
+test_files: []