ircp 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ircp.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 mashiro
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,32 @@
+# Ircp
+
+Ircp is a IRC parser for ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ircp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ircp
+
+## Usage
+
+```ruby
+require 'ircp'
+msg = Ircp.parse 'PRIVMSG ircp :hello ircp!'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/ircp.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ircp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["mashiro"]
+  gem.email         = ["mail@mashiro.org"]
+  gem.description   = %q{irc parser}
+  gem.summary       = %q{irc parser for ruby}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ircp"
+  gem.require_paths = ["lib"]
+  gem.version       = Ircp::VERSION
+
+  gem.add_dependency 'treetop'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/lib/ircp/message.rb

@@ -0,0 +1,15 @@
+require 'ircp/prefix'
+
+module Ircp
+  class Message
+    attr_accessor :raw, :prefix, :command, :params
+
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      @raw = options[:raw]
+      @prefix = options[:prefix].is_a?(Hash) ? Prefix.new(options[:prefix]) : nil
+      @command = options[:command]
+      @params = args
+    end
+  end
+end

data/lib/ircp/parser/message.treetop

@@ -0,0 +1,74 @@
+# vim: ts=2 sw=2 et
+# -*- coding: ascii-8bit -*-
+require 'ircp/parser/message_node_classes'
+
+module Ircp
+  module Parser
+    # RFC1459 based
+    grammar Message
+      rule message
+        prefix:( ':' v:prefix space )? command params:params? crlf? <MessageNode>
+      end
+
+      rule prefix
+        '' servername &space <ShortPrefixNode> /
+        nick user:( '!' v:user )? host:( '@' v:host )? <LongPrefixNode>
+      end
+
+      rule command
+        letter+ <CommandNode> /
+        number 3..3 <NumericReplyNode>
+      end
+
+      rule params
+        middles:( space v:middle )* trailing:( space ':' v:trailing )? <ParamsNode>
+      end
+
+      rule middle
+        [^ :] [^ ]*
+      end
+
+      rule trailing
+        .*
+      end
+
+
+      rule space
+        [ ]+
+      end
+
+      rule nospace
+        [^ ]
+      end
+
+      rule crlf
+        [\x0D\x0A]
+      end
+
+      rule letter
+        [a-zA-Z]
+      end
+
+      rule number
+        [0-9]
+      end
+
+
+      rule servername
+        '' host <ServerNameNode>
+      end
+
+      rule host
+        [^ !@]+ <HostNode>
+      end
+
+      rule nick
+        [^ !@]+ <NickNode>
+      end
+
+      rule user
+        [^ !@]+ <UserNode>
+      end
+    end
+  end
+end

data/lib/ircp/parser/message_node_classes.rb

@@ -0,0 +1,98 @@
+module Ircp
+  module Parser
+    class MessageNode < Treetop::Runtime::SyntaxNode
+      def eval(env = {})
+        env[:raw] = text_value
+        prefix.v.eval (env[:prefix] ||= {}) unless prefix.empty?
+        command.eval env
+        params.eval env unless params.empty?
+        env
+      end
+    end
+
+    class ShortPrefixNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:raw] = text_value
+        servername.eval env
+        env
+      end
+    end
+
+    class LongPrefixNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:raw] = text_value
+        nick.eval env
+        user.v.eval env unless user.empty?
+        host.v.eval env unless host.empty?
+        env
+      end
+    end
+
+    class NumericReplyNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:command] = text_value
+        env[:numeric_reply] = text_value.to_i
+        env
+      end
+    end
+
+    class CommandWithParamsNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        command.eval env
+        params.eval env unless params.empty?
+        env
+      end
+    end
+
+    class CommandNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:command] = text_value
+        env
+      end
+    end
+
+    class ParamsNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:options] = env[:params] = [middle_values, trailing_value].flatten.compact
+        env
+      end
+
+      def middle_values
+        middles.elements.map { |e| e.v.text_value }
+      end
+
+      def trailing_value
+        trailing.v.text_value unless trailing.empty?
+      end
+    end
+
+    class ServerNameNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:servername] = text_value
+        host.eval env
+        env
+      end
+    end
+
+    class HostNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:host] = text_value
+        env
+      end
+    end
+
+    class NickNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:nick] = text_value
+        env
+      end
+    end
+
+    class UserNode < Treetop::Runtime::SyntaxNode
+      def eval(env)
+        env[:user] = text_value
+        env
+      end
+    end
+  end
+end

data/lib/ircp/parser.rb

@@ -0,0 +1,2 @@
+require 'treetop'
+require 'ircp/parser/message'

data/lib/ircp/prefix.rb

@@ -0,0 +1,13 @@
+module Ircp
+  class Prefix
+    attr_accessor :raw, :servername, :nick, :user, :host
+
+    def initialize(options = {})
+      @raw = options[:raw]
+      @servername = options[:servername]
+      @nick = options[:nick]
+      @user = options[:user]
+      @host = options[:host]
+    end
+  end
+end

data/lib/ircp/version.rb

@@ -0,0 +1,3 @@
+module Ircp
+  VERSION = "0.0.1"
+end

data/lib/ircp.rb

@@ -0,0 +1,21 @@
+require 'ircp/version'
+require 'ircp/parser'
+require 'ircp/message'
+
+module Ircp
+  class ParseError < StandardError
+  end
+
+  def self.message_parser
+    @message_parser ||= Ircp::Parser::MessageParser.new
+  end
+
+  def self.parse(text)
+    node = message_parser.parse(text)
+    raise ParseError.new(message_parser.failure_reason) if node.nil?
+
+    env = node.eval
+    params = env.delete(:params)
+    Message.new *params, env
+  end
+end

data/spec/ircp/parser_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+shared_context 'parse text' do |text|
+  before { @result = Ircp.parse(text) }
+  subject { @result }
+  let(:result) { @result }
+end
+
+shared_examples_for 'prefix for' do |options|
+  subject { result.prefix }
+  if options.nil?
+    it { should be_nil }
+  else
+    options.each do |key, value|
+      its(key) { should eq value }
+    end
+  end
+end
+
+shared_examples_for 'params for' do |*args|
+  subject { result.params }
+  args.each.with_index do |arg, index|
+    its([index]) { should eq arg }
+  end
+end
+
+describe Ircp::Parser do
+  describe '#parse' do
+    context 'PASS secretpasswordhere' do
+      include_context 'parse text', description
+      its(:command) { should eq 'PASS' }
+      it_should_behave_like 'prefix for', nil
+      it_should_behave_like 'params for', 'secretpasswordhere'
+    end
+
+    context ':testnick USER guest tolmoon tolsun :Ronnie Reagan' do
+      include_context 'parse text', description
+      its(:command) { should eq 'USER' }
+      it_should_behave_like 'prefix for', :servername => 'testnick'
+      it_should_behave_like 'params for', 'guest', 'tolmoon', 'tolsun', 'Ronnie Reagan'
+    end
+
+    context 'JOIN #foo,#bar fubar,foobar' do
+      include_context 'parse text', description
+      its(:command) { should eq 'JOIN' }
+      it_should_behave_like 'prefix for', nil
+      it_should_behave_like 'params for', '#foo,#bar', 'fubar,foobar'
+    end
+
+    context 'MODE &oulu +b *!*@*.edu' do
+      include_context 'parse text', description
+      its(:command) { should eq 'MODE' }
+      it_should_behave_like 'prefix for', nil
+      it_should_behave_like 'params for', '&oulu', '+b', '*!*@*.edu'
+    end
+
+    context ':Angel PRIVMSG Wiz :Hello are you receiving this message ?' do
+      include_context 'parse text', description
+      its(:command) { should eq 'PRIVMSG' }
+      it_should_behave_like 'prefix for', :servername => 'Angel'
+      it_should_behave_like 'params for', 'Wiz', 'Hello are you receiving this message ?'
+    end
+
+    context 'PRIVMSG #*.edu :NSFNet is undergoing work, expect interruptions' do
+      include_context 'parse text', description
+      its(:command) { should eq 'PRIVMSG' }
+      it_should_behave_like 'prefix for', nil
+      it_should_behave_like 'params for', '#*.edu', 'NSFNet is undergoing work, expect interruptions'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ircp'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ircp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- mashiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: &18199220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18199220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &18198800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18198800
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18198380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18198380
+description: irc parser
+email:
+- mail@mashiro.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ircp.gemspec
+- lib/ircp.rb
+- lib/ircp/message.rb
+- lib/ircp/parser.rb
+- lib/ircp/parser/message.treetop
+- lib/ircp/parser/message_node_classes.rb
+- lib/ircp/prefix.rb
+- lib/ircp/version.rb
+- spec/ircp/parser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: irc parser for ruby
+test_files: []