awestruct 0.4.8 → 0.5.0.cr

data/spec/asciidoc_handler_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'rspec/matchers.rb'
+
+verify = lambda { |output|
+  output.gsub(/(^\s*\n|^\s*)/, '').should =~ %r(<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>This is <strong>AsciiDoc</strong> in Awestruct.</p>
+</div>
+</div>
+</div>)
+}
+
+verify_front_matter = lambda { |output, page|
+  page.title.should == 'AwestructAsciiDoc'
+  output.should_not =~ %r(title: AwestructAsciiDoc)
+}
+
+verify_headers = lambda { |output, page|
+  extend RSpec::Matchers
+  page.author.should == 'Stuart Rackham'
+  page.title.should == 'AsciiDoc'
+  page.doctitle.should == 'AsciiDoc'
+  page.name.should == 'Awestruct'
+  page.tags.should be_a_kind_of(Array)
+  page.tags.should == %w(a b c)
+  page.date.should be_a_kind_of(Date)
+  output.should =~ %r(This is <strong>AsciiDoc</strong> in Awestruct.)
+  output.should =~ %r(#{Awestruct::VERSION})
+}
+
+theories =
+  [
+    {
+      :page => "asciidoc-page.ad",
+      :simple_name => "asciidoc-page",
+      :syntax => :asciidoc,
+      :extension => '.html',
+      :matcher => verify
+    },
+    {
+      :page => "asciidoc-page.adoc",
+      :simple_name => "asciidoc-page",
+      :syntax => :asciidoc,
+      :extension => '.html',
+      :matcher => verify
+    },
+    {
+      :page => "asciidoc-page.asciidoc",
+      :simple_name => "asciidoc-page",
+      :syntax => :asciidoc,
+      :extension => '.html',
+      :matcher => verify
+    },
+    {
+      :page => "asciidoctor_with_front_matter.ad",
+      :simple_name => "asciidoctor_with_front_matter",
+      :syntax => :asciidoc,
+      :extension => '.html' ,
+      :matcher => verify_front_matter
+    },
+    {
+      :page => "asciidoctor_with_headers.ad",
+      :simple_name => "asciidoctor_with_headers",
+      :syntax => :asciidoc,
+      :extension => '.html',
+      :matcher => verify_headers
+    }
+  ]
+
+describe Awestruct::Handlers::AsciidoctorHandler do
+  let(:additional_config_page) { {:name => 'Awestruct', :test => 10} }
+  it_should_behave_like "a handler", theories
+
+end

data/spec/astruct_spec.rb

@@ -0,0 +1,52 @@
+
+require 'awestruct/astruct'
+require 'awestruct/page'
+
+describe Awestruct::AStruct do 
+
+  it "should initialize from hash provided in constructor" do
+    s = Awestruct::AStruct.new( :foo=>'bar', 'taco'=>'tasty' )
+    s[:foo].should == 'bar'
+    s['taco'].should == 'tasty'
+  end
+
+  it "should allow access to members through indifferent hash access" do
+    s = Awestruct::AStruct.new( :foo=>'bar', 'taco'=>'tasty' )
+    s['foo'].should == 'bar'
+    s[:foo].should == 'bar'
+
+    s['taco'].should == 'tasty'
+    s[:taco].should == 'tasty'
+  end
+
+  it "should allow method access to members" do
+    s = Awestruct::AStruct.new( :foo=>'bar', 'taco'=>'tasty' )
+    s.foo.should == 'bar'
+    s.taco.should == 'tasty'
+  end
+
+  it "should cascade AStructs to inner array members" do 
+    s = Awestruct::AStruct.new( :foo=>[ { 'taco'=>'tasty' } ] )
+    s.foo.first.taco.should == 'tasty'
+  end
+
+  it "should preserve the actual array instance holding any inner structs" do
+    inner_hash = { 'taco'=>'tasty' }
+    array = [ inner_hash ]
+    s = Awestruct::AStruct.new( :foo=>array )
+    s.foo.first.taco.should == 'tasty'
+    s.foo.object_id.should == array.object_id
+  end
+
+  it "should cascade AStruct to inner hash value structs" do
+    s = Awestruct::AStruct.new( :foo=>{ 'taco'=>'tasty' } ) 
+    s.foo.taco.should == 'tasty'
+  end
+
+  it "should allow any method to be called, resulting in nil" do
+    s = Awestruct::AStruct.new( :foo=>'bar' )
+    s.foo.should == 'bar'
+    s.taco.should be_nil
+  end
+
+end

data/spec/coffeescript_handler_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+verify = lambda { |output|
+  output.should =~ /function\(\)/
+  output.should =~ /call\(this\)/
+}
+
+theories =
+  [
+    {
+      :page => "coffeescript-page.coffee",
+      :simple_name => "coffeescript-page",
+      :syntax => :coffeescript,
+      :extension => '.js',
+      :matcher => verify
+    }
+  ]
+
+describe Awestruct::Handlers::TiltHandler.to_s + "-CoffeeScript" do
+  
+  it_should_behave_like "a handler", theories
+
+end

data/spec/config_spec.rb

@@ -0,0 +1,22 @@
+require 'awestruct/config'
+require 'spec_helper'
+require 'awestruct/config'
+
+describe Awestruct::Config do
+
+  it "should accept a list of files in .awestruct_ignore to ignore on site generation" do
+    site_dir = File.join(File.dirname(__FILE__), 'test-data')
+    config = Awestruct::Config.new(site_dir)
+    config.ignore.should == ["Rakefile", "Gemfile"]
+  end
+
+  it "should handle an empty .awestruct_ignore file without barfing" do
+    site_dir = File.join(File.dirname(__FILE__), 'test-data')
+    config_file = File.join(site_dir, ".awestruct_ignore")
+    File.open(config_file, "w")
+    config = Awestruct::Config.new(site_dir)
+    config.ignore.should == []
+    File.open(config_file, "w") { |f| f.write("Rakefile\nGemfile\n") }
+  end
+
+end

data/spec/context_helper_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+require 'awestruct/context_helper'
+
+class Tester
+  include Awestruct::ContextHelper
+end
+
+describe Awestruct::ContextHelper do
+  before :each do
+    @tester = Tester.new
+  end
+
+  describe "html_to_text" do
+
+    it "should strip HTML tags" do
+      str = "<h1>A Title</h1>"
+      @tester.html_to_text(str).should == "A Title"
+    end
+
+    it "should replace &nbsp; with a space" do
+      str = "foo&nbsp;bar"
+      @tester.html_to_text(str).should == "foo bar"
+    end
+  end
+
+  describe "clean_html" do
+    # this is an odd, less useful version of html_to_text
+    it "should replace &nbsp; with a space" do
+      str = "foo&nbsp;bar"
+      @tester.clean_html(str).should == "foo bar"
+    end
+  end
+
+  describe "without_images" do
+    it "should remove image tags, but not other tags" do
+      str = "<h1>Hello!</h1><img src='images/foo'/>"
+      @tester.without_images(str).should == "<h1>Hello!</h1>"
+    end
+
+    it "should remove surrounding anchor tags if they exist" do
+      str = "<h1>Hello!</h1><a href='foobar'><img src='images/foo'/></a>"
+      @tester.without_images(str).should == "<h1>Hello!</h1>"
+    end
+
+    it "should not remove anchor tags around text" do
+      str = "<h1>Hello!</h1><a href='foobar'>foobar</a>"
+      @tester.without_images(str).should == "<h1>Hello!</h1>foobar"
+    end
+  end
+
+  describe "close_tags" 
+
+  describe "summarize" do
+
+    before :all do
+      @long_string = "Once upon a time there was a horse who loved apples. He loved them so much that he ate one every day."
+    end
+
+    it "should shorten a string to 20 words by default" do
+      @tester.summarize(@long_string).split(/ /).size.should == 20
+    end
+
+    it "should append the shortened string with an ellipses" do
+      @tester.summarize(@long_string)[-3..-1].should == "..."
+    end
+
+    it "should allow customization of the number of words" do
+      @tester.summarize(@long_string, 10).split(/ /).size.should == 10
+    end
+
+    it "should allow customization of the appended ellipses" do
+      @tester.summarize(@long_string, 5, "---")[-3..-1].should == "---"
+    end
+  end
+
+  describe "fully_qualify_urls" do
+    it "should fix anchor tags" do
+      str = "<a href='/foo'>foobar</a>"
+      @tester.fully_qualify_urls('http://foobar.com', str).should == "<a href=\"http://foobar.com/foo\">foobar</a>"
+    end
+
+    it "should fix link tags" do
+      str = "<link href='/foo' />"
+      #nokogiri html doesn't close optional ending tags
+      @tester.fully_qualify_urls('http://foobar.com', str).should == "<link href=\"http://foobar.com/foo\">"
+    end
+
+    it "should fix image tags" do
+      str = "<img src='/foo' />"
+      #nokogiri html doesn't close optional ending tags
+      @tester.fully_qualify_urls('http://foobar.com', str).should == "<img src=\"http://foobar.com/foo\">"
+    end
+
+    it "should leave anchor tags with no href attribute (for page anchors) unchanged" do
+      str = "<a target=\"#foo\">foobar</a>"
+      @tester.fully_qualify_urls('http://foobar.com', str).should == str
+    end
+  end
+
+  describe "fix_url" do # This method is simple minded and dresses funny
+
+    it "should return a fully qualified url unchanged" do
+      str = "http://foobar.com/foo/bar"
+      @tester.fix_url("http://foobar.com", str).should == str
+    end
+
+    it "should prepend the schema and hostname if required" do
+      str = "http://foobar.com/foo/bar"
+      @tester.fix_url("http://foobar.com", "/foo/bar").should == str
+    end
+
+  end
+
+end
+

data/spec/deploy_spec.rb

@@ -0,0 +1,41 @@
+
+require 'awestruct/cli/deploy'
+
+describe Awestruct::CLI::Deploy do
+
+  it "should use a given deploy[:type]" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'type' => :foo})
+    deployer.deploy_type.should == :foo
+  end
+
+  it "should use rsync if no deploy[:type] is given" do
+    deployer = Awestruct::CLI::Deploy.new({}, {})
+    deployer.deploy_type.should == :rsync
+  end
+
+  it "should use github_pages if deploy['host'] is github_pages and no deploy[:type] is given" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'host' => :github_pages})
+    deployer.deploy_type.should == :github_pages
+  end
+
+  it "should use a given deploy['type'] even if deploy['host'] is github_pages" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'type' => :foo, 'host'=>:github_pages})
+    deployer.deploy_type.should == :foo
+  end
+
+  it "should use s3 if deploy['type'] is s3" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'type' => :s3})
+    deployer.deploy_type.should == :s3
+  end
+
+  it "should work with strings for keys" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'host' => :github_pages})
+    deployer.deploy_type.should == :github_pages
+  end
+
+  it "should work with strings for values" do
+    deployer = Awestruct::CLI::Deploy.new({}, {'host' => 'github_pages'})
+    deployer.deploy_type.should == :github_pages
+  end
+
+end

