coco 0.8 → 0.9

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3e417f05d79b2e611dceda9c526600d5a327e440
-  data.tar.gz: a78c5a379014dd5e2b6aee98eda621f9377dbf18
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTg5MjFhOTYwMDMxYWE4YzNkMzc2YjdjN2EyOGZjMWE4MmE0NDNiMQ==
+  data.tar.gz: !binary |-
+    ODNkODRiOWU0ZTgwNWIzNjA1MDU0M2U4NWE0MTYyZmNjYWE1ZmRkYg==
 SHA512:
-  metadata.gz: df9305b624eb92c01202cafece504f88db6823e1748e7b279330c0600ea2bd7290bdaf165472c426415f4c235d492e46ce04403a8169ba98d0326270599c0537
-  data.tar.gz: 7ebd0be73e14fb5bc5be32fca2478e031aa888b2e5355436010fc48025b105ad81c18f813dc92b57204c7ec7793f969ca8a201f656a63d3f6fb46313fdc76e29
+  metadata.gz: !binary |-
+    ZjhmMGFiNGJkYWM3Zjc4NjE4NWQzZTBiY2M1NjhlMmI5MjEwOGY5MDg4NWE2
+    YTM5N2IxNjY2MzBiNTE4MTNmNDEwMGMwZDJhNjVjNDY0MjI4ZTk1ODAwYzZl
+    Njc1OGVjZmU2YmQ5MGRmMDhjNjhmODQ4MDJiZGU0NGNmMzMzZDA=
+  data.tar.gz: !binary |-
+    MDVkNTcyOTA4NjkzN2JjNTlkZjFiMjIyNTMzOGVkN2JlMDQ2MGM1ZjBkN2M1
+    MTAwMmM2NmZhMmJjYTQ5Yzg4MTkwODY3NjZkYTllMDY1MjkxODc4MWE5ZGYz
+    NmFiZWFkNzU1MDAxNTBjNjk4ZTgzOWNiODA1NTVhNGRmNDdmMTE=

data/Changelog.markdown

@@ -1,3 +1,15 @@
+v0.9  (2014-02-02)
+=================================================
+
+* New configuration option: `always_run`, to control when to start coco
+  and when to not start it.
++ ajouter link dans le terminal
+* New configuration option: `show_link_in_terminal`, to display the
+  report's index page URI in the terminal.
+* Partially converts developer's documentation in tomdoc format.
+* Update gemspec for ruby version 2.1
+
+
 v0.8  (2013-12-21)
 =================================================
 

data/Gemfile

@@ -2,5 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
+gem 'rake', '>= 10.1.0'
 gem 'rspec'

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    coco (0.8)
+    coco (0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
-    rake (10.0.4)
+    rake (10.1.1)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -22,5 +22,5 @@ PLATFORMS
 
 DEPENDENCIES
   coco!
-  rake
+  rake (>= 10.1.0)
   rspec

data/README.markdown

@@ -1,7 +1,7 @@
 coco [![Build Status](https://travis-ci.org/lkdjiin/coco.png)](https://travis-ci.org/lkdjiin/coco) [![Gem Version](https://badge.fury.io/rb/coco.png)](http://badge.fury.io/rb/coco)
 ==============================
 
-Code coverage tool for ruby 1.9.2, 1.9.3 and 2.0.
+Code coverage tool for ruby 1.9.2, 1.9.3, 2.0 and 2.1.
 
 Features
 --------------------------------
@@ -82,6 +82,62 @@ to not put any leading spaces or tab at all._
 
 See [more examples](https://github.com/lkdjiin/coco/wiki) on the wiki.
 
+Advanced configuration
+---------------------------------
+
+### When to start coco, and when not to start it
+For projects whose complete test suite runs in a matter of seconds,
+running code coverage with every test is fine.
+But when the test suite takes longer to complete, we typically start to
+run a single test more often than the complete suite. In such cases,
+the behavior of **coco** could be really annoying: you run a single
+test and **coco** reports a infinite list of uncovered files. The
+problem here is this is a lie. To avoid this behavior, I recommend to
+run code coverage only from time to time, and with the entire test
+suite. To do so, **coco** provide the following configuration key:
+
+__always_run__: If true, **coco** will run every time you start a test.
+If false, **coco** will run only when you explicitly set an
+environement variable named `COCO` with something other than `false`,
+`0` or the empty string.
+
+#### Example
+
+Put this in your `.coco.yml` configuration file:
+
+    :always_run: false
+
+Now, when you run:
+
+    rspec spec/
+
+**coco** will no start. To start it, you have to set the
+environement variable `COCO`, like this:
+
+    COCO=1 rspec spec/
+
+### Index page URI in your terminal
+
+If your terminal supports opening an URI with a double-clic (or any
+other method), you may want to display the URI of the report's index
+page. For that, you have to set the __show_link_in_terminal__ key.
+
+#### Example
+
+Put this in your `.coco.yml` configuration file:
+
+    :show_link_in_terminal: true
+
+Now, when running tests, you will see something like the following:
+
+    $ rspec spec
+    .............
+    [...]
+
+    97% /path/to/bad/tested/file.rb
+    See file:///path/to/your/coverage/index.html
+
+
 Dependencies
 --------------------------------
 

data/TODO

@@ -1,3 +1,18 @@
++ option pour lancer coco si présence d'une variable d'environement
++ doc dev
++ doc readme & examples (maybe wiki ?)
++ manual tests
+
++ update gemspec -> add ruby version 2.1
+
++ ajouter link dans le terminal
++ option on/off
++ doc readme
+
+- add 'How to contribute' section
+
+- translate dev's doc into tomdoc format.
+
 en gras: def, class, module
 
 exclure spec et test par défaut

data/VERSION

@@ -1 +1 @@
-0.8
+0.9

data/lib/coco.rb

@@ -17,17 +17,21 @@ Coverage.start
 
 at_exit do
   config = Coco::Configuration.new
-  result = Coco::CoverageResult.new(config, Coverage.result)
-  covered = result.covered_from_domain
-  
-  sources = Coco::SourceLister.new(config).list
-  uncovered = Coco::UncoveredLister.new(sources, result.all_from_domain).list
-  
-  puts Coco::ConsoleFormatter.new(covered, uncovered).format(config[:single_line_report])
-  
-  html_files = Coco::HtmlFormatter.new(covered).format
-  Coco::HtmlFilesWriter.new(html_files).write
-  
-  index = Coco::HtmlIndexFormatter.new(covered, uncovered).format
-  Coco::HtmlIndexWriter.new(index).write
+  if config.user_wants_to_run?
+    result = Coco::CoverageResult.new(config, Coverage.result)
+    covered = result.covered_from_domain
+
+    sources = Coco::SourceLister.new(config).list
+    uncovered = Coco::UncoveredLister.new(sources, result.all_from_domain).list
+
+    cf = Coco::ConsoleFormatter.new(covered, uncovered)
+    puts cf.format(config[:single_line_report])
+    puts cf.link if config[:show_link_in_terminal]
+
+    html_files = Coco::HtmlFormatter.new(covered).format
+    Coco::HtmlFilesWriter.new(html_files).write
+
+    index = Coco::HtmlIndexFormatter.new(covered, uncovered).format
+    Coco::HtmlIndexWriter.new(index).write
+  end
 end

data/lib/coco/configuration.rb

@@ -4,31 +4,35 @@ require 'yaml'
 
 module Coco
 
-  # I know the configuration of coco.
+  # Public: I know the configuration of coco.
+  # You can override the default configuration by putting a '.coco.yml'
+  # file in YAML format in the project root directory.
   #
-  # @example read the threshold value
+  # Examples
+  #
+  #   # Read the threshold value
   #   config = Configuration.new
   #   config[:threshold]
-  #   => 90
+  #   # => 100
   #
-  # You can override the default configuration by putting a '.coco' file 
-  # in YAML format in the project root directory.
-  # @example to override the threshold put this line in a '.coco' file:
-  #   :threshold: 70
+  #   # To override the threshold, put this line in '.coco.yml' file:
+  #   # :threshold: 70
   #
-  # @note You can set the threshold above 100% (to be sure to see all files) but you
-  #   cannot set it under 0.
+  # Note you can set the threshold above 100% (to be sure to see all
+  # files) but you cannot set it under 0.
   class Configuration < Hash
-  
+
+    # Public: Initialize a Configuration.
     def initialize
       self[:threshold] = 100
       self[:directories] = ['lib']
       self[:excludes] = []
       self[:single_line_report] = false
+      self[:always_run] = true
+      self[:show_link_in_terminal] = false
       if File.exist?('.coco.yml')
         self.merge!(YAML.load_file('.coco.yml'))
-      # Deprecated: Support of '.coco' file will be remove in a future
-      # version.
+      # Deprecated: Support of '.coco' file will be removed in v1.0.
       elsif File.exist?('.coco')
         self.merge!(YAML.load_file('.coco'))
       end
@@ -37,19 +41,39 @@ module Coco
       expand_directories
       remove_directories
     end
-    
+
+    # Public: Code coverage not have to run with every test/spec runs.
+    #
+    # Here are the rules:
+    # If the configuration key :always_run is set to true, we always
+    # run the coverage.
+    # In case the configuration key :always_run is set to false, we have
+    # to check for an environement variable named 'COCO' to decide if
+    # we launch the coverage or not. When 'COCO' doesn't exist, or is
+    # the empty string, or '0', or 'false', we don't run coverage.
+    # When 'COCO' is set to any other value, we start coverage.
+    #
+    # Returns true if coverage should start.
+    def user_wants_to_run?
+      if self[:always_run]
+        true
+      else
+        ![nil, '', '0', 'false'].include?(ENV['COCO'])
+      end
+    end
+
     private
-    
+
     def expand_directories
       self[:excludes].each do |file_or_dir|
         add_files file_or_dir if File.directory?(file_or_dir)
       end
     end
-    
+
     def add_files dir
       Helpers.rb_files_from(dir).each {|file| self[:excludes] << file }
     end
-    
+
     def remove_directories
       self[:excludes].delete_if {|file_or_dir| File.directory?(file_or_dir)}
     end
@@ -57,7 +81,7 @@ module Coco
     def ensure_threeshold_compatibility
       self[:threshold] = self[:threeshold] unless self[:threeshold].nil?
     end
-    
+
   end
-  
+
 end

data/lib/coco/cover/coverage_result.rb

@@ -2,17 +2,24 @@
 
 module Coco
 
-  # Compute results of interest from the big results information (from Coverage.result)
+  # Compute results of interest from the big results information (from
+  # Coverage.result)
   class CoverageResult
-    # @return [Hash] Coverage for all the sources that live in the root project folder.
+
+    # Returns a Hash coverage for all the sources that live in the root
+    # project folder.
     attr_reader :all_from_domain
-    # @return [Hash] Coverage for sources that are not sufficiently covered.
-    #   More technically, the sources that live in the root project folder and for
-    #   which the coverage percentage is under the threshold. 
+
+    # Returns a Hash coverage for sources that are not sufficiently
+    # covered. More technically, the sources that live in the root
+    # project folder and for which the coverage percentage is under the
+    # threshold. 
     attr_reader :covered_from_domain
   
-    # @param [Hash] config
-    # @param [Hash] raw_results Results obtained from Coverage.result
+    # Public: Initialize a CoverageResult.
+    #
+    # config      - Hash
+    # raw_results - Hash results obtained from Coverage.result.
     def initialize config, raw_results
       @exclude_files = config[:excludes]
       @threshold = config[:threshold]

data/lib/coco/formatter/console_formatter.rb

@@ -8,7 +8,7 @@ module Coco
     # @param [Boolean] single_line_report
     #
     # return [string] percent covered and associated filenames
-    def format single_line_report = false
+    def format(single_line_report = false)
       if single_line_report
         single_line_message
       else
@@ -16,6 +16,15 @@ module Coco
       end
     end
 
+    # Returns String.
+    def link
+      unless @formatted_output.empty?
+        "See file://" +
+          File.expand_path(File.join(Coco::HtmlDirectory.new.coverage_dir,
+                                     'index.html'))
+      end
+    end
+
     # @param [Hash] covered
     # @param [Array] uncovered
     def initialize covered, uncovered

data/lib/coco/helpers.rb

@@ -2,43 +2,59 @@
 
 module Coco
 
-  # @todo The app is full of <tt>Dir.pwd</tt>. This is the root project directory
-  #   and must be in Configuration class (or Coco module ?).
+  # Public: Collection of application's helpers methods.
+  #
+  # TODO The app is full of `Dir.pwd`. This is the root project
+  # directory and must be in Configuration class (or Coco module ?).
   module Helpers
-  
-    # Get html filename (from a ruby filename) suitable for the coverage
-    # directory.
-    #
-    # @example
-    #   ruby = '/home/user/my_project/lib/source.rb'
-    #   html = Helpers.rb2html(ruby)
-    #   => '_lib_source.rb.html'
-    #
-    # @param [String] name Ruby filename
-    # @return [String] Html filename
-    def Helpers.rb2html name
-      name.sub(Dir.pwd, '').tr('/\\', '_') + '.html'
-    end
-    
-    # @return [String] The title of the index.html file
-    def Helpers.index_title
-      project_name = File.basename(Dir.pwd)
-      version = File.read(File.join($COCO_PATH, 'VERSION')).strip
-      "#{project_name} - Code coverage (coco #{version})"
-    end
-    
-    # @param [Array<String>] files List of filenames
-    # @return [Array<String>]
-    def Helpers.expand files
-      files.map {|file| File.expand_path file}
-    end
-    
-    # @return [Array<String>] The list of ruby source files from +directory+. Recursive.
-    def Helpers.rb_files_from directory
-      rb_files = File.join(directory, "**", "*.rb")
-      Dir.glob(rb_files)
+    class << self
+
+      # Public: Get html filename (from a ruby filename) suitable for
+      # the coverage directory.
+      #
+      # name - String full path filename.
+      #
+      # Examples
+      #
+      #   ruby = '/home/user/my_project/lib/source.rb'
+      #   html = Helpers.rb2html(ruby)
+      #   #=> '_lib_source.rb.html'
+      #
+      # Returns String HTML filename.
+      def rb2html name
+        name.sub(Dir.pwd, '').tr('/\\', '_') + '.html'
+      end
+
+      # Public: Get page title for the index.html file.
+      #
+      # Returns String.
+      def index_title
+        project_name = File.basename(Dir.pwd)
+        version = File.read(File.join($COCO_PATH, 'VERSION')).strip
+        "#{project_name} - Code coverage (coco #{version})"
+      end
+
+      # Public: Expands a bulk of filenames into full path filenames.
+      #
+      # files - List of filenames as an Array of String.
+      #
+      # Returns an Array of String.
+      def expand files
+        files.map {|file| File.expand_path file}
+      end
+
+      # Public: Get all ruby files from a directory, including
+      # sub-directories.
+      #
+      # directory - String directory to look into.
+      #
+      # Returns an Array of String.
+      def rb_files_from directory
+        rb_files = File.join(directory, "**", "*.rb")
+        Dir.glob(rb_files)
+      end
     end
-    
+
   end
-  
+
 end

metadata

@@ -1,62 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: coco
 version: !ruby/object:Gem::Version
-  version: '0.8'
+  version: '0.9'
 platform: ruby
 authors:
 - Xavier Nayrac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-21 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  "Code coverage tool for ruby 1.9.2 to 2.0.
-  Use it by "require 'coco'" from rspec or unit/test.
+description: ! '"Code coverage tool for ruby 1.9.2 to 2.1.
+
+  Use it by "require ''coco''" from rspec or unit/test.
+
   It display names of uncovered files on console.
+
   It builds simple html report.
+
   It reports sources that have no tests.
-  It's configurable with a simple yaml file.
+
+  It''s configurable with a simple yaml file.'
 email: xavier.nayrac@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/coco.rb
+- lib/coco/writer.rb
+- lib/coco/lister/uncovered_lister.rb
+- lib/coco/lister/source_lister.rb
+- lib/coco/lister.rb
 - lib/coco/configuration.rb
-- lib/coco/cover.rb
-- lib/coco/cover/coverage_result.rb
-- lib/coco/cover/coverage_stat.rb
-- lib/coco/formatter.rb
-- lib/coco/formatter/colored_string.rb
 - lib/coco/formatter/console_formatter.rb
+- lib/coco/formatter/template.rb
 - lib/coco/formatter/context.rb
+- lib/coco/formatter/colored_string.rb
+- lib/coco/formatter/html_index_formatter.rb
 - lib/coco/formatter/formatter.rb
 - lib/coco/formatter/html_formatter.rb
-- lib/coco/formatter/html_index_formatter.rb
-- lib/coco/formatter/template.rb
+- lib/coco/cover.rb
 - lib/coco/helpers.rb
-- lib/coco/lister.rb
-- lib/coco/lister/source_lister.rb
-- lib/coco/lister/uncovered_lister.rb
-- lib/coco/writer.rb
+- lib/coco/cover/coverage_result.rb
+- lib/coco/cover/coverage_stat.rb
 - lib/coco/writer/file_writer.rb
-- lib/coco/writer/html_directory.rb
 - lib/coco/writer/html_files_writer.rb
+- lib/coco/writer/html_directory.rb
 - lib/coco/writer/html_index_writer.rb
-- template/css/coco.css
+- lib/coco/formatter.rb
 - template/file.erb
-- template/img/coconut16.png
-- template/img/licenses
 - template/index.erb
+- template/css/coco.css
+- template/img/licenses
+- template/img/coconut16.png
+- VERSION
 - COPYING
+- README.markdown
 - Changelog.markdown
 - Gemfile
-- Gemfile.lock
-- README.markdown
 - Rakefile
 - TODO
-- VERSION
+- Gemfile.lock
 homepage: http://lkdjiin.github.com/coco/
 licenses:
 - GPL-3
@@ -67,12 +71,12 @@ 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: []
@@ -80,5 +84,5 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Code coverage tool for ruby 1.9.2 to 2.0
+summary: Code coverage tool for ruby 1.9.2 to 2.1
 test_files: []