RubyGems - article_readingtime - Versions diffs - 1.0.0 - Mend

article_readingtime 1.0.0

Files changed (15) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.rspec +2 -0
data/.rubocop.yml +16 -0
data/.travis.yml +4 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +71 -0
data/Rakefile +6 -0
data/article_readingtime.gemspec +27 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/lib/article_readingtime.rb +43 -0
data/lib/article_readingtime/version.rb +3 -0
metadata +127 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bacadfe4d5dc6d07378ef525dfc64f76361420b
+  data.tar.gz: 8a33f5205662ef4c4a8d3bd737f4c7ef16942e37
+SHA512:
+  metadata.gz: 0fdc4f6aca1f9b7a5012b8e71ce63667ddd2b0a5f4ac01cccffb826ed8581f99b4d32a24bcabfafec6840dd170643752ab5d25c977cf5cc7b47b5f7638cd60a8
+  data.tar.gz: acc3bb9151adde7dd9600694e271f9ece240b6bcadb4bb2ee64bb446d0156868b3c4be917c2f139e72141ffd5c3e56e5bc6057b47e365eb87c197383462efc1b

data/.gitignore ADDED

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

data/.rspec ADDED

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

data/.rubocop.yml ADDED

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - article_readingtime.gemspec
+Style/Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+Metrics/AbcSize:
+  Max: 17

data/.travis.yml ADDED

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile ADDED

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

data/LICENSE.txt ADDED

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2016 Julio Olivera
+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 ADDED

@@ -0,0 +1,71 @@
+# ArticleReadingtime
+Given an HTML article, it calculates an estimated reading time for it. Similar to what [Medium does](https://help.medium.com/hc/en-us/articles/214991667-Read-time), although the exact behavior can be customized.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'article_readingtime'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install article_readingtime
+## Usage
+```ruby
+require 'article_readingtime'
+ArticleReadingtime.estimate_html <<HTML
+  <article>
+    <p>
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit,
+      sed do eiusmod tempor incididun
+    </p>
+  </article>
+HTML
+#=> 3
+```
+`ArticleReadingtime.estimate_html` receives an HTML string and returns an estimate of the time in seconds it takes to read it. By default, it considers an average of 275 WPM. The first image is counted as 12 seconds, the second one as 11 seconds, and it keeps decreasing down to 3 seconds for each image. A second optional parameter can be used to customize these values:
+```ruby
+ArticleReadingtime.estimate_html <<HTML, wpm: 300
+  <article>
+    <!-- ... -->
+  </article>
+HTML
+```
+Image time calculation can be customized in two ways - the first one is to change the maximum, minimum and step. For instance, for the first image to be counted as 15 seconds, down until 5 seconds, and reduce 2 seconds for each new image, the options would look like:
+```ruby
+ArticleReadingtime.estimate_html <<HTML, images: { max: 15, min: 5, step: 2 }
+  <article>
+    <!-- ... -->
+  </article>
+HTML
+```
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/julioolvr/article_readingtime.
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile ADDED

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

data/article_readingtime.gemspec ADDED

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'article_readingtime/version'
+Gem::Specification.new do |spec|
+  spec.name          = "article_readingtime"
+  spec.version       = ArticleReadingtime::VERSION
+  spec.authors       = ["Julio Olivera"]
+  spec.email         = ["julio.olvr@gmail.com"]
+  spec.summary       = "Estimate how many seconds it'll take to read an article"
+  spec.homepage      = "https://github.com/julioolvr/article_readingtime"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.44.1"
+end

data/bin/console ADDED

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'article_readingtime'
+# 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

data/bin/setup ADDED

@@ -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/lib/article_readingtime.rb ADDED

@@ -0,0 +1,43 @@
+require 'article_readingtime/version'
+require 'nokogiri'
+WORDS_PER_MINUTE = 275
+IMAGE_MAX = 15
+IMAGE_MIN = 3
+IMAGE_STEP = 1
+module ArticleReadingtime
+  def self.estimate_html(html, options = {})
+    wpm = options[:wpm] || WORDS_PER_MINUTE
+    images_options = default_image_options(options[:images] || {})
+    doc = Nokogiri::HTML(html)
+    count_text(doc, wpm) + count_images(doc, images_options)
+  end
+  def self.default_image_options(options)
+    {
+      max: options[:max] || IMAGE_MAX,
+      min: options[:min] || IMAGE_MIN,
+      step: options[:step] || IMAGE_STEP
+    }
+  end
+  def self.count_text(doc, wpm)
+    words = doc.inner_text.split(' ')
+    (words.length / wpm.to_f * 60).round
+  end
+  def self.count_images(doc, options)
+    images_count = doc.css('img').length
+    images_count.times.reduce(0) do |total, i|
+      total + if options[:max] - i * options[:step] > options[:min]
+                options[:max] - i * options[:step]
+              else
+                options[:min]
+              end
+    end
+  end
+end

data/lib/article_readingtime/version.rb ADDED

@@ -0,0 +1,3 @@
+module ArticleReadingtime
+  VERSION = '1.0.0'.freeze
+end

metadata ADDED

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: article_readingtime
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julio Olivera
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2016-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.1
+description:
+email:
+- julio.olvr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- article_readingtime.gemspec
+- bin/console
+- bin/setup
+- lib/article_readingtime.rb
+- lib/article_readingtime/version.rb
+homepage: https://github.com/julioolvr/article_readingtime
+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.6
+signing_key:
+specification_version: 4
+summary: Estimate how many seconds it'll take to read an article
+test_files: []