data/spec/disqus_spec.rb

@@ -0,0 +1,43 @@
+require 'awestruct/page'
+require 'awestruct/extensions/disqus'
+
+describe Awestruct::Extensions::Disqus do
+
+  before :all do
+    @site = Awestruct::AStruct.new :encoding=>false, :disqus=>'spec', :base_url=>'http://example.org'
+    @disqus = Awestruct::Extensions::Disqus.new 
+  end
+
+  before :each do
+    @page = Awestruct::Page.new @site
+    @page.date = Time.utc(2012,12,8)
+    @page.slug = 'spec-post'
+    @page.url = '/posts/2012/12/08/spec-post/'
+    @site.disqus_generate_id = true
+    @site.pages = [@page]
+    @disqus.execute(@site)
+  end
+
+  it "should assign the disqus short name" do
+    @page.disqus_comments().should match(/var disqus_shortname = '#{@site.disqus}';/) 
+    @page.disqus_comments_count().should match(/var disqus_shortname = '#{@site.disqus}';/) 
+  end
+
+  it "should generate an identifier if necessary when id generation is enabled" do
+    @page.disqus_comments().should match(/var disqus_identifier = "12bb52d0776930e01e9a410fd14f13382778e449";/)
+    @page.disqus_comments_link().should match(/ data-disqus-identifier="12bb52d0776930e01e9a410fd14f13382778e449"/)
+  end
+
+  it "should use the identifier specified in the page" do
+    @page.disqus_identifier = @page.slug
+    @page.disqus_comments().should match(/var disqus_identifier = "#{@page.disqus_identifier}";/)
+    @page.disqus_comments_link().should match(/ data-disqus-identifier="#{@page.disqus_identifier}"/)
+  end
+
+  it "should have a null identifier if no identifier is specified and id generation is disabled" do
+    @site.disqus_generate_id = false
+    @page.disqus_comments().should match(/var disqus_identifier = null;/)
+    @page.disqus_comments_link().should_not match(/ data-disqus-identifier=/)
+  end
+
+end

data/spec/engine_spec.rb

@@ -0,0 +1,115 @@
+
+require 'awestruct/engine'
+
+require 'hashery/open_cascade'
+
+describe Awestruct::Engine do
+
+  it "should be able to load default-site.yml" do
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_default_site_yaml
+
+    engine.site.asciidoctor.backend.should == 'html5'
+  end
+
+  it "should be able to override default with site" do
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_default_site_yaml
+    engine.load_site_yaml( 'development' )
+
+    engine.site.asciidoctor.attributes['backend'].should == 'html4'
+  end
+
+  it "should be able to load site.yml with the correct profile" do
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'development' )
+    engine.site.cook.should == 'microwave'
+    engine.site.title.should == 'Awestruction!'
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'production' )
+    engine.site.cook.should == 'oven'
+    engine.site.title.should == 'Awestruction!'
+  end
+
+  it "should be able to load arbitrary _config/*.yml files" do
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_yaml( File.join( config.dir,  '_config/arbitrary.yml' ) )
+    engine.site.arbitrary.name.should == 'randomness'
+  end
+
+  it "should be able to load all arbitary yamls" do
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+
+    engine = Awestruct::Engine.new(config)
+    engine.load_yamls
+
+    engine.site.arbitrary.name.should == 'randomness'
+    engine.site.other.tags.should == [ 'a', 'b', 'c' ]
+  end
+
+  it "should exclude line comments in compass by default in production mode" do
+    compass = compass_config
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'production' )
+    Compass.stub(:configuration).and_return(compass)
+    compass.should_receive(:line_comments=).with(false)
+    compass.should_receive(:output_style=).with(:compressed)
+    engine.configure_compass
+  end
+
+  it "should exclude minify in compass by default in production mode" do
+    compass = compass_config
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'production' )
+    Compass.stub(:configuration).and_return(compass)
+    compass.should_receive(:line_comments=).with(false)
+    compass.should_receive(:output_style=).with(:compressed)
+    engine.configure_compass
+  end
+
+  it "should include line comments in compass by default in development mode" do
+    compass = compass_config
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'development' )
+    Compass.stub(:configuration).and_return(compass)
+    compass.should_receive(:line_comments=).with(true)
+    compass.should_receive(:output_style=).with(:expanded)
+    engine.configure_compass
+  end
+
+  it "should accept site.compass_line_comments to configure behavior" do
+    compass = compass_config
+    config = Awestruct::Config.new( File.dirname(__FILE__) + '/test-data/engine' )
+    engine = Awestruct::Engine.new(config)
+    engine.load_site_yaml( 'staging' )
+    Compass.stub(:configuration).and_return(compass)
+    compass.should_receive(:line_comments=).with(false)
+    compass.should_receive(:output_style=).with(:expanded)
+    engine.configure_compass
+  end
+
+end
+
+def compass_config
+  config = mock
+  config.stub(:project_type=)
+  config.stub(:project_path=)
+  config.stub(:sass_dir=)
+  config.stub(:css_dir=)
+  config.stub(:javascripts_dir=)
+  config.stub(:images_dir=)
+  config.stub(:fonts_dir=)
+  config
+end