wcc 1.2.0 → 1.3.0

data/README.md

@@ -27,13 +27,13 @@ and then
 
 	wcc-init
 
-At this time you should run the ´wcc´ command only in this directory since wcc reads it's
+At this time you should run the `wcc` command only in this directory since wcc reads it's
 configuration by default from './conf.yml'.
 
 Usage
 -----
 
-The installed 'wcc' gem provides a ´wcc´ binary on the command line.
+The installed 'wcc' gem provides a `wcc` binary on the command line.
 It can invoked by hand or automatically via *cron* on a server environment.
 
 For using wcc you need to specify some options:
@@ -71,7 +71,7 @@ Then don't forget to run
 
 in your '/my/conf' directory which interactively asks to overwrite local 'assets'
 like mail templates and filters with the original ones out of the gem (which you copied
-there using ´wcc-init´ at the beginning).
+there using `wcc-init` at the beginning).
 
 NOTE: You should **make a backup** (especially of your **conf.yml**) of the '/my/conf'
 directory **before upgrading**.

data/assets/conf.yml

@@ -25,6 +25,8 @@ sites:
       - 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}
       # readable, isn't it?
   - url: https://my.secret.place/
     emails:

data/assets/filter.d/and.rb

@@ -0,0 +1,11 @@
+
+WCC::Filters.add 'and' do |data,args|
+	ret = true
+	args.each do |id,inner_args|
+		if not WCC::Filters.call(data, id, inner_args)
+			# short circuit
+			ret = false; break
+		end
+	end
+	ret
+end

data/assets/filter.d/changes_of.rb

@@ -12,6 +12,7 @@ WCC::Filters.add 'changes_of' do |data,args|
 	when 'hunk','hunks'
 		cmp_val = data.diff.nhunks
 	end
+	WCC::Filters.debug "changes_of #{cmp_val} #{args['t'] || args['type']}"
 	next (cmp_val >= args['at_least']) if args.key?('at_least')
 	next (cmp_val >  args['more_than']) if args.key?('more_than')
 	next (cmp_val <= args['at_most']) if args.key?('at_most')

data/assets/filter.d/matches.rb

@@ -0,0 +1,27 @@
+
+WCC::Filters.add 'matches' do |data,args|
+	WCC::Filters.debug "regex: #{args['regex']}"
+	# args['flags'] is assumed to be a string that might be empty or
+	# contains any of the characters 'i','e','m' in any order.
+	ropts = []
+	if not args['flags'].nil?
+		WCC::Filters.debug "flags: #{args['flags']}"
+		ropts << Regexp::IGNORECASE if args['options'].include?('i')
+		ropts << Regexp::EXTENDED if args['options'].include?('e')
+		ropts << Regexp::MULTILINE if args['options'].include?('m')
+	end
+	WCC::Filters.debug "ropts: #{ropts.inspect}"
+	if ropts.empty?
+		r = Regexp.new(args['regex'])
+	else
+		r = Regexp.new(args['regex'], ropts.inject {|acc,x| acc |= x})
+	end
+	case args['scope']
+	when 'diff','change',nil
+		md = r.match(data.diff.to_s)
+	when 'site','full'
+		md = r.match(data.site.content)
+	end
+	WCC::Filters.debug "match: #{md.inspect}"
+	(not md.nil?)
+end

data/assets/filter.d/not.rb

@@ -0,0 +1,5 @@
+
+WCC::Filters.add 'not' do |data,args|
+	id = args.keys.first
+	(not WCC::Filters.call(data, id, args[id]))
+end

data/assets/filter.d/or.rb

@@ -0,0 +1,11 @@
+
+WCC::Filters.add 'or' do |data,args|
+	ret = false
+	args.each do |id,inner_args|
+		if WCC::Filters.call(data, id, inner_args)
+			# short circuit
+			ret = true; break
+		end
+	end
+	ret
+end

data/assets/filter.d/rel_changes_of.rb

@@ -6,11 +6,13 @@ WCC::Filters.add 'rel_changes_of' do |data,args|
 	case args['percent_of']
 	when 'all_lines',nil
 		percent = data.diff.nlinesc.to_f / data.site.content.count("\n").+(1).to_f * 100
+	# TODO: extend rel_changes_of filter
 #	when 'all_chars','all_characters'
 #		percent = ...
 #	when 'nonblank_lines'
 #		percent = ...
 	end
+	WCC::Filters.debug "rel_changes_of #{percent} of #{args['percent_of']}"
 	next (percent >= args['at_least']) if args.key?('at_least')
 	next (percent >  args['more_than']) if args.key?('more_than')
 	next (percent <= args['at_most']) if args.key?('at_most')

data/assets/template.d/mail-body.html.erb

@@ -78,11 +78,11 @@
 <% elsif o.status == :range %>
 				<li class="range">@@<%= o.text %></li>
 <% elsif o.status == :ins %>
-				<li class="ins">+<%= o.html_hilite_text('x') %></li>
+				<li class="ins">+&nbsp;<%= o.html_hilite_text('x').lstrip %></li>
 <% elsif o.status == :del %>
-				<li class="del">-<%= o.html_hilite_text('x') %></li>
+				<li class="del">-&nbsp;<%= o.html_hilite_text('x').lstrip %></li>
 <% else %>
-				<li class="other"><%= o.text == ' ' ? '&nbsp;' : o.text %></li>
+				<li class="other">&nbsp;&nbsp;<%= o.text.substring(1).lstrip %></li>
 <% end %>
 <% end %>
 			</ul>

data/lib/wcc/diff.rb

@@ -1,6 +1,5 @@
 
 module WCC
-	# TODO: Handle tabs/trailing whitespace in output
 
 	class DiffItem
 		attr_reader :status, :text
@@ -19,10 +18,10 @@ module WCC
 				@text = line.substring(2)
 			elsif line.start_with?('+')
 				@status = :ins
-				@text = line.substring(1).rstrip
+				@text = line.substring(1)
 			elsif line.start_with?('-')
 				@status = :del
-				@text = line.substring(1).rstrip
+				@text = line.substring(1)
 			else
 				@status = :other
 				@text = line.rstrip
@@ -92,7 +91,7 @@ module WCC
 			when :del
 				'-'+text
 			when :other
-				text
+				' '+text
 			end
 		end
 	end

data/lib/wcc/filter.rb

@@ -14,11 +14,49 @@ module WCC
 	class Filters
 		@@filters = {}
 		
+		# API method - register a filters code block under given ID.
+		# Should be called by filters the following way:
+		#
+		#   WCC::Filters.add 'filter-name' { block }
+		#
+		# @param [String] id the "name" of the filter
+		# @param [Proc] block a block of code returning true (Accept)
+		#                     or false (Decline) as the filters result
 		def self.add(id, &block)
 			WCC.logger.info "Adding filter '#{id}'"
 			@@filters[id] = block
 		end
 		
+		# API method - invoke the specfied filter and give it's result.
+		#
+		# @param [Object] data arbitrary data the filter might use
+		# @param [String] id the "name" of the filter
+		# @param [Hash] args the arguments of the filter
+		# @return [Boolean] true if filter returned true, false otherwise
+		def self.call(data, id, args = {})
+			block = @@filters[id]
+			if block.nil?
+				raise "Call to requested filter '#{id}' failed - filter not found!"
+			end
+			block.call(data, args)
+		end
+
+		# API method  - log msg as error
+		def self.error(msg); WCC.logger.error "filter: #{msg}" end
+		# API method  - log msg as warn
+		def self.warn(msg); WCC.logger.warn "filter: #{msg}" end
+		# API method  - log msg as info
+		def self.info(msg); WCC.logger.info "filter: #{msg}" end
+		# API method  - log msg as debug
+		def self.debug(msg); WCC.logger.debug "filter: #{msg}" end
+		
+		# Called by wcc check routine to evaluate all filters
+		# and produce and'ed result of their boolean returns.
+		#
+		# @param [Object] data arbitrary data the filters might use
+		# @param [Array] filters list of FilterRefs with the IDs of the
+		#                        filters to be executed
+		# @return [Boolean] true if all filters returned true, false otherwise
 		def self.accept(data, filters)
 			return true if filters.nil?
 			

data/lib/wcc.rb

@@ -45,7 +45,7 @@ end
 
 module WCC
 
-	VERSION = "1.2.0"
+	VERSION = "1.3.0"
 
 	DIFF_TIME_FMT = '%Y-%m-%d %H:%M:%S %Z'
 	

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wcc
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Christian Nicolai
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-12 00:00:00 Z
+date: 2011-10-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: htmlentities
@@ -58,8 +58,12 @@ extra_rdoc_files:
 - README.md
 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