artsy 0.1.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a175378932a34cc922a87e42896ebe230c9d536d4201245097a681c617930927
-  data.tar.gz: 2594faadfd97a6fda4e158ae811f9667888270b6597ffc08e742ba87be9ce3c1
+  metadata.gz: efb06e8dcaa16d78fd779f2c875721b2e14dd8cb1df13386173c1d0a754147e7
+  data.tar.gz: 2cb275e3f3040e436e1d4c002e3a275c3aef8266c81bf5d5c37dab477624e435
 SHA512:
-  metadata.gz: '089e0fc334a0ed0c959845f461e0d2e0e1776d8d2db8ab78230f155319310b4ae5b29dd5a9a859ffbd3b51a94ce21dd1862d5963a2ce86fd281e46c30375fd38'
-  data.tar.gz: f0f777e5d23aa55fd39343e7833bba4a41c23233e36d2af6fed17214762696a2a5dd24cf294c10cd4acaec6dd9aefde663fe6c42e289437f0da1d6871b0559eb
+  metadata.gz: a5de59059c5daaf5648e240dfda3e58eda0bff02363333f77f49b840bfe2f0af278f0cf305f5e0aebc3d9472b773c7f79f2c3460714c96e538101b00611516a1
+  data.tar.gz: 4acb92f51402f01e23160303ce5646ecde15f8b8f66d0c7e1a3bc6689b2b1609890aaa4db62541f0d30058ea23ee6cf4772d80535826d5f2c1b500136bf6cae9

data/lib/artsy.rb

@@ -4,9 +4,13 @@
 ###        Make your Ruby terminal programs look nice!        ###
 ### Developed by Brett (https://github.com/notronaldmcdonald) ###
 #################################################################
+### Licensed under the GNU LGPLv3 license. See the LICENSE in ###
+###           the project root for more information.          ###
+#################################################################
 
 class Artsy
   # main class
+  require 'artsy/devel/handler'
   def self.out(text, colortype, r = 0, g = 0, b = 0, color: "none", formatting: "none")
     definedColours = ["\033[0m", "\033[31m", "\033[32m", "\033[93m", "\033[91m", "\033[92m", "\033[96m"]
     # print colored/formatted text (either from the preset list or with truecolors)
@@ -15,7 +19,7 @@ class Artsy
       # print with regular colors
       if color == "none"
         # fail if color undefined
-        raise StandardError.new "Invalid color defined (#{color})."
+        raise ArgumentError.new "Invalid color defined (#{color})."
       elsif color == "red"
         # printcolor = red
         printcolor = "#{definedColours[1]}"
@@ -31,27 +35,35 @@ class Artsy
         printcolor = "#{definedColours[6]}"
       else
         # fail
-        raise StandardError.new "Invalid color defined (#{color})."
+        raise ArgumentError.new "Invalid color defined (#{color})."
       end
     elsif colortype == "true"
+      # before doing anything, ensure all rgb values are within range
+      ArtsyDev::Handler.rgbOutOfRange("strict", r, g, b) # calls the handler check and passes rgb
       # print with rgb
       printcolor = "\033[38;2;#{r};#{g};#{b}m"
     else
       # fail
-      raise StandardError.new "Invalid colortype defined (#{colortype})."
+      raise ArgumentError.new "Invalid colortype defined (#{colortype})."
     end
-    if formatting == "none"
-      puts "#{printcolor}#{text}#{definedColours[0]}" # done!
-    elsif formatting == "bold"
-      puts "#{printcolor}\033[1m#{text}#{definedColours[0]}"
-    elsif formatting == "underline"
-      puts "#{printcolor}\033[4m#{text}#{definedColours[0]}"
-    elsif formatting == "italics"
-      # WARNING: Not widely supported by terminal emulators.
-      puts "#{printcolor}\033[3m#{text}#{definedColours[0]}"
+    case formatting
+      when "none"
+        puts "#{printcolor}#{text}#{definedColours[0]}" # done!
+      when "bold"
+        puts "#{printcolor}\033[1m#{text}#{definedColours[0]}"
+      when "underline", "ul"
+        puts "#{printcolor}\033[4m#{text}#{definedColours[0]}"
+      when "italics"
+        # WARNING: Not widely supported by terminal emulators.
+        puts "#{printcolor}\033[3m#{text}#{definedColours[0]}"
+      else
+        raise ArgumentError.new "Invalid formatting option set (#{formatting})."
     end
   end
   def self.gradientOut(text, r1, g1, b1, r2, g2, b2, stepping, debug = 0)
+    # before doing anything, check both rgb sets
+    ArtsyDev::Handler.rgbOutOfRange("strict", r1, g1, b1)
+    ArtsyDev::Handler.rgbOutOfRange("strict", r2, g2, b2)
     # prints text with a gradient
     # increases every value by stepping per character
     arr_Text = text.split("") # split text into array of characters
@@ -112,3 +124,7 @@ class Artsy
     print "\n" # print a newline
   end
 end
+
+# load any other gem components
+require 'artsy/menu'
+require 'artsy/colour'

data/lib/artsy/colour.rb

@@ -0,0 +1,29 @@
+#########################################################################
+###                             colour.rb                             ###
+#########################################################################
+### Provides a way for users to define their own custom colour values ###
+###     Developed by Brett (https://github.com/notronaldmcdonald)     ###
+#########################################################################
+require 'json' # needs json rubygem for loading schemes
+
+class Color
+  # class containing all colour manipulation functions, and variables
+  class Schemes
+    # colour schemes. namespaced under Color.
+    # these are essentially the same functions as above, but storing multiple colours in the hash
+    def initialize(filepath = "None")
+      # create a new colour scheme
+      @scheme = Hash.new
+    end
+
+    def setSColor(name, r, g, b)
+      # set scheme colour
+      @scheme["#{name}"] = "\033[38;2;#{r};#{g};#{b}m"
+    end
+
+    def out(text, colour)
+      # print using a scheme colour
+      puts "#{@scheme[colour]}#{text}\033[0m"
+    end
+  end
+end

data/lib/artsy/devel/handler.rb

@@ -0,0 +1,40 @@
+class ArtsyDev
+  # parent class as a namespace
+  class Handler
+    # subclass: contains some preset argumenterror cases
+    def self.rgbOutOfRange(mode, r, g, b)
+      # HACK: Change mode in the script to change how your artsy install deals with errors.
+      if mode == "strict"
+        # strict: raise an argument error exception without catching
+        limit = 255 # set limit
+        unless r <= limit and r >= 0
+          # fail if r exceeds limit or if lower than 0.
+          raise ArgumentError.new "'r' value out of range. Must be between 0-255 (you entered #{r})."
+        end
+        unless g <= limit and g >= 0
+          # fail for green
+          raise ArgumentError.new "'g' value out of range. Must be between 0-255 (you entered #{g})."
+        end
+        unless b <= limit and b >= 0
+          # fail for blue
+          raise ArgumentError.new "'b' value out of range. Must be between 0-255 (you entered #{b})."
+        end
+      elsif mode == "chill"
+        # chill: Print a warning message to stderr, but don't raise exception.
+        limit = 255
+        unless r <= limit and r >= 0
+          # warn for red
+          STDERR.puts "WARNING: red value out of range... (#{r})"
+        end
+        unless g <= limit and g >= 0
+          # warn for green
+          STDERR.puts "WARNING: green value out of range... (#{g})"
+        end
+        unless b <= limit and b >= 0
+          # warn for blue
+          STDERR.puts "WARNING: blue value out of range... (#{b})"
+        end
+      end
+    end
+  end
+end

data/lib/artsy/menu.rb

@@ -0,0 +1,72 @@
+########################################################################
+###                             menu.rb                              ###
+########################################################################
+###   Allows you to easily create menus in your terminal programs.   ###
+###    Developed by Brett. (https://github.com/notronaldmcdonald)    ###
+########################################################################
+
+class Menu
+  def initialize(title, opts = 3, selectMode = "int")
+    # you can set title and no. of opts for your menu object
+    @menutitle = title
+    @optstrings = Array.new(opts) # create an array for each option
+    @optids = Array.new(opts)
+    maxopts = opts - 1 # for use in the loop
+    for i in 0..maxopts
+      # cycle through the number of options, generating a default string for each
+      @optstrings[i] = "Option #{i}"
+      @optids[i] = i + 1
+    end # end of loop
+    @methodLoader = Linkage.new(@optids.count) # create an object, passing all necessary arguments to it
+  end # end of method
+
+  def setOpt(index, value)
+    # set the value of an option
+    index_real = index - 1
+    @optstrings[index_real] = "#{value}"
+  end
+
+  def show()
+    # print menu
+    puts "#{@menutitle}"
+    puts ""
+    for i in 1..@optids.count
+      # print each option
+      n = i - 1 # to access strings via index
+      puts "#{i}) #{@optstrings[n]}" # print the option
+    end
+    puts ""
+    puts "Enter your selection: "
+    @choice = gets.chomp
+    puts "You entered #{@choice}."
+    # now, we'll run some logic to ensure the choice was in @optids, then we can run the user's code!
+    @choice = Integer(@choice) # make sure it is int
+    @choice = @choice - 1 # convert to real
+    @methodLoader.run(@choice)
+  end # end of method
+
+  def assign(option, mname)
+    # a wrapper function to assign a method to an option
+    trueOpt = option - 1 # do some math
+    @methodLoader.bindMethod(trueOpt, mname)
+  end
+
+  class Linkage
+    # this private class contains functions for binding functions to an optid
+    def initialize(optsize)
+      # initializing the object, setting up the callbackMethods instance array based on optsize
+      @callbackMethods = Array.new(optsize)
+    end # simple method
+
+    def bindMethod(toOpt, mname)
+      # binding methods to a value in an array, to be called back later
+      @callbackMethods[toOpt] = mname
+    end
+
+    def run(target, *args)
+      # run the method assigned to the integer value in the array
+      @callbackMethods[target].call(*args) # taking any arguments, as they are sent to the attached method
+    end
+  end # end of private class
+  private_constant :Linkage # set as private constant
+end # end of class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artsy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Brett
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies: []
 description: Enables you to make good looking terminal programs with colors and text
   formatting.
@@ -18,9 +18,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/artsy.rb
+- lib/artsy/colour.rb
+- lib/artsy/devel/handler.rb
+- lib/artsy/menu.rb
 homepage: https://github.com/notronaldmcdonald/artsy
 licenses:
-- MIT
+- LGPL-3.0
 metadata: {}
 post_install_message:
 rdoc_options: []