bable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80a52778b8d0bc8b38193d5052416259fdaf8754
+  data.tar.gz: 44382d772d69ea548c17ba7542a95d13dd260c4e
+SHA512:
+  metadata.gz: db49fa8b22439844d4b9edc74c88c27784c6d59afe54d82f7790293a5d64c2418f961f115d4d38a4c045e97d9267d3c28a14268ce97c7a8ebf886737a6a58546
+  data.tar.gz: 2df068c45f1d074eeb483a047eefd9d374158c6f29012ad3fdef2a3a3d25201f4832cc9b85e22958a08ae2b6c8e209493a41b1dba5b6fe51e13efae3bab49a0b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  RunRailsCops: false
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Daniel Madrid
+
+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,73 @@
+[![Build Status](https://travis-ci.org/danimashu/bable.svg?branch=master)](https://travis-ci.org/danimashu/bable)
+
+# Bable: Text readability indexes calculator
+
+Bable is a library that will allow you calculate quantitative readability indexes of a given text. Read more about readability tests here: [](https://en.wikipedia.org/wiki/Readability_test).
+
+Besides calculating indexes (currently available: `Automated Readability Index` and `Coleman-Liau index`), it will help you build your own index calculator, giving you the structure and the helper methods for making the process smoother.
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "bable"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bable
+
+## Usage
+
+```ruby
+require "bable"
+
+# List of available indexes
+Bable::Index.avalable_indexes # => [:ari, :coleman_liau]
+
+# Instantiate the default index
+Bable.index("text") # => #<Bable::Index::ColemanLiau @text="text">
+
+# Instantiate a concrete index
+Bable.index("text", index: :ari) # => #<Bable::Index::Ari @text="text">
+
+# Calculate a readability index
+index = Bable.index("text")
+index.calc # => 7.72
+```
+
+## Implement your own index
+
+If you want to implement your own index you just need to create a subclass of `Bable::Index::Base` and define a method `#calc` in it, where you'll calculate the actual formula. Note that instances of `Bable::Index::Base` will come with a `#text` attribute reader, which returns a decorator of `String`, the class `StatisticString` (see [lib/bable/statistic_string.rb](lib/bable/statistic_string.rb) ). You can take advantage of all those methods for implement your index.
+
+```ruby
+module Bable
+  module Index
+    class MyNewIndex < Base
+      def calc
+        # Define your formula here.
+      end
+    end
+  end
+end
+
+# Then use it
+Bable.index("text", index: :my_new_index).calc
+```
+
+## Contributing
+
+1. Fork the repo ( http://github.com/danimashu/bable/fork ).
+2. Create your feature branch `git checkout -b my-new-feature`.
+3. Commit your changes `git commit -am "Add some feature"` referencing a GitHub issue.
+4. Push to the branch `git push origin my-new-feature`.
+5. Create a new Pull Request.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bable/version"
+
+Gem::Specification.new do |s|
+  s.name     = "bable"
+  s.version  = Bable::VERSION
+  s.authors  = ["Daniel Madrid"]
+  s.email    = ["hello@dmadridreina.com"]
+  s.summary  = "Text readability indexes calculator."
+  s.homepage = "https://github.com/danimashu/bable"
+  s.license  = "MIT"
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport", "~> 4.2.4"
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "pry",     "~> 0.10"
+  s.add_development_dependency "rake",    "~> 10.0"
+  s.add_development_dependency "rspec",   "~> 3.3"
+  s.add_development_dependency "rubocop", "~> 0.34"
+  s.add_development_dependency "yard",    "~> 0.8"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bable"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/bable.rb

@@ -0,0 +1,21 @@
+require "bable/version"
+require "bable/index"
+require "bable/index/base"
+Dir.glob(File.join(File.dirname(__FILE__), "bable/index/*.rb")).each do |f|
+  require f
+end
+require "active_support/core_ext/string/inflections"
+
+module Bable
+  class << self
+    # Instantiate a readability index calculator.
+    #
+    # @param text [String] the text to analyse.
+    # @param index [Symbol] the index to use (in underscore format).
+    # @return [Babel::Index::Base] the instantiated subclass of
+    #   `Babel::Index::Base` according to the index.
+    def index(text, index: :coleman_liau)
+      Index.target_class(index).new(text)
+    end
+  end
+end

data/lib/bable/index.rb

@@ -0,0 +1,25 @@
+module Bable
+  module Index
+    class << self
+      # List the implemented readability indexes.
+      #
+      # @return [Array<Symbol>] list of indexes in underscored format.
+      def available_indexes
+        indexes = constants.select do |constant|
+          c = const_get(constant)
+          c.is_a?(Class) && c < Base
+        end
+        indexes.map { |c| c.to_s.underscore.to_sym }
+      end
+
+      def target_class(index)
+        camelized_class = index.to_s.camelize
+
+        fail NotExistingIndexError unless const_defined?(camelized_class)
+        const_get(camelized_class)
+      end
+    end
+
+    class NotExistingIndexError < StandardError; end
+  end
+end

data/lib/bable/index/ari.rb

@@ -0,0 +1,13 @@
+module Bable
+  module Index
+    # This class is responsible of calculating the Automated Readability Index.
+    # Check https://en.wikipedia.org/wiki/Automated_readability_index for
+    # knowing more.
+    class Ari < Base
+      def calc
+        (4.71 * text.characters_count / text.words_count +
+          0.5 * text.words_count / text.sentences_count - 21.43).round(2)
+      end
+    end
+  end
+end

data/lib/bable/index/base.rb

@@ -0,0 +1,23 @@
+require "bable/statistic_string"
+
+module Bable
+  module Index
+    class Base
+      attr_reader :text
+
+      def initialize(text)
+        @text = StatisticString.new(text)
+      end
+
+      # The calculation of the readability index. This method should be
+      # implemented in each index class (subclass of Base). The returning value
+      # could potentially means different things, depending on the index. Read
+      # the documentation of each index for knowing more.
+      #
+      # @return [Float] the resulting calculation of the index.
+      def calc
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/bable/index/coleman_liau.rb

@@ -0,0 +1,22 @@
+module Bable
+  module Index
+    # This class is responsible of calculating the Coleman-Liau Index. Check
+    # https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index for knowing more.
+    class ColemanLiau < Base
+      def calc
+        (0.0588 * average_chars_per_100_words -
+          0.296 * average_sentences_per_100_words - 15.8).round(2)
+      end
+
+      private
+
+      def average_chars_per_100_words
+        text.average_word_length * 100
+      end
+
+      def average_sentences_per_100_words
+        text.average_word_length * 100 / text.average_sentence_length
+      end
+    end
+  end
+end

data/lib/bable/statistic_string.rb

@@ -0,0 +1,34 @@
+module Bable
+  class StatisticString < SimpleDelegator
+    WORD_REGEX     = /\w+/
+    SENTENCE_REGEX = /[^\s.?!:][^.?!:]*[.?!:]+/
+
+    def words
+      scan(WORD_REGEX)
+    end
+
+    def sentences
+      scan(SENTENCE_REGEX)
+    end
+
+    def characters_count
+      words.join.size
+    end
+
+    def words_count
+      words.size
+    end
+
+    def sentences_count
+      sentences.size
+    end
+
+    def average_word_length
+      characters_count / words_count.to_f
+    end
+
+    def average_sentence_length
+      characters_count / sentences_count.to_f
+    end
+  end
+end

data/lib/bable/version.rb

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: bable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Madrid
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- hello@dmadridreina.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bable.gemspec
+- bin/console
+- bin/setup
+- lib/bable.rb
+- lib/bable/index.rb
+- lib/bable/index/ari.rb
+- lib/bable/index/base.rb
+- lib/bable/index/coleman_liau.rb
+- lib/bable/statistic_string.rb
+- lib/bable/version.rb
+homepage: https://github.com/danimashu/bable
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Text readability indexes calculator.
+test_files: []
+has_rdoc: