vedeu 0.5.8 → 0.5.9

data/lib/vedeu/esc/colours.rb

@@ -0,0 +1,104 @@
+module Vedeu
+
+  # Provides escape sequence strings.
+  #
+  module EscapeSequences
+
+    # Provides colour related escape sequences.
+    #
+    module Colours
+
+      extend self
+
+      # Produces the background named colour escape sequence hash from the
+      # foreground escape sequence hash.
+      #
+      # @return [Hash<Symbol => Fixnum>]
+      def background_codes
+        hash = {}
+        foreground_codes.inject(hash) do |h, (k, v)|
+          h.merge!(k => v + 10)
+        end
+      end
+
+      # Produces the foreground named colour escape sequence hash. The
+      # background escape sequences are also generated from this by adding 10 to
+      # the values.
+      # This hash gives rise to methods you can call directly on `Esc` to
+      # produce the desired colours:
+      #
+      # @example
+      #   Esc.red                     # => "\e[31m"
+      #
+      #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
+      #
+      #   Esc.on_blue                 # => "\e[44m"
+      #
+      #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
+      #
+      #   # Valid names:
+      #   :black, :red, :green, :yellow, :blue, :magenta, :cyan, :light_grey,
+      #   :default, :dark_grey, :light_red, :light_green, :light_yellow,
+      #   :light_blue, :light_magenta, :light_cyan, :white
+      #
+      # @return [Hash<Symbol => Fixnum>]
+      def foreground_codes
+        {
+          black:         30,
+          red:           31,
+          green:         32,
+          yellow:        33,
+          blue:          34,
+          magenta:       35,
+          cyan:          36,
+          light_grey:    37,
+          default:       39,
+          dark_grey:     90,
+          light_red:     91,
+          light_green:   92,
+          light_yellow:  93,
+          light_blue:    94,
+          light_magenta: 95,
+          light_cyan:    96,
+          white:         97,
+        }
+      end
+      alias_method :codes, :foreground_codes
+
+      # @return [void]
+      def setup!
+        define_backgrounds!
+        define_foregrounds!
+      end
+
+      private
+
+      # @return [void]
+      def define_backgrounds!
+        background_codes.each do |key, code|
+          define_method('on_' + key.to_s) do |&blk|
+            "\e[#{code}m" + (blk ? blk.call + "\e[49m" : '')
+          end
+        end
+      end
+
+      # Dynamically creates methods for each terminal named colour. When a block
+      # is given, then the colour is reset to 'default' once the block is
+      # called.
+      #
+      # @return [void]
+      def define_foregrounds!
+        foreground_codes.each do |key, code|
+          define_method(key) do |&blk|
+            "\e[#{code}m" + (blk ? blk.call + "\e[39m" : '')
+          end
+        end
+      end
+
+    end # Colours
+
+  end # EscapeSequences
+
+  Vedeu::EscapeSequences::Colours.setup!
+
+end # Vedeu

data/lib/vedeu/{output → esc}/esc.rb

@@ -5,7 +5,9 @@ module Vedeu
   #
   module Esc
 
-    include Vedeu::EscapeSequences
+    include Vedeu::EscapeSequences::Actions
+    include Vedeu::EscapeSequences::Borders
+    include Vedeu::EscapeSequences::Colours
     extend self
 
     # Return the stream with the escape sequences escaped so that they can be

data/lib/vedeu/models/cell.rb

@@ -45,8 +45,7 @@ module Vedeu
     # @param other [Vedeu::Cell]
     # @return [Boolean]
     def eql?(other)
-      self.class == other.class && colour == other.colour &&
-        style == other.style && value == other.value && x == other.x &&
+      self.class == other.class && value == other.value && x == other.x &&
         y == other.y
     end
     alias_method :==, :eql?

data/lib/vedeu/output/html_char.rb

@@ -46,18 +46,20 @@ module Vedeu
       return '' unless border || present?(value)
 
       out = " style='"
+      out << tag_style_background unless char.background.empty?
+      out << tag_style_foreground unless char.foreground.empty?
+      out << "'"
+    end
 
-      unless char.background.empty?
-        out << "border:1px #{char.background.to_html} solid;"
-        out << "background:#{char.background.to_html};"
-      end
-
-      unless char.foreground.empty?
-        out << "color:#{char.foreground.to_html};"
-        out << "#{border_style}"
-      end
+    # @return [String]
+    def tag_style_background
+      "border:1px #{char.background.to_html} solid;" \
+        "background:#{char.background.to_html};"
+    end
 
-      out << "'"
+    # @return [String]
+    def tag_style_foreground
+      "color:#{char.foreground.to_html};#{border_style}"
     end
 
     # @return [String]

data/lib/vedeu/templating/view_template.rb

@@ -48,6 +48,9 @@ module Vedeu
 
       private
 
+      # Return the interface colours if a name option is set, otherwise use the
+      # default colours.
+      #
       # @return [Vedeu::Colour|Hash<Symbol => Symbol>]
       def default_colour
         if options[:name]
@@ -62,6 +65,9 @@ module Vedeu
         end
       end
 
+      # Return the interface style(s) if a name option is set, otherwise use the
+      # default style.
+      #
       # @return [Symbol]
       def default_style
         if options[:name]
@@ -73,23 +79,32 @@ module Vedeu
         end
       end
 
+      # Fetch the interface by name.
+      #
       # @return [Vedeu::Interface]
       def interface
         Vedeu.interfaces.by_name(options[:name])
       end
       alias_method :interface?, :interface
 
+      # Returns the stream directives for the line.
+      #
       # @param line [String]
       # @return [Array<String>]
       def streams_for(line)
         line.split(/({{\s*[^}]+\s*}})/)
       end
 
+      # Convert the content into an array of strings without the line ending
+      # character.
+      #
       # @return [Array<String>]
       def lines
         content.lines.map(&:chomp)
       end
 
+      # Return a string representing the template processed with ERB.
+      #
       # @return [String]
       def content
         ERB.new(load, nil, '-').result(binding)

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.5.8'
+  VERSION = '0.5.9'
 
 end

data/test/lib/vedeu/cli/generator/helpers_test.rb

@@ -45,26 +45,69 @@ module Vedeu
         let(:source)      {}
         let(:destination) {}
 
-        before { Vedeu.stubs(:log_stdout) }
+        before {
+          File.stubs(:exist?).returns(false)
+          Vedeu.stubs(:log_stdout)
+        }
 
         subject { instance.copy_file(source, destination) }
 
-        it {
-          FileUtils.expects(:cp).with(source, destination)
-          subject
-        }
+        context 'when the file exists' do
+          before { File.stubs(:exist?).returns(true) }
+
+          it {
+            Vedeu.expects(:log_stdout)
+            subject
+          }
+        end
+
+        context 'when the file does not exist' do
+          it {
+            FileUtils.expects(:cp).with(source, destination)
+            subject
+          }
+        end
       end
 
       describe '#make_file' do
         let(:source)      {}
         let(:destination) {}
 
-        before { Vedeu.stubs(:log_stdout) }
+        before {
+          File.stubs(:exist?).returns(false)
+          Vedeu.stubs(:log_stdout)
+        }
 
         subject { instance.make_file(source, destination) }
 
-        # @todo Add more tests.
-        # it { skip }
+        context 'when the file exists' do
+          before { File.stubs(:exist?).returns(true) }
+
+          it {
+            Vedeu.expects(:log_stdout)
+            subject
+          }
+        end
+
+        context 'when the file does not exist' do
+          # @todo Add more tests.
+          # it { skip }
+        end
+      end
+
+      describe '#skipped_file' do
+        let(:destination) { 'some_file.txt' }
+
+        before { Vedeu.stubs(:log_stdout) }
+
+        subject { instance.skipped_file(destination) }
+
+        it {
+          Vedeu.expects(:log_stdout).
+            with(type:    :create,
+                 message: "some_file.txt \e[31malready exists, skipped.\e[39m")
+          subject
+        }
       end
 
       describe '#touch_file' do

data/test/lib/vedeu/esc/actions_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+module Vedeu
+
+  module EscapeSequences
+
+  	describe Actions do
+
+      let(:described) { Vedeu::EscapeSequences::Actions }
+
+      before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
+
+      describe 'action methods' do
+        it { described.hide_cursor.must_equal("\e[?25l") }
+        it { described.show_cursor.must_equal("\e[?25h") }
+        it { described.cursor_position.must_equal("\e[6n") }
+        it { described.bg_reset.must_equal("\e[49m") }
+        it { described.blink.must_equal("\e[5m") }
+        it { described.blink_off.must_equal("\e[25m") }
+        it { described.bold.must_equal("\e[1m") }
+        it { described.bold_off.must_equal("\e[22m") }
+        it { described.dim.must_equal("\e[2m") }
+        it { described.fg_reset.must_equal("\e[39m") }
+        it { described.negative.must_equal("\e[7m") }
+        it { described.positive.must_equal("\e[27m") }
+        it { described.reset.must_equal("\e[0m") }
+        it { described.underline.must_equal("\e[4m") }
+        it { described.underline_off.must_equal("\e[24m") }
+      end
+
+      describe '.characters' do
+        it { described.characters.must_be_instance_of(Hash) }
+      end
+
+  	end # Actions
+
+  end # EscapeSequences
+
+end # Vedeu

