action_view_preview 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b26ca398ae2566c79af2805216f8d1756c3cf704d2f6198810c66786a46e1b
-  data.tar.gz: 9676ae4d9f8ff52fc0a3a91876b7053b8bf4de3a2d611b8996c887d39ac49971
+  metadata.gz: 991934b5896e195311fd6435e9191f3a2b2130f7424a6fcc21b2901e84506efd
+  data.tar.gz: 26084632cbb232d3c92ff7a0265c6f18e898ea36226493bd5cfe07f2ca1db258
 SHA512:
-  metadata.gz: 79c65bf5bd6cd0bc6afe2540200d12cffa38be1323f535ddff256ad8886c589a4a9e8cef5bd5dd8387034e902c294a6e9292d62021fa79231e691422604ce158
-  data.tar.gz: 78d952cae15d730ebc1cfc204514834505e44e61129a46ad935f25660da70632e80e2305ac4f47468f34deaf7f8417669f9d5f8bcc41da44823530d3112e6cbe
+  metadata.gz: aae377a8eb4fb126b73d302e026cbc3b3f04e9ffbb7147fdf105893863a3eed390bba72ba7938ed46e652cab5b83742351971ae0128469b988ae0adf46b45310
+  data.tar.gz: cda8a097e2f729e1f97880caf9f2fe31a28575ab1c3e14fbfe9cc14dc0a826679622b41ec50426a532beced33459bc8f4cc1758f750e7d94b6ed8f2ad7259e11

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.2'
+  VERSION = '0.1.5'
 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.2
+  version: 0.1.5
 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