flesch_kincaid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad4fa6c2dfc9314c73443857132beea60178be73
+  data.tar.gz: 2893d25edbb290acba77003343b8c49b2d9e12f0
+SHA512:
+  metadata.gz: 128762881c47d201f076d846039052044eb0f3bd7e2e67f8106a9634dc2311a03b344497774ac7436fa88cf063be6b173a64e1ad4d67f897cd7e55b826f3d76e
+  data.tar.gz: 5fd13ef7fc1fee7656837fa95e858eb6ec3abb355b38650fc10458a3fe58f2ff8cafdc2384d978908b5e5cca4cc03ae536a478193b855141b30945389cb97728

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bodacious
+
+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,62 @@
+# FleschKincaid
+
+Simple, super-lightweight gem for calculating the Flesch Kincaid score for a given block of text.
+
+## Vs Odyssey
+
+We needed to calculate F.K. scores in Ruby.
+
+There's a similar gem named [Odyssey](https://github.com/cameronsutter/odyssey), which provides some additional formulae too. However, that codebase is a bit larger and slower.
+
+[flesch_kincaid](https://github.com/KatanaCode/flesch_kincaid) is more than 2x faster (see the [benchmark](benchmarks/odyssey.rb))
+
+If you just need standard Flesch Kincaid scores, this gem should do the trick.
+
+    Warming up --------------------------------------
+                 Odyssey    31.000  i/100ms
+          Flesch Kincaid    75.000  i/100ms
+    Calculating -------------------------------------
+                 Odyssey    323.004  (± 4.0%) i/s -      1.643k in   5.095737s
+          Flesch Kincaid    764.062  (± 3.3%) i/s -      3.825k in   5.012054s
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flesch_kincaid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flesch_kincaid
+
+## Usage
+
+``` ruby
+@result = FleschKincaid.read("I can't explain myself, I'm afraid, sir' said Alice, 'because I'm not myself, you see.")
+@result.score # => 75.77
+@result.grade # => "7th grade"
+@result.notes # => "Fairly easy to read."
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/katanacode/flesch_kincaid.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/benchmarks/odyssey.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), "lib")
+
+require "benchmark/ips"
+require "odyssey"
+require "flesch_kincaid"
+
+TEXT = DATA.read
+
+Benchmark.ips do |test|
+
+  test.report "Odyssey" do
+    Odyssey.flesch_kincaid_re(TEXT, false)
+  end
+
+  test.report "Flesch Kincaid" do
+    FleschKincaid.read(TEXT).score
+  end
+
+end
+
+__END__
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam commodo lobortis justo eget interdum. Nullam lorem ex, efficitur nec ornare eu, fringilla ac nulla. Nulla facilisi. Donec accumsan accumsan sem, et dignissim dolor porta at. Nulla fringilla magna ac magna tincidunt mattis. Quisque aliquet, est nec tristique blandit, felis odio efficitur dui, in convallis massa orci ut nisl. Nullam hendrerit justo vel ante placerat, et imperdiet urna volutpat. Proin risus libero, accumsan ut tellus a, lacinia ultricies nisl. Fusce ultricies interdum diam, vitae tincidunt odio maximus id. Praesent in tortor aliquam mi pulvinar dignissim. Interdum et malesuada fames ac ante ipsum primis in faucibus.
+
+Suspendisse et odio justo. Maecenas dolor ipsum, commodo et justo et, pulvinar hendrerit sapien. Donec dapibus lacus nec eros congue tincidunt. Vestibulum ut eleifend nibh. Curabitur vehicula dui mollis, tempor odio eget, dignissim lorem. In tempus, nisl sed feugiat luctus, enim dolor sollicitudin velit, nec cursus erat sapien non purus. Sed in lacus et lectus vestibulum fermentum. Integer et dignissim purus, sit amet fringilla ante. In finibus sed orci non rhoncus. Maecenas a tempus augue. Pellentesque vel justo id odio condimentum porta.
+
+Morbi pulvinar dignissim lorem, a tincidunt sem tempor nec. Suspendisse ultrices sapien ut nisi vehicula varius. Aenean pharetra ligula et convallis blandit. Curabitur iaculis eget mauris et interdum. Aenean rhoncus eros sed placerat semper. Aenean a ex elementum, tincidunt risus sit amet, ultricies est. Ut aliquet urna a blandit aliquam. Quisque vel porttitor ex. Curabitur erat odio, dapibus ac tortor sit amet, auctor finibus augue. Suspendisse varius sit amet ligula sed ornare. Duis consectetur posuere pharetra. Praesent ornare ante blandit sem tincidunt fringilla. Interdum et malesuada fames ac ante ipsum primis in faucibus. Aliquam erat volutpat. Morbi auctor elit vel sollicitudin tincidunt. Duis auctor sit amet tellus iaculis maximus.
+
+In finibus cursus lectus, ac elementum ante volutpat non. Duis rhoncus euismod purus vitae placerat. Donec vitae tempor velit, quis egestas purus. Mauris condimentum tellus vitae diam laoreet mattis. Nulla lobortis lectus sit amet neque volutpat, sed dapibus lacus tempus. Nullam ligula tellus, tempus auctor faucibus eu, efficitur in odio. Proin molestie fringilla turpis in rhoncus. Nam sollicitudin magna vulputate est luctus, ut porta libero facilisis. Mauris rhoncus nisl a arcu interdum, a pulvinar justo vestibulum. Nulla quis sodales ipsum. Donec nulla felis, hendrerit ac mauris lobortis, suscipit eleifend lectus. Suspendisse nisi mi, imperdiet nec iaculis eu, vestibulum at nisl.
+
+Donec sit amet lectus quis justo faucibus sagittis. Proin eros mauris, sodales non arcu in, ullamcorper tristique lectus. Mauris dignissim tempus nunc, sed mattis ipsum tincidunt nec. Praesent tristique urna sem, euismod vulputate risus tempor quis. Donec nec lacinia eros. Nulla mauris felis, ultrices ac molestie et, vulputate id odio. Aliquam ac imperdiet libero, at faucibus ipsum. Nulla sollicitudin pharetra tempor. Donec turpis purus, maximus id molestie vitae, vulputate sit amet odio.
+
+Morbi aliquam metus urna, ut porta nibh mattis ac. Pellentesque ut neque magna. Quisque pellentesque enim eu nunc commodo condimentum. Proin id posuere dui, vitae euismod sem. Suspendisse et metus ex. Ut vulputate pellentesque orci, in sagittis nisi laoreet eu. Donec ac arcu dui. Fusce suscipit imperdiet elementum.
+
+Ut dapibus aliquet nibh a posuere. Vivamus accumsan sapien quis augue dictum vehicula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Integer sit amet lacus massa. Duis pretium eleifend ante et vulputate. Praesent iaculis eu erat vel ornare. Donec luctus nisl ac purus consequat, nec sagittis mauris tincidunt.
+
+Nulla molestie placerat nisi, nec sollicitudin elit venenatis eu. In malesuada, nunc sed feugiat vulputate, neque erat tincidunt sapien, quis convallis purus leo et arcu. Proin vel ligula id enim aliquet commodo. Aliquam semper justo sed finibus tempus. Praesent ullamcorper sit amet mi sed ullamcorper. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ultrices purus nulla, vel ultrices risus aliquet eu. Nunc dolor sapien, faucibus quis quam sit amet, aliquam vehicula mi. Cras accumsan semper augue, id consectetur mauris elementum ac. Donec quis nulla non eros tempus bibendum. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flesch_kincaid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flesch_kincaid.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flesch_kincaid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flesch_kincaid"
+  spec.version       = FleschKincaid::VERSION
+  spec.authors       = ["Bodacious"]
+  spec.email         = ["gavin@katanacode.com"]
+
+  spec.summary       = %q{Lightweight gem for running Flesch Kincaid tests against text}
+  spec.description   = %q{Flesch Kincaid allows you to parse blocks of text and assess their readability based on the Flesch Kincaid metric.}
+  spec.homepage      = "https://github.com/katanacode/flesch_kincaid"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/flesch_kincaid.rb

@@ -0,0 +1,12 @@
+require "flesch_kincaid/version"
+require "flesch_kincaid/test"
+require "flesch_kincaid/result"
+module FleschKincaid
+
+  module_function
+
+  def read(text)
+    FleschKincaid::Test.new(text).result
+  end
+
+end

data/lib/flesch_kincaid/result.rb

@@ -0,0 +1,75 @@
+module FleschKincaid
+
+  # Internal: A test result object, containing the score, grade, and notes.
+  #
+  # Examples
+  #
+  #   @result = Result.new(80)
+  #   @result.score # => 80.0
+  #
+  #   @result = Result.new(80)
+  #   @result.grade # => "6th grade"
+  #
+  #   @result = Result.new(80)
+  #   @result.notes # => "Easy to read. Conversational English for consumers."
+  class Result
+
+    ##
+    # The Flesh Kincaid formula result score.
+    #
+    # Returns {Float}
+    attr_reader :score
+
+
+    # Initialize a new Result
+    #
+    # score - The Flesh Kincaid formula result score.
+    #
+    def initialize(score)
+      @score = score.to_f
+    end
+
+    # Approx. reading age for score.
+    #
+    # Returns {String}
+    def grade
+      case score
+      when 90..100 then "5th grade"
+      when 80..90  then "6th grade"
+      when 70..80  then "7th grade"
+      when 60..70  then "8th & 9th grade"
+      when 50..60  then "10th to 12th grade"
+      when 30..50  then "College"
+      when 1..30   then "College Graduate"
+      else
+        "n/a"
+      end
+    end
+
+    # Additional notes to describe the score
+    #
+    # Returns {String}
+    def notes
+      case score
+      when 90..100
+        "Very easy to read. Easily understood by an average 11-year-old student."
+      when 80..90
+        "Easy to read. Conversational English for consumers."
+      when 70..80
+        "Fairly easy to read."
+      when 60..70
+        "Plain English. Easily understood by 13-15-year-old students."
+      when 50..60
+        "Fairly difficult to read."
+      when 30..50
+        "Difficult to read."
+      when 1..30
+        "Very difficult to read. Best understood by university graduates."
+      else
+        "No score available"
+      end
+    end
+
+  end
+
+end

data/lib/flesch_kincaid/test.rb

@@ -0,0 +1,84 @@
+module FleschKincaid
+
+  ##
+  # Internal: Tests a block of text based on the Flesch-Kincaid readability test and
+  # returns a {Result}.
+  #
+  #
+  # Examples
+  #
+  #   FleschKincaid::Test.new("A sentence that is long and hard to read").result
+  class Test
+
+    BASE = 206.835.freeze
+
+    SENTENCE_MULTIPLIER = 1.015.freeze
+
+    SYLLABLE_MULTIPLIER = 84.6.freeze
+
+    WORD_REGEX = /\w+[^\w]/.freeze
+
+    SENTENCE_REGEX = /[\w\s](\.|\!|\?)+/.freeze
+
+    COMPRESS_VOWEL_REGEX = /(?:[^laeiouy]es|ed|[^laeiouy]e)$/.freeze
+
+    Y_REGEX = /^y/.freeze
+
+    VOWEL_REGEX = /[aeiouy]{1,2}/.freeze
+
+
+    attr_reader :text
+
+
+    def initialize(text)
+      @text = text
+    end
+
+    def result
+      @result ||= Result.new(formula_output)
+    end
+
+    # The total number of words in {text}
+    #
+    # Returns {Integer}
+    def total_words
+      text.scan(WORD_REGEX).count
+    end
+
+    # The total number of sentences in {text}
+    #
+    # Returns {Integer}
+    def total_sentences
+      text.scan(SENTENCE_REGEX).count
+    end
+
+    # The total number of syllables in {text}
+    #
+    # Returns {Integer}
+    def total_syllables
+      return 1 if text.length <= 3
+      text
+        .downcase
+        .sub(COMPRESS_VOWEL_REGEX, '')
+        .sub(Y_REGEX, '')
+        .scan(VOWEL_REGEX).size
+    end
+
+
+    private
+
+
+    # Runs the Flesch Kincaid formula:
+    #
+    # 206.835 - 1.015(totalwords / totalsentences) - 84.6 (totalsyllables / total words)
+    #
+    # Returns {Float}
+    def formula_output
+      return 0.0 if total_words == 0 || total_sentences == 0
+      sentence_val = SENTENCE_MULTIPLIER * Rational(total_words, total_sentences)
+      syllable_val = SYLLABLE_MULTIPLIER * Rational(total_syllables, total_words)
+      (BASE - sentence_val - syllable_val).round(2)
+    end
+
+  end
+end

data/lib/flesch_kincaid/version.rb

@@ -0,0 +1,3 @@
+module FleschKincaid
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: flesch_kincaid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Flesch Kincaid allows you to parse blocks of text and assess their readability
+  based on the Flesch Kincaid metric.
+email:
+- gavin@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/odyssey.rb
+- bin/console
+- bin/setup
+- flesch_kincaid.gemspec
+- lib/flesch_kincaid.rb
+- lib/flesch_kincaid/result.rb
+- lib/flesch_kincaid/test.rb
+- lib/flesch_kincaid/version.rb
+homepage: https://github.com/katanacode/flesch_kincaid
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Lightweight gem for running Flesch Kincaid tests against text
+test_files: []