octopress 3.0.0.alpha1

data/lib/rake/watch.rake

@@ -0,0 +1,11 @@
+desc "Watch the site and regenerate when it changes"
+task :watch do
+  raise "### You haven't set anything up yet. First run `rake install` to set up an Octopress theme." if Octopress.configuration[:source].nil? || !File.directory?(Octopress.configuration[:source])
+  puts "Starting to watch source with Jekyll and Compass."
+  guardPid = Process.spawn("guard --guardfile #{Octopress.root}/lib/octopress/guardfile")
+  trap("INT") {
+    Process.kill(9, guardPid) rescue Errno::ESRCH
+    exit 0
+  }
+  Process.wait guardPid
+end

data/lib/scaffold/Rakefile

@@ -0,0 +1,142 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+require 'rake/clean'
+require 'safe_yaml'
+
+#############################################################################
+#
+# Configure Rake's clean/clobber tasks.
+#
+#############################################################################
+
+# 'rake clean' is for intermediate/temporary files not meant for direct
+# consumption by the user.  Output from Compass, cache directories, etc are
+# good examples here.
+# CLEAN.include(...)
+
+# 'rake clobber' is for generated files meant for direct consumption by the
+# user.  Release packages, generated docs/coverage reports, etc are good
+# examples here.
+CLOBBER.include('pkg/*')
+
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def manifest
+  @manifest ||= YAML.safe_load_file(File.expand_path("../MANIFEST.yml", __FILE__))
+end
+
+def name
+  @name ||= manifest["slug"]
+end
+
+def ruby_name
+  name.gsub(/-/, '_')
+end
+
+require "./lib/#{ruby_name}"
+
+def version
+  manifest["version"]
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  require 'irb'
+  ARGV.clear
+  IRB.start
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  replace_header(head, :date)
+
+  # determine file list from git ls-files
+  # TODO: Certain files don't belong in the gem...
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    reject { |file| file =~ /^Gemfile(\.lock)?$/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  octo.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{ruby_name}.rb", "lib/#{ruby_name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  if Dir['MANIFEST.yml'].empty?
+    puts "A `MANIFEST.yml` file must exist in your root with at least your plugin slug and version."
+    exit!
+  end
+end

data/lib/scaffold/plugin-name.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+require "safe_yaml"
+
+def manifest
+  @manifest ||= YAML.safe_load_file(File.expand_path("../MANIFEST.yml", __FILE__))
+end
+
+Gem::Specification.new do |plugin|
+  plugin.specification_version = 2 if plugin.respond_to? :specification_version=
+  plugin.required_rubygems_version = Gem::Requirement.new(">= 0") if plugin.respond_to? :required_rubygems_version=
+  plugin.rubygems_version = '1.3.5'
+
+  plugin.name          = manifest["name"]
+  plugin.version       = manifest["version"]
+  plugin.date          = '2013-05-23'
+  plugin.authors       = manifest["authors"]
+  plugin.email         = manifest["emails"]
+  plugin.description   = manifest["description"]
+  plugin.summary       = manifest["summary"]
+  plugin.homepage      = manifest["homepage"]
+
+  plugin.rdoc_options = ["--charset=UTF-8"]
+  plugin.extra_rdoc_files = manifest["extra_rdoc_files"]
+
+  # = MANIFEST =
+  plugin.files = %w[
+  ]
+  # = MANIFEST =
+
+  plugin.require_paths = %w[lib]
+  plugin.executables   = plugin.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  plugin.test_files    = plugin.files.grep(%r{^(test|spec|features)/})
+
+  {
+    "octopress" => "~> 3.0.0"
+  }.each do |gem_name, version|
+    plugin.add_runtime_dependency(gem_name, version)
+  end
+
+  plugin.add_development_dependency('rake', '~> 10.0.3')
+  plugin.add_development_dependency('rspec', '~> 2.13.0')
+end

data/lib/spec/fixtures/env/defaults/classic.yml

@@ -0,0 +1,2 @@
+---
+env: config_specified_environment

data/lib/spec/fixtures/no_override/defaults/classic.yml

@@ -0,0 +1,11 @@
+---
+# ------------------------------- #
+#   Classic Theme Configuration   #
+# ------------------------------- #
+
+url: http://yoursite.com
+title: My Octopress Blog
+subtitle: A blogging framework for hackers.
+author: Your Name
+simple_search: http://google.com/search
+description:

data/lib/spec/fixtures/override/defaults/classic.yml

@@ -0,0 +1,11 @@
+---
+# ------------------------------- #
+#   Classic Theme Configuration   #
+# ------------------------------- #
+
+url: http://yoursite.com
+title: My Octopress Blog
+subtitle: A blogging framework for hackers.
+author: Your Name
+simple_search: http://google.com/search
+description:

data/lib/spec/fixtures/override/site.yml

@@ -0,0 +1,11 @@
+---
+# ------------------------------- #
+#   Classic Theme Configuration   #
+# ------------------------------- #
+
+url: http://myownsite.com
+title: My Octopress custom Blog
+subtitle: "How did this get here? I'm not good with computers"
+author: John Doe
+simple_search: http://google.com/search
+description:

data/lib/spec/octopress/configuration_spec.rb

@@ -0,0 +1,67 @@
+describe Octopress do
+  describe ".configurator" do
+    it "should accept a path pointing to a config directory" do
+      Octopress.configurator(fixture_path('env'))
+
+      Octopress.env.should eq('config_specified_environment')
+    end
+  end
+
+  describe ".configuration" do
+    before do
+      Octopress.configurator(fixture_path('env'))
+    end
+    let(:configuration) { Octopress.configuration }
+
+    it "should provide access to the specified configuration" do
+      configuration[:env].should eq('config_specified_environment')
+    end
+  end
+end
+
+describe Octopress::Configuration do
+  describe '#read_configuration' do
+    describe "when no override" do
+      before do
+        @octo_config = Octopress::Configuration.new(fixture_path('no_override'))
+      end
+      let(:configuration) { @octo_config.read_configuration }
+      let(:expected_config) {
+        { :url           => "http://yoursite.com",
+          :title         => "My Octopress Blog",
+          :subtitle      => "A blogging framework for hackers.",
+          :author        => "Your Name",
+          :simple_search => "http://google.com/search",
+          :description   => nil }
+
+      }
+
+      %w[url title subtitle author simple_search description].each do |key|
+        it "returns the correct value for #{key}" do
+          configuration[key.to_sym].should eq(expected_config[key.to_sym])
+        end
+      end
+    end
+
+    describe "when override" do
+      before do
+        @octo_config = Octopress::Configuration.new(fixture_path('override'))
+      end
+      let(:configuration) { @octo_config.read_configuration }
+      let(:expected_config) {
+        { :url           => "http://myownsite.com",
+          :title         => "My Octopress custom Blog",
+          :subtitle      => "How did this get here? I'm not good with computers",
+          :author        => "John Doe",
+          :simple_search => "http://google.com/search",
+          :description   => nil }
+      }
+
+      %w[url title subtitle author simple_search description].each do |key|
+        it "returns the correct value for #{key}" do
+          configuration[key.to_sym].should eq(expected_config[key.to_sym])
+        end
+      end
+    end
+  end
+end

data/lib/spec/octopress/dependency_installer_spec.rb

@@ -0,0 +1,66 @@
+describe Octopress::DependencyInstaller do
+  # describe "#namespace" do
+  #   context "when just a repo name is specified" do
+  #     let(:plugin) { "adn-timeline" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("adn-timeline") }
+  #   end
+  #   context "when a username and repo name are specified" do
+  #     let(:plugin) { "imathis/adntimeline" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("imathis-adntimeline") }
+  #   end
+  #   context "when a username and repo name are specified (with dash)" do
+  #     let(:plugin) { "imathis-/adn-timeline" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("imathis-adn-timeline") }
+  #   end
+  #   context "when a full git:// URL is specified" do
+  #     let(:plugin) { "git://github.com/parkr/cool-plugin.git" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("parkr-cool-plugin") }
+  #   end
+  #   context "when a full https:// URL is specified" do
+  #     let(:plugin) { "https://bitbucket.com/parkr/cool-plugin.git" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("parkr-cool-plugin") }
+  #   end
+  #   context "when a full git SSH path is specified" do
+  #     let(:plugin) { "git@octopress.org:parkr/cool-plugin.git" }
+  #     subject { Octopress::DependencyInstaller.new.namespace(plugin) }
+  #     it { should eq("parkr-cool-plugin") }
+  #   end
+  # end
+  describe "#git_url" do
+    context "when just a repo name is specified" do
+      let(:plugin) { "adn-timeline" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq("git://github.com/octopress/#{plugin}.git") }
+    end
+    context "when a username and repo name are specified" do
+      let(:plugin) { "imathis/adntimeline" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq("git://github.com/#{plugin}.git") }
+    end
+    context "when a username and repo name are specified (with dash)" do
+      let(:plugin) { "imathis-/adn-timeline" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq("git://github.com/#{plugin}.git") }
+    end
+    context "when a full git:// URL is specified" do
+      let(:plugin) { "git://github.com/parkr/cool-plugin.git" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq(plugin) }
+    end
+    context "when a full https:// URL is specified" do
+      let(:plugin) { "https://bitbucket.com/parkr/cool-plugin.git" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq(plugin) }
+    end
+    context "when a full git SSH path is specified" do
+      let(:plugin) { "git@octopress.org:parkr/cool-plugin.git" }
+      subject { Octopress::DependencyInstaller.new.git_url(plugin) }
+      it { should eq(plugin) }
+    end
+  end
+end

data/lib/spec/octopress/ink_spec.rb

@@ -0,0 +1,10 @@
+describe Octopress::Ink do
+  subject { Octopress::Ink.build }
+
+  %w[debug warn info error].each do |method|
+    it "responds to #{method} method" do
+      expect(subject).to respond_to(method)
+    end
+  end
+
+end

data/lib/spec/octopress/octopress_spec.rb

@@ -0,0 +1,97 @@
+describe Octopress do
+  describe '#env' do
+    context "when ENV['OCTOPRESS_ENV'] is specified" do
+      before do
+        ENV['OCTOPRESS_ENV'] = 'some_environment'
+      end
+
+      subject do
+        Octopress.env
+      end
+
+      it "returns the environment as something that quacks like a string" do
+        should eq('some_environment')
+      end
+
+      # For the InquirableString functionality...
+      describe "#some_environment?" do
+        subject do
+          Octopress.env.some_environment?
+        end
+
+        it "returns true when the environment is set to 'some_environment'" do
+          should be_true
+        end
+      end
+
+      describe "#some_other_environment?" do
+        subject do
+          Octopress.env.some_other_environment?
+        end
+
+        it "returns false when the environment is set to 'some_environment'" do
+          should be_false
+        end
+      end
+    end
+
+    describe "when ENV['OCTOPRESS_ENV'] is NOT specified and a value is specified in config files" do
+      before do
+        @old_value = ENV['OCTOPRESS_ENV']
+        ENV['OCTOPRESS_ENV'] = nil
+        Octopress.configurator(File.join(File.dirname(__FILE__), '..', 'fixtures', 'env'))
+      end
+
+      after do
+        ENV['OCTOPRESS_ENV'] = @old_value
+        Octopress.clear_config!
+      end
+
+      subject do
+        Octopress.env
+      end
+
+      it "returns the environment as something that quacks like a string" do
+        should eq('config_specified_environment')
+      end
+
+      # For the InquirableString functionality...
+      describe "#config_specified_environment?" do
+        subject do
+          Octopress.env.config_specified_environment?
+        end
+
+        it "returns true when the environment is set to 'config_specified_environment'" do
+          should be_true
+        end
+      end
+
+      describe "#some_other_environment?" do
+        subject do
+          Octopress.env.some_other_environment?
+        end
+
+        it "returns false when the environment is set to 'config_specified_environment'" do
+          should be_false
+        end
+      end
+    end
+
+    describe "when the configuration value changes mid-execution" do
+      before do
+        @old_value = ENV['OCTOPRESS_ENV']
+        ENV['OCTOPRESS_ENV'] = 'value_a'
+      end
+
+      after do
+        ENV['OCTOPRESS_ENV'] = @old_value
+      end
+
+      it "returns the initial environment value, then after it's changed, returns the new one" do
+        Octopress.env.should eq('value_a')
+        ENV['OCTOPRESS_ENV'] = 'value_b'
+        Octopress.env.should eq('value_b')
+      end
+    end
+  end
+end