auto_previews 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e58cc642265b751c8bf94fe3291e36427077120199649b622bd2525781a154c
+  data.tar.gz: 7fe02d77b9c2ac02647c47bb1322f9f3dbae1644ee2068b004d55a2d7ccdfd4b
+SHA512:
+  metadata.gz: 5b3c42fd3f5e1e486f8ef94508777507d73a610d8bd71c1138eeb8365f87879a548d07ff7bc7ce560d65a386c385652692a65bc34088ebbfe173fd28ce7e441d
+  data.tar.gz: 24c1bc6173bb4b0393414f5ddfd6c1d4eb2956225f7afdb8271516b44aae1fc10efeab597316c3740c5fd8bc2e62da6c4aa930337cd2f02ec3414ca4de3f99f5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Josh Brody
+
+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,111 @@
+# AutoPreviews
+
+I got tired of writing `ActionMailer::Preview` classes. So I let Ruby write it for me.
+
+## Usage
+
+In your mailer class, define some options:
+
+```ruby
+class PostMailer < ApplicationMailer
+  previews_for model: 'Post', # otherwise automatically infered based on class.name.delete_suffix('Mailer')
+               params: { post_id: :id },
+               only: [:created]
+
+  previews_for model: 'Post',
+               params: { post_id: :id },
+               only: [:deleted],
+               scope: :with_deleted,
+               using: :arguments
+
+  before_action only: [:created] do
+    @post = Post.find_by(id: params[:post_id])
+  end
+
+  def created
+    mail(to: "joshmn@example.com", subject: "Nice post #{@post.id}")
+  end
+
+  def deleted(post_id)
+    @post = Post.find_by(id: post_id)
+    mail(to: "joshmn@example.com", subject: "Deleted post #{@post.id}")
+  end
+end
+```
+
+In your previewer class, just call `auto_preview!`
+
+```ruby 
+class PostMailerPreview < ActionMailer::Preview 
+  auto_preview! 
+end 
+```
+
+`auto_preview!` will do some metaprogramming to create your mailer previews, like so:
+
+```ruby 
+  post = Post.first 
+  params_to_send_to_mailer = {}
+  params_given = { post_id: :id }
+  params_given.each do |mailer_key, model_method| 
+    params_to_send_to_mailer[mailer_key] = post.public_send(model_method) 
+  end   
+  PostMailer.with(params_to_send_to_mailer).created # or `*params_to_send_to_mailer.values` if `using: :arguments`
+```
+
+## Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_previews'
+```
+
+2. And then execute:
+```bash
+$ bundle
+```
+
+3. Restart your Rails server 
+ 
+4. Implement 
+
+5. Enjoy! 
+
+## Options
+
+By default, the `previews_for` will define mailer preview methods for `class.instance_methods(false)`.
+
+* `model`: the model you want to use for the record lookup; defaults to `self.class.name.delete_suffix('Mailer')`; if 
+`false` is passed, no model will be used
+* `params`: a hash of `mailer_method_name: :model_method_name`; used to map values to the mailer from the model 
+* `using`: the type of mailer to use; defaults to using `ActionMailer::Parameterized`
+* `only`: the methods to only use the given `previews_for` on; defaults to `[]`
+* `except`: the methods to not use the given `previews_for` on; defaults to `[]`
+* `scope`: scope to use on the model; defaults to `:all`
+
+## Usage without a model 
+
+Just pass `model: false` and define some sort of values to pass in the `params`:
+
+Passing a proc will `call`; passing a symbol will call the given method on the mailer preview class if it is defined, otherwise it will be sent to your mailer preview as the symbol.
+
+```ruby 
+class OneOffMailer < ApplicationMailer 
+  previews_for model: false,
+               params: {
+                 subject: -> :random_subject,
+                 body: -> { FFaker::CheesyLingo.paragraph },
+               },
+end 
+```
+
+## Roadmap 
+
+* More options
+* Better extensibility
+* Better record lookup 
+* Better serialization of mailer params 
+
+## 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,27 @@
+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    = 'AutoPreviews'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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/lib/auto_previews.rb

@@ -0,0 +1,5 @@
+require 'auto_previews/preview_extensions'
+require 'auto_previews/action_mailer_extensions'
+require "auto_previews/railtie"
+
+module AutoPreviews; end

data/lib/auto_previews/action_mailer_extensions.rb

@@ -0,0 +1,35 @@
+module AutoPreviews
+  module ActionMailerExtensions
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    module ClassMethods
+      # use an array so we can use only/except
+      def previews_for(options = {})
+        autopreview_configs << _normalized_previews_for_options(options)
+      end
+
+      def autopreview_configs
+        @_autopreview_configs ||= []
+      end
+
+      private
+
+      def _normalized_previews_for_options(options)
+        unless options[:model] === false
+          options[:model] ||= self.class.name.delete_suffix('Mailer')
+          if options[:model].is_a?(Class)
+            options[:model] = options[:model].to_s
+          end
+          options[:scope] ||= :all
+        end
+        options[:using] ||= :parameters
+        options
+      end
+    end
+
+  end
+end

data/lib/auto_previews/preview_extensions.rb

@@ -0,0 +1,83 @@
+module AutoPreviews
+  module PreviewExtensions
+    extend ActiveSupport::Concern
+
+    included do #
+      extend ClassMethods
+    end
+
+    module ClassMethods
+      def auto_preview!(klass = nil)
+        mailer_class = (klass || self.name.delete_suffix("Preview")).constantize
+        mailer_class.autopreview_configs.each do |autopreview_config|
+          methods_to_define = if autopreview_config[:except]
+                                mailer_class.instance_methods(false) - Array(autopreview_config[:except])
+                              elsif autopreview_config[:only]
+                                Array(autopreview_config[:only])
+                              else
+                                mailer_class.instance_methods(false)
+                              end
+          methods_to_define.each do |m|
+            model = setup_model(autopreview_config[:model])
+            scoped_collection = setup_scope(model, autopreview_config)
+            finder = record_finder(scoped_collection, autopreview_config)
+            record_proc, preview_params = finder[0], finder[1]
+            define_method(m) do
+              mailer_params = {}
+              record = record_proc.call
+              if record.nil?
+                raise ActiveRecord::RecordNotFound, "Cannot find a record. Should be a type of `#{model}`. Create one?"
+              end
+              preview_params.each do |k,v|
+                mailer_params[k] = record.public_send(v)
+              end
+              if autopreview_config[:using] == :arguments
+                mailer_class.public_send(m, *mailer_params.values)
+              else
+                mailer_class.with(mailer_params).public_send(m)
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def setup_model(model_class)
+        return false if model_class === false
+        model = model_class.safe_constantize || model_class.to_s.delete_suffix('MailerPreview').safe_constantize
+        if model.nil?
+          raise ArgumentError, "unable to infer model from `#{model_class}`."
+        end
+        model
+      end
+
+      def setup_scope(model, config)
+        return model if config[:model] === false
+        scope = config[:scope]
+        scoped_collection = model
+        if scope.is_a?(Proc)
+          scoped_collection = scoped_collection.call(scope)
+        elsif scope.is_a?(Symbol)
+          scoped_collection = scoped_collection.send(scope)
+        else
+          raise ArgumentError, "invalid scope for #{model} `#{scope.inspect}`"
+        end
+        scoped_collection
+      end
+
+      # I hate this. So hacky.
+      def record_finder(collection, config)
+        if config[:model] === false
+          struct = OpenStruct.new
+          config[:params].each do |k,v|
+            struct[k] = v
+            config[:params][k] = k
+          end
+          return [-> { struct }, config[:params]]
+        end
+        [-> { collection.first }, config[:params]]
+      end
+    end
+  end
+end

data/lib/auto_previews/railtie.rb

@@ -0,0 +1,8 @@
+module AutoPreviews
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load(:action_mailer) do
+      include ::AutoPreviews::ActionMailerExtensions
+      ::ActionMailer::Preview.include AutoPreviews::PreviewExtensions
+    end
+  end
+end

data/lib/auto_previews/version.rb

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

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: auto_previews
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically create mailer previews for your mailers.
+email:
+- git@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/auto_previews.rb
+- lib/auto_previews/action_mailer_extensions.rb
+- lib/auto_previews/preview_extensions.rb
+- lib/auto_previews/railtie.rb
+- lib/auto_previews/version.rb
+homepage: https://github.com/joshmn/auto_previews
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Automatically create mailer previews for your mailers.
+test_files: []