data/test/lib/vedeu/esc/borders_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Vedeu
+
+  module EscapeSequences
+
+  	describe Borders do
+
+      let(:described) { Vedeu::EscapeSequences::Borders }
+
+      before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
+
+      describe 'border methods' do
+        it { described.border_on.must_equal("\e(0") }
+        it { described.border_off.must_equal("\e(B") }
+
+        it { described.bottom_right.must_equal("\x6A") }
+        it { described.top_right.must_equal("\x6B") }
+        it { described.top_left.must_equal("\x6C") }
+        it { described.bottom_left.must_equal("\x6D") }
+        it { described.horizontal.must_equal("\x71") }
+        it { described.vertical_left.must_equal("\x74") }
+        it { described.vertical_right.must_equal("\x75") }
+        it { described.horizontal_bottom.must_equal("\x76") }
+        it { described.horizontal_top.must_equal("\x77") }
+        it { described.vertical.must_equal("\x78") }
+      end
+
+      describe '.characters' do
+        it { described.characters.must_be_instance_of(Hash) }
+      end
+
+  	end # Borders
+
+  end # EscapeSequences
+
+end # Vedeu

data/test/lib/vedeu/esc/colours_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+module Vedeu
+
+  module EscapeSequences
+
+    describe Colours do
+
+      let(:described) { Vedeu::EscapeSequences::Colours }
+
+      before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
+
+      describe 'foreground colour methods' do
+        it { described.black.must_equal("\e[30m") }
+        it { described.red.must_equal("\e[31m") }
+        it { described.green.must_equal("\e[32m") }
+        it { described.yellow.must_equal("\e[33m") }
+        it { described.blue.must_equal("\e[34m") }
+        it { described.magenta.must_equal("\e[35m") }
+        it { described.cyan.must_equal("\e[36m") }
+        it { described.light_grey.must_equal("\e[37m") }
+        it { described.default.must_equal("\e[39m") }
+        it { described.dark_grey.must_equal("\e[90m") }
+        it { described.light_red.must_equal("\e[91m") }
+        it { described.light_green.must_equal("\e[92m") }
+        it { described.light_yellow.must_equal("\e[93m") }
+        it { described.light_blue.must_equal("\e[94m") }
+        it { described.light_magenta.must_equal("\e[95m") }
+        it { described.light_cyan.must_equal("\e[96m") }
+        it { described.white.must_equal("\e[97m") }
+
+        it 'returns an escape sequence for the foreground colour and resets ' \
+           'after calling the block' do
+          described.cyan do
+            'ununpentium'
+          end.must_equal("\e[36mununpentium\e[39m")
+        end
+      end
+
+      describe '.codes' do
+        it { described.codes.must_be_instance_of(Hash) }
+        it { described.must_respond_to(:foreground_codes) }
+      end
+
+      describe '.background_codes' do
+        it { described.background_codes.must_be_instance_of(Hash) }
+      end
+
+      describe 'background colour methods' do
+        it { described.on_black.must_equal("\e[40m") }
+        it { described.on_red.must_equal("\e[41m") }
+        it { described.on_green.must_equal("\e[42m") }
+        it { described.on_yellow.must_equal("\e[43m") }
+        it { described.on_blue.must_equal("\e[44m") }
+        it { described.on_magenta.must_equal("\e[45m") }
+        it { described.on_cyan.must_equal("\e[46m") }
+        it { described.on_light_grey.must_equal("\e[47m") }
+        it { described.on_default.must_equal("\e[49m") }
+        it { described.on_dark_grey.must_equal("\e[100m") }
+        it { described.on_light_red.must_equal("\e[101m") }
+        it { described.on_light_green.must_equal("\e[102m") }
+        it { described.on_light_yellow.must_equal("\e[103m") }
+        it { described.on_light_blue.must_equal("\e[104m") }
+        it { described.on_light_magenta.must_equal("\e[105m") }
+        it { described.on_light_cyan.must_equal("\e[106m") }
+        it { described.on_white.must_equal("\e[107m") }
+
+        it 'returns an escape sequence for the background colour and resets ' \
+           'after calling the block' do
+          described.on_red do
+            'livermorium'
+          end.must_equal("\e[41mlivermorium\e[49m")
+        end
+      end
+
+    end # Colours
+
+  end # EscapeSequences
+
+end # Vedeu