lib/vedeu/borders/dsl.rb in vedeu-0.6.20 vs lib/vedeu/borders/dsl.rb in vedeu-0.6.21
- old
+ new
@@ -10,39 +10,29 @@
include Vedeu::DSL::Presentation
include Vedeu::DSL::Use
# Specify the border of an interface or view with a simple DSL.
#
- # Vedeu.border 'some_interface' do
+ # Vedeu.border :some_interface do
# # ...
# end
#
- # @param name [String] The name of the interface or view to
- # which this border belongs.
+ # @param name [String|Symbol] The name of the interface or view
+ # to which this border belongs.
# @param block [Proc]
# @raise [Vedeu::Error::RequiresBlock]
# @return [Vedeu::Borders::Border]
def self.border(name, &block)
fail Vedeu::Error::RequiresBlock unless block_given?
Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
end
- # Returns an instance of Borders::DSL.
- #
- # @param model [Vedeu::Borders::Border]
- # @param client [Object]
- # @return [Vedeu::Borders::DSL]
- def initialize(model, client = nil)
- @model = model
- @client = client
- end
-
# Set the character to be used to draw the bottom left corner of
# the border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# bottom_left '+'
# # ... some code
# end
#
# @param char [String] Character to be used as the bottom left
@@ -54,11 +44,11 @@
alias_method :bottom_left=, :bottom_left
# Set the character to be used to draw the bottom right corner
# of the border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# bottom_right '+'
# # ... some code
# end
#
# @param char [String] Character to be used as the bottom right
@@ -69,11 +59,11 @@
end
alias_method :bottom_right=, :bottom_right
# Disable the border:
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# disable!
# # ... some other code (will be ignored)
# end
#
# @return [Boolean]
@@ -90,11 +80,11 @@
# Enable the border:
# (Borders are enabled by default when defined for an
# interface).
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# enable!
# # ... some code
# end
#
# @return [Boolean]
@@ -110,11 +100,11 @@
end
# Set the character to be used to draw a horizontal part of the
# border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# horizontal '-'
# # ... some code
# end
#
# @param char [String] Character to be used as the horizontal
@@ -125,11 +115,11 @@
end
alias_method :horizontal=, :horizontal
# Enable/disable the bottom border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# bottom true # or...
# bottom false # or...
# hide_bottom! # or...
# show_bottom!
# # ... some code
@@ -160,11 +150,11 @@
bottom(true)
end
# Enable/disable the left border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# left true # or...
# left false # or...
# hide_left! # or...
# show_left!
# # ... some code
@@ -195,11 +185,11 @@
left(true)
end
# Enable/disable the right border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# right true # or...
# right false # or...
# hide_right! # or...
# show_right!
# # ... some code
@@ -231,11 +221,11 @@
end
# If you have you are showing a top border, you could add a
# title.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# title 'My Cool Title'
# # ... some code
# end
#
# produces, depending on other customisations:
@@ -250,11 +240,11 @@
alias_method :title=, :title
# If you have you are showing a bottom border, you could add a
# caption.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# caption 'My Cool Caption'
# # ... some code
# end
#
# produces, depending on other customisations:
@@ -268,11 +258,11 @@
end
alias_method :caption=, :caption
# Enable/disable the top border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# top true # or...
# top false # or...
# hide_top! # or...
# show_top!
# # ... some code
@@ -304,11 +294,11 @@
end
# Set the character to be used to draw the top left corner of
# the border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# top_left '+'
# # ... some code
# end
#
# @param char [String] Character to be used as the top left
@@ -320,11 +310,11 @@
alias_method :top_left=, :top_left
# Set the character to be used to draw the top right corner of
# the border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# top_right '+'
# # ... some code
# end
#
# @param char [String] Character to be used as the top right
@@ -336,11 +326,11 @@
alias_method :top_right=, :top_right
# Set the character to be used to draw a vertical part of the
# border.
#
- # Vedeu.border 'border_demo' do
+ # Vedeu.border :border_demo do
# vertical '|'
# # ... some code
# end
#
# @param char [String] Character to be used as the vertical
@@ -352,7 +342,11 @@
alias_method :vertical=, :vertical
end # Border
end # DSL
+
+ # @!method border
+ # @see Vedeu::Borders::DSL.border
+ def_delegators Vedeu::Borders::DSL, :border
end # Vedeu