jekyll-slugify_underscore 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 388ef81d823b79a183bbefd425ac0f0a00fc39e0
+  data.tar.gz: 0e9410cdf16cbf25b3061f21b0b0e658039e3c53
+SHA512:
+  metadata.gz: 79f35ad015c27add8466eaa0a53f46126ad894e2cebcd4388dea036a737da594e49a71d71445f7c592e3ac66358af2259182aade9893264907356c9ccd52ccc7
+  data.tar.gz: 34f43475ee7147646905dcd6e7c58f7f997f7cb0cd03732ada456cedc11ce649a99c2c26b114d52463e6114c2608c8a9eded7830a0b9b8414cbc9accec2a300b

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+spec/dest
+.bundle
+.jekyll-metadata

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paul Robert Lloyd
+
+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,27 @@
+# jekyll-slugify_underscore
+
+A plugin to make Jekyll slugify with underscores instead of hypens.
+
+[![Gem Version](https://img.shields.io/gem/v/jekyll-slugify_underscore.svg)](https://rubygems.org/gems/jekyll-slugify_underscore)
+
+## Installation
+
+1. Add `gem 'jekyll-slugify_underscore'` to your site’s Gemfile and run bundle
+2. Add the following to your site’s `_config.yml`:
+
+```yml
+gems:
+  - jekyll-slugify_underscore
+```
+
+## Testing
+
+1. `script/bootstrap`
+2. `script/cibuild`
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request

data/Rakefile

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

data/jekyll-slugify_underscore.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll/slugify_underscore/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "jekyll-slugify_underscore"
+  spec.version     = Jekyll::SlugifyUnderscore::VERSION
+  spec.summary     = "Jekyll slugify with underscores."
+  spec.description = "A plugin to make Jekyll slugify with underscores instead of hypens."
+  spec.authors     = ["Paul Robert Lloyd"]
+  spec.email       = "me+rubygems@paulrobertlloyd.com"
+  spec.files       = Dir.glob("lib/**/*.rb")
+  spec.homepage    = "https://github.com/paulrobertlloyd/jekyll-slugify_underscore"
+  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_development_dependency "jekyll", [">= 2.0", "< 4.0"]
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.6"
+end

data/lib/jekyll/slugify_underscore.rb

@@ -0,0 +1,57 @@
+module Jekyll
+  module Utils
+    # https://github.com/jekyll/jekyll/blob/master/lib/jekyll/utils.rb
+
+    # Slugify a filename or title.
+    #
+    # string - the filename or title to slugify
+    # mode - how string is slugified
+    #
+    # When mode is "none", return the given string in lowercase.
+    #
+    # When mode is "raw", return the given string in lowercase,
+    # with every sequence of spaces characters replaced with a hyphen.
+    #
+    # When mode is "default" or nil, non-alphabetic characters are
+    # replaced with a hyphen too.
+    #
+    # When mode is "pretty", some non-alphabetic characters (._~!$&'()+,;=@)
+    # are not replaced with hyphen.
+    #
+    # Examples:
+    #   slugify("The _config.yml file")
+    #   # => "the-config-yml-file"
+    #
+    #   slugify("The _config.yml file", "pretty")
+    #   # => "the-_config.yml-file"
+    #
+    # Returns the slugified string.
+
+    def slugify(string, mode=nil, delimiter="_")
+      mode ||= 'default'
+      return nil if string.nil?
+      return string.downcase unless SLUGIFY_MODES.include?(mode)
+
+      # Replace each character sequence with a hyphen
+      re = case mode
+      when 'raw'
+        SLUGIFY_RAW_REGEXP
+      when 'default'
+        SLUGIFY_DEFAULT_REGEXP
+      when 'pretty'
+        # "._~!$&'()+,;=@" is human readable (not URI-escaped) in URL
+        # and is allowed in both extN and NTFS.
+        SLUGIFY_PRETTY_REGEXP
+      end
+
+      string.
+        # Strip according to the mode
+        gsub(re, delimiter).
+        # Remove leading/trailing hyphen
+        gsub(/^#{delimiter}|#{delimiter}$/i, '').
+        # Downcase
+        downcase
+    end
+
+  end
+end

data/lib/jekyll/slugify_underscore/version.rb

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

data/script/bootstrap

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle install

data/script/cibuild

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+bundle exec rspec

data/script/console

@@ -0,0 +1,34 @@
+#! /usr/bin/env ruby
+
+def relative_to_root(path)
+  File.expand_path(path, File.dirname(File.dirname(__FILE__)))
+end
+
+require 'jekyll'
+require relative_to_root('lib/jekyll/slugify_underscore.rb')
+require 'pry-debugger'
+
+SOURCE_DIR = relative_to_root('spec/fixtures')
+DEST_DIR   = relative_to_root('spec/dest')
+
+def source_dir(*files)
+  File.join(SOURCE_DIR, *files)
+end
+
+def dest_dir(*files)
+  File.join(DEST_DIR, *files)
+end
+
+def config(overrides = {})
+  Jekyll.configuration({
+    "source"      => source_dir,
+    "destination" => dest_dir,
+    "url"         => "http://example.org"
+  }).merge(overrides)
+end
+
+def site(configuration = config)
+  Jekyll::Site.new(configuration)
+end
+
+binding.pry

data/script/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+script/cibuild
+bundle exec rake release

data/spec/fixtures/_config.yml

@@ -0,0 +1,9 @@
+timezone: UTC
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: page
+    values:
+      layout: some_default

data/spec/fixtures/_layouts/some_default.html

@@ -0,0 +1,5 @@
+---
+---
+{% for t in page.test %}
+{{ t | slugify }}<br />
+{% endfor %}

data/spec/fixtures/index.html

@@ -0,0 +1,5 @@
+---
+test:
+  - Tell me why I don't like hypens
+---
+Each test should be an item in `page.test`

data/spec/jekyll-slugify_underscore_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe(Jekyll) do
+  let(:overrides) do
+    {
+      "source"      => source_dir,
+      "destination" => dest_dir,
+      "url"         => "http://example.org",
+    }
+  end
+  let(:config) do
+    Jekyll.configuration(overrides)
+  end
+  let(:site)     { Jekyll::Site.new(config) }
+  let(:contents) { File.read(dest_dir("index.html")) }
+  before(:each) do
+    site.process
+  end
+
+  it "slugifies with underscores" do
+    expect(contents).to match /tell_me_why_i_don_t_like_hypens/
+    expect(contents).to_not match /tell-me-why-i-don-t-like-hypens$/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'jekyll'
+require File.expand_path('../lib/jekyll/slugify_underscore', File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
+  DEST_DIR   = File.expand_path("../dest", __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-slugify_underscore
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Robert Lloyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-12 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: 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'
+description: A plugin to make Jekyll slugify with underscores instead of hypens.
+email: me+rubygems@paulrobertlloyd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-slugify_underscore.gemspec
+- lib/jekyll/.DS_Store
+- lib/jekyll/slugify_underscore.rb
+- lib/jekyll/slugify_underscore/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/fixtures/_config.yml
+- spec/fixtures/_layouts/some_default.html
+- spec/fixtures/index.html
+- spec/jekyll-slugify_underscore_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/paulrobertlloyd/jekyll-slugify_underscore
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Jekyll slugify with underscores.
+test_files:
+- spec/fixtures/_config.yml
+- spec/fixtures/_layouts/some_default.html
+- spec/fixtures/index.html
+- spec/jekyll-slugify_underscore_spec.rb
+- spec/spec_helper.rb