flexpmd 1.2.1 → 1.2.2

data/README.md

@@ -20,22 +20,20 @@ Functionality is only tested on OSX, it is *not expected* to work on Windows. Yo
 
 Add the following to your rake file
 
-    desc "Use FlexPMD to audit source code"
-    flexpmd 'report/pmd' do |t|
+    flexpmd 'report' do |t|
       t.src = 'src'
     end
 
-    desc "Use FlexCPD to detect copy pasted code"
     flexcpd 'report/cpd.xml' do |t|
       t.src = 'src'
       t.minimum_tokens = 50
     end
 
-    desc "Use FlexMetrics to generate code metrics for this project"
     flexmetrics 'report/metrics.xml' do |t|
       t.src = 'src'
     end
 
+    desc "Run FlexPMD, FlexCPD, and FlexMetrics to audit the project"
     task :audit => ['report/pmd', 'report/cpd.xml', 'report/metrics.xml']
     
 Then invoke it with
@@ -43,6 +41,14 @@ Then invoke it with
     rake audit
     
 Output can be found in the `report/` directory created in the project root. This is best consumed via the relevant [Jenkins](http://jenkins-ci.org/) plugins.
+
+## Versioning
+
+The version number of the gem is based on the underlying FlexPMD release number, ie 1.2, followed by a single digit expressing the gem version.
+
+## On the horizon
+
+Initial release has focused on enabling report generation. As the reports are in xml, and not easy on the eye, it is intended that they are post consumed and output to the command line in a more relevant format.
     
 ## MIT License
 

data/Rakefile

@@ -48,3 +48,8 @@ task :release do
   sh "git push origin master"
   sh "git push origin v#{FlexPMD::VERSION}"
 end
+
+task :install do
+  sh "gem build flexpmd.gemspec"
+  sh "gem install flexpmd-#{FlexPMD::VERSION}.gem"
+end

data/lib/flexpmd/base.rb

@@ -1,10 +1,10 @@
 module Sprout::System
-
+  
   ##
-  # Monkey patch the base system so we control the output to stderr.
+  # Extend the unix system so we can run tools with a 'java -jar' prefix.
   #
-  class BaseSystem
-
+  class JavaUnixSystem < UnixSystem
+    
     ##
     # Creates a new process, executes the command
     # and returns whatever the process wrote to stdout, or stderr.
@@ -20,20 +20,15 @@ module Sprout::System
       end
 
       if(error.size > 0)
-        # We expect the process to write to stderror so simply print it, we don't want Sprouts 
-        # to stop executing.
-        Sprout.stdout.puts error
+        # We expect the process to write to stderror so filter and print it, we don't want Rake 
+        # to stop executing. 'WARNING' is consciously supressed as I've not seen it used as a 
+        # prefix to anything meaningful.
+        #
+        error.each_line { |line| Sprout.stdout.puts line if line =~ /^(ERROR|INFO):/ }
       end
 
       result || error
     end
-    
-  end
-  
-  ##
-  # Monkey patch the unix system so we can run tool with 'java -jar'.
-  #
-  class UnixSystem < BaseSystem
 
     ##
     # Get a process runner and execute the provided +executable+,
@@ -52,4 +47,17 @@ module Sprout::System
      
   end
   
-end
+end
+
+module FlexPMD
+  module Executable
+    class Base < Sprout::Executable::Base
+      ##
+      # This isn't very friendly to non unix users and needs to be addressed in future releases.
+      def system_execute binary, params
+        sys = Sprout::System::JavaUnixSystem.new
+        sys.execute binary, params
+      end
+    end
+  end  
+end

data/lib/flexpmd/cpd.rb

@@ -7,7 +7,7 @@ module FlexPMD
   #  (-o|--outputFile) <outputFile> 
   # [(-m|--minimumTokens) <minimumTokens>]]
   #
-  class FCPD < Sprout::Executable::Base
+  class FCPD < FlexPMD::Executable::Base
 
     ##
     # The source directory to recursively audit
@@ -40,7 +40,7 @@ module FlexPMD
     # The default executable target.
     #
     set :executable, :flexcpd
-
+    
   end
   
 end

data/lib/flexpmd/metrics.rb

@@ -6,7 +6,7 @@ module FlexPMD
   # (-s|--sourceDirectory) <sourceDirectory>
   # (-o|--outputDirectory) <outputDirectory>
   #
-  class FlexMetrics < Sprout::Executable::Base
+  class FlexMetrics < FlexPMD::Executable::Base
     
     ##
     # The source path to run flexpmd against.
@@ -26,7 +26,7 @@ module FlexPMD
     # The default executable target.
     #
     set :executable, :flexmetrics
-
+    
   end
   
 end

data/lib/flexpmd/pmd.rb

@@ -8,7 +8,7 @@ module FlexPMD
   #[(-r|--ruleSet) <ruleSet>]
   #[(-e|--excludePackage) <excludePackage>]
   #
-  class FPMD < Sprout::Executable::Base
+  class FPMD < FlexPMD::Executable::Base
 
     ##
     # The source path to run flexpmd against.

data/lib/flexpmd.rb

@@ -1,14 +1,14 @@
 require 'sprout'
 
+require 'flexpmd/base'
 require 'flexpmd/pmd'
 require 'flexpmd/cpd'
 require 'flexpmd/metrics'
-require 'flexpmd/base'
 
 module FlexPMD 
   NAME    = 'flexpmd'
   JAR_VERSION = '1.2'
-  VERSION = "#{JAR_VERSION}.1"
+  VERSION = "#{JAR_VERSION}.2"
   MD5 = 'efd3fa459788fa3d32837628dc82e264'
   ZIP = 'http://opensource.adobe.com/svn/opensource/flexpmd/maven-repository/release/com/adobe/ac/flex-pmd/1.2/flex-pmd-all-in-one-bundle-1.2.zip'
 end

data/test/unit/flexcpd_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class FlexCPDTest < Test::Unit::TestCase
+  include Sprout::TestHelper
+
+  context "A FlexCPD tool" do
+
+    setup do
+      @fixture = File.join fixtures, 'cpd', 'tmp'
+      FileUtils.makedirs @fixture
+    end
+
+    teardown do
+      remove_file @fixture
+    end
+
+    should "accept input" do
+      fcpd = FlexPMD::FCPD.new
+      fcpd.source_directory = @fixture
+      fcpd.output_file = 'report/cpd.xml'
+      fcpd.minimum_tokens = 100
+
+      assert_equal "-s=#{@fixture} -o=report/cpd.xml -m=100", fcpd.to_shell
+    end
+
+    should "accept input using aliases" do
+      fcpd = FlexPMD::FCPD.new
+      fcpd.s = @fixture
+      fcpd.o = 'report/cpd.xml'
+      fcpd.m = 100
+
+      assert_equal "-s=#{@fixture} -o=report/cpd.xml -m=100", fcpd.to_shell
+    end
+
+  end
+  
+end

data/test/unit/flexmetrics_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class FlexMetricsTest < Test::Unit::TestCase
+  include Sprout::TestHelper
+
+  context "A FlexMetrics tool" do
+
+    setup do
+      @fixture = File.join fixtures, 'metrics', 'tmp'
+      FileUtils.makedirs @fixture
+    end
+
+    teardown do
+      remove_file @fixture
+    end
+
+    should "accept input" do
+      fcpd = FlexPMD::FlexMetrics.new
+      fcpd.source_directory = @fixture
+      fcpd.output_directory = 'report/metrics.xml'
+
+      assert_equal "-s=#{@fixture} -o=report/metrics.xml", fcpd.to_shell
+    end
+
+    should "accept input using aliases" do
+      fcpd = FlexPMD::FlexMetrics.new
+      fcpd.s = @fixture
+      fcpd.o = 'report/metrics.xml'
+
+      assert_equal "-s=#{@fixture} -o=report/metrics.xml", fcpd.to_shell
+    end
+
+  end
+  
+end

data/test/unit/flexpmd_test.rb

@@ -17,12 +17,24 @@ class FlexPMDTest < Test::Unit::TestCase
 
     should "accept input" do
       fpmd = FlexPMD::FPMD.new
-      fpmd.src = @fixture
-      fpmd.output = @app_desc
+      fpmd.source_directory = @fixture
+      fpmd.output_directory = 'report/pmd'
       fpmd.rule_set = Dir.pwd
+      fpmd.exclude_package = 'org.foo'
 
-      assert_equal "-s=#{@fixture} -r=#{Dir.pwd}", fpmd.to_shell
+      assert_equal "-s=#{@fixture} -o=report/pmd -r=#{Dir.pwd} -e=org.foo", fpmd.to_shell
     end
+    
+    should "accept input using aliases" do
+      fpmd = FlexPMD::FPMD.new
+      fpmd.s = @fixture
+      fpmd.o = 'report/pmd'
+      fpmd.r = Dir.pwd
+      fpmd.e = 'org.foo'
+      
+      assert_equal "-s=#{@fixture} -o=report/pmd -r=#{Dir.pwd} -e=org.foo", fpmd.to_shell
+    end
+    
   end
   
 end

metadata

@@ -2,7 +2,7 @@
 name: flexpmd
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Simon Gregory
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-26 00:00:00 Z
+date: 2011-06-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sprout
@@ -74,6 +74,8 @@ files:
 - lib/flexpmd.rb
 - Rakefile
 - README.md
+- test/unit/flexcpd_test.rb
+- test/unit/flexmetrics_test.rb
 - test/unit/flexpmd_test.rb
 - test/unit/test_helper.rb
 homepage: http://projectsprouts.org
@@ -90,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 73980266876539591
+      hash: 2784567351923979262
       segments: 
       - 0
       version: "0"