jekyll-stickyposts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2af17204ace97a1999dc4091992a8d72811c0eeb
+  data.tar.gz: 1319ca3797cb5670080e2ac2164b5d66de7b9e0a
+SHA512:
+  metadata.gz: 2cd32659de834bb7dcfd533a39f0a452601542c3a83a6062c60608fcef61330645d14d1640e646c75e79dafbef64f25b495c253b0465f3d83b41a5c6526b3e4b
+  data.tar.gz: ec84a2520f6e6e362d86b1f28f49e61015f7c2f2c50082b69e775e42bc21a0f387f6f1a8e6daf4327514bffa0e390eda1a1a2bf37a59da54604621520f640e7c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+jekyll-stickyposts*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jekyll-stickyposts.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,115 @@
+# Jekyll::StickyPosts
+
+*Version 1.0.0*
+
+*StickyPosts* is a plugin for [Jekyll](https://jekyllrb.com/) that sticks/pins posts marked `sticky: true` to the top, i.e. it moves them  before all others. Optionally, the posts could also appear where they normally would.
+
+### Why do this?
+
+1. You want to keep important announcements, etc. at the top of your home page
+
+## Installation
+
+Add the gem to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  # other plugins here
+  gem 'jekyll-stickyposts'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install jekyll-stickyposts
+
+## Configuration
+
+No configuration is required to run *StickyPosts*. If you want to tweak its behavior, you may set the following options in `_config.yml`:
+
+```yaml
+stickyposts:
+  #enabled: false   # Enable StickyPosts; default: true
+  debug: true       # Show additional info; default: false
+  sort: "blah"      # Optional sort field; default: "date", use "none" to avoid sorting
+  reverse: true     # Ascending order, default: false
+  retain: true      # Also show sticky posts in their original positions; default: false
+```
+
+> Note: if you set `sort` to `"none"` and don't sort as described in the next section, Jekyll will re-sort the documents by date. This may move the sticky posts out of position.
+
+## Usage
+
+If you're not using a paginator, use something like:
+
+```html
+{% assign sorted = site.posts | sort: "stickiness" %}
+{% for post in sorted %}
+...etc...
+{% endfor %}
+```
+
+If you're using a paginator that allows sorting on fields, e.g. [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2/), you need to edit your `_config.yml` a bit:
+
+```yaml
+pagination:
+  # ...
+  sort_field: "stickiness"
+  reverse: false
+  # ...
+
+# ...etc...
+
+stickyposts:
+  #sort: "date"   # or your original pagination sort_field
+  #reverse: true  # ditto for the pagination reverse
+  # ...etc...
+```
+
+No changes will be required in your pagination setup:
+
+```html
+{% for post in paginator.posts %}
+...etc...
+{% endfor %}
+```
+## Additional configuration
+
+You may want to mark sticky posts with e.g. a pin from [FontAwesome](http://fontawesome.io/):
+
+```html
+{% if post.sticky %}
+  <span class="sticky"><i class="fa fa-thumb-tack" aria-hidden="true"></i></span>
+{% endif %}
+```
+
+## Demo
+
+See the [author's blog](https://ibrado.org/) for a (possible) demo.
+
+## Contributing
+
+1. Fork this project: [https://github.com/ibrado/jekyll-stickyposts/fork](https://github.com/ibrado/jekyll-stickyposts/fork)
+1. Clone it (`git clone git://github.com/your_user_name/jekyll-stickyposts.git`)
+1. `cd jekyll-stickyposts`
+1. Create a new branch (e.g. `git checkout -b my-bug-fix`)
+1. Make your changes
+1. Commit your changes (`git commit -m "Bug fix"`)
+1. Build it (`gem build jekyll-stickyposts.gemspec`)
+1. Install and test it (`gem install ./jekyll-stickyposts-*.gem`)
+1. Repeat from step 3 as necessary
+1. Push the branch (`git push -u origin my-bug-fix`)
+1. Create a Pull Request, making sure to select the proper branch, e.g. `my-bug-fix` (via https://github.com/*your_user_name*/jekyll-stickyposts)
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/ibrado/jekyll-stickyposts](https://github.com/ibrado/jekyll-stickyposts). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+Everyone interacting in the Jekyll::StickyPosts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-stickyposts/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/stickyposts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jekyll-stickyposts.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll/stickyposts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-stickyposts"
+  spec.version       = Jekyll::StickyPosts::VERSION
+  spec.authors       = ["Alex Ibrado"]
+  spec.email         = ["alex@ibrado.org"]
+
+  spec.summary       = %q{StickyPosts: Sticky/pinned posts for Jekyll}
+  spec.description   = %q{This Jekyll plugin sticks/pins posts tagged sticky: true, i.e. moves them before all others. Optionally, the posts could also appear where they normally would. Sorting and ordering options are available. Compatible with pagination.}
+  spec.homepage      = "https://github.com/ibrado/jekyll-stickyposts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+end

data/lib/jekyll/stickyposts.rb

@@ -0,0 +1,93 @@
+require "jekyll/stickyposts/version"
+
+module Jekyll
+  module StickyPosts
+    def self.debug_state(state)
+      @debug = state
+    end
+
+    def self.info(msg)
+      Jekyll.logger.info "StickyPosts:", msg
+    end
+
+    def self.debug(msg)
+      self.info msg if @debug
+    end
+
+    class Generator < Jekyll::Generator
+      attr_reader :posts
+      priority :low
+
+      def generate(site)
+        config = site.config["stickyposts"] || {}
+        # Defaults:
+        # sort = date
+        # reverse = false
+        # enabled = true
+        # retain = false
+
+        return if !(config["enabled"].nil? || config["enabled"])
+
+        debug = config["debug"]
+        StickyPosts::debug_state debug 
+
+        collection = config["collection"] || "posts";
+
+        sort_field = config["sort"] || 'date'
+        sort_reverse = config["reverse"]
+
+        sorted = site.collections[collection].docs #.clone
+ 
+        unless config["sort"] == "none"
+          StickyPosts::debug "Sorting by #{sort_field}, reverse: #{sort_reverse ? "true" : "false"}"
+          sorted.sort! { |docB, docA|
+            a = docA.data[sort_field]
+            b = docB.data[sort_field]
+
+            if a.nil? && !b.nil?
+              -1
+            elsif !a.nil? && b.nil?
+              1
+            end
+
+            if a.respond_to?('to_datetime') && b.respond_to?('to_datetime')
+              a.to_datetime <=> b.to_datetime
+            end
+
+            a <=> b
+          }
+
+          sorted.reverse! if sort_reverse
+        end
+
+        remove = config["retain"].nil? || !config["retain"]
+
+        sticky = []
+        sorted.delete_if do |post|
+          if post.data['sticky']
+            StickyPosts::debug "\"#{post.data['title']}\" is sticky, #{remove ? "removing" : "retaining"} copy"
+            if remove
+              sticky << post
+            else
+              copy = Jekyll::Document.new(post.path, { :site => site, :collection => site.posts })
+              copy.merge_data!(post.data)
+              sticky << copy
+            end
+            remove
+          end
+        end
+
+        sorted.unshift(*sticky)
+
+        order = 0;
+        sorted.each do |post|
+          post.data["stickiness"] = order
+          order += 1
+        end
+
+        StickyPosts::info "#{sticky.length} post(s) pinned"
+
+      end
+    end
+  end
+end

data/lib/jekyll/stickyposts/version.rb

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-stickyposts
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Ibrado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-13 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: 'This Jekyll plugin sticks/pins posts tagged sticky: true, i.e. moves
+  them before all others. Optionally, the posts could also appear where they normally
+  would. Sorting and ordering options are available. Compatible with pagination.'
+email:
+- alex@ibrado.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jekyll-stickyposts.gemspec
+- lib/jekyll/stickyposts.rb
+- lib/jekyll/stickyposts/version.rb
+homepage: https://github.com/ibrado/jekyll-stickyposts
+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.5.1
+signing_key: 
+specification_version: 4
+summary: 'StickyPosts: Sticky/pinned posts for Jekyll'
+test_files: []