linmeric 0.1.0 → 0.2.0

data/lib/linmeric/Sizer.rb

@@ -5,11 +5,28 @@ require_relative 'Lexer.rb'
 require_relative 'Error_print.rb'
 require_relative 'CnGal_new_classes.rb'
 
+##
+# Sizer analyzes the sintax of the inserted commands printing
+# errors if they are found, before the string is manipulated by Scp
+# and parsed by Parser.
+#
+#
+# Author:: Massimiliano Dal Mas (mailto:max.codeware@gmail.com)
+# License:: Distributed under MIT license
 class Sizer
+
+  # Builds a new lexer
   def initialize()
     @lexer = Lexer.new
   end
   
+  # Analyzes the stream of tokens to check the sintax. It uses
+  # a turing machine to find errors.
+  #
+  # * **argument**: input comand string to analyze or stream of tokens (array)
+  # * **argument**: boolean value which identifies the possibility to find the 
+  # assign symbol `=`. +true+ is default (`=` is allowed)
+  # * **returns**: +true+ if the sintax is correct; +false+ else
   def analyze(string, equal = true)  
     @i = 0
     state = 0
@@ -24,7 +41,7 @@ class Sizer
     token = @lexer.tokenize(string) unless string.is_a? Array
     token = string if string.is_a? Array
     while @i < token.size
-      #puts "#{token[@i].me}";puts
+    
       case state
         # beginning state
         when 0
@@ -76,7 +93,7 @@ class Sizer
               return false
           end
           
-        # expecting numbers,variables, keywords (
+        # expecting numbers,variables, keywords, (
         when 1
           case token[@i].attribute
             when "NUMBER"
@@ -171,7 +188,7 @@ class Sizer
           PrintError.default(token[@i],@@string)
           return false
           
-        # checking mx arguments (full)
+        # checking mx arguments (full check)
         when 6
           case token[@i].attribute
             when "KEYWORD"
@@ -192,10 +209,10 @@ class Sizer
               unless @i+1 >= token.size
                 if token[@i+1].attribute == "KEYWORD" then
                   @i += 1
-                  unless @i < token.size
-                    PrintError.missing(token[@i-1],@@string)
-                    return false
-                  end
+#                  unless @i < token.size
+#                    PrintError.missing(token[@i-1],@@string)
+#                    return false
+#                  end
                   unless token[@i].me == "as:"
                     PrintError.missmatch(token[@i],@@string,"keyword 'as:' or operator")
                     return false
@@ -205,13 +222,20 @@ class Sizer
                     PrintError.missing_general_string(token[@i-1].position+token[@i-1],@@string)
                     return false
                   end
-                  return false unless check_block(token)
+                  if token[@i].attribute == "QUOTES"
+                    return false unless check_block(token)
+                  else
+                    unless token[@i].attribute == "VARIABLE"
+                      PrintError.default(token[@i],@@string)
+                      return false 
+                    end
+                  end
                 end
               end
               state = 2
           end
           
-        # checking integ arguments (full)
+        # checking integ arguments (full check)
         when 7  
           unless @i < token.size
             PrintError.missing(token[@i-1],@@string)
@@ -242,7 +266,7 @@ class Sizer
           end
           state = 2
           
-        # checking solve args (full)   
+        # checking solve args (full check)   
         when 8
           inner_state = 0
           while !(token[@i].attribute == "EQUALS_TO") and @i < token.size
@@ -290,6 +314,11 @@ class Sizer
   end
 
  private
+ 
+  # checks if the input expression has balanced brackets
+  #
+  # * **argument**: expression (string) to check
+  # * **returns**: +true+ if brackets are balanced; +false+ else
   def balanced_brackets?(exp)
     open_b = 0
     for i in 0...exp.size
@@ -299,6 +328,10 @@ class Sizer
     open_b == 0 ? (return true) : (return false)
   end 
   
+  # Checks the sintax of a block, that is: QUOTES-STRING-QUOTES
+  #
+  # * **argument**: stream of tokens
+  # * **returns**: +true+ if the sintax is correct; +false+ else
   def check_block(token)
     unless token[@i].attribute == "QUOTES" then
       PrintError.missmatch(token[@i],@@string,"quotes for block")

data/lib/linmeric/Token.rb

@@ -3,12 +3,28 @@
 require_relative 'CnGal_tools.rb'
 require_relative 'CnGal_new_classes.rb'
 
+##
+# This class generates a token object with three parameters:
+# * Attribute
+# * Position
+# * Value
+#
+#
+# Author:: Massimiliano Dal Mas (mailto:max.codeware@gmail.com)
+# License:: Distributed under MIT license
 class Token
+
   OPERATORS = Tool.operators
   VARIABLE = /[a-zA-Z_][a-zA-Z0-9_]*/
+  
+  # Creates a new token object
+  #
+  # * **argument**: token value to name
+  # * **argument**: token position
+  # * **argument**: 'suggestion' (string) to force a specific attribute. "" default
   def initialize(to_token,pos,sugg = "")
     @My_pos = pos
-    if OPERATORS.include? to_token then   
+    if OPERATORS.include? to_token then    
       @My_att = "OPERATOR" unless [">","=","+","-"].include? to_token
       @My_att = "EQUAL_OP" if to_token == "="
       @My_att = "TO_FILE_OP" if to_token == ">"
@@ -35,19 +51,22 @@ class Token
     @My_self = (to_token.include? ':') ? (to_token.downcase) : (to_token)
   end
   
+  # * **returns**: token attribute
   def attribute
     return @My_att
   end
   
+  # * **returns**: token position
   def position
     return @My_pos
   end
   
+  # * **returns**: token value
   def me
     return @My_self
   end
   
-  def show
-   return [@My_att,@My_pos,@My_self]
-  end
+#  def to_s
+#   return [@My_att,@My_pos,@My_self]
+#  end
 end

data/lib/linmeric/version.rb

@@ -0,0 +1,3 @@
+module Linmeric
+  VERSION = "0.2.0"
+end

data/lib/linmeric.rb

@@ -1,10 +1,12 @@
 #! /usr/bin/env ruby
 
-require "linmeric/CnGal_new_classes.rb"
-require "linmeric/CnGal_tools.rb"
-require "linmeric/CnGal_Matrix_class.rb"
-require "linmeric/Parser.rb"
-require "linmeric/Scopify.rb"
-require "linmeric/Listener.rb"
-require "linmeric/Sizer.rb"
-require "linmeric/LU.rb"
+%w|linmeric/Archive.rb linmeric/Calculator.rb 
+   linmeric/CnGal_Matrix_class.rb linmeric/CnGal_new_classes.rb
+   linmeric/CnGal_tools.rb linmeric/Error_print.rb 
+   linmeric/Function_class.rb linmeric/Integrators.rb
+   linmeric/Lexer.rb linmeric/Listener.rb linmeric/LU.rb
+   linmeric/Parser.rb linmeric/Scopify.rb linmeric/Sizer.rb
+   linmeric/Token.rb|.each do |f|
+     require_relative f
+  end
+

data/lib/linmeric_bin.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+
+%w|linmeric/CnGal_new_classes.rb
+   linmeric/CnGal_tools.rb
+   linmeric/CnGal_Matrix_class.rb
+   linmeric/Parser.rb
+   linmeric/Scopify.rb
+   linmeric/Listener.rb
+   linmeric/Sizer.rb
+   linmeric/LU.rb|.each do |f|
+     require_relative f
+   end

metadata

@@ -1,41 +1,142 @@
 --- !ruby/object:Gem::Specification
 name: linmeric
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Massimiliano Dal Mas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-02 00:00:00.000000000 Z
-dependencies: []
-description: Simple calculator to make operations on matrices and functions
-email: max.codeware@gmail.com
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple command line calculator to make operations on matrices and functions
+email:
+- max.codeware@gmail.com
 executables:
 - linmeric
+- linguide
 extensions: []
 extra_rdoc_files:
-- doc/Instructions_it.txt
-- doc/Instructions_en.txt
-- doc/Instructions_it.html
-- doc/Instructions_en.html
-- doc/README_en.txt
-- doc/README_it.txt
-- doc/README_en.html
-- doc/README_it.html
+- README.md
+- Gemfile
+- Rakefile
+- LICENSE.txt
 files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/help/Help.rb
+- bin/help/Help_inst.rb
+- bin/linguide
 - bin/linmeric
-- doc/Instructions_en.html
+- doc/Archive.html
+- doc/Calculator.html
+- doc/Calculator/Evaluator.html
+- doc/Calculator/Lexer.html
+- doc/Calculator/Token.html
+- doc/Dim.html
+- doc/Filename.html
+- doc/Fixnum.html
+- doc/Float.html
+- doc/Function.html
+- doc/InputError.html
 - doc/Instructions_en.txt
-- doc/Instructions_it.html
 - doc/Instructions_it.txt
-- doc/README_en.html
-- doc/README_en.txt
-- doc/README_it.html
-- doc/README_it.txt
+- doc/Integrators.html
+- doc/LU.html
+- doc/Lexer.html
+- doc/Linmeric.html
+- doc/Listener.html
+- doc/Matrix.html
+- doc/MyArgError.html
+- doc/NilClass.html
+- doc/Numeric.html
+- doc/Parser.html
+- doc/PrintError.html
+- doc/README_md.html
+- doc/Scp.html
+- doc/Sizer.html
+- doc/String.html
+- doc/Token.html
+- doc/Tool.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/table_of_contents.html
 - lib/linmeric.rb
 - lib/linmeric/Archive.rb
+- lib/linmeric/Calculator.rb
 - lib/linmeric/CnGal_Matrix_class.rb
 - lib/linmeric/CnGal_new_classes.rb
 - lib/linmeric/CnGal_tools.rb
@@ -49,10 +150,13 @@ files:
 - lib/linmeric/Scopify.rb
 - lib/linmeric/Sizer.rb
 - lib/linmeric/Token.rb
-homepage: http://rubygems.org/gems/linmeric
+- lib/linmeric/version.rb
+- lib/linmeric_bin.rb
+homepage: https://max-codeware.github.io/linmeric/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -72,5 +176,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
-summary: Numeric calculator
+summary: Simple numeric calculator
 test_files: []