nesta 0.11.1 → 0.13.0

data/test/integration/commands/plugin/create_test.rb

@@ -0,0 +1,131 @@
+require 'test_helper'
+require_relative '../../../../lib/nesta/commands'
+
+describe 'nesta plugin:create' do
+  include TemporaryFiles
+
+  def working_directory
+    temp_path('plugins')
+  end
+
+  before do
+    FileUtils.mkdir_p(working_directory)
+  end
+
+  after do
+    remove_temp_directory
+  end
+
+  def plugin_name
+    'my-feature'
+  end
+
+  def gem_name
+    "nesta-plugin-#{plugin_name}"
+  end
+
+  def process_stub
+    Object.new.tap do |stub|
+      def stub.run(*args); end
+    end
+  end
+
+  def create_plugin(&block)
+    Dir.chdir(working_directory) do
+      command = Nesta::Commands::Plugin::Create.new(plugin_name)
+      command.execute(process_stub)
+    end
+  end
+
+  def assert_exists_in_plugin(path)
+    full_path = File.join(gem_name, path)
+    assert File.exist?(full_path), "#{path} not found in plugin"
+  end
+
+  def assert_file_contains(path, pattern)
+    assert_match pattern, File.read(File.join(gem_name, path))
+  end
+
+  it "creates the gem's directory" do
+    create_plugin { assert File.directory?(gem_name), 'gem directory not found' }
+  end
+
+  it 'creates README.md file' do
+    create_plugin { assert_exists_in_plugin('README.md') }
+  end
+
+  it 'includes installation instructions in README.md' do
+    create_plugin do
+      assert_file_contains('README.md', /echo 'gem "#{gem_name}"' >> Gemfile/)
+    end
+  end
+
+  it 'creates .gitignore file' do
+    create_plugin { assert_exists_in_plugin('.gitignore') }
+  end
+
+  it 'creates the gemspec' do
+    create_plugin do
+      gemspec = "#{gem_name}.gemspec"
+      assert_exists_in_plugin(gemspec)
+      assert_file_contains(gemspec, %r{require "#{gem_name}/version"})
+      assert_file_contains(gemspec, %r{Nesta::Plugin::My::Feature::VERSION})
+    end
+  end
+
+  it 'creates a Gemfile' do
+    create_plugin { assert_exists_in_plugin('Gemfile') }
+  end
+
+  it 'creates Rakefile for packaging the gem' do
+    create_plugin { assert_exists_in_plugin('Rakefile') }
+  end
+
+  it "creates default folder for Ruby files" do
+    create_plugin do
+      code_directory = File.join(gem_name, 'lib', gem_name)
+      assert File.directory?(code_directory), 'directory for code not found'
+    end
+  end
+
+  it 'creates file required when gem loaded' do
+    create_plugin do
+      path = "#{File.join('lib', gem_name)}.rb"
+      assert_exists_in_plugin(path)
+      assert_file_contains(path, %r{require "#{gem_name}/version"})
+    end
+  end
+
+  it 'creates version.rb' do
+    create_plugin do
+      version = File.join('lib', gem_name, 'version.rb')
+      assert_exists_in_plugin(version)
+      assert_file_contains version, <<-EOF
+module Nesta
+  module Plugin
+    module My
+      module Feature
+        VERSION = '0.1.0'
+      end
+    end
+  end
+end
+      EOF
+    end
+  end
+
+  it 'creates skeleton code for the plugin in init.rb' do
+    create_plugin do
+      init = File.join('lib', gem_name, 'init.rb')
+      assert_exists_in_plugin(init)
+
+      assert_file_contains init, <<-MODULE
+module Nesta
+  module Plugin
+    module My::Feature
+        MODULE
+
+      assert_file_contains init, 'helpers Nesta::Plugin::My::Feature::Helpers'
+    end
+  end
+end

data/test/integration/commands/theme/create_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+require_relative '../../../../lib/nesta/commands'
+
+describe 'nesta theme:create' do
+  include TemporaryFiles
+
+  def theme_path(path = '')
+    File.join('themes', 'theme-name', path)
+  end
+
+  before do
+    FileUtils.mkdir_p(project_root)
+  end
+
+  after do
+    remove_temp_directory
+  end
+
+  def process_stub
+    Object.new.tap do |stub|
+      def stub.run(*args); end
+    end
+  end
+
+  it 'creates default files in the theme directory' do
+    Dir.chdir(project_root) do
+      Nesta::Commands::Theme::Create.new('theme-name').execute(process_stub)
+    end
+    assert_exists_in_project theme_path('README.md')
+    assert_exists_in_project theme_path('app.rb')
+  end
+
+  it 'copies default view templates into views directory' do
+    Dir.chdir(project_root) do
+      Nesta::Commands::Theme::Create.new('theme-name').execute(process_stub)
+    end
+    %w(layout.haml page.haml master.sass).each do |template|
+      assert_exists_in_project theme_path("views/#{template}")
+    end
+  end
+end

data/test/integration/commands/theme/enable_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require_relative '../../../../lib/nesta/commands'
+
+describe 'nesta theme:enable' do
+  include TemporaryFiles
+
+  before do
+    FileUtils.mkdir_p(File.join(project_root, 'config'))
+    File.open(File.join(project_root, 'config', 'config.yml'), 'w').close
+  end
+
+  after do
+    remove_temp_directory
+  end
+
+  def process_stub
+    Object.new.tap do |stub|
+      def stub.run(*args); end
+    end
+  end
+
+  it 'enables the theme' do
+    Dir.chdir(project_root) do
+      Nesta::Commands::Theme::Enable.new('theme-name').execute(process_stub)
+      assert_match /^theme: theme-name/, File.read('config/config.yml')
+    end
+  end
+end

data/test/integration/commands/theme/install_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require_relative '../../../../lib/nesta/commands'
+
+describe 'nesta theme:install' do
+  include TemporaryFiles
+
+  def theme_name
+    'test'
+  end
+
+  def repo_url
+    "../../fixtures/nesta-theme-#{theme_name}.git"
+  end
+
+  def theme_dir
+    project_path("themes/#{theme_name}")
+  end
+
+  before do
+    FileUtils.mkdir_p(project_root)
+  end
+
+  after do
+    remove_temp_directory
+  end
+
+  def process_stub
+    Object.new.tap do |stub|
+      def stub.run(*args); end
+    end
+  end
+
+  it 'clones the repository' do
+    process = Minitest::Mock.new
+    process.expect(:run, true, ['git', 'clone', repo_url, "themes/#{theme_name}"])
+    in_temporary_project do
+      Nesta::Commands::Theme::Install.new(repo_url).execute(process)
+    end
+  end
+
+  it "removes the theme's .git directory" do
+    in_temporary_project do
+      Nesta::Commands::Theme::Install.new(repo_url).execute(process_stub)
+      refute File.exist?("#{theme_dir}/.git"), '.git folder found'
+    end
+  end
+
+  it 'enables the freshly installed theme' do
+    in_temporary_project do
+      Nesta::Commands::Theme::Install.new(repo_url).execute(process_stub)
+      assert_match /theme: #{theme_name}/, File.read('config/config.yml')
+    end
+  end
+
+  it 'determines name of theme from name of repository' do
+    url = 'https://foobar.com/path/to/nesta-theme-the-name.git'
+    command = Nesta::Commands::Theme::Install.new(url)
+    assert_equal 'the-name', command.theme_name
+  end
+
+  it "falls back to name of repo when theme name doesn't match correct format" do
+    url = 'https://foobar.com/path/to/mytheme.git'
+    command = Nesta::Commands::Theme::Install.new(url)
+    assert_equal 'mytheme', command.theme_name
+  end
+end

data/test/integration/default_theme_test.rb

@@ -0,0 +1,220 @@
+require 'integration_test_helper'
+
+describe 'Default theme' do
+  include Nesta::IntegrationTest
+
+  def in_categories(*categories)
+    { 'categories' => categories.map(&:path).join(', ') }
+  end
+
+  it 'includes description meta tag' do
+    with_temp_content_directory do
+      model = create(:page, metadata: { 'Description' => 'A good page' })
+      visit model.path
+      xpath = "//meta[@name='description'][@content='A good page']"
+      assert_has_xpath xpath, visible: false
+    end
+  end
+
+  it 'includes keywords meta tag' do
+    with_temp_content_directory do
+      model = create(:page, metadata: { 'Keywords' => 'good, content' })
+      visit model.path
+      xpath = "//meta[@name='keywords'][@content='good, content']"
+      assert_has_xpath xpath, visible: false
+    end
+  end
+
+  it "doesn't include Google Analytics JavaScript snippet by default" do
+    with_temp_content_directory do
+      visit '/'
+      assert_has_no_css 'script', text: 'google-analytics.com'
+    end
+  end
+
+  it 'includes Google Analytics JavaScript when configured' do
+    analytics_code = { 'google_analytics_code' => 'UA-1234' }
+    stub_config(temp_content.merge('test' => analytics_code)) do
+      visit '/'
+      assert_nil all('script').find { |s| s[:src].match /analytics\.js/ }
+    end
+  end
+
+  it 'displays site title' do
+    site_config = {
+      'title' => 'My blog',
+      'subtitle' => 'about stuff',
+    }
+    stub_config(temp_content.merge(site_config)) do
+      visit '/'
+      assert_has_css 'h1', text: 'My blog'
+      assert_has_css 'h2', text: 'about stuff'
+    end
+  end
+
+  describe 'menus' do
+    def create_pages_in_menu
+      pages
+    end
+
+    it "doesn't include menu markup if menu not configured" do
+      with_temp_content_directory do
+        visit '/'
+        assert_has_no_css 'ul.menu'
+      end
+    end
+
+    it 'only displays first two levels of menu items' do
+      with_temp_content_directory do
+        level1, level2, level3 = (0..2).map { create(:page) }
+        text = "%s\n  %s\n    %s\n" % [level1, level2, level3].map(&:abspath)
+        create_menu(text)
+        visit '/'
+        assert_has_css "ul.menu li a:contains('#{level1.link_text}')"
+        assert_has_css "ul.menu li ul li a:contains('#{level2.link_text}')"
+        assert_has_no_css "ul.menu a:contains('#{level3.link_text}')"
+      end
+    end
+
+    def create_page_and_menu
+      model = create(:page)
+      create_menu(model.path)
+      model
+    end
+
+    it "highlights current page's menu item" do
+      with_temp_content_directory do
+        model = create_page_and_menu
+        visit model.path
+        assert_has_css "ul.menu li[class='current']:contains('#{model.link_text}')"
+      end
+    end
+
+    it "highlights current page's menu item when app mounted at /prefix" do
+      Capybara.app = Rack::Builder.new do
+        map '/prefix' do
+          run Nesta::App.new
+        end
+      end
+
+      with_temp_content_directory do
+        model = create_page_and_menu
+        visit "/prefix/#{model.path}"
+        assert_has_css "ul.menu li[class='current']:contains('#{model.link_text}')"
+      end
+    end
+  end
+
+  it 'only displays read more link for summarised pages' do
+    with_temp_content_directory do
+      category = create(:category)
+      metadata = in_categories(category)
+      summarised = create(:page, metadata: metadata.merge('summary' => 'Summary'))
+      not_summarised = create(:page, metadata: metadata)
+      visit category.path
+      assert_has_css 'li:nth-child(1) p', text: summarised.read_more
+      assert_has_no_css 'li:nth-child(2) p', text: not_summarised.read_more
+    end
+  end
+
+  it 'displays page summaries or full content of unsummarised pages' do
+    with_temp_content_directory do
+      category = create(:category)
+      metadata = in_categories(category)
+      summarised = create(:page,
+                          content: 'Summarised content',
+                          metadata: metadata.merge(summary: 'Summary'))
+      not_summarised = create(:page,
+                              content: 'Unsummarised content',
+                              metadata: metadata)
+      visit category.path
+
+      # Page with a summary
+      assert_has_css 'li:nth-child(1) p', text: 'Summary'
+      assert_has_no_css 'li:nth-child(1) p', text: 'content'
+
+      # Page without a summary
+      assert_has_css 'li:nth-child(2) p', text: 'Unsummarised content'
+      assert_has_no_css 'li:nth-child(2) p', text: 'Summary'
+    end
+  end
+
+  it 'displays contents of page' do
+    with_temp_content_directory do
+      model = create(:page, content: 'Body of page')
+      visit model.path
+      assert_has_css 'p', text: 'Body of page'
+    end
+  end
+
+  describe 'category' do
+    it 'displays its "articles heading" above the articles' do
+      with_temp_content_directory do
+        category = create(:category, metadata: {
+          'articles heading' => 'Articles on this topic'
+        })
+        create(:article, metadata: in_categories(category))
+        visit category.path
+        assert_has_css 'h1', text: 'Articles on this topic'
+      end
+    end
+
+    it 'links to articles in category using article title' do
+      with_temp_content_directory do
+        category = create(:category)
+        article = create(:article, metadata: in_categories(category))
+        visit category.path
+        link_text, href = article.link_text, article.abspath
+        assert_has_css "ol h1 a[href$='#{href}']", text: link_text
+      end
+    end
+  end
+
+  describe 'article' do
+    it 'displays the date' do
+      with_temp_content_directory do
+        article = create(:article)
+        visit article.path
+        assert_has_css "time[datetime='#{article.date}']"
+      end
+    end
+
+    it 'links to parent page in breadcrumb' do
+      with_temp_content_directory do
+        parent = create(:category)
+        article = create(:article, path: "#{parent.path}/child")
+        visit article.path
+        href, link_text = parent.abspath, parent.link_text
+        assert_has_css "nav.breadcrumb a[href='#{href}']", text: link_text
+      end
+    end
+
+    it 'links to its categories at end of article' do
+      with_temp_content_directory do
+        categories = [create(:category), create(:category)]
+        article = create(:article, metadata: in_categories(*categories))
+        visit article.path
+        categories.each do |category|
+          href, link_text = category.abspath, category.link_text
+          assert_has_css "p.meta a[href$='#{href}']", text: link_text
+        end
+      end
+    end
+
+    it 'displays comments from Disqus' do
+      stub_config(temp_content.merge('disqus_short_name' => 'mysite')) do
+        article = create(:article)
+        visit article.path
+        assert_has_css '#disqus_thread'
+        assert_has_css 'script[src*="mysite.disqus.com"]', visible: false
+      end
+    end
+
+    it "doesn't use Disqus if it's not configured" do
+      with_temp_content_directory do
+        visit create(:article).path
+        assert_has_no_css '#disqus_thread'
+      end
+    end
+  end
+end

data/test/integration/overrides_test.rb

@@ -0,0 +1,118 @@
+require 'integration_test_helper'
+
+describe 'Overriding files in gem and themes' do
+  include Nesta::IntegrationTest
+
+  def in_nesta_project(config = {}, &block)
+    app_root = temp_path('root')
+    content_config = { 'content' => File.join(app_root, 'content') }
+    stub_config(content_config.merge(config)) do
+      with_app_root(app_root) do
+        yield
+      end
+    end
+  ensure
+    remove_temp_directory
+  end
+
+  def theme_name
+    'my-theme'
+  end
+
+  def create_fixture(type, name, content)
+    base_path = {
+      local: Nesta::Path.local,
+      theme: Nesta::Path.themes(theme_name)
+    }[type]
+    path = File.join(base_path, name)
+    FileUtils.mkdir_p(File.dirname(path))
+    open(path, 'w') { |file| file.write(content) }
+  end
+
+  def create_app_file(type)
+    create_fixture(type, 'app.rb', "FROM_#{type.to_s.upcase} = true")
+  end
+
+  describe 'app.rb' do
+    it 'loads app.rb from configured theme' do
+      in_nesta_project('theme' => theme_name) do
+        create_app_file(:theme)
+        Nesta::Overrides.load_theme_app
+        assert Object.const_get(:FROM_THEME), 'should load app.rb in theme'
+      end
+    end
+
+    it 'loads both local and theme app.rb files' do
+      in_nesta_project('theme' => theme_name) do
+        create_app_file(:local)
+        Nesta::Overrides.load_local_app
+        create_app_file(:theme)
+        Nesta::Overrides.load_theme_app
+        assert Object.const_get(:FROM_THEME), 'should load app.rb in theme'
+        assert Object.const_get(:FROM_LOCAL), 'should load local app.rb'
+      end
+    end
+  end
+
+  def create_view(type, name, content)
+    create_fixture(type, File.join('views', name), content)
+  end
+
+  describe 'rendering stylesheets' do
+    it 'renders Sass stylesheets' do
+      in_nesta_project do
+        create_view(:local, 'master.sass', "body\n  width: 10px * 2")
+        visit '/css/master.css'
+        assert_match /width: 20px;/, body, 'should match /width: 20px;/'
+      end
+    end
+
+    it 'renders SCSS stylesheets' do
+      in_nesta_project do
+        create_view(:local, 'master.scss', "body {\n  width: 10px * 2;\n}")
+        visit '/css/master.css'
+        assert_match /width: 20px;/, body, 'should match /width: 20px;/'
+      end
+    end
+
+    it 'renders stylesheet in the the gem if no others found' do
+      in_nesta_project do
+        visit '/css/master.css'
+        assert_equal 200, page.status_code
+      end
+    end
+  end
+
+  def create_haml(type, name, content)
+    create_view(type, 'layout.haml', '= yield')
+    create_view(type, name, content)
+  end
+
+  describe 'rendering Haml' do
+    it 'uses local template in place of default' do
+      in_nesta_project do
+        create_haml(:local, 'page.haml', '%p Local template')
+        visit create(:category).abspath
+        assert_has_xpath '//p', text: 'Local template'
+      end
+    end
+
+    it 'uses theme template in place of default' do
+      in_nesta_project('theme' => theme_name) do
+        create_haml(:theme, 'page.haml', '%p Theme template')
+        visit create(:category).abspath
+        assert_has_xpath '//p', text: 'Theme template'
+      end
+    end
+
+    it 'prioritise local templates over theme templates' do
+      in_nesta_project('theme' => theme_name) do
+        create_haml(:local, 'page.haml', '%p Local template')
+        create_haml(:theme, 'page.haml', '%p Theme template')
+        visit create(:category).abspath
+        assert_has_xpath '//p', text: 'Local template'
+        assert_has_no_xpath '//p', text: 'Theme template'
+      end
+    end
+  end
+end

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