jekyll-config-variables 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0f6eec0587832e96bb779767ba7935725ad1c3b
+  data.tar.gz: d4f0647fad2b6680469043478abcfc3d9a259323
+SHA512:
+  metadata.gz: 62540a9382ed0ecbd0a4d48f4565f16e96d27de58172078221492c87189d6140dc4592d925fd73a4f866f107981801a7d70eeb4606d34a30594849b79bc18037
+  data.tar.gz: b3e72f3f8f25d18c9032be5724b2fd1466c55c1e0be9395456cf48cac810845c5af7d1861e6a21e24a04322a33b1bdb63534922717ec8b608393caa9c166c157

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3
+script: "script/cibuild"

data/Gemfile

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

data/README.md

@@ -0,0 +1,25 @@
+jekyll-verison-helper
+=======================
+
+This gem lets you define variables within a *_config.yml* file and refer to it through the same file.
+
+To do that, first, create a key called `variables`, and populate it with any set of variable names you like:
+
+``` yaml
+variables:
+  latest_version: "2.0"
+```
+
+In this case, a new variable called `latest_version` is available to use, and it's defined a `"2.0"`. You can use this variable throughout your YAML file with the `%{...}` notation. For example:
+
+``` yaml
+defaults:
+  -
+    scope:
+      path: ""
+      type: "source"
+      values:
+        version: "%{latest_version}"
+```
+
+This sets a frontmatter of `version` on all the files in the `source` collection. It uses whatever value is defined in `latest_version` to set that up.

data/Rakefile

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

data/_site/Gemfile

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

data/_site/Rakefile

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

data/_site/jekyll-version-helper.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-version-helper'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Garen Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+  spec.summary       = 'A set of monkey-patching plugins to help Jekyll when building versioned sites'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'jekyll', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/_site/lib/configurer.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+def iterate(h, variables)
+  h.each do |k, v|
+    # If v is nil, an array is being iterated and the value is k.
+    # If v is not nil, a hash is being iterated and the value is v.
+    #
+    value = v || k
+
+    if value.is_a?(Hash) || value.is_a?(Array)
+      iterate(value, variables)
+    else
+      variables.each_pair { |var, val| v.gsub!(/\%\{#{var}\}/, val) } if v.is_a? String
+    end
+  end
+end
+
+module Jekyll
+  class Site
+
+    alias_method :old_process, :process
+
+    def process
+      variables = self.config['variables']
+      return old_process if variables.nil?
+
+      iterate(self.config, variables)
+
+      old_process
+    end
+
+  end
+end

data/_site/lib/jekyll-version-helper.rb

@@ -0,0 +1,4 @@
+module JekyllVersionHelper
+  require 'configurer'
+  require 'permalinker'
+end

data/_site/lib/permalinker.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+module Jekyll
+  class Document
+    alias_method :old_url_placeholders, :url_placeholders
+
+    PROTECTED_NAMES = %w(index search)
+
+    def url_placeholders
+      additional_placeholders = site.config['placeholders'] || {}
+      split_path = cleaned_relative_path.split('/')
+      filename = split_path.pop # last value is the filename
+
+      if !PROTECTED_NAMES.include? filename
+        if split_path.last == 'hidden'
+          split_path.pop
+          path = (split_path << filename).join('/')
+        else
+          path = old_url_placeholders[:path]
+        end
+        additional_placeholders[:dirpath] = File.join(path, "index#{old_url_placeholders[:output_ext]}")
+      else
+        additional_placeholders[:dirpath] = File.join(*split_path, "#{filename}#{old_url_placeholders[:output_ext]}")
+      end
+
+      old_url_placeholders.merge(additional_placeholders)
+    end
+  end
+end

data/_site/spec/jekyll-version-helper/configurer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe('Configurer') do
+  let(:file1)        { setup_doc('file1.md') }
+  let(:file2)        { setup_doc('file2.md') }
+
+  it "writes the default frontmatter using a variable" do
+    require 'pp'
+    pp file1
+    expect(1).to eql(3)
+  end
+end

data/_site/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'jekyll'
+require 'yaml'
+require File.expand_path('lib/jekyll-config-variables.rb')
+
+RSpec.configure do |config|
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    Jekyll.logger.log_level = :error
+
+    @fixtures_path = Pathname.new(__FILE__).parent.join('fixtures')
+    @dest        = @fixtures_path.join('_site')
+    @config_src  = @fixtures_path.join('_config.yml')
+    # @posts_src   = @fixtures_path.join('_posts')
+    # @layouts_src = @fixtures_path.join('_layouts')
+    # @plugins_src = @fixtures_path.join('_plugins')
+
+    @site = Jekyll::Site.new(Jekyll.configuration(
+      YAML.load_file(@config_src)
+    ))
+
+    @dest.rmtree if @dest.exist?
+    @site.process
+  end
+
+  config.after(:each) do
+    # @dest.rmtree if @dest.exist?
+  end
+
+  def setup_doc(doc_filename)
+    puts @site.collections['source'].docs
+    @site.collections['source'].docs.find { |d| d.relative_path.match(doc_filename) }
+  end
+end

data/jekyll-config-variables.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-config-variables'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Garen Torikian']
+  spec.email         = ['gjtorikian@gmail.com']
+  spec.summary       = 'A Jekyll monkey-patch to allow you to use variables within your _config.yml file'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/gjtorikian/jekyll-config-variables'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'jekyll', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/configurer.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+def iterate(h, variables)
+  h.each do |k, v|
+    # If v is nil, an array is being iterated and the value is k.
+    # If v is not nil, a hash is being iterated and the value is v.
+    #
+    value = v || k
+
+    if value.is_a?(Hash) || value.is_a?(Array)
+      iterate(value, variables)
+    else
+      variables.each_pair { |var, val| v.gsub!(/\%\{#{var}\}/, val) } if v.is_a? String
+    end
+  end
+end
+
+module Jekyll
+  class Site
+
+    alias_method :old_process, :process
+
+    def process
+      variables = self.config['variables']
+      return old_process if variables.nil?
+
+      iterate(self.config, variables)
+
+      old_process
+    end
+
+  end
+end

data/lib/jekyll-config-variables.rb

@@ -0,0 +1,3 @@
+module JekyllConfigVariables
+  require 'configurer'
+end

data/script/bootstrap

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

data/script/cibuild

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+script/bootstrap > /dev/null 2>&1
+bundle exec rake spec

data/spec/fixtures/_config.yml

@@ -0,0 +1,15 @@
+variables:
+  latest_version: "2.0"
+
+collections:
+  source:
+    output: true
+    permalink: '/output/%{latest_version}/:dirpath'
+
+defaults:
+  -
+    scope:
+      path: ""
+      type: "source"
+    values:
+      version: "%{latest_version}"

data/spec/fixtures/_source/folder/file1.md

@@ -0,0 +1,5 @@
+---
+title: A file
+---
+
+I am a file.

data/spec/fixtures/_source/folder/file2.md

@@ -0,0 +1,5 @@
+---
+title: Another file
+---
+
+I am another file.

data/spec/fixtures/_source/folder/index.md

@@ -0,0 +1,5 @@
+---
+title: Another index!
+---
+
+I am an md index.

data/spec/fixtures/_source/folder/search/search.html

@@ -0,0 +1,5 @@
+---
+title: Search page
+---
+
+I search and stuff.

data/spec/fixtures/_source/index.html

@@ -0,0 +1,5 @@
+---
+title: The index.
+---
+
+Hello, I am an index.

data/spec/fixtures/_source/page1.md

@@ -0,0 +1,5 @@
+---
+title: A page
+---
+
+I am a page.

data/spec/jekyll-config-variables/configurer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe('Configurer') do
+  let(:index)        { setup_doc('index.html') }
+  let(:file1)        { setup_doc('file1.md') }
+  let(:file2)        { setup_doc('file2.md') }
+
+  it 'writes the default frontmatter using a variable' do
+    expect(file1.data['version']).to eql('2.0')
+    expect(file2.data['version']).to eql('2.0')
+    expect(index.data['version']).to eql('2.0')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+require 'jekyll'
+require 'yaml'
+require File.expand_path('lib/jekyll-config-variables.rb')
+
+RSpec.configure do |config|
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    Jekyll.logger.log_level = :error
+
+    @fixtures_path = Pathname.new(__FILE__).parent.join('fixtures')
+    @dest        = @fixtures_path.join('_site')
+    @config_src  = @fixtures_path.join('_config.yml')
+    @posts_src   = @fixtures_path.join('_posts')
+    @layouts_src = @fixtures_path.join('_layouts')
+    @plugins_src = @fixtures_path.join('_plugins')
+
+    @site = Jekyll::Site.new(Jekyll.configuration(
+      'source'      => @fixtures_path.to_s,
+      'destination' => @dest.to_s,
+      'plugins'     => @plugins_src.to_s,
+      'collections' => {
+        'source' => {'output' => true}
+      }
+    ))
+
+    @dest.rmtree if @dest.exist?
+    @site.process
+  end
+
+  # config.after(:each) do
+  #   @dest.rmtree if @dest.exist?
+  # end
+
+  def setup_doc(doc_filename)
+    @site.collections['source'].docs.find { |d| d.relative_path.match(doc_filename) }
+  end
+
+  def destination_file_exists?(file)
+    File.exist?(File.join(@dest.to_s, file))
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-config-variables
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Garen Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: ''
+email:
+- gjtorikian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- _site/Gemfile
+- _site/README.md
+- _site/Rakefile
+- _site/jekyll-version-helper.gemspec
+- _site/lib/configurer.rb
+- _site/lib/jekyll-version-helper.rb
+- _site/lib/permalinker.rb
+- _site/spec/jekyll-version-helper/configurer_spec.rb
+- _site/spec/spec_helper.rb
+- jekyll-config-variables.gemspec
+- lib/configurer.rb
+- lib/jekyll-config-variables.rb
+- script/bootstrap
+- script/cibuild
+- spec/fixtures/_config.yml
+- spec/fixtures/_source/folder/file1.md
+- spec/fixtures/_source/folder/file2.md
+- spec/fixtures/_source/folder/index.md
+- spec/fixtures/_source/folder/search/search.html
+- spec/fixtures/_source/index.html
+- spec/fixtures/_source/page1.md
+- spec/fixtures/_source/search.html
+- spec/jekyll-config-variables/configurer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gjtorikian/jekyll-config-variables
+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: A Jekyll monkey-patch to allow you to use variables within your _config.yml
+  file
+test_files: []