logix_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07aad560c5874d323a5fdc38883c0d7ca5070676
+  data.tar.gz: e7358d2a08c4e2108202853f407b4744cea2a417
+SHA512:
+  metadata.gz: fce706a744fc34e69d5ba9dbb66a5ca1f214d97e505282c9e75713c95a4fc35ef0e14673b193a7740a1f994733bc91a0f612f7a0e167b3a65e32746014e5a720
+  data.tar.gz: 1aa1478bfeca7eee94a728055fa0a91a7f134678595b0f19fc9ade499b721c7444936d4450ab9c552d0fbf05d76784c23c1f4822280fd0748559be0ed2aff58f

data/lib/logix-toolkit.rb

@@ -0,0 +1,22 @@
+require 'logix-toolkit/core/errors'
+require 'logix-toolkit/core/boolean_verifier'
+require 'logix-toolkit/core/messages'
+
+#The main library class
+class LogixToolkit
+  #the class used as a namespace seperator for operations
+  class Operations
+  end
+  
+  #Displays introduction and a tutorial on how to use the library
+  def self.help
+    Messages.intro
+  end
+end
+
+require 'logix-toolkit/operations/or'
+require 'logix-toolkit/operations/and'
+require 'logix-toolkit/operations/implication'
+
+puts "The gem was successfully required use \"LogixToolkit.help\" to see an intoduction
+and a tutorial about how you should use the library"

data/lib/logix-toolkit/core/boolean_verifier.rb

@@ -0,0 +1,22 @@
+require 'logix-toolkit/core/errors'
+
+#The Boolean verifier class, it's task is to make sure that user input is a boolean
+#otherwise it throws an error
+class BooleanVerifier
+  #verifies the validity of a boolean
+  def self.verify? object, *more_args
+    if object == true or object == false
+      more_args.each do |i|
+        if i == true or i == false
+          #Do nothing continue the check unless an invalid argument was found
+        else
+          ErrorsAndExceptions.object_not_boolean i
+        end
+      end
+      #finally return true
+      return true
+    else
+      ErrorsAndExceptions.object_not_boolean object
+    end
+  end
+end

data/lib/logix-toolkit/core/errors.rb

@@ -0,0 +1,15 @@
+#This class stores the Errors and exceptions messages
+class ErrorsAndExceptions
+  #throws an error if the object from user input is not a boolean
+  def self.object_not_boolean object
+    puts "ERROR: Object \"#{object}\" was not recognized as a boolean no logical operations could be performed"
+  end
+  #throws an error if the logical functions couldn't be performed for any reason
+  def self.couldnt_be_performed
+    puts "ERROR: Operation could not be performed"
+  end
+  #throws an error if function is currently unavailable
+  def self.operation_unavailable_atm
+    puts "Sorry, the current operation is unavailable at the moment"
+  end
+end

data/lib/logix-toolkit/core/messages.rb

