prawn_oval_text 0.11.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Daniel Nelson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,49 @@
+= Prawn Oval Text
+
+Provides capacity for drawing ellipse and circle shaped text.
+
+= Usage
+
+  require 'prawn/text/oval'
+
+then
+
+  text_oval(string, options)
+
+where acceptable options are
+
+- :width and :height are the width and height of the ellipse, respectively. If they are equal, then the shape is a circle.
+
+- :at is a two element array denoting the upper left corner of the bounding box around the ellipse.
+
+- :center is a two element array denoting the center of the ellipse. If :center is present, then its value overrides that provided by :at.
+
+- :overflow is :truncate, :shrink_to_fit, or :ellipses, denoting the behavior when the amount of text exceeds the available space. Defaults to :truncate. If :shrink_to_fit, then the font size is decreased
+
+- :crop denotes the space between top of the oval and the first line. It is used to push the starting line lower in the circle when the combination of oval size and font size result in only a few characters being displayable on the very top line.
+
+- :leading is the amount of space between lines. Defaults to 0.
+
+- :kerning is a boolean. Defaults to true. Note that if kerning is on, it will result in slower width computations
+
+- :align is :center, :left, or :right. Defaults to :center.
+
+- :min_font_size is the minimum font-size to use when :overflow is set to :shrink_to_fit (ie: the font size will not be reduced to less than this value, even if it means that some text will be cut off). Defaults to 5
+
+= Example
+
+{http://mindlev.wordpress.com/files/2009/10/oval_text.pdf}[http://mindlev.wordpress.com/files/2009/10/oval_text.pdf]
+
+= Changelog
+
+0.3 - added shrink_to_fit overflow option. fixed so can work with new lines in the text
+
+0.3.2 - changed default kerning to true to match Prawn default
+
+0.4.0 - rewrote as descendent of newly rewritten Prawn::Text::Box. notice change of oval_text method to text_oval
+
+0.10.0 - updated to reflect changes in Prawn::Text developer API
+
+0.10.2 - added :justify as align option
+
+2011-02-14 - incorporated Bundler. I must have been linked to master when I produced this (now avoided by use of Bundler) because this was failing at Prawn 0.10.2 because @character_spacing was not set by Text::Box. updated license to MIT license

data/Rakefile

@@ -0,0 +1,27 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rake/testtask"
+
+task :default => [:test]
+
+desc "Run all tests, test-spec, mocha, and pdf-reader required"
+Rake::TestTask.new do |test|
+  # test.ruby_opts  << "-w"  # .should == true triggers a lot of warnings
+  test.libs       << "spec"
+  test.test_files =  Dir[ "spec/*_spec.rb" ]
+  test.verbose    =  true
+end
+
+desc "run all examples"
+task :examples do
+  mkdir_p "output"
+  examples = Dir["examples/**/*.rb"]
+  t = Time.now
+  puts "Running Examples"
+  examples.each { |file| `ruby -Ilib #{file}` }
+  puts "Ran in #{Time.now - t} s"
+  `mv *.pdf output`
+end

data/examples/example_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'prawn'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'prawn_oval_text'
+
+Prawn.debug = true

data/examples/text/text_oval.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+#
+require File.expand_path(File.join(File.dirname(__FILE__),
+                                   %w[.. example_helper]))
+
+Prawn::Document.generate("text_oval.pdf") do
+  def get_string(i, j)      
+    case i
+    when 0
+      # gqpy to show descender relative to outer circle
+      text = "this is left gqpy " * 20
+    when 1
+      if j == 2
+        text = "this is justify gqpy " * 20
+      else
+        text = "this is center gqpy " * 20
+      end
+    when 2
+      text = "this is right gqpy " * 20
+    end
+    
+    case j
+    when 0
+      text.split(" ").slice(0..47).join(" ")
+    when 3
+      text.delete(" ").insert(51, "\n\n")
+    else
+      text
+    end
+  end
+
+  def get_options(i, j)
+    options = {
+      :width    => bounds.width * 0.3,
+      :height   => bounds.width * 0.3,
+      :overflow => :ellipses,
+      :center   => [0, 0],
+      :align    => :left,
+      :document => self
+    }
+    
+    case i
+    when 0
+      options[:valign] = :top if j == 0
+    when 1
+      options[:align] = :center
+      options[:valign] = :center if j == 0
+      options[:align] = :justify if j == 2
+    when 2
+      options[:align] = :right
+      options[:valign] = :bottom if j == 0
+    end
+    
+    case j
+    when 1
+      options[:overflow] = :shrink_to_fit
+    when 2
+      options[:leading] = font.height * 0.5
+      options[:overflow] = :truncate
+    end
+    options
+  end
+
+  stroke_color("555555")
+  3.times do |i|
+    4.times do |j|
+      options = get_options(i, j)
+      options[:center][0] = bounds.left + options[:width] * 0.5 + (bounds.width  - options[:width]) * 0.5 * i
+      options[:center][1] = bounds.top - options[:height] * 0.5 - (bounds.height - options[:height]) * 0.33 * j
+      oval = Prawn::Text::Oval.new(get_string(i, j), options)
+      stroke_circle(options[:center], options[:width] / 2)
+      oval.render
+    end
+  end
+end

data/lib/prawn_oval_text.rb

@@ -0,0 +1,2 @@
+require "prawn_oval_text/formatted/oval.rb"
+require "prawn_oval_text/oval.rb"

data/lib/prawn_oval_text/formatted/oval.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+
+# prawn_oval_text/formatted/oval.rb : Implements text ovals
+#
+# Copyright October 2009-2011, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Text
+    module Formatted
+
+      def formatted_text_oval(text, options={})
+        Text::Formatted::Oval.new(text, options.merge(:document => self)).render
+      end
+
+      # Provides oval shaped text capacity
+      #
+      class Oval < Prawn::Text::Formatted::Box
+
+        DEFAULT_CROP_INCREMENT = 5
+
+        def valid_options
+          super.concat([:crop, :center])
+        end
+        
+        def initialize(formatted_text, options={})
+
+          super(formatted_text, options)
+
+          @horizontal_radius = options[:width] * 0.5
+          @vertical_radius   = options[:height] * 0.5
+          @height            = options[:height]
+          @center            = [@at[0] + @horizontal_radius,
+                                @at[1] - @vertical_radius]
+          @center            = options[:center] if options[:center]
+          @at                = [@center[0] - @horizontal_radius,
+                                @center[1] + @vertical_radius]
+          @original_x        = @at[0]
+          @align             = options[:align] || :center
+          @vertical_align    = :top
+
+          # the crop lets us start printing text some distance below the
+          # top of the ellipse, otherwise, there may not be enough space
+          # to display much text, which looks bad
+          crop = [options[:crop] || 0, @document.font.descender].max
+          increase_crop(crop)
+        end
+
+        # def height
+        #   @vertical_radius * 2
+        # end
+
+        def available_width
+          @width = compute_max_line_width(@horizontal_radius, @vertical_radius, width_limiting_y)
+          @at[0] = @original_x + @horizontal_radius - @width * 0.5
+          [@width, @line_height].max
+        end
+
+        def render(flags={})
+          @oval_line_height = @document.font.height
+          @oval_descender   = @document.font.descender
+          @oval_ascender    = @document.font.ascender
+          @oval_line_gap    = @document.font.line_gap
+          #          begin
+          #            results = super(flags)
+          super(flags)
+          # rescue Prawn::Errors::CannotFit
+          #   if @baseline_y.abs < @height - @oval_line_height
+          #     increase_crop
+          #     retry
+          #   end
+          #   results = []
+          # end
+          # results
+        end
+        
+        private
+
+        # Override because oval text is more succeptable to change in the lower
+        # part of the circle (due to ever diminishing space), so we want a
+        # finer-grained font reduction
+        #
+        def shrink_to_fit(text)
+          wrap(text)
+          until @everything_printed || @font_size <= @min_font_size
+            @font_size = [@font_size - 0.3, @min_font_size].max
+            @document.font_size = @font_size
+            wrap(text)
+          end
+        end
+
+        # Override because the #word_spacing_for_this_line in
+        # Prawn::Core::Text::Formatted::Wrap recomputes available_width, even
+        # though it has already moved on to the next line
+        #
+        def word_spacing_for_this_line
+          if @align == :justify &&
+              @line_wrap.space_count > 0 &&
+              !@line_wrap.paragraph_finished?
+            (@width - @line_wrap.width) / @line_wrap.space_count
+          else
+            0
+          end
+        end
+
+        def increase_crop(amount=DEFAULT_CROP_INCREMENT)
+          @crop ||= 0
+          @crop   += amount
+          @at[1]  -= amount
+          @height -= amount + 1
+        end
+
+        def oval_baseline_y
+          if @baseline_y == 0
+            -@crop - @oval_ascender
+          else
+            @baseline_y - @crop - (@oval_line_height + @leading)
+          end
+        end
+
+        # Width_limiting_y is the value of y that will be used to compute x;
+        # whereas, y is the vertical position of the text baseline
+        def width_limiting_y
+          return (oval_baseline_y + @vertical_radius + @oval_ascender) if above_x_axis?
+          (oval_baseline_y + @vertical_radius - @oval_descender)
+        end
+
+        # When we are above the x-axis, the top of the ascender is
+        # limited by the ellipse. When below the y-axis, the bottom
+        # of the descender is limited by the ellipse
+        def above_x_axis?
+          (oval_baseline_y + @vertical_radius).abs > (oval_baseline_y + @vertical_radius - @oval_line_height).abs
+        end
+        
+        def compute_max_line_width(a, b, y)
+          # equation of ellipse is x^2 / a^2 + y^2 / b^2 = 1, which
+          # reduces to the following line
+          b_squared = b * b
+          y_squared = [y * y, b_squared].min
+          x = a * Math.sqrt(1 - y_squared / b_squared)
+          2 * x
+        end
+      end
+    end
+  end
+end

data/lib/prawn_oval_text/oval.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+# prawn_oval_text/oval.rb : Implements text ovals
+#
+# Copyright October 2009-2011, Daniel Nelson. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE and COPYING files for details.
+
+module Prawn
+  module Text
+    # Draws the requested text into an oval. When the text overflows
+    # the oval, you can display ellipses, shrink to fit, or
+    # truncate the text
+    #   acceptable options:
+    #
+    #     :width and :height are the width and height of the
+    #       ellipse, respectively. If they are equal, then the shape
+    #       is a circle.
+    #
+    #     :at is a two element array denoting the upper left corner
+    #       of the bounding box around the ellipse
+    #
+    #     :center is a two element array denoting the center of the
+    #       ellipse. If :center is present, then its value overrides
+    #       that provided by :at
+    #
+    #     :overflow is :truncate, :shrink_to_fit, or :ellipses, denoting the
+    #       behavior when the amount of text exceeds the available
+    #       space. Defaults to :truncate.
+    #
+    #     :crop denotes the space between top of the oval and the
+    #       first line. It is used to push the starting line lower in
+    #       the circle when the combination of oval size and font size
+    #       result in only a few characters being displayable on the
+    #       very top line.
+    #
+    #     :leading is the amount of space between lines. Defaults to 0
+    #
+    #     :kerning is a boolean. Defaults to true. Note that if
+    #       kerning is on, it will result in slower width
+    #       computations
+    #   
+    #     :align is :center, :left, :right, or :justify. Defaults to :center
+    #
+    #     :min_font_size is the minimum font-size to use when
+    #       :overflow is set to :shrink_to_fit (ie: the font size
+    #       will not be reduced to less than this value, even if it
+    #       means that some text will be cut off). Defaults to 5
+
+    # +text+ must be UTF8-encoded.
+    #
+    def text_oval(text, options={})
+      Text::Oval.new(text, options.merge(:document => self)).render
+    end
+
+    # Provides oval shaped text capacity
+    #
+    class Oval < Prawn::Text::Formatted::Oval
+
+      def initialize(string, options={})
+        super([{ :text => string }], options)
+      end
+
+      def render(flags={})
+        leftover = super(flags)
+        leftover.collect { |hash| hash[:text] }.join
+      end
+
+    end
+  end
+end

data/prawn_oval_text.gemspec

@@ -0,0 +1,27 @@
+# Version numbering: http://wiki.github.com/sandal/prawn/development-roadmap
+PRAWN_OVAL_TEXT_VERSION = "0.11.1"
+
+Gem::Specification.new do |spec|
+  spec.name = "prawn_oval_text"
+  spec.version = PRAWN_OVAL_TEXT_VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "Oval text for Prawn"
+  spec.files =  Dir.glob("{examples,lib,spec}/**/**/*") +
+                      ["Rakefile", "prawn_oval_text.gemspec"]
+  spec.require_path = "lib"
+  spec.required_ruby_version = '>= 1.8.7'
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.test_files = Dir[ "spec/*_spec.rb" ]
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{README.rdoc LICENSE}
+  spec.rdoc_options << '--title' << 'Prawn Oval Text Documentation' <<
+                       '--main'  << 'README.rdoc' << '-q'
+  spec.authors = ["Daniel Nelson"]
+  spec.email = ["dnelson@bluejade.com"]
+  spec.add_dependency('prawn', '>=0.11.1')
+  spec.homepage = "https://github.com/Bluejade/prawn-oval-text"
+  spec.description = <<END_DESC
+  Adds oval shaped text to Prawn
+END_DESC
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require "prawn"
+require "test/spec"
+require "mocha"
+require "pdf/reader"
+require "pdf/inspector"
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'prawn_oval_text'
+
+
+
+Prawn.debug = true
+
+def create_pdf(klass=Prawn::Document)
+  @pdf = klass.new(:left_margin   => 0,
+                   :right_margin  => 0,
+                   :top_margin    => 0,
+                   :bottom_margin => 0)
+end    

data/spec/text_oval_spec.rb

@@ -0,0 +1,187 @@
+# encoding: utf-8
+require File.join(File.expand_path(File.dirname(__FILE__)), "spec_helper")
+
+describe "Text::Oval" do
+  it "should print text" do
+    create_pdf
+    options = {
+      :width => 162.0,
+      :height => 162.0,
+      :center => [81.0, 639.0],
+      :crop => 0,
+      :document => @pdf
+    }
+    text = "Hello world"
+    text_oval = Prawn::Text::Oval.new(text, options)
+    text_oval.render
+    text = PDF::Inspector::Text.analyze(@pdf.render)
+    text.strings[0].should == "Hello"
+    text.strings[1].should == "world"
+  end
+end
+
+describe "Text::Oval with text than can fit in the oval" do
+  before(:each) do
+    create_pdf
+    @text = "Oh hai text oval. " * 10
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :center => [81.0, 639.0],
+      :crop => 0,
+      :document => @pdf
+    }
+  end
+
+  it "printed text should match requested text, except for trailing or leading white space and that spaces may be replaced by newlines" do
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    text_oval.text.gsub("\n", " ").should == @text.strip
+  end
+
+  it "render should return an empty string because no text remains unprinted" do
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render.should == ""
+  end
+
+  it "should be truncated when the leading is set high enough to prevent all the lines from being printed" do
+    @options[:leading] = 40
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    text_oval.text.gsub("\n", " ").should.not == @text.strip
+  end
+
+  it "printed text should be identical for all three alignments" do
+    @options[:align] = :left
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    left_text = text_oval.text
+
+    @options[:align] = :center
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    center_text = text_oval.text
+
+    @options[:align] = :right
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    right_text = text_oval.text
+
+    left_text.should == center_text
+    center_text.should == right_text
+  end
+end
+
+describe "Text::Oval with longer text than can fit in the oval" do
+  before(:each) do
+    create_pdf
+    @text = "Oh hai text oval. " * 15
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :center => [81.0, 639.0],
+      :crop => 0,
+      :document => @pdf
+    }
+  end
+
+  context "truncated overflow" do
+    before(:each) do
+      @options[:overflow] = :truncate
+      @text_oval = Prawn::Text::Oval.new(@text, @options)
+    end
+    it "should be truncated" do
+      @text_oval.render
+      @text_oval.text.gsub("\n", " ").should.not == @text.strip
+    end
+    it "render should not return an empty string because some text remains unprinted" do
+      @text_oval.render.should.not == ""
+    end
+  end
+
+  context "shrink_to_fit overflow" do
+    before(:each) do
+      @options[:overflow] = :shrink_to_fit
+      @options[:min_font_size] = 2
+      @text_oval = Prawn::Text::Oval.new(@text, @options)
+    end
+    it "should display the entire text" do
+      @text_oval.render
+      @text_oval.text.gsub("\n", " ").should == @text.strip
+    end
+    it "render should return an empty string because no text remains unprinted" do
+      @text_oval.render.should == ""
+    end
+  end
+
+  it "printed text should be identical for all three alignments" do
+    @options[:align] = :left
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    left_text = text_oval.text
+
+    @options[:align] = :center
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    center_text = text_oval.text
+
+    @options[:align] = :right
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    right_text = text_oval.text
+
+    left_text.should == center_text
+    center_text.should == right_text
+  end
+end
+
+describe "Text::Oval with a single word that is longer than can fit in the oval" do
+  before(:each) do
+    create_pdf
+    @text = "Ohhaitextoval" * 100
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :center => [81.0, 639.0],
+      :crop => 0,
+      :document => @pdf
+    }
+  end
+
+  context "with a crop greater than zero" do
+  it "should print less text than without a crop" do
+    @options[:crop] = 0
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    full_text = text_oval.text
+
+    @options[:crop] = @pdf.font.height
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    cropped_text = text_oval.text
+
+    cropped_text.length.should < full_text.length
+    end
+  end
+end
+
+describe "Text::Oval with a solid block of Chinese characters" do
+  before(:each) do
+    create_pdf
+    @text = "写中国字" * 10
+    @options = {
+      :width => 162.0,
+      :height => 162.0,
+      :center => [81.0, 639.0],
+      :crop => 0,
+      :document => @pdf
+    }
+    @pdf.font "#{Prawn::BASEDIR}/data/fonts/gkai00mp.ttf"
+  end
+
+  it "printed text should match requested text, except for newlines" do
+    text_oval = Prawn::Text::Oval.new(@text, @options)
+    text_oval.render
+    text_oval.text.gsub("\n", "").should == @text.strip
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: prawn_oval_text
+version: !ruby/object:Gem::Version 
+  hash: 49
+  prerelease: 
+  segments: 
+  - 0
+  - 11
+  - 1
+  version: 0.11.1
+platform: ruby
+authors: 
+- Daniel Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 11
+        - 1
+        version: 0.11.1
+  type: :runtime
+  version_requirements: *id001
+description: "  Adds oval shaped text to Prawn\n"
+email: 
+- dnelson@bluejade.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- examples/example_helper.rb
+- examples/text/text_oval.rb
+- lib/prawn_oval_text.rb
+- lib/prawn_oval_text/formatted/oval.rb
+- lib/prawn_oval_text/oval.rb
+- spec/text_oval_spec.rb
+- spec/spec_helper.rb
+- Rakefile
+- prawn_oval_text.gemspec
+- README.rdoc
+- LICENSE
+has_rdoc: true
+homepage: https://github.com/Bluejade/prawn-oval-text
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Prawn Oval Text Documentation
+- --main
+- README.rdoc
+- -q
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Oval text for Prawn
+test_files: 
+- spec/text_oval_spec.rb