fractals 1.2.0

data/lib/fractals/renderers.rb

@@ -0,0 +1,169 @@
+#--
+# Copyright (c) 2009  Ryan Baxter
+#++
+
+module Fractals
+  # Rendering modules for the PNG and RMagick libraries and JRuby.
+  module Renderers
+    begin; require 'rubygems'; rescue LoadError; end
+
+    # Inherited by Fractal, Renderers::Base includes traits common to each of
+    # the rendering modules.
+    class Base
+      # The number that determines if an iteration is approaching inifinity.
+      attr_accessor :bailout
+      # The maximum number of iterations to perform on an expression.
+      attr_accessor :max_iterations
+      # The last iteration number of a complex coordinate.  Determined by the
+      # in_set? method.
+      attr_accessor :last_iteration
+      # The renderer's coloring algorithm.
+      attr_accessor :algorithm
+      # The width of the fractal image.
+      attr_accessor :width
+      # The height of the fractal image.
+      attr_accessor :height
+      # The magnification level of the fractal in powers of 100.
+      attr_accessor :magnification
+      # The coloring theme applied to complex coordinates that lie outside of
+      # the fractal set.
+      attr_accessor :theme
+      # The color of complex coordinates inside the fractal set.  Expects an
+      # array of RGB values [R, G, B].
+      attr_accessor :set_color
+
+      # Sets the default property values.
+      def initialize(bailout=2, max_iterations=50, algorithm=Algorithms::EscapeTime)
+        @bailout, @max_iterations = bailout, max_iterations
+        @algorithm = algorithm
+        @width, @height = 300, 300
+        @magnification = 1.0
+        @theme, @set_color = Themes::Fire, [0, 0, 0]
+      end
+
+      # Determines if a complex coordinate lies within the fractal's set.
+      def in_set?(c)
+        @args[:c] = c
+        iterate(@max_iterations) do |i, z|
+          if z.abs > @bailout then
+            @last_iteration = i
+            return false
+          end
+        end
+        return true
+      end
+
+      # Loops through each x, y value pair yielding the pair and its RGB color
+      # value as an array [R, G, B].
+      def render
+        (0...@width).each do |x|
+          (0...@height).each do |y|
+            if !in_set?(where_is?(x, y)) then
+              yield x, y, @theme.call(@algorithm.call(self))
+            else
+              yield x, y, @set_color
+            end
+          end
+        end
+      end
+
+      # Extends the Renderers::Base class with the provided module.
+      #
+      # =Example:
+      # mandelbrot = Mandelbrot.new<br />
+      # mandelbrot.<b>renderer =</b> Renderers::RMagickRenderer
+      def renderer=(renderer)
+        self.extend renderer
+      end
+
+      # Includes the provided module.  Use the renderer= method for setting the
+      # renderer at runtime.
+      def self.acts_as_renderer(renderer)
+        include renderer
+      end
+
+      # Determines the location of an x, y value pair on the complex coordinate
+      # plane.
+      def where_is?(x, y)
+        Complex(@c.real - (@width / 2 * scale) + (x * scale),
+                  @c.image - (@height / 2 * scale) + (y * scale))
+      end
+
+      private
+      def scale
+        0.01 / @magnification
+      end
+    end
+
+    # Renders fractals using the PNG library.  PNGRenderer is the default
+    # renderer.
+    module PNGRenderer
+      begin; require 'png'; rescue LoadError; end
+
+      # Returns the fractal image as a BLOB.
+      def to_blob()
+        canvas = PNG::Canvas.new(@width, @height)
+        render do |x, y, color|
+          canvas[x, (y - @height).abs - 1] = PNG::Color.new(color[0], color[1], color[2], 255)
+        end
+
+        PNG.new(canvas).to_blob
+      end
+
+      # Writes the image to the specifiec file path.
+      def write(file_path='fractal.png')
+        File.open(file_path, 'wb') { |file| file.write(to_blob) }
+      end
+    end
+
+    # Renders fractals using the RMagick library.
+    module RMagickRenderer
+      begin; require 'RMagick'; rescue LoadError; end
+
+      # Returns the fractal image as a BLOB of the specified file format.
+      #
+      # =Example:
+      # mandelbrot = Mandelbrot.new<br />
+      # mandelbrot.renderer = Renderers::RMagickRenderer<br />
+      # blob = mandelbrot.<b>to_blob('jpg')</b>
+      def to_blob(file_format)
+        image = Magick::Image.new(@width, @height)
+        render do |x, y, color|
+          image.pixel_color(x, y, "rgb(#{color.join(',')})")
+        end
+
+        image.to_blob { self.format = file_format; self.quality = 100 }
+      end
+
+      # Writes the image to the specified file path.
+      def write(file_path='fractal.png')
+        File.open(file_path, 'wb') do |file|
+          file.write(to_blob(file_path.split('.').last))
+        end
+      end
+    end
+
+    # Renders fractals using native Java libraries.
+    module JRubyRenderer
+      begin; include Java; rescue NameError; end
+
+      # Writes the image to the specified file path.
+      def write(file_path='fractal.png')
+        import java.awt.image.BufferedImage
+        import javax.imageio.ImageIO
+
+        buffered_image = BufferedImage.new(@width, @height, BufferedImage::TYPE_INT_RGB)
+        render do |x, y, color|
+          buffered_image.setRGB(x, y, to_rgb(color))
+        end
+
+        ImageIO.write(buffered_image, file_path.split('.').last, java.io.File.new(file_path))
+      end
+
+      private
+      def to_rgb(color)
+        (color[0] << 16) + (color[1] << 8) + color[2]
+      end
+    end
+  end
+end

data/lib/fractals/themes.rb

@@ -0,0 +1,48 @@
+#--
+# Copyright (c) 2009  Ryan Baxter
+#++
+
+module Fractals
+  # Each themes returns an array of RGB values [R, G, B] for the provided color
+  # index.
+  #
+  # <b>Fire</b>::   The default theme.  Themes::Fire produces bright fiery
+  #                 fractals.
+  # <b>Water</b>::  Deep blues and greens.
+  # <b>Winter</b>:: Lots of blue. Looks best with set_color = [255, 255, 255].
+  # <b>None</b>::   Coordinates outside the fractal set will appear white in
+  #                 color.
+  # <br />
+  # =Example:
+  # mandelbrot = Mandelbrot.new<br />
+  # mandelbrot.theme = <b>Themes::Winter</b>
+  module Themes
+    #:stopdoc:
+    Fire = lambda do |index|
+      case
+        when index >= 510 then return [255, 255, index % 255]
+        when index >= 255 then return [255, index % 255, 0]
+        else return [index % 255, 0, 0]
+      end
+    end
+
+    Water = lambda do |index|
+      case
+        when index >= 510 then return [index % 255, 255 - (index % 255), 0]
+        when index >= 255 then return [0, index - 255, 255 - (index - 255)]
+        else return [0, 0, index]
+      end
+    end
+
+    Winter = lambda do |index|
+      case
+        when index >= 510 then return [0, 255 % index, 255]
+        when index >= 255 then return [0, index % 255, 255]
+        else return [0, 0, index % 255]
+      end
+    end
+
+    None = lambda { |index| return [255, 255, 255] }
+    #:startdoc:
+  end
+end

data/test/burning_ship_test.rb

@@ -0,0 +1,19 @@
+require 'fractals'
+require 'test/unit'
+
+include Fractals
+
+class BurningShipTest < Test::Unit::TestCase
+  def setup
+    burning_ship = BurningShip.new
+    burning_ship.write
+  end
+
+  def teardown
+    File.delete('fractal.png')
+  end
+
+  def test_file_size
+    assert_equal(13326, File.size?('fractal.png'))
+  end
+end

data/test/julia_test.rb

@@ -0,0 +1,20 @@
+require 'fractals'
+require 'test/unit'
+
+include Fractals
+
+class JuliaTest < Test::Unit::TestCase
+  def setup
+    julia = Julia.new
+    julia.write
+  end
+
+  def teardown
+    File.delete('fractal.png')
+  end
+
+  def test_file_size
+    assert_equal(16005, File.size?('fractal.png'))
+  end
+end
+

data/test/mandelbrot_test.rb

@@ -0,0 +1,19 @@
+require 'fractals'
+require 'test/unit'
+
+include Fractals
+
+class MandelbrotTest < Test::Unit::TestCase
+  def setup
+    mandelbrot = Mandelbrot.new
+    mandelbrot.write
+  end
+
+  def teardown
+    File.delete('fractal.png')
+  end
+
+  def test_file_size
+    assert_equal(12046, File.size?('fractal.png'))
+  end
+end

data/test/newton_test.rb

@@ -0,0 +1,20 @@
+require 'fractals'
+require 'test/unit'
+
+include Fractals
+
+class NewtonTest < Test::Unit::TestCase
+  def setup
+    newton = Newton.new
+    newton.write
+  end
+
+  def teardown
+    File.delete('fractal.png')
+  end
+
+  def test_file_size
+    assert_equal(4753, File.size?('fractal.png'))
+  end
+end
+

data/test/renderer_test.rb

@@ -0,0 +1,21 @@
+require 'fractals'
+require 'test/unit'
+
+include Fractals
+
+class MandelbrotTest < Test::Unit::TestCase
+  def test_false_in_set?
+    mandelbrot = Mandelbrot.new
+    assert_equal(false, mandelbrot.in_set?(Complex(-5.0, -5.0)))
+  end
+
+  def test_true_in_set?
+    mandelbrot = Mandelbrot.new
+    assert_equal(true, mandelbrot.in_set?(Complex(0.0, 0.0)))
+  end
+
+  def test_where_is?
+    mandelbrot = Mandelbrot.new
+    assert_equal(Complex(-2.15, -1.5), mandelbrot.where_is?(0, 0))
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: fractals
+version: !ruby/object:Gem::Version 
+  version: 1.2.0
+platform: ruby
+authors: 
+- Ryan Baxter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rcbaxter@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- examples.rb
+- gpl-2.0.txt
+- README
+files: 
+- examples.rb
+- gpl-2.0.txt
+- Rakefile
+- README
+- doc/fr_method_index.html
+- doc/classes
+- doc/classes/Fractals.html
+- doc/classes/Fractals
+- doc/classes/Fractals/Fractal.html
+- doc/classes/Fractals/Newton.html
+- doc/classes/Fractals/BurningShip.html
+- doc/classes/Fractals/Julia.html
+- doc/classes/Fractals/Renderers
+- doc/classes/Fractals/Renderers/JRubyRenderer.html
+- doc/classes/Fractals/Renderers/RMagickRenderer.html
+- doc/classes/Fractals/Renderers/PNGRenderer.html
+- doc/classes/Fractals/Renderers/Base.html
+- doc/classes/Fractals/Renderers.html
+- doc/classes/Fractals/Themes.html
+- doc/classes/Fractals/Mandelbrot.html
+- doc/classes/Fractals/Algorithms.html
+- doc/files
+- doc/files/examples_rb.html
+- doc/files/README.html
+- doc/files/gpl-2_0_txt.html
+- doc/files/lib
+- doc/files/lib/fractals_rb.html
+- doc/files/lib/fractals
+- doc/files/lib/fractals/themes_rb.html
+- doc/files/lib/fractals/renderers_rb.html
+- doc/files/lib/fractals/algorithms_rb.html
+- doc/fr_file_index.html
+- doc/index.html
+- doc/created.rid
+- doc/fr_class_index.html
+- doc/rdoc-style.css
+- lib/fractals.rb
+- lib/fractals
+- lib/fractals/algorithms.rb
+- lib/fractals/themes.rb
+- lib/fractals/renderers.rb
+- test/burning_ship_test.rb
+- test/newton_test.rb
+- test/renderer_test.rb
+- test/julia_test.rb
+- test/mandelbrot_test.rb
+has_rdoc: true
+homepage: http://ryanbaxter.net/pages/ruby_fractal_library
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A library for creating fractals in the Ruby programming language.
+test_files: 
+- test/burning_ship_test.rb
+- test/newton_test.rb
+- test/renderer_test.rb
+- test/julia_test.rb
+- test/mandelbrot_test.rb