readme-score 0.0.2

data/lib/readme-score/util.rb

@@ -0,0 +1,14 @@
+module ReadmeScore
+  module Util
+    module_function
+    def to_noko(noko_or_html, copy = false)
+      noko = noko_or_html
+      if noko_or_html.is_a?(String)
+        noko = Nokogiri::HTML.fragment(noko_or_html)
+      elsif copy && noko_or_html.is_a?(Nokogiri::XML::Node)
+        noko = Nokogiri::HTML.fragment(noko.to_s)
+      end
+      noko
+    end
+  end
+end

data/lib/readme-score/version.rb

@@ -0,0 +1,3 @@
+module ReadmeScore
+  VERSION = "0.0.2"
+end

data/readme-score.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readme-score/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "readme-score"
+  spec.version       = ReadmeScore::VERSION
+  spec.authors       = ["Clay Allsopp"]
+  spec.email         = ["clay.allsopp@gmail.com"]
+  spec.summary       = "Gives a score for README.md"
+  spec.homepage      = "https://github.com/clayallsopp/readme-score"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", ">= 1.6.0"
+  spec.add_dependency "unirest", ">= 1.1.0"
+  spec.add_dependency "redcarpet", ">= 3.1.0"
+  spec.add_dependency "octokit", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dotenv"
+end

data/spec/document/filter_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe ReadmeScore::Document::Filter do
+  describe "#filtered_html!" do
+
+    describe "removing license" do
+      it "works" do
+        html = %Q{
+          <h2>LICENSE</h2>
+          <p>Some info about the license here</p>
+          <p>More info</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        filter.filtered_html!.strip.empty?.should == true
+      end
+
+      it "works and preserves other elements" do
+        html = %Q{
+          <h2>Other thing</h2>
+          <p>Something</p>
+          <h2>LICENSE</h2>
+          <p>Some info about the license here</p>
+          <p>More info</p>
+          <h2>Something else</h2>
+          <p>Hello</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.should == %Q{
+          <h2>Other thing</h2>
+          <p>Something</p>
+          <h2>Something else</h2>
+          <p>Hello</p>}
+      end
+
+      it "works with lesser headings afterwards" do
+        html = %Q{
+          <h2>LICENSE</h2>
+          <p>Some info about the license here</p>
+          <p>More info</p>
+          <h4>Something else</h4>
+          <p>Hello</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.strip.should == ""
+      end
+    end
+
+    describe "removing contact" do
+      it "works" do
+        html = %Q{
+          <h2>Contact</h2>
+          <p>Some info about the contact here</p>
+          <p>More info</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        filter.filtered_html!.strip.empty?.should == true
+      end
+
+      it "works and preserves other elements" do
+        html = %Q{
+          <h2>Other thing</h2>
+          <p>Something</p>
+          <h2>Contact</h2>
+          <p>Some info about the contact here</p>
+          <p>More info</p>
+          <h2>Something else</h2>
+          <p>Hello</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.should == %Q{
+          <h2>Other thing</h2>
+          <p>Something</p>
+          <h2>Something else</h2>
+          <p>Hello</p>}
+      end
+
+      it "works with lesser headings afterwards" do
+        html = %Q{
+          <h2>Contact</h2>
+          <p>Some info about the contact here</p>
+          <p>More info</p>
+          <h4>Something else</h4>
+          <p>Hello</p>}
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.strip.should == ""
+      end
+    end
+
+    describe "removing services with images" do
+      it "works" do
+        html = %Q{
+          <h2>Repo</h2><a href="http://travis-ci.org/thing"><img src="travis" /></a><p>Hello</p>
+        }.strip
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.strip.should == %Q{
+          <h2>Repo</h2><p>Hello</p>
+          }.strip
+      end
+
+      it "keeps non-image links" do
+        html = %Q{
+          <h2>Repo</h2><a href="http://travis-ci.org/thing">Travis</a><p>Hello</p>
+        }.strip
+        filter = ReadmeScore::Document::Filter.new(html)
+        string = filter.filtered_html!
+        string.strip.should == html
+      end
+    end
+
+  end
+end

data/spec/document/loader_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe ReadmeScore::Document::Loader do
+  describe ".is_github_repo_slug?" do
+    it "works" do
+      ReadmeScore::Document::Loader.is_github_repo_slug?("usepropeller/react.backbone").should == true
+      ReadmeScore::Document::Loader.is_github_repo_slug?("afnetworking/afnetworking").should == true
+      ReadmeScore::Document::Loader.is_github_repo_slug?("afnetworking/").should == false
+      ReadmeScore::Document::Loader.is_github_repo_slug?("afnetworking").should == false
+      ReadmeScore::Document::Loader.is_github_repo_slug?("http://github.com/afnetworking/afnetworking").should == false
+      ReadmeScore::Document::Loader.is_github_repo_slug?("afnetworking/afnetworking/").should == false
+      ReadmeScore::Document::Loader.is_github_repo_slug?("afnetworking/afnetworking/z").should == false
+    end
+  end
+
+  describe ".is_url?" do
+    it "works" do
+      ReadmeScore::Document::Loader.is_url?("http://github.com/afnetworking/afnetworking").should == true
+      ReadmeScore::Document::Loader.is_url?("https://github.com/afnetworking/afnetworking").should == true
+      ReadmeScore::Document::Loader.is_url?("https://something.com/").should == true
+      ReadmeScore::Document::Loader.is_url?("usepropeller/react.backbone").should == false
+      ReadmeScore::Document::Loader.is_url?("afnetworking/afnetworking").should == false
+      ReadmeScore::Document::Loader.is_url?("afnetworking/").should == false
+      ReadmeScore::Document::Loader.is_url?("afnetworking").should == false
+      ReadmeScore::Document::Loader.is_url?("afnetworking/afnetworking/").should == false
+      ReadmeScore::Document::Loader.is_url?("afnetworking/afnetworking/z").should == false
+    end
+  end
+
+  describe "#markdown?" do
+    ReadmeScore::Document::Loader::MARKDOWN_EXTENSIONS.each {|extension|
+      describe "with .#{extension} link" do
+        it "is true" do
+          url = "http://www.test.com/readme.#{extension}"
+          stub_request(:get, url)
+
+          loader = ReadmeScore::Document::Loader.new(url)
+          loader.load!
+          loader.markdown?.should == true
+        end
+      end
+    }
+
+    describe "without .md link" do
+      it "is false" do
+        url = "http://www.test.com/readme.html"
+        stub_request(:get, url)
+
+        loader = ReadmeScore::Document::Loader.new(url)
+        loader.markdown?.should == false
+      end
+    end
+  end
+
+  describe "#html" do
+    describe "without markdown" do
+      it "works" do
+        loader = ReadmeScore::Document::Loader.new("http://something.com/thing.html")
+        loader.markdown = false
+        loader.response = double('HTTP response', body: "<h1>Hello</h1>")
+        loader.html.should == "<h1>Hello</h1>"
+      end
+    end
+
+    describe "with markdown" do
+      it "works" do
+        loader = ReadmeScore::Document::Loader.new("http://something.com/thing.md")
+        loader.markdown = true
+        loader.response = double('Markdown response', body: "# Hello")
+        expect(loader).to receive(:parse_markdown).with("# Hello")
+        loader.html
+      end
+    end
+  end
+
+
+  describe "#load!" do
+    describe "when github api is turned off" do
+      before do
+        ReadmeScore.use_github_api = false
+      end
+
+      after do
+        ReadmeScore.use_github_api = true
+      end
+
+      it "loads via approximation" do
+        loader = ReadmeScore::Document::Loader.new("http://github.com/repo/user")
+        expect(loader).to receive(:load_via_github_approximation!)
+        loader.load!
+      end
+    end
+
+    describe "with non-github links" do
+      it "works" do
+        url = "http://www.test.com/readme.md"
+        stub_request(:get, url).
+          to_return(body: "<h1>This is a test</h1>")
+
+        loader = ReadmeScore::Document::Loader.new(url)
+        loader.load!
+        loader.html.strip.should == "<h1>This is a test</h1>"
+      end
+    end
+
+    describe "with github links" do
+      describe "with link to repo" do
+        ["", "www."].each {|subdomain|
+          %w(http https).each {|protocol|
+            it "works with #{protocol}" do
+              repo_url = "#{protocol}://#{subdomain}github.com/repo/user"
+
+              stub_github_readme(protocol, 'repo', 'user', 'README.md').
+                to_return(body: "<h1>This is a hit</h1>")
+
+              loader = ReadmeScore::Document::Loader.new(repo_url)
+              loader.load!
+              loader.html.strip.should == "<h1>This is a hit</h1>"
+            end
+          }
+        }
+
+      end
+
+      describe "with link to some other page" do
+        it "works" do
+          url = "http://github.com/repo/user/block/thing/idk.md"
+          stub_request(:get, url).
+            to_return(body: "<h1>A markdown</h1>")
+
+          loader = ReadmeScore::Document::Loader.new(url)
+          loader.load!
+          loader.html.strip.should == "<h1>A markdown</h1>"
+        end
+      end
+    end
+  end
+
+end

data/spec/document/metrics_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe ReadmeScore::Document::Metrics do
+
+  describe "#number_of_links" do
+    it "works" do
+      html = %Q{
+        <a href="other_thing.html">Other thing</a>
+        <p><a href="/other_thing.html">Other thing</a></p>
+        <a href="http://google.com">Something there</a>}
+      calc = ReadmeScore::Document::Metrics.new(html)
+      calc.number_of_links.should == 3
+    end
+  end
+
+  describe "#number_of_code_blocks" do
+    it "works" do
+      html = %Q{
+  <p>You can initialize a <code>Formotion::Form</code> using either a hash (as above) or the DSL:</p>
+  <div class="highlight highlight-ruby"><pre><span class="n">form</span> <span class="o">=</span> <span class="no">Formotion</span><span class="o">::</span><span class="no">Form</span><span class="o">.</span><span class="n">new</span>
+
+  <span class="n">form</span><span class="o">.</span><span class="n">build_section</span> <span class="k">do</span> <span class="o">|</span><span class="n">section</span><span class="o">|</span>
+    <span class="n">section</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="s2">"Title"</span>
+
+    <span class="n">section</span><span class="o">.</span><span class="n">build_row</span> <span class="k">do</span> <span class="o">|</span><span class="n">row</span><span class="o">|</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="s2">"Label"</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">subtitle</span> <span class="o">=</span> <span class="s2">"Placeholder"</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="ss">:string</span>
+    <span class="k">end</span>
+  <span class="k">end</span>
+  </pre></div>
+  <p>Then attach it to a <code>Formotion::FormController</code> and you're ready to rock and roll:</p>
+  <div class="highlight highlight-ruby"><pre><span class="vi">@controller</span> <span class="o">=</span> <span class="no">Formotion</span><span class="o">::</span><span class="no">FormController</span><span class="o">.</span><span class="n">alloc</span><span class="o">.</span><span class="n">initWithForm</span><span class="p">(</span><span class="n">form</span><span class="p">)</span>
+  <span class="nb">self</span><span class="o">.</span><span class="n">navigationController</span><span class="o">.</span><span class="n">pushViewController</span><span class="p">(</span><span class="vi">@controller</span><span class="p">,</span> <span class="ss">animated</span><span class="p">:</span> <span class="kp">true</span><span class="p">)</span>
+  </pre></div>
+
+  <p>Pretty simple, right?</p>
+      }
+      calc = ReadmeScore::Document::Metrics.new(html)
+      calc.number_of_code_blocks.should == 2
+    end
+  end
+
+  describe "#code_block_to_paragraph_ratio" do
+    it "works" do
+      html = %Q{
+  <p>You can initialize a <code>Formotion::Form</code> using either a hash (as above) or the DSL:</p>
+  <div class="highlight highlight-ruby"><pre><span class="n">form</span> <span class="o">=</span> <span class="no">Formotion</span><span class="o">::</span><span class="no">Form</span><span class="o">.</span><span class="n">new</span>
+
+  <span class="n">form</span><span class="o">.</span><span class="n">build_section</span> <span class="k">do</span> <span class="o">|</span><span class="n">section</span><span class="o">|</span>
+    <span class="n">section</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="s2">"Title"</span>
+
+    <span class="n">section</span><span class="o">.</span><span class="n">build_row</span> <span class="k">do</span> <span class="o">|</span><span class="n">row</span><span class="o">|</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="s2">"Label"</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">subtitle</span> <span class="o">=</span> <span class="s2">"Placeholder"</span>
+      <span class="n">row</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="ss">:string</span>
+    <span class="k">end</span>
+  <span class="k">end</span>
+  </pre></div>
+  <p>Then attach it to a <code>Formotion::FormController</code> and you're ready to rock and roll:</p>
+  <div class="highlight highlight-ruby"><pre><span class="vi">@controller</span> <span class="o">=</span> <span class="no">Formotion</span><span class="o">::</span><span class="no">FormController</span><span class="o">.</span><span class="n">alloc</span><span class="o">.</span><span class="n">initWithForm</span><span class="p">(</span><span class="n">form</span><span class="p">)</span>
+  <span class="nb">self</span><span class="o">.</span><span class="n">navigationController</span><span class="o">.</span><span class="n">pushViewController</span><span class="p">(</span><span class="vi">@controller</span><span class="p">,</span> <span class="ss">animated</span><span class="p">:</span> <span class="kp">true</span><span class="p">)</span>
+  </pre></div>
+
+  <p>Pretty simple, right?</p>
+      }
+      calc = ReadmeScore::Document::Metrics.new(html)
+      calc.code_block_to_paragraph_ratio.should == (2.0 / 3.0)
+    end
+  end
+
+  describe "#number_of_non_code_sections" do
+    it "works" do
+      html = %Q{
+<p>Paragraph</p>
+<p>Paragraph2</p>
+<div class="highlight highlight-yaml"><pre><span class="l-Scalar-Plain">additional_guides</span><span class="p-Indicator">:</span>
+ <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">https://github.com/magicalpanda/MagicalRecord/wiki/Installation</span>
+ <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">https://github.com/CocoaPods/CocoaPods/wiki/A-pod-specification</span>
+ <span class="p-Indicator">-</span> <span class="l-Scalar-Plain">docs/Getting_started.md</span>
+</pre></div>
+<ol>
+  <li></li>
+  <li></li>
+</ol>
+<ul>
+  <li></li>
+  <li></li>
+</ul>
+      }
+      calc = ReadmeScore::Document::Metrics.new(html)
+      calc.number_of_non_code_sections.should == 4
+    end
+  end
+end

data/spec/readme-score_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe ReadmeScore do
+  describe ".use_github_api?" do
+    it "changes after setting" do
+      ReadmeScore.use_github_api = false
+      ReadmeScore.use_github_api?.should == false
+      ReadmeScore.use_github_api = true
+      ReadmeScore.use_github_api?.should == true
+    end
+  end
+
+  describe ".for" do
+    %w{http https}.each { |protocol|
+      it "should load a #{protocol} URL" do
+        url = "#{protocol}://somewhere.com/thing.md"
+        expect(ReadmeScore::Document).to receive(:load).with(url) { ReadmeScore::Document.new("") }
+        ReadmeScore.for(url)
+      end
+    }
+
+    it "should load a Github slug" do
+        repo = "user/repo"
+        expect(ReadmeScore::Document).to receive(:load).with("http://github.com/#{repo}") { ReadmeScore::Document.new("") }
+        ReadmeScore.for(repo)
+    end
+
+    it "should not load for HTML" do
+      html = "<h1>Sup</h1>"
+      expect(ReadmeScore::Document).to_not receive(:load)
+      ReadmeScore.for(html)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+
+$:.unshift((ROOT + 'lib').to_s)
+require 'readme-score'
+
+require 'webmock/rspec'
+
+module GithubSpecHelpers
+  def stub_github_readme(protocol, repo, user, readme_filename)
+    stub_request(:get, "https://api.github.com/repos/#{repo}/#{user}/readme").
+         with(:headers => {'Accept'=>'application/vnd.github.html', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'})
+  end
+end
+
+RSpec.configure do |config|
+  config.include GithubSpecHelpers
+end