mathemagical 0.0.1

data/README.md

@@ -0,0 +1,21 @@
+Mathemagical
+============
+
+## Usage and such
+
+Things will go here.  Oh, yes.  They will.
+
+## Origins
+
+The `math_ml` gem is a perfectly fine MathML parser, but for my needs, it had a few issues:
+
+* It requires `eim_xml`.  I'd prefer not to introduce an XML generation library into production if I don't have to.  This library uses a simple homegrown XML generation system that covers all our needs without an extra, unverified gem floating about.
+* It lacks a binscript.  Not a huge deal, but I'd have to write one anyhow since it's GPL2.
+* It's crufty and had a few bugs.  I'll continually be improving the quality of the code as I work on this.
+* There was no place to contribute to the code that I could find.
+
+So I decided to fork it.  Since most interpretations of the GPL say that if you fork, you must rename, I decided to rename my fork to Mathemagical.
+
+## License
+
+The original `math_ml` gem is license under the GPL Version 2.  My modifications are licensed under the BSD License or whatever is most liberal, but since the original code is all GPL2, it doesn't really matter much.

data/Rakefile

@@ -0,0 +1,136 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/mathemagical

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'mathemagical'
+require 'mathemagical/string'
+
+puts STDIN.read.to_mathml

data/lib/mathemagical.rb

@@ -0,0 +1,24 @@
+# MathML Library
+#
+# Copyright (C) 2005, KURODA Hiraku <hiraku@hinet.mydns.jp>
+# You can redistribute it and/or modify it under GPL2.
+
+require "strscan"
+require "htmlentities"
+
+module Mathemagical
+  VERSION = '0.0.1' unless defined?(:VERSION)
+
+	class Error < StandardError; end
+
+	def self.encode(s)
+    @entities ||= HTMLEntities.new
+
+    # TODO: HTMLEntities Y U DOUBLE ENCODE??
+    @entities.encode(s).gsub(/&amp;([#a-zA-Z0-9]{2,24});/, '&\1;')
+  end
+end
+
+require "mathemagical/element"
+require "mathemagical/symbol/entity_reference"
+require "mathemagical/latex"

data/lib/mathemagical/element.rb

@@ -0,0 +1,304 @@
+module Mathemagical
+	class Element
+		attr_reader :display_style, :attributes, :children
+		attr_accessor :name
+
+		def initialize(name, options = {})
+			@name = name
+			@attributes = options
+			@children = []
+		end
+
+		def as_display_style
+			@display_style = true
+			self
+		end
+
+		def []=(key, value)
+			@attributes[key.to_sym] = value
+		end
+
+		def [](key)
+			@attributes[key.to_sym]
+		end
+
+		def <<(*obj)
+			@children += obj.flatten.map {|o| o.is_a?(String) ? Mathemagical.encode(o) : o }
+
+			self
+		end
+
+		def to_s
+			children.empty? ? self_closing_xml : xml
+		end
+
+		def self_closing_xml
+			"<#{@name}#{build_attributes_string} />"
+		end
+
+		def xml
+			"<#{@name}#{build_attributes_string}>
+				#{child_ml}
+			</#{@name}>".gsub(/[\n\t]/, '')
+		end
+
+		def child_ml
+			@children.map(&:to_s).join("\n")
+		end
+
+		def build_attributes_string
+			return if @attributes.empty?
+
+			" " + @attributes.map do |key, value|
+				"#{key}='#{value}'"
+			end.join(" ")
+		end
+
+		def pop
+			@children.pop
+		end
+	end
+
+	module Variant
+		NORMAL = "normal"
+		BOLD = "bold"
+		BOLD_ITALIC = "bold-italic"
+		def variant=(v)
+			self["mathvariant"] = v
+		end
+	end
+
+	module Align
+		CENTER = "center"
+		LEFT = "left"
+		RIGHT = "right"
+	end
+
+	module Line
+		SOLID = "solid"
+		NONE = "none"
+	end
+
+	class Math < Element
+		def initialize(display_style)
+			super("math", "xmlns"=>"http://www.w3.org/1998/Math/MathML")
+			self[:display] = display_style ? "block" : "inline"
+		end
+	end
+
+	class Row < Element
+		def initialize
+			super("mrow")
+		end
+	end
+
+	class Break < Element
+		def initialize
+			super("br", :xmlns => 'http://www.w3.org/1999/xhtml')
+		end
+	end
+
+	class None < Element
+		def initialize
+			super("none")
+		end
+	end
+
+	class Space < Element
+		def initialize(width)
+			super("mspace", "width"=>width)
+		end
+	end
+
+	class Fenced < Element
+		attr_reader :open, :close
+
+		def initialize
+			super("mfenced")
+		end
+
+		def open=(o)
+			o = "" if o.to_s=="." || !o
+			o = "{" if o.to_s=="\\{"
+			self[:open] = Mathemagical.encode(o)
+		end
+
+		def close=(c)
+			c = "" if c.to_s=="." || !c
+			c = "}" if c.to_s=="\\}"
+			self[:close] = Mathemagical.encode(c)
+		end
+	end
+
+	class Frac < Element
+		def initialize(numerator, denominator)
+			super("mfrac")
+			self << numerator
+			self << denominator
+		end
+	end
+
+	class SubSup < Element
+		attr_reader :sub, :sup, :body
+
+		def initialize(display_style, body)
+			super("mrow")
+			as_display_style if display_style
+			@body = body
+		end
+
+		def update_name
+			if @sub || @sup
+				name = "m"
+				name << (@sub ? (@display_style ? "under" : "sub") : "")
+				name << (@sup ? (@display_style ? "over" : "sup") : "")
+			else
+				name = "mrow"
+			end
+			self.name = name
+		end
+		private :update_name
+
+		def update_contents
+			children.clear
+			children << @body
+			children << @sub if @sub
+			children << @sup if @sup
+		end
+		private :update_contents
+
+		def update
+			update_name
+			update_contents
+		end
+		private :update
+
+		def sub=(sub)
+			@sub = sub
+			update
+		end
+
+		def sup=(sup)
+			@sup = sup
+			update
+		end
+	end
+
+	class Over < Element
+		def initialize(base, over)
+			super("mover")
+			self << base << over
+		end
+	end
+
+	class Under < Element
+		def initialize(base, under)
+			super("munder")
+			self << base << under
+		end
+	end
+
+	class Number < Element
+		def initialize
+			super("mn")
+		end
+
+		def <<(o)
+			@children << o
+			self
+		end
+	end
+
+	class Identifier < Element
+		def initialize
+			super("mi")
+		end
+
+		def <<(o)
+			@children << Mathemagical.encode(o)
+			self
+		end
+	end
+
+	class Operator < Element
+		def initialize
+			super("mo")
+		end
+
+		def <<(o)
+			@children << Mathemagical.encode(o)
+			self
+		end
+	end
+
+	class Text < Element
+		def initialize
+			super("mtext")
+		end
+
+		def <<(o)
+			@children << Mathemagical.encode(o)
+			self
+		end
+	end
+
+	class Sqrt < Element
+		def initialize
+			super("msqrt")
+		end
+	end
+
+	class Root < Element
+		def initialize(index, base)
+			super("mroot")
+			self << base
+			self << index
+		end
+	end
+
+	class Table < Element
+		def initialize
+			super("mtable")
+		end
+
+		def set_align_attribute(name, a, default)
+			if a.is_a?(Array) && a.size>0
+				value = ""
+				a.each do |i|
+					value << " "+i
+				end
+				if value =~ /^( #{default})*$/
+					@attributes.delete(name)
+				else
+					@attributes[name] = value.strip
+				end
+			else
+				@attributes.delete(name)
+			end
+		end
+
+		def aligns=(a)
+			set_align_attribute("columnalign", a, Align::CENTER)
+		end
+
+		def vlines=(a)
+			set_align_attribute("columnlines", a, Line::NONE)
+		end
+
+		def hlines=(a)
+			set_align_attribute("rowlines", a, Line::NONE)
+		end
+	end
+
+	class Tr < Element
+		def initialize
+			super("mtr")
+		end
+	end
+
+	class Td < Element
+		def initialize
+			super("mtd")
+		end
+	end
+end