action_view_preview 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 143b01a8f2f804443f8b5a6894acab8f0a077bd6465a2bfb2a0e13440af553b9
+  data.tar.gz: 902199c1a8f455d4cdb10655f3e812f315d4861f60b9c14a8efd8d697b5382d9
+SHA512:
+  metadata.gz: d527e086a7835cd02fe3d1fb0f97f96b340f3f392be4271cd6ddddd83854729a43f605f7f8a1999f79f99a118f0095e3e43391abf9208547f7298913d4b428ee
+  data.tar.gz: a105ad9734d535800ea73e028ff1eb23b44708cff75e5624b06c442bd5430b3d4d0e0f19dc60997f48663211e77421a79dbe7a419c6d8d1821f38a250074d31c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Lucas Campanari
+
+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,62 @@
+# ActionViewPreview
+Sometimes being able to preview a view might come in handy, like when a view is going to be used only inside a PDF, for example.
+
+This gem allows a setup similar `ActionMailer::Base`, and provides a development tool for rendering and debugging views that wouldn't otherwise be rendered in your application.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_view_preview'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install action_view_preview
+```
+
+## Usage
+1. Mount the engine in your `routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  # Add the line below
+  mount ActionViewPreview::Engine => "/action_view_preview"
+end
+```
+
+2. Create files `*_preview.rb` on `test/views/previews/`, e.g. `hello_preview.rb`:
+
+```ruby
+class HelloViewPreview < ActionViewPreview::Base
+  def hello
+    '<b>Hello world</b>'
+  end
+end
+```
+
+3. Access the route `/action_view_preview` to see the available previews
+
+## Configuration
+
+Add a `ActionViewPreview.setup` block to an initializer. For example, if you want to place the preview files in `lib/view_previews`:
+
+```ruby
+ActionViewPreview.setup do |config|
+  config.preview_path = "#{Rails.root}/lib/view_previews"
+end
+```
+
+Possible config values:
+
+| Config | Default | Description |
+| - | - | - |
+| `preview_path` | `test/views/previews` | Path to the preview files |
+
+## 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,18 @@
+require "bundler/setup"
+
+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/action_view_preview_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/action_view_preview .css

data/app/assets/stylesheets/action_view_preview/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/assets/stylesheets/action_view_preview/preview.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/action_view_preview/application_controller.rb

@@ -0,0 +1,4 @@
+module ActionViewPreview
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/action_view_preview/preview_controller.rb

@@ -0,0 +1,50 @@
+require_dependency "action_view_preview/application_controller"
+
+module ActionViewPreview
+  class PreviewController < ApplicationController
+    before_action :find_preview, only: :show
+
+    def index
+      @previews = ActionViewPreview::Base.all
+      @page_title = "View Previews"
+    end
+
+    def show
+      preview
+    end
+
+    
+    private
+
+    def preview
+      if params[:path] == @preview.preview_name
+        @page_title = "View Previews for #{@preview.preview_name}"
+        render action: "view"
+      else
+        @view_action = File.basename(params[:path])
+  
+        if @preview.view_exists?(@view_action)
+          @page_title = "View Preview for #{@preview.preview_name}##{@view_action}"
+          @view = @preview.call(@view_action, params)
+          render action: "show", layout: false, formats: [:html]
+        else
+          # raise AbstractController::ActionNotFound, "View '#{@view_action}' not found in #{@preview.name}"
+          raise "View '#{@view_action}' not found in #{@preview.name}"
+        end
+      end
+    end
+
+    def find_preview
+      candidates = []
+      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+      preview = candidates.detect { |candidate| ActionViewPreview::Base.exists?(candidate) }
+
+      if preview
+        @preview = ActionViewPreview::Base.find(preview)
+      else
+        # raise AbstractController::ActionNotFound, "View preview '#{params[:path]}' not found"
+        raise "View preview '#{params[:path]}' not found"
+      end
+    end
+  end
+end

data/app/helpers/action_view_preview/application_helper.rb

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

data/app/helpers/action_view_preview/preview_helper.rb

@@ -0,0 +1,4 @@
+module ActionViewPreview
+  module PreviewHelper
+  end
+end

data/app/jobs/action_view_preview/application_job.rb

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

data/app/mailers/action_view_preview/application_mailer.rb

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

data/app/models/action_view_preview/application_record.rb

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

data/app/views/action_view_preview/preview/index.html.erb

@@ -0,0 +1,8 @@
+<% @previews.each do |preview| %>
+  <h3><%= link_to preview.preview_name.titleize, url_for(controller: "preview", action: "show", path: preview.preview_name) %></h3>
+  <ul>
+    <% preview.views.each do |view| %>
+      <li><%= link_to view, url_for(controller: "preview", action: "show", path: "#{preview.preview_name}/#{view}") %></li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/action_view_preview/preview/show.html.erb

@@ -0,0 +1 @@
+<%= @view.html_safe %>

data/app/views/action_view_preview/preview/view.html.erb

@@ -0,0 +1,6 @@
+<h3><%= @preview.preview_name.titleize %></h3>
+<ul>
+  <% @preview.views.each do |view| %>
+    <li><%= link_to view, url_for(controller: "preview", action: "show", path: "#{@preview.preview_name}/#{view}") %></li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Action view preview</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+ActionViewPreview::Engine.routes.draw do
+  get '/'      => 'preview#index', as: :preview_index, internal: true
+  get '/*path' => 'preview#show',  as: :preview_show, internal: true
+end

data/lib/action_view_preview/base.rb

@@ -0,0 +1,62 @@
+module ActionViewPreview
+  class Base
+    extend ActiveSupport::DescendantsTracker
+
+    attr_reader :params
+
+    def initialize(params = {})
+      @params = params
+    end
+
+    class << self
+
+      def call(view_action, params = {})
+        preview = new(params)
+        preview.public_send(view_action)
+      end
+
+      # Returns all preview classes
+      def all
+        load_previews if descendants.empty?
+        descendants
+      end
+
+      # Returns all of the available views
+      def views
+        public_instance_methods(false).map(&:to_s).sort
+      end
+
+      # Returns +true+ if the view exists.
+      def view_exists?(view)
+        views.include?(view)
+      end
+
+      # Returns the underscored name of the preview without the suffix
+      def preview_name
+        name.delete_suffix("Preview").underscore
+      end
+
+       # Find a preview by its underscored class name
+       def find(preview)
+        all.find { |p| p.preview_name == preview }
+      end
+
+      # Returns +true+ if the preview exists
+      def exists?(preview)
+        all.any? { |p| p.preview_name == preview }
+      end
+
+      private
+
+      def load_previews
+        if preview_path
+          Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
+        end
+      end
+
+      def preview_path
+        ActionViewPreview.preview_path
+      end
+    end
+  end
+end

data/lib/action_view_preview/engine.rb

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

data/lib/action_view_preview/version.rb

@@ -0,0 +1,3 @@
+module ActionViewPreview
+  VERSION = '0.1.1'
+end

data/lib/action_view_preview.rb

@@ -0,0 +1,19 @@
+require "action_view_preview/version"
+require "action_view_preview/engine"
+
+module ActionViewPreview
+  extend ::ActiveSupport::Autoload
+  
+  autoload :Base
+
+  mattr_accessor :preview_path
+
+  def self.setup
+    yield self
+  end
+
+  def self.preview_path
+    @@preview_path || "#{Rails.root}/test/views/previews"
+  end
+ 
+end

data/lib/tasks/action_view_preview_tasks.rake

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: action_view_preview
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lucas Campanari
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A development tool for rendering and debugging views that wouldn't otherwise
+  be rendered in your application
+email:
+- campanari.ls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/action_view_preview_manifest.js
+- app/assets/stylesheets/action_view_preview/application.css
+- app/assets/stylesheets/action_view_preview/preview.css
+- app/controllers/action_view_preview/application_controller.rb
+- app/controllers/action_view_preview/preview_controller.rb
+- app/helpers/action_view_preview/application_helper.rb
+- app/helpers/action_view_preview/preview_helper.rb
+- app/jobs/action_view_preview/application_job.rb
+- app/mailers/action_view_preview/application_mailer.rb
+- app/models/action_view_preview/application_record.rb
+- app/views/action_view_preview/preview/index.html.erb
+- app/views/action_view_preview/preview/show.html.erb
+- app/views/action_view_preview/preview/view.html.erb
+- app/views/layouts/action_view_preview/application.html.erb
+- config/routes.rb
+- lib/action_view_preview.rb
+- lib/action_view_preview/base.rb
+- lib/action_view_preview/engine.rb
+- lib/action_view_preview/version.rb
+- lib/tasks/action_view_preview_tasks.rake
+homepage: https://github.com/lcampanari/action_view_preview
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lcampanari/action_view_preview
+  source_code_uri: https://github.com/lcampanari/action_view_preview
+  changelog_uri: https://github.com/lcampanari/action_view_preview
+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: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Views preview for Rails
+test_files: []