jekyll-joule 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 168d9830494897dc6dd8c2135973945aec314ca9
-  data.tar.gz: 72dd84b82e4b69d5bd72cc3550d56a2c510e703e
+  metadata.gz: a4e2101503338f46fba3f5d6350affa42d1e5ef1
+  data.tar.gz: 8e7a846a2fd33971fc698b000f62a2363cc6c486
 SHA512:
-  metadata.gz: dee6756d1c6b10b87bd03b4edc2e3cbbf57f90095655dc37ba7318ad09a69a58493ccce6670882db06305aafecd890d6b133fc676ba034dd1d65fd9d3d17b417
-  data.tar.gz: a24ed6c2587b565c611bfcd0afd93f183794e5c6f9540eee3e9100de4be6eee910735d41e35e7d6d9285017d5b32d2722956159a77447cde93518c9bacd08d7f
+  metadata.gz: '02328add785b1185da1b1380a1b9f0891626fbce6b0b8b540142d022645c4624d747cf9759340aa0e5a3fddf3834a3dd596d3a0a12dc78828ee1ddeaa786a1d6'
+  data.tar.gz: 9b2eb2342c9bf9b6b715bbbd5e784ce32c7c35dcc059885b42e12e3b5aedde64746ec42d1ccf295790fb6085c2b0066c178499c08558395c5a8cba9cc78cb7dc

data/README.md

@@ -1,3 +1,34 @@
-# Joule ✨ [![Build Status](https://travis-ci.org/helpscout/jekyll-joule.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-joule)
+# Joule 🔸 [![Build Status](https://travis-ci.org/helpscout/jekyll-joule.svg?branch=master)](https://travis-ci.org/helpscout/jekyll-joule) [![Gem Version](https://badge.fury.io/rb/jekyll-joule.svg)](https://badge.fury.io/rb/jekyll-joule)
 
