vedeu 0.8.0 → 0.8.1

data/lib/vedeu/distributed/server.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to control a running client application via
@@ -92,19 +94,19 @@ module Vedeu
       #
       # @return [void]
       def restart
-        log('Attempting to restart'.freeze)
+        log('Attempting to restart')
 
         return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
-          log('Restarting'.freeze)
+          log('Restarting')
 
           stop
 
           start
 
         else
-          log('Not running'.freeze)
+          log('Not running')
 
           start
 
@@ -136,15 +138,15 @@ module Vedeu
       #
       # @return [Vedeu::Distributed::Server]
       def start
-        log('Attempting to start'.freeze)
+        log('Attempting to start')
 
         return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
-          log('Already started'.freeze)
+          log('Already started')
 
         else
-          log('Starting'.freeze)
+          log('Starting')
 
           DRb.start_service(uri, self)
 
@@ -159,17 +161,17 @@ module Vedeu
       #
       # @return [Symbol]
       def status
-        log('Fetching status'.freeze)
+        log('Fetching status')
 
         return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
-          log('Running'.freeze)
+          log('Running')
 
           :running
 
         else
-          log('Stopped'.freeze)
+          log('Stopped')
 
           :stopped
 
@@ -183,24 +185,24 @@ module Vedeu
       #
       # @return [void]
       def stop
-        log('Attempting to stop'.freeze)
+        log('Attempting to stop')
 
         return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
-          log('Stopping'.freeze)
+          log('Stopping')
 
           DRb.stop_service
 
           DRb.thread.join
 
         else
-          log('Already stopped'.freeze)
+          log('Already stopped')
 
         end
       rescue NoMethodError # raised when #join is called on NilClass.
         Vedeu.log(type:    :drb,
-                  message: 'Attempted to #join on DRb.thread.'.freeze)
+                  message: 'Attempted to #join on DRb.thread.')
       end
 
       protected
@@ -218,12 +220,12 @@ module Vedeu
 
       # @return [void]
       def log(message)
-        Vedeu.log(type: :drb, message: "#{message}: '#{uri}'".freeze)
+        Vedeu.log(type: :drb, message: "#{message}: '#{uri}'")
       end
 
       # @return [Symbol]
       def not_enabled
-        log('Not enabled'.freeze)
+        log('Not enabled')
 
         :drb_not_enabled
       end

data/lib/vedeu/distributed/subprocess.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Distributed
@@ -59,7 +61,7 @@ module Vedeu
 
       # @return [String]
       def command
-        "ruby #{file_path}".freeze
+        "ruby #{file_path}"
       end
 
       # @return [Fixnum] The number of bytes written.
@@ -90,7 +92,7 @@ module Vedeu
 
       # @return [String]
       def file_name
-        "/tmp/foo_#{timestamp}".freeze
+        "/tmp/foo_#{timestamp}"
       end
 
       # return [Fixnum]

data/lib/vedeu/distributed/test_application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Create a test application as a string.

data/lib/vedeu/distributed/uri.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to control a running client application via
@@ -33,7 +35,7 @@ module Vedeu
       #
       # @return [String] The host and port as a single value.
       def to_s
-        "druby://#{host}:#{port}".freeze
+        "druby://#{host}:#{port}"
       end
       alias_method :to_str, :to_s
 

data/lib/vedeu/dsl/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to help configure and use Vedeu.

data/lib/vedeu/dsl/attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL
@@ -14,7 +16,7 @@ module Vedeu
       # @return (see #attributes)
       def self.build(context = nil,
                      model   = nil,
-                     value   = ''.freeze,
+                     value   = '',
                      options = {},
                      &block)
         new(context, model, value, options, &block).attributes
@@ -42,12 +44,12 @@ module Vedeu
       # @return [Vedeu::DSL::Attributes]
       def initialize(context = nil,
                      model   = nil,
-                     value   = ''.freeze,
+                     value   = '',
                      options = {},
                      &block)
         @context = context
         @model   = model
-        @value   = value   || ''.freeze
+        @value   = value   || ''
         @options = options || {}
         @block   = block
       end
@@ -118,7 +120,7 @@ module Vedeu
           client:     nil,
           colour:     nil,
           name:       nil,
-          pad:        ' '.freeze,
+          pad:        ' ',
           style:      nil,
           truncate:   false,
           width:      nil,
@@ -145,7 +147,7 @@ module Vedeu
 
       # @return [String]
       def pad
-        options[:pad].to_s[0] || ' '.freeze
+        options[:pad].to_s[0] || ' '
       end
 
       # @return [NilClass|Vedeu::Presentation::Style]

data/lib/vedeu/dsl/border.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/cursors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to help configure and use Vedeu.
@@ -64,7 +66,7 @@ module Vedeu
     def method_missing(method, *args, &block)
       Vedeu.log(type:    :debug,
                 message: "!!!method_missing '#{method}' " \
-                         "(#{client.inspect})".freeze)
+                         "(#{client.inspect})")
 
       client.send(method, *args, &block) if client
     end

data/lib/vedeu/dsl/elements.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL
 
+    # @todo This documentation needs editing and is out of date.
+    # (GL: 2015-12-25)
+    #
     # Provides methods to be used to define views.
     #
     #   Vedeu.renders do
@@ -55,7 +60,8 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock|Vedeu::Error::Fatal]
+      # @macro raise_requires_block
+      # @raise [Vedeu::Error::Fatal]
       # @return [void]
       def lines(&block)
         requires_block!(&block)
@@ -111,7 +117,7 @@ module Vedeu
 
         else
           fail Vedeu::Error::Fatal,
-               "Cannot add line to '#{model.class.name}' model.".freeze
+               "Cannot add line to '#{model.class.name}' model."
 
         end
       end
@@ -139,7 +145,8 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock|Vedeu::Error::Fatal]
+      # @macro raise_requires_block
+      # @raise [Vedeu::Error::Fatal]
       # @return [void]
       def streams(&block)
         requires_block!(&block)
@@ -187,7 +194,7 @@ module Vedeu
 
         else
           fail Vedeu::Error::Fatal,
-               "Cannot add line to '#{model.class.name}' model.".freeze
+               "Cannot add line to '#{model.class.name}' model."
 
         end
       end
@@ -264,7 +271,7 @@ module Vedeu
 
         else
           fail Vedeu::Error::Fatal,
-               "Cannot add text to '#{model.class.name}' model.".freeze
+               "Cannot add text to '#{model.class.name}' model."
 
         end
       end
@@ -305,8 +312,7 @@ module Vedeu
       end
 
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock] When the required block
-      #   is not given.
+      # @macro raise_requires_block
       # @return [NilClass]
       def requires_block!(&block)
         fail Vedeu::Error::RequiresBlock unless block_given?
@@ -317,7 +323,7 @@ module Vedeu
       # @return [NilClass]
       def requires_model!
         fail Vedeu::Error::Fatal,
-             'No model, cannot continue.'.freeze unless present?(model)
+             'No model, cannot continue.' unless present?(model)
       end
 
       # Returns a boolean indicating the model is a

data/lib/vedeu/dsl/geometry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/presentation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/string/align.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/string/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provides a mechanism to help configure and use Vedeu.

data/lib/vedeu/dsl/string/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/string/truncate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/string/wordwrap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL
@@ -116,7 +118,7 @@ module Vedeu
       def ellipsis_string(string)
         return prune_string(string) if string.size < ellipsis.size
 
-        "#{prune_string(string)}#{ellipsis}".freeze
+        "#{prune_string(string)}#{ellipsis}"
       end
 
       # Returns the string pruned.

data/lib/vedeu/dsl/use.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL

data/lib/vedeu/dsl/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL
@@ -61,7 +63,7 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @macro raise_requires_block
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def view(name = '', &block)
         fail Vedeu::Error::RequiresBlock unless block_given?
@@ -95,9 +97,9 @@ module Vedeu
       def template_for(name, filename, object = nil, options = {})
         fail Vedeu::Error::MissingRequired,
              'Cannot render template without the name of the ' \
-             'view.'.freeze unless name
+             'view.' unless name
         fail Vedeu::Error::MissingRequired,
-             'Cannot render template without a filename.'.freeze unless filename
+             'Cannot render template without a filename.' unless filename
 
         options.merge!(name: name)
 

data/lib/vedeu/dsl/views.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module DSL
@@ -130,7 +132,7 @@ module Vedeu
         # @param block [Proc] The directives you wish to send to
         #   render. Typically includes `view` with associated
         #   sub-directives.
-        # @raise [Vedeu::Error::RequiresBlock]
+        # @macro raise_requires_block
         # @return [Array<View>]
         def renders(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?
@@ -175,7 +177,7 @@ module Vedeu
         # @param block [Proc] The directives you wish to send to
         #   render. Typically includes `view` with associated
         #   sub-directives.
-        # @raise [Vedeu::Error::RequiresBlock]
+        # @macro raise_requires_block
         # @return [Array<View>]
         def views(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?

data/lib/vedeu/editor/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provide a mechanism to edit individual lines of the view.

data/lib/vedeu/editor/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Editor