From 7cf7ba4db535ea45e70e844cb653909be6143fd5 Mon Sep 17 00:00:00 2001 From: Kasper Timm Hansen Date: Tue, 18 Dec 2018 22:03:23 +0100 Subject: Refit generator file structure to match Action Cable. Fits with rails/generators/channel containing: - channel_generator.rb - templates/ - USAGE --- lib/rails/generators/mailbox/USAGE | 12 ++++++++ lib/rails/generators/mailbox/mailbox_generator.rb | 32 ++++++++++++++++++++++ .../mailbox/templates/application_mailbox.rb.tt | 5 ++++ .../generators/mailbox/templates/mailbox.rb.tt | 6 ++++ .../generators/test_unit/mailbox_generator.rb | 20 ++++++++++++++ .../test_unit/templates/mailbox_test.rb.tt | 13 +++++++++ 6 files changed, 88 insertions(+) create mode 100644 lib/rails/generators/mailbox/USAGE create mode 100644 lib/rails/generators/mailbox/mailbox_generator.rb create mode 100644 lib/rails/generators/mailbox/templates/application_mailbox.rb.tt create mode 100644 lib/rails/generators/mailbox/templates/mailbox.rb.tt create mode 100644 lib/rails/generators/test_unit/mailbox_generator.rb create mode 100644 lib/rails/generators/test_unit/templates/mailbox_test.rb.tt (limited to 'lib/rails') diff --git a/lib/rails/generators/mailbox/USAGE b/lib/rails/generators/mailbox/USAGE new file mode 100644 index 0000000000..d679dd63ae --- /dev/null +++ b/lib/rails/generators/mailbox/USAGE @@ -0,0 +1,12 @@ +Description: +============ + Stubs out a new mailbox class in app/mailboxes and invokes your template + engine and test framework generators. + +Example: +======== + rails generate mailbox inbox + + creates a InboxMailbox class and test: + Mailbox: app/mailboxes/inbox_mailbox.rb + Test: test/mailboxes/inbox_mailbox_test.rb diff --git a/lib/rails/generators/mailbox/mailbox_generator.rb b/lib/rails/generators/mailbox/mailbox_generator.rb new file mode 100644 index 0000000000..c2c403b8f6 --- /dev/null +++ b/lib/rails/generators/mailbox/mailbox_generator.rb @@ -0,0 +1,32 @@ +# frozen_string_literal: true + +module Rails + module Generators + class MailboxGenerator < NamedBase + source_root File.expand_path("templates", __dir__) + + check_class_collision suffix: "Mailbox" + + def create_mailbox_file + template "mailbox.rb", File.join("app/mailboxes", class_path, "#{file_name}_mailbox.rb") + + in_root do + if behavior == :invoke && !File.exist?(application_mailbox_file_name) + template "application_mailbox.rb", application_mailbox_file_name + end + end + end + + hook_for :test_framework + + private + def file_name # :doc: + @_file_name ||= super.sub(/_mailbox\z/i, "") + end + + def application_mailbox_file_name + "app/mailboxes/application_mailbox.rb" + end + end + end +end diff --git a/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt b/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt new file mode 100644 index 0000000000..be51eb3639 --- /dev/null +++ b/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt @@ -0,0 +1,5 @@ +# frozen_string_literal: true + +class ApplicationMailbox < ActionMailbox::Base + # routing /something/i => :somewhere +end diff --git a/lib/rails/generators/mailbox/templates/mailbox.rb.tt b/lib/rails/generators/mailbox/templates/mailbox.rb.tt new file mode 100644 index 0000000000..56b138e2d9 --- /dev/null +++ b/lib/rails/generators/mailbox/templates/mailbox.rb.tt @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +class <%= class_name %>Mailbox < ApplicationMailbox + def process + end +end diff --git a/lib/rails/generators/test_unit/mailbox_generator.rb b/lib/rails/generators/test_unit/mailbox_generator.rb new file mode 100644 index 0000000000..2ec7d11a2f --- /dev/null +++ b/lib/rails/generators/test_unit/mailbox_generator.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module TestUnit + module Generators + class MailboxGenerator < ::Rails::Generators::NamedBase + source_root File.expand_path("templates", __dir__) + + check_class_collision suffix: "MailboxTest" + + def create_test_files + template "mailbox_test.rb", File.join("test/mailboxes", class_path, "#{file_name}_mailbox_test.rb") + end + + private + def file_name # :doc: + @_file_name ||= super.sub(/_mailbox\z/i, "") + end + end + end +end diff --git a/lib/rails/generators/test_unit/templates/mailbox_test.rb.tt b/lib/rails/generators/test_unit/templates/mailbox_test.rb.tt new file mode 100644 index 0000000000..41749808e3 --- /dev/null +++ b/lib/rails/generators/test_unit/templates/mailbox_test.rb.tt @@ -0,0 +1,13 @@ +# frozen_string_literal: true + +require "test_helper" + +class <%= class_name %>MailboxTest < ActionMailbox::TestCase + # test "receive mail" do + # receive_inbound_email_from_mail \ + # to: '"someone" , + # from: '"else" ', + # subject: "Hello world!", + # body: "Hello?" + # end +end -- cgit v1.2.3