contraption 0.2.0

data/spec/contraption/lib/header_spec.rb

@@ -0,0 +1,198 @@
+require_relative '../../spec_helper.rb'
+
+require 'date'
+
+module Contraption
+  describe Header do
+    before(:each) do
+      @title = "The Title"
+      @date = DateTime.now
+      @type = :a_type
+      @tags = []
+      @summary = "some witty line to get people to read the post"
+      @h = Header.new title: @title, publication_date: @date, type: @type, tags: @tags, summary: @summary
+    end
+
+    context "initialization" do
+
+      it "returns the initial title" do
+        @h.title.should eq(@title)
+      end
+
+      it "returns the initial date" do
+        @h.publication_date.should eq(@date)
+      end
+
+      it "returns the initial type" do
+        @h.type.should eq(@type)
+      end
+
+      it "returns the initial tags" do
+        @h.tags.should eq(@tags)
+      end
+
+      it "returns the summary" do
+        @h.summary.should eq(@summary)
+      end
+    end
+
+    context ".new?" do
+      it "knows when it is new" do
+        h = Header.from "published: now"
+        h.new?.should be_true
+      end
+
+      it "knows when it is not new" do
+        h = Header.from "published: #{@date}"
+        h.new?.should be_false
+      end
+    end
+
+    context "#filename" do
+      it "stores the filename if specified in the initializer" do
+        h = Header.new ({filename: "a-filename.md"})
+        h.filename.should eq "a-filename.md"
+      end
+
+      it "returns a filename computed from the title if no filename given" do
+        h = Header.new ({title: "A Filename"})
+        h.filename.should eq "a-filename.md"
+      end
+
+      it "removes non-alphanumeric characters" do
+        h = Header.new ({title: "Call Me ... Maybe?!"})
+        h.filename.should eq "call-me-maybe.md"
+      end
+
+      it "does not remove '-'" do
+        h = Header.new ({title: "Hyphenated-title"})
+        h.filename.should eq "hyphenated-title.md"
+      end
+
+      it "has only one extension" do
+        h = Header.new ({filename: "a-filename.md"})
+        h.filename.split('.').length.should eq 2
+      end
+
+      it "has an extension when not specified" do
+        h = Header.new ({filename: "a-filename"})
+        h.filename.split('.').length.should eq 2
+      end
+    end
+
+    context "#update" do
+      it "returns a new object" do
+        update_h = @h.update
+        update_h.should_not eq @h
+      end
+
+      it "does not modify the original header" do
+        initial_h = @h
+        @h.update
+        initial_h.should eq @h
+      end
+
+      it "stores the new title" do
+        new_h = @h.update title: "New Title"
+        new_h.title.should eq "New Title"
+      end
+
+      it "retains the original values" do
+        new_h = @h.update
+        new_h.title.should eq @h.title
+      end
+
+      it "stores all of the new values" do
+        new_h = @h.update title: "New Title", tags: %w[ruby]
+        new_h.title.should eq "New Title"
+        new_h.tags.should  eq %w[ruby]
+      end
+    end
+
+    context "::from" do
+      let(:title)         { "The Title" }
+      let(:pub_date)      { "Published: Mon, 31 Dec 2012 15:41:00 EST" }
+      let(:expected_date) { DateTime.new(2012, 12, 31, 15, 41, 00, '-5') }
+      let(:summary)       { "SuMMAry: Something witty to get 'eyeballs'" }
+      let(:type)          { "tyPe: Article" }
+      let(:tags)          { "TaGS: red, green, blue, purple" }
+
+      it "returns a Header" do
+        h = Header.from ""
+        h.class.should eq Header
+      end
+
+      it "finds the title" do
+        h = Header.from title
+        h.title.should eq title
+      end
+
+      it "finds the filename" do
+        h = Header.from "filenAmE: the-filename-goes-here.md"
+        h.filename.should eq "the-filename-goes-here.md"
+      end
+
+      it "finds the publication date" do
+        h = Header.from pub_date
+        h.publication_date.should eq expected_date
+      end
+
+      it "does not manipulate now" do
+        h = Header.from "published: now"
+        h.publication_date.should eq :now
+      end
+
+      it "finds the summary" do
+        h = Header.from summary
+        h.summary.should eq "Something witty to get 'eyeballs'"
+      end
+
+      it "finds the type" do
+        h = Header.from type
+        h.type.should eq :article
+      end
+
+      it "finds the tags" do
+        h = Header.from tags
+        h.tags.map{|t| t.to_s}.should eq %w[red green blue purple]
+      end
+
+      it "finds multiple elements" do
+        combined_input = [title, pub_date, type, tags].join("\n")
+        h = Header.from combined_input
+        h.title.should eq title
+        h.publication_date.should eq expected_date
+        h.type.should eq :article
+        h.tags.map{|t| t.to_s}.should eq %w[red green blue purple]
+      end
+
+      it "alternate definition for titles" do
+        title = "thetitle: and a subtitle"
+        h = Header.from("title: " + title)
+        h.title.should eq title
+      end
+
+      it "handles initial whitespace" do
+        t = "\t A title starting with Whitespace"
+        h = Header.from "title: " + t
+        h.title.should eq "A title starting with Whitespace"
+      end
+
+      it "handles unsupported header lines" do
+        h = Header.from "unsupported: this should not exist"
+        expect {h.unsupported}.to raise_error NameError
+      end
+
+      it "ignores '====' separators" do
+        example = [title, "="*15].join("\n")
+        h = Header.from example
+        h.title.should eq title
+      end
+
+      it "finds external links" do
+        h = Header.from "external: http://ruby-lang.org"
+        h.external.should eq "http://ruby-lang.org"
+      end
+    end
+  end
+end

data/spec/contraption/lib/location_spec.rb

@@ -0,0 +1,148 @@
+require_relative '../../spec_helper'
+
+module Contraption
+  describe Location do
+    before(:all) { `mkdir /tmp/qscfr` }
+    after(:all)  { `rm -r /tmp/qscfr` }
+
+    let (:dir) { "/tmp/qscfr" }
+    after(:each) { `rm -rf #{dir}/*` }
+
+    let (:l) { Location.new dir }
+
+    it "has a path" do
+      l.path.should eq dir
+    end
+
+    it "can create itself on disk" do
+      new_location = Location.new(dir + '/newdir')
+      new_location.create!
+      File.exist?(dir+'/newdir').should be_true
+    end
+
+    context "#list" do
+      it "handles empty directories" do
+        l.list.should eq []
+      end
+
+      it "handles directories with one file" do
+        `touch #{dir}/monkeys`
+        l.list.should eq ['monkeys']
+      end
+
+      it "handles directories with multiple files" do
+        10.times {|i| `touch #{dir}/#{i}`}
+        l.list.should eq (0..9).map{|i| i.to_s}
+      end
+
+      it "only finds files with specific extension" do
+        `touch #{dir}/10.txt #{dir}/10.html #{dir}/10.md #{dir}/10.rb`
+        l.list(".html").should eq ["10.html"]
+      end
+
+      it "finds files with any of a list of extensions" do
+        `touch #{dir}/10.txt #{dir}/10.html #{dir}/10.md #{dir}/10.rb`
+        l.list(%w[.html .md]).should eq %w[10.html 10.md]
+      end
+    end
+
+    context "#read" do
+      let(:content) { "stuff\nthings" }
+      before(:each) { File.open("#{dir}/file", "w:UTF-8") { |f| f.print content } }
+
+      it "returns the contents of the file" do
+        l.read("file").should eq content
+      end
+
+      it "yields to block when passed" do
+        l.read("file") do |io|
+          io.map {|l| l[0]}
+        end.should eq ["s","t"]
+      end
+
+      it "returns a useful token if file does not exist" do
+        l.read("nonexistent_file").should eq :file_does_not_exist
+      end
+
+      it "returns a useful token if file is not readable" do
+        `touch #{dir}/file && chmod -r #{dir}/file`
+        l.read("#{dir}/file").should eq :file_not_readable
+      end
+    end
+
+    context "#write" do
+      it "writes the provided string to a file" do
+        l.write "filename", "this is a test string.\nand another line just for fun."
+      end
+
+      it "does not destructively write to a file" do
+        `touch #{dir}/a_new_file`
+        l.write("a_new_file", "some content that will not be written").should eq :file_already_exists
+      end
+    end
+
+    context "#remove" do
+      it "forgets an existing file" do
+        l.write("a_new_file", "some stuff to write")
+        l.remove("a_new_file")
+        l.list.should_not include("a_new_file")
+      end
+
+      it "does nothing for non-existing files" do
+        l.remove("a_non_existant_file").should eq :file_does_not_exist
+      end
+    end
+
+    context "directory trees" do
+      it "recursively creates directories" do
+        l.write "some/thing", "something"
+        l.read("some/thing").should eq "something"
+      end
+
+      it "recursively lists files" do
+        l.write "some/thing", "something"
+        l.write "a/new/file", "a"
+        l.list.should eq %w[a new file some thing]
+      end
+    end
+
+    context "equality" do
+      it "returns true for Locations with the same path" do
+        l.==(Location.new(dir)).should be_true
+      end
+
+      it "returns false for Locations with different paths" do
+        l.==(Location.new(dir+"a")).should be_false
+      end
+    end
+
+    context "interrogation" do
+      it "contains exist?" do
+        l.exist?
+      end
+
+      it "contains readable?" do
+        l.readable?
+      end
+
+      it "contains writable?" do
+        l.writable?
+      end
+
+      it "contains executable?" do
+        l.executable?
+      end
+    end
+
+    context "cd" do
+      it "returns a new Location rooted at argument" do
+        `mkdir #{dir}/subdir`
+        l.cd("subdir").path.should eq "#{dir}/subdir"
+      end
+
+      it "creates location if directory does not exist" do
+       l.cd("subdir").exist?.should be_true
+      end
+    end
+  end
+end

data/spec/contraption/lib/options_spec.rb

@@ -0,0 +1,25 @@
+require_relative '../../../lib/contraption/options'
+
+module Contraption
+  describe Options do
+    it "accepts an array of arguments" do
+      Options.new []
+    end
+
+    it "sets the source with -s" do
+      Options.new(["-s", "TheSource"]).source.path.should eq "TheSource"
+    end
+
+    it "sets the source with --source" do
+      Options.new(["--source", "TheSource"]).source.path.should eq "TheSource"
+    end
+
+    it "sets the destination with -d" do
+      Options.new(["-d", "TheDestination"]).destination.path.should eq "TheDestination"
+    end
+
+    it "sets the destination with --destination" do
+      Options.new(["--destination", "TheDestination"]).destination.path.should eq "TheDestination"
+    end
+  end
+end

data/spec/contraption/lib/post_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../../spec_helper.rb'
+
+module Contraption
+  describe Post do
+    it "has a body" do
+      Post.new.body
+    end
+
+    it "has metadata" do
+      Post.new.metadata
+    end
+
+    context "::build" do
+      it "returns a post object from the given string" do
+        Post.build("testing").class.should eq Post
+      end
+
+      it "has a nonempty title" do
+        Post.build("testing").title.should_not eq ""
+      end
+
+      it "has a nonempty body" do
+        p = Post.build("testing\n\nsome content for the post")
+        p.body.should_not eq ""
+      end
+
+      it "captures the entire contents of multiline posts" do
+        p = Post.build("testing\n\nsome content for the post\n\nsome more content")
+        p.body.should include "<p>some content for the post</p>\n\n<p>some more content</p>"
+      end
+
+      it "translates markdown to html" do
+        p = Post.build("testing\n\n__bold text__")
+        p.body.should include "<strong>bold text</strong>"
+      end
+    end
+
+    context ".publish" do
+      it "sets the new date" do
+        p = Post.build "\n\n"
+        p = p.publish.publication_date.to_s.should eq Time.now.to_s
+      end
+
+      it "does not modify the body" do
+        p = Post.build "\n\nSome stuff"
+        p.publish.body.should include "Some stuff"
+      end
+    end
+  end
+end

data/spec/contraption/lib/repository_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../../../lib/contraption/repository.rb'
+
+module Contraption
+  describe Repository do
+    context "validity" do
+      before(:each) do
+        @source = double()
+        @source.stub(exist?: true)
+        @source.stub(:cd).and_return("")
+      end
+
+      it "raises an error if the structure is invalid" do
+        @source.stub(list: %w[drafts pictures])
+        expect {r = Repository.new(@source)}.to raise_error
+      end
+    end
+
+    it "finds the drafts" do
+      Repository.any_instance.stub(:validate)
+      source = double()
+      source.stub(:list).and_return(%w[test.md house.md])
+      source.stub(cd: source)
+      r = Repository.new(source)
+      r.drafts.should eq %w[test.md house.md]
+    end
+
+    it "returns a collection of posts" do
+      Repository.any_instance.stub(:validate)
+      source = double()
+      source.stub(:list).and_return(%w[test.md house.md])
+      source.stub(:read).with("test.md").and_return("something")
+      source.stub(:read).with("house.md").and_return("something else")
+      source.stub(cd: source)
+      r = Repository.new(source)
+      r.posts.should respond_to :each
+    end
+  end
+end

data/spec/contraption/lib/tag_cloud_spec.rb

@@ -0,0 +1,39 @@
+require_relative '../../../lib/contraption/tag_cloud'
+
+module Contraption
+  describe TagCloud do
+    context "#initialize" do
+      it "takes a collection of posts" do
+        tc = TagCloud.new []
+      end
+    end
+
+    context "#to_s" do
+      before do
+        tag1 = double
+        tag2 = double
+        tag1.stub(:to_s).and_return("Ruby")
+        tag1.stub(:to_url).and_return("ruby")
+        tag2.stub(:to_s).and_return("OS X")
+        tag2.stub(:to_url).and_return("os-x")
+        posts = double
+        posts.stub(:by_tag).and_return( {tag1 => [1, 2], tag2 => [1]} )
+        @tc = TagCloud.new posts
+      end
+
+      it "contains all of the tags" do
+        @tc.to_s.should include 'ruby'
+        @tc.to_s.should include 'os-x'
+      end
+
+      it "includes a link to the tag page" do
+        @tc.to_s.should include 'ruby/index.html'
+        @tc.to_s.should include 'os-x/index.html'
+      end
+
+      it "sets the size of each tag" do
+        @tc.to_s.should include 'font-size'
+      end
+    end
+  end
+end

data/spec/contraption/lib/tag_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../../../lib/contraption/tag.rb'
+
+module Contraption
+  describe Tag do
+    it "accepts a string to be displayed" do
+      t = Tag.new "Ruby"
+    end
+
+    it "returns the display text" do
+      t = Tag.new "Ruby"
+      t.to_s.should eq "Ruby"
+    end
+
+    context "#to_url" do
+      it "provides a url friendly version" do
+        t = Tag.new "Ruby"
+        t.to_url
+      end
+
+      it "downcases the output" do
+        t = Tag.new "Ruby"
+        t.to_url.should eq "ruby"
+      end
+
+      it "replaces spaces with dashes" do
+        t = Tag.new "ruby rocks"
+        t.to_url.should eq "ruby-rocks"
+      end
+    end
+
+    context "#to_sym" do
+      it "returns a symbolized version of the display text" do
+        t = Tag.new "Qwerty"
+        t.to_sym.should eq "Qwerty".to_sym
+      end
+    end
+  end
+end

data/spec/contraption/lib/version_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../../spec_helper'
+
+module Contraption
+  describe VERSION do
+    it "is defined" do
+      Contraption::VERSION
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/contraption'
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end