Merge pull request #21 from AdrieanKhisbe/faces

Add face support and Basic regression Test

Author: johanvts

README.rst

@@ -44,8 +44,17 @@ Key bind                  Function
 
 Use ``M-x customize-group RET fireplace RET`` to view and change the user defined variables and read their documentation.
 
+Configuration
+-------------
+
+You can tweak the setting of `fireplace` the way you please with the ``customize-group``
+`fireplace` and `fireplace-faces`.
+
+Among the options, the name of the buffer, the frequency of refresh, the smoke char,
+or the faces used in the fireplace.
+
 Manual Installation
-------------
+-------------------
 
 If you don't want to use melpa to install this package, follow these steps:
 
@@ -73,6 +82,5 @@ or on twitter @johanvts.
 To-Do
 -----
 - Better status bar
-- Custom faces support
 - Locally override some of the offending settings from `Issue #10 <https://github.com/johanvts/emacs-fireplace/issues/10>`_
 - Automatically scale fire if the user alters the window size after starting the fire, see `Issue #20 <https://github.com/johanvts/emacs-fireplace/issues/20>`_

features/emacs-fireplace.feature

@@ -1,11 +1,30 @@
-Feature: Do Some things
-  In order to do something
-  As a user
-  I want to do something
-
-  Scenario: Do Something
-    Given I have "something"
-    When I have "something"
-    Then I should have "something"
-    And I should have "something"
-    But I should not have "something"
+Feature: Putting Emacs on Fire
+  In order to do get warm in the winter
+  As a cool emacs users
+  I want to get some warmth from my favorite editor
+
+  Scenario: Turn on the fire
+    When I call "fireplace"
+    Then there is a "*fireplace*" buffer
+
+
+  Scenario: Turn on the fire and then off
+    When I call "fireplace"
+    And  I call "fireplace-off"
+    Then I should be in buffer "*scratch*"
+
+  Scenario: I can customize general setting
+    When I try to configure "fireplace"
+    Then I should be in buffer "*Customize Group: Fireplace*"
+    And I should see "Fireplace Background Char"
+    And I should see "Fireplace Buffer Name"
+    And I should see "Fireplace Fury"
+    And I should see "Fireplace Smoke Char"
+
+
+  Scenario: I can customize faces
+    When I try to configure "fireplace-faces"
+    Then I should be in buffer "*Customize Group: Fireplace Faces*"
+    And I should see "Fireplace Inner Flame Face"
+    And I should see "Fireplace Outter Flame Face"
+    And I should see "Fireplace Smoke Face"

features/step-definitions/emacs-fireplace-steps.el

@@ -2,27 +2,11 @@
 ;; files in this directory whose names end with "-steps.el" will be
 ;; loaded automatically by Ecukes.
 
-(Given "^I have \"\\(.+\\)\"$"
-  (lambda (something)
-    ;; ...
-    ))
-
-(When "^I have \"\\(.+\\)\"$"
-  (lambda (something)
-    ;; ...
-    ))
-
-(Then "^I should have \"\\(.+\\)\"$"
-  (lambda (something)
-    ;; ...
-    ))
-
-(And "^I have \"\\(.+\\)\"$"
-  (lambda (something)
-    ;; ...
-    ))
-
-(But "^I should not have \"\\(.+\\)\"$"
-  (lambda (something)
-    ;; ...
-    ))
+(When "^I try to configure \"\\([^\"]+\\)\"$"
+      (lambda (group)
+        (shut-up
+         (customize-group group))))
+
+(Then "^there is a \"\\([^\"]+\\)\" buffer$"
+      (lambda (buffer-name)
+        (get-buffer buffer-name)))

features/support/env.el

@@ -29,6 +29,8 @@
 
 (After
  ;; After each scenario is run
+ (get-buffer-create "*fireplace*")
+ (fireplace-off) ; so far it break if no fireplace buffer
  )
 
 (Teardown

fireplace.el

@@ -1,7 +1,7 @@
 ;;; fireplace.el --- A cozy fireplace for emacs      -*- lexical-binding: t; -*-
 
 ;; Copyright (C) 2015 Johan Sivertsen
-;;; Version: 1.0
+;;; Version: 1.1
 ;;; Author: Johan Sivertsen <[email protected]>
 ;;; URL: https://github.com/johanvts/emacs-fireplace
 ;;; Released: December 2015
@@ -62,14 +62,32 @@
   "Default name for fireplace buffer."
   :type 'string :group 'fireplace)
 