@@ -0,0 +1,57 @@
+#This class stores functions that display long messages such as
+#introductions tutorials and such
+class Messages
+  #Displays an introductory message
+  def self.intro
+    puts "
+==============================================================
+Hello there, logix toolkit user! and thank you for using the
+logix-toolkit library here is an introduction to the
+library and how you should use it
+==============================================================
+ABOUT:
+This library is a small project that its target is to add
+and integrate a lot of boolean algebra operations to the Ruby
+programming language
+it's meant to be used by anyone from mathematicians and 
+students that want an easy tool to make boolean algebra 
+calculations much  more complicated than the core 
+AND, OR operations that most programming languages support
+to game developers that are willing to integrate logic into 
+their games and focus on their game  without having to mess 
+with logic code
+or just by anyone interested in logic and boolean
+algebra.
+    
+USAGE:
+now the usage of the library is fairly simple
+all the logic functions at the moment are simple
+almost every command you will use here will be .check?
+but here is the catch everything is used here with a
+namespace seperator (this thing: \"::\")
+meaning that if you want to access the AND operation
+you will type in the following code:
+LogixToolkit::Operations::And.check? true, false
+and it will return the value of the operation
+(in this example: false)
+same goes for any other operation Or, Implication,
+Logic gates and so on...
+but then what if you need to do calculations
+for multiple booleans say I want to check the
+OR value for 4 booleans?
+it's simple just use the check[NUMBER]? function
+Example:
+LogixToolkit::Operations::Or.check4? true, true, false, true
+simple enough right?
+NOTE: I still haven't found a way to make the function accept
+an (X) amount of variables so now the check method supports
+only up to check5?
+    
+That's it you're good to go, now go and explore the
+magnificent world of boolean algebra
+
+whenever you need to see this message again type
+LogixToolkit.help
+"
+  end
+end

data/lib/logix-toolkit/operations/and.rb

@@ -0,0 +1,54 @@
+require 'logix-toolkit/core/errors'
+require 'logix-toolkit/core/boolean_verifier'
+require 'logix-toolkit'
+
+#The "and" class used to define and operations (e.g A ∧  B)
+class LogixToolkit::Operations::And
+  def self.check? arg0, arg1
+    if BooleanVerifier.verify? arg0, arg1
+      if arg0 and arg1
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check3? arg0, arg1, arg2
+    if BooleanVerifier.verify? arg0, arg1, arg2
+      if arg0 and arg1 and arg2
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check4? arg0, arg1, arg2, arg3
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3
+      if arg0 and arg1 and arg2 and arg3
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check5? arg0, arg1, arg2, arg3, arg4
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3, arg4
+      if arg0 and arg1 and arg2 and arg3 and arg4
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+end

data/lib/logix-toolkit/operations/implication.rb

@@ -0,0 +1,42 @@
+require 'logix-toolkit/core/errors'
+require 'logix-toolkit/core/boolean_verifier'
+require 'logix-toolkit'
+
+#The "implication" class used to define implication operations (e.g A → B)
+class LogixToolkit::Operations::Implication
+  def self.check? arg0, arg1
+    if BooleanVerifier.verify? arg0, arg1
+      if !arg0 or arg1
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+  
+  def self.check3? arg0, arg1, arg2
+    if BooleanVerifier.verify? arg0, arg1, arg2
+      ErrorsAndExceptions.operation_unavailable_atm
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+  
+  def self.check4? arg0, arg1, arg2, arg3
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3
+      ErrorsAndExceptions.operation_unavailable_atm
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+  
+  def self.check5? arg0, arg1, arg2, arg3
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3
+      ErrorsAndExceptions.operation_unavailable_atm
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+end

data/lib/logix-toolkit/operations/or.rb

@@ -0,0 +1,55 @@
+require 'logix-toolkit/core/errors'
+require 'logix-toolkit/core/boolean_verifier'
+require 'logix-toolkit'
+
+#The "or" class used to define or operations (e.g A ∨  B)
+class LogixToolkit::Operations::Or
+  #checks the value of A ∨  B
+  def self.check? arg0, arg1
+    if BooleanVerifier.verify? arg0,arg1
+      if arg0 or arg1
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check3? arg0, arg1, arg2
+    if BooleanVerifier.verify? arg0, arg1, arg2
+      if arg0 or arg1 or arg2
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check4? arg0, arg1, arg2, arg3
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3
+      if arg0 or arg1 or arg2 or arg3
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+
+  def self.check5? arg0, arg1, arg2, arg3, arg4
+    if BooleanVerifier.verify? arg0, arg1, arg2, arg3, arg4 
+      if arg0 or arg1 or arg2 or arg3 or arg4
+        return true
+      else
+        return false
+      end
+    else
+      ErrorsAndExceptions.couldnt_be_performed
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: logix_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elian(Shadi) Kamal
+- Matan Haller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-22 00:00:00.000000000 Z
+dependencies: []
+description: "A boolean algebra tools library for ruby that adds logic functions and
+  operations \n(currently limited to AND, OR, CONDITIONAL operations with multiple
+  parameters)\nmore functionality will be added later.\ninstall via \"gem install
+  logix-toolkit\"\nrequire using \"require 'logix-toolkit'\"\nsee usage via the documentation
+  or via typing \"LogixToolkit.help\" in the console\nafter requiring the library"
+email: shady3300@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/logix-toolkit.rb
+- lib/logix-toolkit/core/boolean_verifier.rb
+- lib/logix-toolkit/core/errors.rb
+- lib/logix-toolkit/core/messages.rb
+- lib/logix-toolkit/operations/and.rb
+- lib/logix-toolkit/operations/implication.rb
+- lib/logix-toolkit/operations/or.rb
+homepage: http://rubygems.org/gems/logixtoolkit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A logic tools library for ruby
+test_files: []
+has_rdoc: