sieve-parser 0.0.1

data/lib/sieve-parser.rb

@@ -0,0 +1,5 @@
+module Sieve
+  %w(filterset filter action condition ).each do |entity|
+    require_relative "sieve-parser/#{entity}"
+  end
+end

data/lib/sieve-parser/action.rb

@@ -0,0 +1,70 @@
+# -*- coding: UTF-8 -*-
+
+module Sieve
+    
+  # This class contains the attributes of action 
+  class Action
+    attr_accessor :type, :copy, :target, :text
+
+    # Create Action object by text of action
+    #@param [string] text of action 
+    #@note Example:
+    #  fileinto :copy "INBOX.lixo"
+    #@return [Action] action object parsed
+    def initialize(text=nil)
+      @text = text
+      @type=nil
+      @copy=nil
+      @target=nil
+      parse unless @text.nil?
+    end
+
+    # Return a array of actions after parse the text
+    #@note Example:
+    #  fileinto "INBOX";
+    #  fileinto :copy "INBOX.lixo";
+    #  stop;
+    #@param [string] text of actions
+    #@return [Array(Action)] array of Actions
+    def self.parse_all(text)
+      lines = text.split("\n")
+      actions = []
+      lines.each do |line|
+        actions << self.new(line)
+      end
+      actions
+    end
+
+    # Return a text of action
+    #@return [string] text of action
+    def to_s
+      text =""
+      {'type'=>@type, 'copy'=>@copy, 'target'=>@target}.each do |name,item|
+        if ['target'].index(name)
+          text += "\"#{item}\" " unless item.nil?
+        else
+          text += "#{item} " unless item.nil?
+        end
+
+      end
+      text[text.length-1] = ";"
+      text
+    end
+
+    private
+    # Parse text actions to variables of object
+    #@note Example:
+    #  @text = %q{fileinto :copy "INBOX.lixo"};
+    def parse
+      [';', '"'].each{|d| @text.delete!(d)}
+      params = @text.split(" ")
+      @type = params[0]
+      if params[1]==":copy"
+        @copy = params[1]
+        @target = params[2]
+      else
+        @target = params[1]
+      end
+    end
+  end
+end

data/lib/sieve-parser/condition.rb

@@ -0,0 +1,80 @@
+# -*- coding: UTF-8 -*-
+
+module Sieve
+  # This class contains the attributes of conditions/tests 
+  class Condition
+    attr_accessor :test,:not,:arg1,:arg2,:type, :text
+
+    # Create Condition object by text of condition
+    #@note Example:
+    #  header :contains "Subject" "teste"
+    #@param [string] text of condition 
+    #@return [Condition] Condition object parsed
+    def initialize(text=nil)
+      @text = text
+      @test=nil
+      @not=nil
+      @arg1=nil
+      @arg2=nil
+      @type=nil
+      parse unless @text.nil?
+    end
+    # Return a array of conditions after parse the text
+    #@param [string] text of conditions
+    #@note Example:
+    #  header :contains "From" "all", header :contains "aaaaa" "333"
+    # the text of conditions are splited by ','
+    #@return [Array(Contition)] array of Condition
+    def self.parse_all(text)
+      contitions = []
+      text.scan(/([\s\w:]*\"\S+\"\s\"[\sa-zA-Z0-9,\.\-\@ÁÀÃÂÇÉÈÊÍÌÓÒÔÕÚÙÜÑáàãâçéèêíìóòôõúùüñ]*\")/).each do |item|
+        contitions << self.new(item[0])
+      end
+      contitions
+    end
+
+    # Return a text of action
+    #@return [string] text of action
+    def to_s
+      text =""
+      {"not"=>@not,'test'=>@test,'type'=>@type,'arg1'=>@arg1,'arg2'=>@arg2}.each do |name, item|
+        if ['arg1','arg2'].index(name)
+          text += "\"#{item}\" " unless item.nil?
+        else
+          text += "#{item} " unless item.nil?
+        end
+      end
+      text[text.length-1] = ""
+      text
+    end
+
+    private
+    # Parse text condition to variables of object
+    #@note Example:
+    # header :contains "From" "all"
+    def parse
+      if @text =~ /^true/
+        @test = "true"
+        return
+      end
+
+      res = @text.scan(/(([\s\w:]+)\"(\S+)\"\s\"([\sa-zA-Z0-9,\.\-\@ÁÀÃÂÇÉÈÊÍÌÓÒÔÕÚÙÜÑáàãâçéèêíìóòôõúùüñ]*)\"|true)/)
+
+      params = res[0][1].strip.split(" ")
+      params += [res[0][2]] + [res[0][3]]
+      
+      if params[0] == "not"
+        @not = params[0]
+        @test = params[1]
+        @type = params[2]
+        @arg1 = params[3]
+        @arg2 = params[4]
+      else
+        @test = params[0]
+        @type = params[1]
+        @arg1 = params[2]
+        @arg2 = params[3]
+      end
+    end
+  end
+end

data/lib/sieve-parser/filter.rb

@@ -0,0 +1,103 @@
+# -*- coding: UTF-8 -*-
+# This class implements a parse of sieve filter and returns a object
+# to manipulate
+# @author Thiago Coutinho<thiago @ osfeio.com>(selialkile)
+# @note This code folow de "THE BEER-WARE LICENSE"
+module Sieve
+  class Filter
+
+    #@note [join] can be: any, allof or anyof
+    attr_accessor :name, :type, :join, :text_filter
+
+    # Initialize the class
+    #@param [string] String of filter text
+    #@return [object] Object of self
+    def initialize(text_filter=nil)
+      @text_filter = text_filter
+      @conditions = []
+      @actions = []
+      parse unless @text_filter.nil?
+    end
+
+    # Return the conditions of filter
+    #@return [array] conditions
+    def conditions
+      @conditions
+    end
+
+    # Return the actions of filter
+    #@return [array] actions
+    def actions
+      @actions
+    end
+
+    # Return name of filter
+    # @return [string] name of filter
+    def name
+      @name
+    end
+
+    # Add object of Condition to filter
+    #@param [Sieve::Condition]
+    def add_condition(condition)
+      raise "the param is not a Condition" unless condition.class.to_s == "Sieve::Action"
+      @conditions << condition
+    end
+
+    # Return a text of filter
+    #@return [string] text of filter
+    def to_s
+      text = "# #{name}\n"
+      text += "#{@type}"
+      if conditions.count > 1
+        text += " #{@join} (" + conditions.join(", ") + ")"
+      else
+        text += " " + conditions[0].to_s
+      end
+      text += "\n{\n    "
+      text += actions.join("\n    ")
+      text += "\n}\n"
+    end
+
+    private
+    # Parse conditions, call the parse_common or parse_vacation
+    def parse
+      @text_filter[/vacation/].nil? ? parse_common : parse_vacation
+    end
+
+    private
+    # Parse the filter adding contitions and actions to class
+    def parse_common
+      #regex_rules_params = "(^#.*)\nif([\s\w\:\"\.\;\(\)\,\-]+)\{([\@\<>=a-zA-Z0-9\s\[\]\_\:\"\.\;\(\)\,\-\/]+)\}$"
+      #regex_rules_params2 = "(^#.*)\n(\S+)(.+)\n\{\n([\s\S]*)\}"
+      parts = @text_filter.scan(/(^#.*)\n(\S+)\s(.+)\n\{\n([\s\S]*)\}/)[0]
+      parse_name(parts[0])
+      @type = parts[1]
+      #if the join is true, dont have conditions...
+      if parts[2] =~ /true/
+        @conditions << Condition.new(type:"true")
+      elsif parts[2] =~ /(anyof|allof)/
+        @join = parts[2][/^\S+/]
+        @conditions.concat(Condition.parse_all( parts[2].scan(/\(([\S\s]+)\)/)[0][0] ))
+      else
+        @conditions << Condition.new(parts[2])
+      end
+
+      @actions.concat(Action.parse_all(parts[3]))
+    end
+
+    private
+    # Parse the vacation filter
+    def parse_vacation
+
+    end
+
+    def parse_name(text_name)
+      @name = text_name.match(/#(.*)/)[1].strip
+    end
+  end
+
+  class Vacation
+    attr_accessor :days, :subject, :content
+  end
+end

data/lib/sieve-parser/filterset.rb

@@ -0,0 +1,58 @@
+# -*- coding: UTF-8 -*-
+
+# This class implements a parse of sieve and returns a object
+# to manipulate
+# ONLY ACCEPTY THE "IF" conditions
+#@see http://www.faqs.org/rfcs/rfc3028.html
+#@see http://www.faqs.org/rfcs/rfc5804.html
+#@see http://www.faqs.org/rfcs/rfc5230.html
+#@see http://www.faqs.org/rfcs/rfc5229.html
+# @author Thiago Coutinho<thiago @ osfeio.com>(selialkile)
+# @author Thiago Coutinho<thiago.coutinho@locaweb.com.br>
+# @note This code folow de "THE BEER-WARE LICENSE"
+
+module Sieve
+  class FilterSet
+    attr_accessor :text_sieve
+    
+    def initialize(text_sieve=nil)
+      @text_sieve = text_sieve
+      @requires = []
+      @filters = []
+      parse unless @text_sieve.nil?
+    end
+
+    # Return all filters of script.
+    #@return [array] array of filters
+    def filters
+      @filters
+    end
+
+    # Requires inside the script
+    #@return [array] names of requires
+    def requires
+      @requires
+    end
+
+    # Return a text of filterset
+    #@return [string] text of filterset
+    def to_s
+      text = "require [\"#{requires.join('","')}\"];\n"
+      text += filters.join("")
+    end
+
+    private
+    # Make de parse and put results in variables
+    def parse
+      #return a array with string of elements: "xxxx", "yyyyyy"
+      @text_sieve.scan(/^require\s\["(\S+)"\];$/).each do |r| 
+        @requires.concat(r[0].split('","'))
+      end
+
+      @text_sieve.scan(/(^#.*\nif[\s\w\:\"\.\;\(\)\,\-]*\n\{[a-zA-Z0-9\s\@\<>=\:\[\]\_\"\.\;\(\)\,\-\/]*\n\}$)/).each do |f| 
+        @filters << Sieve::Filter.new(f[0])
+      end
+
+    end
+  end
+end

data/sieve-parser.gemspec

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'sieve-parser'
+  s.version = '0.0.1'
+  s.summary = 'A Ruby library for sieve parser'
+  s.description = <<-EOF
+    sieve-parser is a pure-ruby implementation for parsing and 
+    manipulate the sieve scripts.
+  EOF
+  s.requirements << 'A sieve script to parse and gem ruby-managesieve to connect on server.'
+  s.files = [
+            'lib/sieve-parser',
+            'lib/sieve-parser/action.rb',
+            'lib/sieve-parser/condition.rb',
+            'lib/sieve-parser/filter.rb',
+            'lib/sieve-parser/filterset.rb',
+            'lib/sieve-parser.rb',
+            'sieve-parser.gemspec'
+            ]
+
+  s.has_rdoc = true
+  s.author = 'Thiago Coutinho'
+  s.email = 'thiago.coutinho@locaweb.com.br'
+  s.rubyforge_project = 'sieve-parser'
+  s.homepage = "http://github.com/selialkile/sieve-parser"
+end
+
+if __FILE__ == $0
+  Gem::Builder.new(spec).build
+else
+  spec
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: sieve-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thiago Coutinho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-25 00:00:00.000000000Z
+dependencies: []
+description: ! "    sieve-parser is a pure-ruby implementation for parsing and \n
+  \   manipulate the sieve scripts.\n"
+email: thiago.coutinho@locaweb.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sieve-parser/action.rb
+- lib/sieve-parser/condition.rb
+- lib/sieve-parser/filter.rb
+- lib/sieve-parser/filterset.rb
+- lib/sieve-parser.rb
+- sieve-parser.gemspec
+homepage: http://github.com/selialkile/sieve-parser
+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:
+- A sieve script to parse and gem ruby-managesieve to connect on server.
+rubyforge_project: sieve-parser
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Ruby library for sieve parser
+test_files: []
+has_rdoc: true