readability_score 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73894e752f214f41a925418434d3d775c615d545fc17965701aa818858293c23
+  data.tar.gz: 0d77be49f03f63935eb2dee938d95180998dbbe35a41f95c85d6f225b0e93c7b
+SHA512:
+  metadata.gz: 9cad53f1757ce1fa053a5028534acfa764bba33e412d8768b659073030f0539dc9c753a3d9b2eb036a28c2fd4129b3ff8070d7398ea96d7221a9ff625ad76bf3
+  data.tar.gz: 858c1f36a1485dc825efad82fa2d52bd1cc5fdc56e54e8b95ffcdcb314065dc7cb78863042e1d4c80d6e64b14dac12d0ae21c1e96fbf2a1eab42f795bb516aa5

data/bin/rscore

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "readability_score"
+
+if ARGV.length != 1
+  ReadabilityScore.check
+else
+  ReadabilityScore.check ARGV[0]
+end

data/lib/readability_score.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'require_all'
+require 'odyssey'
+require 'awesome_print'
+
+class ReadabilityScore
+  def self.check(filename = "README.md")
+    puts "Checking the contents of #{filename}..."
+    fh = open filename
+    content = fh.read
+    fh.close
+
+    average_readability = Odyssey.ari(content, false)
+    coleman_liau = Odyssey.coleman_liau(content, false)
+    grade_level = Odyssey.flesch_kincaid_grade_level(content, false)
+    readability_ease = Odyssey.flesch_kincaid_reading_ease(content, false)
+    gunning_fog = Odyssey.gunning_fog(content, false)
+    smog = Odyssey.smog(content, false)
+    text = Odyssey.fake_formula(content, true)
+
+    gender_specific_words = ["he", "she", "him", "her"]
+      .select { |word|
+        text["score"]["words"].include?(word)
+      }
+
+    relevant_words = ["readme", "code along", "codealong", "lab", "test"]
+      .select { |word|
+        text["score"]["words"].include?(word)
+      }
+
+    irrelevant_words = ["a", "an", "and", "the", "like", "with", "through", "over", "before", "at", "of", "to", "in", "for", "on", "by", "between", "after", "since", "without", "under", "beyond", "near", "above", "off", "down", "except", "about", "learn", "co", "open", "really", "we're" ]
+    word_hash = {}
+    text["score"]["words"]
+        .select {|word| !irrelevant_words.include?(word.downcase)}
+        .each {|word|
+          word_hash.key?(word) ? word_hash[word] += 1 :  word_hash[word] = 1
+        }
+
+    puts "Automated Readability Index (1 => Kindergarten, 8 => 7th Grade, 14+ => College Level):"
+    puts average_readability
+    puts ""
+    puts "Coleman Liau Index (1 => Kindergarten, 8 => 7th Grade, 14+ => College Level):"
+    puts coleman_liau
+    puts ""
+    puts "Flesch Kincaid Grade Level (1 => Kindergarten, 8 => 7th Grade, 14+ => College Level):"
+    puts grade_level
+    puts ""
+    puts "Flesch Kincaid Reading Ease (100.0-90.0 => 5th Grade, 80.0-70.0 => 7th Grade, 50.0-30.0 => College Level):"
+    puts readability_ease
+    puts ""
+    puts "Gunning Fog Index (7 => 7th grade, 10 => 10th Grade, 13-16 => College Level):"
+    puts gunning_fog
+    puts ""
+    puts "Smog Index (7 => 7th grade, 10 => 10th Grade, 13-16 => College Level):"
+    puts smog
+    puts ""
+
+    puts "Gender specific words: #{gender_specific_words}"
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: readability_score
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- maxwellbenton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-14 00:00:00.000000000 Z
+dependencies: []
+description: Readable uses the Odyssey gem's built in readability index scores to
+  test a particular README.md file. Once installed, simply navigate to a directory
+  with a README present and call the gem to get feedback on the content.
+email:
+- maxwellbenton@gail.com
+executables:
+- rscore
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/rscore
+- lib/readability_score.rb
+homepage: https://github.com/learn-co-curriculum/readable/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Readable generates readability scores for README.md files in the terminal
+test_files: []