flexpmd 1.2.1

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'sprout', '>= 1.1.15.pre'
+
+group :development do
+  gem 'rake'
+  gem 'shoulda'
+  gem 'mocha'
+end
+

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    mocha (0.9.12)
+    open4 (1.1.0)
+    rake (0.9.2)
+    rubyzip (0.9.4)
+    shoulda (2.11.3)
+    sprout (1.1.15.pre)
+      archive-tar-minitar (= 0.5.2)
+      bundler (>= 0.9.19)
+      open4 (>= 0.9.6)
+      rake (>= 0.9.2)
+      rubyzip (= 0.9.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rake
+  shoulda
+  sprout (>= 1.1.15.pre)

data/README.md

@@ -0,0 +1,68 @@
+# The FlexPMD Sprout Gem
+
+This [RubyGem](http://docs.rubygems.org/read/book/7) contains a rake task to add support for [FlexPMD](http://opensource.adobe.com/wiki/display/flexpmd/FlexPMD) in [Project Sprouts](http://projectsprouts.org).
+
+Functionality is only tested on OSX, it is *not expected* to work on Windows. You may be ok on Linux.
+
+## Install
+
+    git clone [this repo]
+    cd sprout-flexpmd
+    bundle install
+    gem build flexpmd.gemspec 
+    gem install flexpmd
+    
+#### Or
+
+    gem install flexpmd
+
+## Usage
+
+Add the following to your rake file
+
+    desc "Use FlexPMD to audit source code"
+    flexpmd 'report/pmd' 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
+
+    task :audit => ['report/pmd', 'report/cpd.xml', 'report/metrics.xml']
+    
+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.
+    
+## MIT License
+
+Copyright 2011 Simon Gregory
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,50 @@
+lib = File.expand_path('lib', File.dirname(__FILE__))
+$:.unshift lib unless $:.include?(lib)
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'flexpmd'
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/unit"
+  t.test_files = FileList["test/unit/*_test.rb"]
+  t.verbose = true
+end
+
+CLEAN.add '*.gem'
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release do
+  puts ""
+  print "Are you sure you want to relase FlexPMD #{FlexPMD::VERSION}? [y/N] "
+  exit unless STDIN.gets.index(/y/i) == 0
+  
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  
+  # Build gem and upload
+  sh "gem build flexpmd.gemspec"
+  sh "gem push flexpmd-#{FlexPMD::VERSION}.gem"
+  sh "rm flexpmd-#{FlexPMD::VERSION}.gem"
+  
+  # Commit
+  sh "git commit --allow-empty -a -m 'v#{FlexPMD::VERSION}'"
+  sh "git tag v#{FlexPMD::VERSION}"
+  sh "git push origin master"
+  sh "git push origin v#{FlexPMD::VERSION}"
+end

data/lib/flexpmd/base.rb

@@ -0,0 +1,55 @@
+module Sprout::System
+
+  ##
+  # Monkey patch the base system so we control the output to stderr.
+  #
+  class BaseSystem
+
+    ##
+    # Creates a new process, executes the command
+    # and returns whatever the process wrote to stdout, or stderr.
+    #
+    def execute(tool, options='')
+      Sprout.stdout.puts("#{tool} #{options}")
+      runner = get_and_execute_process_runner(tool, options)
+      error  = runner.read_err
+      result = runner.read
+
+      if(result.size > 0)
+        Sprout.stdout.puts result
+      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
+      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+,
+    # with the provided +options+.
+    #
+    # +executable+ String path to the external executable file.
+    #
+    # +options+ String commandline options to send to the +executable+.
+    #
+    def get_and_execute_process_runner tool, options=nil
+      runner = get_process_runner
+      raise Sprout::Errors::ExecutionError.new("[ERROR] Java is required for this tool to run.") unless `which java` =~ /java$/
+      runner.execute_open4 "java -Xms64m -Xmx768m -jar "+ clean_path(tool), options
+      runner
+    end
+     
+  end
+  
+end

data/lib/flexpmd/cpd.rb

@@ -0,0 +1,52 @@
+module FlexPMD 
+
+  ##
+  # Flex Copy and Paste Detector
+  #
+  #  (-s|--sourceDirectory) <sourceDirectory> 
+  #  (-o|--outputFile) <outputFile> 
+  # [(-m|--minimumTokens) <minimumTokens>]]
+  #
+  class FCPD < Sprout::Executable::Base
+
+    ##
+    # The source directory to recursively audit
+    #
+    add_param :source_directory, Path, { :required => true, :shell_name => '-s' }
+    
+    add_param_alias :s, :source_directory
+    
+    add_param_alias :src, :source_directory
+    
+    ##
+    # The file to output results to.
+    #
+    add_param :output_file, File, { :shell_name => '-o', :file_task_name => true }
+    
+    add_param_alias :o, :output_file
+    
+    add_param_alias :output, :output_file
+    
+    ##
+    # The minmum length of matched portions of code. A token roughly translates to a word,
+    # method name, operator etc. As this is subjective experiment to find a useful value. 50 to
+    # 100 is a reasonable starting point, the lower the better.
+    #
+    add_param :minimum_tokens, Number, { :shell_name => '-m' }
+    
+    add_param_alias :m, :minimum_tokens
+            
+    ##
+    # The default executable target.
+    #
+    set :executable, :flexcpd
+
+  end
+  
+end
+
+def flexcpd *args, &block
+  exe = FlexPMD::FCPD.new
+  exe.to_rake(*args, &block)
+  exe
+end

data/lib/flexpmd/metrics.rb

@@ -0,0 +1,38 @@
+module FlexPMD 
+  
+  ##
+  # FlexMetrics API
+  #
+  # (-s|--sourceDirectory) <sourceDirectory>
+  # (-o|--outputDirectory) <outputDirectory>
+  #
+  class FlexMetrics < Sprout::Executable::Base
+    
+    ##
+    # The source path to run flexpmd against.
+    add_param :source_directory, Path, { :required => true, :shell_name => '-s' }
+    
+    add_param_alias :s, :source_directory
+    
+    add_param_alias :src, :source_directory
+
+    add_param :output_directory, File, { :shell_name => '-o', :file_task_name => true }
+    
+    add_param_alias :o, :output_directory
+    
+    add_param_alias :output, :output_directory
+    
+    ##
+    # The default executable target.
+    #
+    set :executable, :flexmetrics
+
+  end
+  
+end
+
+def flexmetrics *args, &block
+  exe = FlexPMD::FlexMetrics.new
+  exe.to_rake(*args, &block)
+  exe
+end

data/lib/flexpmd/pmd.rb

@@ -0,0 +1,48 @@
+module FlexPMD 
+
+  ##
+  # FlexPMD API
+  #
+  # (-s|--sourceDirectory) <sourceDirectory> 
+  # (-o|--outputDirectory) <outputDirectory> 
+  #[(-r|--ruleSet) <ruleSet>]
+  #[(-e|--excludePackage) <excludePackage>]
+  #
+  class FPMD < Sprout::Executable::Base
+
+    ##
+    # The source path to run flexpmd against.
+    add_param :source_directory, Path, { :required => true, :shell_name => '-s' }
+    
+    add_param_alias :s, :source_directory
+    
+    add_param_alias :src, :source_directory
+
+    add_param :output_directory, File, { :shell_name => '-o', :file_task_name => true }    
+    
+    add_param_alias :o, :output_directory
+    
+    add_param_alias :output, :output_directory
+    
+    add_param :rule_set, File, { :shell_name => '-r' }
+    
+    add_param_alias :r, :rule_set
+        
+    add_param :exclude_package, String, { :shell_name => '-e' }
+    
+    add_param_alias :e, :exclude_package
+    
+    ##
+    # The default executable target.
+    #
+    set :executable, :flexpmd
+
+  end
+  
+end
+
+def flexpmd *args, &block
+  exe = FlexPMD::FPMD.new
+  exe.to_rake(*args, &block)
+  exe
+end

data/lib/flexpmd.rb

@@ -0,0 +1,30 @@
+require 'sprout'
+
+require 'flexpmd/pmd'
+require 'flexpmd/cpd'
+require 'flexpmd/metrics'
+require 'flexpmd/base'
+
+module FlexPMD 
+  NAME    = 'flexpmd'
+  JAR_VERSION = '1.2'
+  VERSION = "#{JAR_VERSION}.1"
+  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
+
+Sprout::Specification.new do |s|
+
+  s.name    = FlexPMD::NAME
+  s.version = FlexPMD::JAR_VERSION
+
+  s.add_remote_file_target do |t|
+    t.platform     = :universal
+    t.archive_type = :zip
+    t.url = FlexPMD::ZIP
+    t.md5 = FlexPMD::MD5
+    t.add_executable :flexpmd, "flex-pmd-command-line-#{FlexPMD::JAR_VERSION}.jar"
+    t.add_executable :flexcpd, "flex-pmd-cpd-command-line-#{FlexPMD::JAR_VERSION}.jar"
+    t.add_executable :flexmetrics, "flex-pmd-metrics-command-line-#{FlexPMD::JAR_VERSION}.jar"
+  end
+end

data/test/unit/flexpmd_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class FlexPMDTest < Test::Unit::TestCase
+  include Sprout::TestHelper
+
+  context "A FlexPMD tool" do
+
+    setup do
+      @fixture = File.join fixtures, 'flexpmd', 'tmp'
+      FileUtils.makedirs @fixture
+      @ruleset = File.join @fixture, 'ruleset.xml'
+    end
+
+    teardown do
+      remove_file @fixture
+    end
+
+    should "accept input" do
+      fpmd = FlexPMD::FPMD.new
+      fpmd.src = @fixture
+      fpmd.output = @app_desc
+      fpmd.rule_set = Dir.pwd
+
+      assert_equal "-s=#{@fixture} -r=#{Dir.pwd}", fpmd.to_shell
+    end
+  end
+  
+end

data/test/unit/test_helper.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bundler"
+Bundler.require :default, :development
+
+# These require statments *must* be in this order:
+# http://bit.ly/bCC0Ew
+# Somewhat surprised they're not being required by Bundler...
+require 'shoulda'
+require 'mocha'
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+$:.unshift lib unless $:.include? lib
+
+test = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+$:.unshift test unless $:.include? test
+
+require 'sprout'
+require 'sprout/test_helper'
+
+require 'flexpmd'
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: flexpmd
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.2.1
+platform: ruby
+authors: 
+- Simon Gregory
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sprout
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.15.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Project Sprouts support for FlexPMD
+email: projectsprouts@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- lib/flexpmd/base.rb
+- lib/flexpmd/cpd.rb
+- lib/flexpmd/metrics.rb
+- lib/flexpmd/pmd.rb
+- lib/flexpmd.rb
+- Rakefile
+- README.md
+- test/unit/flexpmd_test.rb
+- test/unit/test_helper.rb
+homepage: http://projectsprouts.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 73980266876539591
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Code auditing for ActionScript and Flex
+test_files: []
+