code_counter 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bbdf015cdbbaabfcf13e4d1f92f3908faaa5f7d
+  data.tar.gz: d0c93d2c78986a80eb3334581c2695e9beaabe3c
+SHA512:
+  metadata.gz: 29fe7cbaae18b03c6e5b3f9dc7cb6737fb2d4d7c99843fd660485344a34a8d38b72d8eb8406018adf05f0e2b1b42fe4a3484e6c6949ffe5027324ac18e2ed233
+  data.tar.gz: 1bbeca19a84e7dab0dc55540d3d1a3cdadfacad602447e11ec3ef13a1a4d783a9554ff597a05e5c20f23b9d7096ec4c0565c5614117e47612e92beda45cecaea

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changes
+
+## v0.3.1
+
+* Add CodeClimate badge to `README.md`.
+* Correct email address in `README.md` and `code_statistics.gemspec`.
+* Switch to secure RubyGems URL.
+* Rename gem to `code_counter` so it can be published to RubyGems.
+* Improve documentation generation.
+* Remove use of `test-construct` in favor of simpler fixture directories.
+* Switch to `rspec`.
+* Begin adding tests for CLI.
+* Fix an uninitialized variable bug.
+* Paths listed in `ADDITIONAL_SOURCE_DIRECTORIES` don't need to be relative to
+  the current directory anymore.
+* Add support for `.rake` files.
+* Add support for files with arbitrary extensions in binary directories.
+* Make `bin`, `script`, and `scripts` be binary directories by default.
+* Add `ADDITIONAL_BINARY_DIRECTORIES` var for adding binary directory mappings
+  to the CLI.
+
+
+## v0.3.0
+
+* Modernize project to work well with newer Rake, and in the world of Bundler.
+* Formalize development environment, and fix broken tasks.
+* Don't leave file handles open needlessly.
+* Make all path additions recursive.  (Incl. allowing more-specific
+  definitions earlier on to override definitions later on...)
+* Allow specifying multiple paths to be grouped into one line item.
+* Normalized mechanism for configuring things.
+* Substantially simplify code.
+* Add a proper changelog.
+* Don't add development-dependencies to gem; let people use `git clone` for
+  that.
+* Improve Cucumber support by treating `Given`/`When`/`Then` matcher blocks as
+  methods.  (Analogous to how `should`/`it` methods were already treated.)
+* Reduce namespace pollution in both `rake` task namespace, and Ruby global
+  namespace.
+
+
+## v0.2.13
+
+* Initial fork from devver's repo.

data/LICENSE.md

@@ -0,0 +1,28 @@
+# License
+
+## Ownership
+
+* Copyright (c) 2009, 2010 Devver
+* Copyright (c) 2012 Cloudability Inc
+* Copyright (c) 2014 Jon Frisby
+
+## The MIT License
+
+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/README.md

@@ -0,0 +1,116 @@
+# code_counter
+
+[![Code Climate](https://codeclimate.com/github/MrJoy/code_statistics.png)](https://codeclimate.com/github/MrJoy/code_statistics)
+[![Coverage](https://codeclimate.com/github/MrJoy/code_statistics/coverage.png)](https://codeclimate.com/github/MrJoy/code_statistics)
+
+This started as an extraction of the Rails `rake stat` task, so it could be
+used on non-Rails projects and have it's features slowly expanded.
+
+Improvements include:
+
+* Support for RSpec and Cucumber out of the box.
+* Includes `.rake` files.
+* Includes scripts (by default, in `bin/`, `script/`, and `scripts/`) with no
+  extension, provided they have a shebang line.
+
+
+## Requirements
+
+This project requires Ruby 1.9.x or higher.
+
+
+## Usage
+
+### Rake
+
+Add this to the bottom of your `Rakefile`:
+
+```ruby
+require 'code_counter'
+```
+
+Then, when you run `rake -T` you'll see a stats task, unless you already had
+one defined.  If you have an existing task named `stats`, and want to use this
+one, simply make a task of a new name that depends on the `code_counter`
+task, like so:
+
+```ruby
+task :new_stats => :code_counter
+```
+
+To configure the task:
+
+```ruby
+task :stats_configuration do
+  CodeCounter::Engine.clear!
+  CodeCounter::Engine.init!
+
+  # By default, this will recursively add the specified path, and only look for
+  # files ending in `.rb`, `.rake`, or `.feature`.
+  CodeCounter::Engine.add_path("Some Group", "some/path")
+
+  # Don't add recursively:
+  CodeCounter::Engine.add_path("Some Group", "other/path", false)
+
+  # Add recursively, and don't filter by file extension:
+  CodeCounter::Engine.add_path("Some Group", "my/script/dir", true, true)
+end
+
+# Add a dependency on our config task here so that our config gets loaded when
+# we run `rake stats`.
+task :code_counter => :stats_configuration
+```
+
+
+### CLI
+
+```bash
+code_counter
+```
+
+Additionally, you can configure things using some environment variables:
+
+* `ADDITIONAL_SOURCE_DIRECTORIES`: A comma-separated list of directories to
+  scan for source files.  You may assign a directory to a named group by
+  prefixing the path with a group name and colon.  E.G. `ADDITIONAL_SOURCE_DIRECTORIES='Libraries:my_awesome_code'`
+* `ADDITIONAL_BINARY_DIRECTORIES`: A comma-separated list of directories to
+  scan for binaries.  You may assign a directory to a named group by prefixing
+  the path with a group name and colon.  E.G. `ADDITIONAL_BINARY_DIRECTORIES='Binaries:my_awesome_scripts'`
+* `IGNORE_FILE_GLOBS`: A comma-separated list of file globs to ignore.
+
+
+## TODOs
+
+* make bin accept passed cmd line arguments to run
+* stop relying on ENV vars
+* count number of total files
+* count number of of .rb or passed in filter files
+* find todo, perf, bug, hack, etc comments and display them with info about
+  them (line number etc)
+* reduce duplication between bin and task
+* comments:code ratio
+* support for more languages
+    * JS
+    * CoffeeScript
+* don't accidentally count __actual__ binaries
+* Include `Rakefile*` in analysis
+
+[jfrisby@mrjoy.com](mailto:jfrisby@mrjoy.com)
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version
+  unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have
+  your own version, that is fine but bump version in a commit by itself I can
+  ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+## Copyright
+
+Distributed under the MIT license.  See LICENSE.md for details, including
+authorship/ownership.

data/bin/code_counter

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+require File.expand_path('../../lib/code_counter/engine', __FILE__)
+require File.expand_path('../../lib/code_counter/cli', __FILE__)
+
+(ENV['ADDITIONAL_SOURCE_DIRECTORIES'] || '').split(',').each do |dir|
+  (path, label) = CodeCounter::CLI.expand_labeled_path(dir)
+  CodeCounter::Engine.add_path(label, path, true, false)
+end
+
+(ENV['ADDITIONAL_BINARY_DIRECTORIES'] || '').split(',').each do |dir|
+  (path, label) = CodeCounter::CLI.expand_labeled_path(dir)
+  CodeCounter::Engine.add_path(label, path, true, true)
+end
+
+user_ignored_globs = (ENV['IGNORE_FILE_GLOBS'] || '').split(',')
+
+puts CodeCounter::Engine.new(user_ignored_globs).to_s

data/code_counter.gemspec

@@ -0,0 +1,41 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: code_counter 0.3.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "code_counter"
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jon Frisby", "Dan Mayer"]
+  s.date = "2014-06-06"
+  s.description = "This is a port of the rails 'rake stats' method so it can be made more robust and work for non rails projects. New features may eventually be added as well."
+  s.email = "jfrisby@mrjoy.com"
+  s.executables = ["code_counter"]
+  s.extra_rdoc_files = [
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md",
+    "bin/code_counter",
+    "code_counter.gemspec",
+    "lib/code_counter.rb",
+    "lib/code_counter/cli.rb",
+    "lib/code_counter/engine.rb",
+    "lib/code_counter/rake.rb",
+    "lib/code_counter/version.rb"
+  ]
+  s.homepage = "http://github.com/MrJoy/code_counter"
+  s.licenses = ["MIT"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+  s.rubygems_version = "2.2.2"
+  s.summary = "Making a gem of the normal rails rake stats method, to make it more robust and work on non rails projects"
+end
+

data/lib/code_counter.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'code_counter', 'version')
+require File.join(File.dirname(__FILE__), 'code_counter', 'engine')
+require File.join(File.dirname(__FILE__), 'code_counter', 'rake')

data/lib/code_counter/cli.rb

@@ -0,0 +1,14 @@
+module CodeCounter
+  class CLI
+    def self.expand_labeled_path(dir_with_label)
+      components = dir_with_label.split(/\s*:\s*/)
+      if components.length > 1
+        (label, path) = *components
+      else
+        label = path = components.first
+      end
+
+      return [Pathname.new(path).expand_path.to_s, label]
+    end
+  end
+end

data/lib/code_counter/engine.rb

@@ -0,0 +1,237 @@
+require 'set'
+
+module CodeCounter
+  class Engine
+    BIN_DIRECTORIES = Set.new
+    STATS_DIRECTORIES = []
+    TEST_TYPES = Set.new
+
+    ###########################################################################
+    # Mechanisms for configuring the behavior of this tool
+    ###########################################################################
+    def self.clear!
+      BIN_DIRECTORIES.clear
+      STATS_DIRECTORIES.clear
+      TEST_TYPES.clear
+    end
+
+    def self.add_path(key, directory, recursive=true, is_bin_dir=false)
+      directory = File.expand_path(directory)
+      if File.directory?(directory)
+        STATS_DIRECTORIES << [key, directory]
+        BIN_DIRECTORIES << directory if is_bin_dir
+        if(recursive)
+          Dir.entries(directory).
+            reject { |dirent| dirent =~ /^\.\.?$/ }.
+            map { |dirent| File.join(directory, dirent) }.
+            reject { |dirent| !File.directory?(dirent) }.
+            each { |dirent| add_path(key, dirent, recursive, is_bin_dir) }
+        end
+      end
+    end
+
+    def self.add_test_group(key)
+      TEST_TYPES << key
+    end
+
+
+    ###########################################################################
+    # Default configuration
+    ###########################################################################
+    def self.init!
+      add_path("Controllers", "app/controllers")
+      add_path("Mailers", "app/mailers")
+      add_path("Models", "app/models")
+      add_path("Views", "app/views")
+      add_path("Helpers", "app/helpers")
+      add_path("Binaries", "bin", true, true)
+      add_path("Binaries", "script", true, true)
+      add_path("Binaries", "scripts", true, true)
+      add_path("Libraries", "lib")
+      add_path("Source", "source")
+      add_path("Source", "src")
+      add_path("Unit tests", "test")
+      add_path("RSpec specs", "spec")
+      add_path("Features", "features")
+
+      add_test_group("Unit tests")
+      add_test_group("RSpec specs")
+      add_test_group("Features")
+    end
+    init!
+
+
+    ###########################################################################
+    # Internals
+    ###########################################################################
+    FILTER = /.*\.(rb|feature|rake)$/
+    attr_reader :print_buffer
+
+    def initialize(ignore_file_globs = [])
+      @bin_dirs     = BIN_DIRECTORIES.dup
+      @pairs        = STATS_DIRECTORIES.select { |pair| File.directory?(pair[1]) }
+      @print_buffer = ""
+      @ignore_files = collect_files_to_ignore(ignore_file_globs)
+
+      @pairs = coalesce_pairs(@pairs)
+
+      @statistics  = calculate_statistics
+      @total       = (@pairs.length > 1) ? calculate_total : nil
+    end
+
+    def coalesce_pairs(pairs)
+      groups = {}
+      paths_seen = {}
+      pairs.each do |pair|
+        next if(paths_seen[pair.last])
+        paths_seen[pair.last] = true
+        (groups[pair.first] ||= Set.new) << pair.last
+      end
+      return groups
+    end
+
+    def collect_files_to_ignore(ignore_file_globs)
+      files_to_remove = []
+      ignore_file_globs.each do |glob|
+        files_to_remove.concat(Dir[glob])
+      end
+      files_to_remove.map { |filepath| File.expand_path(filepath) }
+    end
+
+    def to_s
+      @print_buffer = ''
+      print_header
+      @pairs.each { |pair| print_line(pair.first, @statistics[pair.first]) }
+      print_splitter
+
+      if @total
+        print_line("Total", @total)
+        print_splitter
+      end
+
+      print_code_test_stats
+      @print_buffer
+    end
+
+    private
+
+    def calculate_statistics
+      @pairs.inject({}) { |stats, pair| stats[pair.first] = calculate_group_statistics(pair.last); stats }
+    end
+
+    def ignore_file?(file_path)
+      @ignore_files.include?(file_path)
+    end
+
+    def calculate_group_statistics(directories, pattern = FILTER)
+      stats = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
+
+      directories.each do |directory|
+        Dir.foreach(directory) do |file_name|
+          next if file_name =~ /\A\.\.?\Z/
+          is_expected_ext = file_name =~ pattern
+          next unless @bin_dirs.include?(directory) || is_expected_ext
+          file_path = File.expand_path(File.join(directory, file_name))
+          next if ignore_file?(file_path)
+
+          # First, check if a file with an unknown extension is binary...
+          next unless is_expected_ext || is_shell_program?(file_path)
+
+          # Now, go ahead and analyze the file.
+          File.open(file_path) do |fh|
+            while line = fh.gets
+              stats["lines"] += 1
+              stats["classes"] += 1 if line =~ /class [A-Z]/
+              stats["methods"] += 1 if line =~ /(def [a-z]|should .* do|test .* do|it .* do|(Given|When|Then) .* do)/
+              stats["codelines"] += 1 unless line =~ /^\s*$/ || line =~ /^\s*#/
+            end
+          end
+        end
+      end
+
+      return stats
+    end
+
+    def is_shell_program?(path)
+      magic_word = File.open(path, "r", { :encoding => "ASCII-8BIT" }) do |fh|
+        fh.read(2)
+      end
+      return magic_word == '#!'
+    end
+
+    def calculate_total
+      total = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
+      @statistics.each_value { |pair| pair.each { |k, v| total[k] += v } }
+      total
+    end
+
+    def calculate_code
+      calculate_type(false)
+    end
+
+    def calculate_tests
+      calculate_type(true)
+    end
+
+    def calculate_type(test_match)
+      type_loc = 0
+      @statistics.each { |k, v| type_loc += v['codelines'] if TEST_TYPES.include?(k)==test_match }
+      type_loc
+    end
+
+    COL_WIDTHS      = [[22,-1], [7,1], [7,1], [9,1], [9,1], [5,1], [7,1]]
+    HEADER_PATTERN  = '|' + COL_WIDTHS.map { |(w,_)| "%-#{w}s" }.join('|') + "|\n"
+    ROW_PATTERN     = '|' + COL_WIDTHS.map { |(w,d)| "%#{w*d}s" }.join('|') + "|\n"
+    HEADERS         = ['Name', 'Lines', 'LOC', 'Classes', 'Methods', 'M/C', 'LOC/M']
+    SPLITTER        = HEADER_PATTERN % COL_WIDTHS.map { |(w,_)| '-' * w }
+
+    def pad_elements(list)
+      return list.map { |e| " #{e} " }
+    end
+
+    def print_header
+      print_splitter
+      @print_buffer << HEADER_PATTERN % pad_elements(HEADERS)
+      print_splitter
+    end
+
+    def print_splitter
+      @print_buffer << SPLITTER
+    end
+
+    def x_over_y(top, bottom)
+      return (bottom > 0) ? (top / bottom) : 0
+    end
+
+    def print_line(name, stats)
+      return if stats['lines'] == 0
+
+      # Ugly hack for subtracting out class/end.  >.<
+      loc_over_m  = x_over_y(stats["codelines"], stats["methods"])
+      loc_over_m -= 2 if loc_over_m >= 2
+
+      @print_buffer << ROW_PATTERN % pad_elements([
+        name,
+        stats['lines'],
+        stats['codelines'],
+        stats['classes'],
+        stats['methods'],
+        x_over_y(stats["methods"], stats["classes"]),
+        loc_over_m,
+      ])
+    end
+
+    def print_code_test_stats
+      code = calculate_code
+      tests = calculate_tests
+
+      ratio = if code!=0
+        "#{sprintf("%.1f", tests.to_f/code)}"
+      else
+        "0.0"
+      end
+      @print_buffer << " Code LOC: #{code}  Test LOC: #{tests}  Code to Test Ratio: 1:#{ratio}\n"
+      @print_buffer << "\n"
+    end
+  end
+end

data/lib/code_counter/rake.rb

@@ -0,0 +1,17 @@
+# This is for apps that already had a stats task, but want to use the newer
+# features of this gem.
+if(defined?(Rake::Task))
+  task :code_counter do
+    if ENV['IGNORE_FILE_GLOBS']
+      user_ignored_dirs = ENV['IGNORE_FILE_GLOBS'].split(',')
+    else
+      user_ignored_dirs = []
+    end
+    puts CodeCounter::Engine(user_ignored_dirs).to_s
+  end
+
+  unless(Rake::Task.task_defined?(:stats))
+    desc "Report code statistics (KLOCs, etc) from the application."
+    task :stats => :code_counter
+  end
+end

data/lib/code_counter/version.rb

@@ -0,0 +1,3 @@
+module CodeCounter
+  VERSION='0.3.1'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: code_counter
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Jon Frisby
+- Dan Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 00:00:00.000000000 Z
+dependencies: []
+description: This is a port of the rails 'rake stats' method so it can be made more
+  robust and work for non rails projects. New features may eventually be added as
+  well.
+email: jfrisby@mrjoy.com
+executables:
+- code_counter
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- bin/code_counter
+- code_counter.gemspec
+- lib/code_counter.rb
+- lib/code_counter/cli.rb
+- lib/code_counter/engine.rb
+- lib/code_counter/rake.rb
+- lib/code_counter/version.rb
+homepage: http://github.com/MrJoy/code_counter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Making a gem of the normal rails rake stats method, to make it more robust
+  and work on non rails projects
+test_files: []