syndi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 27ade4d78970ed7812bb1e4f7edb12b755e2ad84
-  data.tar.gz: cdc9beaf0aba4162ca054d0085ab053dd7929844
+  metadata.gz: d3c3c628e51409c1937e24f0b5d297fb1d8b3cdd
+  data.tar.gz: e5e3f0cc263f154cb4f0df8ba70313a2d9cb2921
 !binary "U0hBNTEy":
-  metadata.gz: e7d8e880065a0bfdbe71e6ed8963944026214745d9f6f4351b41888faf898494db17a71dd1920f59aa9825679ce09eddc8df3c5d12bb1c77bde2a61e33ea89c8
-  data.tar.gz: d3d4ac783179808b7ae38391b0fe3cef5796f2c931e65b09806c088cf7b2c5c817488a90f2062bd53f1f1687dc861867b2f5e8eb9eee75ec094300c60af7da8f
+  metadata.gz: 0e5a95e3c02248c6e82d1e098147016ae9c7554b9ed4beee218ecb2068cab656d3ff50a526d6adf9ef9a92cb06765d7aabb4340a7d0d444ef4b7cf45b5e27a4c
+  data.tar.gz: 7c57468b20970ef7a2d152f503df0d1eb241a872b4f723e72908d9e7d9e92e9c5214bcd2f41562101ce4d755a9beeda228ef059b934206171b84930d76431fdf

data/README.md

@@ -5,12 +5,12 @@ _A modern, elegant, extensible multi-protocol chat bot—reloaded._
 
 **Formerly known as Auto.**
 
-**Version**:            0.1.0 "Phoenix"  
+**Version**:            0.1.1 "Phoenix"  
 [![Build Status](https://travis-ci.org/syndibot/syndi.png?branch=master)](https://travis-ci.org/syndibot/syndi)
-[![Dependency Status](https://gemnasium.com/syndibot/syndi.png)](https://gemnasium.com/syndibot/syndi)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/syndibot/syndi)
+[![Dependency Status](https://gemnasium.com/syndibot/syndi.png)](https://gemnasium.com/syndibot/syndi)  
+[![Code Climate](https://codeclimate.com/github/syndibot/syndi.png)](https://codeclimate.com/github/syndibot/syndi)
 
-+ [Homepage](http://syndibot.com) (lots of information)
++ [Website](http://syndibot.com) (lots of information)
 + [RubyGems](https://rubygems.org/gems/syndi)
 + [Wiki](https://github.com/syndibot/syndi/wiki)
 + [Mailing List](https://groups.google.com/group/syndibot)
@@ -19,10 +19,6 @@ _A modern, elegant, extensible multi-protocol chat bot—reloaded._
 
 Our official IRC channel is [#syndi on irc.freenode.net](irc://irc.freenode.net/#syndi).
 
-### Is it Production-Ready™?
-
-Not yet. Syndi 4's a fairly sizable project. We're getting close though.
-
 Synopsis
 --------
 
@@ -34,6 +30,10 @@ Syndi is automated chat bot software, developed per this philosophy:
 
 It is a reboot of Auto, an old IRC bot which, though featureful, suffered of design flaws.
 
+### Is it Production-Ready™?
+
+Not yet. Syndi's a fairly sizable project. We're getting close though.
+
 Installation
 ------------
 

data/Rakefile

@@ -2,7 +2,7 @@
 # This free software is distributed under the FreeBSD license (see LICENSE).
 
 # import the gemspec
-GEMSPEC    = 'Syndi.gemspec'
+GEMSPEC    = 'syndi.gemspec'
 $gemspec ||= eval(File.read(GEMSPEC), binding, GEMSPEC)
 
 def perform t
@@ -19,7 +19,11 @@ Dir["tasks/**/*.rake"].each do |t|
 end
 
 # groups
-task :default => %i[compile native gem]
+if ENV['CI']
+  task :default => %i[compile spec]
+else
+  task :default => %i[compile native gem]
+end
 task :typical => %i[compile spec]
 task :full    => %i[clean typical gem install]
 

data/WINDOWS.md

@@ -18,7 +18,7 @@ Windows users can install Syndi easily by downloading and installing from RubyGe
     $ gem install Syndi [--pre]
 
 On Windows, this will install the native Windows distribution, which includes the
-_libsyndi_ library cross-compiled with [Minimalist GNU for Windows](http://www.mingw.org/),
+_csyndi_ library cross-compiled with [Minimalist GNU for Windows](http://www.mingw.org/),
 commonly called MinGW.
 
 This assumes that you have installed Ruby compiled with MinGW; this is the case
@@ -35,7 +35,7 @@ a sufficiently sane build environment for this on Windows. We haven't tested
 it since we cross-compile on UNIX systems when packaging gems.
 
 You must then force RubyGems to download the distribution without binaries, so
-that _libsyndi_ will be compiled:
+that _csyndi_ will be compiled:
 
     $ gem install Syndi [--pre] --platform=ruby --development
 

data/bin/syndi

@@ -49,7 +49,7 @@ opts = Slop.parse(:banner => "Usage: #$PROGRAM_NAME [options]") do
 Syndi #{Syndi::FULLVERSION}
 [os: #{::RbConfig::CONFIG['host_os']}] [rb: #{::RbConfig::CONFIG['ruby_version']}] [arch: #{::RbConfig::CONFIG['arch']}]
 
-http://syndiproj.org
+http://syndibot.com
     EOV
     exit 0
   end

data/bin/syndi-conf

@@ -23,7 +23,7 @@ opts = Slop.parse(:banner => "Usage: #$0 [options/command]") do
     puts <<-EOV
 Syndi Configure v#{Syndi::Configure::VERSION}
 
-http://syndiproj.org
+http://syndibot.com
     EOV
     exit 0
   end

data/ext/csyndi/libauto.c

@@ -23,7 +23,7 @@ void initialize_exceptions()
 }
 
 /* initialize Syndi module */
-void Init_libsyndi()
+void Init_csyndi()
 {
     mSyndi = rb_define_module("Syndi");
     /* initialize exceptions */

data/ext/csyndi/logger.c

@@ -133,15 +133,16 @@ VALUE logger_fatal(VALUE self, VALUE message)
  *   @param [Boolean] backtrace Whether to output a backtrace.
  *   @return [nil]
  */
-VALUE logger_error(int argc, VALUE argv, VALUE self)
+VALUE logger_error(int argc, VALUE *argv, VALUE self)
 {
     VALUE message;
     VALUE backtrace;
     VALUE bt_bool;
+    char *msg;
 
     rb_scan_args(argc, argv, "11", &message, &bt_bool);
 
-    char *msg = RSTRING_PTR(message);
+    msg = RSTRING_PTR(message);
     log_out2file("ERROR", msg);
     log_out2scrn(TYPE_ERROR, msg, 0);
 

data/include/syndi/csyndi.h

@@ -14,8 +14,8 @@
 /* variable for the Syndi module */
 extern VALUE mSyndi;
 
-/* Init_libsyndi prototype */
-void Init_libsyndi();
+/* Init_csyndi prototype */
+void Init_csyndi();
 
 /* Syndi's exceptions */
 extern VALUE eLogError;
@@ -31,7 +31,7 @@ extern VALUE ePluginError;
 #endif
 
 /* fetch the Syndi directory */
-#define SYNDI_DIR RSTRING_PTR(rb_funcall(mSyndi, SYM(app_dir), 0))
+#define SYNDI_DIR RSTRING_PTR(rb_funcall(mSyndi, SYM(dir), 0))
 
 #endif
 

data/include/syndi/logger.h

@@ -36,8 +36,7 @@ void init_syndi_logger();
 VALUE logger_init(VALUE self);
 
 VALUE logger_fatal(VALUE self, VALUE message);
-VALUE logger_error(VALUE self, VALUE message);
-VALUE logger_error_bt(VALUE self, VALUE message, VALUE backtrace);
+VALUE logger_error(int argc, VALUE *argv, VALUE message);
 VALUE logger_verbose(VALUE self, VALUE message, VALUE level);
 VALUE logger_warning(VALUE self, VALUE message);
 VALUE logger_info(VALUE self, VALUE message);

data/include/syndi.h

@@ -11,8 +11,8 @@
 #include <stdio.h>
 #include "ruby.h"
 
-/* include libsyndi headers */
-#include "syndi/libsyndi.h"
+/* include csyndi headers */
+#include "syndi/csyndi.h"
 #include "syndi/logger.h"
 #include "syndi/events.h"
 #include "syndi/integer.h"

data/lib/syndi/bot.rb

@@ -1,11 +1,7 @@
 # Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
 # This free software is distributed under the FreeBSD license (see LICENSE).
 
-syndiload :Redis,  'redis'
-syndiload :FileKV, 'filekv'
-
-require 'syndi/config'
-require 'syndi/api'
+require 'redis'
 
 # Namespace: Syndi
 module Syndi

data/lib/syndi/config.rb

@@ -3,7 +3,7 @@
 
 require 'psych'
 require 'syndi/verbosity'
-require 'libsyndi'
+require 'csyndi'
 
 # Namespace: Syndi
 module Syndi

data/lib/syndi/events.rb

@@ -50,11 +50,7 @@ module Syndi
       if @events[event]
 
         # collect the listeners with respect to priority
-        one   = @events.collect { |hook| (hook.priority == 1 ? hook : nil) }.compact
-        two   = @events.collect { |hook| (hook.priority == 2 ? hook : nil) }.compact
-        three = @events.collect { |hook| (hook.priority == 3 ? hook : nil) }.compact
-        four  = @events.collect { |hook| (hook.priority == 4 ? hook : nil) }.compact
-        five  = @events.collect { |hook| (hook.priority == 5 ? hook : nil) }.compact
+        one, two, three, four, five = gather @events[event]
 
         Syndi.log.verbose "event *#{event}* is being broadcasted on #{self}", VNOISY
 
@@ -64,11 +60,11 @@ module Syndi
             # cease if status ever becomes false/nil
             status = true
             
-            one.each   { |code| status = code.call parameters if status }
-            two.each   { |code| status = code.call parameters if status }
-            three.each { |code| status = code.call parameters if status }
-            four.each  { |code| status = code.call parameters if status }
-            five.each  { |code| status = code.call parameters if status }
+            one.each   { |code| status = code.call *parameters if status }
+            two.each   { |code| status = code.call *parameters if status }
+            three.each { |code| status = code.call *parameters if status }
+            four.each  { |code| status = code.call *parameters if status }
+            five.each  { |code| status = code.call *parameters if status }
           rescue => e
             # catch thread errors
             Syndi.log.error "A listener to a broadcast of #{event} on #{self} caused an exception to rise (#{e})", true
@@ -83,10 +79,24 @@ module Syndi
     end
     alias_method :to_s, :inspect
 
+    private
+
+    # Gather hooks.
+    def gather list
+      [list.collect { |hook| (hook.priority == 1 ? hook : nil) }.compact,
+       list.collect { |hook| (hook.priority == 2 ? hook : nil) }.compact,
+       list.collect { |hook| (hook.priority == 3 ? hook : nil) }.compact,
+       list.collect { |hook| (hook.priority == 4 ? hook : nil) }.compact,
+       list.collect { |hook| (hook.priority == 5 ? hook : nil) }.compact]
+    end
+
+    public
+
     # A class which represents a listener.
     class Listener
       attr_reader :event, :priority, :code
 
+      # Spawn a new listener object.
       def initialize sys, event, priority, prc
         @sys      = sys
         @event    = event
@@ -96,12 +106,18 @@ module Syndi
         Syndi.log.verbose "new listener spawned and attached to #{event}: #{self}", VNOISY
       end
 
+      # Terminate this object.
       def deaf
         @sys.events[event].delete self
       end
 
+      # Execute this listener.
+      def call *args
+        @code.call *args
+      end
+
       def inspect
-        "<#Syndi::Events::Listener: sys=#@sys event=#@event priority=#@priority proc={#@code}>"
+        "<#Syndi::Events::Listener: sys=#@sys event=#@event priority=#@priority>"
       end
       alias_method :to_s, :inspect
 

data/lib/syndi/irc/protocol.rb

@@ -3,12 +3,8 @@
 
 require 'syndi/irc/protocol/numerics'
 
-# namespace Syndi
 module Syndi
-
-  # namespace IRC
   module IRC
-    syndiload :SASL, 'syndi/irc/sasl/mech'
 
     # A class for parsing of data per the specifications of the IRC protocol,
     # v3.1.
@@ -123,6 +119,7 @@ module Syndi
         end
 
         if $m.conf['irc'][irc.s]['SASL'] and list.include? 'sasl'
+          require 'syndi/irc/sasl/mech'
           req.push 'sasl'
         end
 

data/lib/syndi/irc/sasl/mech/dh_blowfish.rb

@@ -3,7 +3,7 @@
 
 require 'base64'
 require 'openssl'
-require 'libsyndi'
+require 'csyndi'
 require 'syndi/irc/sasl/diffie_hellman'
 
 module Syndi

data/lib/syndi/irc/sasl/mech.rb

@@ -1,15 +1,7 @@
 # Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
 # This free software is distributed under the FreeBSD license (see LICENSE).
 
-module Syndi
-  module IRC
-    module SASL
-      module Mech
-        syndiload :DHBlowfish, 'syndi/irc/sasl/mech/dh_blowfish'
-        syndiload :Plain,      'syndi/irc/sasl/mech/plain'
-      end
-    end
-  end
-end
+require 'syndi/irc/sasl/mech/dh_blowfish'
+require 'syndi/irc/sasl/mech/plain'
 
 # vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/version.rb

@@ -6,7 +6,7 @@ module Syndi
   # Standard version string.
   #
   # We use semantic versioning: +MAJOR.MINOR.PATCH.PRE.PRENUM+
-  VERSION      = '0.1.0'.freeze
+  VERSION      = '0.1.1'.freeze
   
   # Standard version plus the codename (assigned to each minor release).
   #

data/lib/syndi.rb

@@ -3,6 +3,7 @@
 
 require 'syndi/rubyext/string'
 require 'syndi/version'
+require 'fileutils'
 
 module Syndi
   extend self
@@ -62,6 +63,13 @@ module Syndi
     @app_dir ||= File.join ENV['HOME'], '.syndi'
   end
 
+  # Set the application data directory.
+  def dir= directory
+    FileUtils.mkdir_p directory unless Dir.exists? directory
+    Dir.chdir directory
+    @app_dir = directory
+  end 
+
   # Initiate Syndi with command-line +options+.
   #
   # @param [Slop] options The command-line options.
@@ -123,7 +131,7 @@ else
   require 'colored'
 end
 
-require 'libsyndi'
+require 'csyndi'
 %w[events actress config bot].each { |lib| require "syndi/#{lib}" }
 
 # vim: set ts=4 sts=2 sw=2 et:

data/spec/helper.rb

@@ -9,24 +9,29 @@ require 'rspec/expectations'
 require 'rspec/mocks'
 require 'fileutils'
 require 'stringio'
+require 'tmpdir'
     
 require 'syndi'
 
-$temp_dir = Dir.mktmpdir 'syndi-rspec'
-Syndi.app_dir = $temp_dir
-$VERBOSITY = Float::INFINITY
+$temp_dir = Dir.mktmpdir
+Syndi.dir = $temp_dir
+$VERBOSITY = -1
 
 module Helper
 
 end
 
 RSpec.configure do |conf|
-  conf.syntax = :expect
   conf.include Helper
 
   conf.after(:all) do
+    Dir.chdir __dir__
     FileUtils.remove_entry $temp_dir
   end
+
+  conf.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end
 
 # vim: set ts=4 sts=2 sw=2 et:

data/spec/syndi/events_spec.rb

@@ -13,28 +13,74 @@ describe Syndi::Events do
     
     it 'listens for an event' do
       @events.on(:moo) do |magic|
-       magic = true
+        magic.write 'OK'
       end
 
-      rawr = false
+      rawr = StringIO.new
       @events.emit :moo, rawr
+      sleep 0.1
 
-      expect { rawr }.to be_true
+      rawr.seek 0
+      expect(rawr.string).to eq 'OK'
     end
 
     it 'returns a listener' do
-      expect do
-        @events.on(:cows) { nil }
-      end.to be_an_instance_of Syndi::Events::Listener
+      hook = @events.on(:cows) { nil }
+      expect(hook).to be_an_instance_of Syndi::Events::Listener
+    end
+
+    context 'when given a priority outside 1..5' do
+      it 'raises an ArgumentError' do
+        expect { @events.on(:meowbar, 6) { nil } }.to raise_error ArgumentError
+      end
+    end
+
+  end
+
+  describe '#emit' do
+    
+    it 'broadcasts an event' do
+      @events.on(:fairy) do |cat, meow|
+        cat.write meow
+      end
+
+      cat = StringIO.new
+      @events.emit :fairy, cat, 'meow'
+      sleep 0.1
+
+      expect(cat.string).to eq 'meow'
+    end
+
+    it 'respects priority' do
+      @order = ''
+      @events.on(:a, 1) { |order| order << 'A' }
+      @events.on(:a, 3) { |order| order << 'B' }
+      @events.on(:a, 5) { |order| order << 'C' }
+
+      @events.emit :a, @order
+      sleep 0.1
+
+      expect(@order).to eq 'ABC'
     end
 
   end
 
-  describe '#emit'
+  describe Syndi::Events::Listener do
 
-  describe Syndi::Events::Listener
+    describe '#deaf' do
 
-    describe '#deaf'
+      it 'terminates a listener' do
+        @ok = true
+        hook = @events.on(:beep) { @ok = false }
+        hook.deaf
+
+        @events.emit :beep
+        sleep 0.1
+
+        expect(@ok).to be_true
+      end
+
+    end
 
   end
 

data/tasks/compile.rake

@@ -4,7 +4,7 @@
 require 'rake/extensiontask'
 
 desc 'Compile the native extension.'
-Rake::ExtensionTask.new 'libsyndi', $gemspec do |ext|
+Rake::ExtensionTask.new 'csyndi', $gemspec do |ext|
   ext.cross_compile  = true
 
   ext.cross_compiling do |spec|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syndi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Autumn Perrault
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,17 +150,13 @@ extra_rdoc_files: []
 files:
 - bin/syndi-conf
 - bin/syndi
+- lib/csyndi.so
 - lib/syndi/dsl/irc.rb
 - lib/syndi/dsl/base.rb
-- lib/syndi/configure.rb
 - lib/syndi/verbosity.rb
 - lib/syndi/api.rb
 - lib/syndi/rubyext/string.rb
 - lib/syndi/irc.rb
-- lib/syndi/configure/generator.rb
-- lib/syndi/configure/cli.rb
-- lib/syndi/api/plugin.rb
-- lib/syndi/api/events.rb
 - lib/syndi/api/object.rb
 - lib/syndi/config.rb
 - lib/syndi/version.rb
@@ -208,7 +204,6 @@ files:
 - README.md
 - LICENSE
 - WINDOWS.md
-- INSTALL.md
 - CHANGELOG.md
 - Gemfile
 - Rakefile

data/INSTALL.md

@@ -1,86 +0,0 @@
-*This is a copy of https://github.com/Syndi/Syndi/wiki/Install-Guide as it appeared Jan 13 2013 4:16 UTC.*
-
-Thank you for choosing **Syndi 4** to serve your needs! Please foremost read the [licensing terms](/Syndi/Syndi/wiki/License), as *by proceeding you confirm your agreement to them*.
-
-Before installing, you must decide on how you would like to install Syndi. There is a relatively easy way, and a somewhat more advanced way.
-
-For most users, the relatively easy way is advisable, and that is the **gem method**.
-
-Users who have some reason for doing so and are more advanced can install Syndi from source. See further below for that.
-
----
-
-# Gem
-
-You must have [Ruby 1.9.2 or later](http://www.ruby-lang.org).
-
-## Installation
-
-There is a complete list of releases and links therefor on the [official releases page](http://syndi.syndiproj.org/releases.html).
-
-We recommend merely installing the latest (pre-)release from [RubyGems](https://rubygems.org/gems/Syndi):
-
-    $ gem install Syndi --pre
-
-If you downloaded the source, either from Git or in an archive, do this in the main directory to compile a gem:
-
-    $ gem build Syndi.gemspec
-    $ gem install Syndi-*.gem
-
-Depending on which database management system you wish to use, you must separately download the respective gem whether you use the distributed **Syndi** or your own build:
-
-**SQLite**: `$ gem install sqlite3`  
-**MySQL**: `$ gem install mysqlplus`  
-**PostgreSQL**: `$ gem install pg`
-
-## Configuration
-
-The indispensable [Syndi Configure](/Syndi/Syndi/wiki/Syndi-Configure) utility will help you configure Syndi, and this is the suggested method as it is the easiest.
-
-    $ syndi-conf
-
-Otherwise you must navigate to the path to which **syndibot** was installed (typically somewhere in `~/.gem/`) and find the `conf/` directory; that is unless you cloned from Git, in which case you'll find it in `Syndi/conf/`.
-
-The **Y**AML **A**in't **M**arkup **L**anguage configuration, which is suggested, is `example.yml`. Open it with your favorite editor and save it as `~/.config/syndibot/syndi.yml`. You can also save it to a path of your choosing, but remember to invoke Syndi with `--config=path/to/config.yml`:
-
-    $ syndi --config=/somewhere/where/cows/speak/syndi.yml
-
-If you prefer, the **J**ava **S**cript **O**bject **N**otation configuration is `example.json`. Modify it as above (except use a `.json` extension). Invoke Syndi with the `-j` flag (unless you specify `--config`, in which case the `--j` is superfluous).
-
-    $ syndi -j
-
-## Start
-
-    $ syndi
-
-Consult with the [Syndi Handbook](/Syndi/Syndi/wiki/Syndi-Handbook) for information on using Syndi.
-
-# Source
-
-You need at least [Ruby 1.9.2](http://www.ruby-lang.org)!
-
-The easiest way to install Syndi's gem prerequisites is to use [**GemBundler**](https://rubygems.org/gems/bundler). Install it:
-
-    $ gem install bundler
-
-After downloading the source code and entering the main directory, invoke bundler:
-
-    $ bundle install --without dev
-
-If testing and/or development are among your intentions, exclude the `--without dev` to install testing/development dependencies.
-
-Depending on which database management system you wish to use, you must separately download the respective gem:
-
-**SQLite**: `$ gem install sqlite3`  
-**MySQL**: `$ gem install mysqlplus`  
-**PostgreSQL**: `$ gem install pg`
-
-All releases can be obtained in either Git, Tar/GZ, or Zip format from the [official releases page](http://syndi.syndiproj.org/releases.html).
-
-Compile the source code:
-
-    $ rake compile
-
-To test Syndi (and you must have installed the testing dependencies), invoke:
-
-    $ rake test