magister_cli 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c679885476aafdf7a4ac673994d31396be72982161a554aebd78ed66b13814ab
-  data.tar.gz: d762dad23dcfb491ef7295241f663f6da9b310bf441e92f3db7a73043e12c5ce
+  metadata.gz: fc4e88673fb16d2fa82e0e23bd3312a684584a7eea909d101c49c7e96dd0c3c1
+  data.tar.gz: ffbb5497cc609cbdb4d775fdb92160f9d6ad559955cde2644c451f687795a005
 SHA512:
-  metadata.gz: 89799db254ad526cfc7f05370809aa3923d83d9e1aca5f57d3061d18a11ed18f9472b6d5c9c8f32d54a063f68578a6b4dcd1d599189507f45f84658203a74395
-  data.tar.gz: bbb0d7a439c9d2d37d64222dfaa7eed37fbe92c00a621bb18a069bde8e652971e1d71a392753d5445b481c8424f2e37ed210be42b81314098cfbc190d052bd0e
+  metadata.gz: 489fb98b433f60be95f0c444a8006dc014f677798b489d4341debd299c63d77d21fde38cc5805bffb3e3d45ab4fefcfb06cccf5decb34fecbe0c0de8bdcb5614
+  data.tar.gz: bd1e443124ecb18d1906fdd0ac7aa9c0db6e51c2bb7e309347b99f02ebbece9d01d4f66a92a8f9441b2c90fd58f3897c354501df4185f3338a9415317ff73c35

data/lib/magister_cli/ext/string.rb

@@ -0,0 +1,9 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+class String
+    def is_integer?
+        self.to_i.to_s == self
+    end
+end

data/lib/magister_cli/parser.rb

@@ -0,0 +1,119 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+require 'magister_cli/tokenizer'
+
+class Parser
+    @@actions = [
+        ['login', ['username', 'password', 'school']],
+        ['auth', ['token', 'school']],
+        ['quit', []],
+        ['exit', []],
+        ['get_classes', ['date_from', 'date_to']]
+    ]
+
+    def initialize(string)
+        @tokenizer = Tokenizer.new(string)
+        @string = string
+    end
+
+    def is_action?(actionName)
+        @@actions.each do |action|
+            if action[0] == actionName
+                return true
+            end
+        end
+        return false
+    end
+
+    def string=(string)
+        @string = string
+        @tokenizer = Tokenizer.new(string)
+    end
+
+    def get_args(actionName)
+        @@actions.each do |action|
+            if action[0] == actionName
+                return action[1].dup
+            end
+        end
+    end
+
+    def parse()
+        tokens = @tokenizer.tokenize
+
+        i = 0
+
+        ast = Array.new
+        while i < tokens.length
+            tmp = 0
+            props = false
+            opts = false
+            altOpts = false # true if opts are in the place props would be
+
+            if tokens[0 + i]["type"] != "KEYWORD"
+                puts "Current index: #{i.to_s}"
+                raise SyntaxError.new "Expected #{tokens[0 + i]["value"]} to be a KEYWORD, is a #{tokens[0 + i]["type"]}"
+            end
+
+            if tokens[1 + i] != nil && tokens[1 + i]["type"] == "PARAMS"
+                tmp += 1
+                props = true
+            end
+
+            if tokens[2 + i] != nil && tokens[2 + i]["type"] == "OPTIONS"
+                tmp += 1
+                opts = true
+            end
+
+            if tokens[1 + i] != nil && tokens[1 + i]["type"] == "OPTIONS"
+                if opts || props
+                    raise SyntaxError.new "Cant have type OPTIONS here, must be PARAMS"
+                end
+                opts = true
+                altOpts = true
+                tmp += 1
+            end
+
+            ast_node = {"action" => tokens[0 + i]["value"]}
+
+            if props
+                ast_node["parameters"] = tokens[1 + i]["value"]
+            end
+
+            if opts
+                if altOpts
+                    ast_node["options"] = tokens[1 + i]["value"]
+                else
+                    ast_node["options"] = tokens[2 + i]["value"]
+                end
+            end
+
+            if !is_action? ast_node["action"]
+                throw SyntaxError.new "#{ast_node["action"]} is not a valid action!"
+            end
+
+            lacking = Array.new
+            lacking = get_args(ast_node["action"])
+
+            if props
+                ast_node["parameters"].each do |prop|
+                    if !lacking.include? prop["key"]
+                        raise SyntaxError.new "#{prop["key"]} is is already defined or is not a valid parameter for #{ast_node["action"]}!"
+                    end
+                    lacking.delete prop["key"]
+                end
+            else
+                ast_node["parameters"] = Array.new
+            end
+
+            ast_node["lacking_params"] = lacking
+
+            ast.append(ast_node)
+
+            i += tmp + 1 # + 1 for the keyword itself
+        end
+
+        ast
+    end
+end

data/lib/magister_cli/runtime.rb

@@ -0,0 +1,73 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+require 'magister'
+
+def zulu_to_ams(string)
+    ("%02d" % (string[0..1].to_i + 1)).to_s + string[2..-1]
+end
+
+module Runners
+    def login(username, password, school)
+        $magcli_runtime_variables["magister"].login(school, username, password)
+    end
+
+    def auth(token, school)
+        $magcli_runtime_variables["magister"].authenticate(school, token)
+    end
+
+    def get_classes(date_from, date_to)
+        classes = $magcli_runtime_variables["magister"].get_classes(date_from, date_to)
+        if classes == nil
+            raise "Couldn't fetch classes!"
+        end
+        if @opts["outputMode"]
+            classes.each do |c|
+                puts "|#{zulu_to_ams c.classStart.to_s[11..-13]} - #{zulu_to_ams c.classEndInclusive.to_s[11..-13]}| #{c.description} [#{c.location}]"
+            end
+        else
+            puts classes.to_json
+        end
+    end
+end
+
+class Runtime
+    include Runners
+
+    @@spec = {
+        "login" => :login,
+        "auth" => :auth,
+        "quit" => :exit,
+        "exit" => :exit,
+        "get_classes" => :get_classes
+    }
+    def initialize(action)
+        if action["options"] != nil
+            @opts = action["options"]
+        else
+            @opts = {"outputMode" => "formatted"}
+        end
+
+        if @opts["noCache"] != nil && @opts["noCache"] == "true"
+            $magister_useCache = false
+        else
+            $magister_useCache = true
+        end
+
+        requiredArgs = Parser.new("").get_args(action["action"])
+        args = Array.new
+
+        if action["parameters"] == nil
+            raise "Not a single parameter defined!! not even an empty array!"
+        end
+
+        requiredArgs.each do |arg|
+            action["parameters"].each do |param|
+                if arg == param["key"]
+                    args.append(param["value"])
+                end
+            end
+        end
+        send(@@spec[action["action"]], *args)
+    end
+end

data/lib/magister_cli/tokenizer.rb

@@ -0,0 +1,86 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+class Tokenizer
+    @@spec = [
+        [/(\w+)/, "KEYWORD"],
+        [/(?:\w+\s?){(.*)}/, "PARAMS"],
+        [/(?:\w+\s?(?:{.*}\s?)?)\[(.*)\]/, "OPTIONS"],
+        [/(\s+)/, "EMPTY"]
+    ]
+
+    def initialize(string)
+        @string = string
+    end
+
+    def parse_options(optionsString)
+        cursor = 0
+        found = Array.new
+        while cursor < optionsString.length
+            scope = optionsString[cursor..-1]
+
+            if scope[0] == "{" || scope[0] == "}" || scope[0] == "[" || scope[0] == "]"
+                cursor += 1
+                next
+            end
+
+            whiteSpaceMatch = scope.match /^\s+/
+            if whiteSpaceMatch != nil
+                cursor += whiteSpaceMatch[0].length
+                next
+            end
+
+            keywordMatch = scope.match /^\w+\s?:/
+            if keywordMatch != nil
+                cursor += keywordMatch[0].length
+                found.append({"type" => "KEYWORD", "value" => keywordMatch[0][0..-2]})
+                next
+            end
+
+            explicitString = scope.match /^'([^']*)',*/
+            if explicitString != nil
+                cursor += explicitString[0].length
+                found.append({"type" => "STRING", "value" => explicitString.captures[0]})
+                next
+            end
+
+            impliedString = scope.match /^(.*?),*/
+            if impliedString != nil
+                cursor += impliedString[0].length
+                found.append({"type" => "STRING", "value" => impliedString.captures[0]})
+                next
+            end
+        end
+        parsed = Array.new
+        i = 0
+        while i < found.length
+            if found[i]["type"] != "KEYWORD" || found[i + 1]["type"] != "STRING"
+                raise TypeError.new "Expected #{found[i]["value"]} to be a KEYWORD and #{found[i + 1]["value"]} to be a STRING"
+            end
+
+            parsed.append({"type" => "PROPERTY", "key" => found[i]["value"], "value" => found[i + 1]["value"]})
+
+            i += 2
+        end
+        parsed
+    end
+
+    def tokenize
+        @tokens = Array.new
+        @@spec.each do |item|
+            matched = @string.match item[0]
+            if matched != nil
+                matched.captures.each do |match|
+                    if item[1] == "PARAMS" || item[1] == "OPTIONS"
+                        @tokens.append({"type" => item[1], "value" => parse_options(match)})
+                    elsif item[1] == "EMPTY"
+                    else
+                        @tokens.append({"type" => item[1], "value" => match})
+                    end
+                end
+            end
+        end
+        @tokens
+    end
+end

data/lib/magister_cli.rb

@@ -2,13 +2,24 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at https://mozilla.org/MPL/2.0/.
 require 'magister'
+require 'magister_cli/ext/string'
+require 'magister_cli/parser'
+require 'magister_cli/tokenizer'
+require 'magister_cli/runtime'
+require 'io/console'
+
+$magister_cachingDirectory = Dir.home + "/.cache/magister"
 
 $magcli_runmode = "normal"
+$magcli_runtime_variables = {}
 
 module MagisterCLI
     extend self
 
     def main
+      $magcli_runtime_variables["magister"] = Magister.new
+
+      begin
         if ARGV.include?("-r") || ARGV.include?("--run")
             $magcli_runmode = "inline"
             args = ARGV
@@ -27,9 +38,53 @@ module MagisterCLI
             return
         end
 
-        # TODO: ask for command
-        # TOOD: tokenize command
-        # TODO: parse command
-        # TODO: run command
+        parser = Parser.new("")
+        while true
+          print "> "
+          input = gets.chomp
+          parser.string = input
+          output = parser.parse
+
+          # loop over each action that was outputted
+          output.each do |action|
+            props = action["parameters"]
+            doneParams = Array.new
+            # get any parametres that werent set and ask then set them
+            action["lacking_params"].each do |param|
+              print "#{param}: "
+              if param == "password"
+                ans = STDIN.noecho(&:gets).chomp
+                print "\n"
+              else
+                ans = gets.chomp
+              end
+              props.append({"type" => "PROPERTY", "key" => param, "value" => ans})
+              doneParams.append param
+            end
+
+            # update lacking_params value, done here as to not mess with the order while looping over them
+            doneParams.each do |p|
+              action["lacking_params"].delete(p)
+            end
+            action["parameters"] = props
+            props = Array.new
+
+            runtime = Runtime.new(action)
+          end
+        end
+      rescue SignalException
+        $magcli_runtime_variables = Array.new
+        puts "[CTRL + C]\nExiting..."
+        exit
+      rescue UncaughtThrowError => e
+        if e.message.include? "#<SyntaxError: "
+          message = e.message.split("#<SyntaxError: ").last[0..-2]
+          puts "Invalid syntax: #{message}"
+        else
+          puts "Something went wrong: #{e.message}"
+        end
+      rescue => e
+        puts "Something went wrong: #{e.message}"
+      end
     end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: magister_cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Riley0122
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-27 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: magister
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The CLI for the 'magister' gem
 email: contact@riley0122.dev
 executables:
@@ -19,11 +47,15 @@ extra_rdoc_files: []
 files:
 - bin/magister
 - lib/magister_cli.rb
-homepage: https://github.com/riley0122/rubymag/cli#readme
+- lib/magister_cli/ext/string.rb
+- lib/magister_cli/parser.rb
+- lib/magister_cli/runtime.rb
+- lib/magister_cli/tokenizer.rb
+homepage: https://github.com/riley0122/rubymag/tree/main/cli#readme
 licenses:
 - MPL-2.0
 metadata:
-  source_code_uri: https://github.com/riley0122/rubymag/cli
+  source_code_uri: https://github.com/riley0122/rubymag/tree/main/cli
 post_install_message: 
 rdoc_options: []
 require_paths: