teepee 0.6.0 → 0.7.0

data/lib/teepee/constants.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+module Teepee
+  TB_COM = "http://thinkingbicycle.com"
+end

data/lib/teepee/errors.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+module Teepee
+  class ParseError < RuntimeError
+  end
+end

data/lib/teepee/number-token.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'active_support/all'
+require 'monkey-patch'
+
+require 'teepee/token'
+
+module Teepee
+  class NumberToken < Token
+    attr_reader :number, :text
+
+    def initialize(text)
+      raise ArgumentError if not text.is_a? String
+      @text = text
+    end
+
+    def parse
+    end
+
+    def to_s
+      number.to_s
+    end
+
+    def to_html
+      to_s
+    end
+
+    class << self
+      def matches? text
+      end
+    end
+  end
+end

data/lib/teepee/paragraph-parser.rb

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'teepee/parser-node'
+require 'teepee/token'
+require 'teepee/commander'
+require 'teepee/actionable-commander'
+require 'teepee/single-character-token'
+require 'teepee/string-token'
+require 'teepee/number-token'
+require 'teepee/tokenizer'
+require 'teepee/command-parser'
+
+module Teepee
+  class ParagraphParser < ParserNode
+    attr_reader :expressions, :tokens
+
+    def initialize(tokens)
+      raise ArgumentError if not tokens.is_a? Array
+      tokens.each {|token| raise ArgumentError if not token.kind_of? ParserNode}
+      @tokens = tokens
+      parse
+    end
+
+    def parse
+      @expressions = []
+      rest = tokens
+      while rest.length > 0
+        if rest.first.is_a? WordToken
+          @expressions << rest.shift
+        elsif rest.first.is_a? WhitespaceToken
+          @expressions << rest.shift
+        elsif rest.first.is_a? BackslashToken
+          command, rest = CommandParser.parse(rest)
+          @expressions << command
+        else
+          return self
+        end
+      end
+    end
+
+    def to_html
+      "<p>\n" + expressions.map(&:to_html).join + "\n</p>\n"
+    end
+  end
+end

data/lib/teepee/parser-node.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+module Teepee
+  class ParserNode
+  end
+end

data/lib/teepee/parser.rb

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'active_support/all'
+require 'monkey-patch'
+
+require 'teepee/constants'
+require 'teepee/errors'
+require 'teepee/parser-node'
+require 'teepee/token'
+require 'teepee/commander'
+require 'teepee/actionable-commander'
+require 'teepee/single-character-token'
+require 'teepee/string-token'
+require 'teepee/number-token'
+require 'teepee/tokenizer'
+require 'teepee/command-parser'
+require 'teepee/paragraph-parser'
+
+module Teepee
+  class Parser < ParserNode
+    attr_reader :paragraphs, :split_tokens, :text, :tokenizer
+
+    def tokens
+      tokenizer.tokens
+    end
+
+    def initialize(text)
+      @text = text
+      @tokenizer = Tokenizer.new text
+      parse
+    end
+
+    def parse
+      @split_tokens = tokens.split {|token| token.class == EmptyNewlinesToken}
+      @paragraphs = @split_tokens.map {|split_tokens| ParagraphParser.new split_tokens}
+    end
+
+    def to_html
+      paragraphs.map(&:to_html).join "\n"
+    end
+  end
+end

data/lib/teepee/single-character-token.rb

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'teepee/token'
+
+module Teepee
+  class SingleCharacterToken < Token
+    def text
+      self.class.character_matched
+    end
+
+    class << self
+      def character_matched
+        self::CHARACTER_MATCHED
+      end
+
+      def matches? text
+        if text.first == character_matched
+          return [self.new, text.rest]
+        else
+          return nil
+        end
+      end
+    end
+  end
+
+  class BackslashToken < SingleCharacterToken
+    CHARACTER_MATCHED = "\\"
+  end
+
+  class LeftBraceToken < SingleCharacterToken
+    CHARACTER_MATCHED = "{"
+  end
+
+  class RightBraceToken < SingleCharacterToken
+    CHARACTER_MATCHED = "}"
+  end
+end

data/lib/teepee/string-token.rb

@@ -0,0 +1,123 @@
+# -*- coding: utf-8 -*-
+# -*- mode: Ruby -*-
+
+# Copyright © 2013-2015, Christopher Mark Gore,
+# Soli Deo Gloria,
+# All rights reserved.
+#
+# 2317 South River Road, Saint Charles, Missouri 63303 USA.
+# Web: http://cgore.com
+# Email: cgore@cgore.com
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright
+#     notice, this list of conditions and the following disclaimer.
+#
+#   * Redistributions in binary form must reproduce the above copyright
+#     notice, this list of conditions and the following disclaimer in the
+#     documentation and/or other materials provided with the distribution.
+#
+#   * Neither the name of Christopher Mark Gore nor the names of other
+#     contributors may be used to endorse or promote products derived from
+#     this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'teepee/token'
+
+module Teepee
+  class StringToken < Token
+    attr_reader :text
+
+    def initialize(text)
+      raise ArgumentError if not text.is_a? String
+      raise ArgumentError if not text =~ self.class.full_match_regex
+      @text = text
+    end
+
+    def to_s
+      @text
+    end
+
+    def to_html
+      @text
+    end
+
+    class << self
+      def full_match_regex
+        self::FULL_MATCH_REGEX # Define this in a child class.
+      end
+
+      def front_match_regex
+        self::FRONT_MATCH_REGEX # Define this in a child class.
+      end
+
+      def count_regex
+        self::COUNT_REGEX # Define this in a child class.
+      end
+
+      def matches? text
+        if text =~ front_match_regex
+          count = text.index count_regex
+          if count.nil?
+            return [self.new(text), ""]
+          else
+            return [self.new(text[0 ... count]), text[count .. -1]]
+          end
+        else
+          return nil
+        end
+      end
+    end
+  end
+
+  class EmptyNewlinesToken < StringToken
+    FULL_MATCH_REGEX = /\A\n\n+\z/
+    FRONT_MATCH_REGEX = /\A\n\n+/
+    COUNT_REGEX = /[^\n]/
+
+    def newlines
+      text
+    end
+  end
+
+  class WhitespaceToken < StringToken
+    FULL_MATCH_REGEX = /\A\s+\z/
+    FRONT_MATCH_REGEX = /\A\s+/
+    COUNT_REGEX = /\S/
+
+    def whitespace
+      text
+    end
+
+    def to_html
+      " " # Replace all whitespace tokens with a single space.
+    end
+  end
+
+  class WordToken < StringToken
+    FULL_MATCH_REGEX = /\A[^\s{}\\]+\z/
+    FRONT_MATCH_REGEX = /[^\s{}\\]+/
+    COUNT_REGEX = /[\s{}\\]/
+
+    def to_html
+      html_escape text
+    end
+
+    def word
+      text
+    end
+  end
+end