tkellem 0.9.1 → 0.9.2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -1,8 +1,8 @@
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
 coverage/*
 doc/*
 .yardoc/*
 test.log
+tmp/*

data/.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
+bundler_args: --without development
 rvm:
   - "1.9.3"
   - "2.0.0"
-  - rbx-19mode
 # uncomment this line if your project needs to run something other than `rake`:
 # script: bundle exec rspec spec
+matrix:
+  allow_failures:
+    # this is intermittently failing with "attempt to unlock a mutex that is not locked" errors
+    # while creating an EM threadpool
+    - rvm: "2.0.0"
 

data/Gemfile

@@ -4,6 +4,13 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'rspec', '~> 2.5'
-  gem 'simplecov'
+  gem 'rspec', '~> 2.13.0'
+  gem 'mocha', '0.14.0', require: false
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+end
+
+group :development do
+  gem 'guard-rspec'
+  gem 'rspec-nc'
 end

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    tkellem (0.9.2)
+      activerecord (~> 4.0.0.rc2)
+      eventmachine (~> 1.0.3)
+      rails-observers (~> 0.1.1)
+      sqlite3 (~> 1.3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      builder (~> 3.1.0)
+    activerecord (4.0.0.rc2)
+      activemodel (= 4.0.0.rc2)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0.rc2)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0.rc2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.9)
+    builder (3.1.4)
+    coderay (1.0.9)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    i18n (0.6.4)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    mime-types (1.23)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails-observers (0.1.1)
+      railties (~> 4.0.0.beta)
+    railties (4.0.0.rc2)
+      actionpack (= 4.0.0.rc2)
+      activesupport (= 4.0.0.rc2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-nc (0.0.6)
+      rspec (~> 2.9)
+      terminal-notifier (~> 1.4.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.5)
+    sqlite3 (1.3.7)
+    terminal-notifier (1.4.2)
+    thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  guard-rspec
+  mocha (= 0.14.0)
+  rspec (~> 2.13.0)
+  rspec-nc
+  simplecov
+  tkellem!

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cli: '-f progress -f Nc', env: { 'NO_SIMPLECOV' => '1' } do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(tkellem/)?(.+)\.rb$})     { |m| "spec/#{m[2]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -2,6 +2,9 @@
 
 [![Build
 Status](https://travis-ci.org/codekitchen/tkellem.png)](https://travis-ci.org/codekitchen/tkellem)
+[![Code Climate](https://codeclimate.com/github/codekitchen/tkellem.png)](https://codeclimate.com/github/codekitchen/tkellem)
+[![Coverage Status](https://coveralls.io/repos/codekitchen/tkellem/badge.png)](https://coveralls.io/r/codekitchen/tkellem)
+
 
 tkellem is an IRC bouncer, a proxy that keeps you permanently logged on to an
 IRC server and stores all messages so that when your client next connects, you

data/lib/backwards_file_reader.rb

@@ -1,48 +1,40 @@
 class BackwardsFileReader
-  def self.scan(stream)
-    scanner = new(stream)
+  def self.scan(stream, *init_args)
+    scanner = new(stream, *init_args)
     while line = scanner.readline
       break unless yield(line)
     end
     scanner.sync
   end
 
-  def initialize(stream)
+  DEFAULT_READ_SIZE = 4096
+
+  def initialize(stream, read_size = DEFAULT_READ_SIZE)
     @stream = stream
     @stream.seek 0, IO::SEEK_END
     @pos = @stream.pos
-    @offset = 0
 
-    @read_size = [4096, @pos].min
+    @read_size = [read_size, @pos].min
     @line_buffer = []
   end
 
   def readline
-    if @line_buffer.size > 2 || @pos == 0
-      line = @line_buffer.pop
-      if line
-        @offset += line.length
-      end
-      return line
-    end
-
-    @read_size = [@read_size, @pos].min
-    @pos -= @read_size
-    @stream.seek(@pos, IO::SEEK_SET)
-    @offset = -@line_buffer.reduce(0) { |n,l| n + l.length }
+    while @line_buffer.size < 2 && @pos > 0
+      @read_size = [@read_size, @pos].min
+      @pos -= @read_size
+      @stream.seek(@pos, IO::SEEK_SET)
 
-    @line_buffer[0] = "#{@stream.read(@read_size)}#{@line_buffer[0]}"
-    @line_buffer[0] = @line_buffer[0].scan(%r{.*\n})
-    @line_buffer.flatten!
+      @line_buffer[0] = "#{@stream.read(@read_size)}#{@line_buffer[0]}"
+      @line_buffer[0] = @line_buffer[0].scan(%r{.*\n})
+      @line_buffer.flatten!
+    end
 
-    readline
+    @line_buffer.pop
   end
 
   def sync
-    if @offset > 0
-      @stream.seek(-@offset, IO::SEEK_CUR)
-    end
-    @offset = 0
+    offset = @read_size - @line_buffer.inject(0) { |n, l| n + l.size }
+    @stream.seek(-offset, IO::SEEK_CUR) if offset != 0
     @stream
   end
 end

data/lib/tkellem/bouncer.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'active_support/core_ext/class/attribute_accessors'
 
 require 'tkellem/irc_server'

data/lib/tkellem/bouncer_connection.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'active_support/core_ext/object/blank'
 
 require 'eventmachine'
@@ -91,6 +92,7 @@ module BouncerConnection
 
   def receive_line(line)
     failsafe("message: {#{line}}") do
+      line.force_encoding Encoding::UTF_8
       trace "from client: #{line}"
       return if line.blank?
       msg = IrcMessage.parse(line)

data/lib/tkellem/daemon.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'fileutils'
 require 'optparse'
 

data/lib/tkellem/irc_message.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Tkellem
 
 class IrcMessage < Struct.new(:prefix, :command, :args, :ctcp)
@@ -50,10 +51,6 @@ class IrcMessage < Struct.new(:prefix, :command, :args, :ctcp)
     self.ctcp == 'ACTION'
   end
 
-  def command?(cmd)
-    @command.downcase == cmd.downcase
-  end
-
   def replay
     line = []
     line << ":#{prefix}" unless prefix.nil?

data/lib/tkellem/irc_server.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'eventmachine'
 require 'set'
 require 'socket'
@@ -39,6 +40,7 @@ module IrcServerConnection
 
   def receive_line(line)
     @bouncer.failsafe(:receive_line) do
+      line.force_encoding Encoding::UTF_8
       @bouncer.trace "from server: #{line}"
       return if line.blank?
       msg = IrcMessage.parse(line)

data/lib/tkellem/plugins/backlog.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'backwards_file_reader'
 require 'fileutils'
 require 'pathname'
@@ -94,7 +95,7 @@ class Backlog
   end
 
   def get_stream(ctx, for_reading = false)
-    mode = for_reading ? 'rb' : 'ab'
+    mode = for_reading ? 'rb:utf-8' : 'ab:utf-8'
     ctx = ctx.gsub(%r{[\./\\]}, '')
     path = stream_path(ctx)
     return nil if !path.file? && for_reading

data/lib/tkellem/socket_server.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'eventmachine'
 
 require 'tkellem/tkellem_bot'

data/lib/tkellem/tkellem_bot.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'shellwords'
 require 'yaml'
 

data/lib/tkellem/tkellem_server.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'eventmachine'
 require 'active_record'
 require 'rails/observers/activerecord/active_record'

data/lib/tkellem/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Tkellem
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/spec/backwards_file_reader_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe BackwardsFileReader do
+  let :testfile do
+    Tempfile.new("tkellem-test").tap do |tf|
+      tf.write <<-LINES
+line1
+line2
+line3
+LINES
+      tf.rewind
+    end
+  end
+
+  describe '.scan' do
+    it "should read all lines" do
+      results = mock('lines')
+      results.expects(:got).with("line3\n")
+      results.expects(:got).with("line2\n")
+      results.expects(:got).with("line1\n")
+
+      BackwardsFileReader.scan(testfile) { |line| results.got(line); true }
+      testfile.pos.should == 0
+    end
+
+    it "should abort if the block returns false" do
+      results = mock('lines')
+      results.expects(:got).with("line3\n")
+      results.expects(:got).with("line2\n")
+      BackwardsFileReader.scan(testfile) do |line|
+        results.got(line)
+        line != "line2\n"
+      end
+      testfile.pos.should == 6
+    end
+  end
+
+  describe "#readline" do
+    it "should read correctly with a buffer size smaller than one line" do
+      reader = BackwardsFileReader.new(testfile, 2)
+      reader.readline.should == "line3\n"
+      reader.readline.should == "line2\n"
+      reader.readline.should == "line1\n"
+      reader.readline.should == nil
+    end
+
+    it "should read correctly with a buffer size larger than one line" do
+      reader = BackwardsFileReader.new(testfile, 6)
+      reader.readline.should == "line3\n"
+      reader.readline.should == "line2\n"
+      reader.readline.should == "line1\n"
+      reader.readline.should == nil
+    end
+  end
+
+  describe "#sync" do
+    it "should reset the stream position to the current line" do
+      reader = BackwardsFileReader.new(testfile)
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 6
+
+      reader = BackwardsFileReader.new(testfile)
+      reader.readline
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 12
+    end
+
+    it "should reset correctly with a buffer size smaller than one line" do
+      reader = BackwardsFileReader.new(testfile, 2)
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 6
+
+      reader = BackwardsFileReader.new(testfile, 2)
+      reader.readline
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 12
+    end
+
+    it "should reset correctly with a buffer size larger than one line" do
+      reader = BackwardsFileReader.new(testfile, 7)
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 6
+
+      reader = BackwardsFileReader.new(testfile, 7)
+      reader.readline
+      reader.readline
+      reader.sync.should == testfile
+      testfile.pos.should == testfile.size - 12
+    end
+  end
+
+  it "should support resuming" do
+    reader = BackwardsFileReader.new(testfile, 2)
+    reader.readline.should == "line3\n"
+    reader.sync
+    testfile.pos.should == testfile.size - 6
+    reader.readline.should == "line2\n"
+    reader.sync
+    testfile.pos.should == testfile.size - 12
+    reader.readline.should == "line1\n"
+    reader.sync
+    testfile.pos.should == 0
+  end
+end

data/spec/irc_message_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'tkellem/irc_message'
+require 'time'
 
 include Tkellem
 
@@ -41,12 +42,19 @@ end
 describe IrcMessage, "#with_timestamp" do
   it "should prefix a timestamp to the last arg" do
     line = IrcMessage.parse(":some_long_prefix COMMAND first second :long arg here")
-    require 'time'
     timestamp = Time.parse("Thu Nov 29 14:33:20 2001")
     ts_line = line.with_timestamp(timestamp)
     ts_line.should be_a(IrcMessage)
     ts_line.to_s.should == ":some_long_prefix COMMAND first second :2001-11-29 14:33:20> long arg here"
   end
+
+  it "should not prefix the date if the message is < 24 hours old" do
+    line = IrcMessage.parse(":some_long_prefix COMMAND first second :long arg here")
+    timestamp = 3.hours.ago
+    ts_line = line.with_timestamp(timestamp)
+    ts_line.should be_a(IrcMessage)
+    ts_line.to_s.should == ":some_long_prefix COMMAND first second :#{timestamp.strftime("%H:%M:%S")}> long arg here"
+  end
 end
 
 describe IrcMessage do
@@ -59,6 +67,22 @@ describe IrcMessage do
     line2.args.should == %w(one two three)
     line2.args.last.should == "three"
   end
+
+  describe ".parse_client_command" do
+    it "should return nil for non-client commands" do
+      IrcMessage.parse_client_command("PRIVMSG a :b c d").should == nil
+    end
+
+    it "should turn /msg into a PRIVMSG command" do
+      IrcMessage.parse_client_command("/msg brian hai there").should ==
+        IrcMessage.new(nil, "PRIVMSG", ["brian", "hai there"])
+    end
+
+    it "should treat other commands literally" do
+      IrcMessage.parse_client_command("/join #tkellem").should ==
+        IrcMessage.new(nil, "JOIN", ["#tkellem"])
+    end
+  end
 end
 
 describe IrcMessage, "CTCP" do

data/spec/spec_helper.rb

@@ -2,9 +2,19 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rspec'
-require 'simplecov'
-SimpleCov.start do
-  add_filter "/spec"
+require 'mocha/api'
+
+unless ENV['NO_SIMPLECOV']
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = if ENV['TRAVIS']
+    Coveralls::SimpleCov::Formatter
+  else
+    SimpleCov::Formatter::HTMLFormatter
+  end
+  SimpleCov.start do
+    add_filter "/spec"
+  end
 end
 
 require 'tkellem'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tkellem
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -83,9 +83,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -101,7 +104,6 @@ files:
 - debian/rules
 - debian/source/format
 - debian/tkellem.1
-- examples/config.yml
 - lib/backwards_file_reader.rb
 - lib/tkellem.rb
 - lib/tkellem/bouncer.rb
@@ -129,6 +131,7 @@ files:
 - lib/tkellem/version.rb
 - resources/bot_command_descriptions.yml
 - resources/setting_descriptions.yml
+- spec/backwards_file_reader_spec.rb
 - spec/bouncer_connection_spec.rb
 - spec/irc_message_spec.rb
 - spec/irc_server_spec.rb
@@ -148,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4403450271075957014
+      hash: -1609570308087987502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4403450271075957014
+      hash: -1609570308087987502
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -165,6 +168,7 @@ signing_key:
 specification_version: 3
 summary: IRC bouncer with multi-client support
 test_files:
+- spec/backwards_file_reader_spec.rb
 - spec/bouncer_connection_spec.rb
 - spec/irc_message_spec.rb
 - spec/irc_server_spec.rb

data/examples/config.yml

@@ -1,2 +0,0 @@
-#     this file is deprecated, settings are now stored in ~/.tkellem/tkellem.sqlite3
-#     more help to come