jekyll-authors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4209e6a6fc998af91e2cda7f1d7254eb2497dca4
+  data.tar.gz: fa428c2ab5af1fb1d70c22cf8412f1eab6837128
+SHA512:
+  metadata.gz: 04b8aa8cb3c16e70edcdea7106eeefffa939e6febcba925ab0968f968fb5638537dd5cf9dbe44bea8279fd416f08a2761db9d14c5c46d067634777b40ccc8a45
+  data.tar.gz: 69e17f77aef96b4a847c155ec690d5abd8df00a12deced26cf2ad4c49f1cbacc8d60bfc9e89a918c45231675aafbaf09ec10245c40a73e919e736b57e5b7fad5

data/.gitignore

@@ -0,0 +1,3 @@
+.ruby-version
+
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    jekyll-authors (0.0.1)
+      jekyll (>= 0.10.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    blankslate (2.1.2.4)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    classifier-reborn (2.0.3)
+      fast-stemmer (~> 1.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    colorator (0.1)
+    execjs (2.5.2)
+    fast-stemmer (1.0.2)
+    ffi (1.9.8)
+    hitimes (1.2.2)
+    jekyll (2.5.3)
+      classifier-reborn (~> 2.0)
+      colorator (~> 0.1)
+      jekyll-coffeescript (~> 1.0)
+      jekyll-gist (~> 1.0)
+      jekyll-paginate (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 2.6.1)
+      mercenary (~> 0.3.3)
+      pygments.rb (~> 0.6.0)
+      redcarpet (~> 3.1)
+      safe_yaml (~> 1.0)
+      toml (~> 0.1.0)
+    jekyll-coffeescript (1.0.1)
+      coffee-script (~> 2.2)
+    jekyll-gist (1.2.1)
+    jekyll-paginate (1.1.0)
+    jekyll-sass-converter (1.3.0)
+      sass (~> 3.2)
+    jekyll-watch (1.2.1)
+      listen (~> 2.7)
+    kramdown (1.7.0)
+    liquid (2.6.2)
+    listen (2.10.1)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    mercenary (0.3.5)
+    parslet (1.5.0)
+      blankslate (~> 2.0)
+    posix-spawn (0.3.11)
+    pygments.rb (0.6.3)
+      posix-spawn (~> 0.3.6)
+      yajl-ruby (~> 1.2.0)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.1)
+    safe_yaml (1.0.4)
+    sass (3.4.14)
+    timers (4.0.1)
+      hitimes
+    toml (0.1.2)
+      parslet (~> 1.5.0)
+    yajl-ruby (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll-authors!

data/README.md

@@ -0,0 +1,37 @@
+Jekyll Authors
+==============
+
+This gem provides a [Jekyll](http://github.com/mojombo/jekyll) generator for
+author pages, author feeds and a author index.
+
+Basic Setup
+-----------
+Install the gem:
+
+	[sudo] gem install jekyll-authors
+
+In a plugin file within your Jekyll project's _plugins directory:
+
+	# _plugins/my-plugin.rb
+	require "jekyll-authors"
+
+Create the following layouts:
+
+- author_index.html
+- author_list.html
+- author_feed.xml
+
+Bundler Setup
+-------------
+Already using bundler to manage gems for your Jekyll project?  Then just add
+
+	gem "jekyll-authors"
+
+to your gemfile and create the following plugin in your projects _plugins
+directory.  I've called mine bundler.rb.  This will automatically require all
+of the gems specified in your Gemfile.
+
+	# _plugins/bundler.rb
+	require "rubygems"
+	require "bundler/setup"
+	Bundler.require(:default)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/jekyll-authors.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jekyll-authors/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jekyll-authors"
+  s.version     = Jekyll::Authors::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mauro Otonelli", "Ernesto Tagwerker"]
+  s.email       = ["mauro@ombulabs.com", "ernesto@ombulabs.com"]
+  s.homepage    = "http://github.com/ombulabs/jekyll-authors"
+  s.summary     = %q{Author generators for Jekyll}
+  s.description = %q{Provides an author index page and author atom feeds for Jekyll.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('jekyll', [">= 0.10.0"])
+end

data/lib/jekyll-authors/tags.rb

@@ -0,0 +1,121 @@
+module Jekyll
+  module Authors
+    class TagIndex < Page
+      def initialize(site, base, dir, tag)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'tag_index.html')
+        self.data['tag'] = tag
+
+        tag_title_prefix = site.config['tag_title_prefix'] || 'Tag: '
+        self.data['title'] = "#{tag_title_prefix}#{tag}"
+      end
+    end
+
+    class TagFeed < Page
+      def initialize(site, base, dir, tag)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'atom.xml'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'tag_feed.xml')
+        self.data['tag'] = tag
+
+        tag_title_prefix = site.config['tag_title_prefix'] || 'Tag: '
+        self.data['title'] = "#{tag_title_prefix}#{tag}"
+      end
+    end
+
+    class TagList < Page
+      def initialize(site,  base, dir, tags)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'tag_list.html')
+        self.data['tags'] = tags
+      end
+    end
+
+    class TagGenerator < Generator
+      safe true
+
+      def generate(site)
+        if site.layouts.key? 'tag_index'
+          dir = site.config['tag_dir'] || 'tags'
+          site.tags.keys.each do |tag|
+            write_tag_index(site, File.join(dir, tag.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), tag)
+          end
+        end
+
+        if site.layouts.key? 'tag_feed'
+          dir = site.config['tag_dir'] || 'tags'
+          site.tags.keys.each do |tag|
+            write_tag_feed(site, File.join(dir, tag.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), tag)
+          end
+        end
+
+        if site.layouts.key? 'tag_list'
+          dir = site.config['tag_dir'] || 'tags'
+          write_tag_list(site, dir, site.tags.keys.sort)
+        end
+      end
+
+      def write_tag_index(site, dir, tag)
+        index = TagIndex.new(site, site.source, dir, tag)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_tag_feed(site, dir, tag)
+        index = TagFeed.new(site, site.source, dir, tag)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_tag_list(site, dir, tags)
+        index = TagList.new(site, site.source, dir, tags)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+    end
+
+    # Returns a correctly formatted tag url based on site configuration.
+    #
+    # Use without arguments to return the url of the tag list page.
+    #    {% tag_url %}
+    #
+    # Use with argument to return the url of a specific catogory page.  The
+    # argument can be either a string or a variable in the current context.
+    #    {% tag_url tag_name %}
+    #    {% tag_url tag_var %}
+    #
+    class TagUrlTag < Liquid::Tag
+      def initialize(tag_name, text, tokens)
+        super
+        @tag = text
+      end
+
+      def render(context)
+        base_url = context.registers[:site].config['base-url'] || '/'
+        tag_dir = context.registers[:site].config['tag_dir'] || 'tags'
+
+        tag = context[@tag] || @tag.strip.tr(' ', '-').downcase
+        tag.empty? ? "#{base_url}#{tag_dir}" : "#{base_url}#{tag_dir}/#{tag}"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('tag_url', Jekyll::Authors::TagUrlTag)

data/lib/jekyll-authors/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Authors
+    VERSION = "0.0.1"
+  end
+end

data/lib/jekyll-authors.rb

@@ -0,0 +1,123 @@
+require 'jekyll-authors/tags'
+
+module Jekyll
+  module Authors
+    class AuthorIndex < Page
+      def initialize(site, base, dir, author)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'author_index.html')
+        self.data['author'] = author
+
+        author_title_prefix = site.config['author_title_prefix'] || 'Author: '
+        self.data['title'] = "#{author_title_prefix}#{author}"
+      end
+    end
+
+    class AuthorFeed < Page
+      def initialize(site, base, dir, author)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'atom.xml'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'author_feed.xml')
+        self.data['author'] = author
+
+        author_title_prefix = site.config['author_title_prefix'] || 'Author: '
+        self.data['title'] = "#{author_title_prefix}#{author}"
+      end
+    end
+
+    class AuthorList < Page
+      def initialize(site,  base, dir, authors)
+        @site = site
+        @base = base
+        @dir = dir
+        @name = 'index.html'
+
+        self.process(@name)
+        self.read_yaml(File.join(base, '_layouts'), 'author_list.html')
+        self.data['authors'] = authors
+      end
+    end
+
+    class AuthorGenerator < Generator
+      safe true
+
+      def generate(site)
+        if site.layouts.key? 'author_index'
+          dir = site.config['author_dir'] || 'authors'
+          site.authors.keys.each do |author|
+            write_author_index(site, File.join(dir, author.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), author)
+          end
+        end
+
+        if site.layouts.key? 'author_feed'
+          dir = site.config['author_dir'] || 'authors'
+          site.authors.keys.each do |author|
+            write_author_feed(site, File.join(dir, author.gsub(/\s/, "-").gsub(/[^\w-]/, '').downcase), author)
+          end
+        end
+
+        if site.layouts.key? 'author_list'
+          dir = site.config['author_dir'] || 'authors'
+          write_author_list(site, dir, site.authors.keys.sort)
+        end
+      end
+
+      def write_author_index(site, dir, author)
+        index = CategoryIndex.new(site, site.source, dir, author)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_author_feed(site, dir, author)
+        index = AuthorFeed.new(site, site.source, dir, author)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+
+      def write_author_list(site, dir, authors)
+        index = AuthorList.new(site, site.source, dir, authors)
+        index.render(site.layouts, site.site_payload)
+        index.write(site.dest)
+        site.static_files << index
+      end
+    end
+
+    # Returns a correctly formatted author url based on site configuration.
+    #
+    # Use without arguments to return the url of the author list page.
+    #    {% author_url %}
+    #
+    # Use with argument to return the url of a specific catogory page.  The
+    # argument can be either a string or a variable in the current context.
+    #    {% author_url author_name %}
+    #    {% author_url author_var %}
+    #
+    class AuthorUrlTag < Liquid::Tag
+      def initialize(tag_name, text, tokens)
+        super
+        @author = text
+      end
+
+      def render(context)
+        base_url = context.registers[:site].config['base-url'] || '/'
+        author_dir = context.registers[:site].config['author_dir'] || 'authors'
+
+        author = context[@author] || @author.strip.tr(' ', '-').downcase
+        author.empty? ? "#{base_url}#{author_dir}" : "#{base_url}#{author_dir}/#{author}"
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('author_url', Jekyll::Authors::AuthorUrlTag)

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-authors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mauro Otonelli
+- Ernesto Tagwerker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Provides an author index page and author atom feeds for Jekyll.
+email:
+- mauro@ombulabs.com
+- ernesto@ombulabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- jekyll-authors.gemspec
+- lib/jekyll-authors.rb
+- lib/jekyll-authors/tags.rb
+- lib/jekyll-authors/version.rb
+homepage: http://github.com/ombulabs/jekyll-authors
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Author generators for Jekyll
+test_files: []