strawberry_cough 0.1.0 → 0.2.0

data/tasks/ci.rake

@@ -0,0 +1,3 @@
+desc 'Heckle and run metrics'
+task :ci => [ :verify_measurements, :flog, :flay, :reek, 'metrics:all' ]
+

data/tasks/quality/flay.rake

@@ -0,0 +1,42 @@
+begin
+  require 'flay'
+  require 'yaml'
+
+  config      = YAML.load_file(File.expand_path('../../../config/flay.yml', __FILE__)).freeze
+  threshold   = config.fetch('threshold').to_i
+  total_score = config.fetch('total_score').to_f
+  files       = Flay.expand_dirs_to_files(config.fetch('path', 'lib'))
+
+  # original code by Marty Andrews:
+  # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+  desc 'Analyze for code duplication'
+  task :flay do
+    # run flay once without a threshold to ensure the max mass matches the threshold
+    flay = Flay.new(:fuzzy => false, :verbose => false, :mass => 0)
+    flay.process(*files)
+
+    max = flay.masses.map { |hash, mass| mass.to_f / flay.hashes[hash].size }.max
+    unless max >= threshold
+      raise "Adjust flay threshold down to #{max}"
+    end
+
+    total = flay.masses.reduce(0.0) { |total, (hash, mass)| total + (mass.to_f / flay.hashes[hash].size) }
+    unless total == total_score
+      raise "Flay total is now #{total}, but expected #{total_score}"
+    end
+
+    # run flay a second time with the threshold set
+    flay = Flay.new(:fuzzy => false, :verbose => false, :mass => threshold.succ)
+    flay.process(*files)
+
+    if flay.masses.any?
+      flay.report
+      raise "#{flay.masses.size} chunks of code have a duplicate mass > #{threshold}"
+    end
+  end
+rescue LoadError
+  task :flay do
+    abort 'Flay is not available. In order to run flay, you must: gem install flay'
+  end
+end
+

data/tasks/quality/flog.rake

@@ -0,0 +1,44 @@
+begin
+  require 'flog'
+  require 'yaml'
+
+  class Float
+    def round_to(n)
+      (self * 10**n).round.to_f * 10**-n
+    end
+  end
+
+  config    = YAML.load_file(File.expand_path('../../../config/flog.yml', __FILE__)).freeze
+  threshold = config.fetch('threshold').to_f.round_to(1)
+
+  # original code by Marty Andrews:
+  # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+  desc 'Analyze for code complexity'
+  task :flog do
+    flog = Flog.new
+    flog.flog Array(config.fetch('path', 'lib'))
+
+    totals = flog.totals.select  { |name, score| name[-5, 5] != '#none' }.
+                         map     { |name, score| [ name, score.round_to(1) ] }.
+                         sort_by { |name, score| score }
+
+    max = totals.last[1]
+    unless max >= threshold
+      raise "Adjust flog score down to #{max}"
+    end
+
+    bad_methods = totals.select { |name, score| score > threshold }
+    if bad_methods.any?
+      bad_methods.reverse_each do |name, score|
+        puts '%8.1f: %s' % [ score, name ]
+      end
+
+      raise "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+    end
+  end
+rescue LoadError
+  task :flog do
+    abort 'Flog is not available. In order to run flog, you must: gem install flog'
+  end
+end
+

data/tasks/quality/metric_fu.rake

@@ -0,0 +1,26 @@
+begin
+  require 'metric_fu'
+
+  MetricFu::Configuration.run do |config|
+    config.rcov = {
+      :environment => 'test',
+      :test_files => %w[ spec/**/*_spec.rb ],
+      :rcov_opts => %w[
+        --sort coverage
+        --no-html
+        --text-coverage
+        --no-color
+        --profile
+        --include spec
+        --exclude /gems/,/Library/,/usr/,spec
+      ]
+    }
+  end
+rescue LoadError
+  namespace :metrics do
+    task :all do
+      abort "metric_fu is not available. Install with: gem install metric_fu"
+    end
+  end
+end
+

data/tasks/quality/reek.rake

@@ -0,0 +1,10 @@
+begin
+  require 'reek/rake/task'
+
+  Reek::Rake::Task.new
+rescue LoadError
+  task :reek do
+    abort "reek not available. Install with: gem install reek"
+  end
+end
+

data/tasks/quality/yardstick.rake

@@ -0,0 +1,24 @@
+begin
+  require 'pathname'
+  require 'yardstick'
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+  require 'yaml'
+
+  config = YAML.load_file(File.expand_path('../../../config/yardstick.yml', __FILE__))
+
+  # yardstick_measure task
+  Yardstick::Rake::Measurement.new
+
+  # verify_measurements task
+  Yardstick::Rake::Verify.new do |verify|
+    verify.threshold = config.fetch('threshold')
+  end
+rescue LoadError
+  %w[ yardstick_measure verify_measurements ].each do |name|
+    task name.to_s do
+      abort "Yardstick is not available. In order to run #{name}, you must: gem install yardstick"
+    end
+  end
+end
+

metadata

@@ -1,50 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: strawberry_cough
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Craig Savolainen
 - Nate Smith
+- Shawn Lee-Kwong
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-25 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id001
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: 
-email: 
+email:
 - support@threewisemen.ca
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -52,51 +46,52 @@ files:
 - Rakefile
 - TODO
 - autotest/discover.rb
+- config/flay.yml
+- config/flog.yml
+- config/site.reek
+- config/yardstick.yml
+- lib/assets/javascripts/routes.js.strawberry_cough
 - lib/strawberry_cough.rb
 - lib/strawberry_cough/path_compiler.rb
 - lib/strawberry_cough/path_parser.rb
-- lib/strawberry_cough/railtie.rb
+- lib/strawberry_cough/rails/engine.rb
 - lib/strawberry_cough/routes_compiler.rb
+- lib/strawberry_cough/routes_js_template.rb
 - lib/strawberry_cough/version.rb
 - spec/path_compiler_spec.rb
 - spec/path_parser_spec.rb
 - spec/routes_compiler_spec.rb
 - spec/spec_helper.rb
 - strawberry_cough.gemspec
-has_rdoc: true
+- tags
+- tasks/ci.rake
+- tasks/quality/flay.rake
+- tasks/quality/flog.rake
+- tasks/quality/metric_fu.rake
+- tasks/quality/reek.rake
+- tasks/quality/yardstick.rake
 homepage: http://github.com/ThreeWiseMen/strawberry_cough
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -3654356472966179208
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: strawberry_cough
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Strawberry Cough lets you access your Rails 3 routes in your JavaScripts.
 test_files: []
-

data/lib/strawberry_cough/railtie.rb

@@ -1,19 +0,0 @@
-require 'strawberry_cough/routes_compiler'
-require 'rails/railtie'
-
-module StrawberryCough
-
-  class Railtie < Rails::Railtie
-
-    config.to_prepare do
-      app = Rails.application
-      routes = app.routes.routes
-      file = File.join(app.root, "public", "javascripts", "routes.js")
-      File.open(file, "w") do |io|
-        RoutesCompiler.compile_to_io(routes, io)
-      end
-    end
-
-  end
-
-end