vedeu 0.4.35 → 0.4.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84b194d5028029767ac815eb90fee5806af559ed
-  data.tar.gz: ecce8b75baa7b87fd03f18ffb491034659febff9
+  metadata.gz: 2ecad92f4001170f4fa870a5738639b549bd5030
+  data.tar.gz: aebc0c775c358a62c309bdfba93d58d01077c662
 SHA512:
-  metadata.gz: cf0641babb32ff61b8511a02c7898cabc04c0622b16557c72a5b61590caf7dea14b5eae9c3b5ebfcfb4ef8d51dd988f41a79b92cecb589e0be45c54cd1d68484
-  data.tar.gz: a9c5358c3c7b08293b26b8f57f3d3f69ed352b58184a684a54b8b16bfdf3349e0784ba62750ef8b82d51549fed272ffd3b339bd1f3bd1a4e3cd8a4b2ed09f487
+  metadata.gz: 2fe008b535bc415a6a7c6829ebf256bc0913edf2fe5d2abc4808e8e8ea67d9ee7e8ca9e14286de8d5829617abd381f47dfe070117190194468f796b2f707dc25
+  data.tar.gz: d822a5e46f9c3897c49eb7edb65f4ecb2c32b61a5bc0c62ac1f2b6080febebcfc439d80e81e0e8832ca392f08b6fa9b6fc375e1ff15b08cc22e29f7154aeccc5

data/.rubocop.yml

@@ -368,6 +368,9 @@ Style/LambdaCall:
     - call
     - braces
 
+Style/ModuleFunction:
+  Enabled: false
+
 Style/Next:
   # With `always` all conditions at the end of an iteration needs to be
   # replaced by next - with `skip_modifier_ifs` the modifier if like this one

data/Dockerfile

@@ -2,43 +2,39 @@ FROM ubuntu:15.04
 MAINTAINER Gavin Laking <gavinlaking@gmail.com>
 
 # Build dependencies
-RUN apt-get update
-RUN apt-get install -y --force-yes \
-        software-properties-common \
-        build-essential \
-        openssl \
-        ca-certificates \
-        git-core \
-        autoconf \
-        gawk \
-        libreadline-dev \
-        libyaml-dev \
-        libgdbm-dev \
-        libncurses5-dev \
-        automake \
-        libtool \
-        bison \
-        pkg-config \
-        curl \
-        wget \
-        libxslt-dev \
-        libxml2-dev \
-        libffi-dev \
-        libssl-dev \
-        zlib1g-dev \
-        make
-RUN apt-get clean -y
-RUN apt-get autoremove -y
+RUN apt-get update && apt-get install -y --force-yes \
+    software-properties-common \
+    build-essential \
+    openssl \
+    ca-certificates \
+    git-core \
+    autoconf \
+    gawk \
+    libreadline-dev \
+    libyaml-dev \
+    libgdbm-dev \
+    libncurses5-dev \
+    automake \
+    libtool \
+    bison \
+    pkg-config \
+    curl \
+    wget \
+    libxslt-dev \
+    libxml2-dev \
+    libffi-dev \
+    libssl-dev \
+    zlib1g-dev \
+    make
+RUN apt-get clean -y && apt-get autoremove -y
 
 # Chruby
 RUN wget -O chruby-0.3.9.tar.gz https://github.com/postmodern/chruby/archive/v0.3.9.tar.gz
-RUN tar -xzvf chruby-0.3.9.tar.gz
-RUN cd chruby-0.3.9/ && make install
+RUN tar -xzvf chruby-0.3.9.tar.gz && cd chruby-0.3.9/ && make install
 
 # Ruby Install
 RUN wget -O ruby-install-0.5.0.tar.gz https://github.com/postmodern/ruby-install/archive/v0.5.0.tar.gz
-RUN tar -xzvf ruby-install-0.5.0.tar.gz
-RUN cd ruby-install-0.5.0/ && make install
+RUN tar -xzvf ruby-install-0.5.0.tar.gz && cd ruby-install-0.5.0/ && make install
 
 # Install Ruby 2.2.2
 RUN ruby-install ruby 2.2.2
@@ -48,12 +44,37 @@ RUN echo '[ -n "$BASH_VERSION" ] || [ -n "$ZSH_VERSION" ] || return' >> /etc/pro
 RUN echo 'source /usr/local/share/chruby/chruby.sh' >> /etc/profile.d/chruby.sh
 RUN echo 'source /usr/local/share/chruby/auto.sh' >> $HOME/.bashrc
 RUN echo 'chruby ruby-2.2.2' >> $HOME/.bash_profile
-
-# Setup .gemrc
-RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:verbose: true\ngem: --no-ri --no-rdoc" > $HOME/.gemrc
+RUN echo "---\n:benchmark: false\n:bulk_threshold: 1000\n:backtrace: false\n:verbose: true\ngem: --no-ri --no-rdoc" >> $HOME/.gemrc
 
 # Setup PATH
-ENV PATH /opt/rubies/ruby-2.2.2/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+ENV PATH /opt/rubies/ruby-2.2.2/bin/:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/vedeu/gem/bin
 
 # Get ruby version
 RUN ruby -v
+
+# Create a fake home directory
+RUN usr/sbin/useradd --create-home --home-dir /home/vedeu --shell /bin/bash vedeu
+
+# Make files
+RUN mkdir /home/vedeu/gem
+RUN chown -R vedeu:vedeu /home/vedeu
+RUN gem install bundler
+
+# VOLUME .:/home/vedeu/gem
+
+ADD . /home/vedeu/gem/
+WORKDIR /home/vedeu
+USER vedeu
+
+# To build this file:
+#
+#     sudo docker build -t vedeu/my_first_app .
+#
+#
+# Once we're up and running, we can create a shell to the docker instance and
+# start running commands against it.
+#
+#     sudo docker run -it -v $PWD:/home/vedeu/gem:rw vedeu/my_first_app /bin/bash
+#
+#
+

data/bin/vedeu

@@ -1,15 +1,56 @@
 #!/usr/bin/env ruby
 
-lib_dir = File.dirname(__FILE__) + '/../lib'
-$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
-
-require 'vedeu/version'
-
-puts "Vedeu (#{Vedeu::VERSION})"
-puts ''
-puts 'Vedeu is a Ruby gem. This executable serves for a future in which ' \
-     'Vedeu can generate a starting point for your terminal-based GUI '   \
-     'application.'
-puts ''
-puts 'Please see: https://github.com/gavinlaking/vedeu for more details.'
-puts ''
+require 'rake'
+
+bundler_message = 'Bundler is required. Please install bundler with ' \
+                  "'gem install bundler'"
+
+begin
+  require 'bundler'
+
+rescue LoadError
+  puts bundler_message
+
+end
+
+fail bundler_message unless defined?(Bundler)
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# load Gem.bin_path('bundler', 'bundle')
+
+Bundler.setup
+
+Rake.application.init
+
+gem_dir = File.expand_path('..', File.dirname(__FILE__))
+$LOAD_PATH.unshift(gem_dir) unless $LOAD_PATH.include?(gem_dir)
+
+# Initialize vedeu
+require 'vedeu'
+
+# Load the rake tasks of vedeu
+load "#{gem_dir}/lib/vedeu/tasks/vedeu.rake"
+
+# Let's go!
+begin
+  if ARGV.empty?
+    print "\n\e[33mVedeu v#{Vedeu::VERSION}\e[39m\n\n"
+    print "\e[4m\e[36mUsage:\e[39m\e[24m\n\n"
+    print "\e[32m  vedeu new [app_name]\e[39m\n"
+    print "    Creates the skeleton file and directory structure for a new Vedeu client application.\n\n"
+    print "\e[32m  vedeu view [view_name]\e[39m\n"
+    print "    Creates a new view for Vedeu.\n"
+    print "\n\n"
+
+  else
+    Rake.application.invoke_task(ARGV.shift)
+
+  end
+
+rescue RuntimeError => exception
+  puts 'Vedeu Error: Either the task you specified failed, or the task could ' \
+       "not be built.\n"
+  puts "Exception: #{exception.class.name}"
+  puts "Message: #{exception.message}"
+
+end

data/docs/applications.md

@@ -0,0 +1,92 @@
+## Vedeu Applications
+
+Vedeu has basic tools to generate client application scaffolding, in a similar way to Ruby on Rails. Although not nearly as advanced as the Rails equivalent,
+hopefully these generators will get you off the ground.
+
+### Application Structure
+
+|
+|- app_name/
+|   |
+    |- app/
+    |   |- controllers
+    |   |- helpers
+    |   |- models
+    |   |    |- keymaps
+    |   |- views
+    |        |- interfaces
+    |        |- templates
+    |
+    |- bin
+    |- config
+    |- lib
+    |- test
+    |- vendor
+    |
+
+To create the application structure as shown above:
+  
+    vedeu new app_name
+
+Let's talk about each directory and its purpose.
+
+#### app/controllers
+
+The controllers directory is the place to store the events and behaviour logic
+of your application. It will manage the choosing of views and models based on
+previous choices. Think of them as the orchestrators of your application.
+
+In web applications, the controller typically handles the routed request and interacts with the models and sets up the views. In Vedeu, it does much the same, minus the requests.
+
+#### app/helpers
+
+Ruby on Rails has a concept of helpers which are not very object-oriented, but
+allow you to share functionality/behaviour across multiple views. Vedeu uses this concept as it will be familiar to many Rails developers and might be helpful to beginners.
+
+#### app/models
+
+Much like `lib`, this directory is for your application logic code. Some people
+prefer to use `app/models`, others like to use `lib`. Some even use both!
+
+#### app/models/keymaps
+
+This will contain the global keymap (which affects all of your application) plus any specific interface keymaps which only affect a certain interface when
+in focus.
+
+#### app/views
+
+This will contain classes which produce the views needed by Vedeu to make your
+application come alive!
+
+#### app/views/interfaces
+
+This will contain the information Vedeu needs to draw the various interfaces and views of your application.
+
+#### app/views/templates
+
+This will house the templates your application will use to display views. You can populate templates with generic view information and supplement it with
+variable data from your application.
+
+#### bin
+
+This will contain executable Ruby scripts (or Bash, or shell language of your choice) which will launch your application or provide command-line behaviours.
+
+#### config
+
+This will contain any configuration your application needs to run, plus the
+configuration for Vedeu. This configuration affects the way Vedeu works with
+your application.
+
+#### lib
+
+This is for code your application may use to support code you have in `app/models`.
+
+#### test
+
+This is for the tests you might write to help ensure your application executes
+in the way you expect.
+
+#### vendor
+
+This is for third-party code which your application might want to ship with. Usually you will include various Ruby gems to provide functionality, but you
+might want to do something special.

