vedeu 0.4.60 → 0.4.61

data/lib/vedeu/repositories/collection.rb

@@ -78,6 +78,15 @@ module Vedeu
       collection.empty?
     end
 
+    # An object is equal when its values are the same.
+    #
+    # @param other [Vedeu::Collection]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && collection == other.collection
+    end
+    alias_method :==, :eql?
+
     # Returns the size of the collection.
     #
     # @return [Fixnum]

data/lib/vedeu/templating/all.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # Provides means to use templates with Vedeu.
+  #
+  module Templating
+
+  end # Templating
+
+end # Vedeu

data/lib/vedeu/templating/decoder.rb

@@ -0,0 +1,62 @@
+module Vedeu
+
+  module Templating
+
+    # Converts an encoded string back into an object or objects.
+    #
+    class Decoder
+
+      # @param data [String]
+      # @return [Object]
+      def self.process(data)
+        new(data).process
+      end
+
+      # Returns a new instance of Vedeu::Templating::Decoder.
+      #
+      # @param data [String]
+      # @return [Vedeu::Templating::Decoder]
+      def initialize(data)
+        @data = data
+      end
+
+      # @return [Object]
+      def process
+        demarshal
+      end
+
+      protected
+
+      # @!attribute [r] data
+      # @return [String]
+      attr_reader :data
+
+      private
+
+      # Convert the marshalled object or objects back into an object(s).
+      #
+      # @return [Object]
+      def demarshal
+        Marshal.load(decompress)
+      end
+
+      # Decompress the marshalled object or objects.
+      #
+      # @return [String]
+      def decompress
+        Zlib::Inflate.inflate(decode64)
+      end
+
+      # Decode the Base64 string into a compressed, marshalled object or
+      # objects.
+      #
+      # @return [String]
+      def decode64
+        Base64.strict_decode64(data)
+      end
+
+    end # Decoder
+
+  end # Templating
+
+end # Vedeu

data/lib/vedeu/templating/directive.rb

@@ -1,6 +1,5 @@
 module Vedeu
 
-  # Provides means to use templates with Vedeu.
   module Templating
 
     # Converts a directive found in a template into a Vedeu::Stream object.

data/lib/vedeu/templating/encoder.rb

@@ -0,0 +1,62 @@
+module Vedeu
+
+  module Templating
+
+    # Converts an object or objects into an encoded string.
+    #
+    class Encoder
+
+      # @param data [Object]
+      # @return [String]
+      def self.process(data)
+        new(data).process
+      end
+
+      # Returns a new instance of Vedeu::Templating::Encoder.
+      #
+      # @param data [Object]
+      # @return [Vedeu::Templating::Encoder]
+      def initialize(data)
+        @data = data
+      end
+
+      # @return [String]
+      def process
+        encode64
+      end
+
+      protected
+
+      # @!attribute [r] data
+      # @return [Object]
+      attr_reader :data
+
+      private
+
+      # Encode the compressed, marshalled object or objects into a Base64
+      # string.
+      #
+      # @return [String]
+      def encode64
+        Base64.strict_encode64(compress)
+      end
+
+      # Compress the marshalled object or objects.
+      #
+      # @return [String]
+      def compress
+        Zlib::Deflate.deflate(marshal)
+      end
+
+      # Convert the object or objects into marshalled object(s).
+      #
+      # @return [String]
+      def marshal
+        Marshal.dump(data)
+      end
+
+    end # Encoder
+
+  end # Templating
+
+end # Vedeu

data/lib/vedeu/templating/helpers.rb

@@ -1,17 +1,11 @@
 module Vedeu
 
-  # Provides means to use templates with Vedeu.
   module Templating
 
     # Provide helpers to be used with your Vedeu templates.
     #
     module Helpers
 
-      # @example
-      #   Roses are {{ background('#ff0000', 'red') }},
-      #   violets are {{ bg('#0000ff', 'blue') }},
-      #   {{ background('#00ff00'), 'The test suite is all green!' }}
-      #
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @return [Vedeu::Stream]
@@ -31,11 +25,6 @@ module Vedeu
         define_stream(attributes, &block)
       end
 
-      # @example
-      #   Roses are {{ foreground('#ff0000', 'red') }},
-      #   violets are {{ fg('#0000ff', 'blue') }},
-      #   {{ foreground('#00ff00'), 'The test suite is all green!' }}
-      #
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @return [Vedeu::Stream]
@@ -45,22 +34,21 @@ module Vedeu
       end
       alias_method :fg, :foreground
 
-      private
-
-      # @see Vedeu::Templating::Helpers#colours
-      def define_colour(attributes = {})
-        attributes.delete_if do |k, v|
-          [:background, :foreground].include?(k) == false || v.nil? || v.empty?
-        end
-
-        Vedeu::Colour.new(attributes)
+      # @param value [Symbol]
+      # @param block [Proc]
+      # @return [Vedeu::Stream]
+      def style(value, &block)
+        define_stream({ style: value }, &block)
       end
 
-      # @see Vedeu::Templating::Helpers#colours
+      private
+
+      # @see Vedeu::Templating::Helpers#colour
       def define_stream(attributes = {}, &block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Stream.build(colour: define_colour(attributes),
+        Vedeu::Stream.build(colour: Vedeu::Colour.new(attributes),
+                            style:  Vedeu::Style.new(attributes[:style]),
                             value:  block.call)
       end
 

data/lib/vedeu/templating/post_processor.rb

@@ -0,0 +1,81 @@
+module Vedeu
+
+  module Templating
+
+    # Pre-processes a template, to convert all lines and lines with directives
+    # into Vedeu::Streams.
+    #
+    class PostProcessor
+
+      # @param content [String]
+      # @return [Array<Vedeu::Stream>]
+      def self.process(content)
+        new(content).process
+      end
+
+      # Returns a new instance of Vedeu::Templating::PostProcessor.
+      #
+      # @param content [String]
+      # @return [Vedeu::Templating::PostProcessor]
+      def initialize(content)
+        @content = content
+      end
+
+      # @return [Vedeu::Streams]
+      def process
+        lines.each_with_object(Vedeu::Streams.new) do |line, acc|
+          if line =~ markers?
+            acc << Vedeu::Templating::Directive.process(unmark(line))
+
+          else
+            acc << Vedeu::Stream.new(value: line.chomp)
+
+          end
+          acc
+        end
+      end
+
+      protected
+
+      # @!attribute [r] content
+      # @return [String]
+      attr_reader :content
+
+      private
+
+      # @return [Array<String>]
+      def lines
+        content.lines
+      end
+
+      # Return a pattern to remove directive markers and spaces.
+      #
+      # @example
+      #   line containing {{ or }}
+      #
+      # @return [Regexp]
+      def markers
+        /({{\s*|\s*}})/
+      end
+
+      # @example
+      #   line contains {{ or }}
+      #
+      # @return [Regexp]
+      def markers?
+        /^\s*({{)(.*?)(}})$/
+      end
+
+      # Removes the markers and any line returns from the given line.
+      #
+      # @param line [String]
+      # @return [String]
+      def unmark(line)
+        line.gsub(markers, '').chomp
+      end
+
+    end # PostProcessor
+
+  end # Templating
+
+end # Vedeu

data/lib/vedeu/templating/template.rb

@@ -1,6 +1,5 @@
 module Vedeu
 
-  # Provides means to use templates with Vedeu.
   module Templating
 
     # Generic class to loading a template and parsing it via ERb.
@@ -26,7 +25,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @return [void]
+      # @return [Vedeu::Stream]
       def parse
         ERB.new(load, nil, '-').result(binding)
       end
@@ -43,11 +42,6 @@ module Vedeu
 
       private
 
-      # @return [String]
-      def preprocess
-        Vedeu::Templating::Preprocessor.process(load)
-      end
-
       # @return [String]
       def load
         File.read(path)

data/lib/vedeu/terminal_mode.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Store the current mode of the terminal.
+  #
   module TerminalMode
 
     extend self

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/geometry/coordinate_test.rb

@@ -5,21 +5,22 @@ module Vedeu
   describe Coordinate do
 
     let(:described) { Vedeu::Coordinate }
-    let(:instance)  { described.new(_name) }
+    let(:instance)  { described.new(_name, oy, ox) }
     let(:_name)     { 'coordinate' }
+    let(:oy)        { 0 }
+    let(:ox)        { 0 }
     let(:height)    { 6 }
     let(:width)     { 6 }
     let(:x)         { 7 }
     let(:y)         { 5 }
 
     before do
-      Vedeu::Border.new(name: _name,
-                        enabled: true).store
-      Vedeu::Geometry.new(name: _name,
+      Vedeu::Border.new(name: _name, enabled: true).store
+      Vedeu::Geometry.new(name:   _name,
                           height: height,
-                          width: width,
-                          x: x,
-                          y: y).store
+                          width:  width,
+                          x:      x,
+                          y:      y).store
     end
     after do
       Vedeu.borders.reset
@@ -29,6 +30,8 @@ module Vedeu
     describe '#initialize' do
       it { instance.must_be_instance_of(described) }
       it { instance.instance_variable_get('@name').must_equal(_name) }
+      it { instance.instance_variable_get('@oy').must_equal(oy) }
+      it { instance.instance_variable_get('@ox').must_equal(ox) }
     end
 
     describe '#yn' do
@@ -60,20 +63,20 @@ module Vedeu
     end
 
     describe '#y_position' do
-      let(:index)  { 0 }
+      let(:oy)  { 0 }
 
-      subject { instance.y_position(index) }
+      subject { instance.y_position }
 
       it { subject.must_be_instance_of(Fixnum) }
 
       context 'with a negative index' do
-        let(:index) { -3 }
+        let(:oy) { -3 }
 
         it { subject.must_equal(6) }
       end
 
       context 'with an index greater than the maximum index for y' do
-        let(:index) { 9 }
+        let(:oy) { 9 }
 
         it { subject.must_equal(9) }
 
@@ -85,27 +88,27 @@ module Vedeu
       end
 
       context 'with an index within range' do
-        let(:index) { 3 }
+        let(:oy) { 3 }
 
         it { subject.must_equal(8) }
       end
     end
 
     describe '#x_position' do
-      let(:index)  { 0 }
+      let(:ox)  { 0 }
 
-      subject { instance.x_position(index) }
+      subject { instance.x_position }
 
       it { subject.must_be_instance_of(Fixnum) }
 
       context 'with a negative index' do
-        let(:index) { -3 }
+        let(:ox) { -3 }
 
         it { subject.must_equal(8) }
       end
 
       context 'with an index greater than the maximum index for x' do
-        let(:index) { 9 }
+        let(:ox) { 9 }
 
         it { subject.must_equal(11) }
 
@@ -117,7 +120,7 @@ module Vedeu
       end
 
       context 'with an index within range' do
-        let(:index) { 3 }
+        let(:ox) { 3 }
 
         it { subject.must_equal(10) }
       end