From 8415a6c5cf883f7ce6fe93b80ec99072fb04be83 Mon Sep 17 00:00:00 2001 From: Dino Maric Date: Sat, 15 Dec 2018 13:41:23 +0100 Subject: Fix Rails generators 1.Don't generate ApplicationMailboxTest when executing installer 2. Hookup test_unit, so console doesn't throw errors --- lib/generators/rails/USAGE | 12 +++++++ lib/generators/rails/mailbox_generator.rb | 34 +++++++++++++++++++ .../rails/templates/application_mailbox.rb.tt | 5 +++ lib/generators/rails/templates/mailbox.rb.tt | 8 +++++ lib/generators/test_unit/mailbox_generator.rb | 20 ++++++++++++ .../test_unit/templates/mailbox_test.rb.tt | 13 ++++++++ lib/rails/generators/mailbox/USAGE | 12 ------- lib/rails/generators/mailbox/mailbox_generator.rb | 38 ---------------------- .../mailbox/templates/application_mailbox.rb.tt | 5 --- .../generators/mailbox/templates/mailbox.rb.tt | 8 ----- .../mailbox/templates/mailbox_test.rb.tt | 13 -------- lib/tasks/install.rake | 2 +- test/generators/mailbox_generator_test.rb | 15 +++------ 13 files changed, 97 insertions(+), 88 deletions(-) create mode 100644 lib/generators/rails/USAGE create mode 100644 lib/generators/rails/mailbox_generator.rb create mode 100644 lib/generators/rails/templates/application_mailbox.rb.tt create mode 100644 lib/generators/rails/templates/mailbox.rb.tt create mode 100644 lib/generators/test_unit/mailbox_generator.rb create mode 100644 lib/generators/test_unit/templates/mailbox_test.rb.tt delete mode 100644 lib/rails/generators/mailbox/USAGE delete mode 100644 lib/rails/generators/mailbox/mailbox_generator.rb delete mode 100644 lib/rails/generators/mailbox/templates/application_mailbox.rb.tt delete mode 100644 lib/rails/generators/mailbox/templates/mailbox.rb.tt delete mode 100644 lib/rails/generators/mailbox/templates/mailbox_test.rb.tt diff --git a/lib/generators/rails/USAGE b/lib/generators/rails/USAGE new file mode 100644 index 0000000000..d679dd63ae --- /dev/null +++ b/lib/generators/rails/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/generators/rails/mailbox_generator.rb b/lib/generators/rails/mailbox_generator.rb new file mode 100644 index 0000000000..7b43173480 --- /dev/null +++ b/lib/generators/rails/mailbox_generator.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +module Rails + module Generators + class MailboxGenerator < NamedBase + source_root File.expand_path("templates", __dir__) + + argument :actions, type: :array, default: [:process], banner: "method method" + + 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/generators/rails/templates/application_mailbox.rb.tt b/lib/generators/rails/templates/application_mailbox.rb.tt new file mode 100644 index 0000000000..be51eb3639 --- /dev/null +++ b/lib/generators/rails/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/generators/rails/templates/mailbox.rb.tt b/lib/generators/rails/templates/mailbox.rb.tt new file mode 100644 index 0000000000..9788bd9bb4 --- /dev/null +++ b/lib/generators/rails/templates/mailbox.rb.tt @@ -0,0 +1,8 @@ +# frozen_string_literal: true + +class <%= class_name %>Mailbox < ApplicationMailbox +<% actions.each do |action| -%> + def <%= action %> + end +<% end -%> +end diff --git a/lib/generators/test_unit/mailbox_generator.rb b/lib/generators/test_unit/mailbox_generator.rb new file mode 100644 index 0000000000..2ec7d11a2f --- /dev/null +++ b/lib/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/generators/test_unit/templates/mailbox_test.rb.tt b/lib/generators/test_unit/templates/mailbox_test.rb.tt new file mode 100644 index 0000000000..41749808e3 --- /dev/null +++ b/lib/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 diff --git a/lib/rails/generators/mailbox/USAGE b/lib/rails/generators/mailbox/USAGE deleted file mode 100644 index d679dd63ae..0000000000 --- a/lib/rails/generators/mailbox/USAGE +++ /dev/null @@ -1,12 +0,0 @@ -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 deleted file mode 100644 index 5511545a98..0000000000 --- a/lib/rails/generators/mailbox/mailbox_generator.rb +++ /dev/null @@ -1,38 +0,0 @@ -# frozen_string_literal: true - -module Rails - module Generators - class MailboxGenerator < NamedBase - source_root File.expand_path("templates", __dir__) - - argument :actions, type: :array, default: [:process], banner: "method method" - - def check_class_collision - class_collisions "#{class_name}Mailbox", "#{class_name}MailboxTest" - end - - 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 - - template "mailbox_test.rb", File.join('test/mailboxes', class_path, "#{file_name}_mailbox_test.rb") - 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 deleted file mode 100644 index be51eb3639..0000000000 --- a/lib/rails/generators/mailbox/templates/application_mailbox.rb.tt +++ /dev/null @@ -1,5 +0,0 @@ -# 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 deleted file mode 100644 index 9788bd9bb4..0000000000 --- a/lib/rails/generators/mailbox/templates/mailbox.rb.tt +++ /dev/null @@ -1,8 +0,0 @@ -# frozen_string_literal: true - -class <%= class_name %>Mailbox < ApplicationMailbox -<% actions.each do |action| -%> - def <%= action %> - end -<% end -%> -end diff --git a/lib/rails/generators/mailbox/templates/mailbox_test.rb.tt b/lib/rails/generators/mailbox/templates/mailbox_test.rb.tt deleted file mode 100644 index 41749808e3..0000000000 --- a/lib/rails/generators/mailbox/templates/mailbox_test.rb.tt +++ /dev/null @@ -1,13 +0,0 @@ -# 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 diff --git a/lib/tasks/install.rake b/lib/tasks/install.rake index 1f4c071494..598e30c2d4 100644 --- a/lib/tasks/install.rake +++ b/lib/tasks/install.rake @@ -8,7 +8,7 @@ namespace :action_mailbox do task install: %w[ environment run_generator copy_migrations ] task :run_generator do - system "#{RbConfig.ruby} ./bin/rails generate mailbox application" + system "#{RbConfig.ruby} ./bin/rails generate mailbox application --no-test-framework" end task :copy_migrations do diff --git a/test/generators/mailbox_generator_test.rb b/test/generators/mailbox_generator_test.rb index 9295c2d8c8..46f1dc6ea0 100644 --- a/test/generators/mailbox_generator_test.rb +++ b/test/generators/mailbox_generator_test.rb @@ -1,6 +1,7 @@ # frozen_string_literal: true + require "test_helper" -require "rails/generators/mailbox/mailbox_generator" +require "generators/rails/mailbox_generator" class MailboxGeneratorTest < Rails::Generators::TestCase destination File.expand_path("../../tmp", File.dirname(__FILE__)) @@ -33,7 +34,7 @@ class MailboxGeneratorTest < Rails::Generators::TestCase end def test_invokes_default_test_framework - run_generator %w(inbox foo bar) + run_generator %w(inbox foo bar -t=test_unit) assert_file "test/mailboxes/inbox_mailbox_test.rb" do |test| assert_match(/class InboxMailboxTest < ActionMailbox::TestCase/, test) assert_match(/# test "receive mail" do/, test) @@ -41,14 +42,6 @@ class MailboxGeneratorTest < Rails::Generators::TestCase end end - def test_check_test_class_collision - Object.send :const_set, :InboxMailboxTest, Class.new - content = capture(:stderr) { run_generator } - assert_match(/The name 'InboxMailboxTest' is either already used in your application or reserved/, content) - ensure - Object.send :remove_const, :InboxMailboxTest - end - def test_actions_are_turned_into_methods run_generator %w(inbox foo bar) @@ -66,7 +59,7 @@ class MailboxGeneratorTest < Rails::Generators::TestCase end def test_mailbox_suffix_is_not_duplicated - run_generator ["inbox_mailbox"] + run_generator %w(inbox_mailbox -t=test_unit) assert_no_file "app/mailboxes/inbox_mailbox_mailbox.rb" assert_file "app/mailboxes/inbox_mailbox.rb" -- cgit v1.2.3