odyssey 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8e415094592c3db8e4c7ef95471e8a8d9fe974e6082a68ca1aee14741859d78
-  data.tar.gz: 2706164618acba8b59271b8edcef213fade62ec9da2d1b94b815db807f58adba
+  metadata.gz: ca6a284fce2d0aae3b4cbba40c7a44212b318146525c8b68044d5f8293c6d39f
+  data.tar.gz: 74e76ecbec621570651e6c89d043355d4adc6773e5e6996efe6864cce1e2d670
 SHA512:
-  metadata.gz: 9b194aa3f7a798a6decd7a9998e9b8c0e4c04ae7a8f8547c32ae8a7cce7102c3346528d2dfa38e1ea1acc4f888559d99f644aded4afc78fd67f0947e56064e2a
-  data.tar.gz: 2f041bbe7cbd458bcc75625eafe527bd9776df99c20b3774f4158c04d4aca9db969e385f74d3e7769bca2831eb47e8feeed5e90bc59ddb6eab9a5c9573e06635
+  metadata.gz: f96f23450e57618982d81b2b79aa1e33f22486fd69cbcbe9caf23197b96611e33a678408b7d3aada5d90a0b395337d691655a7dd0de51c8f6f58e1277884be93
+  data.tar.gz: b605033fd23d562e6d2d3676b85911d13b1b3b0ab3d7899b0b46124d4001d0e6b724a37d0b5ab8baa9a22fe9bd1ae2c0e2633990ff234a94db517a934bdca451

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: ci
+
+on: [push]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.4.x', '2.5.x', '2.6.x', '2.7.x']
+    env:
+      CI: true
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        submodules: true
+
+    - name: set up ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: setup bundler, gems
+      run: |
+        gem install bundler
+        bundle install
+
+    - name: run specs
+      run: |
+        bundle exec rake spec

data/README.md

@@ -1,7 +1,7 @@
 # Odyssey
 
 [![Gem Version](https://badge.fury.io/rb/odyssey.svg)](https://badge.fury.io/rb/odyssey)
-[![Build Status](https://travis-ci.org/cameronsutter/odyssey.svg?branch=master)](https://travis-ci.org/cameronsutter/odyssey)
+![](https://github.com/cameronsutter/odyssey/workflows/ci/badge.svg)
 
 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.
 

data/changelog.md

@@ -0,0 +1,3 @@
+### Odyssey v0.3.2
+
+- `Odyssey.analyze_multi` now raises `Odyssey::ArgumentError` instead of `ArgumentError`.

data/lib/odyssey.rb

@@ -1,7 +1,7 @@
-require "odyssey/version"
+require "odyssey/error"
 
 module Odyssey
-
+  FORMULAS = %w[Ari ColemanLiau FleschKincaidGl FleschKincaidRe GunningFog Smog]
   DEFAULT_FORMULA = 'FleschKincaidRe'
 
   #main method
@@ -11,18 +11,13 @@ module Odyssey
     @engine = Odyssey::Engine.new(formula_name)
     score = @engine.score(text)
 
-    #return all stats?
-    if all_stats
-      output = @engine.get_stats
-    else
-      output = score
-    end
+    return @engine.get_stats if all_stats
 
-    output
+    score
   end
 
   def self.analyze_multi(text, formula_names, all_stats = false)
-    raise ArgumentError, "You must supply at least one formula" if formula_names.empty?
+    raise Odyssey::ArgumentError, "You must supply at least one formula" if formula_names.empty?
 
     scores = {}
     @engine = Odyssey::Engine.new(formula_names[0])
@@ -33,20 +28,15 @@ module Odyssey
       scores[formula_name] = @engine.score("", false)
     end
 
-    if all_stats
-      all_stats = @engine.get_stats(false)
-      all_stats['scores'] = scores
-      output = all_stats
-    else
-      output = scores
-    end
+    return scores unless all_stats
 
-    output
+    all_stats = @engine.get_stats(false)
+    all_stats['scores'] = scores
+    all_stats
   end
 
   def self.analyze_all(text)
-    formulas = %w[Ari ColemanLiau FleschKincaidGl FleschKincaidRe GunningFog Smog]
-    analyze_multi text, formulas, true
+    analyze_multi text, FORMULAS, true
   end
 
   #run whatever method was given as if it were a shortcut to a formula
@@ -56,11 +46,6 @@ module Odyssey
     super unless Object.const_defined? formula_class
     analyze(args[0], formula_class, args[1] || false)
   end
-
-  #define this here, so it doesn't get sent to method_missing()
-  def self.to_ary
-    []
-  end
 end
 
 require 'odyssey/engine'

data/lib/odyssey/error.rb

@@ -0,0 +1,4 @@
+module Odyssey
+  class Error < StandardError; end
+  class ArgumentError < Error; end
+end

data/lib/odyssey/version.rb

@@ -1,3 +1,3 @@
 module Odyssey
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/odyssey_spec.rb

@@ -1,6 +1,13 @@
 require 'spec_helper'
 
 describe Odyssey do
+  describe '.analyze_multi' do
+    it 'raises an error if no formulas are supplied' do
+      expect do
+        Odyssey.analyze_multi(one_simple_sentence, [])
+      end.to raise_error(Odyssey::ArgumentError)
+    end
+  end
 
   context 'default formula' do
     it 'should return something' do
@@ -117,7 +124,7 @@ describe Odyssey do
     end
 
     it 'should raise an error for empty formula list' do
-      expect { Odyssey.analyze_multi one_simple_sentence, [] }.to raise_error(ArgumentError)
+      expect { Odyssey.analyze_multi one_simple_sentence, [] }.to raise_error(Odyssey::ArgumentError)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: odyssey
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Cameron Sutter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,14 +75,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- changelog.md
 - lib/odyssey.rb
 - lib/odyssey/engine.rb
+- lib/odyssey/error.rb
 - lib/odyssey/formulas/ari.rb
 - lib/odyssey/formulas/coleman_liau.rb
 - lib/odyssey/formulas/fake_formula.rb
@@ -123,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Text readability analyzer using Flesch-Kincaid and others

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-
-dist: bionic # Ubuntu 18.04
-
-# Test against all Ruby-supported versions
-#
-# See https://www.ruby-lang.org/en/downloads/branches/
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-
-script: |
-  bundle exec rake spec
-
-notifications:
-  email: false