data/features/cli_vedeu.feature

@@ -0,0 +1,5 @@
+Feature: Running 'vedeu'
+
+  Scenario: Without arguments provides a usage message
+    When I successfully run `vedeu`
+    Then the output should contain ""

data/features/start_stop.feature

@@ -1,6 +1,6 @@
 Feature: Starting and stopping a client application
 
-  @basic
+  @basic @wip
   Scenario: The simplest thing that could work
     Given a file named "simple.rb" with mode "0755" and with:
       """ruby

data/features/support/env.rb

@@ -4,9 +4,10 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'simplecov'
 require 'aruba'
 require 'aruba/cucumber'
-# require 'aruba/in_process'
+require 'aruba/in_process'
 require 'mocha/api'
-require 'vedeu'
+
+require_relative '../../lib/vedeu.rb'
 
 class CucumberError < StandardError; end
 

data/lib/vedeu.rb

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift($LIB_DIR) unless $LOAD_PATH.include?($LIB_DIR)
 require 'date'
 require 'drb'
 require 'erb'
+require 'fileutils'
 require 'forwardable'
 require 'io/console'
 require 'json'

data/lib/vedeu/all.rb

@@ -13,6 +13,8 @@ require 'vedeu/repositories/all'
 require 'vedeu/api'
 require 'vedeu/bindings'
 
+require 'vedeu/generator/all'
+
 # load order has not been fully established beyond this point
 
 require 'vedeu/buffers/all'
@@ -31,3 +33,7 @@ require 'vedeu/templating/all'
 require 'vedeu/main_loop'
 require 'vedeu/application'
 require 'vedeu/launcher'
+
+require 'vedeu/application/all'
+
+require 'vedeu/bootstrap'

data/lib/vedeu/application/all.rb

@@ -0,0 +1,2 @@
+require_relative 'application_controller'
+require_relative 'application_helper'

data/lib/vedeu/application/application_controller.rb

@@ -0,0 +1,7 @@
+module Vedeu
+
+  class ApplicationController
+
+  end # ApplicationController
+
+end # Vedeu

data/lib/vedeu/application/application_helper.rb

@@ -0,0 +1,7 @@
+module Vedeu
+
+  module ApplicationHelper
+
+  end # ApplicationHelper
+
+end # Vedeu

data/lib/vedeu/bootstrap.rb

@@ -0,0 +1,73 @@
+module Vedeu
+
+  # Provides the mechanism to start up a generated application.
+  #
+  # This class loads all necessary client application files and initializes
+  # Vedeu with this data, then starts the client application.
+  class Bootstrap
+
+    # @param argv [Array<String>]
+    # @return [void]
+    def self.start(argv = ARGV)
+      new(argv).start
+    end
+
+    # @param argv [Array<String>]
+    # @return [Vedeu::Bootstrap]
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # @return [void]
+    def start
+      [:configuration_path,
+       :interface_path,
+       :keymap_path].each do |path|
+        load(path)
+      end
+
+      Vedeu::Launcher.execute!(argv)
+    end
+
+    protected
+
+    # @!attribute [r] argv
+    # @return [Array<String>]
+    attr_reader :argv
+
+    private
+
+    # @return [String]
+    def configuration_path
+      File.dirname(__FILE__) + '/config/**/*'
+    end
+
+    # @return [String]
+    def interface_path
+      File.dirname(__FILE__) + '/app/views/interfaces/**/*'
+    end
+
+    # @return [String]
+    def keymap_path
+      File.dirname(__FILE__) + '/app/models/keymaps/**/*'
+    end
+
+    # @param path [String]
+    # @return [String]
+    def load(path)
+      files = send(path)
+
+      Dir.glob(files).select do |file|
+        File.file?(file) && File.extname(file) == '.rb'
+
+      end.each do |file|
+        Kernel.load(file)
+
+      end
+
+      path
+    end
+
+  end # Bootstrap
+
+end # Vedeu