Merge pull request #515 from revans/inject-into-module

Inject into Modules

Author: rafaelfranca

lib/thor/actions/file_manipulation.rb

@@ -204,6 +204,29 @@ def inject_into_class(path, klass, *args, &block)
       insert_into_file(path, *(args << config), &block)
     end
 
+    # Injects text right after the module definition. Since it depends on
+    # insert_into_file, it's reversible.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # module_name<String|Class>:: the module to be manipulated
+    # data<String>:: the data to append to the class, can be also given as a block.
+    # config<Hash>:: give :verbose => false to not log the status.
+    #
+    # ==== Examples
+    #
+    #   inject_into_module "app/helpers/application_helper.rb", ApplicationHelper, "  def help; 'help'; end\n"
+    #
+    #   inject_into_module "app/helpers/application_helper.rb", ApplicationHelper do
+    #     "  def help; 'help'; end\n"
+    #   end
+    #
+    def inject_into_module(path, module_name, *args, &block)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      config.merge!(:after => /module #{module_name}\n|module #{module_name} .*\n/)
+      insert_into_file(path, *(args << config), &block)
+    end
+
     # Run a regular expression replacement on a file.
     #
     # ==== Parameters

spec/actions/file_manipulation_spec.rb

@@ -1,6 +1,7 @@
 require "helper"
 
 class Application; end
+module ApplicationHelper; end
 
 describe Thor::Actions do
   def runner(options = {})
@@ -340,6 +341,31 @@ def file
         expect(File.binread(file)).to eq("class Application < Base\nend\n")
       end
     end
+
+    describe "#inject_into_module" do
+      def file
+        File.join(destination_root, "application_helper.rb")
+      end
+
+      it "appends content to a module" do
+        action :inject_into_module, "application_helper.rb", ApplicationHelper, "  def help; 'help'; end\n"
+        expect(File.binread(file)).to eq("module ApplicationHelper\n  def help; 'help'; end\nend\n")
+      end
+
+      it "accepts a block" do
+        action(:inject_into_module, "application_helper.rb", ApplicationHelper) { "  def help; 'help'; end\n" }
+        expect(File.binread(file)).to eq("module ApplicationHelper\n  def help; 'help'; end\nend\n")
+      end
+
+      it "logs status" do
+        expect(action(:inject_into_module, "application_helper.rb", ApplicationHelper, "  def help; 'help'; end\n")).to eq("      insert  application_helper.rb\n")
+      end
+
+      it "does not append if class name does not match" do
+        action :inject_into_module, "application_helper.rb", "App", "  def help; 'help'; end\n"
+        expect(File.binread(file)).to eq("module ApplicationHelper\nend\n")
+      end
+    end
   end
 
   describe "when adjusting comments" do

spec/fixtures/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end