fxcop 0.0.4

data/lib/fxcop.rb

@@ -0,0 +1,135 @@
+module BuildQuality
+	class FxCop
+		def initialize(shell_command = ShellCommand.new, parameters)	
+			parameters[:fxcop_binary]
+			fxcop_binary = parameters[:fxcop_binary]
+			@fxcop_command = FxCopCommand.new(fxcop_binary,shell_command)	
+			@fxcop_settings_adapter = FxCopSettingsAdapterFactory.new(@fxcop_command).create
+		end
+
+		def start(fxcop_settings = FxCopSettings.new)	
+			@fxcop_settings_adapter.adapt(fxcop_settings)							
+			@fxcop_command.execute
+		end		
+	end
+
+	class FxCopSettings
+		attr_reader :assemblies, :output_file_name, :dictionary_file_name, :ruleset_file_name, :culture
+
+		def initialize(parameters = {})
+			@assemblies = parameters[:assemblies] || []
+			@output_file_name = parameters[:output_file_name]
+			@dictionary_file_name = parameters[:dictionary_file_name]
+			@ruleset_file_name = parameters[:ruleset_file_name]
+			@culture = parameters[:culture]
+		end
+	end
+
+	class FxCopSettingsAdapterFactory
+		def initialize(fxcop_command)
+			@fxcop_command = fxcop_command
+		end
+
+		def create
+			culture_adapter = CultureAdapter.new(@fxcop_command)
+			ruleset_file_name_adapter =  RulesetFileNameAdapter.new(@fxcop_command,culture_adapter)
+			dictionary_file_name_adapter = DictionaryFileNameAdapter.new(@fxcop_command,ruleset_file_name_adapter)		
+			assemblies_adapter = AssembliesAdapter.new(@fxcop_command, dictionary_file_name_adapter)
+			OutputFileNameAdapter.new(@fxcop_command, assemblies_adapter)
+		end
+	end
+
+	class FxCopCommand		
+		def initialize(fxcop_binary,shell_command)
+			@fxcop_binary = fxcop_binary
+			@shell_command = shell_command
+			@arguments = []
+		end
+
+		def execute					
+			fxcop_command = "#{@fxcop_binary}" << @arguments.join			
+			@shell_command.execute(fxcop_command)
+		end			
+
+		def add_argument(argument)			
+			@arguments.push(argument)
+		end
+	end
+
+	class OutputFileNameAdapter		
+		OUTPUT_SWITCH = "/o:"
+		def initialize(fxcop_command, next_adapter)			
+			@fxcop_command = fxcop_command
+			@next_adapter = next_adapter
+		end
+
+		def adapt(fxcop_settings)
+			output_file_name = fxcop_settings.output_file_name
+			output_argument = " #{OUTPUT_SWITCH}#{output_file_name}" unless output_file_name.nil?
+			@fxcop_command.add_argument(output_argument)
+			@next_adapter.adapt(fxcop_settings)
+		end
+	end
+
+	class CultureAdapter
+		CULTURE_SWITCH = ' /cul:'
+		def initialize(fxcop_command)
+			@fxcop_command = fxcop_command
+		end
+
+		def adapt(fxcop_settings)
+			culture = fxcop_settings.culture
+			@fxcop_command.add_argument("#{CULTURE_SWITCH}#{culture}") unless fxcop_settings.culture.nil?
+		end
+	end
+
+	class RulesetFileNameAdapter
+		RULESET_SWITCH = " /rs:="
+		def initialize(fxcop_command, next_adapter)
+			@fxcop_command = fxcop_command
+			@next_adapter = next_adapter
+		end
+		def adapt(fxcop_settings)
+			ruleset_file_name = fxcop_settings.ruleset_file_name
+			@fxcop_command.add_argument("#{RULESET_SWITCH}#{ruleset_file_name}") unless ruleset_file_name.nil?
+			@next_adapter.adapt(fxcop_settings)
+		end
+	end
+
+	class DictionaryFileNameAdapter
+		DICTIONARY_SWITCH = "/dic:"
+		def initialize(fxcop_command, next_adapter)
+			@next_adapter = next_adapter
+			@fxcop_command = fxcop_command
+		end
+		def adapt(fxcop_settings)
+			dictionary_file_name = fxcop_settings.dictionary_file_name
+			dictionary_argument = " #{DICTIONARY_SWITCH}#{dictionary_file_name}" unless dictionary_file_name.nil?
+			@fxcop_command.add_argument(dictionary_argument)
+			@next_adapter.adapt(fxcop_settings)
+		end
+	end
+
+	class AssembliesAdapter
+		FILE_SWITCH = "/f:"
+
+		def initialize(fxcop_command, next_adapter)
+			@fxcop_command = fxcop_command
+			@next_adapter = next_adapter
+		end
+
+		def adapt(fxcop_settings)			
+			fxcop_settings.assemblies.each do | assembly |
+				file_command = " #{FILE_SWITCH}#{assembly}"
+				@fxcop_command.add_argument(file_command)
+			end							
+			@next_adapter.adapt(fxcop_settings)	
+		end
+	end
+
+	class ShellCommand
+		def execute(command)
+			system command
+		end
+	end
+end

data/lib/fxcop_raketask.rb

@@ -0,0 +1,43 @@
+require_relative "fxcop"
+
+def fxcop(*args, &block)	
+	fxcop_wrapper = FxCopWrapper.new(&block)
+	task = Proc.new { fxcop_wrapper.run }
+	Rake::Task.define_task(*args, &task)
+end
+
+
+class FxCopWrapper
+	def initialize(&block)
+		@block = block;
+	end
+	
+	def run()			
+		configuration = FxCopConfiguration.new
+		@block.call(configuration)
+		fxcop_settings = create_fxcop_settings_from_configuration(configuration)
+		BuildQuality::FxCop.new(self,fxcop_binary: configuration.fxcop_binary).start(fxcop_settings)
+	end
+
+	def create_fxcop_settings_from_configuration(configuration)
+		BuildQuality::FxCopSettings.new(assemblies: configuration.assemblies,
+										output_file_name: configuration.output_file_name,
+										dictionary_file_name: configuration.dictionary_file_name,
+										ruleset_file_name: configuration.ruleset_file_name,
+										culture: configuration.culture)
+	end
+
+	def execute(command)
+		puts command
+		BuildQuality::ShellCommand.new.execute(command)
+	end
+end
+
+class FxCopConfiguration
+	attr_accessor 	:fxcop_binary, 
+					:assemblies,
+					:output_file_name, 
+					:dictionary_file_name, 
+					:ruleset_file_name, 
+					:culture
+end

data/tests/test_fxcop.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require_relative '../lib/fxcop'
+
+class TestFxCop < Test::Unit::TestCase
+
+	def test_when_started_with_no_arguments_Then_command_is_fxcop_binary	
+		fxcop_binary = '.\FxCopCmd.exe'
+		BuildQuality::FxCop.new(self, fxcop_binary: fxcop_binary).start	
+		assert_equal(fxcop_binary, @command)
+	end	
+
+	def test_when_fxcop_started_with_two_assemblies_Then_command_contains_both_assemblies_as_files_switches
+		assembly1 = 'c:\workspace\mydll1.dll'
+		assembly2 = 'c:\workspace\mydll2.dll'
+		file_switch = '/f:'		
+		fxcop_settings = BuildQuality::FxCopSettings.new(assemblies: [assembly1,assembly2])
+		BuildQuality::FxCop.new(self, {}).start(fxcop_settings)
+		assert_equal(" #{file_switch}#{assembly1} #{file_switch}#{assembly2}", @command)
+	end
+
+	def test_when_fxcop_started_with_out_file_name_provided_Then_command_contains_output_file_with_output_switch
+		output_file_name = "fred.xml"
+		output_switch = '/o:' 
+		fxcop_settings = BuildQuality::FxCopSettings.new(output_file_name: output_file_name)
+		BuildQuality::FxCop.new(self, {}).start(fxcop_settings)
+		assert_equal(" #{output_switch}#{output_file_name}",@command)
+	end
+
+	def test_when_fxcop_started_with_custom_dictionary_provided_Then_command_contains_custom_dictionary_switch
+		dictionary_file_name = "mydictionary.txt"
+		dictionary_switch = '/dic:' 
+		fxcop_settings = BuildQuality::FxCopSettings.new(dictionary_file_name: dictionary_file_name)
+		BuildQuality::FxCop.new(self, {}).start(fxcop_settings)
+		assert_equal(" #{dictionary_switch}#{dictionary_file_name}",@command)
+	end
+
+	def test_when_fxcop_started_with_custom_ruleset_provided_Then_command_contains_ruleset_switch
+		ruleset_file_name = "myruleset.ruleset"
+		ruleset_switch = '/rs:=' 
+		fxcop_settings = BuildQuality::FxCopSettings.new(ruleset_file_name: ruleset_file_name)
+		BuildQuality::FxCop.new(self, {}).start(fxcop_settings)
+		assert_equal(" #{ruleset_switch}#{ruleset_file_name}",@command)
+	end
+
+	def test_when_fxcop_started_with_culture_provided_Then_command_contains_culture_switch
+		culture_type = 'en-gb'
+		culture_switch = '/cul:' 
+		fxcop_settings = BuildQuality::FxCopSettings.new(culture: culture_type)
+		BuildQuality::FxCop.new(self, {}).start(fxcop_settings)
+		assert_equal(" #{culture_switch}#{culture_type}",@command)
+	end
+
+
+	def execute(command)
+		@command = command
+	end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: fxcop
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Ben Flowers
+- Iain Mitchell
+- Rikk Renshaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: FxCop Wrapper for running FxCop on Continuous integration. Comes with
+  Rake Task or can be used with Standard Ruby
+email:
+- ben.j.flowers@gmail.com
+- iainjmitchell@gmail.com
+- rikk62@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fxcop.rb
+- lib/fxcop_raketask.rb
+- tests/test_fxcop.rb
+homepage: https://github.com/team-beast/fxcop
+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.24
+signing_key: 
+specification_version: 3
+summary: Simple FxCop wrapper gem
+test_files:
+- tests/test_fxcop.rb