-;; Program controlled variables
-
+;;; Faces
+(defgroup fireplace-faces nil
+  "Faces for `fireplace'."
+  :group 'fireplace)
+
+(defface fireplace-outter-flame-face
+  '((t (:background "orange red")))
+  "Color of the core of the flame."
+  :group 'fireplace-faces)
+
+(defface fireplace-inner-flame-face
+  '((t (:background "dark orange")))
+  "Color of the core of the flame."
+  :group 'fireplace-faces)
+(defface fireplace-smoke-face
+  '((t (:foreground "slate grey")))
+  "Color of the smoke."
+  :group 'fireplace-faces)
+
+;;; Program controlled variables
 (defvar fireplace--bkgd-height "Used for fireplace height, will be set from windows size")
 (defvar fireplace--bkgd-width "Used for fireplace width, will be set from windows size")
 (defvar fireplace--timer "Holds the active fireplace, kill using fireplace-off")
 (defvar fireplace--flame-width "Calculated width of flames")
 
-;; Helper routines
+;;; Helper routines
 
 (defun fireplace--make-grid ()
   "Redraw backgound of buffer."
@@ -88,34 +106,35 @@
   "Draw flame stripe."
   (fireplace--gotoxy x y)
   (let* ((actual-width (min width (1+ (- fireplace--bkgd-width x))))
-	 (hot-core (/ actual-width 2)))
+         (hot-core (/ actual-width 2)))
     (delete-char actual-width)
     (insert (propertize (make-string actual-width fireplace-fill-char)
-			'face `(:background ,"orange red")))
+      'face 'fireplace-outter-flame-face))
     (when (> hot-core 1)
       (fireplace--gotoxy (+ x (/ hot-core 2)) y)
       (delete-char hot-core)
       (insert (propertize (make-string hot-core fireplace-fill-char)
-				      'face `(:background ,"dark orange"))))))
+              'face 'fireplace-inner-flame-face)))))
 
 (defun fireplace--smoke (x height)
   "Draw one random smoke."
-  (fireplace--gotoxy (if (>(random 3) 1)
+  (fireplace--gotoxy
+    (if (>(random 3) 1)
         (+ x (random (/ fireplace--bkgd-width 5)))
-      (max 0 (- x (random (/ fireplace--bkgd-width 5)))))
+        (max 0 (- x (random (/ fireplace--bkgd-width 5)))))
     (+ height (random (- fireplace--bkgd-height height))))
   (delete-char 1)
   (insert (propertize (make-string 1 fireplace-smoke-char)
-		      'face `(:foreground, "slate grey"))))
+          'face 'fireplace-smoke-face)))
 
 (defun fireplace--flame (middle h)
   "Draw a flame."
   (setq cursor-type nil)
   (let* ((width h)
-	 (lower (truncate(* 0.2 h)))
-	 (high (- h lower))
-	 x
-	 line)
+         (lower (truncate (* 0.2 h)))
+         (high (- h lower))
+         x
+         line)
     (dotimes (y lower)
       (setq width (+ width y)
             x (- middle (/ width 2)))
@@ -126,9 +145,9 @@
         (setq width (- fireplace--bkgd-width x)))
       (draw-flame-stripe x y width))
     (dotimes (y high)
-      (setq line (+ lower y))
-      (setq width (max 0 (- width 1 (random 3))))
-      (setq x (- middle (/ width 2)))
+      (setq line (+ lower y)
+            width (max 0 (- width 1 (random 3)))
+            x (- middle (/ width 2)))
       (when (< x 0)
         (setq width (+ width x)
               x 0))
@@ -144,9 +163,8 @@
     (fireplace--make-grid)
     (dolist (pos flame-pos)
       (fireplace--flame (round (* pos fireplace--bkgd-width))
-	     (+
-	      (round (* (+ 0.2 (min pos (- 1 pos))) flame-width))
-	      (random 3))))
+       (+ (round (* (+ 0.2 (min pos (- 1 pos))) flame-width))
+          (random 3))))
     (setq buffer-read-only t)))
 
 
@@ -188,9 +206,7 @@
 (defun fireplace-toggle-smoke ()
   "Toggle smoke on/off."
   (interactive)
-  (if fireplace-smoke-on
-      (setq fireplace-smoke-on nil)
-    (setq fireplace-smoke-on t)))
+  (setq fireplace-smoke-on (not fireplace-smoke-on)))
 
 ;;; Key-bindings