staticpress 0.6.2 → 0.7.0

data/lib/staticpress/theme.rb

@@ -1,18 +1,51 @@
+require 'hike'
+
 module Staticpress
   class Theme
     extend Staticpress::Helpers
     include Staticpress::Helpers
 
-    attr_reader :root
+    attr_reader :name, :root, :trail
 
     def initialize(name)
-      @name = name
+      @name = name.to_sym
       custom = Staticpress.blog_path + 'themes' + @name.to_s
       @root = custom.directory? ? custom : Staticpress.root + 'themes' + @name.to_s
+
+      @trail = Hike::Trail.new
+      @trail.append_paths custom, Staticpress.root + 'themes' + @name.to_s
+      @trail.append_extensions *Tilt.mappings.keys
     end
 
     def ==(other)
-      other.respond_to?(:root) ? (root == other.root) : super
+      other.respond_to?(:name) ? (name == other.name) : super
+    end
+
+    def assets
+      reply = spider_map (root + 'assets').children do |file|
+        file
+      end.flatten
+      parent ? (parent.assets + reply) : reply
+    end
+
+    def copy_to(name)
+      destination = Staticpress.blog_path + 'themes' + name.to_s
+
+      if destination.directory?
+        raise Staticpress::Error, "Cannot copy theme. Destination (#{destination}) already exists."
+      else
+        FileUtils.mkdir_p destination
+        FileUtils.cp_r root.children, destination
+      end
+    end
+
+    def parent
+      @parent ||= lambda do
+        if config.theme_parent
+          reply = self.class.new(config.theme_parent)
+          @parent = reply unless self == reply
+        end
+      end.call
     end
 
     [
@@ -20,20 +53,15 @@ module Staticpress
       :layout,
       :view
     ].each do |method_name|
-      define_method "default_#{method_name}" do
-        send("keyed_#{method_name}s")['default']
-      end unless method_name == :include
-
-      define_method "keyed_#{method_name}s" do
-        hash_from_array(send("#{method_name}s")) { |name| extensionless_basename name }
-      end
-
-      define_method "#{method_name}_for" do |name|
-        send("keyed_#{method_name}s")[name.to_s]
-      end
-
-      define_method "#{method_name}s" do
-        (root + "#{method_name}s").children
+      define_method "#{method_name}_for" do |*names|
+        names_with_default = (method_name == :include) ? names : names + [:default]
+        catch :path do
+          names_with_default.each do |name|
+            path = trail.find "#{method_name}s/#{name}"
+            throw :path, Pathname(path) if path
+          end
+          nil
+        end
       end
     end
 

data/lib/staticpress/version.rb

@@ -2,7 +2,7 @@ module Staticpress
   class Version
     extend Comparable
 
-    SIGNATURE = [0, 6, 2]
+    SIGNATURE = [0, 7, 0]
 
     def self.<=>(other)
       other = other.split('.').map(&:to_i) if other.respond_to? :split

data/lib/themes/basic/includes/github.haml

@@ -0,0 +1,2 @@
+%a.github-ribbon{ :href => 'https://github.com/ravinggenius/staticpress', :style => 'position: absolute; top: 0; right: 0;' }
+  %img{ :src => 'https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png', :alt => 'Fork me on GitHub' }/

data/lib/themes/basic/layouts/default.haml

@@ -13,3 +13,4 @@
     %nav= root_menu
     %section= yield
     %section
+    = partial :github

data/lib/themes/basic/views/page_paged.haml

@@ -0,0 +1,6 @@
+- page.sub_content.each do |post|
+  %article.post
+    %header
+      %div.h
+        %a{ :href => post.url_path }= post.title
+    %section= post.render_partial

data/spec/integration/editing_blog_contents_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe 'Editing blog contents', :blur do
+  create_sample_blog
+
+  before :each do
+    run_simple 'staticpress create_page about'
+    run_simple 'staticpress create hello-goodbye'
+  end
+
+  it 'Creating a static page with multiple formats' do
+    add_multi_format_page
+    build_site
+    confirm_formats_page_contains_markup
+  end
+
+  it 'Listing all routes' do
+    list_urls
+    confirm_static_pages_present
+  end
+
+  it 'Building a site' do
+    build_site
+    confirm_output_directory_contains_expected_files
+  end
+
+  it 'Building a site (verbose)' do
+    build_site_verbosely
+    confirm_filenames_output
+  end
+
+  it 'Building a site with a custom home page' do
+    create_custom_home_page
+    build_site
+    confirm_built_home_page
+  end
+
+  it 'Pushing a compiled site to a remote location' do
+    build_site
+    add_custom_deploy_strategy
+    push_site
+    confirm_site_deployed
+  end
+
+  it 'Deploying site (build and push in one step)' do
+    add_custom_deploy_strategy
+    confirm_site_not_built_or_deployed
+    deploy_site
+    confirm_output_directory_contains_expected_files
+    confirm_site_deployed
+  end
+end

data/spec/integration/editing_blog_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Editing blog' do
+  create_sample_blog
+
+  it 'Creating a new blog post' do
+    create_post
+    edit_post
+  end
+
+  it 'Creating a static page' do
+    create_page
+    edit_page
+  end
+
+  context 'without any custom plugins' do
+    before :each do
+      run_simple 'rm -fR plugins'
+    end
+
+    it 'Copying a built-in plugin' do
+      fork_plugin
+      confirm_plugin_editable 'blockquote'
+    end
+
+    it 'Copying and renaming a built-in plugin' do
+      fork_plugin 'pullquote'
+      confirm_plugin_editable 'pullquote'
+    end
+  end
+
+  context 'without a custom theme' do
+    before :each do
+      run_simple 'rm -fR themes'
+    end
+
+    it 'Copying the default theme' do
+      fork_theme
+      confirm_theme_is_local 'basic'
+    end
+  end
+end

data/spec/integration/getting_started_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'Getting started' do
+  it 'Getting help' do
+    ask_for_help
+    see_helpful_tips
+  end
+
+  it 'Finding the version' do
+    check_the_version
+    see_the_version
+  end
+
+  context 'generic blog' do
+    create_sample_blog
+
+    it 'Creating a new blog' do
+      confirm_minimal_files
+    end
+  end
+
+  context do
+    create_sample_blog 'This is my blog'
+
+    it 'Creating a new blog with a custum title' do
+      confirm_settings_saved
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'compass'
+require 'aruba/api'
+require 'fileutils'
+require 'haml'
+require 'pathname'
+require 'pry'
+require 'redcarpet'
+require 'sass'
+
+require_relative '../lib/staticpress'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |path| require_relative path }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :blur => true
+
+  # config.expect_with :rspec do |c|
+  #   c.syntax = :expect
+  # end
+
+  # 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'
+
+  config.include Aruba::Api
+  config.include CustomMatchers
+  config.include UnitSupport
+  config.include IntegrationSupport
+  config.extend Fixtures
+end

data/spec/support/custom_matchers.rb

@@ -0,0 +1,15 @@
+module CustomMatchers
+  def assert_eql(expected, actual, message = nil)
+    assert actual.eql?(expected), (message || "Expected #{actual} to have same content as #{expected}")
+  end
+
+  def refute_raises(exception, &block)
+    begin
+      block.call
+      assert true
+    rescue Exception => e
+      refute e.is_an?(exception), exception_details(e, "Expected #{e} not to be raised")
+      raise e
+    end
+  end
+end

data/spec/support/fixtures.rb

@@ -0,0 +1,35 @@
+module Fixtures
+  FIXTURES_PATH = (Staticpress.root + '..' + 'spec' + 'fixtures').expand_path
+  TEMP_PATH = (Staticpress.root + '..' + 'tmp').expand_path
+
+  def basic_blog
+    setup_blog 'test_blog'
+  end
+
+  def setup_blog(name)
+    source_path = FIXTURES_PATH + name
+    temp_path = TEMP_PATH + name
+
+    before :each do
+      FileUtils.rm_rf temp_path if temp_path.directory?
+      FileUtils.cp_r source_path, temp_path
+
+      Staticpress.blog_path = temp_path.clone
+    end
+
+    after :each do
+      Staticpress.blog_path = '.'
+    end
+  end
+
+  def create_sample_blog(title = 'Transient Thoughts')
+    before :each do
+      blog_title = title ? "'#{title}'" : nil
+      run_simple "staticpress new temporary_blog #{blog_title}"
+      cd('temporary_blog')
+      append_to_file 'Gemfile', <<-RUBY
+gem 'staticpress', :path => '../../..'
+      RUBY
+    end
+  end
+end

data/spec/support/integration_support.rb

@@ -0,0 +1,230 @@
+module IntegrationSupport
+  def run_one_of(*commands)
+    run_simple commands.shuffle.first
+  end
+
+  def verify_directory_contains_file(directory, file)
+    check_directory_presence [directory], true
+    check_file_presence ["#{directory}/#{file}"], true
+  end
+
+  def samples_path
+    Pathname("#{__FILE__}/../fixtures").expand_path
+  end
+
+  def ask_for_help
+    commands = [
+      'staticpress',
+      'staticpress help',
+      'staticpress -h',
+      'staticpress --help'
+    ]
+    run_one_of *commands
+  end
+
+  def check_the_version
+    commands = [
+      'staticpress version',
+      'staticpress -v',
+      'staticpress --version'
+    ]
+    run_one_of *commands
+  end
+
+  def see_helpful_tips
+    assert_exit_status 0
+    assert_partial_output 'Usage', all_output
+  end
+
+  def see_the_version
+    assert_exit_status 0
+    assert_partial_output 'Staticpress', all_output
+  end
+
+  def confirm_minimal_files
+    files = [
+      'config.ru',
+      'config.yml',
+      'Gemfile',
+      'README.markdown'
+    ]
+    check_file_presence files, true
+  end
+
+  def confirm_settings_saved
+    check_file_content 'config.yml', <<-YAML, true
+---
+:title: This is my blog
+    YAML
+  end
+
+  def create_post
+    run_simple 'staticpress create \'Hello World\''
+  end
+
+  def create_page
+    run_simple 'staticpress create_page about'
+  end
+
+  def fork_plugin(new_name = nil)
+    run_simple "staticpress fork_plugin blockquote #{new_name}"
+  end
+
+  def fork_theme
+    run_simple 'staticpress fork_theme'
+  end
+
+  def edit_post
+    now = Time.now.utc
+    filename = [
+      now.year,
+      ('%02d' % now.month),
+      ('%02d' % now.day),
+      'hello-world.markdown'
+    ].join('-')
+    verify_directory_contains_file 'content/_posts', filename
+  end
+
+  def edit_page
+    verify_directory_contains_file 'content', 'about.markdown'
+  end
+
+  def confirm_plugin_editable(name)
+    verify_directory_contains_file 'plugins', "#{name}.rb"
+  end
+
+  def confirm_theme_is_local(name)
+    check_directory_presence ["themes/#{name}"], true
+  end
+
+  def confirm_site_not_built_or_deployed
+    files = [
+      'public/index.html',
+      'public/about/index.html',
+      '../deployed/index.html',
+      '../deployed/about/index.html'
+    ]
+    check_file_presence files, false
+  end
+
+  def add_multi_format_page
+    write_file 'content/formats.markdown.erb', 'hello world'
+  end
+
+  def build_site
+    run_simple 'staticpress build'
+  end
+
+  def deploy_site
+    run_simple 'staticpress deploy'
+  end
+
+  def push_site
+    run_simple 'staticpress build'
+  end
+
+  def list_urls
+    run_simple 'staticpress list url_path'
+  end
+
+  def build_site_verbosely
+    run_simple 'staticpress build --verbose'
+  end
+
+  def create_custom_home_page
+    write_file 'content/index.markdown', <<-MARKDOWN
+---
+title: Custom Home Page
+---
+
+in custom page
+    MARKDOWN
+  end
+
+  def add_custom_deploy_strategy
+    append_to_file 'config.yml', <<-YAML
+:deployment_strategies:
+  :custom: 'cp -R public ../deployed'
+    YAML
+  end
+
+  def confirm_formats_page_contains_markup
+    check_exact_file_content 'public/formats/index.html', <<-HTML
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8' />
+    <title>Formats | Transient Thoughts</title>
+    <link href='/assets/basic/styles/all.css' rel='stylesheet' type='text/css' />
+    <script src='http://ajax.googleapis.com/ajax/libs/jquery/1.7.0/jquery.min.js'></script>
+    <script src='/assets/basic/scripts/application.js'></script>
+  </head>
+  <body>
+    <header>
+      <div class='site-title'>Transient Thoughts</div>
+      <div class='site-subtitle'>A blogging framework for hackers</div>
+    </header>
+    <nav></nav>
+    <section><p>hello world</p></section>
+    <section></section>
+    <a class='github-ribbon' href='https://github.com/ravinggenius/staticpress' style='position: absolute; top: 0; right: 0;'>
+  <img alt='Fork me on GitHub' src='https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' />
+</a>
+  </body>
+</html>
+    HTML
+  end
+
+  def confirm_static_pages_present
+    assert_partial_output '/', all_output
+    assert_partial_output '/about', all_output
+    assert_partial_output '/hello-goodbye', all_output
+  end
+
+  def confirm_output_directory_contains_expected_files
+    files = [
+      'public/index.html',
+      'public/about/index.html'
+    ]
+    check_file_presence files, true
+  end
+
+  def confirm_filenames_output
+    assert_partial_output "    page public/about/index.html", all_output
+  end
+
+  def confirm_built_home_page
+    check_exact_file_content 'public/index.html', <<-HTML
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8' />
+    <title>Custom Home Page | Transient Thoughts</title>
+    <link href='/assets/basic/styles/all.css' rel='stylesheet' type='text/css' />
+    <script src='http://ajax.googleapis.com/ajax/libs/jquery/1.7.0/jquery.min.js'></script>
+    <script src='/assets/basic/scripts/application.js'></script>
+  </head>
+  <body>
+    <header>
+      <div class='site-title'>Transient Thoughts</div>
+      <div class='site-subtitle'>A blogging framework for hackers</div>
+    </header>
+    <nav></nav>
+    <section><p>in custom page</p></section>
+    <section></section>
+    <a class='github-ribbon' href='https://github.com/ravinggenius/staticpress' style='position: absolute; top: 0; right: 0;'>
+  <img alt='Fork me on GitHub' src='https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' />
+</a>
+  </body>
+</html>
+    HTML
+  end
+
+  def confirm_site_deployed
+    files = [
+      '../deployed/index.html',
+      '../deployed/about/index.html'
+    ]
+    check_file_presence files, true
+  end
+end