dyi 1.1.1 → 1.1.2

data/lib/dyi/drawing/pen_3d.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -19,9 +19,11 @@
 # You should have received a copy of the GNU General Public License
 # along with DYI.  If not, see <http://www.gnu.org/licenses/>.
 
-module DYI #:nodoc:
-  module Drawing #:nodoc:
+#
+module DYI
+  module Drawing
 
+    # @since 0.0.0
     class CubicPen < Pen
       POSITION_TYPE_VALUES = [:baseline, :center, :backline]
       attr_reader :position_type, :background_color, :background_opacity, :dx, :dy
@@ -93,14 +95,14 @@ module DYI #:nodoc:
 
       private
 
-      def adjust_z_coordinate(shape) #:nodoc:
+      def adjust_z_coordinate(shape)
         case position_type
           when :center then shape.translate(-dx / 2, -dy / 2)
           when :backline then shape.translate(-dx, -dy)
         end
       end
 
-      def draw_background_shape(canvas, start_point, end_point, options={}) #:nodoc:
+      def draw_background_shape(canvas, start_point, end_point, options={})
         brush.draw_polygon(canvas, start_point, options) {|polygon|
           polygon.line_to(end_point)
           polygon.line_to(Coordinate.new(end_point) + Coordinate.new(dx, dy))
@@ -109,6 +111,7 @@ module DYI #:nodoc:
       end
     end
 
+    # @since 0.0.0
     class CylinderBrush < Brush
 
       # @since 1.1.0
@@ -160,7 +163,7 @@ module DYI #:nodoc:
 
       private
 
-      def body_gradient(canvas) #:nodoc:
+      def body_gradient(canvas)
         gradient = ColorEffect::LinearGradient.new([0,0],[1,0])
         gradient.add_color(0, color.merge(Color.white, 0.4))
         gradient.add_color(0.3, color.merge(Color.white, 0.65))
@@ -171,13 +174,15 @@ module DYI #:nodoc:
         gradient
       end
 
-      def top_color #:nodoc:
+      def top_color
         color.merge(Color.white, 0.3)
       end
     end
 
+    # @since 0.0.0
     class ColumnBrush < Brush
 
+      # @since 1.1.0
       def initialize(options={})
         self.flank_color = options.delete(:flank_color)
         self.dy = options.delete(:dy)

data/lib/dyi/element.rb

@@ -19,6 +19,7 @@
 # You should have received a copy of the GNU General Public License
 # along with DYI.  If not, see <http://www.gnu.org/licenses/>.
 
+#
 module DYI
 
   # Abstract class that represents a element contained in the image.
@@ -108,7 +109,7 @@ module DYI
     # Sets a CSS class attribute.
     # @param [String] css_class a CSS class attribute
     # @see {#css_class}
-    # @raise [ArgumentError] parameter `css_class' is illegal class name
+    # @raise [ArgumentError] parameter 'css_class' is illegal class name
     def css_class=(css_class)
       return @css_class = nil if css_class.nil?
       classes = css_class.to_s.split(/\s+/)
@@ -128,9 +129,9 @@ module DYI
 
     # Adds a CSS class.
     # @param [String] css_class a CSS class name
-    # @return [String, nil] value of parameter `css_class' if successes to add
+    # @return [String, nil] value of parameter 'css_class' if successes to add
     #   a class, nil if failures
-    # @raise [ArgumentError] parameter `css_class' is illegal class name
+    # @raise [ArgumentError] parameter 'css_class' is illegal class name
     def add_css_class(css_class)
       if css_class.to_s !~ CLASS_REGEXP
         raise ArgumentError, "`#{css_class}' is a illegal class-name"
@@ -144,7 +145,7 @@ module DYI
 
     # Remove a CSS class.
     # @param [String] css_class a CSS class name that will be removed
-    # @return [String, nil] value of parameter `css_class' if successes to
+    # @return [String, nil] value of parameter 'css_class' if successes to
     #   remove a class, nil if failures
     def remove_css_class(css_class)
       classes = css_classes

data/lib/dyi/event.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -26,13 +26,13 @@
 #
 # See the documentation to the DYI::Length class for more details and
 # examples of usage.
-#
-# @since 1.0.0
 
+#
 module DYI
 
   # Class representing a event.  The event becomes effective only when it is
   # output by SVG format.
+  # @since 1.0.0
   class Event
     IMPLEMENT_EVENTS = [:focusin,:focusout,:click,:mousedown,:mouseup,
                         :mouseover,:mousemove,:mouseout,:load]

data/lib/dyi/font.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -19,8 +19,10 @@
 # You should have received a copy of the GNU General Public License
 # along with DYI.  If not, see <http://www.gnu.org/licenses/>.
 
-module DYI #:nodoc:
+#
+module DYI
 
+  # @since 0.0.0
   class Font
     IMPLEMENT_ATTRIBUTES = [:font_family, :style, :variant, :weight, :size, :size_adjust, :stretch]
     VALID_VALUES = {
@@ -95,7 +97,7 @@ module DYI #:nodoc:
       @size = Length.new_or_nil(value)
     end
 
-    def size_adjust=(value) #:nodoc:
+    def size_adjust=(value)
       @size_adjust = value ? value.to_f : nil
     end
 
@@ -119,7 +121,7 @@ module DYI #:nodoc:
 
     class << self
 
-      def new(*args) #:nodoc:
+      def new(*args)
         return args.first if args.size == 1 && args.first.instance_of?(self)
         super
       end

data/lib/dyi/formatter.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #

data/lib/dyi/formatter/base.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -21,9 +21,10 @@
 
 require 'stringio'
 
-module DYI #:nodoc:
-  module Formatter #:nodoc:
+module DYI
+  module Formatter
 
+    # @since 0.0.0
     class Base
 
       def initialize(canvas)
@@ -88,9 +89,10 @@ module DYI #:nodoc:
       end
     end
 
-    module XmlChar #:nodoc:
+    # @since 0.0.0
+    module XmlChar
       # See http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
-      CP1252 = {      #:nodoc:
+      CP1252 = {     
         128 => 8364,  # euro sign
         130 => 8218,  # single low-9 quotation mark
         131 =>  402,  # latin small letter f with hook
@@ -121,14 +123,14 @@ module DYI #:nodoc:
       }
 
       # See http://www.w3.org/TR/REC-xml/#dt-chardata for details.
-      PREDEFINED = {    #:nodoc:
+      PREDEFINED = {   
         38 => '&',  # ampersand
         60 => '<',   # left angle bracket
         62 => '>'    # right angle bracket
       }
 
       # See http://www.w3.org/TR/REC-xml/#dt-chardata for details.
-      ATTR_PREDEFINED = PREDEFINED.merge( #:nodoc:
+      ATTR_PREDEFINED = PREDEFINED.merge(
         34 => '"',  # double quote
         39 => '''   # single quote
       )
@@ -143,19 +145,19 @@ module DYI #:nodoc:
 
       private
 
-      def escape(s) #:nodoc:
+      def escape(s)
         s.to_s.unpack('U*').map {|n| code_to_char(n)}.join # ASCII, UTF-8
       rescue
         s.to_s.unpack('C*').map {|n| code_to_char(n)}.join # ISO-8859-1, WIN-1252
       end
 
-      def attr_escape(s) #:nodoc:
+      def attr_escape(s)
         s.to_s.unpack('U*').map {|n| code_to_char(n, true)}.join # ASCII, UTF-8
       rescue
         s.to_s.unpack('C*').map {|n| code_to_char(n, true)}.join # ISO-8859-1, WIN-1252
       end
 
-      def code_to_char(code, is_attr=false) #:nodoc:
+      def code_to_char(code, is_attr=false)
         code = CP1252[code] || code
         case code when *VALID
           (is_attr ? ATTR_PREDEFINED : PREDEFINED)[code] || (code<128 ? code.chr : "&##{code};")
@@ -165,8 +167,11 @@ module DYI #:nodoc:
       end
     end
 
+    # @since 0.0.0
     class XmlFormatter < Base
       include XmlChar
+
+      # @since 1.1.0
       attr_reader :namespace
 
       def initialize(canvas, options={})
@@ -178,18 +183,22 @@ module DYI #:nodoc:
         @namespace = namespace.empty? ? nil : namespace
       end
 
+      # @since 1.1.0
       def inline_mode?
         @inline_mode ? true : false
       end
 
+      # @since 1.1.0
       def inline_mode=(boolean)
         @inline_mode = boolean ? true : false
       end
 
+      # @since 1.0.0
       def xml_instruction
         %Q{<?xml version="1.0" encoding="UTF-8"?>}
       end
 
+      # @since 1.0.0
       def stylesheet_instruction(stylesheet)
         styles = []
         styles << '<?xml-stylesheet href="'
@@ -234,13 +243,13 @@ module DYI #:nodoc:
 
       private
 
-      def puts_line(io, &block) #:nodoc:
+      def puts_line(io, &block)
         io << (' ' * (@indent * @level)) if @indent != 0 && @level != 0
         yield io
         io << "\n" if @indent != 0
       end
 
-      def create_node(io, tag_name, attributes={}, &block) #:nodoc:
+      def create_node(io, tag_name, attributes={}, &block)
         _tag_name = @namespace ? "#{namespace}:#{tag_name}" : tag_name
         puts_line(io) {
           io << '<' << _tag_name
@@ -253,7 +262,7 @@ module DYI #:nodoc:
         puts_line(io) {io << '</' << _tag_name << '>'}
       end
 
-      def create_leaf_node(io, tag_name, *attr) #:nodoc:
+      def create_leaf_node(io, tag_name, *attr)
         _tag_name = @namespace ? "#{namespace}:#{tag_name}" : tag_name
         puts_line(io) {
           io << '<' << _tag_name
@@ -275,7 +284,7 @@ module DYI #:nodoc:
         }
       end
 
-      def create_nested_nodes(io, &block) #:nodoc:
+      def create_nested_nodes(io, &block)
         @level += 1
         yield io
       ensure
@@ -283,7 +292,7 @@ module DYI #:nodoc:
       end
 
       # @since 1.0.0
-      def create_cdata_node(io, tag_name, attributes={}, &block) #:nodoc:
+      def create_cdata_node(io, tag_name, attributes={}, &block)
         _tag_name = @namespace ? "#{namespace}:#{tag_name}" : tag_name
         puts_line(io) {
           io << '<' << _tag_name

data/lib/dyi/formatter/emf_formatter.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -22,9 +22,10 @@
 require 'System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a'
 require 'System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089'
 
-module DYI #:nodoc:
-  module Formatter #:nodoc:
+module DYI
+  module Formatter
 
+    # @since 0.0.0
     class EmfFormatter < Base
 
       def save(file_name, options={})
@@ -206,7 +207,7 @@ module DYI #:nodoc:
 
       private
 =begin
-      def pre_render(shape) #:nodoc:
+      def pre_render(shape)
         attributes = {}
         style = create_style(shape)
         transform = create_transform(shape)
@@ -217,7 +218,7 @@ module DYI #:nodoc:
         attributes
       end
 =end
-      def set_transform(shape, graphics, &block) #:nodoc:
+      def set_transform(shape, graphics, &block)
         shape.transform.each do |tr|
           case tr.first
           when :translate

data/lib/dyi/formatter/eps_formatter.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-# Copyright (c) 2009-2011 Sound-F Co., Ltd. All rights reserved.
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
 #
 # Author:: Mamoru Yuo
 #
@@ -21,9 +21,10 @@
 
 require 'nkf'
 
-module DYI #:nodoc:
-  module Formatter #:nodoc:
+module DYI
+  module Formatter
 
+    # @since 0.0.0
     class EpsFormatter < Base
 
       def header_comment
@@ -245,17 +246,17 @@ module DYI #:nodoc:
 
       private
 
-      def puts_line(io, *args) #:nodoc:
+      def puts_line(io, *args)
         io << args.flatten.join(' ') << "\n"
       end
 
-      def command_block(io) #:nodoc:
+      def command_block(io)
         puts_line(io, 'gsave')
         yield
         puts_line(io, 'grestore')
       end
 
-      def stroke_path(io, shape) #:nodoc:
+      def stroke_path(io, shape)
         cmds = []
         if shape.respond_to?(:painting) && (attrs = shape.painting)
           cmds.push([attrs.stroke, 'setrgbcolor']) if attrs.stroke
@@ -274,13 +275,13 @@ module DYI #:nodoc:
         }
       end
 
-      def stroke_current_path(io, shape) #:nodoc:
+      def stroke_current_path(io, shape)
         stroke_path(io, shape) {
           puts_line(io, 'stroke')
         } if shape.painting.stroke
       end
 
-      def fill_path(io, shape) #:nodoc:
+      def fill_path(io, shape)
         cmds = []
         if shape.respond_to?(:painting) && (attrs = shape.painting)
           if attrs.fill
@@ -300,13 +301,13 @@ module DYI #:nodoc:
         }
       end
 
-      def fill_current_path(io, shape) #:nodoc:
+      def fill_current_path(io, shape)
         fill_path(io, shape) {
           puts_line(io, shape.painting.fill_rule == 'evenodd' ? 'eofill' : 'fill')
         } if shape.painting.fill
       end
 
-      def linecap_to_num(linecap) #:nodoc:
+      def linecap_to_num(linecap)
         case linecap
           when 'butt' then 0
           when 'round' then 1
@@ -314,7 +315,7 @@ module DYI #:nodoc:
         end
       end
 
-      def linejoin_to_num(linejoin) #:nodoc:
+      def linejoin_to_num(linejoin)
         case linejoin
           when 'miter' then 0
           when 'round' then 1
@@ -322,7 +323,7 @@ module DYI #:nodoc:
         end
       end
 
-      def write_lines(io, points) #:nodoc:
+      def write_lines(io, points)
         puts_line(io, points.first.x, points.first.y, 'moveto')
         points[1..-1].each do |pt|
           pt = Coordinate.new(pt)
@@ -360,7 +361,7 @@ module DYI #:nodoc:
         cmds
       end
 
-      def transform_path(io, shape) #:nodoc:
+      def transform_path(io, shape)
         if shape.respond_to?(:transform) && !(tr = shape.transform).empty?
           tr.each do |t|
             case t[0]
@@ -381,7 +382,7 @@ module DYI #:nodoc:
         end
       end
 
-      def clip_path(io, shape) #:nodoc:
+      def clip_path(io, shape)
         if shape.respond_to?(:clipping) && shape.clipping
           shape.clipping.each_shapes do |shape, rule|
             s = shape.clone