octopress-date-format 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b6c0adba7917954ffbf5405d1078930c67033e9
+  data.tar.gz: d60d1df617fc1422eb1964d3949737ab08d98199
+SHA512:
+  metadata.gz: 9dfe8fa193b06e5766cae535e01f631369b1ccfb0ab5ff534ba595bf79be4b175ceb529958cc8e68c46cecd8c5fa8349fd95b80723b185b000baf7713c5635c5
+  data.tar.gz: 0563a12335464f65f3c78c94141bbc29955fd71bfeafc0c7d25270695c87054ec9c07ac45cc51778eb57ccbd12c219695066c27ce72429cfcbb0e614d19e7674

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && bundle exec clash

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in octopress-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,118 @@
+# Octopress Date Format
+
+A simple plugin which makes it easy to have nicely formatted dates on any post or page.
+[![Build Status](https://travis-ci.org/octopress/date-format.svg)](https://travis-ci.org/octopress/date-format)
+[![Gem Version](http://img.shields.io/gem/v/octopress-date-format.svg)](https://rubygems.org/gems/octopress-date-format)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://octopress.mit-license.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-date-format'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-date-format
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-date-format
+    
+## Usage
+
+Any post (or page with a date) will automatically have some new date attributes. 
+
+- `date` - The date, `2014-07-03 14:08:00 +0000`
+- `date_text` - The formatted date, Jul 3rd, 2014
+- `time_text` - The formatted time, 2:08 pm
+- `date_xml` - The XML schema formatted date, 2014-07-03T14:08:00+00:00
+- `date_html` - The formatted date in a `<time>` tag.
+- `date_time_html` - The formatted date and time in a `<time>` tag.
+
+Here's an example of what would be rendered with `{{ post.date_time_html }}`.
+
+```html
+<time class='entry-date' datetime='2014-07-03T14:08:00+00:00'>
+  <span class='date'>
+    <span class='date-month'>Jul</span>
+    <span class='date-day'>3</span><span class='date-suffix'>rd</span>,
+    <span class='date-year'>2014</span>
+  </span>
+  <span class='time'>2:08 pm</span>
+</time>
+```
+
+If you update a post or page and want to display this in a template, add this to YAML
+front-matter, `date_updated: 2014-07-03 15:03:15` and your post will have updated date
+attributes as well.
+
+- `updated` - The date, `2014-07-03 15:03:15 +0000`
+- `date_updated_text` - The formatted date, Jul 3rd, 2014
+- `time_updated_text` - The formatted time, 3:03 pm
+- `date_updated_xml` - The XML schema formatted date, 2014-07-03T15:03:15+00:00
+- `date_updated_html` - The formatted date in a `<time>` tag.
+- `date_time_updated_html` - The formatted date and time in a `<time>` tag.
+
+Of course you can use Liquid conditionals when outputting an updated date.
+
+```
+{% if post.updated %}Updated: {{ post.date_time_updated_html }}{% endif %}
+```
+
+## Configuration
+
+You may change the formatting of the dates and times in the
+`_octopress.yml` configuration file. Here are the defaults:
+
+```
+date_format: 'ordinal'     # July 3rd, 2014
+time_format: '%-I:%M %P'   # 2:08 pm
+```
+
+To choose a different format, use a [Ruby strftime](http://apidock.com/ruby/DateTime/strftime)
+compatible string. For example:
+
+```
+date_format: "%Y-%m-%d"  # e.g. 2014-07-03
+time_format: "%H:%M"     # 24 hour time
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/date-format/fork )
+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/lib/octopress-date-format.rb

@@ -0,0 +1,109 @@
+require 'octopress-hooks'
+require 'octopress-date-format/configuration'
+require 'octopress-date-format/version'
+
+module Octopress
+  module PageDate
+    class PageHook < Hooks::Page
+      def post_init(page)
+        PageDate.hack_date(page)
+      end
+    end
+
+    class PostHook < Hooks::Post
+      def post_init(post)
+        PageDate.hack_date(post)
+      end
+    end
+
+    def self.hack_date(page)
+      if page.data['date'] || page.respond_to?(:date)
+        date = datetime(page.data['date'] || page.date)
+
+        page.data['date_xml']  = date.xmlschema
+        page.data['date_text'] = format_date(date)
+        page.data['time_text'] = format_time(date)
+        page.data['date_html'] = date_html(date, false)
+        page.data['date_time_html'] = date_html(date)
+      end
+
+      if page.data['date_updated']
+        updated  = datetime(page.data['date_updated'])
+        page.data['date_updated_xml']  = updated.xmlschema
+        page.data['date_updated_text'] = format_date(updated)
+        page.data['time_updated_text'] = format_time(updated)
+        page.data['date_updated_html'] = date_updated_html(updated, false)
+        page.data['date_time_updated_html'] = date_updated_html(updated)
+      end
+      page
+    end
+
+    def self.date_html(date, time=true)
+      tag =  "<time class='entry-date' datetime='#{ date.xmlschema }'>"
+      tag += "<span class='date'>#{format_date(date, true)}</span>"
+      tag += " <span class='time'>#{format_time(date)}</span>" if time
+      tag += "</time>"
+    end
+
+    def self.date_updated_html(date, time=true)
+      date_html(date, time).sub('entry-date','updated')
+    end
+
+    def self.format_date(date, html=false)
+      format = config['date_format']
+      if format == 'ordinal'
+        html ? ordinalize_html(date) : ordinalize(date)
+      else
+        date.strftime(format)
+      end
+    end
+
+    def self.format_time(date, html=false)
+      format = config['time_format']
+      date.strftime(format)
+    end
+
+    # Returns an ordidinal date eg July 22 2007 -> July 22nd 2007
+    def self.ordinalize(date)
+      "#{date.strftime('%b %-d')}#{ordinal_suffix(date)}, #{date.strftime('%Y')}"
+    end
+
+    def self.ordinalize_html(date)
+      d = "<span class='date-month'>#{date.strftime('%b')}</span> "
+      d += "<span class='date-day'>#{date.strftime('%-d')}</span>"
+      d += "<span class='date-suffix'>#{ordinal_suffix(date)}</span>, "
+      d += "<span class='date-year'>#{date.strftime('%Y')}</span>"
+    end
+
+    # Returns an ordinal number. 13 -> 13th, 21 -> 21st etc.
+    def self.ordinal_suffix(date)
+      number = date.strftime('%e').to_i
+      if (11..13).include?(number % 100)
+        "th"
+      else
+        case number % 10
+        when 1; "st"
+        when 2; "nd"
+        when 3; "rd"
+        else    "th"
+        end
+      end
+    end
+
+    def self.datetime(input)
+      case input
+      when Time
+        input
+      when Date
+        input
+      when String
+        Time.parse(input) rescue Time.at(input.to_i)
+      when Numeric
+        Time.at(input)
+      else
+        raise "Invalid Date:", "'#{input}' is not a valid datetime."
+        exit(1)
+      end
+    end
+  end
+end

data/lib/octopress-date-format/configuration.rb

@@ -0,0 +1,26 @@
+module Octopress
+  unless defined? Octopress.config
+    def self.config
+      file = '_octopress.yml'
+      if File.exist?(file)
+        SafeYAML.load_file(file) || {}
+      else
+        {}
+      end
+    end
+  end
+
+  module PageDate
+    module Configuration
+      DEFAULTS = {
+        'date_format' => 'ordinal',
+        'time_format' => '%-I:%M %P',
+      }
+    end
+
+    def self.config
+      @config ||= Jekyll::Utils.deep_merge_hashes(PageDate::Configuration::DEFAULTS, Octopress.config)
+    end
+  end
+end
+

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

@@ -0,0 +1,5 @@
+module Octopress
+  class DateFormat
+    VERSION = "2.0.0"
+  end
+end

data/octopress-date-format.gemspec

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

data/test/.clash.yml

@@ -0,0 +1,2 @@
+build: true
+compare: _expected _site

data/test/.gitignore

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

data/test/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :path => '/gemspec/path', :path => '../'

data/test/_config.yml

@@ -0,0 +1,7 @@
+name: Your New Jekyll Site
+markdown: redcarpet
+timezone: UTC
+gems:
+  - octopress-date-format
+exclude:
+  - Gemfile*

data/test/_expected/2014/07/03/welcome-to-jekyll.html

@@ -0,0 +1,18 @@
+## Date
+- Date: 2014-07-03 14:08:00 +0000
+- Formatted Date: Jul 3rd, 2014
+- Formatted Time: 2:08 pm
+- Date XML: 2014-07-03T14:08:00+00:00
+- Date HTML: <time class='entry-date' datetime='2014-07-03T14:08:00+00:00'><span class='date'><span class='date-month'>Jul</span> <span class='date-day'>3</span><span class='date-suffix'>rd</span>, <span class='date-year'>2014</span></span></time>
+- Date Time HTML: <time class='entry-date' datetime='2014-07-03T14:08:00+00:00'><span class='date'><span class='date-month'>Jul</span> <span class='date-day'>3</span><span class='date-suffix'>rd</span>, <span class='date-year'>2014</span></span> <span class='time'>2:08 pm</span></time>
+
+
+## Updated
+- Date: 2014-07-03 15:03:15 +0000
+- Formatted Date: Jul 3rd, 2014
+- Formatted Time: 3:03 pm
+- XML: 2014-07-03T15:03:15+00:00
+- HTML: <time class='updated' datetime='2014-07-03T15:03:15+00:00'><span class='date'><span class='date-month'>Jul</span> <span class='date-day'>3</span><span class='date-suffix'>rd</span>, <span class='date-year'>2014</span></span></time>
+- Date Time HTML: <time class='updated' datetime='2014-07-03T15:03:15+00:00'><span class='date'><span class='date-month'>Jul</span> <span class='date-day'>3</span><span class='date-suffix'>rd</span>, <span class='date-year'>2014</span></span> <span class='time'>3:03 pm</span></time>
+
+

data/test/_expected/index.html

@@ -0,0 +1,10 @@
+## Date
+- Date: 2013-08-16 14:08:15 +0000
+- Formatted Date: Aug 16th, 2013
+- Formatted Time: 2:08 pm
+- Date XML: 2013-08-16T14:08:15+00:00
+- Date HTML: <time class='entry-date' datetime='2013-08-16T14:08:15+00:00'><span class='date'><span class='date-month'>Aug</span> <span class='date-day'>16</span><span class='date-suffix'>th</span>, <span class='date-year'>2013</span></span></time>
+- Date Time HTML: <time class='entry-date' datetime='2013-08-16T14:08:15+00:00'><span class='date'><span class='date-month'>Aug</span> <span class='date-day'>16</span><span class='date-suffix'>th</span>, <span class='date-year'>2013</span></span> <span class='time'>2:08 pm</span></time>
+
+
+

data/test/_includes/test_date.html

@@ -0,0 +1,17 @@
+## Date
+- Date: {{ page.date }}
+- Formatted Date: {{ page.date_text }}
+- Formatted Time: {{ page.time_text }}
+- Date XML: {{ page.date_xml }}
+- Date HTML: {{ page.date_html }}
+- Date Time HTML: {{ page.date_time_html }}
+
+{% if page.date_updated %}
+## Updated
+- Date: {{ page.date_updated }}
+- Formatted Date: {{ page.date_updated_text }}
+- Formatted Time: {{ page.time_updated_text }}
+- XML: {{ page.date_updated_xml }}
+- HTML: {{ page.date_updated_html }}
+- Date Time HTML: {{ page.date_time_updated_html }}
+{% endif %}

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

@@ -0,0 +1,7 @@
+---
+title:  "Welcome to Jekyll!"
+date:   2014-07-03 14:08:00
+date_updated: 2014-07-03 15:03:15
+---
+
+{% include test_date.html %}

data/test/index.html

@@ -0,0 +1,6 @@
+---
+title: Your New Jekyll Site
+date:   2013-08-16 14:08:15
+---
+
+{% include test_date.html %}

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: octopress-date-format
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octopress-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Adds nicely formated dates to Jekyll posts and pages. (formerly: ''jekyll-date-format'')'
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-date-format.rb
+- lib/octopress-date-format/configuration.rb
+- lib/octopress-date-format/version.rb
+- octopress-date-format.gemspec
+- test/.clash.yml
+- test/.gitignore
+- test/Gemfile
+- test/_config.yml
+- test/_expected/2014/07/03/welcome-to-jekyll.html
+- test/_expected/index.html
+- test/_includes/test_date.html
+- test/_posts/2013-08-16-welcome-to-jekyll.html
+- test/index.html
+homepage: https://github.com/octopress/date-format
+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.2.2
+signing_key: 
+specification_version: 4
+summary: 'Adds nicely formated dates to Jekyll posts and pages. (formerly: ''jekyll-date-format'')'
+test_files: []