This repository has been archived by the owner on Sep 4, 2021. It is now read-only.
forked from tomtt/emacs-rails
/
rails.el
537 lines (459 loc) · 19.8 KB
/
rails.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
;;; rails.el --- minor mode for editing RubyOnRails code
;; Copyright (C) 2006 Dmitry Galinsky <dima dot exe at gmail dot com>
;; Authors: Dmitry Galinsky <dima dot exe at gmail dot com>,
;; Rezikov Peter <crazypit13 (at) gmail.com>
;; Keywords: ruby rails languages oop
;; $URL$
;; $Id$
;;; License
;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License
;; as published by the Free Software Foundation; either version 2
;; of the License, or (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program; if not, write to the Free Software
;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
;;; Code:
(unless (<= 23 emacs-major-version)
(error
(format "emacs-rails requires Emacs 24 or newer, and may not work with this Emacs %s.%s"
emacs-major-version
emacs-minor-version)))
(eval-when-compile
(require 'speedbar)
(require 'inf-ruby)
(require 'ruby-mode))
(require 'grep)
(require 'sql)
(require 'ansi-color)
(require 'etags)
(require 'inflections)
(require 'rails-project)
;;;;;;;;; Defining custom group before loading other file
(defgroup rails nil
"Edit Rails projet with Emacs."
:group 'programming
:prefix "rails-")
;;;;;;;;; Loading most of the mode
(require 'rails-lib)
(require 'rails-core)
(require 'rails-ruby)
(require 'rails-cmd-proxy)
(require 'rails-navigation)
(require 'rails-find)
(require 'rails-scripts)
(require 'rails-rake)
(require 'rails-test)
(require 'rails-ws)
(require 'rails-log)
(require 'rails-ui)
(require 'rails-model-layout)
(require 'rails-controller-layout)
(require 'rails-features)
(require 'rails-lib-layout)
(require 'rails-spec)
(require 'rails-shoulda)
(require 'rails-refactoring)
;;;;;;;;;; Variable definition ;;;;;;;;;;
(defcustom rails-api-root ""
"*Root of Rails API html documentation. Must be a local directory."
:group 'rails
:type 'string)
(defcustom rails-use-alternative-browse-url nil
"Indicates an alternative way of loading URLs on Windows.
Try using the normal method before. If URLs invoked by the
program don't end up in the right place, set this option to
true."
:group 'rails
:type 'boolean)
(defcustom rails-browse-api-with-w3m nil
"Indicates that the user wants to browse the Rails API using
Emacs w3m browser."
:group 'rails
:type 'boolean)
(defcustom rails-tags-command "ctags -e -a --Ruby-kinds=-f -o %s -R %s"
"Command used to generate TAGS in Rails root"
:group 'rails
:type 'string)
(defcustom rails-ri-command "ri"
"Command used to invoke the ri utility."
:group 'rails
:type 'string)
(defcustom rails-always-use-text-menus nil
"Force the use of text menus by default."
:group 'rails
:type 'boolean)
(defcustom rails-text-menu-function nil
"Which function to use to create text menus. nil means #'rails-core:ttm-menu"
:group 'rails
:type 'string)
(defcustom rails-ask-when-reload-tags nil
"Indicates whether the user should confirm reload a TAGS table or not."
:group 'rails
:type 'boolean)
(defcustom rails-ruby-command "ruby"
"Ruby preferred command line invocation."
:group 'rails
:type 'string)
(defcustom rails-layout-template
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
<html xmlns=\"http://www.w3.org/1999/xhtml\"
xml:lang=\"en\" lang=\"en\">
<head>
<title></title>
<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
<%= stylesheet_link_tag \"default\" %>
</head>
<body>
<%= yield %>
</body>
</html>"
"Default html template for new rails layout"
:group 'rails
:type 'string)
(defcustom rails-number-of-lines-shown-when-opening-log-file 130
"Specifies how many lines to show initially when opening a log file"
:group 'rails
:type 'integer)
(defvar rails-version "0.5.99.6")
(defvar rails-primary-switch-func nil)
(defvar rails-secondary-switch-func nil)
(defvar rails-required-lisp-eval-depth 1000) ; Specifies the minimum required value of max-lisp-eval-depth for rails mode to work
(defvar rails-directory<-->types
'((:controller "app/controllers/")
(:layout "app/views/layouts/")
(:view "app/views/")
(:observer "app/models/" (lambda (file) (rails-core:observer-p file)))
(:mailer "app/models/" (lambda (file) (rails-core:mailer-p file)))
(:model "app/models/" (lambda (file) (and (not (rails-core:mailer-p file))
(not (rails-core:observer-p file)))))
(:helper "app/helpers/")
(:unit-test "vendor/plugins/.*/test/") ; needs to appear before more-general :plugin
(:model "vendor/plugins/.*/lib/") ; needs to appear before more-general :plugin
(:plugin "vendor/plugins/")
(:unit-test "test/unit/")
(:functional-test "test/functional/")
(:integration-test "test/integration/")
(:fixture "test/fixtures/")
(:lib "lib")
(:rspec-controller "spec/controllers")
(:rspec-controller "spec/requests")
(:rspec-fixture "spec/fixtures")
(:rspec-lib "spec/lib")
(:rspec-model "spec/models")
(:migration "db/migrate"))
"Rails file types -- rails directories map")
(defcustom rails-environments '("development" "production" "test")
"rails environments"
:group 'rails
:type '(repeat string))
(defcustom rails-default-environment (first rails-environments)
"rails environment used by default"
:group 'rails
:type 'string)
(defvar rails-adapters-alist
'(("mysql" . sql-mysql)
("mysql2" . sql-mysql)
("postgresql" . sql-postgres)
("sqlite3" . sql-sqlite))
"Sets emacs sql function for rails adapter names.")
(defcustom rails-tags-dirs '("app" "lib" "test" "db")
"List of directories from RAILS_ROOT where ctags works."
:group 'rails
:type '(repeat string))
(defcustom rails-grep-extensions '("builder" "erb" "haml" "liquid" "mab" "rake" "rb" "rhtml" "rjs" "rxml" "yml" "feature" "js" "html" "rtex" "prawn" "coffee" "less" "scss" "rabl" "json_builder" "jbuilder" "slim")
"List of file extensions which grep searches."
:group 'rails
:type '(repeat string))
(defcustom rails-templates-list
'("html.erb" "erb" "js.rjs" "rjs" "xml.builder" "builder" "rhtml" "rxml" "html.haml" "haml" "html.liquid" "liquid" "html.mad" "mab" "pdf.rtex" "rtex" "pdf.prawn" "prawn" "rabl" "json_builder" "json.jbuilder" "html.slim" "slim")
"List of view templates. This first template is the default template."
:group 'rails
:type '(repeat string))
(defvar rails-error-regexp-alist
'(
(" /?\\(app/[a-z0-9._/]*\\):\\([0-9]+\\)" 1 2)
(" /?\\(lib/[a-z0-9._/]*\\):\\([0-9]+\\)" 1 2)
(" /?\\(test/[a-z0-9._/]*\\):\\([0-9]+\\)" 1 2)
(" /?\\(db/[a-z0-9._/]*\\):\\([0-9]+\\)" 1 2)
(" /?\\(vendor/[a-z0-9._/]*\\):\\([0-9]+\\)" 1 2)
(" /?\\(app/[a-z0-9._/]*\\)" 1)
(" /?\\(lib/[a-z0-9._/]*\\)" 1)
(" /?\\(test/[a-z0-9._/]*\\)" 1)
(" /?\\(db/[a-z0-9._/]*\\)" 1)
(" /?\\(vendor/[a-z0-9._/]*\\)" 1)
)
"Rails specific compilation-error-regexp-alist.")
(defun rails-use-text-menu ()
"If t use text menu, popup menu otherwise"
(or (null window-system) rails-always-use-text-menus))
;;;;;;;; hack ;;;;
(defun rails-svn-status-into-root ()
(interactive)
(rails-project:with-root (root)
(svn-status root)))
(defun rails-git-status-into-root ()
(interactive)
(rails-project:with-root (root)
(git-status root)))
(defun rails-scm-status-into-root ()
(interactive)
(rails-project:with-root (root)
(cond ((file-directory-p (expand-file-name ".git" root))
(rails-git-status-into-root))
((file-directory-p (expand-file-name ".svn" root))
(rails-svn-status-into-root)))))
;; helper functions/macros
(defun backward-ruby-object ()
(if (looking-back "[-a-zA-Z_#:*]+" (line-beginning-position) t)
(goto-char (match-beginning 0))))
(defun forward-ruby-object (n)
(if (> 0 n)
(when (search-backward-regexp "[^-a-zA-Z_#:*][-a-zA-Z_#:*]+" nil t (- n))
(forward-char)
(point))
(when (search-forward-regexp "[-a-zA-Z_#:*]+" nil t n)
(goto-char (match-end 0)))))
(defun rails-search-doc (&optional item)
(interactive)
(setq item (if item item (thing-at-point 'ruby-object)))
(unless item
(setq item (read-string "Search symbol: ")))
(if item
(with-current-buffer (get-buffer-create "*ri*")
(setq buffer-read-only nil)
(erase-buffer)
(message (concat "Please wait..."))
(call-process rails-ri-command nil "*ri*" t "-T" "-f" "ansi" item)
(ansi-color-apply-on-region (point-min) (point-max))
(setq buffer-read-only t)
(goto-char (point-min))
(local-set-key "q" 'quit-window)
(display-buffer (current-buffer)))))
(defun rails-create-tags()
"Create tags file"
(interactive)
(rails-project:in-root
(message "Creating TAGS, please wait...")
(let ((tags-file-name (rails-core:file "TAGS")))
(shell-command
(format rails-tags-command tags-file-name
(strings-join " " (mapcar #'rails-core:file rails-tags-dirs))))
(flet ((yes-or-no-p (p) (if rails-ask-when-reload-tags
(y-or-n-p p)
t)))
(visit-tags-table tags-file-name)))))
(defun rails-apply-for-buffer-type ()
(let* ((type (rails-core:buffer-type))
(name (substring (symbol-name type) 1))
(minor-mode-name (format "rails-%s-minor-mode" name)))
(when (require (intern minor-mode-name) nil t) ;; load new style minor mode rails-*-minor-mode
(when (fboundp (intern minor-mode-name))
(apply (intern minor-mode-name) (list t))))))
(defun rails-grep-project (regexp)
"Find regexp in project."
(interactive (progn (grep-compute-defaults)
(list (grep-read-regexp))))
(rgrep regexp (mapconcat (lambda (ext) (format "*.%s" ext)) rails-grep-extensions " ") (rails-project:root)))
(defun rails-shell ()
"Switch to the project inferior shell buffer."
(interactive)
(let ((default-directory (rails-project:root)))
(shell (get-buffer-create (concat "*rails-" (rails-project:name) "-shell*")))))
;;;;;;;;;; Database integration ;;;;;;;;;;
(defstruct rails-db-conf adapter host database username password)
(defun rails-db-parameters (env)
"Return database parameters for enviroment ENV"
(with-temp-buffer
(shell-command
(format "ruby -r yaml -r erb -e 'YAML.load(ERB.new(ARGF.read).result)[\"%s\"].to_yaml.display' %s"
env
(rails-core:file "config/database.yml"))
(current-buffer))
(let ((answer
(make-rails-db-conf
:adapter (yml-value "adapter")
:host (yml-value "host")
:database (yml-value "database")
:username (yml-value "username")
:password (yml-value "password"))))
answer)))
(defun rails-database-emacs-func (adapter)
"Return the Emacs function for ADAPTER that, when run, will
+invoke the appropriate database server console."
(cdr (assoc adapter rails-adapters-alist)))
(defun rails-read-enviroment-name (&optional default)
"Read Rails enviroment with auto-completion."
(completing-read "Environment name: " (list->alist rails-environments) nil nil default))
(defun* rails-run-sql (&optional env)
"Run a SQL process for the current Rails project."
(interactive (list (rails-read-enviroment-name "development")))
(rails-project:with-root (root)
(cd root)
(if (bufferp (sql-find-sqli-buffer))
(switch-to-buffer-other-window (sql-find-sqli-buffer))
(let ((conf (rails-db-parameters env)))
(let ((sql-database (rails-db-conf-database conf))
(default-process-coding-system '(utf-8 . utf-8))
(sql-server (rails-db-conf-host conf))
(sql-user (rails-db-conf-username conf))
(sql-password (rails-db-conf-password conf)))
;; Reload localy sql-get-login to avoid asking of confirmation of DB login parameters
(flet ((sql-get-login (&rest pars) () t))
(funcall (rails-database-emacs-func (rails-db-conf-adapter conf)))))))))
(defun rails-has-api-root ()
"Test whether `rails-api-root' is configured or not, and offer to configure
it in case it's still empty for the project."
(rails-project:with-root
(root)
(if (file-exists-p (rails-core:file (concat rails-api-root "/index.html")))
t
(unless (or (file-exists-p (rails-core:file "doc/api/index.html"))
(not (yes-or-no-p (concat "This project has no API documentation. "
"Would you like to configure it now? "))))
(let (clobber-gems)
(message "This may take a while. Please wait...")
(unless (file-exists-p (rails-core:file "vendor/rails"))
(setq clobber-gems t)
(message "Freezing gems...")
(shell-command-to-string "rake rails:freeze:gems"))
;; Hack to allow generation of the documentation for Rails 1.0 and 1.1
;; See http://dev.rubyonrails.org/ticket/4459
(unless (file-exists-p (rails-core:file "vendor/rails/activesupport/README"))
(write-string-to-file (rails-core:file "vendor/rails/activesupport/README")
"Placeholder"))
(message "Generating documentation...")
(shell-command-to-string "rake doc:rails")
(if clobber-gems
(progn
(message "Unfreezing gems...")
(shell-command-to-string "rake rails:unfreeze")))
(message "Done...")))
(if (file-exists-p (rails-core:file "doc/api/index.html"))
(setq rails-api-root (rails-core:file "doc/api"))))))
(defun rails-browse-api ()
"Browse Rails API on RAILS-API-ROOT."
(interactive)
(if (rails-has-api-root)
(rails-browse-api-url (concat rails-api-root "/index.html"))
(message "Please configure variable rails-api-root.")))
(defun rails-get-api-entries (name file sexp get-file-func)
"Return all API entries named NAME in file FILE using SEXP to
find matches, and GET-FILE-FUNC to process the matches found."
(if (file-exists-p (concat rails-api-root "/" file))
(save-current-buffer
(save-match-data
(find-file (concat rails-api-root "/" file))
(let* ((result
(loop for line in (split-string (buffer-string) "\n")
when (string-match (format sexp (regexp-quote name)) line)
collect (cons (match-string-no-properties 2 line)
(match-string-no-properties 1 line)))))
(kill-buffer (current-buffer))
(when-bind (api-file (funcall get-file-func result))
(rails-browse-api-url (concat "file://" rails-api-root "/" api-file))))))
(message "There are no API docs.")))
(defun rails-browse-api-class (class)
"Browse the Rails API documentation for CLASS."
(rails-get-api-entries
class "fr_class_index.html" "<a href=\"\\(.*\\)\">%s<"
(lambda (entries)
(cond ((= 0 (length entries)) (progn (message "No API Rails doc for class %s." class) nil))
((= 1 (length entries)) (cdar entries))))))
(defun rails-browse-api-method (method)
"Browse the Rails API documentation for METHOD."
(rails-get-api-entries
method "fr_method_index.html" "<a href=\"\\(.*\\)\">%s[ ]+(\\(.*\\))"
(lambda (entries)
(cond ((= 0 (length entries)) (progn (message "No API Rails doc for %s" method) nil))
((= 1 (length entries)) (cdar entries))
(t (cdr (assoc (completing-read (format "Method %s from what class? " method) entries)
entries)))))))
(defun rails-browse-api-at-point ()
"Open the Rails API documentation on the class or method at the current point.
The variable `rails-api-root' must be pointing to a local path
either in your project or elsewhere in the filesystem. The
function will also offer to build the documentation locally if
necessary."
(interactive)
(if (rails-has-api-root)
(let ((current-symbol (prog2
(modify-syntax-entry ?: "w")
(thing-at-point 'sexp)
(modify-syntax-entry ?: "."))))
(if current-symbol
(if (capital-word-p current-symbol)
(rails-browse-api-class current-symbol)
(rails-browse-api-method current-symbol))))
(message "Please configure \"rails-api-root\".")))
;;; Rails minor mode
(define-minor-mode rails-minor-mode
"RubyOnRails"
nil
" RoR"
rails-minor-mode-map
(make-local-variable 'tags-file-name)
(make-local-variable 'rails-primary-switch-func)
(make-local-variable 'rails-secondary-switch-func)
(set (make-local-variable 'compile-command) "rake")
(set (make-local-variable 'ffip-project-root) (rails-project:root))
(set (make-local-variable 'ffip-regexp)
(concat ".*\\(" (rails-core:regex-for-match-view)
"\\|" (mapconcat #'car rails-auto-mode-alist "\\|")
"\\|" (mapconcat (lambda (ext) (concat "\\." ext "$")) rails-refactoring-source-extensions "\\|")
"\\|" (mapconcat (lambda (ext) (concat "\\." ext "$")) rails-grep-extensions "\\|")
"\\)"))
(set (make-local-variable 'ffip-patterns)
(mapcar (lambda (ext) (concat "*." ext)) rails-grep-extensions))
(rails-features:install))
;; hooks
(add-hook 'ruby-mode-hook
(lambda ()
(when (rails-project:root)
(require 'rails-ruby)
(local-set-key (rails-global-key "f") '(lambda()
(interactive)
(mouse-major-mode-menu (rails-core:menu-position))))
(local-set-key (kbd "C-:") 'ruby-toggle-string<>simbol)
(local-set-key (kbd "RET") 'ruby-newline-and-indent))))
(add-hook 'speedbar-mode-hook
(lambda()
(speedbar-add-supported-extension "\\.rb")))
(add-hook 'find-file-hooks
(lambda()
(rails-project:with-root
(root)
(progn
(rails-minor-mode t)
(rails-apply-for-buffer-type)))))
;; Run rails-minor-mode in dired
(add-hook 'dired-mode-hook
(lambda ()
(if (rails-project:root)
(rails-minor-mode t))))
(defvar rails-auto-mode-alist '(("\\.rb$" . ruby-mode)
("\\.rake$" . ruby-mode)
("\\.mab$" . ruby-mode)
("Rakefile$" . ruby-mode)
("Capfile$" . ruby-mode)
("Gemfile" . ruby-mode)
("\\.rxml$" . ruby-mode)
("\\.builder$" . ruby-mode)
("\\.rjs$" . ruby-mode)
("\\.prawn$" . ruby-mode)
("\\.scss$" . css-mode)
("\\.rabl$" . ruby-mode)
("\\.rhtml$" . rhtml-mode)
("\\.erb$" . rhtml-mode)))
(dolist (pair rails-auto-mode-alist)
(add-to-list 'auto-mode-alist pair)
(modify-coding-system-alist 'file (car pair) 'utf-8))
(modify-coding-system-alist 'file (rails-core:regex-for-match-view) 'utf-8)
;; Some navigation breaks if max-lisp-eval-depth is not high enough, up it if too low
(setq max-lisp-eval-depth (max max-lisp-eval-depth rails-required-lisp-eval-depth))
(provide 'rails)