jekyll-theme-specs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c601c43be1e92a24bf68448352572103dcf62238
+  data.tar.gz: 7aff260a5ccb49fd6e85247afa9f7c0435ce7a35
+SHA512:
+  metadata.gz: 2f6b06cfc339376055d653ef26b1ca12932755fb2c313d29f80f383e1b3c0e5047a428450ff78ff86a3d46eabed41c98daf729141d78785d1889005e63389d4f
+  data.tar.gz: be6c8e9e3b357ebad5902e32da195e0554d351cf56ecca36bf597bd9b03e619e528ef2d1065db56f32a0fbe408c571500bdebf77eeba380089c4969fd3c3dd4e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-theme-specs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pavel Tsurbeleu
+
+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,49 @@
+# Jekyll Theme Specs
+
+This gem is a simple wrap up of behavior-driven (BDD) validations borrowed from the original
+source code of Jekyll. The only reason it has been extracted into a gem is to be able to validate
+gem-based themes for Jekyll using Jekyll's original validation tools & techniques.
+
+All the credits belong to Jekyll's contributors & maintainers. Again, this gem is a
+carbon-copy of what is already available in Jekyll's code base in a bit more reusable package.
+
+## Installation
+
+Add this line to your Jekyll's Gemfile:
+
+```ruby
+gem 'jekyll-theme-specs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-specs
+
+## Usage
+
+At this point the tool makes quite a few assumptions and very rigid in terms of the configuration options available.
+
+- All your features MUST be placed in `features` folder (Cucumber default);
+- Before running your theme's specs, it is a MUST to run `bundle` or `bundle install`;
+- Always run the tool via Bundler, eq. `bundle exec theme-specs`;
+- You can opt-in for more concise reporting style (Jekyll's favorite) by using `-f Jekyll::Cucumber::Formatter` option, eq. `bundle exec theme-specs -f Jekyll::Cucumber::Formatter`;
+
+There is also `minima-theme-specs` repository that is a work in progress of building `minima` theme
+validations. We will start with a few simple things and expand coverage further.
+
+## Development
+
+...
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ptsurbeleu/jekyll-theme-specs. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jekyll/theme/specs"
+
+# 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/exe/theme-specs

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'cucumber'
+require 'pry'
+
+# Require our own step definitions and other files to support steps execution
+ARGV << "--require"
+ARGV << File.dirname(__FILE__) + '/../lib'
+
+# The dup is to keep ARGV intact, so that tools like ruby-debug can respawn.
+Cucumber::Cli::Main.new(ARGV.dup).execute!

data/jekyll-theme-specs.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-theme-specs"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Pavel Tsurbeleu"]
+  spec.email         = ["pavel.tsurbeleu@me.com"]
+
+  spec.summary       = %q{Helps you to write & exercise behavior-driven (BDD) specifications for your gem-based Jekyll theme}
+  spec.description   = %q{Helps you to write & exercise behavior-driven (BDD) specifications for your gem-based Jekyll theme}
+  spec.homepage      = "https://github.com/ptsurbeleu/jekyll-theme-specs"
+  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_dependency "cucumber", "~> 2.1"
+  spec.add_dependency "rspec"
+  spec.add_dependency "jekyll", ">= 3.0", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/step_definitions.rb

@@ -0,0 +1,366 @@
+Before do
+  # TODO: Figure out how to activate these snippets using configuration flags
+  # FileUtils.rm_rf(Paths.test_dir) if Paths.test_dir.exist?
+  # FileUtils.mkdir_p(Paths.test_dir) unless Paths.test_dir.directory?
+  # Dir.chdir(Paths.source_dir)
+end
+
+#
+
+After do
+  # TODO: Figure out how to activate these snippets using configuration flags
+  # FileUtils.rm_rf(Paths.test_dir) if Paths.test_dir.exist?
+  # Paths.output_file.delete if Paths.output_file.exist?
+  # Paths.status_file.delete if Paths.status_file.exist?
+  # Dir.chdir(Paths.test_dir.parent)
+end
+
+#
+
+Given(%r!^I have a blank site in "(.*)"$!) do |path|
+  unless File.exist?(path)
+    then FileUtils.mkdir_p(path)
+  end
+end
+
+#
+
+Given(%r!^I do not have a "(.*)" directory$!) do |path|
+  Paths.test_dir.join(path).directory?
+end
+
+#
+
+Given(%r!^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$!) do |file, key, value, text|
+  File.write(file, Jekyll::Utils.strip_heredoc(<<-DATA))
+    ---
+    #{key || "layout"}: #{value || "nil"}
+    ---
+
+    #{text}
+  DATA
+end
+
+#
+
+Given(%r!^I have an? "(.*)" file that contains "(.*)"$!) do |file, text|
+  File.write(file, text)
+end
+
+#
+
+Given(%r!^I have an? (.*) (layout|theme) that contains "(.*)"$!) do |name, type, text|
+  folder = type == "layout" ? "_layouts" : "_theme"
+
+  destination_file = Pathname.new(File.join(folder, "#{name}.html"))
+  FileUtils.mkdir_p(destination_file.parent) unless destination_file.parent.directory?
+  File.write(destination_file, text)
+end
+
+#
+
+Given(%r!^I have an? "(.*)" file with content:$!) do |file, text|
+  File.write(file, text)
+end
+
+#
+
+Given(%r!^I have an? (.*) directory$!) do |dir|
+  unless File.directory?(dir)
+    then FileUtils.mkdir_p(dir)
+  end
+end
+
+#
+
+Given(%r!^I have the following (draft|page|post)s?(?: (in|under) "([^"]+)")?:$!) do |status, direction, folder, table|
+  table.hashes.each do |input_hash|
+    title = slug(input_hash["title"])
+    ext = input_hash["type"] || "markdown"
+    filename = "#{title}.#{ext}" if %w(draft page).include?(status)
+    before, after = location(folder, direction)
+    dest_folder = "_drafts" if status == "draft"
+    dest_folder = "_posts"  if status == "post"
+    dest_folder = "" if status == "page"
+
+    if status == "post"
+      parsed_date = Time.xmlschema(input_hash["date"]) rescue Time.parse(input_hash["date"])
+      filename = "#{parsed_date.strftime("%Y-%m-%d")}-#{title}.#{ext}"
+    end
+
+    path = File.join(before, dest_folder, after, filename)
+    File.write(path, file_content_from_hash(input_hash))
+  end
+end
+
+#
+
+Given(%r!^I have the following documents? under the (.*) collection:$!) do |folder, table|
+  table.hashes.each do |input_hash|
+    title = slug(input_hash["title"])
+    filename = "#{title}.md"
+    dest_folder = "_#{folder}"
+
+    path = File.join(dest_folder, filename)
+    File.write(path, file_content_from_hash(input_hash))
+  end
+end
+
+#
+
+Given(%r!^I have a configuration file with "(.*)" set to "(.*)"$!) do |key, value|
+  # NOTE: This snippet has been tweaked as well to load '_config.yml'
+  # from the source directory, which is supposed to be the current directory.
+  config = \
+    if Paths::SOURCE_DIR.join("_config.yml").exist?
+      SafeYAML.load_file(Paths::SOURCE_DIR.join("_config.yml"))
+    else
+      {}
+    end
+  # NOTE: The original snippet was replaced with this code. In the given context we must
+  # assert configuration values to ensure our expectations are valid.
+  expect(config[key]).to eq value
+end
+
+#
+
+Given(%r!^I have a configuration file with:$!) do |table|
+  table.hashes.each do |row|
+    step %(I have a configuration file with "#{row["key"]}" set to "#{row["value"]}")
+  end
+end
+
+#
+
+Given(%r!^I have a configuration file with "([^\"]*)" set to:$!) do |key, table|
+  File.open("_config.yml", "w") do |f|
+    f.write("#{key}:\n")
+    table.hashes.each do |row|
+      f.write("- #{row["value"]}\n")
+    end
+  end
+end
+
+#
+
+Given(%r!^I have fixture collections$!) do
+  FileUtils.cp_r Paths.source_dir.join("test", "source", "_methods"), source_dir
+  FileUtils.cp_r Paths.source_dir.join("test", "source", "_thanksgiving"), source_dir
+end
+
+#
+
+Given(%r!^I wait (\d+) second(s?)$!) do |time, _|
+  sleep(time.to_f)
+end
+
+#
+
+When(%r!^I run jekyll(.*)$!) do |args|
+  run_jekyll(args)
+  # TODO: Figure out how to activate this snippet with configuration flag...
+  # if args.include?("--verbose") || ENV["DEBUG"]
+  #   $stderr.puts "\n#{jekyll_run_output}\n"
+  # end
+end
+
+#
+
+When(%r!^I run bundle(.*)$!) do |args|
+  run_bundle(args)
+  if args.include?("--verbose") || ENV["DEBUG"]
+    $stderr.puts "\n#{jekyll_run_output}\n"
+  end
+end
+
+#
+
+When(%r!^I run gem(.*)$!) do |args|
+  run_rubygem(args)
+  if args.include?("--verbose") || ENV["DEBUG"]
+    $stderr.puts "\n#{jekyll_run_output}\n"
+  end
+end
+
+#
+
+When(%r!^I run git add .$!) do
+  run_in_shell("git", "add", ".", "--verbose")
+end
+
+#
+
+When(%r!^I decide to build the theme gem$!) do
+  Dir.chdir(Paths.theme_gem_dir)
+  gemspec = "my-cool-theme.gemspec"
+  File.write(gemspec, File.read(gemspec).sub("TODO: ", ""))
+  File.new("_includes/blank.html", "w")
+  File.new("_sass/blank.scss", "w")
+  File.new("assets/blank.scss", "w")
+end
+
+#
+
+When(%r!^I change "(.*)" to contain "(.*)"$!) do |file, text|
+  File.open(file, "a") do |f|
+    f.write(text)
+  end
+end
+
+#
+
+When(%r!^I delete the file "(.*)"$!) do |file|
+  File.delete(file)
+end
+
+#
+
+Then(%r!^the (.*) directory should +(not )?exist$!) do |dir, negative|
+  if negative.nil?
+    expect(Pathname.new(dir)).to exist
+  else
+    expect(Pathname.new(dir)).to_not exist
+  end
+end
+
+#
+
+Then(%r!^I should (not )?see "(.*)" in "(.*)"$!) do |negative, text, file|
+  step %(the "#{file}" file should exist)
+  regexp = Regexp.new(text, Regexp::MULTILINE)
+  if negative.nil? || negative.empty?
+    expect(file_contents(file)).to match regexp
+  else
+    expect(file_contents(file)).not_to match regexp
+  end
+end
+
+#
+
+Then(%r!^I should (not )?see "(.*)" in "(.*)" if on Windows$!) do |negative, text, file|
+  step %(the "#{file}" file should exist)
+  regexp = Regexp.new(text, Regexp::MULTILINE)
+  if negative.nil? || negative.empty?
+    if Jekyll::Utils::Platforms.really_windows?
+      expect(file_contents(file)).to match regexp
+    else
+      expect(file_contents(file)).not_to match regexp
+    end
+  end
+end
+
+#
+
+Then(%r!^I should (not )?see "(.*)" in "(.*)" unless Windows$!) do |negative, text, file|
+  step %(the "#{file}" file should exist)
+  regexp = Regexp.new(text, Regexp::MULTILINE)
+  if negative.nil? || negative.empty?
+    if Jekyll::Utils::Platforms.really_windows?
+      expect(file_contents(file)).not_to match regexp
+    else
+      expect(file_contents(file)).to match regexp
+    end
+  end
+end
+
+#
+
+Then(%r!^I should see date "(.*)" in "(.*)" unless Windows$!) do |text, file|
+  step %(the "#{file}" file should exist)
+  regexp = Regexp.new(text)
+  if Jekyll::Utils::Platforms.really_windows? && !dst_active?
+    expect(file_contents(file)).not_to match regexp
+  else
+    expect(file_contents(file)).to match regexp
+  end
+end
+
+#
+
+Then(%r!^I should see date "(.*)" in "(.*)" if on Windows$!) do |text, file|
+  step %(the "#{file}" file should exist)
+  regexp = Regexp.new(text)
+  if Jekyll::Utils::Platforms.really_windows? && !dst_active?
+    expect(file_contents(file)).to match regexp
+  else
+    expect(file_contents(file)).not_to match regexp
+  end
+end
+
+#
+
+Then(%r!^I should see exactly "(.*)" in "(.*)"$!) do |text, file|
+  step %(the "#{file}" file should exist)
+  expect(file_contents(file).strip).to eq text
+end
+
+#
+
+Then(%r!^I should see escaped "(.*)" in "(.*)"$!) do |text, file|
+  step %(I should see "#{Regexp.escape(text)}" in "#{file}")
+end
+
+#
+
+Then(%r!^the "(.*)" file should +(not )?exist$!) do |file, negative|
+  if negative.nil?
+    expect(Pathname.new(file)).to exist
+  else
+    expect(Pathname.new(file)).to_not exist
+  end
+end
+
+#
+
+Then(%r!^I should see today's time in "(.*)"$!) do |file|
+  step %(I should see "#{seconds_agnostic_time(Time.now)}" in "#{file}")
+end
+
+#
+
+Then(%r!^I should see today's date in "(.*)"$!) do |file|
+  step %(I should see "#{Date.today}" in "#{file}")
+end
+
+#
+
+Then(%r!^I should (not )?see "(.*)" in the build output$!) do |negative, text|
+  if negative.nil? || negative.empty?
+    expect(jekyll_run_output).to match Regexp.new(text)
+  else
+    expect(jekyll_run_output).not_to match Regexp.new(text)
+  end
+end
+
+#
+
+Then(%r!^I should get an updated git index$!) do
+  index = %w(
+    .gitignore
+    Gemfile
+    LICENSE.txt
+    README.md
+    _includes/blank.html
+    _layouts/default.html
+    _layouts/page.html
+    _layouts/post.html
+    _sass/blank.scss
+    assets/blank.scss
+    my-cool-theme.gemspec
+  )
+  index.each do |file|
+    expect(jekyll_run_output).to match file
+  end
+end
+
+#
+
+Then(%r!^I should get a zero exit(?:\-| )status$!) do
+  step %(I should see "EXIT STATUS: 0" in the build output)
+end
+
+#
+
+Then(%r!^I should get a non-zero exit(?:\-| )status$!) do
+  step %(I should not see "EXIT STATUS: 0" in the build output)
+end

data/lib/support/formatter.rb

@@ -0,0 +1,214 @@
+require "fileutils"
+require "colorator"
+require "cucumber/formatter/console"
+require "cucumber/formatter/io"
+
+module Jekyll
+  module Cucumber
+    class Formatter
+      attr_accessor :indent, :runtime
+      include ::Cucumber::Formatter::Console
+      include ::Cucumber::Formatter::Io
+      include FileUtils
+
+      CHARS = {
+        :failed    => "\u2718".red,
+        :pending   => "\u203D".yellow,
+        :undefined => "\u2718".red,
+        :passed    => "\u2714".green,
+        :skipped   => "\u203D".blue,
+      }.freeze
+
+      #
+
+      def initialize(runtime, path_or_io, options)
+        @runtime = runtime
+        @snippets_input = []
+        @io = ensure_io(path_or_io)
+        @prefixes = options[:prefixes] || {}
+        @delayed_messages = []
+        @options = options
+        @exceptions = []
+        @indent = 0
+        @timings = {}
+      end
+
+      #
+
+      def before_features(_features)
+        print_profile_information
+      end
+
+      #
+
+      def after_features(features)
+        @io.puts
+        print_worst_offenders
+        print_summary(features)
+      end
+
+      #
+
+      def before_feature(_feature)
+        @exceptions = []
+        @indent = 0
+      end
+
+      #
+
+      def feature_element_timing_key(feature_element)
+        "\"#{feature_element.name.to_s.sub("Scenario: ", "")}\" (#{feature_element.location})"
+      end
+
+      #
+
+      def before_feature_element(feature_element)
+        @indent = 2
+        @scenario_indent = 2
+        @timings[feature_element_timing_key(feature_element)] = Time.now
+      end
+
+      #
+
+      def after_feature_element(feature_element)
+        @timings[feature_element_timing_key(feature_element)] = Time.now - @timings[feature_element_timing_key(feature_element)]
+        @io.print " (#{@timings[feature_element_timing_key(feature_element)]}s)"
+      end
+
+      #
+
+      def tag_name(tag_name); end
+
+      def comment_line(comment_line); end
+
+      def after_tags(tags); end
+
+      #
+
+      def before_background(_background)
+        @scenario_indent = 2
+        @in_background = true
+        @indent = 2
+      end
+
+      #
+
+      def after_background(_background)
+        @in_background = nil
+      end
+
+      #
+
+      def background_name(keyword, name, source_line, indent)
+        print_feature_element_name(
+          keyword, name, source_line, indent
+        )
+      end
+
+      #
+
+      def scenario_name(keyword, name, source_line, indent)
+        print_feature_element_name(
+          keyword, name, source_line, indent
+        )
+      end
+
+      #
+
+      def before_step(step)
+        @current_step = step
+      end
+
+      #
+
+      # rubocop:disable Metrics/ParameterLists
+      def before_step_result(_keyword, _step_match, _multiline_arg, status, exception, \
+              _source_indent, background, _file_colon_line)
+
+        @hide_this_step = false
+        if exception
+          if @exceptions.include?(exception)
+            @hide_this_step = true
+            return
+          end
+
+          @exceptions << exception
+        end
+
+        if status != :failed && @in_background ^ background
+          @hide_this_step = true
+          return
+        end
+
+        @status = status
+      end
+
+      #
+
+      def step_name(_keyword, _step_match, status, _source_indent, _background, _file_colon_line)
+        @io.print CHARS[status]
+        @io.print " "
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      #
+
+      def exception(exception, status)
+        return if @hide_this_step
+
+        @io.puts
+        print_exception(exception, status, @indent)
+        @io.flush
+      end
+
+      #
+
+      def after_test_step(test_step, result)
+        collect_snippet_data(
+          test_step, result
+        )
+      end
+
+      #
+
+      private
+      def print_feature_element_name(keyword, name, source_line, _indent)
+        @io.puts
+
+        names = name.empty? ? [name] : name.each_line.to_a
+        line  = "  #{keyword}: #{names[0]}"
+
+        @io.print(source_line) if @options[:source]
+        @io.print(line)
+        @io.print " "
+        @io.flush
+      end
+
+      #
+
+      def cell_prefix(status)
+        @prefixes[status]
+      end
+
+      #
+
+      def print_worst_offenders
+        @io.puts
+        @io.puts "Worst offenders:"
+        @timings.sort_by { |_f, t| -t }.take(10).each do |(f, t)|
+          @io.puts "  #{t}s for #{f}"
+        end
+        @io.puts
+      end
+
+      #
+
+      def print_summary(features)
+        @io.puts
+        print_stats(features, @options)
+        print_snippets(@options)
+        print_passing_wip(@options)
+      end
+    end
+  end
+end

data/lib/support/helpers.rb

@@ -0,0 +1,183 @@
+require "fileutils"
+require "jekyll"
+require "time"
+require "safe_yaml/load"
+
+class Paths
+  SOURCE_DIR = Pathname.new(Dir.pwd)
+
+  # NOTE: I'm not sure how to reuse this code... therefore raise if someone calls it.
+  def self.test_dir; raise 'NOT SUPPORTED!' ; end
+
+  def self.theme_gem_dir; 'NOT SUPPORTED!'; end
+
+  def self.output_file; source_dir.join("jekyll_output.txt"); end
+
+  def self.status_file; source_dir.join("jekyll_status.txt"); end
+
+  # NOTE: I'm not sure how to reuse this code... therefore raise if someone calls it.
+  def self.jekyll_bin; raise 'NOT SUPPORTED!'; end
+
+  def self.source_dir; SOURCE_DIR; end
+end
+
+#
+
+def file_content_from_hash(input_hash)
+  matter_hash = input_hash.reject { |k, _v| k == "content" }
+  matter = matter_hash.map do |k, v|
+    "#{k}: #{v}\n"
+  end
+
+  matter = matter.join.chomp
+  content = \
+    if !input_hash["input"] || !input_hash["filter"]
+      then input_hash["content"]
+    else "{{ #{input_hash["input"]} | " \
+        "#{input_hash["filter"]} }}"
+    end
+
+  Jekyll::Utils.strip_heredoc(<<-EOF)
+    ---
+    #{matter.gsub(
+      %r!\n!, "\n    "
+    )}
+    ---
+    #{content}
+  EOF
+end
+
+#
+
+def source_dir(*files)
+  return Paths.test_dir(*files)
+end
+
+#
+
+def all_steps_to_path(path)
+  source = source_dir
+  dest = Pathname.new(path).expand_path
+  paths = []
+
+  dest.ascend do |f|
+    break if f == source
+    paths.unshift f.to_s
+  end
+
+  paths
+end
+
+#
+
+def jekyll_run_output
+  if Paths.output_file.file?
+    then return Paths.output_file.read
+  end
+end
+
+#
+
+def jekyll_run_status
+  if Paths.status_file.file?
+    then return Paths.status_file.read
+  end
+end
+
+#
+
+def run_bundle(args)
+  run_in_shell("bundle", *args.strip.split(" "))
+end
+
+#
+
+def run_rubygem(args)
+  run_in_shell("gem", *args.strip.split(" "))
+end
+
+#
+
+def run_jekyll(args)
+  args = args.strip.split(" ") # Shellwords?
+  # process = run_in_shell("ruby", Paths.jekyll_bin.to_s, *args, "--trace")
+
+  # NOTE: We MUST execute Jekyll CLI that is from the gem installed
+  # but we need to leave the rest as is.
+  process = run_in_shell("jekyll", *args, "--trace")
+  process.exitstatus.zero?
+end
+
+#
+def run_in_shell(*args)
+  p, output = Jekyll::Utils::Exec.run(*args)
+
+  File.write(Paths.status_file, p.exitstatus)
+  File.open(Paths.output_file, "wb") do |f|
+    f.puts "$ " << args.join(" ")
+    f.puts output
+    f.puts "EXIT STATUS: #{p.exitstatus}"
+  end
+
+  p
+end
+
+#
+
+def slug(title = nil)
+  if !title
+    then Time.now.strftime("%s%9N") # nanoseconds since the Epoch
+  else title.downcase.gsub(%r![^\w]!, " ").strip.gsub(%r!\s+!, "-")
+  end
+end
+
+#
+
+def location(folder, direction)
+  if folder
+    before = folder if direction == "in"
+    after  = folder if direction == "under"
+  end
+
+  [before || ".",
+    after || ".",]
+end
+
+#
+
+def file_contents(path)
+  return Pathname.new(path).read
+end
+
+#
+
+def seconds_agnostic_datetime(datetime = Time.now)
+  date, time, zone = datetime.to_s.split(" ")
+  time = seconds_agnostic_time(time)
+
+  [
+    Regexp.escape(date),
+    "#{time}:\\d{2}",
+    Regexp.escape(zone),
+  ] \
+    .join("\\ ")
+end
+
+#
+
+def seconds_agnostic_time(time)
+  time = time.strftime("%H:%M:%S") if time.is_a?(Time)
+  hour, minutes, = time.split(":")
+  "#{hour}:#{minutes}"
+end
+
+# Helper method for Windows
+def dst_active?
+  config = Jekyll.configuration("quiet" => true)
+  ENV["TZ"] = config["timezone"]
+  dst = Time.now.isdst
+
+  # reset variable to default state on Windows
+  ENV["TZ"] = nil
+  dst
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-specs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Tsurbeleu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: rspec
+  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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Helps you to write & exercise behavior-driven (BDD) specifications for
+  your gem-based Jekyll theme
+email:
+- pavel.tsurbeleu@me.com
+executables:
+- theme-specs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/theme-specs
+- jekyll-theme-specs.gemspec
+- lib/step_definitions.rb
+- lib/support/formatter.rb
+- lib/support/helpers.rb
+homepage: https://github.com/ptsurbeleu/jekyll-theme-specs
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Helps you to write & exercise behavior-driven (BDD) specifications for your
+  gem-based Jekyll theme
+test_files: []