wcc 2.0.2 → 2.0.3

data/assets/conf.yml

@@ -6,6 +6,7 @@ conf:
 #  tag: wcc
 #  filterd: ./filter.d
 #  templated: ./template.d
+#  # default config assuming local mail server
 #  email:
 #    smtp:
 #      from: root@localhost
@@ -47,8 +48,6 @@ sites:
     # These filters will be executed and every single one has to
     # return 'true' for the user to be notified
     filters:
-      - test
-      - arg-test: {number: 5, hello: world}
       - only_changes_of: {at_least: 4, t: lines}
       # Regex filter that performs matching against <scope> (one of full or diff)
       - matches: {regex: '(normal|regex)[!]+', flags: i, scope: diff}

data/assets/filter.d/changes_of.rb

@@ -1,5 +1,6 @@
 
 WCC::Filters.add 'changes_of' do |data,args|
+	next true if data.diff.nil?
 	case args['t'] || args['type']
 	when 'line','lines',nil
 		cmp_val = data.diff.nlinesc

data/assets/filter.d/matches.rb

@@ -18,7 +18,7 @@ WCC::Filters.add 'matches' do |data,args|
 	end
 	case args['scope']
 	when 'diff','change',nil
-		md = r.match(data.diff.to_s)
+		md = data.diff.nil? ? nil : r.match(data.diff.to_s)
 	when 'site','full'
 		md = r.match(data.site.content)
 	end

data/assets/filter.d/rel_changes_of.rb

@@ -1,8 +1,9 @@
 
 # NOTE: the percentage may easily go above 100% when there are more
-#       changes than the whole site has lines.
+#       changes than the whole site had lines before.
 
 WCC::Filters.add 'rel_changes_of' do |data,args|
+	next true if data.diffnil?
 	case args['percent_of']
 	when 'all_lines',nil
 		percent = data.diff.nlinesc.to_f / data.site.content.count("\n").+(1).to_f * 100

data/lib/wcc.rb

@@ -129,29 +129,57 @@ module WCC
 			
 			if !File.exists?(self[:conf])
 				WCC.logger.fatal "Config file '#{self[:conf]}' does not exist!"
-				exit 1
+				Prog.exit 1
 			end
 			
+			# register standard notificators - these are already loaded
+			Notificators.map 'email', MailNotificator
+			Notificators.map 'jabber', XMPPNotificator
+			Notificators.map 'syslog', SyslogNotificator
+			
 			WCC.logger.debug "Load config from '#{self[:conf]}'"
 			
 			# may be false if file is empty
 			yaml = YAML.load_file(self[:conf])
-			if yaml.is_a?(Hash) and (yaml = yaml['conf']).is_a?(Hash)
-				@options[:cache_dir] ||= yaml['cache_dir']
-				@options[:tag] ||= yaml['tag']
-				@options[:filter_dir] ||= yaml['filterd']
-				@options[:template_dir] ||= yaml['templated']
+			if yaml.is_a?(Hash) and yaml['conf'].is_a?(Hash)
+				
+				# load MailNotificator and it's defaults even if the key is missing
+				# since email has always been the backbone of wcc
+				if not yaml['conf'].key?('email')
+					yaml['conf']['email'] = nil
+				end
 				
-				MailNotificator.parse_conf(yaml['email']).each { |k,v| @options[k] ||= v }
-				XMPPNotificator.parse_conf(yaml['jabber']).each { |k,v| @options[k] ||= v }
-				SyslogNotificator.parse_conf(yaml['syslog']).each { |k,v| @options[k] ||= v }
+				yaml['conf'].each do |key,val|
+					case key
+					when 'cache_dir'
+						@options[:cache_dir] ||= val
+					when 'tag'
+						@options[:tag] ||= val
+					when 'filterd'
+						@options[:filter_dir] ||= val
+					when 'templated'
+						@options[:template_dir] ||= val
+					else
+						if not Notificators.mappings.include?(key)
+							plugin_name = "wcc-#{key}-notificator"
+							WCC.logger.info "Trying to load plugin #{plugin_name}..."
+							begin
+								require plugin_name
+							rescue LoadError
+								WCC.logger.error "Plugin #{plugin_name} not found - maybe try `gem install #{plugin_name}`"
+								next
+							end
+						end
+						Notificators.mappings[key].parse_conf(val).each { |k,v| @options[k] ||= v }
+					end
+				end
 			end
 			
 			if self[:show_config]
 				Conf.default.merge(@options).each do |k,v|
 					puts "  #{k.to_s} => #{self[k]}"
 				end
-				exit 0
+				Prog.exit 0
 			end
 			
 			@recipients = {}
@@ -167,10 +195,20 @@ module WCC
 					yaml_rec[name].to_a.each do |yaml_way|
 						# TODO: find options and pass them to every notificator
 						if yaml_way.is_a?(Hash)
-							rec << XMPPNotificator.new(yaml_way['jabber']) if yaml_way.key?('jabber')
-							rec << MailNotificator.new(yaml_way['email']) if yaml_way.key?('email')
-						elsif yaml_way == 'syslog'
-							rec << SyslogNotificator.new
+							prim_key = yaml_way.keys.first # and only!
+							klass = Notificators.mappings[prim_key]
+							if klass.nil?
+								WCC.logger.error "Referenced notificator '#{prim_key}' not found!"
+							else
+								rec << klass.new(yaml_way[prim_key])
+							end
+						else
+							klass = Notificators.mappings[yaml_way]
+							if klass.nil?
+								WCC.logger.error "Referenced notificator '#{yaml_way}' not found!"
+							else
+								rec << klass.new
+							end
 						end
 					end
 					@recipients[name] = rec
@@ -214,7 +252,6 @@ module WCC
 					cookie = File.open(yaml_site['cookie'], 'r') { |f| f.read }
 				end
 				
-
 				@sites << Site.new(
 					yaml_site['url'], 
 					yaml_site['strip_html'] || true,
@@ -222,7 +259,8 @@ module WCC
 					frefs,
 					yaml_site['auth'] || {},
 					cookie,
-					yaml_site['check_interval'] || 5)
+					yaml_site['check_interval'] || 5
+				)
 			end
 			
 			WCC.logger.debug @sites.length.to_s + (@sites.length == 1 ? ' site' : ' sites') + " loaded\n" +
@@ -239,6 +277,20 @@ module WCC
 		def self.simulate?; self[:simulate] end
 		def self.[](key); Conf.instance[key] end
 	end
+	
+	class Notificators
+		@@mappings = {}
+		
+		# API method - add a mapping from conf string to class object
+		# @param [String] name the string to be used in conf.yml's conf entry
+		# @param [Class] klass the associated notifier class
+		def self.map(name, klass)
+			WCC.logger.debug "Register notificator #{klass.inspect} for #{name}"
+			@@mappings[name] = klass
+		end
+		
+		def self.mappings; @@mappings end
+	end
 
 	class LogFormatter
 		def initialize(use_color = true)
@@ -362,11 +414,14 @@ module WCC
 			Dir.mkdir(Conf[:cache_dir]) unless File.directory?(Conf[:cache_dir])
 			
 			if(Conf[:clean])
-				WCC.logger.warn "Cleanup hash and diff files"
+				WCC.logger.warn "Removing hash and diff files..."
 				Dir.foreach(Conf[:cache_dir]) do |f|
 					File.delete(Conf.file(f)) if f =~ /^.*\.(md5|site)$/
 				end
-				# TODO: delete timestamps on clean?
+				cache_file = Conf.file('cache.yml')
+				WCC.logger.warn "Removing timestamp cache..."
+				File.delete(cache_file) if File.exists?(cache_file)
+				Prog.exit 1
 			end
 			
 			# read filter.d
@@ -409,16 +464,24 @@ module WCC
 			File.open(cache_file, 'w+') do |f| YAML.dump({"timestamps" => @@timestamps}, f) end
 			
 			# shut down notificators
-			MailNotificator.shut_down
-			XMPPNotificator.shut_down
-			SyslogNotificator.shut_down
+			Notificators.mappings.each do |name,klass|
+				WCC.logger.debug "Shut down #{klass}"
+				klass.shut_down
+			end
 		end
 		
 		def self.load_template(name)
 			t_path = File.join(Conf[:template_dir], name)
-			t = File.open(t_path, 'r') { |f| f.read }
-			# <> omit newline for lines starting with <% and ending in %>
-			ERB.new(t, 0, "<>")
+			if File.exists?(t_path)
+				t = File.open(t_path, 'r') { |f| f.read }
+				# <> omit newline for lines starting with <% and ending in %>
+				return ERB.new(t, 0, "<>")
+			end
+			nil
+		end
+		
+		def self.exit(errno)
+			Kernel::exit errno
 		end
 		
 		private

data/lib/wcc/diff.rb

@@ -112,7 +112,7 @@ module WCC
 			md = s.match(/(@|_)di(@|_)/)
 			while not md.nil?
 				mds << md
-				s = s.substring(md.begin(2)+1)
+				s = s.substring(md.begin(2))
 				md = s.match(/(@|_)di(@|_)/)
 			end
 			

data/lib/wcc/mail.rb

@@ -91,6 +91,7 @@ module WCC
 				end
 			end
 			# default is smtp
+			WCC.logger.debug "Using default SMTP configuration for MailNotificator"
 			return {
 				:mailer => 'smtp',
 				:from_mail => MailAddress.new("#{Etc.getlogin}@localhost"),

data/lib/wcc/version.rb

@@ -1,4 +1,4 @@
 
 module WCC
-	VERSION = "2.0.2"
+	VERSION = "2.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wcc
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 2
   - 0
-  - 2
-  version: 2.0.2
+  - 3
+  version: 2.0.3
 platform: ruby
 authors: 
 - Christian Nicolai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2011-11-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities
@@ -75,13 +75,11 @@ extra_rdoc_files:
 files: 
 - assets/conf.yml
 - assets/filter.d/and.rb
-- assets/filter.d/arg-test.rb
 - assets/filter.d/changes_of.rb
 - assets/filter.d/matches.rb
 - assets/filter.d/not.rb
 - assets/filter.d/or.rb
 - assets/filter.d/rel_changes_of.rb
-- assets/filter.d/test.rb
 - assets/template.d/mail.alt.erb
 - assets/template.d/mail-body.html.erb
 - assets/template.d/mail-body.plain.erb
@@ -104,7 +102,7 @@ files:
 homepage: https://github.com/cmur2/wcc
 licenses: 
 - Apache License Version 2.0
-post_install_message: "NOTE: Remember to \xC2\xB4wcc-upgrade\xC2\xB4 your conf.yml directory!"
+post_install_message: "NOTE: Remember to `wcc-upgrade` your conf.yml directory!"
 rdoc_options: []
 
 require_paths: 

data/assets/filter.d/arg-test.rb

@@ -1,9 +0,0 @@
-
-WCC::Filters.add 'arg-test' do |data,args|
-	puts "arg-test:"
-	puts "  #arguments = #{args.size}"
-	args.each do |arg|
-		puts "  - #{arg.inspect}"
-	end
-	true
-end

data/assets/filter.d/test.rb

@@ -1,4 +0,0 @@
-
-WCC::Filters.add 'test' do |data|
-	true
-end