Re: Subject: [PATCH] * lisp/progmodes/ruby-mode.el: Set `ruby-insert-encoding-magic-comment' to nil by default.

[Bozhidar Batsov <bozhidar@batsov.com>]

[-- Attachment #1.1: Type: text/plain, Size: 1470 bytes --]

Here's a patch for making the comment format customizable. How does it look
to you?


I'll send later another patch with the always-utf8 customization we
discussed.


On 4 November 2013 15:40, Bozhidar Batsov <bozhidar@batsov.com> wrote:

> OK. I'll implement the discussed customizations.
>
>
> On 3 November 2013 11:22, Dmitry Gutov <dgutov@yandex.ru> wrote:
>
>> Bozhidar Batsov <bozhidar@batsov.com> writes:
>>
>> > Sorry about the lack of clarity - I meant that if you have a Ruby 2.0
>> only project you likely don't
>> > want the insertion of utf-8 coding comments.
>> >
>> > ...
>> >
>> > Yeah, I'm aware of that. In my open source projects I still keep 1.9
>> compatibility and generally
>> > include those cookies in every file. Since I want them included
>> unconditionally (AFAIK many other
>> > Ruby programmers do this as well for the sake of consistency) the
>> magic-comment functionality in
>> > ruby-mode is quite useless to me even for Ruby 1.9.
>>
>> Now I get it, thanks for the explanation.
>>
>> > If we add the option to include the magic
>> > comment unconditionally that might increase the usefulness of the
>> > setting for some people.
>>
>> Sure, as long as it's not on by default. For example, add a new possible
>> value of `ruby-insert-encoding-magic-comment': `always'. Or `always-utf8'.
>>
>> In this case, `ruby-mode-set-encoding' might short-circuit the whole
>> encoding detection logic and just always write `coding: utf-8'.
>>
>
>

[-- Attachment #1.2: Type: text/html, Size: 2327 bytes --]

[-- Attachment #2: 0001-lisp-progmodes-ruby-mode.el-ruby-mode-set-encoding.patch --]
[-- Type: application/octet-stream, Size: 1641 bytes --]

From 3202624bb533968cc1bdd7b4a8c8669a9fc4f967 Mon Sep 17 00:00:00 2001
From: Bozhidar Batsov <bozhidar@batsov.com>
Date: Wed, 6 Nov 2013 19:04:34 +0200
Subject: [PATCH] * lisp/progmodes/ruby-mode.el (ruby-mode-set-encoding):  
 Make encoding comment format customizable via
 `ruby-encoding-magic-comment-template'.

---
 lisp/progmodes/ruby-mode.el | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/lisp/progmodes/ruby-mode.el b/lisp/progmodes/ruby-mode.el
index 253a600..01989f5 100644
--- a/lisp/progmodes/ruby-mode.el
+++ b/lisp/progmodes/ruby-mode.el
@@ -261,6 +261,10 @@ explicitly declared in magic comment."
   "Insert a magic Emacs 'coding' comment upon save if this is non-nil."
   :type 'boolean :group 'ruby)
 
+(defcustom ruby-encoding-magic-comment-template " -*- coding: %s -*-"
+  "An encoding comment template in which the actual encoding will be inserted."
+  :type 'string :group 'ruby)
+
 (defcustom ruby-use-encoding-map t
   "Use `ruby-encoding-map' to set encoding magic comment if this is non-nil."
   :type 'boolean :group 'ruby)
@@ -621,7 +625,10 @@ explicitly declared in magic comment."
                    (insert coding-system)))
                 ((looking-at "\\s *#.*coding\\s *[:=]"))
                 (t (when ruby-insert-encoding-magic-comment
-                     (insert "# -*- coding: " coding-system " -*-\n"))))
+                     (insert
+                      "#"
+                      (format ruby-encoding-magic-comment-template coding-system)
+                      "\n"))))
           (when (buffer-modified-p)
             (basic-save-buffer-1)))))))
 
-- 
1.8.4