nesta 0.13.0 → 0.15.0

data/lib/nesta/static/site.rb

@@ -0,0 +1,104 @@
+require 'rake'
+
+require_relative './html_file'
+
+module Nesta
+  module Static
+    class Site
+      def initialize(build_dir, domain, logger = nil)
+        @build_dir = build_dir
+        @domain = domain
+        @logger = logger
+        @app = Nesta::App.new
+        set_app_root
+      end
+
+      def render_pages
+        Nesta::Page.find_all.each do |page|
+          target = HtmlFile.new(@build_dir, page).filename
+          source = page.filename
+          task = Rake::FileTask.define_task(target => source) do
+            save_markup(target, render(page.abspath, target, source))
+          end
+          task.invoke
+        end
+      end
+
+      def render_not_found
+        path_info = '/404'
+        source = 'no-such-file.md'
+        target = File.join(@build_dir, '404.html')
+        markup = render(path_info, target, source, expected_code: 404)
+        save_markup(target, markup)
+      end
+
+      def render_atom_feed
+        filename = 'articles.xml'
+        path_info = "/#{filename}"
+        description = 'Atom feed'
+        target = File.join(@build_dir, filename)
+        markup = render(path_info, target, description)
+        save_markup(target, markup)
+      end
+
+      def render_sitemap
+        filename = File.join(@build_dir, 'sitemap.xml')
+        save_markup(filename, render('/sitemap.xml', filename, 'site'))
+      end
+
+      def render_templated_assets
+        Nesta::Config.build.fetch('templated_assets', []).each do |path|
+          filename = File.join(@build_dir, path)
+          save_markup(filename, render(path, filename, path))
+        end
+      end
+
+      private
+
+      def log(message)
+        @logger.call(message) if @logger
+      end
+
+      def set_app_root
+        root = ::File.expand_path('.')
+        ['Gemfile', ].each do |expected|
+          if ! File.exist?(File.join(root, 'config', 'config.yml'))
+            message = "is this a Nesta site? (expected './#{expected}')"
+            raise RuntimeError, message
+          end
+        end
+        Nesta::App.root = root
+      end
+
+      def rack_environment(abspath)
+        {
+          'REQUEST_METHOD' => 'GET',
+          'SCRIPT_NAME' => '',
+          'PATH_INFO' => abspath,
+          'QUERY_STRING' => '',
+          'SERVER_NAME' => @domain,
+          'SERVER_PROTOCOL' => 'https',
+          'rack.url_scheme' => 'https',
+          'rack.input' => StringIO.new,
+          'rack.errors' => STDERR
+        }
+      end
+
+      def render(abspath, filename, description, expected_code: 200)
+        http_code, headers, body = @app.call(rack_environment(abspath))
+        if http_code != expected_code
+          raise RuntimeError, "Can't render #{filename} from #{description}"
+        end
+        body.join
+      end
+
+      def save_markup(filename, content)
+        FileUtils.mkdir_p(File.dirname(filename))
+        if (! File.exist?(filename)) || (open(filename, 'r').read != content)
+          open(filename, 'w') { |output| output.write(content) }
+          log("Rendered #{filename}")
+        end
+      end
+    end
+  end
+end

data/lib/nesta/version.rb

@@ -1,3 +1,3 @@
 module Nesta
-  VERSION = '0.13.0'
+  VERSION = '0.15.0'
 end

data/lib/nesta.rb

@@ -1,8 +1,6 @@
 module Nesta
   def self.deprecated(name, message)
-    if Nesta::App.environment != :test
-      $stderr.puts "DEPRECATION WARNING: #{name} is deprecated; #{message}"
-    end
+    $stderr.puts "DEPRECATION WARNING: #{name} is deprecated; #{message}"
   end
 
   def self.fail_with(message)

data/nesta.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Graham Ashton"]
   s.email       = ["graham@effectif.com"]
-  s.homepage    = "http://nestacms.com"
+  s.homepage    = "https://nestacms.com"
   s.summary     = %q{Ruby CMS, written in Sinatra}
   s.description = <<-EOF
 Nesta is a lightweight Content Management System, written in Ruby using
@@ -31,11 +31,12 @@ EOF
 
   s.add_dependency('haml', '>= 3.1', '< 6.0')
   s.add_dependency('haml-contrib', '>= 1.0')
-  s.add_dependency('rack', '~> 2.0')
+  s.add_dependency('rack', '~> 2')
+  s.add_dependency('rake')
   s.add_dependency('rdiscount', '~> 2.1')
   s.add_dependency('RedCloth', '~> 4.2')
-  s.add_dependency('sassc', '>= 2.2')
-  s.add_dependency('sinatra', '~> 2.0')
+  s.add_dependency('sass-embedded', '~> 1.58')
+  s.add_dependency('sinatra', '~> 3.0')
   s.add_dependency('tilt', '~> 2.0')
 
   # Useful in development
@@ -46,5 +47,4 @@ EOF
   s.add_development_dependency('capybara', '~> 2.0')
   s.add_development_dependency('minitest', '~> 5.0')
   s.add_development_dependency('minitest-reporters')
-  s.add_development_dependency('rake')
 end

data/templates/config/config.yml

@@ -12,7 +12,7 @@ subtitle: "(change this text in config/config.yml)"
 #
 # author:
 #   name: Your Name
-#   uri: http://yourhomepage.com
+#   uri: https://yourdomain.com
 #   email: you@yourdomain.com
 
 # You can stick with the default look and feel, or use a theme. Themes are
@@ -21,7 +21,7 @@ subtitle: "(change this text in config/config.yml)"
 #
 # theme: name-of-theme
 
-# If you want to use the Disqus service (http://disqus.com) to display
+# If you want to use the Disqus service (https://disqus.com) to display
 # comments on your site, register a Disqus account and then specify your
 # site's short name here. A comment form will automatically be added to
 # the bottom of your pages.
@@ -65,3 +65,29 @@ content: content
 # production:
 #   content: /var/apps/nesta/shared/content
 #   google_analytics_code: "UA-???????-?"
+
+# The following settings control the behaviour of the `nesta build`
+# command, which is used to generate a "static" version of your site.
+# It's optional, but allows you to deploy your site on hosting providers
+# that serve pre-prepared HTML and CSS files (instead of generating them
+# in real-time with a web server).
+#
+# You can either set the `domain` key here, or specify it on the command
+# line with the `--domain` switch. Nesta needs to know your site's
+# domain name so that it can generate the correct URLs in sitemap.xml,
+# and in your Atom feed.
+#
+# The templated_assets setting is a list of the things that Nesta
+# generates for you, other from all the page in your content directory.
+# The example below is for a site that has two stylesheets, both of
+# which are converted from .sass or .scss files in your ./views folder.
+#
+# If you're not using Sass and are just editing CSS files directly, you
+# can keep them in your ./public folder and Nesta's build command will
+# find them automatically.
+#
+# build:
+#   domain: yourdomain.com
+#   templated_assets:
+#     - /css/master.css
+#     - /css/local.css

data/templates/themes/README.md

@@ -4,4 +4,4 @@
 <%= @name %> is a theme for Nesta, a [Ruby CMS](nesta), designed by
 <insert your name here>.
 
-[nesta]: http://nestacms.com
+[nesta]: https://nestacms.com

data/templates/themes/views/master.sass

@@ -1,3 +1,3 @@
 // Master Sass stylesheet
-// http://sass-lang.com/
+// https://sass-lang.com/
 

data/test/integration/atom_feed_test.rb

@@ -18,7 +18,7 @@ describe 'Atom feed' do
     it "uses Atom's XML namespace" do
       with_temp_content_directory do
         visit_feed
-        assert_has_xpath '//feed[@xmlns="http://www.w3.org/2005/Atom"]'
+        assert_has_xpath '//feed[@xmlns="https://www.w3.org/2005/Atom"]'
       end
     end
 

data/test/integration/commands/build_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+require_relative '../../../lib/nesta/commands'
+
+describe 'nesta build' do
+  include ModelFactory
+  include TestConfiguration
+
+  def silencing_stdout(&block)
+    stdout, $stdout = $stdout, StringIO.new
+    yield
+  ensure
+    $stdout.close
+    $stdout = stdout
+  end
+
+  it 'builds HTML file from Markdown file' do
+    in_temporary_project do
+      with_temp_content_directory do
+        page = create(:page)
+        command = Nesta::Commands::Build.new('output_dir')
+
+        process = Minitest::Mock.new
+        silencing_stdout { command.execute(process) }
+
+        assert_exists_in_project File.join('output_dir', page.abspath + '.html')
+      end
+    end
+  end
+
+  it 'reads domain name from config file' do
+    domain = 'mysite.com'
+
+    in_temporary_project do
+      stub_config('build' => { 'domain' => domain }) do
+        command = Nesta::Commands::Build.new('output_dir')
+
+        assert_equal domain, command.domain
+      end
+    end
+  end
+
+  it 'overrides domain name if set on command line' do
+    domain = 'mysite.com'
+
+    in_temporary_project do
+      stub_config('build' => { 'domain' => 'ignored.com' }) do
+        command = Nesta::Commands::Build.new('output_dir', 'domain' => domain)
+
+        assert_equal domain, command.domain
+      end
+    end
+  end
+end

data/test/integration/overrides_test.rb

@@ -75,7 +75,7 @@ describe 'Overriding files in gem and themes' do
       end
     end
 
-    it 'renders stylesheet in the the gem if no others found' do
+    it 'renders stylesheet in the gem if no others found' do
       in_nesta_project do
         visit '/css/master.css'
         assert_equal 200, page.status_code

data/test/integration/sitemap_test.rb

@@ -31,7 +31,7 @@ describe 'XML sitemap' do
 
   it 'has a urlset tag' do
     for_site_with_page do
-      namespace = 'http://www.sitemaps.org/schemas/sitemap/0.9'
+      namespace = 'https://www.sitemaps.org/schemas/sitemap/0.9'
       assert_has_xpath "//urlset[@xmlns='#{namespace}']"
     end
   end

data/test/support/temporary_files.rb

@@ -22,7 +22,7 @@ module TemporaryFiles
   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 }
+    Dir.chdir(project_root) { yield project_root }
   ensure
     remove_temp_directory
   end

data/test/support/test_configuration.rb

@@ -2,10 +2,8 @@ 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
+    Nesta::Config.instance.stub(:config, config) do
+      yield
     end
   end
 

data/test/unit/config_test.rb

@@ -3,11 +3,17 @@ require 'test_helper'
 describe Nesta::Config do
   include TestConfiguration
 
-  after do
-    ENV.keys.each { |variable| ENV.delete(variable) if variable =~ /NESTA_/ }
+  it 'cannot be instantiated directly' do
+    assert_raises(NoMethodError) { Nesta::Config.new }
   end
 
-  it 'returns default value for "Read more"' do
+  it 'exposes settings at the class level' do
+    Nesta::Config::SETTINGS.each do |setting|
+      assert Nesta::Config.respond_to?(setting), "should respond to '#{setting}'"
+    end
+  end
+
+  it 'defines default value for "Read more"' do
     assert_equal 'Continue reading', Nesta::Config.read_more
   end
 
@@ -15,100 +21,34 @@ describe Nesta::Config 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
+  it 'reads configuration from YAML' do
+    title = 'Site Title'
+    stub_config('subtitle' => title) do
+      assert_equal title, Nesta::Config.subtitle
     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
+  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
 
-  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
+  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
 
   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')
@@ -125,14 +65,5 @@ describe Nesta::Config do
     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/static/assets_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+require_relative '../../../lib/nesta/static/assets'
+
+describe 'Assets' do
+  include TestConfiguration
+
+  after do
+    remove_temp_directory
+  end
+
+  it 'is happy if attachments directory not present' do
+    in_temporary_project do |project_root|
+      stub_config('content' => File.join(project_root, 'content')) do
+        Nesta::Static::Assets.new('dist').copy_attachments
+      end
+    end
+  end
+
+  it 'copies attachments into build directory' do
+    build_dir = 'dist'
+    attachment = 'image.jpeg'
+
+    in_temporary_project do |project_root|
+      stub_config('content' => File.join(project_root, 'content')) do
+        FileUtils.mkdir_p(Nesta::Config.attachment_path)
+        open(File.join(Nesta::Config.attachment_path, attachment), 'w')
+
+        Nesta::Static::Assets.new(build_dir).copy_attachments
+
+        assert_exists_in_project File.join(build_dir, 'attachments', attachment)
+      end
+    end
+  end
+
+  it 'is happy if public directory not present' do
+    in_temporary_project do |project_root|
+      Nesta::Static::Assets.new('dist').copy_public_folder
+    end
+  end
+
+  it 'copies contents of public directory into build directory' do
+    build_dir = 'dist'
+    asset_path = File.join('css', 'third-party.css')
+
+    in_temporary_project do |project_root|
+      public_path = File.join(project_root, 'public')
+      FileUtils.mkdir_p(File.dirname(File.join(public_path, asset_path)))
+      open(File.join(public_path, asset_path), 'w')
+
+      Nesta::Static::Assets.new(build_dir).copy_public_folder
+
+      assert_exists_in_project File.join(build_dir, asset_path)
+    end
+  end
+end

