code_stats2 0.1.4 → 0.1.5

data/bin/code_stats

@@ -4,28 +4,46 @@ lib_dir = %(#{File.expand_path "#{__FILE__}/../.."}/lib)
 $LOAD_PATH << lib_dir unless $LOAD_PATH.include? lib_dir
 
 require 'code_stats'
+require 'optparse'
 
-if ARGV.empty? or %w(-h --help help).any?{|k| ARGV.include? k}
-  puts <<-TEXT
-  Language-agnostic Code Statistics
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner =  <<-TEXT
+Language-agnostic Code Statistics
+
+Usage:
+  $ code_stats /projects/wordpress /projects/drupal
+  $ code_stats /projects/*
+  $ code_stats /projects/wordpress --except JavaScript --skip /tmp/
 
-  Usage:
-    $ code_stats /projects/wordpress /projects/drupal
-    $ code_stats /projects/*
-    $ code_stats /projects/wordpress /projects/drupal except: JavaScript skip_filter: /tmp/
-  
-  Options:
-    except: JavaScript - analyze all languages except JavaScript
-    only: Ruby - analyze Ruby language only
-    specs_filter: regex, specifies should be path threated as specs, default: #{CodeStats::Project::DEFAUL_SPEC_FILTER.source}
-    skip_filter: regex, specifies paths that should be skipped, default: #{CodeStats::Project::DEFAUL_SKIP_FILTER.source}
 TEXT
-  exit
-end
+
+  opts.on("--except LANG", "Analyze all languages except specified.") do |lang|
+    (options[:except] ||= []) << lang.to_sym
+  end
   
-args = RubyExt.argv
-options = args.extract_options!
-options2 = {}; options.each{|k, v| options2[k] = v ? v.to_sym : v}
-args << options2
+  opts.on("--only LANG", "Analyze only specified language(es).") do |lang|
+    (options[:only] ||= []) << lang.to_sym
+  end
+  
+  opts.on(
+    "--specs REGEX", 
+    "Specify paths that should be threated as specs/tests (default #{CodeStats::Project::DEFAUL_SPEC_FILTER.source})."
+  ) do |re|
+    options[:spec_filter] = Regexp.new(re)
+  end
+
+  opts.on(
+    "--skip REGEX", 
+    "Specify paths that should be skipped (default #{CodeStats::Project::DEFAUL_SKIP_FILTER.source})."
+  ) do |re|
+    options[:skip_filter] = Regexp.new(re)
+  end
+end
+parser.parse!
 
-CodeStats.analyze_and_report *args
+if ARGV.empty?
+  puts parser.banner
+else
+  CodeStats.analyze_and_report *(ARGV + [options])
+end

data/lib/code_stats.rb

@@ -10,11 +10,11 @@ require 'tilt'
 class CodeStats
   class << self
     def extensions; @extensions ||= {} end
-    
+
     attr_accessor :file_size_limit
-    attr_required :file_size_limit    
+    attr_required :file_size_limit
   end
-  
+
   self.file_size_limit = 500 * 1024
 end
 

data/lib/code_stats/code_stats.rb

@@ -1,24 +1,24 @@
 class CodeStats
-  class << self    
+  class << self
     def know? extension
       extensions.include? extension
     end
-  
+
     def parse text, extension
       language = extensions[extension] || raise("no language for :#{extension} extension!")
       language.new text
     end
-    
+
     def analyze *args
       options = args.extract_options!
-      paths = args      
+      paths = args
       paths.collect!{|path| Dir[path]}.flatten!
-      
-      puts <<-TEXT
-please wait, analyzing:
+
+      info <<-TEXT
+please wait, analyzing following projects:
   #{paths.join("\n  ")}
 TEXT
-      
+
       projects = paths.collect do |path|
         project = Project.new path, options
         project.analyze!
@@ -26,26 +26,31 @@ TEXT
       end
       projects.sort{|a, b| b.characters_count <=> a.characters_count}
     end
-    
+
     def analyze_and_report *args
       # parsing options
       options = args.extract_options!
       paths = args
-      
+
       options.validate_options! *(FileSet::AVAILIABLE_OPTIONS + Project::AVAILIABLE_OPTIONS)
       project_options = options.select{|k, v| Project::AVAILIABLE_OPTIONS.include? k}
       lang_options = options.select{|k, v| FileSet::AVAILIABLE_OPTIONS.include? k}
-      
+
       # analyzing & reporting
       projects = analyze *(paths << project_options)
       report = Report.new(*(projects << lang_options)).render
-      
+
       report_file = "./projects_statistics.html".to_file
-      report_file.write! report
+      report_file.write report
 
-      puts "done, statistics are in #{report_file}"      
+      info "done, statistics are in #{report_file}"
 
       Kernel.exec "open #{report_file}"
     end
+
+    protected
+      def info msg
+        puts msg
+      end
   end
 end

data/lib/code_stats/file_set.rb

@@ -2,7 +2,7 @@ class CodeStats::FileSet
   def initialize
     @lines_count_by_language, @characters_count_by_language = Hash.new(0), Hash.new(0)
   end
-  
+
   def lines_count options = {}
     total_count = 0
     lines_count_by_language(options).each{|lang, count| total_count += count}
@@ -27,7 +27,7 @@ class CodeStats::FileSet
     @lines_count_by_language[script.class.alias.to_sym] += script.lines_count
     @characters_count_by_language[script.class.alias.to_sym] += script.characters_count
   end
-  
+
   AVAILIABLE_OPTIONS = [:only, :except]
 
   protected

data/lib/code_stats/gems.rb

@@ -1,4 +1,4 @@
-if respond_to? :fake_gem  
+if respond_to? :fake_gem
   fake_gem 'ruby_ext', '~> 0.4'
   fake_gem 'vfs',      '~> 0.3'
   fake_gem 'haml',     '~> 3.1'

data/lib/code_stats/languages.rb

@@ -1,40 +1,40 @@
 module CodeStats::Languages
   class Abstract
-    attr_reader :text    
-    
+    attr_reader :text
+
     def initialize text
       @text = text
     end
-    
+
     def self.extensions *args
       if args.size > 0
         @extensions = args
-        
+
         @extensions.each{|ext| CodeStats.extensions[ext] = self}
       else
         @extensions ||= []
       end
     end
-    
+
     def lines_count
       calculate_basic_statistics
       @lines_count
     end
-    
+
     def characters_count
       calculate_basic_statistics
       @characters_count
     end
-    
+
     def analyze
       calculate_basic_statistics
     end
-    
+
     protected
       def calculate_basic_statistics
         return if @basic_statistics_calculated
         @basic_statistics_calculated = true
-        
+
         @lines_count = code.blank? ? 0 : 1
         @characters_count = 0
         code.chars do |c|
@@ -43,92 +43,92 @@ module CodeStats::Languages
         end
       end
   end
-  
+
   module CComments
     def code
-      @code ||= text.substitute(/\/\*.+?\*\/\n?/m, '').substitute(/^\/\/.+?[\n\z]/m, '')
+      @code ||= text.substitute(/\/\*.+?\*\/\n?/m, '').substitute(/^\/\/.+?[\n\z]/m, '').substitute(/\/\/.+?$/, '')
     end
   end
-  
+
   module SharpComments
     def code
-      @code ||= text.substitute(/^#.+?[\n\z]/m, '')
+      @code ||= text.substitute(/^#.+?[\n\z]/m, '').substitute(/#.+?$/, '')
     end
   end
-  
+
   class Java < Abstract
     include CComments
-    
-    extensions :java        
+
+    extensions :java
   end
-  
+
   class JavaScript < Abstract
     include CComments
-    
+
     extensions :js
   end
-  
+
   class Ruby < Abstract
     include SharpComments
-    
+
     extensions :rb
   end
-  
+
   class Cpp < Abstract
     include CComments
-    
+
     extensions :c, :cpp, :h
   end
-  
+
   class Yaml < Abstract
     include SharpComments
-    
+
     extensions :yml
   end
-  
+
   class CoffeeScript < Abstract
     include SharpComments
-    
+
     extensions :coffee
-    
+
     def code
-      @code ||= text.substitute(/###.+?###\n?/m, '').substitute(/^#.+?[\n\z]/m, '')
+      @code ||= text.substitute(/###.+?###\n?/m, '').substitute(/^#.+?[\n\z]/m, '').substitute(/#.+?$/, '')
     end
   end
-  
+
   class Haml < Abstract
     extensions :haml
-    
+
     def code
-      @code ||= text.substitute(/^\/.+?[\n\z]/m, '')
+      @code ||= text.substitute(/^\/.+?[\n\z]/m, '').substitute(/^\s*\/.+?$/, '')
     end
   end
-  
+
   class Erb < Abstract
     extensions :erb
-    
+
     def code
       @code ||= text
     end
   end
-  
+
   class Rjs < Abstract
     extensions :rjs
-    
+
     def code
       @code ||= text
     end
   end
-  
+
   class Php < Abstract
     include CComments
-    
-    extensions :php        
+
+    extensions :php
   end
-  
+
   class Python < Abstract
     include SharpComments
-    
+
     extensions :py
   end
 end

data/lib/code_stats/project.rb

@@ -1,19 +1,19 @@
 class CodeStats::Project
-  attr_reader :path, :name, :specs_filter, :skip_filter, :unknown_extensions
+  attr_reader :path, :name, :spec_filter, :skip_filter, :unknown_extensions
   attr_reader :sources, :specs
-  
-  AVAILIABLE_OPTIONS = [:specs_filter, :skip_filter]
+
+  AVAILIABLE_OPTIONS = [:spec_filter, :skip_filter]
   DEFAUL_SPEC_FILTER = /\/tests?\/|\/specs?\//
-  DEFAUL_SKIP_FILTER = /\/docs?\/|\/(s|ex)amples?\/|\/guides?\/|\/.git\/|\/tmp\/|database\.php/
-  
+  DEFAUL_SKIP_FILTER = /\/docs?\/|\/(s|ex)amples?\/|\/guides?\/|\/.git\/|\/tmp\/|\/old\/|database\.php/
+
   def initialize path, options = {}
-    @path, @name = path, path.to_entry.name    
+    @path, @name = path, path.to_entry.name
     options.validate_options! *AVAILIABLE_OPTIONS
-    @specs_filter = options.include?(:specs_filter) ? options[:specs_filter] : DEFAUL_SPEC_FILTER
+    @spec_filter = options.include?(:spec_filter) ? options[:spec_filter] : DEFAUL_SPEC_FILTER
     @skip_filter = options.include?(:skip_filter) ? options[:skip_filter] : DEFAUL_SKIP_FILTER
     clear
   end
-  
+
   def files &b
     files = []
     path.to_dir.files '**/*.*' do |file|
@@ -22,33 +22,33 @@ class CodeStats::Project
     end
     b ? nil : files
   end
-  
+
   delegate :lines_count, :characters_count, :lines_count_by_language, :characters_count_by_language, to: :sources
-    
+
   def analyze!
-    clear    
-    files do |file|      
+    clear
+    files do |file|
       ext = file.extension.to_sym
       if CodeStats.know?(ext)
         warn("file #{file} is too big, skipping") and next if file.size > CodeStats.file_size_limit
-        script = CodeStats.parse file.read.force_utf8_encoding, ext        
+        script = CodeStats.parse file.read.force_utf8_encoding, ext
         source?(file) ? sources.add(script) : specs.add(script)
       else
         unknown_extensions << ext unless unknown_extensions.include? ext
       end
     end
   end
-  
+
   protected
     def clear
       @unknown_extensions = []
       @sources, @specs = CodeStats::FileSet.new, CodeStats::FileSet.new
     end
-  
+
     def source? file
-      !(specs_filter && (file.path.sub(path, '') =~ specs_filter))
+      !(spec_filter && (file.path.sub(path, '') =~ spec_filter))
     end
-    
+
     def skip? file
       skip_filter && (file.path.sub(path, '') =~ skip_filter)
     end

data/lib/code_stats/report.rb

@@ -2,9 +2,9 @@ class CodeStats::Report
   attr_reader :filters, :projects
   def initialize *args
     @filters = args.extract_options!
-    @projects = args    
+    @projects = args
   end
-  
+
   def render
     # preparing data
     data = projects.clone
@@ -12,30 +12,30 @@ class CodeStats::Report
     data.collect! do |p|
       o = OpenObject.new
       o.name = p.name
-      
+
       o.characters_count = p.characters_count(filters)
-      o.characters_count_by_language = p.characters_count_by_language(filters)                
+      o.characters_count_by_language = p.characters_count_by_language(filters)
       o.ignored_characters_count_by_language = p.characters_count_by_language.reject do |lang, count|
         o.characters_count_by_language.include?(lang)
       end
-      
-      o.specs = OpenObject.new        
+
+      o.specs = OpenObject.new
       o.specs.characters_count = p.specs.characters_count(filters)
-      o.specs.characters_count_by_language = p.specs.characters_count_by_language(filters)                
+      o.specs.characters_count_by_language = p.specs.characters_count_by_language(filters)
       o.specs.ignored_characters_count_by_language = p.specs.characters_count_by_language.reject do |lang, count|
         o.specs.characters_count_by_language.include?(lang)
       end
-      
+
       o.unknown_extensions = p.unknown_extensions
-      
+
       o
     end
-            
+
     # rendering
     dir = __FILE__.dirname.to_dir
     css = [dir['report/style.css'].read].join("\n")
     js = %w(jquery.js highchart.js report.js).collect{|n| dir["report/#{n}"].read}.join("\n")
-    
+
     report = dir / 'report.html.haml'
     report.render(projects: data, filters: filters, css: css, js: js)
   end

data/lib/code_stats/support.rb

@@ -1,5 +1,5 @@
 String.class_eval do
-  # Ruby just crashes on some files, don't know why and don't want to 
+  # Ruby just crashes on some files, don't know why and don't want to
   # spend time on this shit, just found this hack somewhere in the internet.
   def force_utf8_encoding
     force_encoding('binary').gsub(156.chr,"Oe")

data/readme.md

@@ -8,17 +8,17 @@ Screenshots showing us: Complexity of [Rails libraries][rails-img], comparison o
 
 # Installation & Usage
 
-This tool is language-agnostic, but it itself is made with Ruby, so You need Ruby installed to use it, to install it type:
+The tool is language-agnostic, but to use it You need Ruby installed, to install type:
 
 ``` bash
 gem install code_stats2
 ```
 
-Now run it on some of Your projects, You can also specify some options (type '$ code_stats' without arguments to see full help):
+Now run it on some of Your projects, You can also specify some options (type 'code_stats' without arguments to see full help):
 
 ``` bash
 code_stats /projects/wordpress
-code_stats /projects/* except: JavaScript
+code_stats /projects/* --except JavaScript
 ```
 
 Also You can easily customize it, sources are small and simple as an egg.

data/spec/code_stats_spec.rb

@@ -6,7 +6,7 @@ describe "Project" do
     report = CodeStats::Report.new(*projects).render
     report.should =~ /sample_project.+32/m
   end
-  
+
   it "should also accept options (from error)" do
     projects = CodeStats.analyze sample_project_path
     report = CodeStats::Report.new(*(projects << {except: :JavaScript})).render

data/spec/languages_spec.rb

@@ -5,7 +5,7 @@ shared_examples_for 'language' do
     lang = CodeStats.parse @script, @extension
     lang.code.should == <<-CODE
 code_a
-code_b
+code_b 
 CODE
     # lang.code.should_not include 'comment_a'
     # lang.code.should_not include 'comment_a2'
@@ -16,7 +16,7 @@ end
 
 describe "Java" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :java
     @script = <<-JAVA
@@ -29,14 +29,14 @@ comment_a
  */
 // comment_b
 // comment_b2
-code_b
+code_b // comment_b3
 JAVA
   end
 end
 
 describe "JavaScript" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :js
     @script = <<-JAVA_SCRIPT
@@ -49,10 +49,10 @@ comment_a
  */
 // comment_b
 // comment_b2
-code_b
+code_b // comment_b3
 JAVA_SCRIPT
   end
-  
+
   it "removing comments should correctly change lines count" do
     script = <<-JAVA_SCRIPT
 // a variable
@@ -74,7 +74,7 @@ b = 2;
 
 alert(a + b);
 JAVA_SCRIPT
-    
+
     lang = CodeStats.parse script, :js
     lang.code.should == code
   end
@@ -82,21 +82,21 @@ end
 
 describe "Ruby" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :rb
     @script = <<-RUBY
 code_a
 # comment_a
 # comment_a2
-code_b
+code_b # comment_b3
 RUBY
   end
 end
 
 describe "Cpp" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :cpp
     @script = <<-CPP
@@ -109,14 +109,14 @@ comment_a
  */
 // comment_b
 // comment_b2
-code_b
+code_b // comment_b3
 CPP
   end
 end
 
 describe "CoffeeScript" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :coffee
     @script = <<-COFFEE_SCRIPT
@@ -129,66 +129,66 @@ comment_a2
 ###
 # comment_b
 # comment_b2
-code_b
+code_b # comment_b3
 COFFEE_SCRIPT
   end
 end
 
 describe "Yaml" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :yml
     @script = <<-YAML
 code_a
 # comment_a
 # comment_a2
-code_b
+code_b # comment_b3
 YAML
   end
 end
 
 describe "Haml" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :haml
     @script = <<-HAML
 code_a
 / comment_a
 / comment_a2
-code_b
+code_b 
 HAML
   end
 end
 
 describe "Erb" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :erb
     @script = <<-ERB
 code_a
-code_b
+code_b 
 ERB
   end
 end
 
 describe "Rjs" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :rjs
     @script = <<-RJS
 code_a
-code_b
+code_b 
 RJS
   end
 end
 
 describe "Php" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :php
     @script = <<-PHP
@@ -201,21 +201,21 @@ comment_a
  */
 // comment_b
 // comment_b2
-code_b
+code_b // comment_b3
 PHP
   end
 end
 
 describe "Python" do
   it_should_behave_like "language"
-  
+
   before do
     @extension = :py
     @script = <<-PYTHON
 code_a
 # comment_a
 # comment_a2
-code_b
+code_b # comment_b3
 PYTHON
   end
 end

data/spec/project_spec.rb

@@ -1,30 +1,30 @@
 require 'spec_helper'
 
-describe "Project" do 
+describe "Project" do
   it "general" do
     prj = CodeStats::Project.new sample_project_path
     prj.name.should == 'sample_project'
     prj.files.size.should == 4
-    
+
     prj.analyze!
-    
+
     prj.unknown_extensions.should == [:unknown]
-    
+
     # sources
     prj.lines_count.should == 10
     prj.characters_count.should == 32
 
     prj.lines_count_by_language.should == {JavaScript: 5, Ruby: 5}
     prj.characters_count_by_language.should == {JavaScript: 19, Ruby: 13}
-    
+
     # specs
     prj.specs.lines_count.should == 2
     prj.specs.characters_count.should == 16
 
     prj.specs.lines_count_by_language.should == {Ruby: 2}
-    prj.specs.characters_count_by_language.should == {Ruby: 16}    
+    prj.specs.characters_count_by_language.should == {Ruby: 16}
   end
-  
+
   it "language filters" do
     prj = CodeStats::Project.new sample_project_path
     prj.analyze!

data/spec/spec_helper.rb

@@ -5,4 +5,8 @@ rspec do
   def sample_project_path
     "#{__FILE__.dirname}/sample_project"
   end
+end
+
+CodeStats.class_eval do
+  def self.info msg; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_stats2
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-11 00:00:00.000000000Z
+date: 2011-09-15 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_ext
-  requirement: &740960 !ruby/object:Gem::Requirement
+  requirement: &2844590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *740960
+  version_requirements: *2844590
 - !ruby/object:Gem::Dependency
   name: vfs
-  requirement: &971370 !ruby/object:Gem::Requirement
+  requirement: &2844350 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *971370
+  version_requirements: *2844350
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &1005160 !ruby/object:Gem::Requirement
+  requirement: &2844110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *1005160
+  version_requirements: *2844110
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &1011610 !ruby/object:Gem::Requirement
+  requirement: &2843870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *1011610
+  version_requirements: *2843870
 description: 
 email: 
 executables: