vedeu 0.4.41 → 0.4.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5bade3d3d45fdc2dd04f64bacfe2e42350b5b98
-  data.tar.gz: a4f39d6b2625bb378ce2b84d5b7f16c3f2cd5529
+  metadata.gz: d52cfaf13c8adfd85fb8d7f29a66133d4d12781c
+  data.tar.gz: 901409d56b30fad4859b55f5b188e44a16628b08
 SHA512:
-  metadata.gz: 43b4cf698da18c2ac3579730abcf18ad1bd9bb013048aa0a0c8542987b324196e52294e599771cd6da7bf62aa61b5d2c557dc95501576efc0f724f0a39c56ba9
-  data.tar.gz: 5ea2e7f70d2b77fb389d94f6eba5d2c2413bd12ff158a97f8d0f62ef7fd947cc1a3ba9adee689feef3c62e34aa86f8ff7b8a7a79e41ba3681cd521fe23fc7c11
+  metadata.gz: 46f1892cef45301eefbea271b95a06455ce30781e4b5f793cd779adb1c81e83e2f99c833db01d97b171fbfdda163f3fe890dff977d9f6108270bd8ea229b23ba
+  data.tar.gz: 752fd49e4627635d187c7d8b73f1773f3be1b1d12a638ae2f0f15e1466a219ac4a16237a869138cb394138571c77b13b112c0b1dccb7b712b4a32f8a16ebeb56

data/README.md

