yardstick 0.9.6 → 0.9.7

data/spec/unit/yardstick/rules/summary/presence/valid_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::Summary::Presence, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document', summary_text: text) }
+
+  context 'with summary' do
+    let(:text) { 'A summary' }
+
+    it { should be(true) }
+  end
+
+  context 'without summary' do
+    let(:text) { '' }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/summary/presence/validatable_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::Summary::Presence, '#validatable?' do
+  subject { described_class.new(document).validatable? }
+
+  let(:document) { double('document') }
+
+  context 'with @see tag' do
+    before { document.stub(:has_tag?).with('see').and_return(true) }
+
+    it { should be(false) }
+  end
+
+  context 'without @see tag' do
+    before { document.stub(:has_tag?).with('see').and_return(false) }
+
+    it { should be(true) }
+  end
+end

data/spec/unit/yardstick/rules/summary/single_line/valid_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::Summary::SingleLine, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document', summary_text: text) }
+
+  context 'with one line summary' do
+    let(:text) { 'A summary' }
+
+    it { should be(true) }
+  end
+
+  context 'with more than one line' do
+    let(:text) { "A summary\nA summary" }
+
+    it { should be(false) }
+  end
+end

data/yardstick.gemspec

@@ -1,28 +1,24 @@
 # encoding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'yardstick/version'
+require File.expand_path('../lib/yardstick/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name        = 'yardstick'
-  gem.version     = Yardstick::VERSION
+  gem.version     = Yardstick::VERSION.dup
   gem.authors     = ['Dan Kubb']
   gem.email       = %w[dan.kubb@gmail.com]
   gem.description = 'Measure YARD documentation coverage'
   gem.summary     = 'A tool for verifying YARD documentation coverage'
   gem.homepage    = 'https://github.com/dkubb/yardstick'
-  gem.licenses    = %w[MIT]
+  gem.licenses    = 'MIT'
 
   gem.require_paths    = %w[lib]
-  gem.files            = `git ls-files`.split($/)
-  gem.test_files       = `git ls-files -- spec/{public,semipublic}`.split($/)
-  gem.extra_rdoc_files = %w[LICENSE README.md]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- spec/{unit,integration}`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.md CONTRIBUTING.md TODO]
   gem.executables      = %w[yardstick]
 
-  gem.add_runtime_dependency('backports', '~> 3.3', '>= 3.3.0')
-  gem.add_runtime_dependency('yard',      '~> 0.8', '>= 0.8.6')
+  gem.add_runtime_dependency('yard', '~> 0.8', '>= 0.8.7')
 
   gem.add_development_dependency('bundler', '~> 1.3', '>= 1.3.5')
 end

metadata

@@ -1,80 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: yardstick
 version: !ruby/object:Gem::Version
-  version: 0.9.6
-  prerelease: 
+  version: 0.9.7
 platform: ruby
 authors:
 - Dan Kubb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: backports
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.5
 description: Measure YARD documentation coverage
@@ -86,82 +59,266 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.md
+- CONTRIBUTING.md
+- TODO
 files:
 - .document
 - .gitignore
-- .rvmrc
+- .rspec
+- .ruby-gemset
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.devtools
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - bin/yardstick
+- config/devtools.yml
 - config/flay.yml
 - config/flog.yml
+- config/mutant.yml
+- config/reek.yml
 - config/roodi.yml
-- config/site.reek
+- config/rubocop.yml
 - config/yardstick.yml
 - lib/yardstick.rb
 - lib/yardstick/cli.rb
-- lib/yardstick/measurable.rb
+- lib/yardstick/config.rb
+- lib/yardstick/document.rb
+- lib/yardstick/document_set.rb
 - lib/yardstick/measurement.rb
 - lib/yardstick/measurement_set.rb
-- lib/yardstick/method.rb
 - lib/yardstick/ordered_set.rb
+- lib/yardstick/parser.rb
 - lib/yardstick/processor.rb
 - lib/yardstick/rake/measurement.rb
 - lib/yardstick/rake/verify.rb
+- lib/yardstick/report_output.rb
 - lib/yardstick/rule.rb
-- lib/yardstick/rule_set.rb
+- lib/yardstick/rule_config.rb
+- lib/yardstick/rules/api_tag.rb
+- lib/yardstick/rules/example_tag.rb
+- lib/yardstick/rules/return_tag.rb
+- lib/yardstick/rules/summary.rb
 - lib/yardstick/version.rb
 - lib/yardstick/yard_ext.rb
+- spec/integration/yardstick/class_methods/measure_spec.rb
+- spec/integration/yardstick/class_methods/measure_string_spec.rb
+- spec/integration/yardstick/document/file_spec.rb
+- spec/integration/yardstick/document/line_spec.rb
+- spec/integration/yardstick/document/path_spec.rb
+- spec/integration/yardstick/processor/process_string_spec.rb
+- spec/integration/yardstick/rake/measurement_spec.rb
+- spec/integration/yardstick/rake/verify_spec.rb
 - spec/rcov.opts
+- spec/shared/measured_itself_behavior.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/support/config_alias.rb
+- spec/support/document_mock.rb
+- spec/support/rules.rb
+- spec/unit/yardstick/class_methods/measure_spec.rb
+- spec/unit/yardstick/class_methods/measure_string_spec.rb
 - spec/unit/yardstick/cli_spec.rb
-- spec/unit/yardstick/measurement_set_spec.rb
-- spec/unit/yardstick/measurement_spec.rb
-- spec/unit/yardstick/method_spec.rb
-- spec/unit/yardstick/rake/measurement_spec.rb
-- spec/unit/yardstick/rake/verify_spec.rb
-- spec/unit/yardstick/rule_spec.rb
-- spec/unit/yardstick_spec.rb
-- tasks/metrics/ci.rake
-- tasks/metrics/flay.rake
-- tasks/metrics/flog.rake
-- tasks/metrics/heckle.rake
-- tasks/metrics/metric_fu.rake
-- tasks/metrics/reek.rake
-- tasks/metrics/roodi.rake
-- tasks/metrics/yardstick.rake
-- tasks/spec.rake
-- tasks/yard.rake
+- spec/unit/yardstick/config/class_methods/coerce_spec.rb
+- spec/unit/yardstick/config/for_rule_spec.rb
+- spec/unit/yardstick/config/initialize_spec.rb
+- spec/unit/yardstick/config/output_spec.rb
+- spec/unit/yardstick/config/output_writer_spec.rb
+- spec/unit/yardstick/config/path_spec.rb
+- spec/unit/yardstick/config/path_writer_spec.rb
+- spec/unit/yardstick/config/require_exact_threshold_predicate_spec.rb
+- spec/unit/yardstick/config/require_exact_threshold_writer_spec.rb
+- spec/unit/yardstick/config/set_defaults_spec.rb
+- spec/unit/yardstick/config/threshold_writer_spec.rb
+- spec/unit/yardstick/config/verbose_predicate_spec.rb
+- spec/unit/yardstick/config/verbose_writer_spec.rb
+- spec/unit/yardstick/document/api_predicate_spec.rb
+- spec/unit/yardstick/document/class_methods/measure_spec.rb
+- spec/unit/yardstick/document/class_methods/register_rule_spec.rb
+- spec/unit/yardstick/document/class_methods/registered_rules_spec.rb
+- spec/unit/yardstick/document/docstring_spec.rb
+- spec/unit/yardstick/document/file_spec.rb
+- spec/unit/yardstick/document/has_tag_predicate_spec.rb
+- spec/unit/yardstick/document/line_spec.rb
+- spec/unit/yardstick/document/null_tag/text_spec.rb
+- spec/unit/yardstick/document/null_tag/types_spec.rb
+- spec/unit/yardstick/document/path_spec.rb
+- spec/unit/yardstick/document/summary_text_spec.rb
+- spec/unit/yardstick/document/tag_text_spec.rb
+- spec/unit/yardstick/document/tag_types_spec.rb
+- spec/unit/yardstick/document/visibility_spec.rb
+- spec/unit/yardstick/document_set/measure_spec.rb
+- spec/unit/yardstick/measurement/description_spec.rb
+- spec/unit/yardstick/measurement/initialize_spec.rb
+- spec/unit/yardstick/measurement/ok_predicate_spec.rb
+- spec/unit/yardstick/measurement/puts_spec.rb
+- spec/unit/yardstick/measurement/skip_predicate_spec.rb
+- spec/unit/yardstick/measurement_set/coverage_spec.rb
+- spec/unit/yardstick/measurement_set/failed_spec.rb
+- spec/unit/yardstick/measurement_set/initialize_spec.rb
+- spec/unit/yardstick/measurement_set/puts_spec.rb
+- spec/unit/yardstick/measurement_set/successful_spec.rb
+- spec/unit/yardstick/measurement_set/total_spec.rb
+- spec/unit/yardstick/ordered_set/each_spec.rb
+- spec/unit/yardstick/ordered_set/empty_predicate_spec.rb
+- spec/unit/yardstick/ordered_set/include_predicate_spec.rb
+- spec/unit/yardstick/ordered_set/index_spec.rb
+- spec/unit/yardstick/ordered_set/left_shift_operator_spec.rb
+- spec/unit/yardstick/ordered_set/length_spec.rb
+- spec/unit/yardstick/ordered_set/merge_spec.rb
+- spec/unit/yardstick/parser/class_methods/parse_paths_spec.rb
+- spec/unit/yardstick/parser/class_methods/parse_string_spec.rb
+- spec/unit/yardstick/processor/process_spec.rb
+- spec/unit/yardstick/processor/process_string_spec.rb
+- spec/unit/yardstick/rake/measurement/initialize_spec.rb
+- spec/unit/yardstick/rake/measurement/yardstick_measure_spec.rb
+- spec/unit/yardstick/rake/verify/initialize_spec.rb
+- spec/unit/yardstick/rake/verify/verify_measurements_spec.rb
+- spec/unit/yardstick/report_output/class_methods/coerce_spec.rb
+- spec/unit/yardstick/report_output/initialize_spec.rb
+- spec/unit/yardstick/report_output/to_s_spec.rb
+- spec/unit/yardstick/report_output/write_spec.rb
+- spec/unit/yardstick/round_percentage_spec.rb
+- spec/unit/yardstick/rule/class_methods/coerce_spec.rb
+- spec/unit/yardstick/rule/class_methods/inherited_spec.rb
+- spec/unit/yardstick/rule/enabled_predicate_spec.rb
+- spec/unit/yardstick/rule/initialize_spec.rb
+- spec/unit/yardstick/rule/validatable_predicate_spec.rb
+- spec/unit/yardstick/rule_config/enabled_for_path_predicate_spec.rb
+- spec/unit/yardstick/rule_config/initialize_spec.rb
+- spec/unit/yardstick/rules/api_tag/inclusion/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/presence/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/private_method/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/private_method/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/protected_method/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/protected_method/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/example_tag/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/example_tag/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/return_tag/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/delimiter/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/length/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/presence/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/presence/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/single_line/valid_predicate_spec.rb
 - yardstick.gemspec
 homepage: https://github.com/dkubb/yardstick
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A tool for verifying YARD documentation coverage
-test_files: []
+test_files:
+- spec/integration/yardstick/class_methods/measure_spec.rb
+- spec/integration/yardstick/class_methods/measure_string_spec.rb
+- spec/integration/yardstick/document/file_spec.rb
+- spec/integration/yardstick/document/line_spec.rb
+- spec/integration/yardstick/document/path_spec.rb
+- spec/integration/yardstick/processor/process_string_spec.rb
+- spec/integration/yardstick/rake/measurement_spec.rb
+- spec/integration/yardstick/rake/verify_spec.rb
+- spec/unit/yardstick/class_methods/measure_spec.rb
+- spec/unit/yardstick/class_methods/measure_string_spec.rb
+- spec/unit/yardstick/cli_spec.rb
+- spec/unit/yardstick/config/class_methods/coerce_spec.rb
+- spec/unit/yardstick/config/for_rule_spec.rb
+- spec/unit/yardstick/config/initialize_spec.rb
+- spec/unit/yardstick/config/output_spec.rb
+- spec/unit/yardstick/config/output_writer_spec.rb
+- spec/unit/yardstick/config/path_spec.rb
+- spec/unit/yardstick/config/path_writer_spec.rb
+- spec/unit/yardstick/config/require_exact_threshold_predicate_spec.rb
+- spec/unit/yardstick/config/require_exact_threshold_writer_spec.rb
+- spec/unit/yardstick/config/set_defaults_spec.rb
+- spec/unit/yardstick/config/threshold_writer_spec.rb
+- spec/unit/yardstick/config/verbose_predicate_spec.rb
+- spec/unit/yardstick/config/verbose_writer_spec.rb
+- spec/unit/yardstick/document/api_predicate_spec.rb
+- spec/unit/yardstick/document/class_methods/measure_spec.rb
+- spec/unit/yardstick/document/class_methods/register_rule_spec.rb
+- spec/unit/yardstick/document/class_methods/registered_rules_spec.rb
+- spec/unit/yardstick/document/docstring_spec.rb
+- spec/unit/yardstick/document/file_spec.rb
+- spec/unit/yardstick/document/has_tag_predicate_spec.rb
+- spec/unit/yardstick/document/line_spec.rb
+- spec/unit/yardstick/document/null_tag/text_spec.rb
+- spec/unit/yardstick/document/null_tag/types_spec.rb
+- spec/unit/yardstick/document/path_spec.rb
+- spec/unit/yardstick/document/summary_text_spec.rb
+- spec/unit/yardstick/document/tag_text_spec.rb
+- spec/unit/yardstick/document/tag_types_spec.rb
+- spec/unit/yardstick/document/visibility_spec.rb
+- spec/unit/yardstick/document_set/measure_spec.rb
+- spec/unit/yardstick/measurement/description_spec.rb
+- spec/unit/yardstick/measurement/initialize_spec.rb
+- spec/unit/yardstick/measurement/ok_predicate_spec.rb
+- spec/unit/yardstick/measurement/puts_spec.rb
+- spec/unit/yardstick/measurement/skip_predicate_spec.rb
+- spec/unit/yardstick/measurement_set/coverage_spec.rb
+- spec/unit/yardstick/measurement_set/failed_spec.rb
+- spec/unit/yardstick/measurement_set/initialize_spec.rb
+- spec/unit/yardstick/measurement_set/puts_spec.rb
+- spec/unit/yardstick/measurement_set/successful_spec.rb
+- spec/unit/yardstick/measurement_set/total_spec.rb
+- spec/unit/yardstick/ordered_set/each_spec.rb
+- spec/unit/yardstick/ordered_set/empty_predicate_spec.rb
+- spec/unit/yardstick/ordered_set/include_predicate_spec.rb
+- spec/unit/yardstick/ordered_set/index_spec.rb
+- spec/unit/yardstick/ordered_set/left_shift_operator_spec.rb
+- spec/unit/yardstick/ordered_set/length_spec.rb
+- spec/unit/yardstick/ordered_set/merge_spec.rb
+- spec/unit/yardstick/parser/class_methods/parse_paths_spec.rb
+- spec/unit/yardstick/parser/class_methods/parse_string_spec.rb
+- spec/unit/yardstick/processor/process_spec.rb
+- spec/unit/yardstick/processor/process_string_spec.rb
+- spec/unit/yardstick/rake/measurement/initialize_spec.rb
+- spec/unit/yardstick/rake/measurement/yardstick_measure_spec.rb
+- spec/unit/yardstick/rake/verify/initialize_spec.rb
+- spec/unit/yardstick/rake/verify/verify_measurements_spec.rb
+- spec/unit/yardstick/report_output/class_methods/coerce_spec.rb
+- spec/unit/yardstick/report_output/initialize_spec.rb
+- spec/unit/yardstick/report_output/to_s_spec.rb
+- spec/unit/yardstick/report_output/write_spec.rb
+- spec/unit/yardstick/round_percentage_spec.rb
+- spec/unit/yardstick/rule/class_methods/coerce_spec.rb
+- spec/unit/yardstick/rule/class_methods/inherited_spec.rb
+- spec/unit/yardstick/rule/enabled_predicate_spec.rb
+- spec/unit/yardstick/rule/initialize_spec.rb
+- spec/unit/yardstick/rule/validatable_predicate_spec.rb
+- spec/unit/yardstick/rule_config/enabled_for_path_predicate_spec.rb
+- spec/unit/yardstick/rule_config/initialize_spec.rb
+- spec/unit/yardstick/rules/api_tag/inclusion/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/presence/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/private_method/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/private_method/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/protected_method/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/api_tag/protected_method/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/example_tag/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/example_tag/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/return_tag/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/delimiter/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/length/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/presence/valid_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/presence/validatable_predicate_spec.rb
+- spec/unit/yardstick/rules/summary/single_line/valid_predicate_spec.rb
 has_rdoc: