vedeu_cli 0.0.1

data/lib/vedeu/cli/application.rb

@@ -0,0 +1,133 @@
+module Vedeu
+
+  module CLI
+
+    # Generates the client application directory and file structure.
+    #
+    # @example
+    #   ```bash
+    #   vedeu new your_app_name_here
+    #   ```
+    #
+    # :nocov:
+    class Application
+
+      include Vedeu::CLI::Helpers
+
+      # @param name [String] The name of the application.
+      # @return [Vedeu::CLI::Application]
+      def self.generate(name)
+        new(name).generate
+      end
+
+      # Returns a new instance of Vedeu::CLI::Application.
+      #
+      # @param name [String] The name of the application.
+      # @return [Vedeu::CLI::Application]
+      def initialize(name)
+        @name = name
+      end
+
+      # @return [void]
+      def generate
+        make_directory_structure
+
+        copy_app_root_files
+        copy_application_bootstrapper
+        copy_application_controller
+        copy_application_helper
+        copy_global_keymap
+        copy_application_executable
+        make_application_executable
+        copy_configuration
+        copy_app_name
+      end
+
+      private
+
+      # @return [void]
+      def make_directory_structure
+        directories.each { |directory| make_directory(name + directory) }
+      end
+
+      # @return [void]
+      def copy_application_bootstrapper
+        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',
+                  app_controllers_path + 'application_controller.rb')
+      end
+
+      # @return [void]
+      def copy_application_executable
+        copy_file(source + '/bin/name', app_bin_path + "#{name}")
+      end
+
+      # @return [void]
+      def copy_application_helper
+        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',
+                  app_config_path + 'configuration.rb')
+      end
+
+      # @return [void]
+      def copy_app_name
+        make_file(source + '/config/app_name.erb',
+                  app_config_path + 'app_name')
+      end
+
+      # @return [void]
+      def copy_app_root_files
+        [
+          '/Gemfile',
+          '/.gitignore',
+          '/LICENSE.txt',
+          '/README.md',
+          '/.ruby-version',
+        ].each do |file|
+          copy_file((source + file), (app_root_path + file))
+        end
+      end
+
+      # @return [void]
+      def make_application_executable
+        FileUtils.chmod(0755, "#{name}/bin/#{name}")
+      end
+
+      # @return [void]
+      def copy_global_keymap
+        copy_file(source + '/app/models/keymaps/_global_.rb',
+                  app_keymaps_path + '_global_.rb')
+      end
+
+      # @return [Array<String>]
+      def directories
+        [
+          '/app/controllers',
+          '/app/helpers',
+          '/app/models/keymaps',
+          '/app/views/interfaces',
+          '/app/views/templates',
+          '/bin',
+          '/config',
+          '/lib',
+          '/test',
+          '/vendor',
+        ]
+      end
+
+    end # Application
+    # :nocov:
+
+  end # CLI
+
+end # Vedeu

data/lib/vedeu/cli/helpers.rb

@@ -0,0 +1,139 @@
+module Vedeu
+
+  module CLI
+
+    # Provides functionality used by the generators to build the client
+    # application.
+    #
+    # :nocov:
+    module Helpers
+
+      include Vedeu::Common
+
+      # @return [String]
+      def app_name
+        @app_name ||= File.read('./config/app_name')
+      end
+
+      # @return [String]
+      def app_bin_path
+        name + '/bin/'
+      end
+
+      # @return [String]
+      def app_config_path
+        name + '/config/'
+      end
+
+      # @return [String]
+      def app_controllers_path
+        name + '/app/controllers/'
+      end
+
+      # @return [String]
+      def app_helpers_path
+        name + '/app/helpers/'
+      end
+
+      # @return [String]
+      def app_models_path
+        name + '/app/models/'
+      end
+
+      # @return [String]
+      def app_keymaps_path
+        name + '/app/models/keymaps/'
+      end
+
+      # @return [String]
+      def app_views_path
+        name + '/app/views/'
+      end
+
+      # @param destination [String]
+      # @return [void]
+      def make_directory(destination)
+        Vedeu.log_stdout(type: :create, message: "#{destination}")
+
+        FileUtils.mkdir_p(destination)
+      end
+
+      # @param source [String]
+      # @param destination [String]
+      # @return [void]
+      def copy_file(source, destination)
+        if File.exist?(destination)
+          skipped_file(destination)
+
+        else
+          Vedeu.log_stdout(type: :create, message: "#{destination}")
+
+          FileUtils.cp(source, destination)
+        end
+      end
+
+      # @param source [String]
+      # @param destination [String]
+      # @return [void]
+      def make_file(source, destination)
+        if File.exist?(destination)
+          skipped_file(destination)
+
+        else
+          Vedeu.log_stdout(type: :create, message: "#{destination}")
+
+          File.write(destination, parse(source))
+        end
+      end
+
+      # @param destination [String]
+      # @return [void]
+      def skipped_file(destination)
+        Vedeu.log_stdout(type:    :create,
+                         message: "#{destination} " +
+                                  Esc.red { 'already exists, skipped.' })
+      end
+
+      # @param destination [String]
+      # @return [void]
+      def touch_file(destination)
+        Vedeu.log_stdout(type: :create, message: "#{destination}")
+
+        FileUtils.touch(destination)
+      end
+
+      # @return [String]
+      def name
+        @_name ||= @name.downcase
+      end
+      alias_method :app_root_path, :name
+
+      # @return [String]
+      def name_as_class
+        name.downcase.split(/_|-/).map(&:capitalize).join
+      end
+
+      # @return [String]
+      def output(message = '')
+        Vedeu.log_stdout(type: :info, message: message)
+
+        message
+      end
+
+      # @param source [String]
+      # @return [String]
+      def parse(source)
+        Vedeu::Templating::Template.parse(self, source)
+      end
+
+      # @return [String]
+      def source
+        File.dirname(__FILE__) + '/templates/application/.'
+      end
+
+    end # Helpers
+    # :nocov:
+
+  end # CLI
+
+end # Vedeu

data/lib/vedeu/cli/main.rb

@@ -0,0 +1,39 @@
+module Vedeu
+
+  # Provide a command line interface to Vedeu.
+  #
+  module CLI
+
+    # The main command line interface commands.
+    #
+    class Main < Thor
+
+      desc 'new <name>', 'Create a skeleton Vedeu client application.'
+      # @param name [String]
+      # @return [String]
+      def new(name)
+        say(Vedeu::CLI::Application.generate(name))
+      end
+
+      # 'Specify the interface name lowercase snakecase; e.g. main_interface'
+
+      desc 'view <name>',
+           'Create a new interface within the client application.'
+      # @param name [String]
+      # @return [String]
+      def view(name)
+        Vedeu::CLI::View.generate(name)
+      end
+
+      desc 'version',
+           'Print the version.'
+      # @return [String]
+      def version
+        say("vedeu #{Vedeu::VERSION} (vedeu_cli #{Vedeu::CLI::VERSION})")
+      end
+
+    end # Main
+
+  end # CLI
+
+end # Vedeu

data/lib/vedeu/cli/templates/application/.gitignore

@@ -0,0 +1 @@
+log/**/*

data/lib/vedeu/cli/templates/application/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/lib/vedeu/cli/templates/application/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'vedeu'
+# gem 'ruby-prof' # uncomment when using the `debug!` configuration option.

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

@@ -0,0 +1,24 @@
+Copyright (c) 2014 Your Name Here
+
+Note: You may wish to change this license to suit your legal needs.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vedeu/cli/templates/application/README.md

@@ -0,0 +1,18 @@
+# <%= object.name_as_class %>
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Dependencies
+
+* Installation
+
+* Configuration
+
+* Runtime instructions
+
+* How to contribute
+
+* Author information

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

@@ -0,0 +1,7 @@
+module <%= object.name_as_class %>
+
+  class ApplicationController < Vedeu::ApplicationController
+
+  end
+
+end

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

@@ -0,0 +1,22 @@
+require_relative 'application_controller'
+require_relative '../views/<%= object.name %>'
+
+module <%= object.app_name %>
+
+  class <%= object.name_as_class %>Controller < <%= object.app_name -%>::ApplicationController
+
+    controller :<%= object.name %>
+    action :list
+    action :show
+    # add more actions and implement or remove existing actions
+
+    def list
+    end
+
+    def show
+      <%= object.app_name %>::<%= object.name_as_class %>View.render(params)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,9 @@
+module <%= object.name_as_class %>
+
+  module ApplicationHelper
+
+    include Vedeu::ApplicationHelper
+
+  end
+
+end

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

