octopress-linkblog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7336205a860a6b39469f177e0fe655a8d4e45eef
+  data.tar.gz: c368edb5152708003d12abf168c62de83d7f906e
+SHA512:
+  metadata.gz: 44dc6b098ec41c585671624edc64a20f7d413f5a0117f83ab91679dff85d2c0d4acf304c0838234fad4f14c88dc44d310e80a69dc104e80eae4133c4657ee5ff
+  data.tar.gz: 14afc967f243ccee7168013fe20ed60d39b6b67dc7d608988a5cd931cec17e49b1a9f871aa816b06c003d22df4fa35eb8c5b3ba3ec3c8d2302bcc3149c356a5c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+_site

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+### 1.0.0 - 2014-07-26
+
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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,93 @@
+# Octopress Link Blog
+
+Adds link blogging features, along with some other niceties, to any Jekyll site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-linkblog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-linkblog
+
+Next add it to your gems list in Jekyll's `_config.yml`
+
+    gems:
+      - octopress-linkblog
+
+## Usage
+
+### Post features
+
+With the gem installed, your site's posts will automatically have new data attributes.
+
+- `post.title` - The post title, properly capitalized with titlecase.
+- `post.title_html` - The post title, unorphaned and with html wrapping any post markers. 
+- `post.title_text` - The post title with markers, but all in plain text (great for RSS).
+- `post.title_url` - The URL that post titles should link to.
+- `post.title_link` - A `<a>` tag filled with the `title_html` pointing to the `title_url`.
+- `post.linkpost` - A boolean indicating whether the post is a link post.
+
+Here is an example. Given the following YAML front-matter:
+
+```
+---
+title: cats are awesome
+external-url: http://cats.example.com
+---
+```
+
+The post would have these attributes:
+
+```
+title        => Cats Are Awesome
+title_html   => Cats Are&nbsp;Awesome&nbsp;<span class='post-marker post-marker-after'>→</span>
+title_text   => Cats Are Awesome →
+title_url    => http://cats.example.com
+title_link   => <a href='http://cats.example.com' class='article-link linkpost'>...</a>
+linkpost     => true
+```
+
+Note: the `<a>` in this demo has been shortened, but it will contain the `title_html`.
+
+
+### Site features
+
+In addition, the site payload will have two new post arrays:
+
+- `site.articles` - Will contain standard posts only.
+- `site.linkposts` - Will contain only posts with an `external-url`
+
+This may have many uses, but one in particular is the option to allow RSS feeds for each type
+of post.
+
+## Configuration
+
+In your site's `_octopress.yml` you can configure the Link Blog features. Here are the defaults.
+
+```ruby
+linkpost:
+  marker: →
+  marker_position: after
+posts:
+  marker: false
+  marker_position: before
+
+titlecase: true
+unorphan: true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/linkblog/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 a new Pull Request
+

data/Rakefile

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

data/lib/octopress-linkblog.rb

@@ -0,0 +1,94 @@
+require 'octopress-linkblog/version'
+require 'octopress-linkblog/configuration'
+require 'titlecase'
+
+require 'octopress-hooks'
+require 'jekyll'
+
+module Octopress
+  module LinkBlog
+
+    def self.config
+      LinkBlog::Configuration.config
+    end
+
+    class SiteHook < Hooks::Site
+      def merge_payload(payload, site)
+        {
+          'site' => {
+            'linkposts' => site.posts.select {|p| p.data['linkpost']},
+            'articles'  => site.posts.reject {|p| p.data['linkpost']}
+          }
+        }
+      end
+    end
+
+    class PostHook < Hooks::Post
+      def post_init(post)
+        add_post_vars(post)
+      end
+
+      def add_post_vars(post)
+        linkpost = post.data['external-url']
+
+        if LinkBlog.config['titlecase']
+          post.data['title'].titlecase!
+        end
+
+        if linkpost
+          config = LinkBlog.config['linkpost']
+        else
+          config = LinkBlog.config['post']
+        end
+
+        post.data['title_text'] = title_text(post.data['title'], config)
+        post.data['title_html'] = title_html(post.data['title'], config)
+        post.data['title_url']  = linkpost || post.url
+        post.data['linkpost']   = !linkpost.nil?
+        post.data['title_link'] = title_link(post.data)
+        post
+      end
+
+      def unorphan(title)
+        title.sub(/\s+(\S+)\s*$/, '&nbsp;\1')
+      end
+
+      def title_html(title, config)
+        if LinkBlog.config['unorphan']
+          title = unorphan(title)
+        end
+
+        return title if !config['marker']
+
+        marker = "<span class='post-marker post-marker-#{config['marker_position']}'>#{config['marker']}</span>"
+        position = config['marker_position']
+
+        if config['marker_position'] == 'before'
+          title = "#{marker}&nbsp;#{title}"
+        else
+          title = "#{title}&nbsp;#{marker}"
+        end
+
+        title
+      end
+
+      def title_link(data)
+        classname = "article-link"
+        classname << " linkpost" if data['linkpost']
+        "<a href='#{data['title_url']}' class='#{classname}'>#{data['title_html']}</a>"
+      end
+
+      def title_text(title, config)
+        return title if !config['marker']
+        position = config['marker_position']
+
+        if config['marker_position'] == 'before'
+          "#{config['marker']} #{title}"
+        else
+          "#{title} #{config['marker']}"
+        end
+      end
+    end
+  end
+end
+

data/lib/octopress-linkblog/configuration.rb

@@ -0,0 +1,35 @@
+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 LinkBlog
+    module Configuration
+      DEFAULTS = {
+        'linkpost' => {
+          'marker' => "→",
+          'marker_position' => 'after'
+        },
+
+        'post' => {
+          'marker' => false,
+          'marker_position' => 'before'
+        },
+
+        'titlecase' => true,
+        'unorphan'  => true
+      }
+
+      def self.config
+        @config ||= Jekyll::Utils.deep_merge_hashes(DEFAULTS, Octopress.config)
+      end
+    end
+  end
+end

data/lib/octopress-linkblog/version.rb

@@ -0,0 +1,7 @@
+module Octopress
+  module Tags
+    module LinkBlog
+      VERSION = "1.0.0"
+    end
+  end
+end

data/octopress-linkblog.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'octopress-linkblog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "octopress-linkblog"
+  spec.version       = Octopress::Tags::LinkBlog::VERSION
+  spec.authors       = ["Brandon Mathis"]
+  spec.email         = ["brandon@imathis.com"]
+  spec.summary       = %q{Add linkblog features to your Jekyll site.}
+  spec.description   = %q{Add linkblog features to your Jekyll site.}
+  spec.homepage      = "https://github.com/octopress/linkblog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 2.0"
+  spec.add_runtime_dependency "octopress-hooks", "~> 2.1"
+  spec.add_runtime_dependency "titlecase"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "clash"
+end

data/test/.clash.yml

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

data/test/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'octopress-linkblog', path: '../'
+gem 'octopress', path: '../../cli'
+gem 'octopress-hooks', path: '../../hooks'
+gem 'pry-debugger'
+gem 'clash'

data/test/_config.yml

@@ -0,0 +1,14 @@
+# Site settings
+title: Your awesome title
+email: your-email@domain.com
+baseurl: ""
+url: "http://yourdomain.com"
+timezone: UTC
+
+exclude:
+  - Gemfile*
+
+# Build settings
+markdown: kramdown
+gems:
+  - octopress-linkblog

data/test/_expected/2014/05/25/awesome-things.html

@@ -0,0 +1 @@
+Hey Guys.

data/test/_expected/2014/06/25/some-linkpost.html

@@ -0,0 +1 @@
+Sup.

data/test/_expected/articles.html

@@ -0,0 +1,14 @@
+
+  Titles:
+normal: Some Awesome Post
+html: <span class='post-marker post-marker-before'>★</span>&nbsp;Some Awesome&nbsp;Post
+text: ★ Some Awesome Post
+
+Urls:
+normal: /2014/05/25/awesome-things.html
+title_url: /2014/05/25/awesome-things.html
+title_link: <a class='article-link' href='/2014/05/25/awesome-things.html'><span class='post-marker post-marker-before'>★</span>&nbsp;Some Awesome&nbsp;Post</a>
+
+linkpost: false
+
+

data/test/_expected/linkposts.html

@@ -0,0 +1,14 @@
+
+  Titles:
+normal: Some Link Post
+html: Some Link&nbsp;Post&nbsp;<span class='post-marker post-marker-after'>→</span>
+text: Some Link Post →
+
+Urls:
+normal: /2014/06/25/some-linkpost.html
+title_url: http://timecube.com
+title_link: <a class='article-link linkpost' href='http://timecube.com'>Some Link&nbsp;Post&nbsp;<span class='post-marker post-marker-after'>→</span></a>
+
+linkpost: true
+
+

data/test/_expected/posts.html

@@ -0,0 +1,27 @@
+
+  Titles:
+normal: Some Link Post
+html: Some Link&nbsp;Post&nbsp;<span class='post-marker post-marker-after'>→</span>
+text: Some Link Post →
+
+Urls:
+normal: /2014/06/25/some-linkpost.html
+title_url: http://timecube.com
+title_link: <a class='article-link linkpost' href='http://timecube.com'>Some Link&nbsp;Post&nbsp;<span class='post-marker post-marker-after'>→</span></a>
+
+linkpost: true
+
+
+  Titles:
+normal: Some Awesome Post
+html: <span class='post-marker post-marker-before'>★</span>&nbsp;Some Awesome&nbsp;Post
+text: ★ Some Awesome Post
+
+Urls:
+normal: /2014/05/25/awesome-things.html
+title_url: /2014/05/25/awesome-things.html
+title_link: <a class='article-link' href='/2014/05/25/awesome-things.html'><span class='post-marker post-marker-before'>★</span>&nbsp;Some Awesome&nbsp;Post</a>
+
+linkpost: false
+
+

data/test/_includes/post.html

@@ -0,0 +1,11 @@
+Titles:
+normal: {{ post.title }}
+html: {{ post.title_html }}
+text: {{ post.title_text }}
+
+Urls:
+normal: {{ post.url }}
+title_url: {{ post.title_url }}
+title_link: {{ post.title_link }}
+
+linkpost: {{ post.linkpost }}

data/test/_octopress.yml

@@ -0,0 +1,2 @@
+post:
+  marker: ★

data/test/_posts/2014-05-25-awesome-things.html

@@ -0,0 +1,5 @@
+---
+title: Some awesome post
+---
+
+Hey Guys.

data/test/_posts/2014-06-25-some-linkpost.html

@@ -0,0 +1,6 @@
+---
+title: Some link post
+external-url: http://timecube.com
+---
+
+Sup.

data/test/articles.html

@@ -0,0 +1,6 @@
+---
+---
+
+{% for post in site.articles %}
+  {% include post.html %}
+{% endfor %}

data/test/linkposts.html

@@ -0,0 +1,6 @@
+---
+---
+
+{% for post in site.linkposts %}
+  {% include post.html %}
+{% endfor %}

data/test/posts.html

@@ -0,0 +1,6 @@
+---
+---
+
+{% for post in site.posts %}
+  {% include post.html %}
+{% endfor %}

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: octopress-linkblog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !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: octopress-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: titlecase
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add linkblog features to your Jekyll site.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-linkblog.rb
+- lib/octopress-linkblog/configuration.rb
+- lib/octopress-linkblog/version.rb
+- octopress-linkblog.gemspec
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/2014/05/25/awesome-things.html
+- test/_expected/2014/06/25/some-linkpost.html
+- test/_expected/articles.html
+- test/_expected/linkposts.html
+- test/_expected/posts.html
+- test/_includes/post.html
+- test/_octopress.yml
+- test/_posts/2014-05-25-awesome-things.html
+- test/_posts/2014-06-25-some-linkpost.html
+- test/articles.html
+- test/linkposts.html
+- test/posts.html
+homepage: https://github.com/octopress/linkblog
+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: Add linkblog features to your Jekyll site.
+test_files:
+- test/.clash.yml
+- test/Gemfile
+- test/_config.yml
+- test/_expected/2014/05/25/awesome-things.html
+- test/_expected/2014/06/25/some-linkpost.html
+- test/_expected/articles.html
+- test/_expected/linkposts.html
+- test/_expected/posts.html
+- test/_includes/post.html
+- test/_octopress.yml
+- test/_posts/2014-05-25-awesome-things.html
+- test/_posts/2014-06-25-some-linkpost.html
+- test/articles.html
+- test/linkposts.html
+- test/posts.html