jekyll-opal 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a2e4c04c59f9edfed2577093fed6a82ed3fb596
-  data.tar.gz: 57e248e6e11022ed7a612f6aaf0c201ca1b79a56
+  metadata.gz: 572cf221b7ea9c111c2db90cb06d7c6faf375f8f
+  data.tar.gz: 889c457a57b43aff2c70501124275a31cb7d3306
 SHA512:
-  metadata.gz: c5a71e4e69cdf2163e2ca15912110ccde8983b1bbe8b0f56077c504583ee37316dd33964f673fe72be308a8c277b9874c8516f82b091b45cc446f36927f0473c
-  data.tar.gz: e3e72d5f1b23f03757954929b3b33fbc651f3e9de596702fa1cb77e96df2a3051253bb6e50ed9667ff44b9401a40a59532a6d50b380cb8b906334a29394130d3
+  metadata.gz: 1050c10ce1edadba8fe2eb0a92985ad3bb3d117e8b9c65ef7f4941ac7c319d0ecd2a8f0992081e597425458d7986263012198590d96080d8ce254c854283c71e
+  data.tar.gz: ed6a41d8c3e2f45a48e17c20b12687e8595e2a8fae1697898ab3a04b906f1ee8327b99e028b213ac4906c9f9c9010b77535f42805625c793b421aa760d597bc4

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/dest
 test/tmp
 test/version_tmp
 tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script : script/cibuild
+rvm:
+- 2.1
+- 2.0
+- 1.9.3
+notifications:
+  email: false

data/Gemfile

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

data/History.markdown

@@ -0,0 +1,9 @@
+## HEAD
+
+### Minor Enhancements
+
+### Bug Fixes
+
+## 0.1.0 / 2014-06-16
+
+  * Birthday!

data/README.md

@@ -1,6 +1,8 @@
-# Jekyll::Opal
+# Jekyll-Opal
 
-TODO: Write a gem description
+Let Jekyll convert your Ruby into JavaScript using [Opal](https://github.com/opal/opal).
+
+[![Build Status](https://travis-ci.org/jekyll/jekyll-opal.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-opal)
 
 ## Installation
 
@@ -18,11 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Write your Opal in `.opal` files (be sure to add the two `---` lines at the
+top to make them pages!!)
+
+This plugin comes with a generator which creates the Opal library file in
+the destination, under `js/opal.js`, if it's not already there. To prevent
+backwards-incompatible sites, we ship a `{{ site.opal.url }}` variable for
+your use in your sites. When output, it will look like this: `/js/opal.js`.
+
+If your site is served in a subfolder (i.e. `http://example.org/subfolder/`), simply prepend a baseurl:
+
+```html
+<script src="{{ site.opal.url | prepend:"my_subfolder" }}"></script>
+```
+
+You can even prepend variables! Perhaps a URL?
+
+```html
+<script src="{{ site.opal.url | prepend:"my_subfolder" | prepend:site.url }}"></script>
+```
+
+Feel free to chain them like that -- they're just Liquid filters.
+
+File an issue if something isn't clear!
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/jekyll-opal/fork )
+1. Fork it ( https://github.com/jekyll/jekyll-opal/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/jekyll-opal.gemspec

@@ -1,14 +1,14 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/opal/version'
+require 'jekyll-opal/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-opal"
   spec.version       = Jekyll::Opal::VERSION
   spec.authors       = ["Parker Moore"]
   spec.email         = ["parkrmoore@gmail.com"]
-  spec.summary       = %q{Convert your Ruby into JavaScript using Opal.}
+  spec.summary       = %q{Let Jekyll convert your Ruby into JavaScript using Opal.}
   spec.homepage      = "https://github.com/jekyll/jekyll-opal"
   spec.license       = "MIT"
 
@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "jekyll", "~> 2.0"
 end

data/lib/jekyll-opal.rb

@@ -0,0 +1,9 @@
+require "jekyll-opal/version"
+require "jekyll/converters/opal"
+require "jekyll/generators/opal"
+
+module Jekyll
+  module Opal
+    OPAL_LIB_LOCATION = File.join("js", "opal.js").freeze
+  end
+end

data/lib/{jekyll/opal → jekyll-opal}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Opal
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/jekyll/converters/opal.rb

@@ -0,0 +1,21 @@
+require 'opal'
+
+module Jekyll
+  module Converters
+    class Opal < Converter
+
+      def matches(ext)
+        !!(ext =~ /\.opal/i)
+      end
+
+      def output_ext(ext)
+        ".js"
+      end
+
+      def convert(content)
+        ::Opal.compile(content)
+      end
+
+    end
+  end
+end

data/lib/jekyll/generators/opal.rb

@@ -0,0 +1,56 @@
+require 'opal'
+
+module Jekyll
+  module Generators
+    class Opal < Generator
+
+      def generate(site)
+        write_file(output_location(site)) unless File.file?(output_location(site))
+        keep_the_file(site)
+        save_lib_file_location_to_config(site)
+      end
+
+      def write_file(location)
+        ensure_directory(location)
+        File.open(location, 'wb') do |f|
+          f.puts(opal_stdlib)
+        end
+        location
+      end
+
+      def opal_stdlib
+        ::Opal::Builder.build('opal')
+      end
+
+      def ensure_directory(location)
+        dir = File.dirname(location)
+        unless File.directory?(dir)
+          require 'fileutils'
+          FileUtils.mkdir_p(dir)
+        end
+      end
+
+      def output_location(site)
+        File.expand_path(opal_lib_relative_path, site.dest)
+      end
+
+      def keep_the_file(site)
+        (site.keep_files ||= []) << opal_lib_relative_path
+      end
+
+      def save_lib_file_location_to_config(site)
+        site.config["opal"] = {
+          "version" => ::Opal::VERSION,
+
+          # must start with a forward slash!
+          "url"     => File.join("", opal_lib_relative_path)
+        }
+      end
+
+      def opal_lib_relative_path
+        Jekyll::Opal::OPAL_LIB_LOCATION
+      end
+
+    end
+  end
+end

data/script/bootstrap

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

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rspec --color --require spec_helper

data/spec/opal_converter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe(Jekyll::Converters::Opal) do
+  let(:bogus_opal)  { "hi.there( oatmeal" }
+  let(:simple_opal) { "puts 'ohai jekyll'" }
+  let(:simple_js_output) do
+    <<-JS
+/* Generated by Opal 0.6.2 */
+(function($opal) {
+  var self = $opal.top, $scope = $opal, nil = $opal.nil, $breaker = $opal.breaker, $slice = $opal.slice;
+
+  $opal.add_stubs(['$puts']);
+  return self.$puts("ohai jekyll")
+})(Opal);
+JS
+  end
+
+  it "matches .opal files" do
+    expect(subject.matches(".opal")).to be_truthy
+  end
+
+  it "outputs .js" do
+    expect(subject.output_ext("ANYTHING AT ALL")).to eql(".js")
+  end
+
+  it "converts Ruby into Opal" do
+    expect(subject.convert(simple_opal)).to eql(simple_js_output)
+  end
+
+  it "explodes on bad input" do
+    expect(->{ subject.convert(bogus_opal) }).to raise_error
+  end
+
+end

data/spec/opal_generator_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe(Jekyll::Generators::Opal) do
+  let(:output_dir)  { dest_dir("js") }
+  let(:output_file) { dest_dir("js", "opal.js") }
+  let(:site)        { fixture_site }
+
+  it "knows where to output the file" do
+    expect(subject.output_location(site)).to eql(output_file)
+  end
+
+  it "can build the opal stdlib" do
+    expect(subject.opal_stdlib).to match("(Opal);")
+  end
+
+  context "when ensuring directory is there" do
+    before(:each) do
+      FileUtils.rm_r(output_dir) if File.directory?(output_dir)
+      subject.ensure_directory(subject.output_location(site))
+    end
+
+    it "creates the proper output directory" do
+      expect(File.directory?(output_dir)).to be_truthy
+    end
+  end
+
+  context "for a fresh site" do
+    before(:each) do
+      FileUtils.rm_r(dest_dir) if File.directory?(dest_dir)
+    end
+
+    it "writes the file" do
+      expect(subject.write_file(subject.output_location(site))).to eql(output_file)
+      expect(File.file?(output_file)).to be(true)
+    end
+  end
+
+  it "adds the outputted file to the site.keep_files list" do
+    expect(subject.keep_the_file(site)).to include("js/opal.js")
+    expect(site.keep_files).to eql(%w(.git .svn js/opal.js))
+  end
+
+  it "adds the 'opal' namespace for liquid" do
+    expect(subject.save_lib_file_location_to_config(site)).to eql({
+      "version" => Opal::VERSION, "url" => "/js/opal.js"
+    })
+    expect(site.config.has_key?("opal")).to be_truthy
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'fileutils'
+require 'jekyll'
+
+TEST_DIR = File.dirname(__FILE__)
+PROJECT_DIR = File.dirname(TEST_DIR)
+FIXTURE_DIR = File.expand_path("fixtures", TEST_DIR)
+require File.expand_path("lib/jekyll-opal.rb", PROJECT_DIR)
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 3
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+  def jekyll_conf(overrides = {})
+    Jekyll::Utils.deep_merge_hashes(
+      Jekyll::Configuration::DEFAULTS,
+      overrides
+    )
+  end
+
+  def fixture_site
+    Jekyll::Site.new jekyll_conf({
+      "source" => source_dir,
+      "destination" => dest_dir
+    })
+  end
+
+  def source_dir(*files)
+    test_dir("source", *files)
+  end
+
+  def dest_dir(*files)
+    test_dir("dest", *files)
+  end
+
+  def test_dir(*files)
+    File.join(TEST_DIR, *files)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-opal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Parker Moore
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: 
 email:
 - parkrmoore@gmail.com
@@ -60,13 +88,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
+- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll-opal.gemspec
-- lib/jekyll/opal.rb
-- lib/jekyll/opal/version.rb
+- lib/jekyll-opal.rb
+- lib/jekyll-opal/version.rb
+- lib/jekyll/converters/opal.rb
+- lib/jekyll/generators/opal.rb
+- script/bootstrap
+- script/cibuild
+- spec/opal_converter_spec.rb
+- spec/opal_generator_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jekyll/jekyll-opal
 licenses:
 - MIT
@@ -90,5 +127,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Convert your Ruby into JavaScript using Opal.
-test_files: []
+summary: Let Jekyll convert your Ruby into JavaScript using Opal.
+test_files:
+- spec/opal_converter_spec.rb
+- spec/opal_generator_spec.rb
+- spec/spec_helper.rb

data/lib/jekyll/opal.rb

@@ -1,7 +0,0 @@
-require "jekyll/opal/version"
-
-module Jekyll
-  module Opal
-    # Your code goes here...
-  end
-end