math-to-itex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40247677aebef7cb0db52225dfcea7fa71dba988
+  data.tar.gz: b967b3faa38349251329182b80ad17c53f52c7ed
+SHA512:
+  metadata.gz: 45e8d6ec89382cda0175d380dbf2b2fd0438c308a1192cf26a9f57e80ea7d5322db5b7356dafa52a2cbef748b926291476da9b3476642197c73c27253c5b5666
+  data.tar.gz: 0d704f0cf2319393ad728cb89c8385eb762c5688b818dff9e08f4d399d1f9f08aed2fc320980058b073d5612a293d4f8eb2ab2cc81ae7c8533f3a470cbaa605c

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Garen Torikian
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# Math to Itex
+
+Convert strings into a proper [itex](http://golem.ph.utexas.edu/~distler/blog/itex2MML.html) format.
+
+[![Build Status](https://travis-ci.org/gjtorikian/math-to-itex.svg?branch=master)](https://travis-ci.org/gjtorikian/math-to-itex)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'math-to-itex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install math-to-itex
+
+## Usage
+
+This gem depends on [refinements](http://blog.headius.com/2012/11/refining-ruby.html), which is a Ruby 2.1+ feature. To use it:
+
+``` ruby
+require 'math-to-itex'
+using MathToItex
+
+result = '\[a \ne 0\]'.convert_to_itex
+# result is now `$$a \ne 0$$`
+
+result = '\[a \ne 0\]'.convert_to_itex { |string| "<span>#{string}</span>" }
+# result is now `<span>$$a \ne 0$$</span>`
+```
+
+Basically, by not passing a block, you do a simple convert. By passing a block,
+you can modify the resulting math equation.
+
+Behind the scenes, `MathToItex` uses `gsub`, so *all* equations in a string are
+modified.
+
+If you want, you can determine the type (inline or display), too:
+
+``` ruby
+result = '$0$ is not equal to $$1 = 0$$'.convert_to_itex do |string, type|
+  %|<span class="#{type}">#{string}</span>|
+end
+
+# result is `<span class="inline">$0$</span> is not equal to <span class="display">$$1 = 0$$</span>`
+```
+
+## Matched math notations
+
+Currently, the following formats are supported:
+
+| inline formulas | display formulas |
+| ------------- |-------------|
+| `$...$`      | `$$...$$`
+| `(...)`      | `[...]`
+| &nbsp;      | `\begin{equation}...\end{equation}`
+
+## More math stuff
+
+Check out [Mathematical](https://github.com/gjtorikian/mathematical), which quickly
+converts itex notation equations into beautiful SVGs.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/math-to-itex.rb

@@ -0,0 +1,38 @@
+require "math-to-itex/parser"
+require "math-to-itex/version"
+
+module MathToItex
+  refine String do
+    def convert_to_itex(&block)
+      self.gsub(MathToItex::Parser::REGEX) do |maths|
+        if maths =~ /\A\$(?!\$)/
+          just_maths = maths[1..-2]
+          type = :inline
+        elsif maths =~ /^\\\((?!\\\()/
+          just_maths = maths[2..-3]
+          type = :inline
+        elsif maths =~ /\A\$\$/
+          just_maths = maths[2..-3]
+          type = :display
+        elsif maths =~ /\A\\\[(?!\\\[)/
+          just_maths = maths[2..-3]
+          type = :display
+        elsif maths =~ /\A\\begin(?!\\begin)/
+          just_maths = maths[16..-15]
+          type = :display
+        end
+
+        # this is the format itex2MML expects
+        if type == :inline
+          just_maths = "$#{just_maths}$"
+        else
+          just_maths = "$$#{just_maths}$$"
+        end
+
+        next(just_maths) if block.nil?
+
+        yield just_maths, type
+      end
+    end
+  end
+end

data/lib/math-to-itex/parser.rb

@@ -0,0 +1,30 @@
+module MathToItex
+  class Parser
+    # https://stackoverflow.com/questions/14182879/regex-to-match-latex-equations
+    REGEX = /
+    (?<!\\)    # negative look-behind to make sure start is not escaped
+    (?:       # start non-capture group for all possible match starts
+        # group 1, match dollar signs only
+        # single or double dollar sign enforced by look-arounds
+        ((?<!\$)\${1,2}(?!\$))|
+        # group 2, match escaped parenthesis
+        (\\\()|
+        # group 3, match escaped bracket
+        (\\\[)|
+        # group 4, match begin equation
+        (\\begin\{equation\})
+    )
+    (.*?(\g<1>)?.*?)  # match everything in between including nested LaTeX equations
+    (?<!\\)  # negative look-behind to make sure end is not escaped
+        # if group 1 was start, match \1
+        (?(1)(?<!\$)\1(?!\$)|
+        # if group 2 was start, escaped parenthesis is end
+        (?(2)\\\)|
+        # if group 3 was start, escaped bracket is end
+        (?(3)\\\]|
+        # otherwise group 4 was start, match end equation
+        \\end\{equation\}
+    )))
+    /x
+  end
+end

data/lib/math-to-itex/version.rb

@@ -0,0 +1,3 @@
+module MathToItex
+  VERSION = "0.1.0"
+end

data/math-to-itex.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'math-to-itex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "math-to-itex"
+  spec.version       = MathToItex::VERSION
+  spec.authors       = ["Garen Torikian"]
+  spec.email         = ["gjtorikian@gmail.com"]
+  spec.summary       = %q{Turn math syntaxes into itex equations.}
+  spec.description   = %q{Pass in a string and turn all math equations into itex equations. Or, pass in a block manipulate multiple matches.}
+  spec.homepage      = "https://github.com/gjtorikian/math-to-itex"
+  spec.license       = "MIT"
+
+  spec.files         = %w(LICENSE.txt README.md Rakefile math-to-itex.gemspec)
+  spec.files         += Dir.glob("lib/**/*")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: math-to-itex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pass in a string and turn all math equations into itex equations. Or,
+  pass in a block manipulate multiple matches.
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/math-to-itex.rb
+- lib/math-to-itex/parser.rb
+- lib/math-to-itex/version.rb
+- math-to-itex.gemspec
+homepage: https://github.com/gjtorikian/math-to-itex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Turn math syntaxes into itex equations.
+test_files: []