action_view_preview 0.1.1 → 0.1.4

checksums.yaml

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

data/README.md

@@ -1,7 +1,7 @@
 # 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.
+This gem allows a setup similar `ActionMailer::Preview`, 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:
@@ -21,6 +21,11 @@ $ gem install action_view_preview
 ```
 
 ## Usage
+### Command Line Install
+
+Run `rails generate action_view_preview:install` and the generator should create a `hello_preview.rb` and mount the route in your `routes.rb` file, similar to the steps shown below in the manual install.
+
+### Manual Install
 1. Mount the engine in your `routes.rb`:
 
 ```ruby

data/lib/action_view_preview/engine.rb

@@ -1,5 +1,32 @@
+# frozen_string_literal: true
+
+require "rails"
+
 module ActionViewPreview
   class Engine < ::Rails::Engine
     isolate_namespace ActionViewPreview
+
+    config.action_view_preview = ActionViewPreview
+    config.eager_load_namespaces << ActionViewPreview
+
+    initializer "action_view_preview.set_configs" do |app|
+      options = app.config.action_view_preview
+
+      options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/views/previews" : nil
+      
+      ActiveSupport.on_load(:action_view_preview) do
+        options.each { |k, v| ActionViewPreview.send("#{k}=", v) }
+      end
+    end
+
+    initializer "action_view_preview.set_autoload_paths" do |app|
+      options = app.config.action_view_preview
+
+      if options.preview_path
+        ActiveSupport::Dependencies.autoload_paths << options.preview_path
+      end
+    end
   end
 end
+
+require 'action_view_preview' if !defined?(ActionViewPreview::Base)

data/lib/action_view_preview/version.rb

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

data/lib/action_view_preview.rb

@@ -1,19 +1,16 @@
 require "action_view_preview/version"
-require "action_view_preview/engine"
+require "active_support/dependencies/autoload"
 
 module ActionViewPreview
   extend ::ActiveSupport::Autoload
   
   autoload :Base
 
-  mattr_accessor :preview_path
+  mattr_accessor :preview_path, instance_writer: false
 
   def self.setup
     yield self
   end
-
-  def self.preview_path
-    @@preview_path || "#{Rails.root}/test/views/previews"
-  end
- 
 end
+
+require "action_view_preview/engine" if defined?(Rails::Engine)

data/lib/generators/action_view_preview/action_view_preview_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class ActionViewPreviewGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  argument :name, type: :string, required: true, banner: 'NAME'
+  argument :actions, type: :array, default: [], banner: 'action action'
+
+  def execute
+    actions.map!(&:underscore)
+
+    template 'test/views/previews/%file_name%_preview.rb', "#{ActionViewPreview.preview_path}/%file_name%_preview.rb"
+  end
+end

data/lib/generators/action_view_preview/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module ActionViewPreview
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Mounts the action view preview module in routes'
+
+    def mount_engine
+      route 'mount ActionViewPreview::Engine => "/action_view_preview"'
+    end
+
+    def execute
+      generate 'action_view_preview Hello hello_world'
+    end
+  end
+end

data/lib/generators/action_view_preview/templates/test/views/previews/%file_name%_preview.rb.tt

@@ -0,0 +1,7 @@
+class <%= class_name %>ViewPreview < ActionViewPreview::Base
+<% actions.each do |action| -%>
+  def <%= action %>
+  end
+<%= "\n" unless action == actions.last -%>
+<% end -%>
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: action_view_preview
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Lucas Campanari
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2022-04-10 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
@@ -54,7 +54,9 @@ files:
 - 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
+- lib/generators/action_view_preview/action_view_preview_generator.rb
+- lib/generators/action_view_preview/install_generator.rb
+- lib/generators/action_view_preview/templates/test/views/previews/%file_name%_preview.rb.tt
 homepage: https://github.com/lcampanari/action_view_preview
 licenses:
 - MIT
@@ -77,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Views preview for Rails

data/lib/tasks/action_view_preview_tasks.rake

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