@@ -21,14 +21,11 @@ Note: You may have trouble running Vedeu with Windows installations. (Pull
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install Vedeu, simply:
 
-    gem 'vedeu'
-
-And then execute:
-
-    $ bundle
+    gem install 'vedeu'
 
+To use Vedeu's application scaffolding, see the [RubyDoc](http://www.rubydoc.info/gems/vedeu/file/docs/applications.md)
 
 ## Example
 

data/bin/vedeu

@@ -1,57 +1,8 @@
 #!/usr/bin/env ruby
 
-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 '
-    print "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
+Vedeu::CLI::Main.start(ARGV.dup)

data/docs/applications.md

@@ -4,8 +4,17 @@ 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.
 
+### Installing Vedeu
+
+To install Vedeu, simply:
+
+    gem install 'vedeu'
+
+To use Vedeu's application scaffolding, see below:
+
 ### Generating a new application
 
+```bash
 |
 |- app_name/
 |   |
@@ -36,10 +45,13 @@ hopefully these generators will get you off the ground.
     |- vendor/
     |- application.rb
     |- Gemfile
+```
 
 To create the application structure as shown above:
 
-    vedeu new app_name
+```bash
+vedeu new app_name
+```
 
 Let's talk about each directory and its purpose.
 
@@ -120,10 +132,13 @@ might want to do something special.
 Vedeu also provides a generator to create the files needed for a view. To run
 this, use the following from within the root of the application directory:
 
-    vedeu view view_name
+```bash
+vedeu view view_name
+```
 
 Let's talk about the files it will create and populate:
 
+```bash
 |
 |- app_name/
 |   |
@@ -147,5 +162,6 @@ Let's talk about the files it will create and populate:
     |       |
     |       |- view_name.rb
     |...
+```
 
 ####

data/lib/vedeu/all.rb

@@ -13,7 +13,7 @@ require 'vedeu/repositories/all'
 require 'vedeu/api'
 require 'vedeu/bindings'
 
-require 'vedeu/generator/all'
+require 'vedeu/cli/generator/all'
 
 # load order has not been fully established beyond this point
 
@@ -37,3 +37,5 @@ require 'vedeu/launcher'
 require 'vedeu/application/all'
 
 require 'vedeu/bootstrap'
+
+require 'vedeu/cli/all'

data/lib/vedeu/api.rb

@@ -75,11 +75,13 @@ module Vedeu
 
     # @!method interface
     #   @see Vedeu::DSL::View.interface
+    # @!method render
+    #   @see Vedeu::DSL::View.render
     # @!method renders
     #   @see Vedeu::DSL::View.renders
     # @!method views
     #   @see Vedeu::DSL::View.views
-    def_delegators Vedeu::DSL::View, :interface, :renders, :views
+    def_delegators Vedeu::DSL::View, :interface, :renders, :render, :views
 
     # @!method bind
     #   @see Vedeu::Event.bind

data/lib/vedeu/application/controller.rb

@@ -3,6 +3,11 @@ module Vedeu
   module Controller
 
     module ClassMethods
+
+      def controller_name(name)
+        Vedeu.bind("show_#{name}".to_sym) { self.new }
+      end
+
     end # ClassMethods
 
     module InstanceMethods

data/lib/vedeu/buffers/buffer.rb

@@ -74,7 +74,7 @@ module Vedeu
     #
     # @return [Boolean] Whether the buffer targetted has content.
     def back?
-      return false if back.nil? || back.content.empty?
+      return false if back.nil? || back.lines.empty?
 
       true
     end
@@ -90,7 +90,7 @@ module Vedeu
     #
     # @return [Boolean] Whether the buffer targetted has content.
     def front?
-      return false if front.nil? || front.content.empty?
+      return false if front.nil? || front.lines.empty?
 
       true
     end
@@ -99,7 +99,7 @@ module Vedeu
     #
     # @return [Boolean] Whether the buffer targetted has content.
     def previous?
-      return false if previous.nil? || previous.content.empty?
+      return false if previous.nil? || previous.lines.empty?
 
       true
     end
@@ -199,6 +199,9 @@ module Vedeu
       elsif previous?
         [previous.render]
 
+      elsif visible?
+        [interface.render]
+
       else
         []
 

data/lib/vedeu/cli/all.rb

@@ -0,0 +1 @@
+require_relative 'main'

data/lib/vedeu/{generator → cli/generator}/all.rb

@@ -1,6 +1,6 @@
-require 'vedeu/generator/helpers'
-require 'vedeu/generator/application'
-require 'vedeu/generator/view'
+require 'vedeu/cli/generator/helpers'
+require 'vedeu/cli/generator/application'
+require 'vedeu/cli/generator/view'
 
 module Vedeu
 

data/lib/vedeu/{generator → cli/generator}/helpers.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/common'
+
 module Vedeu
 
   module Generator
@@ -8,22 +10,13 @@ module Vedeu
     # @api private
     module Helpers
 
+      include Vedeu::Common
+
       # @return [String]
       def app_name
         @app_name ||= File.read('./config/app_name')
       end
 
-      # @param name [String]
-      # @return [String]
-      def app_name_as_snake_case(name = app_name)
-        name.gsub!(/::/, '/')
-        name.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        name.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        name.tr!('-', '_')
-        name.downcase!
-        name
-      end
-
       # @param destination [String]
       # @return [void]
       def make_directory(destination)

data/lib/vedeu/{generator → cli/generator}/templates/application/app/controllers/name.erb

@@ -5,6 +5,8 @@ module <%= object.app_name %>
 
   class <%= object.name_as_class %>Controller < <%= object.app_name -%>::ApplicationController
 
+    controller_name <%= object.app_name -%>
+
     def initialize
       <%= object.app_name %>::<%= object.name_as_class %>View.render(object)
     end

data/lib/vedeu/{generator → cli/generator}/templates/application/app/views/interfaces/name.erb

@@ -48,6 +48,12 @@ Vedeu.interface '<%= object.name %>' do
     # width  10
   # end
 
+  # group ''
+
+  # hide!
+
+  # show!
+
   # style
 
   # zindex

data/lib/vedeu/{generator → cli/generator}/view.rb

@@ -16,8 +16,7 @@ module Vedeu
 
       include Vedeu::Generator::Helpers
 
-      # @param name [String] The name of the view.
-      # @return [Vedeu::Generator::View]
+      # @see Vedeu::Generator::View#initialize
       def self.generate(name)
         new(name).generate
       end

data/lib/vedeu/cli/main.rb

@@ -0,0 +1,29 @@
+module Vedeu
+
+  module CLI
+
+    class Main < Thor
+
+      desc 'new <name>', 'Create a skeleton Vedeu client application.'
+      def new(name)
+        say Vedeu::Generator::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.'
+      def view(name)
+        Vedeu::Generator::View.generate(name)
+      end
+
+      desc 'version',
+           'Print the version.'
+      def version
+        say "vedeu #{Vedeu::VERSION}"
+      end
+
+    end # Main
+
+  end # CLI
+
+end # Vedeu

data/lib/vedeu/dsl/presentation.rb

@@ -38,14 +38,18 @@ module Vedeu
       #
       # @return [String]
       def background(value = '')
-        colour(background: value)
+        model.colour = Vedeu::Colour.coerce(
+          background: Vedeu::Background.coerce(value),
+          foreground: model.colour.foreground)
       end
       alias_method :bg,      :background
       alias_method :bgcolor, :background
 
       # @see Vedeu::DSL::Presentation#background
       def foreground(value = '')
-        colour(foreground: value)
+        model.colour = Vedeu::Colour.coerce(
+          foreground: Vedeu::Foreground.coerce(value),
+          background: model.colour.background)
       end
       alias_method :fg,      :foreground
       alias_method :fgcolor, :foreground

data/lib/vedeu/dsl/view.rb

@@ -58,11 +58,12 @@ module Vedeu
         #
         # @raise [InvalidSyntax] The required block was not given.
         # @return [Array<Interface>]
-        def renders(&block)
+        def render(&block)
           fail InvalidSyntax, 'block not given' unless block_given?
 
           store(:store_immediate, &block)
         end
+        alias_method :renders, :render
 
         # Deferred view
         #

data/lib/vedeu/geometry/area.rb

@@ -123,7 +123,7 @@ module Vedeu
     # Returns the row above the top by default.
     #
     # @example
-    #   `top` / `y` is 4.
+    #   `top` or `y` is 4.
     #
     #   north     # => 3
     #   north(2)  # => 2 (positive goes north)
@@ -138,7 +138,7 @@ module Vedeu
     # Returns the column after right by default.
     #
     # @example
-    #   `right` / `xn` is 19.
+    #   `right` or `xn` is 19.
     #
     #   east     # => 20
     #   east(2)  # => 21 (positive goes east)
@@ -153,7 +153,7 @@ module Vedeu
     # Returns the row below the bottom by default.
     #
     # @example
-    #   `bottom` / `yn` is 12.
+    #   `bottom` or `yn` is 12.
     #
     #   south     # => 13
     #   south(2)  # => 14 (positive goes south)
@@ -168,7 +168,7 @@ module Vedeu
     # Returns the column before left by default.
     #
     # @example
-    #   `left` / `x` is 8.
+    #   `left` or `x` is 8.
     #
     #   west      # => 7
     #   west(2)   # => 6  (positive goes west)

data/lib/vedeu/models/interface.rb

@@ -94,7 +94,6 @@ module Vedeu
     def lines
       collection.coerce(@lines, self)
     end
-    alias_method :content, :lines
     alias_method :value, :lines
 
     # Returns a boolean indicating whether the interface has content.
@@ -103,8 +102,6 @@ module Vedeu
     def lines?
       lines.any?
     end
-    alias_method :content?, :lines?
-    alias_method :value?, :lines?
 
     # Returns a boolean indicating whether the interface belongs to a
     # group.

data/lib/vedeu/output/colour.rb

@@ -33,9 +33,13 @@ module Vedeu
   # @api private
   class Colour
 
-    # @!attribute [r] attributes
-    # @return [Hash]
-    attr_reader :attributes
+    # @!attribute [r] background
+    # @return [Vedeu::Background]
+    attr_reader :background
+
+    # @!attribute [r] foreground
+    # @return [Vedeu::Foreground]
+    attr_reader :foreground
 
     # @param value []
     # @return [Object]
@@ -43,11 +47,11 @@ module Vedeu
       return value if value.is_a?(self)
       return new unless value.is_a?(Hash)
 
-      if value[:colour]
-        return value[:colour] if value[:colour].is_a?(self)
-        return new unless value[:colour].is_a?(Hash)
-        return new(value[:colour]) if value[:colour][:background] ||
-                                      value[:colour][:foreground]
+      if value[:colour] && value[:colour].is_a?(self)
+        value[:colour]
+
+      elsif value[:colour] && value[:colour].is_a?(Hash)
+        new(value[:colour])
 
       elsif value[:background] || value[:foreground]
         new(value)
@@ -65,14 +69,8 @@ module Vedeu
     # @option attributes foreground [String]
     # @return [Vedeu::Colour]
     def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-    end
-
-    # Returns the background colour as a Vedeu::Background.
-    #
-    # @return [Vedeu::Background]
-    def background
-      @background ||= Vedeu::Background.coerce(attributes[:background])
+      @background = Vedeu::Background.coerce(attributes[:background])
+      @foreground = Vedeu::Foreground.coerce(attributes[:foreground])
     end
 
     # Converts the value into a Vedeu::Background.
@@ -80,7 +78,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def background=(value)
-      @background = @attributes[:background] = Vedeu::Background.coerce(value)
+      @background = Vedeu::Background.coerce(value)
     end
 
     # An object is equal when its values are the same.
@@ -93,19 +91,12 @@ module Vedeu
     end
     alias_method :==, :eql?
 
-    # Returns the foreground colour as a Vedeu::Foreground.
-    #
-    # @return [Vedeu::Foreground]
-    def foreground
-      @foreground ||= Vedeu::Foreground.coerce(attributes[:foreground])
-    end
-
     # Converts the value into a Vedeu::Foreground.
     #
     # @param value [String]
     # @return [String]
     def foreground=(value)
-      @foreground = @attributes[:foreground] = Vedeu::Foreground.coerce(value)
+      @foreground = Vedeu::Foreground.coerce(value)
     end
 
     # Returns both or either of the converted attributes into a single escape
@@ -119,16 +110,6 @@ module Vedeu
 
     private
 
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash<Symbol => NilClass>]
-    def defaults
-      {
-        background: '',
-        foreground: '',
-      }
-    end
-
   end # Colour
 
 end # Vedeu

data/lib/vedeu/output/presentation.rb

@@ -19,19 +19,28 @@ module Vedeu
 
     # @return [Vedeu::Background]
     def background=(value)
-      @attributes[:background] = value
-      @background = colour.background = Vedeu::Background.coerce(value)
+      self.colour = Vedeu::Colour.coerce(
+        background: Vedeu::Background.coerce(value),
+        foreground: colour.foreground)
     end
 
     # @return [Vedeu::Colour]
     def colour
-      @colour ||= Vedeu::Colour.coerce(_colour)
+      @colour ||= if attributes[:colour]
+                    Vedeu::Colour.coerce(attributes[:colour])
+
+                  elsif parent_colour
+                    Vedeu::Colour.coerce(parent_colour)
+
+                  else
+                    Vedeu::Colour.new
+
+                  end
     end
 
     # @return [Vedeu::Colour]
     def colour=(value)
-      @attributes[:colour] = value
-      @colour = Vedeu::Colour.coerce(value)
+      @colour = attributes[:colour] = Vedeu::Colour.coerce(value)
     end
 
     # @return [Vedeu::Foreground]
@@ -47,8 +56,9 @@ module Vedeu
 
     # @return [Vedeu::Foreground]
     def foreground=(value)
-      @attributes[:foreground] = value
-      @foreground = colour.foreground = Vedeu::Foreground.coerce(value)
+      self.colour = Vedeu::Colour.coerce(
+        foreground: Vedeu::Foreground.coerce(value),
+        background: colour.background)
     end
 
     # @return [Vedeu::Background]
@@ -80,12 +90,27 @@ module Vedeu
 
     # @return [String|NilClass]
     def parent_style
-      parent.style if parent
+      if parent
+        parent.style
+
+      else
+        Vedeu::Style.new
+
+      end
     end
 
     # @return [Vedeu::Style]
     def style
-      @style ||= Vedeu::Style.coerce(_style)
+      @style ||= if attributes[:style]
+                   Vedeu::Style.coerce(attributes[:style])
+
+                 elsif parent_style
+                   Vedeu::Style.coerce(parent_style)
+
+                 else
+                   Vedeu::Style.new
+
+                 end
     end
 
     # @return [Vedeu::Style]
@@ -105,12 +130,6 @@ module Vedeu
 
     private
 
-    # @return [void]
-    def _colour
-      return attributes[:colour] if attributes[:colour]
-      return parent_colour if parent && parent_colour
-    end
-
     # Renders the colour attributes of the receiver and yields (to then render
     # the styles).
     #
@@ -138,12 +157,6 @@ module Vedeu
       [style, yield].join
     end
 
-    # @return [void]
-    def _style
-      return attributes[:style] if attributes[:style]
-      return parent_style if parent && parent_style
-    end
-
   end # Presentation
 
 end # Vedeu