data/test/unit/static/html_file_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+require_relative '../../../lib/nesta/static/html_file'
+
+describe 'HtmlFile' do
+  include ModelFactory
+  include TestConfiguration
+
+  after do
+    remove_temp_directory
+  end
+
+  it 'determines HTML filename from build dir and page filename' do
+    build_dir = "dist"
+
+    with_temp_content_directory do
+      page = create(:page)
+
+      html_file = Nesta::Static::HtmlFile.new(build_dir, page)
+
+      expected = File.join(build_dir, "page-1.html")
+      assert_equal expected, html_file.filename
+    end
+  end
+
+  it 'creates index.html in directory if page shares path with directory' do
+    build_dir = "dist"
+
+    with_temp_content_directory do
+      page = create(:page)
+      ext = File.extname(page.filename)
+      directory_path = page.filename.sub(/#{ext}$/, '')
+      FileUtils.mkdir(directory_path)
+
+      html_file = Nesta::Static::HtmlFile.new(build_dir, page)
+
+      expected = File.join(build_dir, "page-1", "index.html")
+      assert_equal expected, html_file.filename
+    end
+  end
+end

data/test/unit/static/site_test.rb

@@ -0,0 +1,104 @@
+require 'test_helper'
+
+require_relative '../../../lib/nesta/static/site'
+
+describe 'Site' do
+  include ModelFactory
+  include TestConfiguration
+
+  after do
+    remove_temp_directory
+  end
+
+  it 'converts Markdown to HTML' do
+    build_dir = 'dist'
+    domain = 'localhost'
+
+    in_temporary_project do
+      with_temp_content_directory do
+        page = create(:page)
+
+        Nesta::Static::Site.new(build_dir, domain).render_pages
+
+        html_file = File.join(build_dir, page.abspath + '.html')
+        markup = open(html_file).read
+
+        assert markup.include?("<title>#{page.title}</title>")
+      end
+    end
+  end
+
+  it 'renders a 404 not found page' do
+    build_dir = 'dist'
+    domain = 'localhost'
+
+    in_temporary_project do
+      with_temp_content_directory do
+        Nesta::Static::Site.new(build_dir, domain).render_not_found
+
+        html_file = File.join(build_dir, '404.html')
+        markup = open(html_file).read
+
+        assert markup.include?("<h1>Page not found</h1>")
+      end
+    end
+  end
+
+  it 'renders Atom feed' do
+    build_dir = 'dist'
+    domain = 'mysite.com'
+
+    in_temporary_project do
+      with_temp_content_directory do
+        article = create(:article)
+        Nesta::Static::Site.new(build_dir, domain).render_atom_feed
+
+        xml_file = File.join(build_dir, 'articles.xml')
+        xml = open(xml_file).read
+
+        assert xml.include?("<link href='https://#{domain + article.abspath}'")
+      end
+    end
+  end
+
+  it 'includes domain name in sitemap' do
+    build_dir = 'dist'
+    domain = 'mysite.com'
+
+    in_temporary_project do
+      with_temp_content_directory do
+        page = create(:page)
+        Nesta::Static::Site.new(build_dir, domain).render_sitemap
+
+        xml_file = File.join(build_dir, 'sitemap.xml')
+        xml = open(xml_file).read
+
+        assert xml.include?(domain + page.abspath)
+      end
+    end
+  end
+
+  it "renders the user's list of templated assets" do
+    build_dir = 'dist'
+    css_path = '/css/styles.css'
+    build_config = {}
+
+    in_temporary_project do
+      stub_config('build' => { 'templated_assets' => [css_path] }) do
+        views = File.join(project_root, 'views')
+        FileUtils.mkdir_p(views)
+        open(File.join(views, 'styles.sass'), 'w') do |sass|
+          sass.write("p\n  font-size: 1em\n")
+        end
+
+        site = Nesta::Static::Site.new(build_dir, 'mysite.com')
+        site.render_templated_assets
+
+        css_file = File.join(build_dir, css_path)
+        assert_exists_in_project(css_file)
+
+        assert_equal open(css_file).read, "p {\n  font-size: 1em;\n}"
+      end
+    end
+  end
+end