-A Jekyll library for Unit Testing
+Joule is a Jekyll utility helper designed to make it (way) easier to write unit tests.
+
+So far, Joule has only been tested with [minitest](https://github.com/seattlerb/minitest). However, you **should** be able to use it with other testing frameworks.
+
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-joule'
+```
+
+And then execute:
+```
+bundle
+```
+
+Or install it yourself as:
+```
+gem install jekyll-joule
+```
+
+
+## Documentation
+
+**[View the docs](https://github.com/helpscout/jekyll-joule/blob/master/docs/introduction.md)** to get started with Joule!
+
+
+## Examples
+
+**[View the example](https://github.com/helpscout/jekyll-joule/tree/master/examples)** Jekyll setup + Joule test files.

data/Rakefile

@@ -7,7 +7,7 @@ require 'yaml'
 require 'rake/testtask'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
-# require 'jekyll/joule/version'
+require 'jekyll/joule/version'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'

data/docs/introduction.md

@@ -0,0 +1,9 @@
+# Introduction
+
+Joule is a Jekyll utility helper designed to make it (way) easier to write unit tests.
+
+So far, Joule has only been tested with [minitest](https://github.com/seattlerb/minitest). However, you **should** be able to use it with other testing frameworks.
+
+There is a _slight_ bit of setup required to get Jekyll setup for testing.
+
+Check out our **[Setup](./setup.md)** documentation to get started!

data/docs/setup.md

@@ -0,0 +1,111 @@
+# Setup
+
+The are a couple of things you need to do to get started with writing Jekyll tests.
+
+The following steps are based on Jekyll's own [test setup](https://github.com/jekyll/jekyll/tree/master/test). However, they've been simplified to make it easier to follow 😘.
+
+> ## TLDR
+> You can find all of the setup code in our [examples](https://github.com/helpscout/jekyll-joule/tree/master/examples).
+
+## Add test dependencies
+
+Add a `Gemfile` to your Jekyll project's root directory, if you don't already have one.
+
+```shell
+my-jekyll/
+├── ...
+└── Gemfile
+```
+
+In that Gemfile, add the following Gem dependencies (if you don't have them already):
+
+```ruby
+source 'https://rubygems.org'
+group :test do
+  gem "minitest", "~> 5.8"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+  gem "rake", "~> 10.0"
+  gem "rspec-mocks"
+  gem "shoulda"
+  gem "jekyll-joule"
+end
+```
+
+This allow [Bundler](http://bundler.io/) to install and use these various Gems to power your Jekyll tests.
+
+
+## Add a Rakefile
+
+We're going to be using the following command to run our tests:
+
+`bundle exec rake test` 
+
+In order to get this working, we need to create a `Rakefile` and add a `test` task.
+
+Create an add a `Rakefile` (no extensions) to your Jekyll project's root directory.
+
+```shell
+my-jekyll/
+├── ...
+├── Gemfile
+└── Rakefile
+```
+
+In that `Rakefile`, add the following:
+
+```ruby
+require 'rake'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+```
+
+This tells `Rake` that for our `test` task, execute any `.rb` file in our `test/` directory that has a file name starting with `test_`.
+
+
+## Add a test directory
+
+In your Jekyll project's root folder, add a new `test/` directory
+
+```shell
+my-jekyll/
+├── ...
+├── test/
+├── Gemfile
+└── Rakefile
+```
+
+This is where you'll be adding all of your tests 😎.
+
+
+## Add a test helper file
+
+(Almost there, I promise). In your `test/` directory, add a new file called `helper.rb`:
+
+```shell
+my-jekyll/
+├── ...
+├── test/
+│   └── helper.rb
+├── Gemfile
+└── Rakefile
+```
+
+There's a **bunch** of stuff you need to add to your `helper.rb`. The easiest thing you can do is copy everything from our [example `helper.rb` file](https://github.com/helpscout/jekyll-joule/blob/master/examples/test/helper.rb), and paste it into your `helper.rb` file ✌️.
+
+That's it! Your Jekyll site is setup for testing 🎉
+
+To confirm, run the following command:
+
+`bundle exec rake test`
+
+As long as you don't see a bunch of errors in your Terminal (😱), then you're good!
+
+Next, let's start **[writing some tests!](./writing-tests.md)**!

data/examples/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "minitest", "~> 5.8"
+  gem "minitest-profile"
+  gem "minitest-reporters"
+  gem "rake", "~> 10.0"
+  gem "rspec-mocks"
+  gem "shoulda"
+  gem "jekyll-joule"
+end

data/examples/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/examples/test/helper.rb

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/profile'
+require 'ostruct'
+require 'rspec/mocks'
+require 'jekyll'
+require 'jekyll/joule'
+require 'shoulda'
+
+Jekyll.logger = Logger.new(StringIO.new)
+
+include Jekyll
+
+# Report with color.
+Minitest::Reporters.use! [
+  Minitest::Reporters::SpecReporter.new(
+    :color => true
+  )
+]
+
+class JekyllUnitTest < Minitest::Test
+  include ::RSpec::Mocks::ExampleMethods
+
+  def setup
+    @site = Site.new(site_configuration)
+    @site.read
+    @site.generate
+    @site.render
+
+    @joule = Jekyll::Joule::Site.new(@site)
+  end
+
+  def mocks_expect(*args)
+    RSpec::Mocks::ExampleMethods::ExpectHost.instance_method(:expect).\
+      bind(self).call(*args)
+  end
+
+  def before_setup
+    ::RSpec::Mocks.setup
+    super
+  end
+
+  def after_teardown
+    super
+    ::RSpec::Mocks.verify
+  ensure
+    ::RSpec::Mocks.teardown
+  end
+
+  def fixture_site(overrides = {})
+    Jekyll::Site.new(site_configuration(overrides))
+  end
+
+  def build_configs(overrides, base_hash = Jekyll::Configuration::DEFAULTS)
+    Utils.deep_merge_hashes(base_hash, overrides)
+      .fix_common_issues.backwards_compatibilize.add_default_collections
+  end
+
+  def site_configuration(overrides = {})
+    full_overrides = build_configs(overrides, build_configs({
+      "destination" => dest_dir,
+      "incremental" => false
+    }))
+    build_configs({
+      "source" => source_dir
+    }, full_overrides)
+  end
+
+  def dest_dir(*subdirs)
+    root_dir('dest', *subdirs)
+  end
+
+  def source_dir(*subdirs)
+    root_dir('source', *subdirs)
+  end
+
+  def clear_dest
+    FileUtils.rm_rf(dest_dir)
+    FileUtils.rm_rf(source_dir('.jekyll-metadata'))
+  end
+
+  def root_dir(*subdirs)
+    File.join(File.dirname(__FILE__), *subdirs)
+  end
+
+  def directory_with_contents(path)
+    FileUtils.rm_rf(path)
+    FileUtils.mkdir(path)
+    File.open("#{path}/index.html", "w"){ |f| f.write("I was previously generated.") }
+  end
+
+  def with_env(key, value)
+    old_value = ENV[key]
+    ENV[key] = value
+    yield
+    ENV[key] = old_value
+  end
+
+  def capture_output
+    stderr = StringIO.new
+    Jekyll.logger = Logger.new stderr
+    yield
+    stderr.rewind
+    return stderr.string.to_s
+  end
+  alias_method :capture_stdout, :capture_output
+  alias_method :capture_stderr, :capture_output
+end

data/examples/test/source/joule.md

@@ -0,0 +1,3 @@
+---
+title: "Joule"
+---

data/examples/test/test_example.rb

@@ -0,0 +1,23 @@
+require "helper"
+
+class ExampleTest < JekyllUnitTest
+  should "render a div" do
+    # 1. Write your markup
+    html = %Q[
+      <div class="aww">
+        Yiss
+      </div>
+    ]
+
+    # 2. Pass it into Joule for rendering
+    @joule.render(html)
+
+    # 3. Find your HTML element(s)
+    el = @joule.find(".hello")
+
+    # 4. Write tests
+    assert(el)
+    assert(el.text.include?("Hello"))
+    assert(el["class"].include?("hello"))
+  end
+end

data/jekyll-joule.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-mocks"
   spec.add_development_dependency "shoulda"
   spec.add_development_dependency "kramdown"
+  spec.add_development_dependency "jekyll-jolt"
+  spec.add_development_dependency "jekyll-spark"
 end

data/lib/jekyll/extensions/nokogiri_element.rb

@@ -0,0 +1,13 @@
+module Nokogiri
+  module XML
+    class Element
+      def find_all *args
+        self.css *args
+      end
+
+      def find *args
+        self.css(*args).first
+      end
+    end
+  end
+end

data/lib/jekyll/joule/page.rb

@@ -0,0 +1,32 @@
+require "jekyll"
+
+module Jekyll
+  module Joule
+    class Page < Jekyll::Page
+      WHITESPACE_REGEXP = %r!^\s*!m
+
+      def unindent(content)
+        content.gsub!(/\A^\s*\n/, "")
+        if content =~ WHITESPACE_REGEXP
+          indentation = Regexp.last_match(0).length
+          content.gsub!(/^\ {#{indentation}}/, "")
+        end
+
+        return content
+      end
+
+      def reparse(content = "")
+        content = unindent(content)
+        if content =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
+          self.content = %Q[\n#{$POSTMATCH.strip}\n]
+          self.data = SafeYAML.load(Regexp.last_match(1))
+        else
+          self.content = content
+          self.data = Hash.new
+        end
+
+        return self.content
+      end
+    end
+  end
+end

data/lib/jekyll/joule/site.rb

@@ -1,4 +1,5 @@
 require "jekyll"
+require "jekyll/joule/page"
 require "nokogiri"
 
 module Jekyll
@@ -8,23 +9,36 @@ module Jekyll
 
       def initialize(site)
         @site = site
-        @site.data["joule_data"]
+        @data = false
         @html = ""
         @fixture_id = "joule-fixture"
+        @test_page_name = "test_joule.md"
+
+        return self
+      end
+
+      def get_page
+        @site.pages.find {|p| p.name === @test_page_name}
+      end
+
+      def reset_page
+        @site.pages.delete_if {|p| p.name === @test_page_name}
       end
 
       def generate(page)
-        @data = [page]
+        reset_page
+        @site.pages.push(page)
         @site.render
 
-        return page
+        return get_page
       end
 
       def render(content)
-        page = @site.pages.last
-        page.content = %Q[<div id="#{@fixture_id}">#{content}</div>]
-        generate(page)
-        @html = Nokogiri::HTML(@data.first["content"]).css(%Q[##{@fixture_id}])[0]
+        page = Jekyll::Joule::Page.new(@site, @site.source, "/", @test_page_name)
+        page.reparse(content)
+        page.content = %Q[<div id="#{@fixture_id}">#{page.content}</div>]
+        @data = generate(page)
+        @html = Nokogiri::HTML(@data["content"]).css(%Q[##{@fixture_id}])[0]
 
         return self
       end
@@ -38,7 +52,7 @@ module Jekyll
       end
 
       def find(selector)
-        find_all(selector)[0]
+        find_all(selector).first
       end
     end
   end

data/lib/jekyll/joule/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Joule
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/lib/jekyll/joule.rb

@@ -1,2 +1,3 @@
 require "jekyll/joule/version"
 require "jekyll/joule/site"
+require "jekyll/extensions/nokogiri_element"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-joule
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - ItsJonQ
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-jolt
+  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: jekyll-spark
+  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:
 - itsjonq@gmail.com
@@ -163,9 +191,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/introduction.md
+- docs/setup.md
+- examples/Gemfile
+- examples/Rakefile
+- examples/test/helper.rb
+- examples/test/source/joule.md
+- examples/test/test_example.rb
 - jekyll-joule.gemspec
 - lib/jekyll-joule.rb
+- lib/jekyll/extensions/nokogiri_element.rb
 - lib/jekyll/joule.rb
+- lib/jekyll/joule/page.rb
 - lib/jekyll/joule/site.rb
 - lib/jekyll/joule/version.rb
 homepage: https://github.com/helpscout/jekyll-joule