to_latex 0.1.0 → 0.3.0

data/Rakefile

@@ -18,7 +18,11 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/cie/to_latex"
   gem.license = "MIT"
   gem.summary = %Q{Adds #to_latex to objects and strings to convert them to LaTeX.}
-  gem.description = %Q{Adds #to_latex to objects and strings.}
+  gem.description = %Q{Adds #to_latex to objects and strings. Works like html_safe in Rails 3, it escapes special characters as needed. Once converted, a string becomes a ToLatex::LatexString instance, with #latex? returning true, and never again will be escaped.
+    
+    You can concatenate any escaped or not escaped string to an escaped one, they get properly escaped.
+  
+  This gem powers texerb.}
   gem.email = "kallo.bernat@gmail.com"
   gem.authors = ["Bernát Kalló"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/lib/to_latex.rb

@@ -1,11 +1,15 @@
-class String
-
+module ToLatex
   LATEX_SPECIAL_CHAR = /[\\{}$&\n#^_%~]/
 
-  def to_latex!
-    return self if latex?
+  DELIMITER_PAIRS = { 
+    "$" => "$",
+    "$$" => "$$",
+    "\\(" => "\\)",
+    "\\[" => "\\]"
+  }
 
-    gsub!(LATEX_SPECIAL_CHAR) do |c|
+  def self.escape s
+    s.gsub(LATEX_SPECIAL_CHAR) do |c|
       case c
       when "\\" then '\backslash'
       when "^" then '\char94'
@@ -13,41 +17,73 @@ class String
       else "\\#{c}"
       end
     end
-
-    self.latex!
   end
 
+  # A string converted to latex
+  class LatexString < String
+    def to_latex
+      self
+    end
 
-  def to_latex
-    return self if latex?
+    def latex!
+      self
+    end
 
-    dup.to_latex!
-  end
+    def latex?
+      true
+    end
+
+    def concat value
+      if value.latex?
+        super value
+      else
+        super value.to_latex
+      end
+    end
+    
+    alias << concat
 
-  def to_latex_math
-    "$#{to_latex}$"
+    def +(other)
+      dup.concat(other)
+    end
+
+    def to_s
+      self
+    end
   end
 
+end
 
-  def latex?
-    defined?(@is_latex) && @is_latex
+class String
+  # Convert a string to latex with escaping special characters.
+  def to_latex
+    ToLatex::LatexString.new ToLatex.escape(self)
   end
 
+  # Convert a string to latex without escaping. Despite the bang, this is NOT
+  # destructive, it returns a new object.
   def latex!
-    @is_latex = true
-    self
+    ToLatex::LatexString.new self
   end
 
+  # Tells if this is a string converted to latex
+  def latex?
+    false
+  end
 end
 
 
 
 class Object
+  # Convert an object to latex with escaping
   def to_latex
-    to_s.to_latex!
+    to_s.to_latex
   end
 
-  def to_latex_math
-    "$#{to_latex}$".latex!
+  # Convert an object to latex with escaping and adding $ $ or other delimiter around
+  def to_latex_math open = "$", close = nil
+    close ||= ToLatex::DELIMITER_PAIRS[open] || open
+    ToLatex::LatexString.new "#{open}#{to_latex}#{close}"
   end
 end
+

data/spec/to_latex_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ToLatex" do
-  specify "String" do
+  specify "String#to_latex" do
     '%'.to_latex.should == '\%'
     '!'.to_latex.should == '!'
     '^'.to_latex.should == '\char94'
@@ -12,19 +12,89 @@ describe "ToLatex" do
 
     a = 'a'
     a.should_not be_latex
-    a.to_latex!.should be_equal a
-    a.should be_latex
+    a.to_latex.should_not be_equal a
+    a.to_latex.should be_latex
+  end
+
+  specify "String#latex!" do
+    '%'.latex!.should == '%'
+    '!'.latex!.should == '!'
+    '^'.latex!.should == '^'
+    'a'.latex!.should == 'a'
+
+    'a'.latex!.should be_latex
+
+    a = 'a'
+    a.should_not be_latex
+    a.latex!.should_not be_equal a
+    a.latex!.should be_latex
+
+    b = a.to_latex
+    b.latex!.should be_equal b
+  end
+
+  specify "String#latex! is not destructive" do
+    "a%!\\#".freeze.latex!
+  end
 
+  specify "String#to_latex is not destructive" do
+    "a%!\\#".freeze.to_latex
   end
 
+
+
   specify "Integer" do
     5.to_latex.should == "5"
   end
 
   specify "to_latex_math" do
     5.to_latex_math.should == "$5$"
+    5.to_s.to_latex_math.should == "$5$"
+    5.to_s.to_latex.to_latex_math.should == "$5$"
+    5.to_s.to_latex.to_latex_math.to_latex.should == "$5$"
     "a".to_latex_math.should == "$a$"
+    "a".to_s.to_latex_math.should == "$a$"
+    "a".to_s.to_latex.to_latex_math.should == "$a$"
+    "a".to_s.to_latex.to_latex_math.to_latex.should == "$a$"
+    "5%".to_latex_math.should == "$5\\%$"
+    "5%".to_s.to_latex_math.should == "$5\\%$"
+    "5%".to_s.to_latex.to_latex_math.should == "$5\\%$"
+    "5%".to_s.to_latex.to_latex_math.to_latex.should == "$5\\%$"
+
+    "5%".to_latex_math("\\[").should == "\\[5\\%\\]"
+    "5%".to_latex_math("\\(").should == "\\(5\\%\\)"
+    "5%".to_latex_math("$").should == "$5\\%$"
+    "5%".to_latex_math("$$").should == "$$5\\%$$"
+    "5%".to_latex_math("a").should == "a5\\%a"
+    "5%".to_latex_math("a","b").should == "a5\\%b"
   end
 
+  specify "dup" do
+    "a".dup.should_not be_latex
+    "a".to_latex.dup.should be_latex
+    "a".to_latex.dup.should == "a"
+  end
+
+  specify "concat" do
+    ("a" + "#").should == "a#"
+    ("a".concat "#").should == "a#"
+    ("a" << "#").should == "a#"
+    ("a".to_latex + "#").should == "a\\#"
+    ("a".to_latex.concat "#").should == "a\\#"
+    ("a".to_latex << "#").should == "a\\#"
+    ("a".to_latex + "#".to_latex).should == "a\\#"
+    ("a".to_latex.concat "#".to_latex).should == "a\\#"
+    ("a".to_latex << "#".to_latex).should == "a\\#"
+    ["a\\".to_latex]
+  end
+
+  specify "to_s[tr]" do
+    a="a".to_latex
+    a.to_s.should == "a"
+    a.to_s.should be_latex
+    a.to_str.should == "a"
+    a.to_str.should_not be_latex
+  end
+  
 
 end

data/to_latex.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "to_latex"
-  s.version = "0.1.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bern\u{e1}t Kall\u{f3}"]
-  s.date = "2012-03-13"
-  s.description = "Adds #to_latex to objects and strings."
+  s.date = "2012-03-15"
+  s.description = "Adds #to_latex to objects and strings. Works like html_safe in Rails 3, it escapes special characters as needed. Once converted, a string becomes a ToLatex::LatexString instance, with #latex? returning true, and never again will be escaped.\n    \n    You can concatenate any escaped or not escaped string to an escaped one, they get properly escaped.\n  \n  This gem powers texerb."
   s.email = "kallo.bernat@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: to_latex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000Z
+date: 2012-03-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79518630 !ruby/object:Gem::Requirement
+  requirement: &75258230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *79518630
+  version_requirements: *75258230
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &79518340 !ruby/object:Gem::Requirement
+  requirement: &75257890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *79518340
+  version_requirements: *75257890
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &79518020 !ruby/object:Gem::Requirement
+  requirement: &75257580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *79518020
+  version_requirements: *75257580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &79517720 !ruby/object:Gem::Requirement
+  requirement: &75257280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *79517720
+  version_requirements: *75257280
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &79517360 !ruby/object:Gem::Requirement
+  requirement: &75256940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,8 +65,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79517360
-description: ! 'Adds #to_latex to objects and strings.'
+  version_requirements: *75256940
+description: ! "Adds #to_latex to objects and strings. Works like html_safe in Rails
+  3, it escapes special characters as needed. Once converted, a string becomes a ToLatex::LatexString
+  instance, with #latex? returning true, and never again will be escaped.\n    \n
+  \   You can concatenate any escaped or not escaped string to an escaped one, they
+  get properly escaped.\n  \n  This gem powers texerb."
 email: kallo.bernat@gmail.com
 executables: []
 extensions: []
@@ -101,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 907125359
+      hash: 172590191
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: