coco 0.9 → 0.10.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTg5MjFhOTYwMDMxYWE4YzNkMzc2YjdjN2EyOGZjMWE4MmE0NDNiMQ==
-  data.tar.gz: !binary |-
-    ODNkODRiOWU0ZTgwNWIzNjA1MDU0M2U4NWE0MTYyZmNjYWE1ZmRkYg==
+SHA1:
+  metadata.gz: 2a95f8e7a9b475c43d6a2af585819051272e62f5
+  data.tar.gz: 44d95676351a0d9ce9d6c2a2c1ffc8c6249bfccc
 SHA512:
-  metadata.gz: !binary |-
-    ZjhmMGFiNGJkYWM3Zjc4NjE4NWQzZTBiY2M1NjhlMmI5MjEwOGY5MDg4NWE2
-    YTM5N2IxNjY2MzBiNTE4MTNmNDEwMGMwZDJhNjVjNDY0MjI4ZTk1ODAwYzZl
-    Njc1OGVjZmU2YmQ5MGRmMDhjNjhmODQ4MDJiZGU0NGNmMzMzZDA=
-  data.tar.gz: !binary |-
-    MDVkNTcyOTA4NjkzN2JjNTlkZjFiMjIyNTMzOGVkN2JlMDQ2MGM1ZjBkN2M1
-    MTAwMmM2NmZhMmJjYTQ5Yzg4MTkwODY3NjZkYTllMDY1MjkxODc4MWE5ZGYz
-    NmFiZWFkNzU1MDAxNTBjNjk4ZTgzOWNiODA1NTVhNGRmNDdmMTE=
+  metadata.gz: 7f8b890410e93672ef60c2aaa03182d092da05076cc3fdca6826a875be5b7676d6f8f8dfa5b524758f2e4e9ea3e186c9a5a459d20d33485f39030f9daa2f11ed
+  data.tar.gz: 090258b598f8f079dc645bea11de2e82ad2e72770ea36e97e03efaecd4fe49cca002128cd484c5f285561cbe0fefa97f9e9b93ae23ac7d6f8cff7c92aafa30f0

data/Changelog.markdown

@@ -1,9 +1,17 @@
+v0.10.0  (2014-05-03)
+=================================================
+
+* Drop support for Ruby 1.9.2.
+* Add some rake tasks for development.
+* Add a «Contributing» section in the README.
+
+
 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
+* Add link in the 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.

data/Gemfile.lock

@@ -1,13 +1,22 @@
 PATH
   remote: .
   specs:
-    coco (0.9)
+    coco (0.10.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
+    flay (2.4.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    rainbow (2.0.0)
     rake (10.1.1)
+    reek (1.3.7)
+      rainbow
+      ruby2ruby (~> 2.0.8)
+      ruby_parser (~> 3.3)
+      sexp_processor
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -16,11 +25,19 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
+    ruby2ruby (2.0.8)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.5.0)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.4.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   coco!
+  flay (~> 2.4)
   rake (>= 10.1.0)
+  reek (~> 1.3)
   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)
+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) [![Inline docs](http://inch-pages.github.io/github/lkdjiin/coco.png)](http://inch-pages.github.io/github/lkdjiin/coco) [![Dependency Status](https://gemnasium.com/lkdjiin/coco.svg)](https://gemnasium.com/lkdjiin/coco)
 ==============================
 
-Code coverage tool for ruby 1.9.2, 1.9.3, 2.0 and 2.1.
+Code coverage tool for ruby 1.9.3, 2.0 and 2.1.
 
 Features
 --------------------------------
@@ -141,13 +141,27 @@ Now, when running tests, you will see something like the following:
 Dependencies
 --------------------------------
 
-ruby >= 1.9.2
+ruby >= 1.9.3
+
+
+Contributing
+--------------------------------
+
+1. Fork it.
+2. Create your feature branch **from the development branch**:
+   - `git checkout development`
+   - `git pull origin development`
+   - `git checkout -b my-new-feature`
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a Pull Request.
 
 
 License
 --------------------------------
 GPLv3, see COPYING.
 
+
 Questions and/or Comments
 --------------------------------
 

data/Rakefile

@@ -14,21 +14,29 @@ task :default => :spec
 
 desc 'Test coco'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ['--color --format documentation']
+  t.rspec_opts = ['--color --order=random']
 end
 
-desc 'Check for code smells'
+desc 'Check for code smells with reek'
 task :reek do
-  puts 'Checking for code smells...'
-  args = ruby_files_for_shell
-  sh "reek --quiet #{args} | ./reek.sed"
+  puts 'Checking for code smells.'
+  puts '-------------------------'
+  system "reek #{ruby_files_for_shell}"
 end
 
-desc 'Check for duplicate code'
+desc 'Check for duplicate code with flay'
 task :flay do
-  puts 'Check for duplicate code...'
-  args = ruby_files_for_shell
-  exec "flay #{args}"
+  puts 'Checking for duplicate code.'
+  puts '----------------------------'
+  exec "flay lib"
+end
+
+desc 'Check various code metrics'
+task :metrics do
+  puts 'Checking various metrics.'
+  puts '========================='
+  Rake::Task['reek'].execute
+  Rake::Task['flay'].execute
 end
 
 desc 'Build the gem & install it'

data/TODO

@@ -1,24 +1,33 @@
-+ option pour lancer coco si présence d'une variable d'environement
-+ doc dev
-+ doc readme & examples (maybe wiki ?)
-+ manual tests
+[x] Release 0.10.0
+    [ ] release gem
 
-+ update gemspec -> add ruby version 2.1
+[ ] Update website
 
-+ ajouter link dans le terminal
-+ option on/off
-+ doc readme
+[ ] Review PRs
 
-- add 'How to contribute' section
+[ ] A task to build/install/push a gem
 
-- translate dev's doc into tomdoc format.
+[ ] BUG #22 rails 4.1 / minitest / spring
+    [x] test with rails 4.1 / spring / rspec
+        [x] coco outside dev group
+    [x] test with 4.1 / spring / minitest
+    [ ] retest with a .coco.yml file
 
-en gras: def, class, module
+[ ] refactor with reek
 
-exclure spec et test par défaut
+[ ] en gras: def, class, module
 
-le wiki dit que seul le dossier lib est inspecté par défaut, je pense
-que c'est en fait toute l'application.
+[ ] rakefile task: tomdoc
 
-option verbose
+[ ] exclure spec et test par défaut
 
+[ ] le wiki dit que seul le dossier lib est inspecté par défaut, je pense
+    que c'est en fait toute l'application.
+
+
+Bump Version
+=============
+
+- Update `VERSION` file.
+- `bundle install`
+- Update Changelog.

data/VERSION

@@ -1 +1 @@
-0.9
+0.10.0

data/lib/coco/formatter/console_formatter.rb

@@ -2,12 +2,12 @@
 
 module Coco
 
-  # I format coverages information for console output
+  # I format coverages information for console output.
   class ConsoleFormatter < Formatter
 
-    # @param [Boolean] single_line_report
+    # single_line_report - Boolean
     #
-    # return [string] percent covered and associated filenames
+    # Returns percent covered and associated filenames as a String.
     def format(single_line_report = false)
       if single_line_report
         single_line_message
@@ -25,8 +25,8 @@ module Coco
       end
     end
 
-    # @param [Hash] covered
-    # @param [Array] uncovered
+    # covered   - Hash
+    # uncovered - Array
     def initialize covered, uncovered
       super(covered, uncovered)
       @formatted_output = []

data/lib/coco/formatter/context.rb

@@ -5,8 +5,8 @@ module Coco
   # Contextual information for ERB template, representing each covered files.
   class Context
   
-    # @param [String] filename Name of the source file
-    # @param [Array] lines 
+    # filename - A String name of the source file.
+    # lines    - An Array of lines.
 		def initialize filename, lines
 			@filename = filename
       @lines = lines

data/lib/coco/formatter/formatter.rb

@@ -3,11 +3,11 @@
 module Coco
   
   # My childs will format coverages information.
-  # @abstract
+  # Kind of abstract class.
   class Formatter
   
-    # @param [Hash] raw_coverages The hash from Coverage.result
-    # @param [Array] uncovered List on uncovered files
+    # raw_coverages - The Hash from Coverage.result.
+    # uncovered     - An Array list of uncovered files.
     # @todo I think covered is a better name than raw_coverages
     def initialize raw_coverages, uncovered
       @raw_coverages = raw_coverages

data/lib/coco/formatter/template.rb

@@ -6,8 +6,9 @@ module Coco
   
   # From me, you can obtain ERB templates.
   class Template
-    # @param [String] filename An ERB template
-    # @return [ERB]
+    # filename - An String ERB template.
+    #
+    # Returns ERB.
     def self.open filename
       io = IO.readlines(filename, nil)
 			ERB.new(io[0], nil, '><')

data/lib/coco/lister/source_lister.rb

@@ -5,7 +5,7 @@ module Coco
   # I retrieve the .rb files from a list of directories.
   class SourceLister
   
-    # @param [Hash] config
+    # config - Hash.
     def initialize config
       @exclude_files = config[:excludes]
       dirs = config[:directories]
@@ -22,7 +22,8 @@ module Coco
       @list = []
     end
     
-    # @return [Array<String>] A list of all .rb files from the directories found in configuration
+    # Returns Array of String, that is a list of all `.rb` files from
+    # the directories found in configuration.
     def list
       look_for_sources
       @list.map! {|file| File.expand_path(file)}

data/lib/coco/lister/uncovered_lister.rb

@@ -5,14 +5,14 @@ module Coco
   # I retrieve the list of uncovered (0%) .rb files.
   class UncoveredLister
     
-    # @param [Array<String>] sources List of filenames
-    # @param [Hash] covered Raw coverage from the domain
+    # sources - Array of String list of filenames.
+    # covered - Hash raw coverage from the domain.
     def initialize sources, covered
       @source_files = Helpers.expand(sources)
       @covered_files = Helpers.expand(covered.keys)
     end
     
-    # @return [Array<String>] List of uncovered filenames
+    # Returns Array of String list of uncovered filenames.
     def list
       list = []
       @source_files.each do |elem|

data/lib/coco/writer/html_files_writer.rb

@@ -5,7 +5,7 @@ module Coco
   # I populate the coverage/ directory with files, if any.
   class HtmlFilesWriter
   
-    # @param [Hash] html_files Key is filename, value is html content
+    # html_files - Hash, key is filename, value is html content.
     def initialize html_files
       @html_files = html_files
       @html_dir = HtmlDirectory.new
@@ -23,7 +23,8 @@ module Coco
     
     def write_each_file
       @html_files.each do |filename, html|
-        FileWriter.write File.join(@html_dir.coverage_dir, Helpers.rb2html(filename)), html
+        FileWriter.write File.join(
+          @html_dir.coverage_dir, Helpers.rb2html(filename)), html
       end
     end
     

metadata

@@ -1,66 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: coco
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: 0.10.0
 platform: ruby
 authors:
 - Xavier Nayrac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-02 00:00:00.000000000 Z
-dependencies: []
-description: ! '"Code coverage tool for ruby 1.9.2 to 2.1.
-
-  Use it by "require ''coco''" from rspec or unit/test.
-
+date: 2014-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: |-
+  "Code coverage tool for ruby 1.9.3 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:
+- COPYING
+- Changelog.markdown
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- TODO
+- VERSION
 - 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/cover.rb
+- lib/coco/formatter/html_index_formatter.rb
+- lib/coco/formatter/template.rb
 - lib/coco/helpers.rb
-- lib/coco/cover/coverage_result.rb
-- lib/coco/cover/coverage_stat.rb
+- lib/coco/lister.rb
+- lib/coco/lister/source_lister.rb
+- lib/coco/lister/uncovered_lister.rb
+- lib/coco/writer.rb
 - lib/coco/writer/file_writer.rb
-- lib/coco/writer/html_files_writer.rb
 - lib/coco/writer/html_directory.rb
+- lib/coco/writer/html_files_writer.rb
 - lib/coco/writer/html_index_writer.rb
-- lib/coco/formatter.rb
-- template/file.erb
-- template/index.erb
 - template/css/coco.css
-- template/img/licenses
+- template/file.erb
 - template/img/coconut16.png
-- VERSION
-- COPYING
-- README.markdown
-- Changelog.markdown
-- Gemfile
-- Rakefile
-- TODO
-- Gemfile.lock
+- template/img/licenses
+- template/index.erb
 homepage: http://lkdjiin.github.com/coco/
 licenses:
 - GPL-3
@@ -71,18 +109,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
-summary: Code coverage tool for ruby 1.9.2 to 2.1
+summary: Code coverage tool for ruby 1.9.3 to 2.1
 test_files: []
+has_rdoc: