nesta 0.9.11 → 0.12.0

data/test/integration/route_handlers_test.rb

@@ -0,0 +1,96 @@
+require 'integration_test_helper'
+
+describe 'Routing' do
+  include Nesta::IntegrationTest
+
+  it 'redirects requests with trailing slash' do
+    with_temp_content_directory do
+      model = create(:page)
+      visit model.path + '/'
+      assert_equal model.abspath, page.current_path
+    end
+  end
+
+  describe 'not_found handler' do
+    it 'returns HTTP code 404' do
+      with_temp_content_directory do
+        visit '/no-such-page'
+        assert_equal 404, page.status_code
+      end
+    end
+  end
+
+  describe 'default route' do
+    it 'provides access to helper methods in Haml pages' do
+      with_temp_content_directory do
+        model = create(:category,
+                       ext: 'haml',
+                       content: '%div= format_date(Date.new(2010, 11, 23))')
+        visit model.path
+        assert_has_css 'div', text: '23 November 2010'
+      end
+    end
+
+    it "should access helpers when rendering articles on a category page" do
+      with_temp_content_directory do
+        category = create(:page)
+        markup = "%h1 Heading\n\n%div= format_date(Date.new(2010, 11, 23))"
+        article = create(:article,
+                         ext: 'haml',
+                         metadata: { 'categories' => category.path },
+                         content: markup)
+        visit category.path
+        assert_has_css 'div', text: '23 November 2010'
+      end
+    end
+  end
+
+  def create_attachment_in(directory)
+    path = File.join(directory, 'test.txt')
+    FileUtils.mkdir_p(directory)
+    File.open(path, 'w') { |file| file.write("I'm a test attachment") }
+  end
+
+  describe 'attachments route' do
+    it 'returns HTTP code 200' do
+      with_temp_content_directory do
+        create_attachment_in(Nesta::Config.attachment_path)
+        visit '/attachments/test.txt'
+        assert_equal 200, page.status_code
+      end
+    end
+
+    it 'serves attachment to the client' do
+      with_temp_content_directory do
+        create_attachment_in(Nesta::Config.attachment_path)
+        visit '/attachments/test.txt'
+        assert_equal "I'm a test attachment", page.body
+      end
+    end
+
+    it 'sets the appropriate MIME type' do
+      with_temp_content_directory do
+        create_attachment_in(Nesta::Config.attachment_path)
+        visit '/attachments/test.txt'
+        assert_match %r{^text/plain}, page.response_headers['Content-Type']
+      end
+    end
+
+    it 'refuses to serve files outside the attachments directory' do
+      # On earlier versions of Sinatra this test would have been handed
+      # to the attachments handler. On the current version (1.4.5) it
+      # appears as though the request is no longer matched by the
+      # attachments route handler, which means we're not in danger of
+      # serving serving files to attackers via `#send_file`.
+      #
+      # I've left the test in anyway, as without it we wouldn't become
+      # aware of a security hole if there was a regression in Sinatra.
+      #
+      with_temp_content_directory do
+        model = create(:page)
+        visit "/attachments/../pages/#{File.basename(model.filename)}"
+        assert_equal 404, page.status_code
+      end
+    end
+  end
+end

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/silence_commands_during_tests.rb

@@ -0,0 +1,5 @@
+module SilenceCommandsDuringTests
+  def run_process(*args)
+    super(*args, out: '/dev/null', err: '/dev/null')
+  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