artsy 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e36f8972ca13ddf1717d6a715a0bb2f6a53394f5c1c74366a6de39f52becc640
-  data.tar.gz: ed102c08091538dc5393c2f26c504c03c3733a0c533fdabc8013c4ec7d7df7bc
+  metadata.gz: 14db637c153d6dce542eacc55e154dc2dd3a6135894370a4566dd3121e659b95
+  data.tar.gz: 1562e5f4683a7fddc5312e36a48badf3e2e853a4b932b74e99da3dd41849455a
 SHA512:
-  metadata.gz: 132c65d1b7f53b342b2ce2cf32a1405f0fe0c1be5f43356352c91e9fd883824e39e80eb2c68002ebc6f8f7cc54555f467065116f695ed59fce9b9726f9bdca70
-  data.tar.gz: 51d37b4dd0b392425f4eeb3f2ed30b688dcfe97fd86878f8da3cca65dc263b3195fceef075fe5230d4fe0ea2434c51341e2e26629d0f2b371d4294f39232856a
+  metadata.gz: c38b8fbf673f19350da3b1caef2c49ad41dcc39ed67dc6d1f5a871d1dae562e224dd2e02f164c74bcdbf9e2ee86cfd8c7073b517cd5138056cd31831c2dd95a3
+  data.tar.gz: 3911cdd115b9f8ab118b1d312793c95f8f84c00605efc8be601ccfb865ac4910a33c874fe8210fc99c7172958e32a5dde77e1b26a9427da1061867f05ddf7fe5

data/lib/artsy.rb

@@ -7,6 +7,7 @@
 
 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 +16,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,19 +32,95 @@ 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]}"
+    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
+    if debug == 1
+      # show array
+      puts arr_Text
+    end
+    count = arr_Text.count
+    if debug == 1
+      puts count
+    end
+    count_cap = count - 1
+    cr = r1
+    cg = g1
+    cb = b1
+    for i in 0..count_cap
+      # iterate over characters
+      if r1 < r2
+        # if less than r2, +step and check nr accordingly
+        nr = cr + stepping
+        if nr < r2
+          # as long as less than r2, increment by stepping
+          cr = nr # cr is now nr
+        end
+      else
+        # -step and check nr differently
+        nr = cr - stepping
+        if nr > r2
+          cr = nr
+        end
+      end
+      if g1 < g2
+        ng = cg + stepping
+        if ng < g2
+          # green
+          cg = ng
+        end
+      else
+        ng = cg - stepping
+        if ng > g2
+          cg = ng
+        end
+      end
+      if b1 < b2
+        nb = cb + stepping
+        if nb < b2
+          cb = nb
+        end
+      else
+        nb = cb - stepping
+        if nb > b2
+          cb = nb
+        end
+      end
+      # in conclusion, don't increase if next color exceeds endpoint
+      print "\033[38;2;#{cr};#{cg};#{cb}m#{arr_Text[i]}\033[0m"
     end
+    print "\n" # print a newline
   end
 end
+
+# load any other gem components
+require 'artsy/menu'

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.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Brett
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies: []
 description: Enables you to make good looking terminal programs with colors and text
   formatting.
@@ -18,6 +18,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/artsy.rb
+- lib/artsy/devel/handler.rb
+- lib/artsy/menu.rb
 homepage: https://github.com/notronaldmcdonald/artsy
 licenses:
 - MIT