teepee 0.6.0 → 0.7.0

data/lib/teepee/actionable-commander.rb

@@ -0,0 +1,89 @@
+# -*- 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/commander'
+
+include ERB::Util
+
+module Teepee
+  class ActionableCommander < Commander
+    def initialize action_view, controller
+      @action_view = action_view
+      @controller = controller
+    end
+
+    def id_command_handler(id,
+                           klass,
+                           singular = klass.to_s.camelcase_to_snakecase,
+                           plural = singular.pluralize,
+                           partial = "#{plural}/inline",
+                           view="")
+      if not id
+        command_error "#{singular}_id: error: no #{singular} ID specified"
+      elsif not id.to_s =~ /\A[0-9]+\z/
+        command_error "#{singular}_id: error: invalid #{singular} ID specified"
+      else
+        thing = klass.find Integer(id.to_s)
+        if thing
+          @@action_view.render partial: partial,
+                               locals: {singular.to_sym => thing}
+        else
+          command_error "unknown #{singular} ID #{id.to_s}"
+        end
+      end
+    end
+
+    def user user
+      if not user
+        command_error "user: error: no user specified"
+      else
+        the_user = User.smart_find user.to_s
+        if the_user
+          @action_view.render partial: 'users/name_link',
+                              locals: {the_user: the_user}
+        else
+          command_error "unknown user #{user.to_s}"
+        end
+      end
+    end
+  end
+end

data/lib/teepee/command-parser.rb

@@ -0,0 +1,268 @@
+# -*- 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/commander'
+require 'teepee/actionable-commander'
+
+module Teepee
+  class CommandParser < ParserNode
+    attr_reader :command, :expressions
+
+    def initialize(command, expressions)
+      raise ArgumentError if not command.is_a? WordToken
+      @command = command
+      raise ArgumentError if not expressions.is_a? Array
+      expressions.each do |expression|
+        raise ArgumentError if not expression.kind_of? ParserNode
+      end
+      @expressions = expressions
+    end
+
+    def command_error(message)
+      %{<span style="color: red">[#{message}]</span>}
+    end
+
+    def to_html
+      case command.word
+      when "backslash", "bslash"
+        @@commander.backslash
+      when "left-brace",
+           "left_brace",
+           "leftbrace",
+           "lbrace",
+           "opening-brace",
+           "opening_brace",
+           "openingbrace",
+           "obrace"
+        @@commander.left_brace
+      when "right-brace",
+           "right_brace",
+           "rightbrace",
+           "rbrace",
+           "closing-brace",
+           "closing_brace",
+           "closingbrace",
+           "cbrace"
+        @@commander.right_brace
+      when "br", "newline"
+        @@commander.br
+      when "bold", "b", "textbf"
+        @@commander.b expressions
+      when "del",
+           "s",
+           "strike",
+           "strikethrough",
+           "strikeout"
+        @@commander.del expressions
+      when "i"
+        @@commander.i
+      when "italic",
+           "textit",
+           "it"
+        @@commander.it expressions
+      when "underline",
+           "u"
+        @@commander.u expressions
+      when "tt",
+           "texttt",
+           "teletype",
+           "typewriter"
+        @@commander.tt expressions
+      when "small"
+        @@commander.small expressions
+      when "big"
+        @@commander.big expressions
+      when "subscript",
+           "sub"
+        @@commander.sub expressions
+      when "superscript",
+           "sup"
+        @@commander.sup expressions
+      when "user",
+           "user-id",
+           "user_id"
+        @@commander.user first_word_token
+      when "link-id",
+           "link_id"
+        @@commander.link_id first_word_token
+      when "keyword-id",
+           "keyword_id"
+        @@commander.keyword_id first_word_token
+      when "tag-id",
+           "tag_id"
+        @@commander.tag_id first_word_token
+      when "forum-id",
+           "forum_id"
+        @@commander.forum_id first_word_token
+      when "folder-id",
+           "folder_id"
+        @@commander.folder_id first_word_token
+      when "bookmarks-folder-id",
+           "bookmarks_folder_id",
+           "bookmarks_folder-id",
+           "bookmarks-folder_id",
+           "bookmark-folder-id",
+           "bookmark_folder_id",
+           "bookmark_folder-id",
+           "bookmark-folder_id"
+        @@commander.bookmarks_folder_id first_word_token
+      when "pi"
+        @@commander.pi
+      when "e"
+        @@commander.e
+      when "+"
+        @@commander.+ *numbers_from_expressions
+      when "-"
+        @@commander.- *numbers_from_expressions
+      when "*"
+        @@commander.* *numbers_from_expressions
+      when "/"
+        @@commander./ *numbers_from_expressions
+      when "%"
+        @@commander.% *numbers_from_expressions
+      when "^", "**"
+        @@commander.** *numbers_from_expressions
+      when "sin", "cos", "tan",
+        "asin", "acos", "atan",
+        "sinh", "cosh", "tanh",
+        "asinh", "acosh", "atanh",
+        "erf", "erfc",
+        "gamma", "log10", "sqrt"
+        @@commander.send command.word.to_sym, number_from_expression
+      when "d2r",
+           "deg->rad",
+           "degrees->radians"
+        @@commander.degrees2radians number_from_expression
+      when "r2d",
+           "rad->deg",
+           "radians->degrees"
+        @@commander.radians2degrees number_from_expression
+      when "lgamma"
+        @@commander.lgamma number_from_expression
+      when "ld",
+           "log2"
+        @@commander.ld number_from_expression
+      when "ln"
+        @@commander.ln number_from_expression
+      when "log"
+        base, number = numbers_from_expressions
+        @@commander.log base, number
+      when "ldexp"
+        fraction, exponent = numbers_from_expressions
+        @@commander.ldexp fraction, exponent
+      when "hypot"
+        @@commander.hypot numbers_from_expressions
+      else
+        command_error "unknown command #{command.to_html}"
+      end
+    end
+
+    def html_tag(tag)
+      "<#{tag}>" + expressions.map(&:to_html).join + "</#{tag}>"
+    end
+
+    def tb_href(target, string)
+      %{<a href="#{TB_COM}/#{target}">#{string}</a>}
+    end
+
+    def first_word_token
+      expressions.select {|expr| expr.is_a? WordToken}.first
+    end
+
+    def numbers_from_expressions
+      expressions
+        .map do |number|
+          begin
+            Float(number.to_html)
+          rescue ArgumentError
+            nil
+          end
+        end.reject &:nil?
+    end
+
+    def number_from_expression
+      numbers_from_expressions.first
+    end
+
+    class << self
+      @@commander = Commander.new
+      @@action_view = nil
+      @@controller = nil
+
+      def parse(tokens)
+        expressions = []
+        rest = tokens
+        backslash, command, left_brace = rest.shift(3)
+        right_brace = nil
+        raise ParseError if not backslash.is_a? BackslashToken
+        raise ParseError if not command.is_a? WordToken
+        if not left_brace.is_a? LeftBraceToken # A command with no interior.
+          rest.unshift left_brace if not left_brace.is_a? WhitespaceToken
+          return [CommandParser.new(command, []), rest]
+        end
+        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
+            result, rest = CommandParser.parse(rest)
+            expressions << result
+          elsif rest.first.is_a? RightBraceToken
+            right_brace = rest.shift
+            return [CommandParser.new(command, expressions), rest]
+          else
+            raise ParseError
+          end
+        end
+        if right_brace.nil? # Allow a forgotten final right brace.
+          return [CommandParser.new(command, expressions), rest]
+        end
+      end
+
+      def commander= new
+        @@commander = new
+      end
+    end
+  end
+end

data/lib/teepee/commander.rb

@@ -0,0 +1,320 @@
+# -*- 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'
+
+include ERB::Util
+
+module Teepee
+  class Commander
+    def command_error message
+      %{<span style="color: red">[#{message}]</span>}
+    end
+
+    def command_not_yet_implemented command
+      command_error "The command #{command} is not yet implemented."
+    end
+
+    def ensure_numeric number
+      if number.kind_of? Complex
+        command_error "Complex numbers are not yet supported."
+      elsif not number.kind_of? Numeric
+        command_error "Non-numeric result."
+      else
+        number
+      end
+    end
+
+    def html_tag tag, expressions
+      "<#{tag}>" + expressions.map(&:to_html).join + "</#{tag}>"
+    end
+
+    def tb_href target, string
+      %{<a href="#{TB_COM}/#{target}">#{string}</a>}
+    end
+
+    def id_command_handler(id,
+                           klass,
+                           singular = klass.to_s.camelcase_to_snakecase,
+                           plural = singular.pluralize,
+                           partial = "#{plural}/inline",
+                           view="")
+      if not id
+        command_error "#{singular}_id: error: no #{singular} ID specified"
+      elsif not id.to_s =~ /\A[0-9]+\z/
+        command_error "#{singular}_id: error: invalid #{singular} ID specified"
+      else
+        tb_href "/#{plural}/#{id.to_s}/#{view}", "#{klass} ##{id.to_s}"
+      end
+    end
+
+    #----------------------------------------------------------------------------
+
+    def + *numbers
+      ensure_numeric numbers.inject 0, :+
+    end
+
+    def - *numbers
+      if numbers.length == 1
+        ensure_numeric -numbers.first
+      else
+        ensure_numeric numbers.reduce :-
+      end
+    end
+
+    def * *numbers
+      ensure_numeric numbers.inject 1, :*
+    end
+
+    def / *numbers
+      if numbers.length == 1
+        ensure_numeric 1 / numbers.first
+      else
+        ensure_numeric numbers.reduce :/
+      end
+    end
+
+    def % *numbers
+      ensure_numeric numbers.reduce :%
+    end
+
+    def ** *numbers
+      ensure_numeric numbers.reduce :**
+    end
+
+    def acos number
+      ensure_numeric Math.acos number
+    end
+
+    def acosh number
+      ensure_numeric Math.acosh number
+    end
+
+    def asin number
+      ensure_numeric Math.asin number
+    end
+
+    def asinh number
+      ensure_numeric Math.asinh number
+    end
+
+    def atan number
+      ensure_numeric Math.atan number
+    end
+
+    def atanh number
+      ensure_numeric Math.atanh number
+    end
+
+    def b expressions
+      html_tag :b, expressions
+    end
+
+    def backslash
+      "\\"
+    end
+
+    def big expressions
+      html_tag :big, expressions
+    end
+
+    def bookmarks_folder_id id
+      id_command_handler id, Folder, "folder", "folders", "folders/bookmarks_inline", "bookmarks"
+    end
+
+    def br
+      "\n</br>\n"
+    end
+
+    def cos angle
+      ensure_numeric Math.cos angle
+    end
+
+    def cosh number
+      ensure_numeric Math.cosh number
+    end
+
+    def degrees2radians degrees
+      ensure_numeric degrees * Math::PI / 180.0
+    end
+
+    def del expressions
+      html_tag :del, expressions
+    end
+
+    def e
+      Math::E
+    end
+
+    def erf number
+      ensure_numeric Math.erf number
+    end
+
+    def erfc number
+      ensure_numeric Math.erfc number
+    end
+
+    def folder_id id
+      id_command_handler id, Folder
+    end
+
+    def forum_id id
+      id_command_handler id, Forum
+    end
+
+    def gamma number
+      ensure_numeric Math.gamma number
+    end
+
+    def i
+      command_error "Complex numbers are not yet supported."
+    end
+
+    def it expressions
+      html_tag :i, expressions
+    end
+
+    def hypot numbers
+      ensure_numeric Math.sqrt numbers.map {|n| n**2}
+    end
+
+    def ld n
+      ensure_numeric Math.log2 n
+    end
+
+    def ldexp fraction, exponent
+      ensure_numeric Math.ldexp fraction, exponent
+    end
+
+    def left_brace
+      "{"
+    end
+
+    def lgamma n
+      ensure_numeric Math::lgamma(n).first
+    end
+
+    def link_id
+      id_command_handler id, Link
+    end
+
+    def ln number
+      ensure_numeric Math.log number
+    end
+
+    def log base, number
+      if number.nil?
+        number, base = base, number
+        ensure_numeric Math.log number # default to natural logarithm
+      else
+        ensure_numeric Math.log number, base
+      end
+    end
+
+    def log10 number
+      ensure_numeric Math.log10 number
+    end
+
+    def pi
+      Math::PI
+    end
+
+    def radians2degrees radians
+      ensure_numeric(radians * 180.0 / Math::PI)
+    end
+
+    def right_brace
+      "}"
+    end
+
+    def sin angle
+      ensure_numeric Math.sin angle
+    end
+
+    def sinh number
+      ensure_numeric Math.sinh number
+    end
+
+    def small expressions
+      html_tag :small, expressions
+    end
+
+    def sqrt number
+      ensure_numeric Math.sqrt number
+    end
+
+    def sub expressions
+      html_tag :sub, expressions
+    end
+
+    def sup expressions
+      html_tag :sup, expressions
+    end
+
+    def tag_id id
+      id_command_handler id, Tag
+    end
+
+    def tan angle
+      ensure_numeric Math.tan angle
+    end
+
+    def tanh number
+      ensure_numeric Math.tanh number
+    end
+
+    def tt expressions
+      html_tag :tt, expressions
+    end
+
+    def u expressions
+      html_tag :u, expressions
+    end
+
+    def user user
+      if not user
+        command_error "user: error: no user specified"
+      else
+        tb_href "users/#{user}", user.to_s
+      end
+    end
+  end
+end