vedeu 0.8.2 → 0.8.3

data/lib/vedeu/presentation/background.rb

@@ -24,8 +24,8 @@ module Vedeu
           @background ||= if colour && present?(colour.background)
                             colour.background
 
-                          elsif self.is_a?(Vedeu::Views::Char) && name
-                            interface.colour.background
+                          elsif named_colour?
+                            named_colour.background
 
                           elsif parent && present?(parent.background)
                             parent.background

data/lib/vedeu/presentation/colour.rb

@@ -25,10 +25,6 @@ module Vedeu
                      elsif named_colour?
                        Vedeu::Colours::Colour.coerce(named_colour)
 
-                     elsif self.is_a?(Vedeu::Views::Char) && name
-                       # Currently used by Vedeu::Output::Viewport
-                       Vedeu::Colours::Colour.coerce(interface.colour)
-
                      else
                        Vedeu::Colours::Colour.new
 

data/lib/vedeu/presentation/foreground.rb

@@ -24,8 +24,8 @@ module Vedeu
           @foreground ||= if colour && present?(colour.foreground)
                             colour.foreground
 
-                          elsif self.is_a?(Vedeu::Views::Char) && name
-                            interface.colour.foreground
+                          elsif named_colour?
+                            named_colour.foreground
 
                           elsif parent && present?(parent.foreground)
                             parent.foreground

data/lib/vedeu/presentation/style.rb

@@ -68,7 +68,7 @@ module Vedeu
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Views::Char]
+      # @param other [void]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && value == other.value

data/lib/vedeu/presentation/styles.rb

@@ -20,9 +20,6 @@ module Vedeu
         @_style ||= if @style
                       Vedeu::Presentation::Style.coerce(@style)
 
-                    elsif self.is_a?(Vedeu::Views::Char) && name
-                      Vedeu::Presentation::Style.coerce(interface.style)
-
                     elsif parent && present?(parent.style)
                       Vedeu::Presentation::Style.coerce(parent.style)
 

data/lib/vedeu/renderers/file.rb

@@ -10,90 +10,32 @@ module Vedeu
 
       include Vedeu::Renderers::Options
 
-      # Returns a new instance of Vedeu::Renderers::File.
-      #
-      # @param options [Hash]
-      # @option options filename [String] Provide a filename for the
-      #   output. Defaults to 'out'.
-      # @option options timestamp [Boolean] Append a timestamp to the
-      #   filename.
-      # @option options write_file [Boolean] Whether to write the file
-      #   to the given filename.
-      # @return [Vedeu::Renderers::File]
-      def initialize(options = {})
-        @options = options || {}
+      # @return [String]
+      def clear
+        render('')
       end
 
       # Render the output (either content or clearing) to a file.
       #
-      # @param output [Vedeu::Models::Page]
-      # @param opts [Hash]
       # @return [String]
-      def render(output = '', opts = {})
-        @options = options.merge!(opts)
+      def write
+        data = content
 
-        ::File.write(filename, out(output)) if write_file?
+        ::File.write(filename, data)
 
-        out(output)
+        data
       end
-      alias_method :clear, :render
 
       private
 
-      # Compresses the output depending on configuration.
-      #
-      # @param output [Vedeu::Models::Page]
-      # @return [String]
-      def out(output)
-        if compress?
-          Vedeu::Output::Compressor.render(output, options)
-
-        else
-          output
-
-        end
-      end
-
-      # Return the filename given in the options, (or use the
-      # default), and append a timestamp if the :timestamp option was
-      # set to true.
-      #
       # @return [String]
-      def filename
-        options[:filename] + timestamp
+      def content
+        output
       end
 
-      # Return a timestamp for use as part of the filename if the
-      # :timestamp option was set to true, otherwise an empty string.
-      #
-      # @return [Float]
-      def timestamp
-        if options[:timestamp]
-          "_#{Vedeu.clock_time}"
-
-        else
-          ''
-
-        end
-      end
-
-      # Returns a boolean indicating whether a file should be written.
-      #
       # @return [Boolean]
       def write_file?
-        options[:write_file]
-      end
-
-      # Returns the default options/attributes for this class.
-      #
-      # @return [Hash]
-      def defaults
-        {
-          compression: Vedeu.config.compression?,
-          filename:    'out',
-          timestamp:   false,
-          write_file:  true,
-        }
+        true
       end
 
     end # File

data/lib/vedeu/renderers/html.rb

@@ -9,120 +9,52 @@ module Vedeu
     #
     class HTML < Vedeu::Renderers::File
 
-      # Returns a new instance of Vedeu::Renderers::HTML.
-      #
-      # @param options [Hash]
-      # @option options content [String] Defaults to an empty string.
-      # @option options end_tag [String] Defaults to '</td>'.
-      # @option options end_row_tag [String] Defaults to '</tr>'.
-      # @option options filename [String] Provide a filename for the
-      #   output. Defaults to 'out'.
-      # @option options start_tag [String] Defaults to '<td' (note the
-      #   end of the tag is missing, this is so that inline styles can
-      #   be added later).
-      # @option options start_row_tag [String] Defaults to '<tr>'.
-      # @option options template [String]
-      # @option options timestamp [Boolean] Append a timestamp to the
-      #   filename.
-      # @option options write_file [Boolean] Whether to write the file
-      #   to the given filename.
-      # @return [Vedeu::Renderers::HTML]
-      def initialize(options = {})
-        @options = options || {}
-        @output  = nil
-      end
+      include Vedeu::Renderers::Options
 
-      # Render a cleared output.
-      #
       # @return [String]
-      def clear
-        @output = Vedeu::Cells::Escape.new
-
-        ''
+      def html_body
+        if valid?
+          output.inject([]) do |acc, line|
+            acc << "#{start_row_tag}\n"
+            line.each do |char|
+              acc << char.to_html(options)
+            end
+            acc << "#{end_row_tag}\n"
+          end.join
+
+        else
+          ''
+
+        end
       end
 
-      # @param output [Vedeu::Models::Page]
+      private
+
       # @return [String]
-      def render(output)
-        @output = output
+      def content
+        if valid?
+          Vedeu::Templating::Template.parse(self, template)
 
-        super(Vedeu::Templating::Template.parse(self, template)) unless escape?
-      end
+        else
+          ''
 
-      # @return [String]
-      def html_body
-        return '' if output.is_a?(Vedeu::Cells::Escape)
-
-        output.inject([]) do |acc, line|
-          acc << "#{start_row_tag}\n"
-          line.each do |char|
-            acc << char.to_html(options)
-          end
-          acc << "#{end_row_tag}\n"
-        end.join
+        end
       end
 
-      private
-
       # Returns a boolean indicating whether the output is a
       # {Vedeu::Cells::Escape}. If it is, it won't be rendered in
       # HTML.
       #
       # @return [Boolean]
       def escape?
-        output.is_a?(Vedeu::Cells::Escape)
-      end
-
-      # @return [Array<Array<Vedeu::Views::Char>>]
-      def output
-        @output || options[:output]
-      end
-
-      # @return [String]
-      def end_tag
-        options[:end_tag]
+        output.is_a?(Vedeu::Cells::Escape) || output.is_a?(Vedeu::Cells::Cursor)
       end
 
-      # @return [String]
-      def end_row_tag
-        options[:end_row_tag]
-      end
-
-      # @return [String]
-      def start_tag
-        options[:start_tag]
-      end
-
-      # @return [String]
-      def start_row_tag
-        options[:start_row_tag]
-      end
-
-      # @return [String]
-      def template
-        options[:template]
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => void>]
-      def defaults
-        {
-          content:       '',
-          end_tag:       '</td>',
-          end_row_tag:   '</tr>',
-          filename:      'out',
-          start_tag:     '<td',
-          start_row_tag: '<tr>',
-          template:      default_template,
-          timestamp:     false,
-          write_file:    true,
-        }
-      end
+      # @return [Boolean]
+      def valid?
+        return false if string?(output) || escape?
 
-      # @return [String]
-      def default_template
-        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
+        true
       end
 
     end # HTML

data/lib/vedeu/renderers/json.rb

@@ -8,49 +8,33 @@ module Vedeu
     #
     class JSON < Vedeu::Renderers::File
 
-      # Returns a new instance of Vedeu::Renderers::JSON.
-      #
-      # @param options [Hash]
-      # @return [Vedeu::Renderers::JSON]
-      def initialize(options = {})
-        @options = options || {}
-      end
+      include Vedeu::Renderers::Options
 
       # Render a cleared output.
       #
-      # @return [String]
+      # @return [void]
       def clear
-        json = parse({})
-
-        super(json, { compression: false })
-
-        json
+        render({})
       end
 
-      # @param output [Vedeu::Models::Page]
-      # @return [String]
-      def render(output)
-        json = parse(output)
-
-        super(json, { compression: false })
+      private
 
-        json
+      # @return [Array]
+      def as_hash
+        output.content.map(&:to_h)
       end
 
-      private
-
-      # @param output [Vedeu::Models::Page]
       # @return [String]
-      def parse(output)
-        ::JSON.pretty_generate(as_hash(output))
-      end
+      def content
+        if hash?(output)
+          ::JSON.pretty_generate(output)
 
-      # @param output [Vedeu::Models::Page]
-      # @return [Array]
-      def as_hash(output)
-        return output if output.is_a?(Hash)
+        else
+          Vedeu.log(type:    :render,
+                    message: "#{self.class.name}#content: #{output.class.name}")
 
-        output.content.map(&:to_hash)
+          ::JSON.pretty_generate(as_hash)
+        end
       end
 
     end # JSON

data/lib/vedeu/renderers/options.rb

@@ -8,38 +8,184 @@ module Vedeu
     #
     module Options
 
-      # :nocov:
+      include Vedeu::Common
 
-      # @!attribute [w] options
+      # @!attribute [rw] options
       # @return [Hash<Symbol => void>]
-      attr_writer :options
+      attr_accessor :options
+
+      # Returns a new instance of the class including this module.
+      #
+      # @param opts [Hash]
+      # @return [void]
+      def initialize(opts = {})
+        @options = defaults.merge!(opts || {})
+      end
+
+      # @return [void]
+      def clear
+        render('')
+      end
+
+      # @param output [Vedeu::Models::Page]
+      # @param opts [Hash]
+      # @return [void]
+      def render(output = '')
+        options.merge!(output: output)
+
+        write
+      end
+
+      # @raise [Vedeu::Error::NotImplemented] Subclasses of this class
+      #   must implement this method.
+      # @return [Vedeu::Error::NotImplemented]
+      def write
+        fail Vedeu::Error::NotImplemented, 'Including classes implement this.'
+      end
+
+      private
 
       # Returns a boolean indicating whether the content should be
       # compressed if compression is available.
       #
       # @return [Boolean]
-      def compress?
-        options[:compression] || Vedeu.config.compression? || false
+      def compression?
+        boolean(options[:compression])
       end
 
-      private
-
-      # Combines the options provided at instantiation with the
-      # default values.
+      # Compresses the output depending on configuration.
       #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
+      # @return [String]
+      def compression
+        if compression?
+          Vedeu::Output::Compressor.render(output, options)
+
+        else
+          output
+
+        end
+      end
+
+      # @return [void]
+      def content
+        fail Vedeu::Error::NotImplemented, 'Including classes implement this.'
       end
 
       # The default values for a new instance of this class.
       #
+      # @param options [Hash]
+      # @option options content [String] Defaults to an empty string.
+      # @option options end_tag [String] Defaults to '</td>'.
+      # @option options end_row_tag [String] Defaults to '</tr>'.
+      # @option options filename [String] Provide a filename for the
+      #   output. Defaults to 'out'.
+      # @option options start_tag [String] Defaults to '<td' (note the
+      #   end of the tag is missing, this is so that inline styles can
+      #   be added later).
+      # @option options start_row_tag [String] Defaults to '<tr>'.
+      # @option options template [String]
+      # @option options timestamp [Boolean] Append a timestamp to the
+      #   filename.
+      # @option options write_file [Boolean] Whether to write the file
+      #   to the given filename.
+      #
       # @return [Hash<Symbol => void>]
       def defaults
-        {}
+        {
+          compression:   Vedeu.config.compression?,
+          end_tag:       '</td>',
+          end_row_tag:   '</tr>',
+          filename:      'out',
+          output:        '',
+          start_tag:     '<td',
+          start_row_tag: '<tr>',
+          template:      default_template,
+          timestamp:     false,
+          write_file:    false,
+        }
+      end
+
+      # @return [String]
+      def default_template
+        ::File.dirname(__FILE__) + '/./templates/html_renderer.vedeu'
+      end
+
+      # @return [String]
+      def end_tag
+        options[:end_tag]
       end
 
-      # :nocov:
+      # @return [String]
+      def end_row_tag
+        options[:end_row_tag]
+      end
+
+      # Return the filename given in the options, (or use the
+      # default), and append a timestamp if the :timestamp option was
+      # set to true.
+      #
+      # @return [String]
+      def filename
+        options[:filename] + timestamp
+      end
+
+      # @return [String]
+      def start_tag
+        options[:start_tag]
+      end
+
+      # @return [String]
+      def start_row_tag
+        options[:start_row_tag]
+      end
+
+      # @return [void]
+      def output
+        options[:output]
+      end
+
+      # @return [Boolean]
+      def output?
+        present?(output)
+      end
+
+      # @return [String]
+      def template
+        options[:template]
+      end
+
+      # @return [Boolean]
+      def timestamp?
+        boolean(options[:timestamp])
+      end
+
+      # Return a timestamp for use as part of the filename if the
+      # :timestamp option was set to true, otherwise an empty string.
+      #
+      # @return [String]
+      def timestamp
+        return "_#{Vedeu.clock_time}" if timestamp?
+
+        ''
+      end
+
+      # Returns a boolean indicating whether a file should be written.
+      #
+      # @return [Boolean]
+      def write_file?
+        boolean(options[:write_file])
+      end
+
+      # Render the output (either content or clearing) to a file.
+      #
+      # @return [String]
+      def write_file
+        data = content
+
+        ::File.write(filename, data)
+
+        data
+      end
 
     end # Options