nesta 0.11.1 → 0.13.0

data/test/integration/sitemap_test.rb

@@ -0,0 +1,85 @@
+require 'integration_test_helper'
+
+describe 'XML sitemap' do
+  include Nesta::IntegrationTest
+
+  def visit_sitemap
+    visit '/sitemap.xml'
+  end
+
+  def for_site_with_page(&block)
+    with_temp_content_directory do
+      model = create(:page)
+      visit_sitemap
+      yield(model)
+    end
+  end
+
+  def for_site_with_article(&block)
+    with_temp_content_directory do
+      article = create(:article)
+      visit_sitemap
+      yield(article)
+    end
+  end
+
+  it 'renders successfully' do
+    for_site_with_page do
+      assert_equal 200, page.status_code
+    end
+  end
+
+  it 'has a urlset tag' do
+    for_site_with_page do
+      namespace = 'http://www.sitemaps.org/schemas/sitemap/0.9'
+      assert_has_xpath "//urlset[@xmlns='#{namespace}']"
+    end
+  end
+
+  it 'references the home page' do
+    for_site_with_page do
+      assert_has_xpath '//urlset/url/loc', text: 'http://www.example.com/'
+    end
+  end
+
+  it 'configures home page to be checked frequently' do
+    for_site_with_page do
+      assert_has_xpath '//urlset/url/loc', text: "http://www.example.com/"
+      assert_has_xpath '//urlset/url/changefreq', text: "daily"
+      assert_has_xpath '//urlset/url/priority', text: "1.0"
+    end
+  end
+
+  it "sets homepage lastmod from timestamp of most recently modified page" do
+    for_site_with_article do |article|
+      timestamp = article.last_modified
+      assert_has_xpath '//urlset/url/loc', text: "http://www.example.com/"
+      assert_has_xpath '//urlset/url/lastmod', text: timestamp.xmlschema
+    end
+  end
+
+  def site_url(path)
+    "http://www.example.com/#{path}"
+  end
+
+  it 'references category pages' do
+    for_site_with_page do |model|
+      assert_has_xpath '//urlset/url/loc', text: site_url(model.path)
+    end
+  end
+
+  it 'references article pages' do
+    for_site_with_article do |article|
+      assert_has_xpath '//urlset/url/loc', text: site_url(article.path)
+    end
+  end
+
+  it 'omits pages that have the skip-sitemap flag set' do
+    with_temp_content_directory do
+      create(:category)
+      omitted = create(:page, metadata: { 'flags' => 'skip-sitemap' })
+      visit_sitemap
+      assert_has_no_xpath '//urlset/url/loc', text: site_url(omitted.path)
+    end
+  end
+end

data/test/integration_test_helper.rb

@@ -0,0 +1,61 @@
+require 'capybara/dsl'
+
+require_relative 'test_helper'
+
+module Nesta
+  class App < Sinatra::Base
+    set :environment, :test
+    set :reload_templates, true
+  end
+
+  module IntegrationTest
+    include Capybara::DSL
+
+    include ModelFactory
+    include TestConfiguration
+
+    def setup
+      Capybara.app = App.new
+    end
+
+    def teardown
+      Capybara.reset_sessions!
+      Capybara.use_default_driver
+
+      remove_temp_directory
+      Nesta::FileModel.purge_cache
+    end
+
+    def assert_has_xpath(query, options = {})
+      if ! page.has_xpath?(query, options)
+        message = "not found in page: '#{query}'"
+        message << ", #{options.inspect}" unless options.empty?
+        fail message
+      end
+    end
+
+    def assert_has_no_xpath(query, options = {})
+      if page.has_xpath?(query, options)
+        message = "found in page: '#{query}'"
+        message << ", #{options.inspect}" unless options.empty?
+        fail message
+      end
+    end
+
+    def assert_has_css(query, options = {})
+      if ! page.has_css?(query, options)
+        message = "not found in page: '#{query}'"
+        message << ", #{options.inspect}" unless options.empty?
+        fail message
+      end
+    end
+
+    def assert_has_no_css(query, options = {})
+      if ! page.has_no_css?(query, options)
+        message = "found in page: '#{query}'"
+        message << ", #{options.inspect}" unless options.empty?
+        fail message
+      end
+    end
+  end
+end

data/test/support/model_factory.rb

@@ -0,0 +1,169 @@
+module ModelFactory
+  class FileModelWriter
+    def initialize(type, data = {})
+      @type = type
+      @data = data
+    end
+
+    def model_class
+      Nesta::FileModel
+    end
+
+    def instantiate_model
+      model_class.new(filename)
+    end
+
+    def extension
+      data.fetch(:ext, 'mdown')
+    end
+
+    def filename
+      File.join(model_class.model_path, "#{data[:path]}.#{extension}")
+    end
+
+    def sequence_prefix
+      'file-'
+    end
+
+    def default_data
+      { path: default_path }
+    end
+
+    def default_path
+      sequence_prefix + ModelFactory.next_sequence_number.to_s
+    end
+
+    def data
+      if @memoized_data.nil?
+        @memoized_data = default_data
+        if @memoized_data.has_key?(:metadata)
+          @memoized_data[:metadata].merge!(@data.delete(:metadata) || {})
+        end
+        @memoized_data.merge!(@data)
+      end
+      @memoized_data
+    end
+
+    def write
+      metadata = data[:metadata] || {}
+      metatext = metadata.map { |key, value| "#{key}: #{value}" }.join("\n")
+      contents =<<-EOF
+#{metatext}
+
+#{heading}#{data[:content]}
+      EOF
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, 'w') { |file| file.write(contents) }
+      yield(filename) if block_given?
+    end
+
+    def heading
+      return '' unless data[:heading]
+      prefix = {
+        'haml' => "%div\n  %h1",
+        'textile' => "<div>\nh1."
+      }.fetch(data[:ext], '# ')
+      "#{prefix} #{data[:heading]}\n\n"
+    end
+  end
+
+  class PageWriter < FileModelWriter
+    def model_class
+      Nesta::Page
+    end
+
+    def sequence_prefix
+      'page-'
+    end
+
+    def default_data
+      path = default_path
+      { path: path, heading: heading_from_path(path) }
+    end
+
+    def heading_from_path(path)
+      File.basename(path).sub('-', ' ').capitalize
+    end
+  end
+
+  class ArticleWriter < PageWriter
+    def sequence_prefix
+      'articles/page-'
+    end
+
+    def default_data
+      path = default_path
+      {
+        path: path,
+        heading: heading_from_path(path),
+        content: 'Content goes here',
+        metadata: {
+          'date' => '29 December 2008'
+        }
+      }
+    end
+  end
+
+  class CategoryWriter < PageWriter
+    def sequence_prefix
+      'categories/page-'
+    end
+
+    def default_data
+      path = default_path
+      {
+        path: path,
+        heading: heading_from_path(path),
+        content: 'Content goes here'
+      }
+    end
+  end
+
+  @@sequence = 0
+  def self.next_sequence_number
+    @@sequence += 1
+  end
+
+  def before_setup
+    # This is a minitest hook. We reset file sequence number at the
+    # start of each test so that we can automatically generate a unique
+    # path for each file we create within a test.
+    @@sequence = 0
+  end
+
+  def create(type, data = {}, &block)
+    file_writer = writer_class(type).new(type, data)
+    file_writer.write(&block)
+    file_writer.instantiate_model
+  end
+
+  def write_menu_item(indent, file, menu_item)
+    if menu_item.is_a?(Array)
+      indent.sub!(/^/, '  ')
+      menu_item.each { |path| write_menu_item(indent, file, path) }
+      indent.sub!(/^  /, '')
+    else
+      file.write("#{indent}#{menu_item}\n")
+    end
+  end
+
+  def create_menu(menu_text)
+    file = filename(Nesta::Config.content_path, 'menu', :txt)
+    File.open(file, 'w') { |file| file.write(menu_text) }
+  end
+
+  def create_content_directories
+    FileUtils.mkdir_p(Nesta::Config.page_path)
+    FileUtils.mkdir_p(Nesta::Config.attachment_path)
+  end
+
+  private
+  def filename(directory, basename, extension = :mdown)
+    File.join(directory, "#{basename}.#{extension}")
+  end
+
+  def writer_class(type)
+    camelcased_type = type.to_s.gsub(/(?:^|_)(\w)/) { $1.upcase }
+    ModelFactory.const_get(camelcased_type + 'Writer')
+  end
+end

data/test/support/temporary_files.rb

@@ -0,0 +1,33 @@
+module TemporaryFiles
+  TEMP_DIR = File.expand_path('tmp', File.join(File.dirname(__FILE__), '..'))
+
+  def remove_temp_directory
+    if File.exist?(TemporaryFiles::TEMP_DIR)
+      FileUtils.rm_r(TemporaryFiles::TEMP_DIR)
+    end
+  end
+
+  def temp_path(base)
+    File.join(TemporaryFiles::TEMP_DIR, base)
+  end
+
+  def project_root
+    temp_path('mysite.com')
+  end
+
+  def project_path(path)
+    File.join(project_root, path)
+  end
+
+  def in_temporary_project(*args, &block)
+    FileUtils.mkdir_p(File.join(project_root, 'config'))
+    File.open(File.join(project_root, 'config', 'config.yml'), 'w').close
+    Dir.chdir(project_root) { yield }
+  ensure
+    remove_temp_directory
+  end
+
+  def assert_exists_in_project(path)
+    assert File.exist?(project_path(path)), "#{path} should exist"
+  end
+end

data/test/support/test_configuration.rb

@@ -0,0 +1,19 @@
+module TestConfiguration
+  include TemporaryFiles
+
+  def stub_config(config, &block)
+    Nesta::Config.stub(:yaml_exists?, true) do
+      Nesta::Config.stub(:yaml_conf, config) do
+        yield
+      end
+    end
+  end
+
+  def temp_content
+    { 'content' => temp_path('content') }
+  end
+
+  def with_temp_content_directory(&block)
+    stub_config(temp_content) { yield }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require 'sinatra'
+require 'minitest/autorun'
+
+require 'minitest/reporters'
+
+reporter_setting = ENV.fetch('REPORTER', 'progress')
+camel_case = reporter_setting.split(/_/).map { |word| word.capitalize }.join('')
+Minitest::Reporters.use! Minitest::Reporters.const_get("#{camel_case}Reporter").new
+
+require File.expand_path('../lib/nesta/env', File.dirname(__FILE__))
+require File.expand_path('../lib/nesta/app', File.dirname(__FILE__))
+
+require_relative 'support/model_factory'
+require_relative 'support/temporary_files'
+require_relative 'support/test_configuration'
+
+Nesta::App.environment = 'test'
+
+class Minitest::Test
+  def with_app_root(path, &block)
+    original, Nesta::App.root = Nesta::App.root, path
+    yield
+  ensure
+    Nesta::App.root = original
+  end
+end

data/test/unit/config_test.rb

@@ -0,0 +1,138 @@
+require 'test_helper'
+
+describe Nesta::Config do
+  include TestConfiguration
+
+  after do
+    ENV.keys.each { |variable| ENV.delete(variable) if variable =~ /NESTA_/ }
+  end
+
+  it 'returns default value for "Read more"' do
+    assert_equal 'Continue reading', Nesta::Config.read_more
+  end
+
+  it 'returns nil for author when not defined' do
+    assert_nil Nesta::Config.author
+  end
+
+  describe 'when settings defined in ENV' do
+    before do
+      @title = 'Title from ENV'
+      ENV['NESTA_TITLE'] = @title
+    end
+
+    it 'falls back to config.yml' do
+      stub_config('subtitle' => 'Subtitle in YAML file') do
+        assert_equal 'Subtitle in YAML file', Nesta::Config.subtitle
+      end
+    end
+
+    it 'overrides config.yml' do
+      stub_config('title' => 'Title in YAML file') do
+        assert_equal @title, Nesta::Config.title
+      end
+    end
+
+    it 'knows how to cope with boolean values' do
+      Nesta::Config.settings << 'a_boolean'
+      begin
+        ENV['NESTA_A_BOOLEAN'] = 'true'
+        assert_equal true, Nesta::Config.a_boolean, 'should be true'
+        ENV['NESTA_A_BOOLEAN'] = 'false'
+        assert_equal false, Nesta::Config.a_boolean, 'should be false'
+      ensure
+        Nesta::Config.settings.pop
+        ENV.delete('NESTA_A_BOOLEAN')
+      end
+    end
+
+    it 'should return configured value for "Read more"' do
+      ENV['NESTA_READ_MORE'] = 'Read on'
+      begin
+        assert_equal 'Read on', Nesta::Config.read_more
+      ensure
+        ENV.delete('NESTA_READ_MORE')
+      end
+    end
+
+    it 'sets author hash from ENV' do
+      name = 'Name from ENV'
+      uri = 'URI from ENV'
+      ENV['NESTA_AUTHOR__NAME'] = name
+      ENV['NESTA_AUTHOR__URI'] = uri
+      assert_equal name, Nesta::Config.author['name']
+      assert_equal uri, Nesta::Config.author['uri']
+      assert Nesta::Config.author['email'].nil?, 'should be nil'
+    end
+  end
+
+  describe 'when settings only defined in config.yml' do
+    before do
+      @title = 'Title in YAML file'
+    end
+
+    it 'reads configuration from YAML' do
+      stub_config('subtitle' => @title) do
+        assert_equal @title, Nesta::Config.subtitle
+      end
+    end
+
+    it 'sets author hash from YAML' do
+      name = 'Name from YAML'
+      uri = 'URI from YAML'
+      stub_config('author' => { 'name' => name, 'uri' => uri }) do
+        assert_equal name, Nesta::Config.author['name']
+        assert_equal uri, Nesta::Config.author['uri']
+        assert Nesta::Config.author['email'].nil?, 'should be nil'
+      end
+    end
+
+    it 'overrides top level settings with environment specific settings' do
+      config = {
+        'content' => 'general/path',
+        'test' => { 'content' => 'rack_env_specific/path' }
+      }
+      stub_config(config) do
+        assert_equal 'rack_env_specific/path', Nesta::Config.content
+      end
+    end
+  end
+
+  describe 'Nesta::Config.fetch' do
+    it 'retrieves settings from environment' do
+      ENV['NESTA_MY_SETTING'] = 'value in ENV'
+      begin
+        assert_equal 'value in ENV', Nesta::Config.fetch('my_setting')
+        assert_equal 'value in ENV', Nesta::Config.fetch(:my_setting)
+      ensure
+        ENV.delete('NESTA_MY_SETTING')
+      end
+    end
+
+    it 'retrieves settings from YAML' do
+      stub_config('my_setting' => 'value in YAML') do
+        assert_equal 'value in YAML', Nesta::Config.fetch('my_setting')
+        assert_equal 'value in YAML', Nesta::Config.fetch(:my_setting)
+      end
+    end
+
+    it "throws NotDefined if a setting isn't defined" do
+      assert_raises(Nesta::Config::NotDefined) do
+        Nesta::Config.fetch('no such setting')
+      end
+    end
+
+    it 'allows default values to be set' do
+      assert_equal 'default', Nesta::Config.fetch('no such setting', 'default')
+    end
+
+    it 'copes with non-truthy boolean values' do
+      ENV['NESTA_SETTING'] = 'false'
+      begin
+        assert_equal false, Nesta::Config.fetch('setting')
+      ensure
+        ENV.delete('NESTA_SETTING')
+      end
+    end
+  end
+end

data/test/unit/file_model_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+describe Nesta::FileModel do
+  include ModelFactory
+  include TestConfiguration
+
+  after do
+    Nesta::FileModel.purge_cache
+    remove_temp_directory
+  end
+
+  it 'can find all files of this type' do
+    with_temp_content_directory do
+      model = create(:file_model)
+      assert_equal [model], Nesta::FileModel.find_all
+    end
+  end
+
+  describe '.find_file_for_path' do
+    it 'returns filename for path' do
+      with_temp_content_directory do
+        model = create(:file_model)
+        filename = Nesta::FileModel.find_file_for_path(model.path)
+        assert_equal filename, model.filename
+      end
+    end
+
+    it 'returns nil if file not found' do
+      with_temp_content_directory do
+        assert_nil Nesta::FileModel.find_file_for_path('foobar')
+      end
+    end
+  end
+
+  it 'can parse metadata at top of a file' do
+    with_temp_content_directory do
+      model = create(:file_model)
+      metadata = model.parse_metadata('My key: some value')
+      assert_equal 'some value', metadata['my key']
+    end
+  end
+
+  it "doesn't break loading pages with badly formatted metadata" do
+    with_temp_content_directory do
+      dodgy_metadata = "Key: value\nKey without value\nAnother key: value"
+      page = create(:page) do |path|
+        text = File.read(path)
+        File.open(path, 'w') do |file|
+          file.puts(dodgy_metadata)
+          file.write(text)
+        end
+      end
+      Nesta::Page.find_by_path(page.path)
+    end
+  end
+
+  it 'invalidates cached models when files are modified' do
+    with_temp_content_directory do
+      create(:file_model, path: 'a-page', metadata: { 'Version' => '1' })
+      now = Time.now
+      File.stub(:mtime, now - 1) do
+        Nesta::FileModel.load('a-page')
+      end
+      create(:file_model, path: 'a-page', metadata: { 'Version' => '2' })
+      model = File.stub(:mtime, now) do
+        Nesta::FileModel.load('a-page')
+      end
+      assert_equal '2', model.metadata('version')
+    end
+  end
+end

data/test/unit/menu_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+describe Nesta::Menu do
+  include ModelFactory
+  include TestConfiguration
+
+  def with_page(&block)
+    with_temp_content_directory do
+      page = create(:page)
+      create_menu(page.path)
+      yield(page)
+    end
+  end
+
+  def with_hierarchy_of_pages(&block)
+    with_temp_content_directory do
+      pages = (1..6).map { |i| create(:page) }
+      text = <<-EOF
+#{pages[0].path}
+  #{pages[1].path}
+    #{pages[2].path}
+    #{pages[3].path}
+    "no-such-page"
+"another-missing-page"
+#{pages[4].path}
+  #{pages[5].path}
+      EOF
+      create_menu(text)
+      yield(pages)
+    end
+  end
+
+  after do
+    remove_temp_directory
+    Nesta::FileModel.purge_cache
+  end
+
+  it 'retrieves Page objects for the menu' do
+    with_page do |page|
+      assert_equal [page], Nesta::Menu.full_menu
+      assert_equal [page], Nesta::Menu.for_path('/')
+    end
+  end
+
+  it "filters pages that don't exist out of the menu" do
+    with_temp_content_directory do
+      page = create(:page)
+      text = ['no-such-page', page.path].join("\n")
+      create_menu(text)
+      assert_equal [page], Nesta::Menu.top_level
+    end
+  end
+
+  describe 'nested sub menus' do
+    it 'returns top level menu items' do
+      with_hierarchy_of_pages do |pages|
+        assert_equal [pages[0], pages[4]], Nesta::Menu.top_level
+      end
+    end
+
+    it 'returns full tree of menu items' do
+      with_hierarchy_of_pages do |pages|
+        page1, page2, page3, page4, page5, page6 = pages
+        expected = [page1, [page2, [page3, page4]], page5, [page6]]
+        assert_equal expected, Nesta::Menu.full_menu
+      end
+    end
+
+    it 'returns part of the tree of menu items' do
+      with_hierarchy_of_pages do |pages|
+        page1, page2, page3, page4, page5, page6 = pages
+        assert_equal [page2, [page3, page4]], Nesta::Menu.for_path(page2.path)
+      end
+    end
+
+    it 'deems menu for path not in menu to be nil' do
+      with_hierarchy_of_pages do
+        assert_nil Nesta::Menu.for_path('wibble')
+      end
+    end
+  end
+end