usmu 0.1.0

data/test/spec/spec_helper.rb

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: usmu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Scharley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slim
+  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: tilt
+  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: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  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: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: 
+email:
+- matt.scharley@gmail.com
+executables:
+- usmu
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile-jruby
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/usmu
+- cucumber.yml
+- lib/usmu.rb
+- lib/usmu/configuration.rb
+- lib/usmu/layout.rb
+- lib/usmu/page.rb
+- lib/usmu/site_generator.rb
+- lib/usmu/static_file.rb
+- lib/usmu/ui.rb
+- lib/usmu/ui/console.rb
+- lib/usmu/version.rb
+- test/expected-site/default.html
+- test/expected-site/embedded.html
+- test/expected-site/index.html
+- test/expected-site/robots.txt
+- test/features/generator.feature
+- test/features/step_definitions/step_general.rb
+- test/site/content/default.md
+- test/site/content/embedded.md
+- test/site/content/embedded.meta.yml
+- test/site/content/index.md
+- test/site/content/index.meta.yml
+- test/site/content/robots.txt
+- test/site/layouts/embedded.meta.yml
+- test/site/layouts/embedded.slim
+- test/site/layouts/html.meta.yml
+- test/site/layouts/html.slim
+- test/site/usmu.yml
+- test/spec/configuration_spec.rb
+- test/spec/layout_spec.rb
+- test/spec/page_spec.rb
+- test/spec/site_generator_spec.rb
+- test/spec/spec_helper.rb
+- test/spec/static_file_spec.rb
+- test/spec/support/shared_layout.rb
+- usmu-jruby.gemspec
+- usmu.gemspec
+homepage: https://github.com/usmu/usmu
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A static site generator with a web-based frontend for editing.
+test_files:
+- test/expected-site/default.html
+- test/expected-site/embedded.html
+- test/expected-site/index.html
+- test/expected-site/robots.txt
+- test/features/generator.feature
+- test/features/step_definitions/step_general.rb
+- test/site/content/default.md
+- test/site/content/embedded.md
+- test/site/content/embedded.meta.yml
+- test/site/content/index.md
+- test/site/content/index.meta.yml
+- test/site/content/robots.txt
+- test/site/layouts/embedded.meta.yml
+- test/site/layouts/embedded.slim
+- test/site/layouts/html.meta.yml
+- test/site/layouts/html.slim
+- test/site/usmu.yml
+- test/spec/configuration_spec.rb
+- test/spec/layout_spec.rb
+- test/spec/page_spec.rb
+- test/spec/site_generator_spec.rb
+- test/spec/spec_helper.rb
+- test/spec/static_file_spec.rb
+- test/spec/support/shared_layout.rb
+has_rdoc: