RubyGems - usmu - Versions diffs - 0.1.0-java - Mend

usmu 0.1.0-java

Files changed (49) hide show

checksums.yaml +7 -0
data/.cane +4 -0
data/.gitignore +17 -0
data/.rspec +5 -0
data/.travis.yml +34 -0
data/.yardopts +1 -0
data/Gemfile +4 -0
data/Gemfile-jruby +4 -0
data/LICENSE.md +22 -0
data/README.md +50 -0
data/Rakefile +61 -0
data/bin/usmu +10 -0
data/cucumber.yml +2 -0
data/lib/usmu/configuration.rb +83 -0
data/lib/usmu/layout.rb +166 -0
data/lib/usmu/page.rb +19 -0
data/lib/usmu/site_generator.rb +82 -0
data/lib/usmu/static_file.rb +39 -0
data/lib/usmu/ui/console.rb +26 -0
data/lib/usmu/ui.rb +7 -0
data/lib/usmu/version.rb +5 -0
data/lib/usmu.rb +12 -0
data/test/expected-site/default.html +3 -0
data/test/expected-site/embedded.html +15 -0
data/test/expected-site/index.html +14 -0
data/test/expected-site/robots.txt +1 -0
data/test/features/generator.feature +10 -0
data/test/features/step_definitions/step_general.rb +18 -0
data/test/site/content/default.md +3 -0
data/test/site/content/embedded.md +1 -0
data/test/site/content/embedded.meta.yml +2 -0
data/test/site/content/index.md +3 -0
data/test/site/content/index.meta.yml +3 -0
data/test/site/content/robots.txt +1 -0
data/test/site/layouts/embedded.meta.yml +2 -0
data/test/site/layouts/embedded.slim +2 -0
data/test/site/layouts/html.meta.yml +2 -0
data/test/site/layouts/html.slim +8 -0
data/test/site/usmu.yml +15 -0
data/test/spec/configuration_spec.rb +51 -0
data/test/spec/layout_spec.rb +27 -0
data/test/spec/page_spec.rb +15 -0
data/test/spec/site_generator_spec.rb +32 -0
data/test/spec/spec_helper.rb +85 -0
data/test/spec/static_file_spec.rb +20 -0
data/test/spec/support/shared_layout.rb +111 -0
data/usmu-jruby.gemspec +34 -0
data/usmu.gemspec +35 -0
metadata +285 -0

data/lib/usmu.rb ADDED Viewed

@@ -0,0 +1,12 @@
+%W{
+  usmu/version
+  usmu/configuration
+  usmu/static_file
+  usmu/layout
+  usmu/page
+  usmu/site_generator
+}.each { |f| require f }
+# This module contains all the code for the Usmu site generator
+module Usmu
+end

data/test/expected-site/default.html ADDED Viewed

@@ -0,0 +1,3 @@
+<h1>Default output</h1>
+<p>No metadata for this file. Uh oh!</p>

data/test/expected-site/embedded.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Default Title | Testing website</title>
+  </head>
+  <body>
+    <div id="content">
+      <div class="embedded">
+        <h1>Embedded test</h1>
+      </div>
+    </div>
+  </body>
+</html>

data/test/expected-site/index.html ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Default Title | Testing website</title>
+  </head>
+  <body>
+    <div id="content">
+      <h1>Test index</h1>
+      <p>This is some test content</p>
+    </div>
+  </body>
+</html>

data/test/expected-site/robots.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ User-agent: *

data/test/features/generator.feature ADDED Viewed

@@ -0,0 +1,10 @@
+Feature:
+  In order to create a website
+  As a user
+  I would like to generate a static website
+  Scenario:
+    Given I have a site at "test/site"
+    When I generate the site
+    Then the destination directory should match "test/expected-site"

data/test/features/step_definitions/step_general.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require 'usmu/ui/console'
+require 'open3'
+Given(/^I have a site at "([^"]*)"$/) do |location|
+  @site = Usmu::Ui::Console.new([location])
+end
+When(/^I generate the site$/) do
+  @site.execute
+end
+Then(/^the destination directory should match "([^"]*)"$/) do |test_folder|
+  run = %W{diff -qr #{@site.configuration.destination_path} #{test_folder}}
+  Open3.popen2e(*run) do |i, o, t|
+    output = run.join(' ') + "\n" + o.read
+    fail output if t.value != 0
+  end
+end

data/test/site/content/default.md ADDED Viewed

@@ -0,0 +1,3 @@
+# Default output
+No metadata for this file. Uh oh!

data/test/site/content/embedded.md ADDED Viewed

	@@ -0,0 +1 @@
1	+ # Embedded test

data/test/site/content/embedded.meta.yml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ---
2	+ layout: embedded

data/test/site/content/index.md ADDED Viewed

@@ -0,0 +1,3 @@
+# Test index
+This is some test content

data/test/site/content/index.meta.yml ADDED Viewed

@@ -0,0 +1,3 @@
+---
+title: Index page
+layout: html

data/test/site/content/robots.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ User-agent: *

data/test/site/layouts/embedded.meta.yml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ---
2	+ layout: html

data/test/site/layouts/embedded.slim ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ .embedded
2	+ \| #{{content}}

data/test/site/layouts/html.meta.yml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ ---
2	+ title: Default Title

data/test/site/layouts/html.slim ADDED Viewed

@@ -0,0 +1,8 @@
+doctype html
+html
+  head
+    title #{title} | #{site['title']}
+  body
+    #content
+      | #{{content}}

data/test/site/usmu.yml ADDED Viewed

@@ -0,0 +1,15 @@
+---
+source: content
+destination: site
+title: Testing website
+default meta:
+  title: Test website
+  layout: html
+slim:
+  :pretty: true
+kramdown:
+  :auto_ids: false

data/test/spec/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,51 @@
+require 'rspec'
+require 'usmu/configuration'
+RSpec.describe Usmu::Configuration do
+  context 'should prepend configuration folder' do
+    before do
+      hash = {
+          'source' => 'source',
+          'destination' => 'destination',
+          'layouts' => 'templates',
+      }
+      @configuration = Usmu::Configuration.from_hash(hash, 'test/usmu.yaml')
+    end
+    it 'to source' do
+      expect(@configuration.source_path).to eq('test/source')
+    end
+    it 'to destination' do
+      expect(@configuration.destination_path).to eq('test/destination')
+    end
+    it 'to layouts' do
+      expect(@configuration.layouts_path).to eq('test/templates')
+    end
+  end
+  context 'should have a default path' do
+    before do
+      hash = {}
+      @configuration = Usmu::Configuration.from_hash(hash)
+    end
+    it 'for source' do
+      expect(@configuration.source_path).to eq('src')
+    end
+    it 'for destination' do
+      expect(@configuration.destination_path).to eq('site')
+    end
+    it 'for layouts' do
+      expect(@configuration.layouts_path).to eq('layouts')
+    end
+  end
+  it 'should remember arbitrary configuration' do
+    configuration = Usmu::Configuration.from_hash({:test => 'foo'})
+    expect(configuration[:test]).to eq('foo')
+  end
+end

data/test/spec/layout_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'rspec'
+require 'support/shared_layout'
+require 'usmu/layout'
+RSpec.describe Usmu::Layout do
+  it_behaves_like 'an embeddable layout'
+  let(:configuration) { Usmu::Configuration.from_file('test/site/usmu.yml') }
+  it 'uses the \'layouts\' folder' do
+    layout = Usmu::Layout.new(configuration, 'html.slim')
+    rendered = layout.render({'content' => 'test'})
+    expect(rendered).to eq(<<-EOF)
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Default Title | Testing website</title>
+  </head>
+  <body>
+    <div id="content">
+      test
+    </div>
+  </body>
+</html>
+    EOF
+  end
+end

data/test/spec/page_spec.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'rspec'
+require 'support/shared_layout'
+require 'usmu/page'
+RSpec.describe Usmu::Page do
+  it_behaves_like 'an embeddable layout'
+  let(:configuration) { Usmu::Configuration.from_file('test/site/usmu.yml') }
+  it 'uses the \'source\' folder' do
+    page = Usmu::Page.new(configuration, 'index.md')
+    rendered = page.render({})
+    expect(rendered).to eq(File.read('test/expected-site/index.html'))
+  end
+end

data/test/spec/site_generator_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require 'rspec'
+require 'usmu/site_generator'
+RSpec.describe Usmu::SiteGenerator do
+  let(:configuration) { Usmu::Configuration.from_file('test/site/usmu.yml') }
+  let(:generator) { Usmu::SiteGenerator.new(configuration) }
+  it 'should have layouts' do
+    expect(generator.respond_to? :layouts).to eq(true)
+    expect(generator.layouts.map {|l| l.name}.sort).to eq(%w{embedded.slim html.slim})
+  end
+  it 'should have a list of renderable items' do
+    expect(generator.respond_to? :renderables).to eq(true)
+    expect(generator.renderables.map {|r| r.name}.sort).to eq(%w{default.md embedded.md index.md robots.txt})
+  end
+  it 'should have pages' do
+    expect(generator.respond_to? :pages).to eq(true)
+    expect(generator.pages.map {|p| p.name}.sort).to eq(%w{default.md embedded.md index.md})
+  end
+  it 'should have files' do
+    expect(generator.respond_to? :files).to eq(true)
+    expect(generator.files.map {|f| f.name}.sort).to eq(%w{robots.txt})
+  end
+  it 'should be able to generate a site' do
+    expect(generator.respond_to? :generate).to eq(true)
+    # Further testing is exercised at the system integration level in the cukes.
+  end
+end

data/test/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,85 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # 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|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  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|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+  # 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
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = 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 = 10
+  # 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
+end

data/test/spec/static_file_spec.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'support/shared_layout'
+require 'usmu/static_file'
+RSpec.describe Usmu::StaticFile do
+  it_behaves_like 'a renderable file'
+  let(:configuration) { Usmu::Configuration.from_file('test/site/usmu.yml') }
+  it 'uses the \'source\' folder' do
+    file = Usmu::StaticFile.new(configuration, 'robots.txt')
+    rendered = file.render
+    expect(rendered).to eq(File.read('test/expected-site/robots.txt'))
+  end
+  it 'has an output filename that matches input' do
+    file = Usmu::StaticFile.new(configuration, 'robots.txt')
+    expect(file.output_filename).to eq('robots.txt')
+  end
+end

data/test/spec/support/shared_layout.rb ADDED Viewed

@@ -0,0 +1,111 @@
+RSpec.shared_examples 'a renderable file' do
+  let(:empty_configuration) { Usmu::Configuration.from_hash({}) }
+  it 'and has a name' do
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', '', {})
+    expect(layout.respond_to? :name).to eq(true)
+    expect(layout.name).to eq('body.slim')
+  end
+  it 'and can be rendered' do
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', '', {})
+    expect(layout.respond_to? :render).to eq(true)
+    expect(layout.method(:render).arity).to eq(-1)
+    expect(layout.method(:render).parameters.length).to eq(1)
+  end
+end
+RSpec.shared_examples 'a layout' do
+  include_examples 'a renderable file'
+  let(:title_configuration) { Usmu::Configuration.from_hash({'default meta' => {'title' => 'title'}}) }
+  let(:meta_with_title) { {'title' => 'title'} }
+  let(:content) { "title \#{title}\nbody\n  #container\n    | \#{{content}}" }
+  it 'and has a type' do
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, meta_with_title)
+    expect(layout.respond_to? :type).to eq(true)
+    expect(layout.type).to eq('slim')
+  end
+  it 'and it renders a template' do
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, {})
+    expect(layout.render({'title' => 'title', 'content' => 'test'})).to eq(<<-EOF)
+<title>title</title><body><div id="container">test</div></body>
+    EOF
+  end
+end
+RSpec.shared_examples 'a layout with metadata' do
+  include_examples 'a layout'
+  it 'and has metadata' do
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, meta_with_title)
+    expect(layout.respond_to? :metadata).to eq(true)
+    expect(layout.metadata).to eq(meta_with_title)
+  end
+  it 'and respects default meta from configuration' do
+    layout = described_class.new(title_configuration, 'body.slim', 'slim', content, {})
+    expect(layout.render({'content' => 'test'})).to eq(<<-EOF)
+<title>title</title><body><div id="container">test</div></body>
+    EOF
+  end
+  context 'and prioritises' do
+    it 'variables over metadata' do
+      layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, meta_with_title)
+      expect(layout.render({'content' => 'test', 'title' => 'overridden title'})).to eq(<<-EOF)
+<title>overridden title</title><body><div id="container">test</div></body>
+      EOF
+    end
+    it 'variables over default metadata' do
+      layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, {})
+      expect(layout.render({'content' => 'test', 'title' => 'overridden title'})).to eq(<<-EOF)
+<title>overridden title</title><body><div id="container">test</div></body>
+      EOF
+    end
+  end
+  it 'and it has a html output filename' do
+    layout = described_class.new(empty_configuration, 'index.md', 'md', content, {})
+    expect(layout.output_filename).to eq('index.html')
+  end
+end
+RSpec.shared_examples 'an embeddable layout' do
+  include_examples 'a layout with metadata'
+  let(:wrapper) { "html\n  | \#{{content}}"}
+  it 'and respects parent templates' do
+    parent = described_class.new(empty_configuration, 'html.slim', 'slim', wrapper, {})
+    layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, {'layout' => parent, 'title' => 'test title'})
+    expect(layout.render({'content' => 'test'})).to eq(<<-EOF)
+<html><title>test title</title><body><div id="container">test</div></body>
+</html>
+    EOF
+  end
+  context 'and prioritises' do
+    it 'metadata over parent metadata' do
+      parent = described_class.new(empty_configuration, 'html.slim', 'slim', wrapper, {'title' => 'title'})
+      layout = described_class.new(empty_configuration, 'body.slim', 'slim', content, {'layout' => parent, 'title' => 'overridden title'})
+      expect(layout.render({'content' => 'test'})).to eq(<<-EOF)
+<html><title>overridden title</title><body><div id="container">test</div></body>
+</html>
+      EOF
+    end
+    it 'parent metadata over default metadata' do
+      parent = described_class.new(title_configuration, 'html.slim', 'slim', wrapper, {'title' => 'overridden title'})
+      layout = described_class.new(title_configuration, 'body.slim', 'slim', content, {'layout' => parent})
+      expect(layout.render({'content' => 'test'})).to eq(<<-EOF)
+<html><title>overridden title</title><body><div id="container">test</div></body>
+</html>
+      EOF
+    end
+  end
+end

data/usmu-jruby.gemspec ADDED Viewed

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usmu/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'usmu'
+  spec.version       = Usmu::VERSION
+  spec.authors       = ['Matthew Scharley']
+  spec.email         = ['matt.scharley@gmail.com']
+  spec.summary       = %q{A static site generator with a web-based frontend for editing.}
+  spec.homepage      = 'https://github.com/usmu/usmu'
+  spec.license       = 'MIT'
+  spec.platform      = 'java'
+  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_dependency 'slim', '~> 2.1'
+  spec.add_dependency 'tilt', '~> 2.0'
+  spec.add_dependency 'kramdown', '~> 1.5'
+  spec.add_dependency 'deep_merge', '~> 1.0'
+  spec.add_dependency 'trollop', '~> 2.0'
+  spec.add_dependency 'highline', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'cane', '~> 2.6'
+end

data/usmu.gemspec ADDED Viewed

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usmu/version'
+Gem::Specification.new do |spec|
+  spec.name          = 'usmu'
+  spec.version       = Usmu::VERSION
+  spec.authors       = ['Matthew Scharley']
+  spec.email         = ['matt.scharley@gmail.com']
+  spec.summary       = %q{A static site generator with a web-based frontend for editing.}
+  spec.homepage      = 'https://github.com/usmu/usmu'
+  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_dependency 'slim', '~> 2.1'
+  spec.add_dependency 'tilt', '~> 2.0'
+  # For now yard requires redcarpet < 3.2
+  # See: https://github.com/lsegal/yard/issues/812
+  spec.add_dependency 'redcarpet', '~> 3.1', '< 3.2'
+  spec.add_dependency 'deep_merge', '~> 1.0'
+  spec.add_dependency 'trollop', '~> 2.0'
+  spec.add_dependency 'highline', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'cane', '~> 2.6'
+end