learn_review 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3cc4723caebd0dcb73dcfb0665cfd78998b666911eb26c0b199f75be3cdf75e0
+  data.tar.gz: 36c078a774363ff83f47299d10a50ebdab185162aa56b6d78f66837c14a5c35f
+SHA512:
+  metadata.gz: d2667da1ddfa81299f7e78a7c49f9ae2c3863dd6335acc4caad5aab9b5a049f9e1ad96251886faef9e14d1cc0ee2b26093cf4fcd3e29200f2f711f0df253be24
+  data.tar.gz: 7e0346468c4355fb9625ffe60e3b245a02f5c45581cb45193c7d4655c35d737c363b1fb4f2c9133a764223fe4a5036931bfc4ba71e34daf134caec9275e75c90

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'json'
+gem 'require_all'
+gem 'odyssey'
+gem 'awesome_print'
+
+# Specify your gem's dependencies in readability_score.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/learn_review

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'learn_review'
+LearnReview.new

data/lib/learn_review.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'require_all'
+require 'odyssey'
+require 'awesome_print'
+
+class LearnReview
+  def initialize(filename = 'README.md')
+    puts "Checking the contents of #{filename}..."
+    puts ''
+    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 = %w[he she him her]
+                            .select do |word|
+      text['score']['words'].include?(word)
+    end
+
+    relevant_words = ['readme', 'code along', 'codealong', 'lab', 'test']
+                     .select do |word|
+      text['score']['words'].include?(word)
+    end
+
+    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']
+      .reject { |word| irrelevant_words.include?(word.downcase) }
+      .each do |word|
+      word_hash.key?(word) ? word_hash[word] += 1 : word_hash[word] = 1
+    end
+
+    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,48 @@
+--- !ruby/object:Gem::Specification
+name: learn_review
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- flatironschool
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: maxwell@flatironschool.com
+executables:
+- learn_review
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- bin/learn_review
+- lib/learn_review.rb
+homepage: 
+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: learn_review is a tool for reviewing learn.co lessons
+test_files: []