odyssey 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f0cc39517086a71535119d7843fdaafca381bcf
-  data.tar.gz: 43acd7a7ac8c2a5a62cb514e8282b818988976ce
+  metadata.gz: 2d1fb3f77a3fa0deeb56730cde4d76909cd1dcad
+  data.tar.gz: 6bc10bc82cf9665f760eea3c71e6337d69187924
 SHA512:
-  metadata.gz: f0d03ba87c4ad6b9fbfa7cf7aebf00387d6f530c7f530ba7592692361dc4063c27becda6fe4ef3e87cd301a0f859a4f906a1443a5b4535e6738059753a59a05d
-  data.tar.gz: f448c464b36dd545ccc55e5e4017f4bfe22aac37c07ed8b0550c6995834e4b10477a8a64d467ad6faaba65e228631b16c1f76e18cae56315c358c3e7d508b0d0
+  metadata.gz: 506c2480075aa8ba7c415cd556ca934b4c9d39eb5490513495c3b9cb8832b2d1dbaadaa9081d3a992582f6039280fe993785883b3dcbfc2254a2dbec4e8f1d80
+  data.tar.gz: 35d1c55e66c12f547c381586d7d8ff1140ccb25e040208aff1bf237ec90fc594eb11a232ec34f4d9c0f7a707e263923eb8592a90dae7da46b2e5a920dd03aeef

data/README.md

@@ -70,7 +70,7 @@ if all_stats is true, this returns a Hash, similar to the Hash above:
       'average_syllables_per_word' => Float
     }
 
-##Extending Odyssey
+## Extending Odyssey
 
 To extend Odyssey, you can create a class that inherits from Formula.
 
@@ -107,11 +107,11 @@ stats will be a Hash like so:
     }
 
 That is all you need.
-To call your formula you just use 
+To call your formula you just use
 
     Odyssey.cool_new_formula('See Spot run.', true)
 
-Because you have access to the formula's class (when the 'all_stats' flag is true),
+Because you have access to the formula's class (when the `all_stats` flag is true),
 you have access to any other methods or class variables.
 
 ## Contributing

data/lib/formulas/{formula.rb → _formula.rb}

@@ -7,7 +7,7 @@ class Formula
   #   'sentences' => Array,
   #   'syllables' => Array
   # }
-  # 
+  #
   # stats will be a Hash like so:
   # {
   #   'string_length' => Fixnum,
@@ -23,7 +23,11 @@ class Formula
     0
   end
 
+  def score_by_sentence(text, stats_split)
+    0
+  end
+
   def name
     'Generic'
   end
-end
+end

data/lib/formulas/ari.rb

@@ -4,6 +4,16 @@ class Ari < Formula
     calc_score(stats['letter_count'], stats['word_count'], stats['sentence_count'])
   end
 
+  def score_by_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      res.push(calc_score(stats_split['letter_count'][i],
+                          stats_split['word_count'][i],
+                          1))
+    end
+    res
+  end
+
   def calc_score(letter_count, word_count, sentence_count)
     (((4.71 * (letter_count.to_f / word_count.to_f)) + (0.5 * (word_count.to_f / sentence_count.to_f))) - 21.43).round(1)
   end
@@ -11,4 +21,4 @@ class Ari < Formula
   def name
     'Automated Readability Index'
   end
-end
+end

data/lib/formulas/coleman_liau.rb

@@ -4,6 +4,15 @@ class ColemanLiau < Formula
     calc_score(stats['letter_count'], stats['word_count'], stats['sentence_count'])
   end
 
+  def score_by_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      res.push(calc_score(stats_split['letter_count'][i],
+                          stats_split['word_count'][i],
+                          1))
+    end
+  end
+
   def calc_score(letter_count, word_count, sentence_count)
     ((5.89 * (letter_count.to_f / word_count.to_f)) - (0.3 * (sentence_count.to_f / word_count.to_f)) - 15.8).round(1)
   end
@@ -11,4 +20,4 @@ class ColemanLiau < Formula
   def name
     'Coleman-Liau Index'
   end
-end
+end

data/lib/formulas/fake_formula.rb

@@ -4,7 +4,11 @@ class FakeFormula < Formula
     text
   end
 
+  def score_by_sentence(text, stats_split)
+    text["sentences"]
+  end
+
   def name
     "It's fake"
   end
-end
+end

data/lib/formulas/flesch_kincaid_gl.rb

