RubyGems - dyi_rails - Versions diffs - 0.0.0 - Mend

dyi_rails 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

data/CHANGES +5 -0
data/COPYING +674 -0
data/README +208 -0
data/lib/dyi_rails.rb +71 -0
data/lib/dyi_rails/dyi_helper.rb +249 -0
data/lib/dyi_rails/streaming.rb +65 -0
metadata +102 -0

data/README ADDED Viewed

@@ -0,0 +1,208 @@
+= DYI for Rails: A Library to Use DYI on Rails.
+"DYI for Rails" is a library for use DYI on Rails. "DYI for Rails"
+provides some helpers and module for drawing a image of DYI.
+== Installing
+To install "DYI for Rails", use the following command.
+  $ gem install dyi-rails
+(Add sudo if you're installing under a POSIX system as root)
+== How to Use
+=== Configuration
+You add the following expression to <tt>RAILS_ROOT/config/environment.rb</tt>
+so that you can use this library on your Rails application.
+  # in RAILS_ROOT/config/environment.rb
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+  config.gem "dyi"        # add gem of DYI
+  config.gem "dyi_rails"  # add gem of DYI for Rails
+=== Usage in View
+You add the following expression to <tt>RAILS_ROOT/app/controllers/application_controller.rb</tt>
+so that you can use {DyiRails::DyiHelper} on your Rails application.
+  # in RAILS_ROOT/app/controllers/application_controller.rb
+  class ApplicationController < ActionController::Base
+    helper :all # include all helpers, all the time
+    protect_from_forgery # See ActionController::RequestForgeryProtection for details
+    helper DyiRails::DyiHelper # add this expression, then you can use helper-methods provided by DyiHelper
+    # Scrub sensitive parameters from your log
+    # filter_parameter_logging :password
+  end
+You create the image object using DYI as follows:
+  # in RAILS_ROOT/app/controllers/test_controller.rb
+  class TestController < ApplicationController
+    def index
+      # Creates image using DYI
+      @canvas = DYI::Canvas.new(200, 150)
+      brush = DYI::Drawing::Brush.blue_brush
+      brush.draw_rectangle(@canvas, [20, 20], 160, 110)
+    end
+  end
+You can use helper-methods of {DyiRails::DyiHelper} in any view file, using inline
+SVG in HTML5.
+  # in RAILS_ROOT/app/views/test/index.html.erb
+  <!DOCTYPE html>
+  <html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>Useage of DYI for Rails</title>
+  </head>
+  <body>
+    <div>
+      <h1>SVG Image created by DYI</h1>
+      <%= dyi_inline_image_tag @canvas, :alt => 'SVG Image' %>
+    </div>
+  </body>
+  </html>
+In this sample, the output is as follows:
+  <!DOCTYPE html>
+  <html lang="en">
+  <head>
+    <title>Useage of DYI for Rails</title>
+  </head>
+  <body>
+    <div>
+      <h1>SVG Image created by DYI</h1>
+      <svg xmlns="http://www.w3.org/2000/svg" version="1.1"
+           width="200" height="150" viewBox="0 0 200 150"
+           preserveAspectRatio="none">
+        <desc>SVG Image</desc>
+        <rect x="20" y="20" width="160" height="110" fill="#0000FF"/>
+      </svg>
+    </div>
+  </body>
+  </html>
+In XML (e.g. XHTML, XSL-FO, etc...), you can use XML namespace.
+  # in RAILS_ROOT/app/views/test/index.html.erb
+  #
+  # NOTE: You must use "application/xhtml+xml" as content-type,
+  #       when using XHTML include XML namespace.
+  #       See http://www.w3.org/TR/xhtml-media-types/
+  <?xml version="1.0" encoding="utf-8"?>
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <title>Useage of DYI for Rails</title>
+  </head>
+  <body>
+    <div>
+      <h1>SVG Image created by DYI</h1>
+      <%= dyi_inline_image_tag @canvas, :alt => 'SVG Image', :namespace => 'svg' %>
+    </div>
+  </body>
+  </html>
+In this sample, the output is as follows:
+  <?xml version="1.0" encoding="utf-8"?>
+  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+  <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <title>Useage of DYI for Rails</title>
+  </head>
+  <body>
+    <div>
+      <h1>SVG Image created by DYI</h1>
+      <svg:svg xmlns:svg="http://www.w3.org/2000/svg" version="1.1"
+               width="200" height="150" viewBox="0 0 200 150"
+               preserveAspectRatio="none">
+        <svg:desc>SVG Image</svg:desc>
+        <svg:rect x="20" y="20" width="160" height="110" fill="#0000FF"/>
+      </svg:svg>
+    </div>
+  </body>
+  </html>
+For more information, see the document of {DyiRails::DyiHelper}.
+=== Usage in Controller
+A method to send a DYI image to the client is defined in {DyiRails::Streaming}.
+You can use the method to include {DyiRails::Streaming}, as follows:
+  # in RAILS_ROOT/app/controllers/test_controller.rb
+  class TestController < ApplicationController
+    include DyiRails::Streaming
+    def index
+      # Creates image using DYI
+      canvas = DYI::Canvas.new(200, 150)
+      brush = DYI::Drawing::Brush.blue_brush
+      brush.draw_rectangle(canvas, [20, 20], 160, 110)
+      # Sends image to the client
+      send_dyi_image(canvas)
+    end
+  end
+In this sample, the response body is as follows:
+  <?xml version="1.0" encoding="UTF-8"?>
+  <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
+      "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+  <svg xmlns="http://www.w3.org/2000/svg" version="1.1"
+       width="200" height="150" viewBox="0 0 200 150"
+       preserveAspectRatio="none">
+    <rect x="20" y="20" width="160" height="110" fill="#0000FF"/>
+  </svg>
+You can also use graphics formats other than SVG (e.g. PNG, EPS, etc...).
+See examples of {DyiRails::Streaming#send_dyi_image}.
+== License
+Copyright (c) 2012 Sound-F Co., Ltd. All rights reserved.
+"DYI for Rails" is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+"DYI for Rails" is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+You should have received a copy of the GNU General Public License
+along with "DYI for Rails".  If not, see <http://www.gnu.org/licenses/>.
+== Support
+We support "DYI for Rails" using SourceForge.net.  URL of "DYI for Rails"
+Project is "http://sourceforge.net/projects/dyi-rails/".  This page has
+a tracker and forums.
+We are also preparing the Japanese mailing list.  More infomation
+about the mailing list is indicated to
+<http://open-dyi.org/contents.html#community> in Japanese,
+including how to join it.

data/lib/dyi_rails.rb ADDED Viewed

@@ -0,0 +1,71 @@
+# -*- encoding: UTF-8 -*-
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
+#
+# Author:: Mamoru Yuo
+#
+# This file is part of "DYI for Rails".
+#
+# "DYI for Rails" is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# "DYI for Rails" is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with "DYI for Rails".  If not, see <http://www.gnu.org/licenses/>.
+# Root namespace of "DYI for Rails".
+# @since 0.0.0
+module DyiRails
+  # "DYI for Rails" program version
+  VERSION = '0.0.0'
+  # URL of "DYI for Rails" Project
+  URL = 'http://sourceforge.net/projects/dyi-rails/'
+  # The correspondence of the image format to the mime-type
+  MIME_TYPE = {:svg => 'image/svg+xml',
+               :png => 'image/png',
+               :eps => 'application/postscript',
+               :xaml => 'application/xaml+xml'}
+  class << self
+    # Registers new correspondence of the image format to mime-type. When the
+    # image format has already registered, mime-type is overriden.
+    # @param [Symbol, String] format image format
+    # @param [String] mime_type mime-type which the image format corresponds to
+    def register_mime_type(format, mime_type)
+      MIME_TYPE[format.to_sym] = mime_type.to_s
+    end
+    # Returns mime-type which the given image format corresponds to.
+    # @param [Symbol, String] format image format
+    # @return [String] mime-type which the image format corresponds to
+    # @raise [ArgumentError] unknown format is given
+    def mime_type(format)
+      format = format.to_sym
+      unless MIME_TYPE.has_key?(format)
+        raise ArgumentError, "`#{options[:format]}' is unknown format"
+      end
+      return MIME_TYPE[format]
+    end
+  end
+end
+require 'dyi'
+%w(
+dyi_rails/dyi_helper.rb
+dyi_rails/streaming.rb
+).each do |file_name|
+  require File.join(File.dirname(__FILE__), file_name)
+end

data/lib/dyi_rails/dyi_helper.rb ADDED Viewed

@@ -0,0 +1,249 @@
+# -*- encoding: UTF-8 -*-
+# Copyright (c) 2009-2012 Sound-F Co., Ltd. All rights reserved.
+#
+# Author:: Mamoru Yuo
+#
+# This file is part of "DYI for Rails".
+#
+# "DYI for Rails" is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# "DYI for Rails" is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with "DYI for Rails".  If not, see <http://www.gnu.org/licenses/>.
+module DyiRails
+  # Provides a set of methods for making image tags using DYI.
+  module DyiHelper
+    # Returns a inline HTML element. The HTML element does not have a URI
+    # reference, and the element contains the image data itself.
+    # @param [DYI::Canvas, DYI::Chart::Base] canvas a canvas that hold the image
+    # @option options [String] :id id of the HTML element. If the canvas has
+    #   _id_ attribute, this option is ignored.
+    # @option options [String] :class CSS class name of the HTML element
+    # @option options [String] :alt equivalent content for those who cannot
+    #   process images or who have image loading disabled. If the canvas has
+    #   _description_ attribute, this option is ignored. Default to <tt>'dyi
+    #   image'</tt>
+    # @option options [String] :title title of the image. If the canvas has
+    #   _title_ attribute, this option is ignored
+    # @option options [Symbol, String] :format format of the image. Default to
+    #   +:svg+
+    # @option options [String] :namespace XML namespace when XML format (e.g.
+    #   SVG) is specified at +:format+ option. If nothing is specified,
+    #   XML namespace is not used
+    # @return [String] HTML element contains image data
+    # @example
+    #   dyi_inline_image_tag(@canvas, :alt => 'my image')
+    #   # => <svg width="200" height="150" version="1.1" viewBox="0 0 200 150"
+    #   #         xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="none">
+    #   #      <description>my image</description>
+    #   #      ...
+    #   #    </svg>
+    #
+    #   dyi_inline_image_tag(@canvas, :alt => 'my image', :namespace => 'svg')
+    #   # => <svg:svg width="200" height="150" version="1.1" viewBox="0 0 200 150"
+    #   #         xmlns:svg="http://www.w3.org/2000/svg" preserveAspectRatio="none">
+    #   #      <svg:description>my image</svg:description>
+    #   #      ...
+    #   #    </svg:svg>
+    #
+    #   dyi_inline_image_tag(@canvas, :alt => 'my image', :format => :png)
+    #   # => <img width="200" height="150" alt="my image" src="data:image/png;base64,
+    #   #         ...(encoded PNG image)..." />
+    def dyi_inline_image_tag(canvas, options={})
+      case (format = (options[:format] || :svg).to_sym)
+      when :svg, :xaml #, :vml
+        # output inline XML
+        alt = canvas.description || options[:alt] || 'dyi image'
+        canvas.id = options[:id] if options[:id] && !canvas.inner_id
+        canvas.add_css_class(options[:class]) if options[:class]
+        canvas.description = alt unless canvas.description
+        canvas.title = options[:title] if options[:title] && !canvas.title
+        canvas.string(format, :inline_mode => true, :namespace => options[:namespace])
+      when :png
+        # output <img> tag with base64 encoding
+        element_id = canvas.inner_id || options[:id]
+        class_name = options[:class]
+        alt = canvas.description || options[:alt] || 'dyi image'
+        title = canvas.title || options[:title]
+        mime_type = DyiRails.mime_type(format)
+        tag_parts = ['<img']
+        tag_parts << " id=\"#{element_id}\"" if element_id
+        tag_parts << ' src="data:'
+        tag_parts << mime_type
+        tag_parts << ";base64,\n"
+        tag_parts << [canvas.string(format)].pack('m')[0..-2]
+        tag_parts << '"'
+        tag_parts << " type=\"#{mime_type}\""
+        tag_parts << " class=\"#{class_name}\"" if class_name
+        tag_parts << " width=\"#{canvas.real_width}\""
+        tag_parts << " height=\"#{canvas.real_height}\""
+        tag_parts << " alt=\"#{alt}\""
+        tag_parts << " title=\"#{title}\"" if title
+        tag_parts << " />"
+        tag_parts.join
+      else
+        # output <object> tag with base64 encoding
+        element_id = canvas.inner_id || options[:id]
+        class_name = options[:class]
+        alt = canvas.description || options[:alt] || 'dyi image'
+        title = canvas.title || options[:title]
+        mime_type = DyiRails.mime_type(format)
+        tag_parts = ['<object']
+        tag_parts << " id=\"#{element_id}\"" if element_id
+        tag_parts << " data=\"data:"
+        tag_parts << mime_type
+        tag_parts << ";base64,\n"
+        tag_parts << [canvas.string(format)].pack('m')[0..-2]
+        tag_parts << "\""
+        tag_parts << " type=\"#{mime_type}\""
+        tag_parts << " class=\"#{class_name}\"" if class_name
+        tag_parts << " width=\"#{canvas.real_width}\""
+        tag_parts << " height=\"#{canvas.real_height}\""
+        tag_parts << " title=\"#{title}\"" if title
+        tag_parts << ">"
+        tag_parts << alt
+        tag_parts << "</object>"
+        tag_parts.join
+      end
+    end
+    # Returns a HTML +_img_+ element.
+    # @option options [String] :id id of the HTML element
+    # @option options [String] :class CSS class name of the HTML element
+    # @option options [String] :alt equivalent content for those who cannot
+    #   process images or who have image loading disabled. Default to 'dyi image'
+    # @option options [String] :title title of the image
+    # @option options [Integer] :width width of the image
+    # @option options [Integer] :height height of the image
+    # @option options [Symbol, String] :format format of the image. Default to
+    #   +:svg+
+    # @option options [String] :controller controller of Rails' application
+    #   that process the image. Default to 'images'
+    # @option options [String] :action action of Rails' application that process
+    #   the image. Default to 'dyi'
+    # @option options [String] :model_id id as a parameter passed to the Rails'
+    #   application that process the image. Default to 'dyi'
+    # @option options [String] other-options other options is passed to +url_for+
+    #   method. See examples
+    # @return [String] HTML +_img_+ element contains URI reference to the image
+    # @example
+    #   dyi_image_tag(:format => :png, :width => 200, :height => 150)
+    #   # => <img width="200" height="150" alt="dyi image" src="/images/dyi/dyi.png" />
+    #
+    #   dyi_image_tag(:format => :png, :width => 200, :height => 150, :id => 'emb',
+    #                 :controller => 'teams', :action => 'emblem', :model_id => '1')
+    #   # => <img id="emb" width="200" height="150" alt="dyi image" src="/teams/emblem/1.png" />
+    #
+    #   dyi_image_tag(:format => :png, :width => 200, :height => 150, :id => 'emb',
+    #                 :controller => 'teams', :action => 'emblem', :model_id => '1',
+    #                 :color => 'red', :type => 'simple')
+    #   # => <img id="emb" width="200" height="150" alt="dyi image"
+    #   #         src="/teams/emblem/1.png?color=red&amp;type=simple" />
+    def dyi_image_tag(options={})
+      opt = options.clone
+      element_id = opt.delete(:id)
+      class_name = opt.delete(:class)
+      alt = opt.delete(:alt) || 'dyi image'
+      title = opt.delete(:title)
+      width = opt.delete(:width)
+      height = opt.delete(:height)
+      opt[:controller] = 'images' unless opt[:controller]
+      opt[:action] = 'dyi' unless opt[:action]
+      opt[:id] = opt.delete(:model_id) || 'dyi'
+      opt[:format] = 'svg' unless opt[:format]
+      tag_parts = ['<img']
+      tag_parts << " id=\"#{element_id}\"" if element_id
+      tag_parts << " src=\"#{url_for(opt)}\""
+      tag_parts << " class=\"#{class_name}\"" if class_name
+      tag_parts << " width=\"#{width}\"" if width
+      tag_parts << " height=\"#{height}\"" if height
+      tag_parts << " alt=\"#{alt}\""
+      tag_parts << " title=\"#{title}\"" if title
+      tag_parts << " />"
+      tag_parts.join
+    end
+    # Returns a HTML +_object_+ element.
+    # @option options [String] :id id of the HTML element
+    # @option options [String] :class CSS class name of the HTML element
+    # @option options [String] :alt equivalent content for those who cannot
+    #   process images or who have image loading disabled. Default to 'dyi image'
+    # @option options [String] :title title of the image
+    # @option options [Integer] :width width of the image
+    # @option options [Integer] :height height of the image
+    # @option options [Symbol, String] :format format of the image. Default to
+    #   +:svg+
+    # @option options [String] :controller controller of Rails' application
+    #   that process the image. Default to 'images'
+    # @option options [String] :action action of Rails' application that process
+    #   the image. Default to <tt>'dyi'</tt>
+    # @option options [String] :model_id id as a parameter passed to the Rails'
+    #   application that process the image. Default to <tt>'dyi'</tt>
+    # @option options [String] other-options other options is passed to +url_for+
+    #   method. See examples
+    # @return [String] HTML +_object_+ element contains URI reference to the
+    #   image
+    # @example
+    #   dyi_object_tag(:width => 200, :height => 150)
+    #   # => <object width="200" height="150" type="image/svg+xml"
+    #   #            data="/images/dyi/dyi.svg">dyi image</object>
+    #
+    #   dyi_object_tag(:format => :png, :width => 200, :height => 150,
+    #                  :id => 'emb', :alt => 'an emblem of the team',
+    #                  :controller => 'teams', :action => 'emblem', :model_id => '1')
+    #   # => <object id="emb" width="200" height="150" type="image/svg+xml"
+    #   #            data="/teams/emblem/1.png">an emblem of the team</object>
+    #
+    #   dyi_object_tag(:format => :png, :width => 200, :height => 150,
+    #                  :id => 'emb', :alt => 'an emblem of the team',
+    #                  :controller => 'teams', :action => 'emblem', :model_id => '1',
+    #                  :color => 'red', :type => 'simple')
+    #   # => <object id="emb" width="200" height="150" type="image/svg+xml"
+    #   #            data="/teams/emblem/1.png">an emblem of the team</object>
+    def dyi_object_tag(options={})
+      opt = options.clone
+      element_id = opt.delete(:id)
+      class_name = opt.delete(:class)
+      alt = opt.delete(:alt) || 'dyi image'
+      title = opt.delete(:title)
+      width = opt.delete(:width)
+      height = opt.delete(:height)
+      mime_type = DyiRails.mime_type(opt[:format] || :svg)
+      opt[:controller] = 'images' unless opt[:controller]
+      opt[:action] = 'dyi' unless opt[:action]
+      opt[:id] = opt.delete(:model_id) || 'dyi'
+      opt[:format] = 'svg' unless opt[:format]
+      tag_parts = ['<object']
+      tag_parts << " id=\"#{element_id}\"" if element_id
+      tag_parts << " data=\"#{url_for(opt)}\""
+      tag_parts << " type=\"#{mime_type}\""
+      tag_parts << " class=\"#{class_name}\"" if class_name
+      tag_parts << " width=\"#{width}\"" if width
+      tag_parts << " height=\"#{height}\"" if height
+      tag_parts << " title=\"#{title}\"" if title
+      tag_parts << ">"
+      tag_parts << alt
+      tag_parts << "</object>"
+      tag_parts.join
+    end
+  end
+end