blur 1.8.6 → 2.1.6

data/library/blur/script.rb

@@ -1,140 +1,156 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
-  # The +Script+ class is used for encapsulating dynamically loaded ruby scripts.
-  #
-  # The {Script#Script} method is then used to shape the DSL-language to make
-  # writing Blur scripts a breeze.
-  #
-  # @todo add examples in the documentation
-  # @see Script#Script
-  class Script
-    include Logging
-    include Evaluable
-    include DSL
-
-    ExtensionNotFoundError = Class.new StandardError
-    Emissions = [:connection_ready, :topic_change, :user_rename, :message,
-                 :private_message, :user_entered, :user_left, :user_quit,
-                 :user_kicked, :topic, :user_mode, :channel_mode,
-                 :channel_created, :channel_who_reply]
-
-    # @return the path in which the script remains.
-    attr_accessor :__path
-    # Can be used inside the script to act with the client itself.
-    # @return [Network::Client] the client delegate.
-    attr_accessor :__client
-    # @return [Array] a list of handled emissions.
-    attr_accessor :__emissions
-
-    # A list of extensions.
-    @@__extensions = []
-
-    # Find and evaluate script extensions.
-    def self.load_extensions!
-      root_path = File.dirname $0
-      
-      Dir.glob("#{root_path}/extensions/*.rb").each do |path|
-        extension = Extension.new path
-        extension.__client = self
-        extension.extension_loaded if extension.respond_to? :extension_loaded
-        
-        @@__extensions << extension
+  module Commands
+    # This is a command look-up-table with an autoincrementing index.
+    class CommandLUT
+      attr_accessor :commands
+
+      def initialize
+        @index = -1
+        @commands = {}
+      end
+
+      # Inserts the command to the LUT.
+      #
+      # @returns the index.
+      def << command
+        @commands[command] = @index += 1
+        @index
       end
     end
 
-    # "Unload" all script extensions.
-    def self.unload_extensions!
-      @@__extensions.clear
+    module ClassMethods
+      # Creates a new command.
+      #
+      # @example
+      #   command! '!ping' do |user, channel, args|
+      #     channel.say "#{user}: pong"
+      #   end
+      def command! command, *_args, &block
+        id = (command_lut << command)
+        define_method :"_command_#{id}", &block
+      end
     end
-    
-    # Check to see if the script has been evaluated.
-    def evaluated?; @__evaluated end
-    
-    # Instantiates a script and evaluates the contents which remain in +path+.
-    def initialize path
-      @__path = path
-      @__evaluated = false
-      @__emissions = []
-      
-      if evaluate_source_file path
-        cache.load if Cache.exists? @__name
-
-        Emissions.each do |emission|
-          @__emissions.push emission if respond_to? emission
-        end
-        
-        __send__ :loaded if respond_to? :loaded
-        __send__ :module_init if respond_to? :module_init
+
+    def self.included klass
+      class << klass
+        attr_accessor :command_lut
       end
+
+      klass.extend ClassMethods
+      klass.command_lut = CommandLUT.new
+      klass.register! message: lambda { |script, user, channel, line|
+        command, args = line.split ' ', 2
+        return unless command
+
+        if (id = klass.command_lut.commands[command.downcase])
+          script.__send__ :"_command_#{id}", user, channel, args
+        end
+      }
     end
-    
-    # Make it a DSL-way of writing a script.
-    #
-    # @example
-    #   Script :example do
-    #     def connection_ready network
-    #       # …
-    #     end
-    #   end
-    def Script name, options = {}, &block
-      @__name = name
-
-      extensions = options[:using] || options[:uses] 
-
-      # Automatically used extensions.
-      if extensions
-        extensions.each {|extension_name| using extension_name }
+  end
+
+  class SuperScript
+    class << self
+      attr_accessor :name, :authors, :version, :description, :events
+
+      # Sets the author.
+      #
+      # @example
+      #   Author 'John Doe <john.doe@example.com>'
+      def Author *authors
+        @authors = authors
       end
 
-      # Automatically included modules.
-      if options[:includes]
-        options[:includes].each{|module_name| self.extend module_name }
+      # Sets the description.
+      #
+      # @example
+      #   Description 'This is an example script.'
+      def Description description
+        @description = description
+      end
+
+      # Sets the version.
+      #
+      # @example
+      #   Version '1.0.0'
+      def Version version
+        @version = version
       end
-      
-      instance_eval &block
-      
-      true
-    end
 
-    # Add script extension and define a method with the same name as
-    # the extension.
-    def using *extension_names
-      extension_names.each do |extension_name|
-        if extension = @@__extensions.find{|ext| ext.__name.to_s == extension_name.to_s }
-          extension.extension_used self if extension.respond_to? :extension_used
-          self.metaclass.send :define_method, :"#{extension_name}" do
-            return extension
+      # Registers events to certain functions.
+      #
+      # @example
+      #   register! message: :on_message, connection_ready: :connected
+      def register! *args
+        args.each do |events|
+          case events
+          when Hash
+            events.each do |event, method_name|
+              register_event! event, method_name
+            end
+          when Array
+            register! *events
+          when Symbol
+            register_event! events
           end
-        else
-          raise ExtensionNotFoundError, "Extension not found: #{extension_name}"
         end
       end
-    end
-    
-    # Unload the script and save the cache, if present.
-    def unload!
-      cache.save if @__cache
-      __send__ :unloaded if respond_to? :unloaded
 
-      @__cache = nil
+      # Adds the given event +name+ and the name of the method to call once the
+      # event is emitted.
+      def register_event! name, method_name = name
+        (@events[name] ||= []) << method_name
+      end
+
+      def to_s
+        inspect
+      end
+
+      def inspect
+        %(#<SuperScript:0x#{object_id.to_s 16}>)
+      end
+
+      alias author authors
+      alias Authors Author
     end
 
-    # Access another script with name +name+.
-    #
-    # @return [Script] the script with the name +name+, or nil.
+    # Called when when the superscript has been loaded and added to the list of
+    # superscripts.
+    def self.init; end
+
+    # Called right before the script is being removed from the list of
+    # superscripts.
+    def self.deinit; end
+
+    # Reference to the main client that holds the script.
+    attr_accessor :_client_ref
+
+    # Script-specific configuration that is read from the main configuration
+    # file.
+    attr_accessor :config
+
+    attr_accessor :cache
+
+    # Called right before the instance of the script is being removed.
+    def unloaded; end
+
+    # Gets the instantiated script with +name+.
     def script name
-      @__client.scripts.find { |script| script.__name == name }
+      _client_ref.scripts[name]
     end
-    
-    # Get the cache, if none, instantiate a new cache.
-    def cache
-      @__cache ||= Cache.new self
-    end
-    
-    # Convert it to a debug-friendly format.
+
+    # Gets a human-readable representation of the script.
     def inspect
-      File.basename @__path
+      "#<Script(#{self.class.name.inspect}) " \
+        "@author=#{self.class.author.inspect} " \
+        "@version=#{self.class.version.inspect} " \
+        "@description=#{self.class.description.inspect}>"
+    end
+
+    def to_s
+      inspect
     end
   end
 end

data/library/blur/script_cache.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Blur
+  class ScriptCache
+    def initialize script_name, path, hash
+      @script_name = script_name
+      @path = path
+      @hash = hash
+    end
+
+    # Gets a cache +value+ by its +key+.
+    def [] key
+      @hash[key]
+    end
+
+    # Sets the cache +key+ to the provided +value+.
+    def []= key, value
+      @hash[key] = value
+    end
+
+    # Saves the cache as a YAML file.
+    def save
+      directory = File.dirname @path
+
+      Dir.mkdir directory unless File.directory? directory
+
+      File.open @path, 'w' do |file|
+        YAML.dump @hash, file
+      end
+    end
+
+    # Loads the cache file for +script_name+ in +cache_dir+ if it exists.
+    def self.load script_name, cache_dir
+      cache_path = File.join cache_dir, "#{script_name}.yml"
+
+      if File.exist? cache_path
+        object = YAML.load_file cache_path
+
+        ScriptCache.new script_name, cache_path, object
+      else
+        ScriptCache.new script_name, cache_path, {}
+      end
+    end
+  end
+end

data/library/blur/user.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Blur
+  # The +User+ class is used for encapsulating a user and its properties.
+  #
+  # The user owns a reference to its parent channel.
+  #
+  # Modes can be set for a user, but Blur is not
+  # {http://www.irc.org/tech_docs/005.html ISupport}-compliant yet.
+  #
+  # @todo make so that channels *and* users belongs to the network, and not
+  #   like now where the user belongs to the channel, resulting in multiple
+  #   user instances.
+  class User
+    # @return [String] the users nickname.
+    attr_accessor :nick
+    # @return [String] the users username.
+    attr_accessor :name
+    # @return [String] the users hostname.
+    attr_accessor :host
+    # @return [String] all the modes set on the user.
+    attr_accessor :modes
+    # @return [Network] a reference to the network.
+    attr_accessor :network
+    attr_accessor :channels
+
+    # @return [Hash<String, String>] a map of symbols to channel user modes.
+    COMMON_SYMBOL_MODES = {
+      '@' => 'o',
+      '+' => 'v',
+      '%' => 'h',
+      '&' => 'a',
+      '~' => 'q'
+    }.freeze
+
+    # Check to see if the user is an admin (+a)
+    def admin?
+      @modes.include? 'a'
+    end
+
+    # Check to see if the user has voice (+v)
+    def voice?
+      @modes.include? 'v'
+    end
+
+    # Check to see if the user is the owner (+q)
+    def owner?
+      @modes.include? 'q'
+    end
+
+    # Check to see if the user is an operator (+o)
+    def operator?
+      @modes.include? 'o'
+    end
+
+    # Check to see if the user is an half-operator (+h)
+    def half_operator?
+      @modes.include? 'h'
+    end
+
+    # Instantiate a user with a nickname.
+    def initialize nick, network = nil
+      @nick  = nick
+      @modes = String.new
+      @channels = []
+      @network = network
+
+      return unless (modes = prefix_to_mode(nick[0]))
+
+      @nick  = nick[1..]
+      @modes = modes
+    end
+
+    # Merge the users mode corresponding to the leading character (+ or -).
+    #
+    # @param [String] modes the modes to merge with.
+    def merge_modes modes
+      addition = true
+
+      modes.each_char do |char|
+        case char
+        when '+'
+          addition = true
+        when '-'
+          addition = false
+        else
+          addition ? @modes.concat(char) : @modes.delete!(char)
+        end
+      end
+    end
+
+    # Send a private message to the user.
+    #
+    # @param [String] message the message to send.
+    def say message
+      @network.say self, message
+    end
+
+    # Convert it to a debug-friendly format.
+    def inspect
+      %(#<#{self.class.name}:0x#{object_id.to_s 16} @nick=#{@nick.inspect}>)
+    end
+
+    # Called when YAML attempts to save the object, which happens when a
+    # scripts cache contains this user and the script is unloaded.
+    def to_yaml options = {}
+      @nick.to_yaml options
+    end
+
+    # Get the users nickname.
+    def to_s
+      @nick
+    end
+
+    private
+
+    # Translate a nickname-prefix to a mode character.
+    def prefix_to_mode prefix
+      COMMON_SYMBOL_MODES[prefix]
+    end
+  end
+end

data/library/blur/version.rb

@@ -1,13 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   # The current version of Blur.
-  Version = "1.8.6"
+  VERSION = '2.1.6'
 
   # Get the current version.
   #
   # @return [String] The current version of Blur.
   def self.version
-    Version
+    VERSION
   end
 end

data/library/blur.rb

@@ -1,36 +1,63 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'pp'
 require 'yaml'
-require 'majic'
 require 'socket'
+require 'base64'
 require 'ostruct'
 require 'openssl'
+
+require 'deep_merge/rails_compat'
 require 'eventmachine'
+require 'ircparser'
 
 # Require all library files.
-require 'blur/version'
-require 'blur/client'
-require 'blur/evaluable'
-require 'blur/script/dsl'
-require 'blur/extension'
-require 'blur/script'
-require 'blur/network'
-require 'blur/encryption'
-require 'blur/enhancements'
-require 'blur/script/cache'
-require 'blur/network/user'
-require 'blur/network/channel'
-require 'blur/network/command'
-require 'blur/network/isupport'
-require 'blur/network/connection'
-require 'blur/script/commands'
+require_relative './blur/version'
+require_relative './blur/callbacks'
+require_relative './blur/script'
+require_relative './blur/script_cache'
+require_relative './blur/network'
+require_relative './blur/client'
+require_relative './blur/user'
+require_relative './blur/channel'
+require_relative './blur/network/isupport'
+require_relative './blur/network/connection'
 
 # Blur is a very modular IRC-framework for ruby.
 #
 # It allows the developer to extend it in multiple ways.
 # It can be by handlers, scripts, communications, and what have you.
 module Blur
+  # Client error.
+  class ClientError < StandardError; end
+
+  # Configuration file error.
+  class ConfigError < StandardError; end
+
+  # Creates a new superscript class and inserts it into the list of scripts.
+  def self.Script name, *_args, &block
+    klass = Class.new SuperScript
+    klass.name = name
+    klass.events = {}
+    klass.class_exec &block
+    klass.init
+
+    scripts[name] = klass
+  end
+
+  # Gets all superscript classes.
+  def self.scripts
+    @scripts ||= {}
+  end
+
+  # Resets all scripts.
+  #
+  # This method will call `deinit` on each script class before removing them to
+  # give them a chance to clean up.
+  def self.reset_scripts!
+    scripts.each_value &:deinit
+    scripts.clear
+  end
+
   # Instantiates a client with given options and then makes the client instance
   # evaluate the given block to form a DSL.
   #

metadata

@@ -1,77 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: blur
 version: !ruby/object:Gem::Version
-  version: 1.8.6
+  version: 2.1.6
 platform: ruby
 authors:
 - Mikkel Kroman
-autorequire: 
-bindir: bin
+autorequire:
+bindir: executables
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: majic
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: 
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ircparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description:
 email: mk@uplink.io
-executables: []
+executables:
+- blur
 extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
 - LICENSE
 - README.md
+- executables/blur
 - library/blur.rb
+- library/blur/callbacks.rb
+- library/blur/channel.rb
 - library/blur/client.rb
-- library/blur/encryption.rb
-- library/blur/encryption/base64.rb
-- library/blur/encryption/fish.rb
-- library/blur/enhancements.rb
-- library/blur/evaluable.rb
-- library/blur/extension.rb
 - library/blur/handling.rb
 - library/blur/network.rb
-- library/blur/network/channel.rb
-- library/blur/network/command.rb
 - library/blur/network/connection.rb
 - library/blur/network/isupport.rb
-- library/blur/network/user.rb
 - library/blur/script.rb
-- library/blur/script/cache.rb
-- library/blur/script/commands.rb
-- library/blur/script/dsl.rb
+- library/blur/script_cache.rb
+- library/blur/user.rb
 - library/blur/version.rb
 homepage: https://github.com/mkroman/blur
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - library
@@ -79,16 +87,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: An event-driven IRC-framework for Ruby.
 test_files: []