vedeu_cli 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 458779e8041e6792549e064d5babdca2436a4d6d
-  data.tar.gz: fbdc956a222698a138133ae92ba80103ae9913f9
+  metadata.gz: a24a490252f117afc78c725535d98bdc727e6af7
+  data.tar.gz: 0163be54e79077f0d4eeb8d1d6ded1c746409833
 SHA512:
-  metadata.gz: 7922f71b7ff9b8b97f044480b0bb6172c2ed67580f5fa8038a5638be3b26da0d80bbd0b4c886cb89917d545281a923e68b26cc096eb7ad50aa225f4ace6b779e
-  data.tar.gz: e9abd0bbdaeef46181a0236fc5f7468a6ce0978b003f5c5e2ab7e6fade8e0f9b9047d2cb09542cde6c6f3909fddeaa75b0cd086cbbac1c3d0aa928d86d2ee503
+  metadata.gz: 306836f843ea9eca961fbbe6213462c3e1b0249bdf03c10aa6d1713c9963b0d84431094c074f86c91df3bfac03e9a5db0bb65b49cc3e20c78b5abc442b6f5a9b
+  data.tar.gz: 81bbfb73eaa2c9de2568b7cb153f568d0ddf939a4aff38d42aff44f047c1bb35de7e0c75c33675895eb10bcc0a09bf961ae0e28419f6e1f3826751cbcaeca9aa

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.0

data/lib/vedeu/cli/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module CLI
@@ -52,14 +54,14 @@ module Vedeu
 
       # @return [void]
       def copy_application_bootstrapper
-        make_file(source + '/application.erb'.freeze,
-                  app_root_path + '/application.rb'.freeze)
+        make_file(source + '/application.erb',
+                  app_root_path + '/application.rb')
       end
 
       # @return [void]
       def copy_application_controller
-        make_file(source + '/app/controllers/application_controller.erb'.freeze,
-                  app_controllers_path + 'application_controller.rb'.freeze)
+        make_file(source + '/app/controllers/application_controller.erb',
+                  app_controllers_path + 'application_controller.rb')
       end
 
       # @return [void]
@@ -69,30 +71,30 @@ module Vedeu
 
       # @return [void]
       def copy_application_helper
-        make_file(source + '/app/helpers/application_helper.erb'.freeze,
-                  app_helpers_path + 'application_helper.rb'.freeze)
+        make_file(source + '/app/helpers/application_helper.erb',
+                  app_helpers_path + 'application_helper.rb')
       end
 
       # @return [void]
       def copy_configuration
-        make_file(source + '/config/configuration.erb'.freeze,
-                  app_config_path + 'configuration.rb'.freeze)
+        make_file(source + '/config/configuration.erb',
+                  app_config_path + 'configuration.rb')
       end
 
       # @return [void]
       def copy_app_name
-        make_file(source + '/config/app_name.erb'.freeze,
-                  app_config_path + 'app_name'.freeze)
+        make_file(source + '/config/app_name.erb',
+                  app_config_path + 'app_name')
       end
 
       # @return [void]
       def copy_app_root_files
         [
-          '/Gemfile'.freeze,
-          '/.gitignore'.freeze,
-          '/LICENSE.txt'.freeze,
-          '/README.md'.freeze,
-          '/.ruby-version'.freeze,
+          '/Gemfile',
+          '/.gitignore',
+          '/LICENSE.txt',
+          '/README.md',
+          '/.ruby-version',
         ].each do |file|
           copy_file((source + file), (app_root_path + file))
         end
@@ -100,29 +102,31 @@ module Vedeu
 
       # @return [void]
       def make_application_executable
-        FileUtils.chmod(0755, "#{name}/bin/#{name}".freeze)
+        FileUtils.chmod(0755, "#{name}/bin/#{name}")
       end
 
       # @return [void]
       def copy_global_keymap