@@ -4,6 +4,16 @@ class FleschKincaidGl < Formula
     calc_score(stats['average_words_per_sentence'], stats['average_syllables_per_word'])
   end
 
+  def score_by_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      res.push(calc_score(stats_split['word_count'][i],
+                          stats_split['average_syllables_per_word'][i]))
+    end
+    res
+  end
+
+
   def calc_score(avg_words, avg_syllables)
     (((0.39 * avg_words) + (11.8 * avg_syllables)) - 15.59).round(1)
   end
@@ -11,4 +21,4 @@ class FleschKincaidGl < Formula
   def name
     'Flesch-Kincaid Grade Level'
   end
-end
+end

data/lib/formulas/flesch_kincaid_re.rb

@@ -4,6 +4,15 @@ class FleschKincaidRe < Formula
     calc_score(stats['average_words_per_sentence'], stats['average_syllables_per_word'])
   end
 
+  def score_by_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      res.push(calc_score(stats_split['word_count'][i],
+                          stats_split['average_syllables_per_word'][i]))
+    end
+    res
+  end
+
   def calc_score(avg_words, avg_syllables)
     ((206.835 - (1.015 * avg_words)) - (84.6 * avg_syllables)).round(1)
   end
@@ -11,4 +20,4 @@ class FleschKincaidRe < Formula
   def name
     'Flesch-Kincaid Reading Ease'
   end
-end
+end

data/lib/formulas/gunning_fog.rb

@@ -5,6 +5,16 @@ class GunningFog < Formula
     calc_score(stats['average_words_per_sentence'], percent)
   end
 
+  def score_per_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      percent = three_syllables(stats_split['word_count'][i],
+                                text['syllables_by_sentence'][i])
+      res.push(calc_score(stats_split['word_count'][i], percent))
+    end
+    res
+  end
+
   #percentage of words with three syllables
   def three_syllables(word_count, syllables)
     with_three = 0
@@ -21,4 +31,4 @@ class GunningFog < Formula
   def name
     'Gunning-Fog Score'
   end
-end
+end

data/lib/formulas/smog.rb

@@ -5,6 +5,15 @@ class Smog < Formula
     calc_score(stats['sentence_count'], with_three)
   end
 
+  def score_per_sentence(text, stats_split)
+    res = []
+    for i in 0..text['sentences'].length-1
+      with_three = three_syllables(text['syllables_per_sentence'][i])
+      res.push(calc_score(1, with_three))
+    end
+    res
+  end
+
   def three_syllables(syllables)
     with_three = 0
     syllables.each do |s|
@@ -20,4 +29,4 @@ class Smog < Formula
   def name
     'SMOG Index'
   end
-end
+end

data/lib/odyssey.rb

@@ -7,10 +7,10 @@ module Odyssey
   #main method
   def self.analyze(text, formula_name = DEFAULT_FORMULA, all_stats = false)
     formula_name ||= DEFAULT_FORMULA
-    
+
     @engine = Odyssey::Engine.new(formula_name)
     score = @engine.score(text)
-    
+
     #return all stats?
     if all_stats
       output = @engine.get_stats

data/lib/odyssey/engine.rb

@@ -4,10 +4,12 @@ module Odyssey
     #instance variables
     @formula
     @score
+    @score_by_sentence
     @stats
     @words
     @sentences
     @syllables
+    @syllables_by_sentence
     @data
 
     #regex
@@ -57,9 +59,21 @@ module Odyssey
           'sentences' => @sentences,
           'syllables' => @syllables
         }
+        @data['words_per_sentence'] = words_by_sentence()
+        @data['syllables_per_sentence'] = syllables_by_sentence(@sentences)
+
+        @stats_by_sentence = {
+          'string_length' => @sentences.map { |a| string_length(a) },
+          'letter_count' => @sentences.map { |a| letter_count(a) },
+          'word_count' => @sentences.map { |a| word_count(a) },
+          'syllable_count' => @sentences.map { |a| syllable_count(a) },
+          'sentence_count' => Array.new(@sentences.length, 1),
+        }
+        @stats_by_sentence['average_syllables_per_word'] = average_syllables_per_word_per_sentence(text)
       end
 
       #now run all that through the formula
+      @score_by_sentence = @formula.score_by_sentence(@data, @stats_by_sentence)
       @score = @formula.score(@data, @stats)
     end
 
@@ -82,11 +96,28 @@ module Odyssey
       count
     end
 
+    def syllables_by_sentence(words)
+      res = []
+      words.each do |w|
+        num = analyze_syllables(w)
+        res << num
+      end
+      res
+    end
+
     def word_count(text)
       @words = text.scan WORD_REGEX
       @words.size
     end
 
+    def words_by_sentence()
+      res = []
+      for i in 0..@sentences.length-1
+        res.push(@sentences[i].scan WORD_REGEX)
+      end
+      res
+    end
+
     def sentence_count(text)
       @sentences = text.scan SENTENCE_REGEX
       @sentences.size
@@ -100,6 +131,14 @@ module Odyssey
       @stats['syllable_count'].to_f / @stats['word_count'].to_f
     end
 
+    def average_syllables_per_word_per_sentence(text)
+      res = []
+      for i in 0..@stats_by_sentence['string_length'].length-1
+        res.push(@stats_by_sentence['syllable_count'][i].to_f / @stats_by_sentence['word_count'][i].to_f)
+      end
+      res
+    end
+
     # for now this just removes html tags
     # but it could do more in the future
     def sanitize(text)
@@ -139,13 +178,27 @@ module Odyssey
         all_stats['name']    = @formula.name
         all_stats['formula'] = @formula
         all_stats['score']   = @score
+        all_stats['score_by_sentence'] = merge_scores_with_sentences()
       end
       all_stats
     end
 
+    def merge_scores_with_sentences()
+      res = []
+      ro = Struct.new(:score, :sentence)
+      for i in 0..@score_by_sentence.length-1
+        r = ro.new
+        r.sentence = @sentences[i]
+        r.score = @score_by_sentence[i]
+        res.push(r)
+      end
+      res
+    end
+
     def reset
       @formula = nil
       @score = 0
+      @score_by_sentence = []
       @stats = {}
       @words = nil
       @sentences = nil

data/lib/odyssey/version.rb

@@ -1,3 +1,3 @@
 module Odyssey
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/odyssey.gemspec

@@ -6,14 +6,14 @@ require 'odyssey/version'
 Gem::Specification.new do |spec|
   spec.name          = "odyssey"
   spec.version       = Odyssey::VERSION
-  spec.authors       = ["Cameron Sutter"]
-  spec.email         = ["cameronsutter0@gmail.com"]
+  spec.authors       = ["Cameron Sutter", "Michael Lahnert", "Daniel Jethro"]
+  spec.email         = ["cameronsutter0@gmail.com", "", "jethrodaniel@gmail.com"]
   spec.description   = %q{Odyssey is an extendible text analyzing gem that outputs the readability score of text. It has several of the common readability formulas available, but defaults to the Flesch-Kincaid Reading Ease score.}
   spec.summary       = %q{Text readability analyzer using Flesch-Kincaid and others}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/cameronsutter/odyssey"
   spec.license       = "MIT"
 
-  spec.add_dependency "require_all"
+  spec.add_dependency "require_all", "~> 2.0"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 3.1", ">= 3.1.0"
+  spec.add_development_dependency "pry", "~> 0"
 end

metadata

@@ -1,29 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: odyssey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Cameron Sutter
+- Michael Lahnert
+- Daniel Jethro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +44,14 @@ dependencies:
   name: rake
   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
@@ -57,6 +59,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
@@ -64,20 +69,23 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   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: Odyssey is an extendible text analyzing gem that outputs the readability
@@ -85,6 +93,8 @@ description: Odyssey is an extendible text analyzing gem that outputs the readab
   defaults to the Flesch-Kincaid Reading Ease score.
 email:
 - cameronsutter0@gmail.com
+- ''
+- jethrodaniel@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,12 +104,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/formulas/_formula.rb
 - lib/formulas/ari.rb
 - lib/formulas/coleman_liau.rb
 - lib/formulas/fake_formula.rb
 - lib/formulas/flesch_kincaid_gl.rb
 - lib/formulas/flesch_kincaid_re.rb
-- lib/formulas/formula.rb
 - lib/formulas/gunning_fog.rb
 - lib/formulas/smog.rb
 - lib/odyssey.rb
@@ -108,7 +118,7 @@ files:
 - odyssey.gemspec
 - spec/odyssey_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/cameronsutter/odyssey
 licenses:
 - MIT
 metadata: {}
@@ -128,11 +138,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Text readability analyzer using Flesch-Kincaid and others
 test_files:
 - spec/odyssey_spec.rb
 - spec/spec_helper.rb
-has_rdoc: