asciimath 1.0.0.preview.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e61b8558a971dd887b6e48246a1ee34be6098e
-  data.tar.gz: c7f13147dbb2460cf4ab5564249a0391fdb57095
+  metadata.gz: db33412e95fb41f457c468d34b93d85384ebf114
+  data.tar.gz: 6b62bc0d4745fa50df1dc6329c40d819933be1fd
 SHA512:
-  metadata.gz: 6c7a2f710248ecf71df6a124aecf8e96e0e626b7448831166212572a24cccf615ef85c2f3749531499e3dc2155122c5b219dba012a6cc264de668532ab869962
-  data.tar.gz: 8350a5355cdf93da68d7c9224c8cc820a2fd01b2edee38cd758f6911c75e577f63d5a216b9e2d114c308bb8bd07af95ea1d717b55fd097afedb7b565de8284a4
+  metadata.gz: d8e3fa85489e4d609c90945c161086bc10c7ead9156ce4d10073cae0ff8b994515ec2b736f4dbe2aa6cb0cde2a5e5bd38ebeb6f3a0240104dca1a1fedec78eab
+  data.tar.gz: 44543b4567c6d9eb2572f0254dd3a36f6dad1dacfde9b0fe2bc7ce8dea99e106ea7aa8a59508731353b68d89746ff0c0711c33d1ea743ac814b32a077be1adc9

data/README.md

@@ -1,6 +1,6 @@
-# Asciimath
+# AsciiMath
 
-An [asciimath](http://asciimath.org) parser and MathML generator written in pure Ruby.
+An [AsciiMath](http://asciimath.org) parser and MathML generator written in pure Ruby.
 
 ## Installation
 
@@ -20,11 +20,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Library
+
+First require the library.
+
+```
+require 'asciimath'
+```
+
+Then parse an AsciiMath string.
+
+```
+parsed_expression = AsciiMath.parse(asciimath)
+```
+
+The parsed expression is a set of nested Array and Hash objects.
+
+This expression can then be converted to MathML.
+
+```
+math_ml = parsed_expression.to_mathml
+```
+
+The MathML code is returned as a String.
+
+### Command line
+
+The AsciiMath parser and MathML converter can be invoked via the command line as follows:
+
+```
+asciimath "an asciimath string"
+```
+
+This command will print out the generated MathML code on stdout.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/asciimath/fork )
+1. Fork it ( https://github.com/pepijnve/asciimath/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/asciimath.gemspec

@@ -5,11 +5,11 @@ require 'asciimath/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "asciimath"
-  spec.version       = Asciimath::VERSION
+  spec.version       = AsciiMath::VERSION
   spec.authors       = ["Pepijn Van Eeckhoudt"]
   spec.email         = ["pepijn@vaneeckhoudt.net"]
-  spec.summary       = %q{Asciimath parser and converter}
-  spec.description   = %q{A pure Ruby Asciimath parsing and conversion library.}
+  spec.summary       = %q{AsciiMath parser and converter}
+  spec.description   = %q{A pure Ruby AsciiMath parsing and conversion library.}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/bin/asciimath

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'asciimath/cli'
-::Asciimath::CLI.run(ARGV)
+::AsciiMath::CLI.run(ARGV)

data/lib/asciimath/cli.rb

@@ -1,11 +1,11 @@
 require_relative 'parser'
 require_relative 'mathml'
 
-module Asciimath
+module AsciiMath
   module CLI
     def self.run(args)
       asciimath = args.last
-      mathml = Asciimath.parse(asciimath).to_mathml
+      mathml = AsciiMath.parse(asciimath).to_mathml
       puts mathml
     end
   end

data/lib/asciimath/mathml.rb

@@ -1,4 +1,4 @@
-module Asciimath
+module AsciiMath
   class MathMLBuilder
     def initialize(prefix)
       @prefix = prefix

data/lib/asciimath/parser.rb

@@ -26,7 +26,7 @@ require 'strscan'
 # When parsing the 'constant' the parser will try to find the longest matching string in the symbol
 # table starting at the current position of the parser. If no matching string can be found the
 # character at the current position of the parser is interpreted as an identifier instead.
-module Asciimath
+module AsciiMath
   # Internal: Splits an ASCIIMath expression into a sequence of tokens.
   # Each token is represented as a Hash containing the keys :value and :type.
   # The :value key is used to store the text associated with each token.

data/lib/asciimath/version.rb

@@ -1,3 +1,3 @@
-module Asciimath
-  VERSION = "1.0.0.preview.1"
+module AsciiMath
+  VERSION = "1.0.0"
 end

data/test/parser_spec.rb

@@ -44,17 +44,17 @@ TEST_CASES = {
         '<math><munderover><mo>&#x2211;</mo><mrow><mi>k</mi><mo>=</mo><mn>1</mn></mrow><mi>n</mi></munderover><mi>k</mi><mo>=</mo><mn>1</mn><mo>+</mo><mn>2</mn><mo>+</mo><mo>&#x22EF;</mo><mo>+</mo><mi>n</mi><mo>=</mo><mfrac><mrow><mi>n</mi><mrow><mo>(</mo><mi>n</mi><mo>+</mo><mn>1</mn><mo>)</mo></mrow></mrow><mn>2</mn></mfrac></math>',
 }
 
-module AsciimathHelper
+module AsciiMathHelper
   def expect_mathml(asciimath, mathml)
-    expect(Asciimath.parse(asciimath).to_mathml).to eq(mathml)
+    expect(AsciiMath.parse(asciimath).to_mathml).to eq(mathml)
   end
 end
 
 RSpec.configure do |c|
-  c.include AsciimathHelper
+  c.include AsciiMathHelper
 end
 
-describe "Asciimath::MathMLBuilder" do
+describe "AsciiMath::MathMLBuilder" do
   TEST_CASES.each_pair do |asciimath, mathml|
     it "should produce identical output to asciimathml.js for '#{asciimath}'" do
       expect_mathml(asciimath, mathml)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciimath
 version: !ruby/object:Gem::Version
-  version: 1.0.0.preview.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
-description: A pure Ruby Asciimath parsing and conversion library.
+description: A pure Ruby AsciiMath parsing and conversion library.
 email:
 - pepijn@vaneeckhoudt.net
 executables:
@@ -88,14 +88,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: Asciimath parser and converter
+summary: AsciiMath parser and converter
 test_files:
 - test/parser_spec.rb
+has_rdoc: