hoe-seattlerb 1.2.9 → 1.3.0

data/History.txt

@@ -1,3 +1,11 @@
+=== 1.3.0 / 2013-04-09
+
+* 3 minor enhancements:
+
+  * Added history rake task. Outputs (and caches) flog/flay data across releases.
+  * Added hoe/history.rb -- providing historical flog & flay numbers across releases.
+  * Hooked in history plugin to be on by default.
+
 === 1.2.9 / 2012-11-09
 
 * 1 bug fix:

data/Manifest.txt

@@ -4,5 +4,6 @@ Manifest.txt
 README.txt
 Rakefile
 lib/hoe/email.rb
+lib/hoe/history.rb
 lib/hoe/perforce.rb
 lib/hoe/seattlerb.rb

data/lib/hoe/email.rb

@@ -1,3 +1,6 @@
+##
+# Email plugin for Hoe.
+
 module Hoe::Email
 
   Hoe::DEFAULT_CONFIG["email"] = {
@@ -10,14 +13,23 @@ module Hoe::Email
     "tls"  => nil,
   }
 
+  ##
+  # Who to send email to.
+
   attr_reader :email_to
 
+  ##
+  # Initialize the email plugin. Get the email/to from hoe's config.
+
   def initialize_email
     with_config do |config, _|
       @email_to = config["email"]["to"] rescue nil
     end
   end
 
+  ##
+  # Define email tasks.
+
   def define_email_tasks
     require 'net/smtp'
     begin

data/lib/hoe/history.rb

@@ -0,0 +1,63 @@
+##
+# History plugin for Hoe. Allows you to calculate all of the flog &
+# flay scores over the releases of your project in an SCM independent
+# way.
+
+module Hoe::History
+  def define_history_tasks # :nodoc:
+    # do nothing
+  end
+
+  ##
+  # Calculate the flog and flay score for a Hoe project.
+
+  def flog_flay
+    flog = `flog -s -c $(cat Manifest.txt | grep -v txt$) 2>/dev/null`
+    flay = `flay -s    $(cat Manifest.txt | grep -v txt$) 2>/dev/null`
+
+    flog_total = flog[/([\d\.]+): flog total/, 1].to_f
+    flog_avg   = flog[/([\d\.]+): flog\/method average/, 1].to_f
+    flay_total = flay[/Total score .lower is better. = (\d+)/, 1].to_i
+
+    return flog_total, flog_avg, flay_total
+  end
+
+  ##
+  # Load cached history.
+
+  def load_history
+    require "yaml"
+    YAML.load_file(".history.yaml") rescue {}
+  end
+
+  ##
+  # Save cached history.
+
+  def save_history data
+    require "yaml"
+    File.open ".history.yaml", "w" do |f|
+      YAML.dump data, f
+    end
+  end
+
+  ##
+  # Calculate the history across all versions. Uses `versions` from an
+  # SCM plugin to figure out how to deal with the SCM.
+
+  def history versions
+    history = load_history
+    history.delete "dev" # FIX: this is p4 specific - make a variable?
+
+    flog_total = flog_avg = flay_total = nil
+
+    puts "version\tflog\tavg\tflay"
+    versions.each do |version|
+      history[version] = yield(version) unless history[version]
+
+      flog_total, flog_avg, flay_total = history[version]
+      puts "%s\t%.1f\t%.1f\t%d" % [version, flog_total, flog_avg, flay_total]
+    end
+  ensure
+    save_history history
+  end
+end

data/lib/hoe/perforce.rb

@@ -26,12 +26,23 @@ require 'find'
 # structure can accommodate either but the code below is implicit.
 
 module Hoe::Perforce
+
+  ##
+  # Files fore perforce to ignore. Probably not needed now that they
+  # support a dot-ignore file. I have yet to use that so... yeah.
+
   attr_accessor :perforce_ignore
 
+  ##
+  # Initializes the perforce plugin.
+
   def initialize_perforce
     self.perforce_ignore = []
   end
 
+  ##
+  # Defines tasks for the perforce plugin.
+
   def define_perforce_tasks
     warn :define_perforce_tasks if $DEBUG
 
@@ -60,6 +71,11 @@ module Hoe::Perforce
     task :postrelease => :announce do
       system 'rake clean'
     end
+
+    desc "Generate historical flog/flay data for all releases"
+    task :history do
+      p4_history
+    end
   end
 
   ##
@@ -73,6 +89,9 @@ module Hoe::Perforce
     sh "#{cmd};"
   end
 
+  ##
+  # Audit the manifest file against files on the file system.
+
   def validate_manifest_file manifest_dir
     manifest_file = "#{manifest_dir}/Manifest.txt"
     raise "#{manifest_file} does not exist" unless test ?f, manifest_file
@@ -113,18 +132,47 @@ module Hoe::Perforce
     raise msg.join("\n") unless msg.empty?
   end
 
+  ##
+  # Revert the pending (release) directory.
+
   def p4_revert dir
     puts "reverting #{dir}"
     p4sh "p4 revert #{dir}/..."
   end
 
+  ##
+  # Branch a release from +from+ to +to+.
+
   def p4_integrate from, to
     opened = `p4 opened ... 2>&1`
     raise "You have files open" unless opened =~ /file\(s\) not opened/
     p4sh "p4 integrate #{from}/... #{to}/..."
   end
 
+  ##
+  # Submit the current directory with a description message.
+
   def p4_submit description
     p4sh "p4 submit -d #{description.inspect} ..."
   end
+
+  ##
+  # Return all version directories (and dev).
+
+  def p4_versions
+    dirs = Dir["../[0-9]*"].sort_by { |s| Gem::Version.new(File.basename(s)) }
+    dirs << "../dev"
+    dirs.map { |d| File.basename d }
+  end
+
+  ##
+  # Return the flog & flay history of all releases.
+
+  def p4_history
+    history p4_versions do |version|
+      Dir.chdir "../#{version}" do
+        flog_flay
+      end
+    end
+  end
 end

data/lib/hoe/seattlerb.rb

@@ -1,7 +1,16 @@
-Hoe.plugin :minitest, :perforce, :email
+Hoe.plugin :minitest, :history, :perforce, :email
+
+class Hoe; end # :nodoc: stfu rdoc... *sigh*
+
+##
+# Top level Seattlerb plugin for Hoe. Doesn't really do anything but
+# pull in other default plugins.
 
 module Hoe::Seattlerb
-  VERSION = "1.2.9"
+  VERSION = "1.3.0" # :nodoc:
+
+  ##
+  # Define seattlerb's rdoc location.
 
   def define_seattlerb_tasks
     if Hoe.plugins.include? :publish then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hoe-seattlerb
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 9
-  version: 1.2.9
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2012-11-09 00:00:00 Z
+date: 2013-04-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -46,11 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 21
         segments: 
         - 4
-        - 2
-        version: "4.2"
+        - 7
+        version: "4.7"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -61,11 +61,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 27
         segments: 
-        - 3
-        - 10
-        version: "3.10"
+        - 4
+        - 0
+        version: "4.0"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -76,11 +76,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 13
         segments: 
         - 3
-        - 2
-        version: "3.2"
+        - 5
+        version: "3.5"
   type: :development
   version_requirements: *id003
 description: |-
@@ -104,6 +104,7 @@ files:
 - README.txt
 - Rakefile
 - lib/hoe/email.rb
+- lib/hoe/history.rb
 - lib/hoe/perforce.rb
 - lib/hoe/seattlerb.rb
 homepage: https://github.com/seattlerb/hoe-seattlerb
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: seattlerb
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Hoe plugins providing tasks used by seattle.rb including minitest, perforce, and email providing full front-to-back release/annouce automation.