From fd570d906a17c05e43bc110ca830737af7a769d0 Mon Sep 17 00:00:00 2001 From: Arfon Smith Date: Fri, 7 Aug 2015 10:35:18 +0100 Subject: [PATCH 1/3] Adding examples path to documentation.yml --- lib/linguist/documentation.yml | 1 + test/test_blob.rb | 9 ++++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/linguist/documentation.yml b/lib/linguist/documentation.yml index f95a547d..cd6d2074 100644 --- a/lib/linguist/documentation.yml +++ b/lib/linguist/documentation.yml @@ -13,6 +13,7 @@ - (^|/)[Dd]ocumentation/ - (^|/)javadoc/ - ^man/ +- ^[Ee]xamples/ ## Documentation files ## diff --git a/test/test_blob.rb b/test/test_blob.rb index 976c83ff..691b2149 100644 --- a/test/test_blob.rb +++ b/test/test_blob.rb @@ -517,7 +517,7 @@ class TestBlob < Minitest::Test assert_predicate fixture_blob("CHANGE.md"), :documentation? assert_predicate fixture_blob("CHANGE.txt"), :documentation? assert_predicate fixture_blob("foo/CHANGE"), :documentation? - + assert_predicate fixture_blob("CHANGELOG"), :documentation? assert_predicate fixture_blob("CHANGELOG.md"), :documentation? assert_predicate fixture_blob("CHANGELOG.txt"), :documentation? @@ -526,13 +526,16 @@ class TestBlob < Minitest::Test assert_predicate fixture_blob("CHANGES"), :documentation? assert_predicate fixture_blob("CHANGES.md"), :documentation? assert_predicate fixture_blob("CHANGES.txt"), :documentation? - assert_predicate fixture_blob("foo/CHANGES"), :documentation? - + assert_predicate fixture_blob("foo/CHANGES"), :documentation? + assert_predicate fixture_blob("CONTRIBUTING"), :documentation? assert_predicate fixture_blob("CONTRIBUTING.md"), :documentation? assert_predicate fixture_blob("CONTRIBUTING.txt"), :documentation? assert_predicate fixture_blob("foo/CONTRIBUTING"), :documentation? + assert_predicate fixture_blob("examples/some-file.pl"), :documentation? + assert_predicate fixture_blob("Examples/some-example-file.rb"), :documentation? + assert_predicate fixture_blob("LICENSE"), :documentation? assert_predicate fixture_blob("LICENCE.md"), :documentation? assert_predicate fixture_blob("LICENSE.txt"), :documentation? From 5d5550c48bac3a64ff0a729548f2a7b18f30e2e6 Mon Sep 17 00:00:00 2001 From: Arfon Smith Date: Fri, 7 Aug 2015 10:42:31 +0100 Subject: [PATCH 2/3] Moving vendored definitions to documentation --- lib/linguist/documentation.yml | 3 +++ lib/linguist/vendor.yml | 17 ++++------------- test/test_blob.rb | 14 +++++++++++--- 3 files changed, 18 insertions(+), 16 deletions(-) diff --git a/lib/linguist/documentation.yml b/lib/linguist/documentation.yml index cd6d2074..04649b5b 100644 --- a/lib/linguist/documentation.yml +++ b/lib/linguist/documentation.yml @@ -23,3 +23,6 @@ - (^|/)INSTALL(\.|$) - (^|/)LICEN[CS]E(\.|$) - (^|/)README(\.|$) + +# Samples folders +- ^[Ss]amples/ diff --git a/lib/linguist/vendor.yml b/lib/linguist/vendor.yml index e432af3c..ed89eda8 100644 --- a/lib/linguist/vendor.yml +++ b/lib/linguist/vendor.yml @@ -179,6 +179,10 @@ # Fabric - Fabric.framework/ +# git config files +- gitattributes$ +- gitignore$ +- gitmodules$ ## Groovy ## @@ -224,19 +228,6 @@ # Html5shiv - (^|/)html5shiv\.js$ -# Samples folders -- ^[Ss]amples/ - -# LICENSE, README, git config files -- ^COPYING$ -- LICENSE$ -- License$ -- gitattributes$ -- gitignore$ -- gitmodules$ -- ^README$ -- ^readme$ - # Test fixtures - ^[Tt]ests?/fixtures/ diff --git a/test/test_blob.rb b/test/test_blob.rb index 691b2149..6c705379 100644 --- a/test/test_blob.rb +++ b/test/test_blob.rb @@ -308,6 +308,12 @@ class TestBlob < Minitest::Test # Erlang assert sample_blob("rebar").vendored? + # git config files + + assert_predicate fixture_blob("some/path/.gitattributes"), :vendored? + assert_predicate fixture_blob(".gitignore"), :vendored? + assert_predicate fixture_blob("special/path/.gitmodules"), :vendored? + # Minified JavaScript and CSS assert sample_blob("foo.min.js").vendored? assert sample_blob("foo.min.css").vendored? @@ -326,9 +332,6 @@ class TestBlob < Minitest::Test assert sample_blob("public/javascripts/controls.js").vendored? assert sample_blob("public/javascripts/dragdrop.js").vendored? - # Samples - assert sample_blob("Samples/Ruby/foo.rb").vendored? - # jQuery assert sample_blob("jquery.js").vendored? assert sample_blob("public/javascripts/jquery.js").vendored? @@ -552,6 +555,11 @@ class TestBlob < Minitest::Test assert_predicate fixture_blob("foo/INSTALL"), :documentation? refute_predicate fixture_blob("foo.md"), :documentation? + + # Samples + assert sample_blob("Samples/Ruby/foo.rb").documentation? + + assert_predicate fixture_blob("INSTALL.txt"), :documentation? end def test_language From 8d20c1fb593fc57b485a8641c618ddc161196683 Mon Sep 17 00:00:00 2001 From: Arfon Smith Date: Tue, 11 Aug 2015 09:39:41 +0100 Subject: [PATCH 3/3] More inclusive documentation matches for License and Readme files --- lib/linguist/documentation.yml | 2 ++ test/test_blob.rb | 3 +++ 2 files changed, 5 insertions(+) diff --git a/lib/linguist/documentation.yml b/lib/linguist/documentation.yml index 04649b5b..230cd423 100644 --- a/lib/linguist/documentation.yml +++ b/lib/linguist/documentation.yml @@ -22,7 +22,9 @@ - (^|/)COPYING(\.|$) - (^|/)INSTALL(\.|$) - (^|/)LICEN[CS]E(\.|$) +- (^|/)[Ll]icen[cs]e(\.|$) - (^|/)README(\.|$) +- (^|/)[Rr]eadme(\.|$) # Samples folders - ^[Ss]amples/ diff --git a/test/test_blob.rb b/test/test_blob.rb index 6c705379..0a1cefe9 100644 --- a/test/test_blob.rb +++ b/test/test_blob.rb @@ -514,6 +514,8 @@ class TestBlob < Minitest::Test assert_predicate fixture_blob("README"), :documentation? assert_predicate fixture_blob("README.md"), :documentation? assert_predicate fixture_blob("README.txt"), :documentation? + assert_predicate fixture_blob("Readme"), :documentation? + assert_predicate fixture_blob("readme"), :documentation? assert_predicate fixture_blob("foo/README"), :documentation? assert_predicate fixture_blob("CHANGE"), :documentation? @@ -541,6 +543,7 @@ class TestBlob < Minitest::Test assert_predicate fixture_blob("LICENSE"), :documentation? assert_predicate fixture_blob("LICENCE.md"), :documentation? + assert_predicate fixture_blob("License.txt"), :documentation? assert_predicate fixture_blob("LICENSE.txt"), :documentation? assert_predicate fixture_blob("foo/LICENSE"), :documentation?