jekyll-read-time 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca10ee65b08015c2678206e588cc6d25c576ff3b
+  data.tar.gz: c1c58edec33675bc5efeb4085c654779ccd27324
+SHA512:
+  metadata.gz: 60378d4778ce9f6a386b5f4df1f35bc0dbfa5ebeb847942f20e436bf70f1282c2e43e68191e2f4b7a518c9dae7a6a9105ee0c5682283f5c59674436cb66840d0
+  data.tar.gz: afe1e5d528aa6cc732df6179cea92118a296b3435eec5bc453edfcd642927b6054428158b2fbe7f34d27f303adeb78802407c2b4f183a39a53f167fce1bd7c10

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+.rvmrc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jam Risser <jam@jamrizzi.com> (https://jam.jamrizzi.com)
+
+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/Makefile

@@ -0,0 +1,19 @@
+CWD := $(shell pwd)
+
+.PHONY: all
+all: build
+
+.PHONY: build
+build: clean
+	@gem build *.gemspec
+	@echo ::: BUILD :::
+
+.PHONY: push
+push: build
+	@gem push *.gem
+	@echo ::: PUSH :::
+
+.PHONY: clean
+clean:
+	-@rm -rf *.gem &>/dev/null || true
+	@echo ::: CLEAN :::

data/README.md

@@ -0,0 +1,29 @@
+# Jekyll Read Time
+
+Jekyll liquid tag to indicating the read time of the content
+
+## Usage
+
+Add the following to your `Gemfile`'
+```rb
+group :jekyll_plugins do
+  gem "jekyll-read-time", "~> 0.1.0"
+end
+```
+
+Add the following to your `_config.yml`
+
+```yml
+plugins:
+  - jekyll-read-time
+```
+
+Place one of the following tags in your layout
+
+`{{ content | read_time_short }}`
+
+This generates the reading time as a number, like "4 minute read" or "less than 1 minute read"
+
+`{{ content | read_time }}`
+
+This generates the reading time as like "4 min read"

data/jekyll-read-time.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-read-time/version"
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-read-time"
+  spec.summary       = "Jekyll liquid tag to indicating the read time of the content"
+  spec.description   = "Jekyll liquid tag to indicating the read time of the content"
+  spec.version       = JekyllReadTime::VERSION
+  spec.authors       = ["Jam Risser"]
+  spec.email         = ["jam@jamrizzi.com"]
+  spec.homepage      = "https://github.com/jamrizzi/jekyll-read-time"
+  spec.licenses      = ["MIT"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!)  }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+end

data/lib/jekyll-read-time/filter.rb

@@ -0,0 +1,39 @@
+require "jekyll-read-time"
+
+module JekyllReadTime
+
+  WORD_PER_MINUTE = 180
+
+  def calculate_time( input )
+    words = input.split.size;
+    minutes = ( words / WORD_PER_MINUTE ).floor
+    return minutes
+  end
+
+  module ReadingTimeFilter
+    def read_time( input )
+      minutes = calculate_time(input)
+      case minutes
+      when 2 then minutes_s = 'two'
+      when 3 then minutes_s = 'three'
+      when 4 then minutes_s = 'four'
+      when 5 then minutes_s = 'five'
+      when 6 then minutes_s = 'six'
+      when 7 then minutes_s = 'seven'
+      when 8 then minutes_s = 'eight'
+      when 9 then minutes_s = 'nine'
+      else        minutes_s = minutes
+      end
+      minutes > 0 ? "#{minutes_s} minute read" : "less than one minute read"
+    end
+    Liquid::Template.register_filter(ReadingTimeFilter)
+  end
+
+  module ReadingTimeFilterShort
+    def read_time_short( input )
+      minutes = calculate_time(input)
+      minutes > 0 ? "#{minutes} min read" : "1 min read"
+    end
+    Liquid::Template.register_filter(ReadingTimeFilterShort)
+  end
+end

data/lib/jekyll-read-time/version.rb

@@ -0,0 +1,3 @@
+module JekyllReadTime
+  VERSION = "0.1.0".freeze
+end

data/lib/jekyll-read-time.rb

@@ -0,0 +1,5 @@
+require "jekyll-read-time/version"
+require "jekyll-read-time/filter"
+
+module JekyllReadTime
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-read-time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jam Risser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+description: Jekyll liquid tag to indicating the read time of the content
+email:
+- jam@jamrizzi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- LICENSE
+- Makefile
+- README.md
+- jekyll-read-time.gemspec
+- lib/jekyll-read-time.rb
+- lib/jekyll-read-time/filter.rb
+- lib/jekyll-read-time/version.rb
+homepage: https://github.com/jamrizzi/jekyll-read-time
+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.14
+signing_key: 
+specification_version: 4
+summary: Jekyll liquid tag to indicating the read time of the content
+test_files: []