topherfangio-lcdproc-ruby 0.1.1

data/lib/lcdproc/menu_items/action.rb

@@ -0,0 +1,72 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module MenuItems
+    
+    class Action
+      include LCDProc::MenuItem
+      LCDProc::MenuItem.add_support( :action, self )
+      
+      @@action_item_count = 0
+      
+      
+      # Creates a new Action MenuItem object.
+      #
+      # The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+      #
+      # * <tt>:id</tt> - The unique string that identifies this action. Defaults to "ActionMenuItem_" + a sequence number.
+      #
+      # The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the action.
+      #
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this action. Defaults to the id.
+      def initialize( user_options = {}, lcdproc_options = {} )
+        @lcdproc_options = {}
+        
+        if user_options[:id].nil?
+          @id = "ActionMenuItem_#{@@action_item_count}"
+        else
+          @id = user_options[:id]
+        end
+        
+        @lcdproc_type = "action"
+        @lcdproc_event_type = "select"
+        
+        @lcdproc_options[:menu_result] = :none
+        @lcdproc_options[:text] = "#{@id}"
+        
+        @lcdproc_options.update( lcdproc_options )
+        
+        @lcdproc_options[:text] = "\"#{@lcdproc_options[:text]}\""
+        
+        @@action_item_count += 1
+      end
+    end
+    
+  end
+  
+end

data/lib/lcdproc/menu_items/alpha.rb

@@ -0,0 +1,85 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module MenuItems
+    
+    class Alpha
+      include LCDProc::MenuItem
+      LCDProc::MenuItem.add_support( :alpha, self )
+      
+      @@alpha_item_count = 0
+      
+      # Creates a new Alpha MenuItem object.
+      #
+      # The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+      #
+      # * <tt>:id</tt> - The unique string that identifies this alpha. Defaults to "AlphaMenuItem_" + a sequence number.
+      #
+      # The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the alpha.
+      #
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this alpha. Defaults to the id.
+      # * <tt>:value</tt> - The string that you wish to be able to modify. Defaults to "AString".
+      # * <tt>:password_char</tt> - If you wish that the text entered be a password, you may set this char to appear instead of the actual letters. Defaults to "" (off).
+      # * <tt>:minlength</tt> - The minimum allowed length of the string. Defaults to 0.
+      # * <tt>:maxlength</tt> - The maximum allowed length of the string. Defaults to 10.
+      # * <tt>:allow_caps</tt> - Whether or not the string is allowed to have capital letters. Defaults to true.
+      # * <tt>:allow_noncaps</tt> - ??? Not quite sure about this one, I believe it is whether or not you may have lower case letters. Defaults to false (this is the puzzling part).
+      # * <tt>:allow_numbers</tt> - Whether or not the string is allowed to have numbers. Defaults to false.
+      # * <tt>:allow_extras</tt> - A string containing any other characters that you wish to be allowed. Defaults to "".
+      def initialize( user_options = {}, lcdproc_options = {} )
+        @lcdproc_options = {}
+        
+        if user_options[:id].nil?
+          @id = "AlphaMenuItem_#{@@alpha_item_count}"
+        else
+          @id = user_options[:id]
+        end
+        
+        @lcdproc_type = "alpha"
+        @lcdproc_event_type = "update"
+        
+        @lcdproc_options[:text] = "#{@id}"
+        @lcdproc_options[:value] = "AString"
+        @lcdproc_options[:password_char] = ""
+        @lcdproc_options[:minlength] = 0
+        @lcdproc_options[:maxlength] = 10
+        @lcdproc_options[:allow_caps] = true
+        @lcdproc_options[:allow_noncaps] = false
+        @lcdproc_options[:allow_numbers] = false
+        
+        @lcdproc_options.update( lcdproc_options )
+        
+        [ :text, :value, :password_char ].each { |s| @lcdproc_options[s].quotify! }
+        
+        @@alpha_item_count += 1
+      end
+    end
+    
+  end
+  
+end

data/lib/lcdproc/menu_items/checkbox.rb

@@ -0,0 +1,76 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module MenuItems
+    
+    class Checkbox
+      include LCDProc::MenuItem
+      LCDProc::MenuItem.add_support( :checkbox, self )
+      
+      @@checkbox_item_count = 0
+      
+      
+      # Creates a new Checkbox MenuItem object.
+      #
+      # The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+      #
+      # * <tt>:id</tt> - The unique string that identifies this checkbox. Defaults to "CheckboxMenuItem_" + a sequence number.
+      #
+      # The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the checkbox.
+      #
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this checkbox. Defaults to the id.
+      # * <tt>:value</tt> - The starting value. Valid options are :off, :on, and :gray (if :allow_grey is true). Defaults to :off.
+      # * <tt>:allow_grey</tt> - If true, the value may be set to :grey.
+      def initialize( user_options = {}, lcdproc_options = {} )
+        @lcdproc_options = {}
+        
+        if user_options[:id].nil?
+          @id = "CheckboxMenuItem_#{@@checkbox_item_count}"
+        else
+          @id = user_options[:id]
+        end
+        
+        @lcdproc_type = "checkbox"
+        @lcdproc_event_type = "update"
+        
+        @lcdproc_options[:text] = "#{@id}"
+        
+        @lcdproc_options[:value] = :off
+        @lcdproc_options[:allow_gray] = false
+        
+        @lcdproc_options.update( lcdproc_options )
+        
+        @lcdproc_options[:text] = "\"#{@lcdproc_options[:text]}\""
+        
+        @@checkbox_item_count += 1
+      end
+    end
+    
+  end
+  
+end

data/lib/lcdproc/menu_items/ip.rb

@@ -0,0 +1,75 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module MenuItems
+    
+    class IP
+      include LCDProc::MenuItem
+      LCDProc::MenuItem.add_support( :ip, self )
+      
+      @@ip_item_count = 0
+      
+      # Creates a new IP MenuItem object.
+      #
+      # The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+      #
+      # * <tt>:id</tt> - The unique string that identifies this ip menu item. Defaults to "IPMenuItem_" + a sequence number.
+      #
+      # The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the ip.
+      #
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this ip. Defaults to the id.
+      # * <tt>:value</tt> - The value of the IP address. Defaults to "0.0.0.0".
+      # * <tt>:v6</tt> - Whether or not the IP address should be in IPv6 format or not. Defaults to false.
+      def initialize( user_options = {}, lcdproc_options = {} )
+        @lcdproc_options = {}
+        
+        if user_options[:id].nil?
+          @id = "IPMenuItem_#{@@ip_item_count}"
+        else
+          @id = user_options[:id]
+        end
+        
+        @lcdproc_type = "ip"
+        @lcdproc_event_type = "update"
+        
+        @lcdproc_options[:text] = "#{@id}"
+        
+        @lcdproc_options[:value] = "0.0.0.0"
+        @lcdproc_options[:v6] = false
+        
+        @lcdproc_options.update( lcdproc_options )
+        
+        [ :text, :value ].each { |s| @lcdproc_options[s].quotify! }
+        
+        @@ip_item_count += 1
+      end
+    end
+    
+  end
+  
+end

data/lib/lcdproc/menu_items/numeric.rb

@@ -0,0 +1,75 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+
+	module MenuItems
+
+		class Numeric
+			include LCDProc::MenuItem
+			LCDProc::MenuItem.add_support( :numeric, self )
+
+			@@numeric_item_count = 0
+
+			# Creates a new Numeric MenuItem object.
+			#
+			# The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+			#
+			# * <tt>:id</tt> - The unique string that identifies this numeric. Defaults to "NumericMenuItem_" + a sequence number.
+			#
+			# The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the numeric.
+			#
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this numeric. Defaults to the id.
+      # * <tt>:minvalue</tt> - The minimum value that the numeric should allow. Defaults to 0 but can be negative.
+			# * <tt>:maxvalue</tt> - The maximum value that the numeric should allow. Defaults to 100.
+			def initialize( user_options = {}, lcdproc_options = {} )
+				@lcdproc_options = {}
+
+				if user_options[:id].nil?
+					@id = "NumericMenuItem_#{@@numeric_item_count}"
+				else
+					@id = user_options[:id]
+				end
+
+				@lcdproc_type = "numeric"
+				@lcdproc_event_type = "update"
+				
+				@lcdproc_options[:text] = @id
+
+				@lcdproc_options[:minvalue] = 0
+				@lcdproc_options[:maxvalue] = 100
+
+				@lcdproc_options.update( lcdproc_options )
+
+				@lcdproc_options[:text] = "\"#{@lcdproc_options[:text]}\""
+
+				@@numeric_item_count += 1
+			end
+		end
+
+	end
+
+end

data/lib/lcdproc/menu_items/ring.rb

@@ -0,0 +1,75 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2008 Topher Fangio
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#-------------------------------------------------------------------------------
+
+
+module LCDProc
+  
+  module MenuItems
+    
+    class Ring
+      include LCDProc::MenuItem
+      LCDProc::MenuItem.add_support( :ring, self )
+      
+      @@ring_item_count = 0
+      
+      # Creates a new Ring MenuItem object.
+      #
+      # The <tt>user_options</tt> will accept a hash of the following MenuItem options.
+      #
+      # * <tt>:id</tt> - The unique string that identifies this ring. Defaults to "RingMenuMenuItem_" + a sequence number.
+      #
+      # The <tt>lcdproc_options</tt> will accept a hash of the options to be passed to LCDd when creating or updating the ring.
+      #
+      # * <tt>:text</tt> - The text to be displayed on the LCD for this ring. Defaults to the id.
+      # * <tt>:strings</tt> - A tab separated list of the strings to be displayed as options. Defaults to "Yes\tNo\tMaybe".
+      # * <tt>:value</tt> - The index of the string to be displayed initially. Defaults to 0.
+      def initialize( user_options = {}, lcdproc_options = {} )
+        @lcdproc_options = {}
+        
+        if user_options[:id].nil?
+          @id = "RingMenuItem_#{@@ring_item_count}"
+        else
+          @id = user_options[:id]
+        end
+        
+        @lcdproc_type = "ring"
+        @lcdproc_event_type = "update"
+        
+        @lcdproc_options[:text] = @id
+        
+        @lcdproc_options[:strings] = "Yes\tNo\tMaybe"
+        @lcdproc_options[:value] = 0
+        
+        @lcdproc_options.update( lcdproc_options )
+        
+        [ :text, :strings ].each { |s| @lcdproc_options[s].quotify! }
+        
+        @@ring_item_count += 1
+      end
+    end
+    
+  end
+  
+end