@@ -0,0 +1,11 @@
+require_relative 'application_helper'
+
+module <%= object.app_name %>
+
+  module <%= object.name_as_class %>Helper
+
+    include <%= object.app_name -%>::ApplicationHelper
+
+  end
+
+end

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

@@ -0,0 +1,8 @@
+Vedeu.keymap('_global_') do
+  # see http://www.rubydoc.info/gems/vedeu/Vedeu/DSL/Keymap
+
+  key('q')        { Vedeu.trigger(:_exit_) }
+  key(:esc)       { Vedeu.trigger(:_mode_switch_) }
+  key(:shift_tab) { Vedeu.trigger(:_focus_previous_) }
+  key(:tab)       { Vedeu.trigger(:_focus_next_) }
+end

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

@@ -0,0 +1,3 @@
+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/name.erb

@@ -0,0 +1,67 @@
+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
+
+  # background
+
+  # colour
+
+  # cursor!
+
+  # See Vedeu::DSL::Interface#delay
+  # delay 1.0
+
+  # focus!
+
+  # foreground
+
+  # geometry do
+    # centred!
+    # x      1
+    # y      1
+    # xn     11
+    # yn     11
+    # height 10
+    # width  10
+  # end
+
+  # group ''
+
+  # hide!
+
+  # show!
+
+  # style
+
+  # zindex
+end

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

@@ -0,0 +1,36 @@
+module <%= object.app_name %>
+
+  class <%= object.name_as_class %>View < Vedeu::ApplicationView
+
+    def render
+      Vedeu.renders do
+
+        # Build up the view programmatically...
+        #
+        # view '<%= object.name %>' do
+        #   lines do
+        #     line 'some content...'
+        #   end
+        # end
+
+        # ...or use the template in 'app/views/templates/<%= object.name %>'
+        #
+        template_for('<%= object.name %>',
+                     template('<%= object.name %>'),
+                     object,
+                     options)
+      end
+    end
+
+    private
+
+    def object
+    end
+
+    def options
+      {}
+    end
+
+  end
+
+end

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

@@ -0,0 +1,22 @@
+require_relative 'config/configuration'
+# When manually setting the entry point below, uncomment this line:
+# require_relative 'app/controllers/some_controller'
+
+module <%= object.name_as_class %>
+
+  class Application
+
+    # Change this to be the controller you would like to start the
+    # application from.
+    #
+    # def self.entry_point
+    #   <%= object.name_as_class %>::SomeController.new
+    # end
+
+    # Vedeu::Bootstrap.start(ARGV, entry_point)
+
+    Vedeu::Bootstrap.start(ARGV)
+
+  end
+
+end

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+
+require 'vedeu'
+
+require_relative '../application'

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

@@ -0,0 +1 @@
+<%= object.name_as_class -%>

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

@@ -0,0 +1,33 @@
+Vedeu.configure do
+  # base_path
+
+  # colour_mode 16_777_216 # Some terminals don't render colour at all when this
+                           # value is not one of 8, 16, 256 or 16777216.
+
+  # compression false
+
+  # debug! # Requires "gem 'ruby-prof'" in your Gemfile.
+  # drb!
+  # drb_host    'localhost'
+  # drb_port    21420
+  # drb_width   80
+  # drb_height  25
+
+  # terminal_mode :raw
+  # cooked!
+  # raw!
+
+  log         "/tmp/<%= object.name %>.log"
+
+  # renderers
+
+  # run_once!
+
+  # interactive!
+  # standalone!
+
+  # Not used yet
+  # stdin  File.open("/dev/tty", "r")
+  # stdout File.open("/dev/tty", "w")
+  # stderr File.open("/tmp/vedeu_error.log", "w+")
+end

data/lib/vedeu/cli/version.rb

@@ -0,0 +1,10 @@
+module Vedeu
+
+  module CLI
+
+    # The current version of Vedeu CLI.
+    VERSION = '0.0.1'
+
+  end # CLI
+
+end # Vedeu