-        copy_file(source + '/app/models/keymaps/_global_.rb'.freeze,
-                  app_keymaps_path + '_global_.rb'.freeze)
+        copy_file(source + '/app/models/keymaps/_global_.rb',
+                  app_keymaps_path + '_global_.rb')
       end
 
       # @return [Array<String>]
       def directories
         [
-          '/app/controllers'.freeze,
-          '/app/helpers'.freeze,
-          '/app/models/keymaps'.freeze,
-          '/app/views/interfaces'.freeze,
-          '/app/views/templates'.freeze,
-          '/bin'.freeze,
-          '/config'.freeze,
-          '/lib'.freeze,
-          '/log'.freeze,
-          '/test'.freeze,
-          '/vendor'.freeze,
+          '/app/controllers',
+          '/app/helpers',
+          '/app/models/keymaps',
+          '/app/views/interfaces',
+          '/app/views/interfaces/borders',
+          '/app/views/interfaces/geometries',
+          '/app/views/templates',
+          '/bin',
+          '/config',
+          '/lib',
+          '/log',
+          '/test',
+          '/vendor',
         ]
       end
 

data/lib/vedeu/cli/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module CLI
@@ -12,42 +14,52 @@ module Vedeu
 
       # @return [String]
       def app_name
-        @app_name ||= File.read('./config/app_name'.freeze)
+        @app_name ||= File.read('./config/app_name' )
       end
 
       # @return [String]
       def app_bin_path
-        name + '/bin/'.freeze
+        name + '/bin/'
       end
 
       # @return [String]
       def app_config_path
-        name + '/config/'.freeze
+        name + '/config/'
       end
 
       # @return [String]
       def app_controllers_path
-        name + '/app/controllers/'.freeze
+        name + '/app/controllers/'
       end
 
       # @return [String]
       def app_helpers_path
-        name + '/app/helpers/'.freeze
+        name + '/app/helpers/'
       end
 
       # @return [String]
       def app_models_path
-        name + '/app/models/'.freeze
+        name + '/app/models/'
+      end
+
+      # @return [String]
+      def app_borders_path
+        name + '/app/views/interfaces/borders/'
+      end
+
+      # @return [String]
+      def app_geometries_path
+        name + '/app/views/interfaces/geometries/'
       end
 
       # @return [String]
       def app_keymaps_path
-        name + '/app/models/keymaps/'.freeze
+        name + '/app/models/keymaps/'
       end
 
       # @return [String]
       def app_views_path
-        name + '/app/views/'.freeze
+        name + '/app/views/'
       end
 
       # @param destination [String]
@@ -78,49 +90,49 @@ module Vedeu
         end
       end
 
-      # @param source [String]
-      # @param destination [String]
+      # @param source_path [String]
+      # @param destination_path [String]
       # @return [void]
-      def make_file(source, destination)
-        if File.exist?(destination)
-          log_skipped_file(destination)
+      def make_file(source_path, destination_path)
+        if File.exist?(destination_path)
+          log_skipped_file(destination_path)
 
           false
 
         else
-          log_processed_file(destination)
+          log_processed_file(destination_path)
 
-          File.write(destination, parse(source))
+          File.write(destination_path, parse(source_path))
 
           true
         end
       end
 
-      # @param destination [String]
+      # @param destination_path [String]
       # @return [TrueClass]
-      def log_processed_file(destination)
-        Vedeu.log_stdout(type: :create, message: "#{destination}".freeze)
+      def log_processed_file(destination_path)
+        Vedeu.log_stdout(type: :create, message: "#{destination_path}")
 
         true
       end
 
-      # @param destination [String]
+      # @param destination_path [String]
       # @return [TrueClass]
-      def log_skipped_file(destination)
+      def log_skipped_file(destination_path)
         Vedeu.log_stdout(type:    :create,
-                         message: "#{destination} " +
+                         message: "#{destination_path} " +
                                   Vedeu::EscapeSequences::Esc.red {
                                     'already exists, skipped.'
                                   })
         true
       end
 
-      # @param destination [String]
+      # @param destination_path [String]
       # @return [void]
-      def touch_file(destination)
-        log_processed_file(destination)
+      def touch_file(destination_path)
+        log_processed_file(destination_path)
 
-        FileUtils.touch(destination)
+        FileUtils.touch(destination_path)
 
         true
       end
@@ -145,13 +157,13 @@ module Vedeu
 
       # @param source [String]
       # @return [String]
-      def parse(source)
-        Vedeu::Templating::Template.parse(self, source)
+      def parse(source_path)
+        Vedeu::Templating::Template.parse(self, source_path)
       end
 
       # @return [String]
       def source
-        File.dirname(__FILE__) + '/templates/application/.'.freeze
+        File.dirname(__FILE__) + '/templates/application/.'
       end
 
     end # Helpers

data/lib/vedeu/cli/main.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # Provide a command line interface to Vedeu.

data/lib/vedeu/cli/templates/application/LICENSE.txt

@@ -1,6 +1,9 @@
 Copyright (c) 2014 Your Name Here
+Copyright (c) 2014 Gavin Laking (Vedeu)
 
-Note: You may wish to change this license to suit your legal needs.
+Note: You may wish to change this license to suit your legal needs,
+but please leave the copyright notice of Vedeu in place or add it to
+your new `LICENSE.txt` file.
 
 MIT License
 

data/lib/vedeu/cli/templates/application/app/controllers/application_controller.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module <%= object.name_as_class %>
 
   class ApplicationController < Vedeu::ApplicationController

data/lib/vedeu/cli/templates/application/app/controllers/name.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'application_controller'
 require_relative '../views/<%= object.name %>'
 

data/lib/vedeu/cli/templates/application/app/helpers/application_helper.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module <%= object.name_as_class %>
 
   module ApplicationHelper

data/lib/vedeu/cli/templates/application/app/helpers/name.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'application_helper'
 
 module <%= object.app_name %>

data/lib/vedeu/cli/templates/application/app/models/keymaps/_global_.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Vedeu.keymap('_global_') do
   # see http://www.rubydoc.info/gems/vedeu/Vedeu/DSL/Keymap
 

data/lib/vedeu/cli/templates/application/app/models/keymaps/name.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Vedeu.keymap('<%= object.name %>') do
   # see http://www.rubydoc.info/gems/vedeu/Vedeu/DSL/Keymap
 end

data/lib/vedeu/cli/templates/application/app/views/interfaces/borders/name.erb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Defines a border for the interface/view with the same name.
+#
+Vedeu.border '<%= object.name %>' do
+  # Define colour and style of border
+  #
+  # colour foreground: '#ffffff', background: '#000000'
+  # style  'normal'
+
+  # Define visibility of border. Uncomment one of these:
+  #
+  # enable!
+  # disable!
+
+  # Individually control the visibility of each border:
+  #
+  # hide_bottom!
+  # hide_left!
+  # hide_right!
+  # hide_top!
+  #
+  # show_bottom!
+  # show_left!
+  # show_right!
+  # show_top!
+
+  # Define characters used to draw border:
+  #
+  # Corners:
+  #
+  # bottom_right '+'
+  # bottom_left  '+'
+  # top_right    '+'
+  # top_left     '+'
+  #
+  # Sides:
+  #
+  # horizontal   '-'
+  # vertical     '|'
+
+  # Define the title of the interface, this is displayed in the top
+  # border.
+  #
+  # title '<%= object.name %>'
+
+  # Define the caption of the interface, this is displayed in the
+  # bottom border.
+  #
+  # caption ''
+end

data/lib/vedeu/cli/templates/application/app/views/interfaces/geometries/name.erb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Defines the geometry for the interface/view with the same name.
+#
+Vedeu.geometry '<%= object.name %>' do
+  # Uncomment this and provide a height and width to centrally align
+  # the interface in the terminal.
+  #
+  # centred!
+
+  # Uncomment this to use all available space in the terminal.
+  #
+  # maximised!
+
+  # Set the height and width of the interface.
+  # - If 'centred!' is set, then the y, x coordinates will be
+  #   calculated automatically.
+  # - If 'centred! is not set, then the y, x coordinates will be 1, 1.
+  # - If 'x' and/or 'y' coordinate(s) are set, then they will be the
+  #   starting coordinates.
+  # - If 'xn' and/or 'yn' coordinate(s) are set, then either/both
+  #   height and width will be ignored.
+  #
+  # height 10
+  # width  10
+
+  # Set the width via the x (start), or xn (end) coordinates.
+  # x      1
+  # xn     11
+
+  # Set the height via the y (start), or yn (end) coordinates.
+  # y      1
+  # yn     11
+end

data/lib/vedeu/cli/templates/application/app/views/interfaces/name.erb

@@ -1,67 +1,50 @@
-Vedeu.interface '<%= object.name %>' do
-  # border do
-    # Define colour and style of border
-    # colour foreground: '#ffffff', background: '#000000'
-    # style  'normal'
-
-    # Define visibility of border
-    #
-    # Uncomment one of these:
-    # enable!
-    # disable!
-    #
-    # Individually control each border:
-    # hide_bottom!
-    # hide_left!
-    # hide_right!
-    # hide_top!
-    # show_bottom!
-    # show_left!
-    # show_right!
-    # show_top!
-
-    # Define characters used to draw border
-    # bottom_right '+'
-    # bottom_left  '+'
-    # horizontal   '-'
-    # top_right    '+'
-    # top_left     '+'
-    # vertical     '|'
-
-    # Define the title of the interface
-    # title '<%= object.name %>'
-  # end
+# frozen_string_literal: true
 
-  # background
+# Defines an interface.
+#
+Vedeu.interface '<%= object.name %>' do
+  # Define the colour of the interface:
+  #
+  # background '#000000'
+  # foreground '#ffffff'
 
-  # colour
+  # Define the colour of the interface concisely:
+  #
+  # colour background: '#000000', foreground: '#ffffff'
 
-  # cursor!
+  # Define whether the interface should have a cursor (can be
+  # overridden by the view):
+  #
+  # cursor!    # => same as `cursor(true)`
+  # no_cursor! # => same as `cursor(false)`
 
   # See Vedeu::DSL::Interface#delay
   # delay 1.0
 
+  # Uncomment to indicate this interface as having focus at startup.
+  # Note: If multiple interfaces are set to have focus on startup,
+  #       the last defined will have focus.
+  #
   # focus!
 
-  # foreground
-
-  # geometry do
-    # centred!
-    # x      1
-    # y      1
-    # xn     11
-    # yn     11
-    # height 10
-    # width  10
-  # end
-
+  # Define the group the interface belongs to. Allowing multiple
+  # interfaces to be manipulated at once.
+  #
   # group ''
 
+  # Define visibility of the interface.
+  #
   # hide!
-
   # show!
 
-  # style
+  # Define the default style for the interface, this affects all
+  # characters in the interface unless overridden on a per-line,
+  # per-stream or per-character basis.
+  #
+  # style :normal
 
-  # zindex
+  # Interfaces with a higher zindex will be display on top of
+  # interfaces with a lower zindex.
+  #
+  # zindex 1
 end

data/lib/vedeu/cli/templates/application/app/views/name.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module <%= object.app_name %>
 
   class <%= object.name_as_class %>View < Vedeu::ApplicationView

data/lib/vedeu/cli/templates/application/app/views/templates/name.erb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/vedeu/cli/templates/application/bin/name

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 
 require 'bundler/setup' # Set up gems listed in the Gemfile.

data/lib/vedeu/cli/templates/application/config/configuration.erb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Vedeu.configure do
   # see http://rubydoc.info/gems/vedeu/file/docs/configuration.md
 
@@ -31,7 +33,7 @@ Vedeu.configure do
   # standalone!
 
   # Not used yet
-  # stdin  File.open("/dev/tty", "r")
-  # stdout File.open("/dev/tty", "w")
-  # stderr File.open("/tmp/vedeu_error.log", "w+")
+  # stdin  File.open('/dev/tty', 'r')
+  # stdout File.open('/dev/tty', 'w')
+  # stderr File.open(Dir.tmpdir + '/vedeu_error.log', 'w+')
 end

data/lib/vedeu/cli/version.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module CLI
 
     # The current version of Vedeu CLI.
-    VERSION = '0.0.8'.freeze
+    VERSION = '0.0.9'
 
   end # CLI
 

data/lib/vedeu/cli/view.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module CLI
@@ -32,6 +34,8 @@ module Vedeu
         make_controller_file
         make_helper_file
         make_keymap_file
+        make_border_file
+        make_geometry_file
         make_interface_file
         make_template_file
         make_view_class_file
@@ -41,44 +45,56 @@ module Vedeu
                "controller and action: (args are optional)\n\n" \
                "Vedeu.configure do\n" \
                "  root :some_controller, :show, *args\n" \
-               "end\n\n".freeze)
+               "end\n\n")
       end
 
       private
 
       # @return [void]
       def make_controller_file
-        make_file(source + '/app/controllers/name.erb'.freeze,
-                  '.' + "/app/controllers/#{name}_controller.rb".freeze)
+        make_file(source + '/app/controllers/name.erb',
+                  "./app/controllers/#{name}_controller.rb")
       end
 
       # @return [void]
       def make_helper_file
-        make_file(source + '/app/helpers/name.erb'.freeze,
-                  '.' + "/app/helpers/#{name}_helper.rb".freeze)
+        make_file(source + '/app/helpers/name.erb',
+                  "./app/helpers/#{name}_helper.rb")
       end
 
       # @return [void]
       def make_keymap_file
-        make_file(source + '/app/models/keymaps/name.erb'.freeze,
-                  '.' + "/app/models/keymaps/#{name}.rb".freeze)
+        make_file(source + '/app/models/keymaps/name.erb',
+                  "./app/models/keymaps/#{name}.rb")
+      end
+
+      # @return [void]
+      def make_border_file
+        make_file(source + '/app/views/interfaces/borders/name.erb',
+                  "./app/views/interfaces/borders/#{name}.rb")
+      end
+
+      # @return [void]
+      def make_geometry_file
+        make_file(source + '/app/views/interfaces/geometries/name.erb',
+                  "./app/views/interfaces/geometries/#{name}.rb")
       end
 
       # @return [void]
       def make_interface_file
-        make_file(source + '/app/views/interfaces/name.erb'.freeze,
-                  '.' + "/app/views/interfaces/#{name}.rb".freeze)
+        make_file(source + '/app/views/interfaces/name.erb',
+                  "./app/views/interfaces/#{name}.rb")
       end
 
       # @return [void]
       def make_template_file
-        touch_file('.' + "/app/views/templates/#{name}.erb".freeze)
+        touch_file("./app/views/templates/#{name}.erb")
       end
 
       # @return [void]
       def make_view_class_file
-        make_file(source + '/app/views/name.erb'.freeze,
-                  '.' + "/app/views/#{name}.rb".freeze)
+        make_file(source + '/app/views/name.erb',
+                  "./app/views/#{name}.rb")
       end
 
     end # View

data/lib/vedeu_cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'vedeu'
 

data/test/lib/vedeu/cli/application_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Vedeu

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Vedeu

data/test/lib/vedeu/cli/main_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Vedeu

data/test/lib/vedeu/cli/version_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Vedeu

data/test/lib/vedeu/cli/view_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 module Vedeu

data/test/lib/vedeu_cli_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 describe Vedeu do

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'simplecov-console' if ENV['CONSOLE_COVERAGE']
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -239,6 +239,8 @@ files:
 - lib/vedeu/cli/templates/application/app/helpers/name.erb
 - lib/vedeu/cli/templates/application/app/models/keymaps/_global_.rb
 - lib/vedeu/cli/templates/application/app/models/keymaps/name.erb
+- lib/vedeu/cli/templates/application/app/views/interfaces/borders/name.erb
+- lib/vedeu/cli/templates/application/app/views/interfaces/geometries/name.erb
 - lib/vedeu/cli/templates/application/app/views/interfaces/name.erb
 - lib/vedeu/cli/templates/application/app/views/name.erb
 - lib/vedeu/cli/templates/application/app/views/templates/name.erb
@@ -280,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A plugin for Vedeu.