jekyll-date-format 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+_site

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+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,90 @@
+# Jekyll DateFormat
+
+A simple plugin which makes it easy to have nicely formatted dates on any post or page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-date-format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-date-format
+
+## Usage
+
+In your Jekyll configuration (usually the _config.yml) you can set the date
+
+| Configuration | Description                                                                    | Default   |
+|:--------------|--------------------------------------------------------------------------------|-----------|
+| date_format   | A [Ruby strftime](http://apidock.com/ruby/DateTime/strftime) compatible string | 'ordinal' |
+
+Any post (or page with a date) will have access to two new variables. Use `post.date_formatted` to output a date formatted based on your `date_format` Jekyll
+configuration, or use `post.time_tag` to output a fully formatted `<time>` tag. For a page, use `page.date_formatted` and `page.time_tag` instead.
+
+```
+Published: {{ post.date_formatted }} 
+Published: {{ post.time_tag }} 
+
+# Which would output
+# Published: July 3, 2013
+# Published: <time class='date-published' datetime='2013-07-03 09:08:15 -0500' pubdate>July 3<sup>rd</sup>, 2013</time>
+```
+
+In the output above it's worth noting that the `pubdate` attribute is a microformat used to help robots distinguish a document's date of publication.
+
+Additionally if you like to keep track of when posts were updated, you can add an updated  `updated: 2013-07-05 4:08:15` to your post or page's YAML front matter and you'll be able to use variables with your udpated date as well.
+
+```
+Last Updated: {{ post.updated_formatted }} 
+Last updated: {{ post.time_tag_updated }} 
+
+# Which would output
+# Last updated: July 5, 2013
+# Last updated: <time class='date-updated' datetime='2013-05-03 04:08:15 -0500'>July 5<sup>th</sup>, 2013</time>
+```
+
+Of course you can use Liquid conditionals to test for the presence of `post.updated` before outputting an udpated date.
+
+```
+{% if post.updated %}Last Updated: {{ post.time_tag_updated }}{% endif %}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jekyll-date-format.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-date-format/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jekyll-date-format"
+  gem.version       = Jekyll::DateFormat::VERSION
+  gem.authors       = ["Brandon Mathis"]
+  gem.email         = ["brandon@imathis.com"]
+  gem.description   = %q{Automatically adds variables with nicely formated dates and time tags to Jekyll posts and pages.}
+  gem.summary       = %q{Automatically adds variables with nicely formated dates and time tags to Jekyll posts and pages.}
+  gem.homepage      = "https://github.com/octopress/jekyll-date-format"
+  gem.license       = "MIT"
+
+  gem.add_runtime_dependency 'jekyll', '>= 1.0.0'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/lib/jekyll-date-format.rb

@@ -0,0 +1,116 @@
+
+module Jekyll
+  class DateFormat
+
+    # Returns a datetime if the input is a string
+    def self.datetime(date)
+      if date.class == String
+        date = Time.parse(date)
+      end
+      date
+    end
+
+    # Returns an ordidinal date eg July 22 2007 -> July 22nd 2007
+    def self.ordinalize(date)
+      date = datetime(date)
+      "#{date.strftime('%b')} #{ordinal(date.strftime('%e').to_i)}, #{date.strftime('%Y')}"
+    end
+
+    def self.time_tag(date, formatted, type)
+      t = "<time class='date-#{type}' datetime='#{date}'"
+      t += " pubdate" unless type == 'updated'
+      t += ">#{formatted}</time>"
+    end
+
+
+    # Returns an ordinal number. 13 -> 13th, 21 -> 21st etc.
+    def self.ordinal(number)
+      if (11..13).include?(number.to_i % 100)
+        "#{number}<sup>th</sup>"
+      else
+        case number.to_i % 10
+        when 1; "#{number}<sup>st</sup>"
+        when 2; "#{number}<sup>nd</sup>"
+        when 3; "#{number}<sup>rd</sup>"
+        else    "#{number}<sup>th</sup>"
+        end
+      end
+    end
+
+    # Formats date either as ordinal or by given date format
+    # Adds %o as ordinal representation of the day
+    def self.format_date(date, format)
+      date = datetime(date)
+      if format.nil? || format.empty? || format == "ordinal"
+        date_formatted = ordinalize(date)
+      else
+        date_formatted = date.strftime(format)
+        date_formatted.gsub!(/%o/, ordinal(date.strftime('%e').to_i))
+      end
+      date_formatted
+    end
+
+  end
+
+  class Post
+
+    # Copy the #initialize method to #old_initialize, so we can redefine #initialize
+    #
+    alias_method :old_initialize, :initialize
+    attr_accessor :updated
+
+    def initialize(site, source, dir, name)
+      old_initialize(site, source, dir, name)
+      format = self.site.config['date_format']
+
+      date_f = DateFormat.format_date(self.date, format) unless self.data['date'].nil?
+      date_t = DateFormat.time_tag(self.date, date_f, 'published')
+
+      self.data['date_formatted'] = date_f
+      self.data['time_tag'] = date_t
+
+      unless self.data['updated'].nil?
+        updated = Time.parse(self.data['updated'].to_s)
+        updated_f = DateFormat.format_date(self.data['updated'], format)
+        updated_t = DateFormat.time_tag(self.date, date_f, 'updated')
+
+        self.data['updated'] = updated
+        self.data['updated_formatted'] = updated_f
+        self.data['updated_time_tag'] = updated_t
+      end
+    end
+  end
+
+  class Page
+
+    # Copy the #initialize method to #old_initialize, so we can redefine #initialize
+    #
+    alias_method :old_initialize, :initialize
+    attr_accessor :updated, :date
+
+    def initialize(site, source, dir, name)
+      old_initialize(site, source, dir, name)
+      format = self.site.config['date_format']
+
+      unless self.data['date'].nil?
+
+        date_f = DateFormat.format_date(self.data['date'], format) unless self.data['date'].nil?
+        date_t = DateFormat.time_tag(self.data['date'], date_f, 'published')
+
+        self.data['date_formatted'] = date_f
+        self.data['time_tag'] = date_t
+      end
+
+      unless self.data['updated'].nil?
+        updated = Time.parse(self.data['updated'].to_s)
+        updated_f = DateFormat.format_date(self.data['updated'], format)
+        updated_t = DateFormat.time_tag(self.date, date_f, 'updated')
+
+        self.data['updated'] = updated
+        self.data['updated_formatted'] = updated_f
+        self.data['updated_time_tag'] = updated_t
+      end
+    end
+  end
+end
+

data/lib/jekyll-date-format/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  class DateFormat
+    VERSION = "1.0.0"
+  end
+end

data/test/.gitignore

@@ -0,0 +1 @@
+_site

data/test/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'jekyll-date-format', :path => '../'
+gem 'redcarpet'

data/test/_config.yml

@@ -0,0 +1,3 @@
+name: Your New Jekyll Site
+markdown: redcarpet
+pygments: true

data/test/_layouts/default.html

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+        <title>{{ page.title }}</title>
+        <meta name="viewport" content="width=device-width">
+
+        <!-- syntax highlighting CSS -->
+        <link rel="stylesheet" href="/css/syntax.css">
+
+        <!-- Custom CSS -->
+        <link rel="stylesheet" href="/css/main.css">
+
+    </head>
+    <body>
+
+        <div class="container">
+          <div class="site">
+            <div class="header">
+              <h1 class="title"><a href="/">{{ site.name }}</a></h1>
+              <a class="extra" href="/">home</a>
+            </div>
+
+                {{ content }}
+
+            <div class="footer">
+              <div class="contact">
+                <p>
+                  Your Name<br />
+                  What You Are<br />
+                  your@email.com
+                </p>
+              </div>
+              <div class="contact">
+                <p>
+                  <a href="http://github.com/yourusername/">github.com/yourusername</a><br />
+                  <a href="http://twitter.com/yourusername/">twitter.com/yourusername</a><br />
+                </p>
+              </div>
+            </div>
+          </div>
+        </div> <!-- /container -->
+
+    </body>
+</html>

data/test/_layouts/post.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+<h2>{{ page.title }}</h2>
+<p class="meta">{{ page.date | date_to_string }}</p>
+
+<div class="post">
+{{ content }}
+</div>

data/test/_plugins/jekyll-date-format.rb

@@ -0,0 +1 @@
+require 'jekyll-date-format'

data/test/_posts/2013-08-16-welcome-to-jekyll.markdown

@@ -0,0 +1,17 @@
+---
+layout: post
+title:  "Welcome to Jekyll!"
+date:   2013-08-16 14:08:15
+updated: 2013-08-16 15:00:15
+categories: jekyll update
+---
+
+## Date
+- Date: {{ page.date }}
+- Formatted: {{ page.date_formatted }}
+- TimeTag: {{ page.time_tag }}
+
+## Updated
+- Date: {{ page.updated }}
+- Formatted: {{ page.updated_formatted }}
+- TimeTag: {{ page.updated_time_tag }}

data/test/css/main.css

@@ -0,0 +1,160 @@
+/*****************************************************************************/
+/*
+/* Common
+/*
+/*****************************************************************************/
+
+/* Global Reset */
+* {
+  margin: 0;
+  padding: 0;
+}
+
+html, body { height: 100%; }
+
+body {
+  background-color: #FFF;
+  font: 13.34px Helvetica, Arial, sans-serif;
+  font-size: small;
+  text-align: center;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-size: 100%; }
+
+h1 { margin-bottom: 1em; }
+p { margin: 1em 0; }
+
+a         { color: #00a; }
+a:hover   { color: #000; }
+a:visited { color: #a0a; }
+
+/*****************************************************************************/
+/*
+/* Home
+/*
+/*****************************************************************************/
+ul.posts {
+  list-style-type: none;
+  margin-bottom: 2em;
+}
+
+ul.posts li {
+  line-height: 1.75em;
+}
+
+ul.posts span {
+  color: #aaa;
+  font-family: Monaco, "Courier New", monospace;
+  font-size: 80%;
+}
+
+/*****************************************************************************/
+/*
+/* Site
+/*
+/*****************************************************************************/
+
+.site {
+  font-size: 115%;
+  text-align: justify;
+  width: 42em;
+  margin: 3em auto 2em;
+  line-height: 1.5em;
+}
+
+.site .header a {
+  font-weight: bold;
+  text-decoration: none;
+}
+
+.site .header h1.title {
+  display: inline-block;
+  margin-bottom: 2em;
+}
+
+.site .header h1.title a {
+  color: #a00;
+}
+
+.site .header h1.title a:hover {
+  color: #000;
+}
+
+.site .header a.extra {
+  color: #aaa;
+  margin-left: 1em;
+}
+
+.site .header a.extra:hover {
+  color: #000;
+}
+
+.site .meta {
+  color: #aaa;
+}
+
+.site .footer {
+  font-size: 80%;
+  color: #666;
+  border-top: 4px solid #eee;
+  margin-top: 2em;
+  overflow: hidden;
+}
+
+.site .footer .contact {
+  float: left;
+  margin-right: 3em;
+}
+
+.site .footer .contact a {
+  color: #8085C1;
+}
+
+.site .footer .rss {
+  margin-top: 1.1em;
+  margin-right: -.2em;
+  float: right;
+}
+
+.site .footer .rss img {
+  border: 0;
+}
+
+/*****************************************************************************/
+/*
+/* Posts
+/*
+/*****************************************************************************/
+
+/* standard */
+.post pre {
+  border: 1px solid #ddd;
+  background-color: #eef;
+  padding: 0 .4em;
+}
+
+.post ul, .post ol {
+  margin-left: 1.35em;
+}
+
+.post code {
+  border: 1px solid #ddd;
+  background-color: #eef;
+  padding: 0 .2em;
+}
+
+.post pre code {
+  border: none;
+}
+
+/* terminal */
+.post pre.terminal {
+  border: 1px solid #000;
+  background-color: #333;
+  color: #FFF;
+}
+
+.post pre.terminal code {
+  background-color: #333;
+}

data/test/css/syntax.css

@@ -0,0 +1,60 @@
+.highlight  { background: #ffffff; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

data/test/index.html

@@ -0,0 +1,17 @@
+---
+layout: default
+title: Your New Jekyll Site
+date:   2013-08-16 14:08:15
+---
+
+## Date
+- Date: {{ page.date }}
+- Formatted: {{ page.date_formatted }}
+- TimeTag: {{ page.time_tag }}
+
+{% if page.updated %}
+## Updated
+- Date: {{ page.updated }}
+- Formatted: {{ page.updated_formatted }}
+- TimeTag: {{ page.updated_time_tag }}
+{% endif %}

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-date-format
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Automatically adds variables with nicely formated dates and time tags
+  to Jekyll posts and pages.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-date-format.gemspec
+- lib/jekyll-date-format.rb
+- lib/jekyll-date-format/version.rb
+- test/.gitignore
+- test/Gemfile
+- test/_config.yml
+- test/_layouts/default.html
+- test/_layouts/post.html
+- test/_plugins/jekyll-date-format.rb
+- test/_posts/2013-08-16-welcome-to-jekyll.markdown
+- test/css/main.css
+- test/css/syntax.css
+- test/index.html
+homepage: https://github.com/octopress/jekyll-date-format
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Automatically adds variables with nicely formated dates and time tags to
+  Jekyll posts and pages.
+test_files: []