loc_counter 0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/.yardoc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in loc_counter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+# loc_counter
+
+`loc_counter` is a command-line tool for measuring LOC (line-of-code) count in your Ruby project or some set of arbitrary Ruby source files.
+
+## Installation
+
+``` bash
+gem install loc_counter
+```
+
+## Usage
+
+The gem install a single executable `loc_counter`.
+
+### On a project
+
+If you want to count LOCs in your Rails app or in a gem, you can just pass a path to that project's directory to `loc_counter`:
+
+``` bash
+$ loc_counter /path/to/project
+48 files processed
+Total     1826 lines
+Empty     331 lines
+Comments  372 lines
+Code      1123 lines
+```
+
+In 'project mode' it scans `app`, `bin`, `config`, `lib` and top-level directories of your project, processing the following files:
+
+- `Capfile`
+- `Gemfile`
+- `Rakefile`
+- `*.gemspec`
+- `*.rake`
+- `*.rb`
+- `*` in `bin` directory
+
+### On arbitrary files
+
+You can also give `loc_counter` any files you want to measure.
+
+``` bash
+$ loc_counter ~/*.rb              
+5 files processed
+Total     118 lines
+Empty     27 lines
+Comments  4 lines
+Code      87 lines
+```
+
+## Contributing
+
+If you want to contribute to the project, fork the repository, push your changes to a topic branch and send me a pull request.
+
+`loc_counter` is tested under MRI `1.8.7`, `1.9.2` and `1.9.3`. If something is working incorrectly or not working at all in one of these environments, this should be considered a bug. Any bug reports are welcome at Github issues.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = '--color --format doc'
+end
+
+task :default => :spec

data/bin/loc_counter

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor/group'
+require 'active_support/inflector'
+require 'loc_counter'
+
+module LOCCounter
+  class CLI < Thor::Group
+    include Thor::Actions
+    
+    desc 'Scans the project or individual files for Ruby source files and outputs LOC counts.'
+    argument :paths, :type => :array
+    def project
+      if paths.empty?
+        # no arguments received
+        say 'No path was given'
+      elsif paths.count == 1 && File.directory?(paths.first)
+        # received one argument which is a directory path
+        print_results LOCCounter::Project.new(paths.first).counts
+      else
+        # received one or more file paths
+        print_results LOCCounter::FilesCollection.new(paths).counts
+      end
+    end
+    
+    def self.banner
+        "loc_counter /path/to/project             # scan the whole project\n" + 
+      "    or\n" + 
+      "  loc_counter /some/filename/mask/**/*.rb  # scan only specified files"
+    end
+  private
+    def print_results(counts)
+      # '46 files processed'
+      say pluralized_noun(counts.delete(:files), 'file') + ' processed'
+      
+      results = counts.map do |type, count|
+        type  = type.to_s.capitalize
+        count = pluralized_noun(count, 'line')
+        [type, count]
+      end
+      
+      print_table(results)
+    end
+    
+    # pluralized_noun(53, 'octopus') # => '53 octopi'
+    def pluralized_noun(number, noun)
+      "#{number} #{noun.pluralize(number)}"
+    end
+  end
+end
+
+LOCCounter::CLI.start

data/lib/loc_counter.rb

@@ -0,0 +1,8 @@
+require 'loc_counter/version'
+require 'loc_counter/source_file'
+require 'loc_counter/files_collection'
+require 'loc_counter/project'
+
+module LOCCounter
+  # Your code goes here...
+end

data/lib/loc_counter/files_collection.rb

@@ -0,0 +1,45 @@
+module LOCCounter
+  # A class representing a collection of arbitrary files.
+  class FilesCollection
+    # All parsed files in the collection.
+    # @return [Array]
+    attr_reader :files
+    
+    # Regexp for Ruby source file paths
+    RUBY_FILES = /((Cap|Gem|Rake)file|\.(gemspec|rake|rb)|bin\/\w+)$/
+    
+    # @param [Array] file_paths Paths to files being processed
+    def initialize(file_paths)
+      @files = []
+      file_paths.each do |path|
+        @files << SourceFile.new(path) if path =~ RUBY_FILES
+      end
+    end
+    
+    # Summarized line counts for all files in the collection.
+    # @example
+    #   project = LOCCounter::Project.new(path)
+    #   project.counts
+    #   # => {
+    #   #    :total => 1606,
+    #   #    :empty => 292,
+    #   # :comments => 360,
+    #   #     :code => 954,
+    #   #    :files => 43
+    #   # }
+    # @return [ActiveSupport::OrderedHash]
+    # @see LOCCounter::SourceFile#counts
+    def counts
+      total_counts = ActiveSupport::OrderedHash.new
+      [:total, :empty, :comments, :code].each { |type| total_counts[type] = 0 }
+      
+      @files.each do |file|
+        total_counts.keys.each do |type|
+          total_counts[type] += file.counts[type]
+        end
+      end
+      
+      total_counts.merge(:files => @files.count)
+    end
+  end
+end

data/lib/loc_counter/project.rb

@@ -0,0 +1,27 @@
+require 'active_support/ordered_hash'
+module LOCCounter
+  # A class representing a project.
+  class Project < FilesCollection
+    # Dir.glob patterns for project source code files paths
+    SOURCE_FILES = [
+      '*.{rb,gemspec}',
+      '{Cap,Gem,Rake}file',
+      'bin/*',
+      '{app,config,lib}/**/*.{gemspec,rake,rb}'
+    ]
+    
+    # @param [String] dir_name Path to the project directory
+    def initialize(dir_name)
+      raise ArgumentError, "Directory '#{dir_name}' not found" unless File.exists?(dir_name)
+      
+      @files = []
+      SOURCE_FILES.each do |pattern|
+        full_pattern = File.join(dir_name, pattern)
+        
+        @files += Dir.glob(full_pattern).map do |filename|
+          SourceFile.new(filename)
+        end
+      end
+    end
+  end
+end

data/lib/loc_counter/source_file.rb

@@ -0,0 +1,52 @@
+module LOCCounter
+  # A class representing a source code file.
+  class SourceFile
+    # All lines in a file.
+    # @return [Array]
+    attr_reader :lines
+    
+    # A regexp for empty lines
+    EMPTY_PATTERN   = /^\s*$/
+    # A regexp for lines containing just comments
+    COMMENT_PATTERN = /^\s*\#.*$/
+    
+    # @param [String] filename Full path to the file being processed
+    def initialize(filename)
+      raise ArgumentError, "File '#{filename}' not found" unless File.exists?(filename)
+      
+      @lines = File.readlines(filename)
+    end
+    
+    # Line counts broken by the line type.
+    # 
+    # Returns a hash with 4 elements:
+    # - :total is total line count
+    # - :empty is a number of empty lines
+    # - :comments is a number of lines containing only a comment
+    # - :code is a number of lines containing any code
+    # @return [Hash]
+    def counts
+      @counts ||= begin
+        counts = {
+          :total    => @lines.count,
+          :empty    => 0,
+          :comments => 0,
+          :code     => 0
+        }
+        
+        @lines.each do |line|
+          case line
+          when EMPTY_PATTERN
+            counts[:empty] += 1
+          when COMMENT_PATTERN
+            counts[:comments] += 1
+          else
+            counts[:code] += 1
+          end
+        end
+        
+        counts
+      end
+    end
+  end
+end

data/lib/loc_counter/version.rb

@@ -0,0 +1,3 @@
+module LOCCounter
+  VERSION = '0.1'
+end

data/loc_counter.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+$: << File.expand_path('../lib', __FILE__)
+require 'loc_counter/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'loc_counter'
+  s.version     = LOCCounter::VERSION
+  s.authors     = ['Vsevolod Romashov']
+  s.email       = ['7@7vn.ru']
+  s.homepage    = ''
+  s.summary     = 'CLI LOC counter for a Ruby project'
+  s.description = 'A simple line-of-code counter for Ruby projects'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'activesupport', '~> 3.0'
+  
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'rspec'
+end

data/spec/fixtures/test.rb

@@ -0,0 +1,7 @@
+First.line
+Second.line
+
+Some.new.line
+# a comment
+
+More.code # and a comment

data/spec/loc_counter/files_collection_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe LOCCounter::FilesCollection do
+  before(:each) do
+    stub_files
+    File.stub(:exists?).and_return(true)
+  end
+  
+  describe "#initialize" do
+    before(:each) do
+      @filename1.stub(:=~).and_return(true)
+      @filename2.stub(:=~).and_return(false)
+    end
+    
+    it "puts the filtered files list to @files" do
+      collection = LOCCounter::FilesCollection.new(@filenames)
+      collection.files.should == [@file1]
+    end
+  end
+  
+  describe "#counts" do
+    before(:each) do
+      @file1_counts = {
+        :total    => 5,
+        :empty    => 0,
+        :comments => 1,
+        :code     => 4
+      }
+      @file1.stub(:counts => @file1_counts)
+      
+      @file2_counts = {
+        :total    => 8,
+        :empty    => 1,
+        :comments => 2,
+        :code     => 5
+      }
+      @file2.stub(:counts => @file2_counts)
+    end
+    
+    it "sums line counts from all files and returns them in a hash" do
+      collection = LOCCounter::FilesCollection.new(@filenames)
+      collection.instance_variable_set(:@files, @files)
+      counts = collection.counts
+      
+      counts[:total].should     == @file1_counts[:total] + @file2_counts[:total]
+      counts[:empty].should     == @file1_counts[:empty] + @file2_counts[:empty]
+      counts[:comments].should  == @file1_counts[:comments] + @file2_counts[:comments]
+      counts[:code].should      == @file1_counts[:code] + @file2_counts[:code]
+      counts[:files].should     == @files.count
+    end
+  end
+end

data/spec/loc_counter/project_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe LOCCounter::Project do
+  before(:each) do
+    stub_files
+    @dir_path = '/path/to/project'
+  end
+  
+  describe "#initialize" do
+    context "with a non-existent directory" do
+      it "raises an ArgumentError" do
+        expect {
+          LOCCounter::Project.new('foo')
+        }.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "with an existing directory" do
+      before(:each) do
+        File.stub(:exists?).and_return(true)
+        Dir.stub(:glob).and_return(@filenames)
+      end
+      
+      it "puts the files list from Dir.glob to @files" do
+        Dir.should_receive(:glob).with(@dir_path + '/' + LOCCounter::Project::SOURCE_FILES.first)
+        project = LOCCounter::Project.new(@dir_path)
+        project.files.should == [@file1, @file2] * LOCCounter::Project::SOURCE_FILES.count
+      end
+    end
+  end
+end

data/spec/loc_counter/source_file_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe LOCCounter::SourceFile do
+  before(:each) do
+    path = File.expand_path('../../fixtures/test.rb', __FILE__)
+    @file = LOCCounter::SourceFile.new(path)
+  end
+  
+  describe "#initialize" do
+    before(:each) do
+      @filename = stub("Filename")
+      @lines = stub("Source lines")
+      File.stub(:readlines).and_return(@lines)
+    end
+    
+    context "with a non-existent file" do
+      it "raises an ArgumentError" do
+        expect {
+          LOCCounter::SourceFile.new('foo')
+        }.to raise_error(ArgumentError)
+      end
+    end
+    
+    context "with an existing file" do
+      before(:each) do
+        File.stub(:exists?).and_return(true)
+      end
+      
+      it "puts the result of File.readlines to @lines" do
+        File.should_receive(:readlines).with(@filename)
+        file = LOCCounter::SourceFile.new(@filename)
+        file.lines.should == @lines
+      end
+    end
+  end
+  
+  describe "#counts" do
+    before(:each) do
+      @counts = @file.counts
+      @lines  = @file.lines
+    end
+    
+    describe "[:total]" do
+      it "returns total lines count" do
+        @counts[:total].should == @lines.count
+      end
+    end
+    
+    describe "[:empty]" do
+      it "returns a number of empty lines" do
+        empty_lines = @lines.find_all do |line|
+          line =~ LOCCounter::SourceFile::EMPTY_PATTERN
+        end
+        
+        @counts[:empty].should == empty_lines.count
+      end
+    end
+    
+    describe "[:comments]" do
+      it "returns a number of lines containing just a comment" do
+        comments_lines = @lines.find_all do |line|
+          line =~ LOCCounter::SourceFile::COMMENT_PATTERN
+        end
+        
+        @counts[:comments].should == comments_lines.count
+      end
+    end
+    
+    describe "[:code]" do
+      it "returns a number of lines containing any code" do
+        code_lines = @lines.reject do |line|
+          line =~ LOCCounter::SourceFile::EMPTY_PATTERN || line =~ LOCCounter::SourceFile::COMMENT_PATTERN
+        end
+        
+        @counts[:code].should == code_lines.count
+      end
+    end
+  end
+end

data/spec/loc_counter_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe LOCCounter do
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'loc_counter'
+
+support_dir = File.expand_path('../support', __FILE__)
+Dir.glob("#{support_dir}/**/*.rb").each { |file| require file }
+
+RSpec.configure do |config|
+  config.include FilesCollectionHelpers
+end

data/spec/support/files_collection_helpers.rb

@@ -0,0 +1,19 @@
+module FilesCollectionHelpers
+  # setting filenames, files and LOCCounter::SourceFile.new
+  def stub_files
+    @filename1  = stub("First file name")
+    @filename2  = stub("Second file name")
+    @filenames  = [@filename1, @filename2]
+    
+    @file1 = stub("LOCCounter::SourceFile instance for filename1")
+    @file2 = stub("LOCCounter::SourceFile instance for filename2")
+    @files = [@file1, @file2]
+    
+    LOCCounter::SourceFile.stub(:new) do |filename|
+      case filename
+      when @filename1 then @file1
+      when @filename2 then @file2
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: loc_counter
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Vsevolod Romashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70252920255280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70252920255280
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70252920277240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70252920277240
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70252920276760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252920276760
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70252920276020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252920276020
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70252920274440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252920274440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70252920273520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70252920273520
+description: A simple line-of-code counter for Ruby projects
+email:
+- 7@7vn.ru
+executables:
+- loc_counter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/loc_counter
+- lib/loc_counter.rb
+- lib/loc_counter/files_collection.rb
+- lib/loc_counter/project.rb
+- lib/loc_counter/source_file.rb
+- lib/loc_counter/version.rb
+- loc_counter.gemspec
+- spec/fixtures/test.rb
+- spec/loc_counter/files_collection_spec.rb
+- spec/loc_counter/project_spec.rb
+- spec/loc_counter/source_file_spec.rb
+- spec/loc_counter_spec.rb
+- spec/spec_helper.rb
+- spec/support/files_collection_helpers.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2459367167302849776
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2459367167302849776
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: CLI LOC counter for a Ruby project
+test_files:
+- spec/fixtures/test.rb
+- spec/loc_counter/files_collection_spec.rb
+- spec/loc_counter/project_spec.rb
+- spec/loc_counter/source_file_spec.rb
+- spec/loc_counter_spec.rb
+- spec/spec_helper.rb
+- spec/support/files_collection_helpers.rb