readme-score 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9349f1f7324a4fd2257ec0d917e526bf42bb3d38
+  data.tar.gz: aa9b06e70969999360ea05cb4a41085a26001a56
+SHA512:
+  metadata.gz: fe0b9f3a1663f6a59951e93522804fec27e67e84d5cccac980e8eefcfa75bda1fedfeec96db1d375d26799a410fad130802a13ec8eae524a3d667ebebb2c4c64
+  data.tar.gz: e2667d4bfc8742c1fe975fbdfc33626c9feda8bb4428e77a6aca5b55083f723162df2c1cc13c018e81517e5fb4f447113e9681106d5523f315164edc72fb332f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+data/cache

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in readme-score.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    readme-score (0.0.2)
+      nokogiri (>= 1.6.0)
+      octokit (>= 3.2.0)
+      redcarpet (>= 3.1.0)
+      unirest (>= 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    dotenv (1.0.2)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    json (1.8.1)
+    mime-types (1.25.1)
+    mini_portile (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    octokit (3.4.2)
+      sawyer (~> 0.5.3)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    redcarpet (3.2.0)
+    rest-client (1.6.8)
+      mime-types (~> 1.16)
+      rdoc (>= 2.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    sawyer (0.5.5)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+    webmock (1.19.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  dotenv
+  rake
+  readme-score!
+  rspec
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Clay Allsopp
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# ReadmeScore
+
+[![Build Status](https://travis-ci.org/clayallsopp/readme-score.svg)](https://travis-ci.org/clayallsopp/readme-score)
+[![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=clayallsopp/readme-score&bust=1)](http://clayallsopp.github.io/readme-score?url=clayallsopp/readme-score)
+
+Gives a complexity score for a README.
+
+Check scores of any repo in your browser: [http://scoreme.report](http://scoreme.report)
+
+There's an [HTTP API too](http://github.com/clayallsopp/readme-score-api)!
+
+
+Example score:
+
+| Repo                                                          | Score |
+|---------------------------------------------------------------|-------|
+| https://github.com/RolandasRazma/RRFPSBar                     | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=RolandasRazma/RRFPSBar)](http://clayallsopp.github.io/readme-score?url=RolandasRazma/RRFPSBar)    |
+| https://github.com/JRG-Developer/MediaRSSParser               | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=JRG-Developer/MediaRSSParser)](http://clayallsopp.github.io/readme-score?url=JRG-Developer/MediaRSSParser)    |
+| https://github.com/ruslanskorb/RSDayFlow                      | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=ruslanskorb/RSDayFlow)](http://clayallsopp.github.io/readme-score?url=ruslanskorb/RSDayFlow)    |
+| https://github.com/samnung/AFHTTPFileUpdateOperation          | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=samnung/AFHTTPFileUpdateOperation)](http://clayallsopp.github.io/readme-score?url=samnung/AFHTTPFileUpdateOperation)    |
+| https://github.com/schneiderandre/ASCFlatUIColor              | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=schneiderandre/ASCFlatUIColor)](http://clayallsopp.github.io/readme-score?url=schneiderandre/ASCFlatUIColor)    |
+| https://github.com/daltoniam/BootstrapUIKit                   | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=daltoniam/BootstrapUIKit)](http://clayallsopp.github.io/readme-score?url=daltoniam/BootstrapUIKit)    |
+| https://github.com/AFNetworking/AFNetworking                  | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=AFNetworking/AFNetworking)](http://clayallsopp.github.io/readme-score?url=AFNetworking/AFNetworking)    |
+| https://github.com/tomersh/AppleGuice                         | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=tomersh/AppleGuice)](http://clayallsopp.github.io/readme-score?url=tomersh/AppleGuice)    |
+| https://github.com/kevindelord/DKHelper                       | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=kevindelord/DKHelper)](http://clayallsopp.github.io/readme-score?url=kevindelord/DKHelper)    |
+| https://github.com/saturngod/IAPHelper                        | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=saturngod/IAPHelper)](http://clayallsopp.github.io/readme-score?url=saturngod/IAPHelper)    |
+| https://github.com/alskipp/ASValueTrackingSlider              | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=alskipp/ASValueTrackingSlider)](http://clayallsopp.github.io/readme-score?url=alskipp/ASValueTrackingSlider)    |
+| https://github.com/phranck/CNTreeNode                         | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=phranck/CNTreeNode)](http://clayallsopp.github.io/readme-score?url=phranck/CNTreeNode)    |
+| https://github.com/dasdom/DDHDynamicViewControllerTransitions | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=dasdom/DDHDynamicViewControllerTransitions)](http://clayallsopp.github.io/readme-score?url=dasdom/DDHDynamicViewControllerTransitions)    |
+| https://github.com/RestKit/RestKit                            | [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=RestKit/RestKit)](http://clayallsopp.github.io/readme-score?url=RestKit/RestKit)   |
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'readme-score'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readme-score
+
+## Usage
+
+Pass in a URL:
+
+```ruby
+url = "https://raw.githubusercontent.com/AFNetworking/AFNetworking/master/README.md"
+score = ReadmeScore.for(url)
+score.total_score
+# => 95
+```
+
+Pass in a Github Repo:
+
+```ruby
+score = ReadmeScore.for("afnetworking/afnetworking")
+score.total_score
+# => 95
+```
+
+Pass in HTML:
+
+```ruby
+html = "AFNetworking is a delightful networking library for iOS and Mac OS X...."
+score = ReadmeScore.for(html)
+score.total_score
+# => 95
+```
+
+## Configuration
+
+### Settings
+
+- `ReadmeScore.use_github_api = <boolean>` - whether or not to use the Github API when loading a Github repo's readme. If `false`, will attempt to find the correct readme URL without the API (which could fail unexpectedly). Defaults to `true`
+
+- `ReadmeScore.github_api_token = <token>` - a token to use with the Github API. Supercedes the ENV variable.
+
+### Environment Variables
+
+| ENV                                                          | Description |
+|---------------------------------------------------------------|-------|
+| READMESCORE_GITHUB_TOKEN                     | If scoring a Github repo, ReadmeScore will try to grab the canonical representation via the Github API. By default, [unauthenticated requests are limited](https://developer.github.com/v3/#rate-limiting) to 60/hour. Set this env variable to increase that limited to 5k/hour.    |

data/Rakefile

@@ -0,0 +1,133 @@
+ROOT = File.dirname(__FILE__)
+
+$:.unshift(File.join(ROOT, 'lib'))
+require 'readme-score'
+
+require "bundler/gem_tasks"
+
+require 'json'
+require 'ostruct'
+require 'fileutils'
+
+require 'dotenv'
+Dotenv.load
+
+def loaded_seed_data
+  JSON.parse(IO.read("data/seed.json")).map {|d|
+    OpenStruct.new(d).tap { |o|
+      o.repo_name = o.readme.split("/")[-1]
+      o.cache_path = File.join(ROOT, "data", "cache", "#{o.repo_name}.md")
+    }
+  }
+end
+
+def seed_data(d)
+  buffer = "------\n"
+  buffer << d.output_metrics
+  buffer << "------\n"
+  buffer << d.html
+end
+
+def analyze(document_tuples)
+  document_tuples.each {|seed, d|
+    # puts seed_data(d)
+  }
+  repo_names = document_tuples.map(&:first).map(&:repo_name)
+  scores = document_tuples.map(&:first).map(&:score)
+  documents = document_tuples.map(&:last)
+
+  Statsample::Analysis.store(Statsample::Regression::Multiple) do |suite|
+    metric_hash = {}
+    ReadmeScore::Document::Metrics::EQUATION_METRICS.each do |metric|
+      puts metric
+      metric_hash[metric] = documents.map(&:text_metrics).map(&metric.to_proc).to_scale
+    end
+    puts metric_hash
+    ds = suite.dataset(metric_hash)
+    ds['score'] = scores.to_scale
+    @regression = suite.lr(ds, 'score')
+  end
+
+  Statsample::Analysis.run_batch
+
+  equation = ReadmeScore::Equation.new(@regression.constant, @regression.coeffs)
+
+  differentials = []
+  documents.each.with_index {|d, i|
+    puts repo_names[i]
+    predection = scores[i]
+    calculated = equation.value_for(d.text_metrics)
+    differentials << (predection - calculated).abs
+    puts "Predection: #{predection}; Equation: #{calculated}"
+  }
+  puts "Average diff: #{differentials.to_scale.mean}"
+
+  ReadmeScore::Equation.save_as_default!(equation)
+end
+
+desc "Analyze seed data"
+task :seed do
+  seed_data = loaded_seed_data
+  documents = seed_data.map {|d|
+    [d, ReadmeScore::Document.load(d.readme)]
+  }
+  analyze(documents)
+end
+
+task :seed_from_cache do
+  seed_data = loaded_seed_data
+  #seed_data = [seed_data[0]]
+  documents = seed_data.map {|d|
+    cached_markdown = IO.read(d.cache_path)
+    html = ReadmeScore::Document::Parser.new(cached_markdown).to_html
+    [d, ReadmeScore::Document.new(html)]
+  }
+  analyze(documents)
+end
+
+desc "Cache the seed data locally"
+task :cache_seed do
+  seed_data = loaded_seed_data
+  seed_data.each {|d|
+    FileUtils.mkdir_p(File.dirname(d.cache_path))
+    loader = ReadmeScore::Document::Loader.new(d.readme)
+    loader.load!
+    File.open(d.cache_path, 'w') {|f| f.write(loader.response.body) }
+  }
+end
+
+task :example do
+  d = ReadmeScore::Document.load("http://github.com/usepropeller/applebot")
+  puts d.score.total_score
+end
+
+task :compare_seeds do
+  seed_data = loaded_seed_data
+  documents = seed_data.map {|d|
+    html = IO.read(d.cache_path)
+    [d, ReadmeScore::Document.new(html)]
+    # [d, ReadmeScore::Document.load(d.readme)]
+  }
+  differentials = []
+  documents.each {|seed, d|
+    puts seed.readme
+    predection = seed.score
+    calculated = d.score.total_score
+    differentials << (predection - calculated).abs
+    puts "Predection: #{predection}; Equation: #{calculated}"
+  }
+  puts differentials
+  puts "Average diff: #{differentials.to_scale.mean}"
+end
+
+task :console do
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end

data/data/seed.json

@@ -0,0 +1,58 @@
+[
+    {
+        "readme": "https://github.com/RolandasRazma/RRFPSBar",
+        "score": 30
+    },
+    {
+        "readme": "https://github.com/JRG-Developer/MediaRSSParser",
+        "score": 50
+    },
+    {
+        "readme": "https://github.com/ruslanskorb/RSDayFlow",
+        "score": 40
+    },
+    {
+        "readme": "https://github.com/samnung/AFHTTPFileUpdateOperation",
+        "score": 25
+    },
+    {
+        "readme": "https://github.com/schneiderandre/ASCFlatUIColor",
+        "score": 65
+    },
+    {
+        "readme": "https://github.com/daltoniam/BootstrapUIKit",
+        "score": 45
+    },
+    {
+        "readme": "https://github.com/AFNetworking/AFNetworking",
+        "score": 100
+    },
+    {
+        "readme": "https://github.com/tomersh/AppleGuice",
+        "score": 80
+    },
+    {
+        "readme": "https://github.com/kevindelord/DKHelper",
+        "score": 10
+    },
+    {
+        "readme": "https://github.com/saturngod/IAPHelper",
+        "score": 60
+    },
+    {
+        "readme": "https://github.com/alskipp/ASValueTrackingSlider",
+        "score": 100
+    },
+    {
+        "readme": "https://github.com/phranck/CNTreeNode",
+        "score": 30
+    },
+    {
+        "readme": "https://github.com/dasdom/DDHDynamicViewControllerTransitions",
+        "score": 90
+    },
+    {
+        "readme": "https://github.com/RestKit/RestKit",
+        "score": 100
+    }
+]

data/lib/readme-score.rb

@@ -0,0 +1,47 @@
+require 'nokogiri'
+require 'unirest'
+require 'redcarpet'
+require 'octokit'
+
+require 'json'
+
+require "readme-score/version"
+require "readme-score/util"
+require "readme-score/document"
+
+module ReadmeScore
+  ROOT = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+  module_function
+  def for(url_or_html)
+    document(url_or_html).score
+  end
+
+  def document(url_or_html)
+    document = nil
+    if Document::Loader.is_url?(url_or_html)
+      document = Document.load(url_or_html)
+    elsif Document::Loader.is_github_repo_slug?(url_or_html)
+      document = Document.load("http://github.com/#{url_or_html}")
+    else
+      document = Document.new(url_or_html)
+    end
+    document
+  end
+
+  def use_github_api?
+    !@reject_github_api
+  end
+
+  def use_github_api=(use_github_api)
+    @reject_github_api = !use_github_api
+  end
+
+  def github_api_token=(github_api_token)
+    @github_api_token = github_api_token
+  end
+
+  def github_api_token
+    @github_api_token || ENV['READMESCORE_GITHUB_TOKEN']
+  end
+end