smeagol 0.5.9 → 0.6.0

data/lib/smeagol/views/post.rb

@@ -0,0 +1,51 @@
+module Smeagol
+
+  module Views
+
+    class Post < Page
+
+      # The Gollum::Page that this view represents.
+      # This is the same as `#page` and `#file`.
+      alias post page
+
+      # Public: static href, used when generating static site.
+      def href
+        dir  = ::File.dirname(page.path)
+        name = slug(page.filename_stripped)
+        ext  = ::File.extname(page.path)
+
+        if dir != '.'
+          ::File.join(dir, name, 'index.html')
+        else
+          if name == settings.index #|| 'Home'
+            'index.html'
+          else
+            ::File.join(name, 'index.html')
+          end
+        end
+      end
+
+      # Internal: Apply slug rules to name.
+      #
+      # TODO: Support configurable slugs.
+      #
+      # Returns [String] Sluggified name.
+      def slug(name)
+        if /^\d\d+\-/ =~ name
+          dirs = [] 
+          parts = name.split('-')
+          while /^\d+$/ =~ parts.first
+            dirs << parts.shift             
+          end
+          dirs << parts.join('-')
+          dirs.join('/')
+        else
+          name
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/smeagol/views/versions.rb

@@ -1,16 +1,24 @@
 module Smeagol
   module Views
     class Versions < Base
-      # Public: The title of the wiki. This is set in the settings file.
-      def wiki_title
-        wiki.settings.title
+      # Initializes a new mustache view template data object.
+      #
+      # master - Master controller, which creates all the views.
+      #
+      # Returns a new page object.
+      def initialize(master)
+        @master  = master
+        @wiki    = master.wiki
+
+        setup_template_path
       end
-      
+
       # Public: The HTML formatted content of the page.
       def content
         html = "<a href=\"/\">Current</a><br/>"
         wiki.repo.tags.each do |tag|
-          html << "<a href=\"/#{tag.name}\">#{tag.name}</a><br/>"
+          href = tag.name.start_with?('v') ? "/#{tag.name}" : "/v#{tag.name}"
+          html << "<a href=\"#{href}\">#{tag.name}</a><br/>"
         end
         html
       end
@@ -18,8 +26,14 @@ module Smeagol
       # Public: The URL of the project source code. This is set in the settings
       # file.
       def source_url
-        wiki.settings.source_url
+        settings.source_url
       end
+
+      # TODO: Allow customization ?
+      def layout
+        IO.read(LIBDIR + "/templates/layouts/versions.mustache")
+      end
+
     end
   end
 end

data/lib/smeagol/wiki.rb

@@ -1,55 +1,35 @@
-require 'gollum'
-require 'ostruct'
-require 'yaml'
-
 module Smeagol
+
+  # Subclass of Gollum::Wiki.
+  #
+  # TODO: Techincailly this is probably not needed. Presently it only adds
+  #       one methods.
+  #
   class Wiki < Gollum::Wiki
-    # Public: Updates the wiki repository.
-    # 
-    # git  - The path to the git binary.
-    #
-    # Returns true if successful. Otherwise returns false.
-    def update(git)
-      # TODO: Change this method to raise errors if something goes wrong instead
-      #       of returning a status.
-      
-      # If the git executable is available, pull from master and check status.
-      if !git.nil?
-        output = `cd #{path} && #{git} pull origin master 2>/dev/null`
-        
-        # Write update to log if something happened
-        if output.index('Already up-to-date').nil?
-          $stderr.puts "==Repository updated at #{Time.new()} : #{path}=="
-        end
-    
-        return $? == 0
-      # Otherwise return false.
-      else
-        return false
-      end
-    end
 
-    ##############################################################################
+    # TODO: Wish Gollum let us set these in some other way so that a subclass
+    # doesn't have to do it again.
+    self.default_ref = 'master'
+    self.default_committer_name  = 'Anonymous'
+    self.default_committer_email = 'anon@anon.com'
+    self.default_ws_subs = ['_','-']
+
+    # Public: The Smeagol wiki settings. These can be found in the _settings.yml
+    # file at the root of the repository.
+    # This method caches the settings for all subsequent calls.
     #
-    # Settings
+    # TODO: Should settings be coming from current file or from repo version?
+    #       This can be tricky. Right now they come from current file, but
+    #       In future we probably need to split this into two config files.
+    #       One that comes from version and one that is current.
     #
-    ##############################################################################
-
-    # The Smeagol wiki settings. These can be found in the smeagol.yaml file at
-    # the root of the repository.
+    # TODO: This might be better in Controller instead.
     #
-    # Returns an OpenStruct of settings.
+    # Returns a Settings object.
     def settings
-      # Cache settings if already read
-      if @settings.nil?
-        file = "#{path}/settings.yml"
-        if File.readable?(file)
-          @settings = YAML::load(IO.read(file)).to_ostruct
-        else
-          @settings = OpenStruct.new
-        end
-      end
-      return @settings
+      @settings ||= Settings.load(path)
     end
+
   end
+
 end

data/test/helper.rb

@@ -1,12 +1,76 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'mocha'
+require 'citron'
+require 'ae'
+require 'fileutils'
+#require 'mocha'
+require 'smeagol'
+require 'rack/test'
 
-$:.unshift(File.dirname(__FILE__))
-require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
+# Shut-off verbose output from Smeagol.
+$QUIET = true
+
+#$:.unshift(File.dirname(__FILE__))
+#require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
 
 # Stop test if test wiki path is not set
-if !ENV.has_key?('SMEAGOL_TEST_WIKI_PATH')
-  puts 'You must set SMEAGOL_TEST_WIKI_PATH in your environment to run the tests.'
-  exit(1);
+#if !ENV.has_key?('SMEAGOL_TEST_WIKI_PATH')
+#  puts 'You must set SMEAGOL_TEST_WIKI_PATH in your environment to run the tests.'
+#  exit(1);
+#end
+
+# TODO: Use Grit instead of shell.
+def test_wiki(directory='smeagol-test')
+  $test_wiki ||= {}
+  $test_wiki[directory] ||= (
+    directory = File.join('tmp', directory)
+
+    if ::File.directory?("#{directory}/.git")
+      #system "cd #{directory} && git reset --hard"
+    else
+      system "git clone https://github.com/rubyworks/smeagol-test.git #{directory}"
+    end
+
+    directory
+  )
+end
+
+=begin
+class TestWiki
+  include Rack::Test::Methods 
+
+  # TODO: Use Grit instead of shell.
+  def self.clone(directory='smeagol-test')
+    if ::File.directory?("#{directory}/.git")
+      #system "cd #{directory} && git reset --hard"
+    else
+      system "git clone https://github.com/rubyworks/smeagol-test.git #{directory}"
+    end
+    new(directory)
+  end
+
+  #
+  def initialize(directory)
+    @directory = directory
+    Smeagol::App.set :environment, :test
+    Smeagol::App.set :repositories, [Smeagol::Repository.new(:path => directory)]
+    Smeagol::App.set :cache_enabled, false
+  end
+
+  #
+  attr :directory
+
+  #
+  def app
+    @app ||= Rack::Builder.new do
+      run Smeagol::App
+    end
+  end
+
+  # Helper method.
+  def get_content(body)
+    body = body.gsub(/^.+<article>\n/m, '')
+    body = body.gsub(/\n<\/article>.+$/m, '')
+    return body
+  end
 end
+=end
+

data/test/test_app.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+testcase Smeagol::App do
+
+  context "Testing Routes" do
+    include Rack::Test::Methods
+
+    # TODO: Wait, there is no `before :all`?
+    setup do
+      @wiki_directory = test_wiki('smeagol-test')
+    end
+
+    test "root" do
+      get '/'
+      body = last_response.body.gsub(/^\s+| +$/, '')
+      body.assert.include?('<html>')
+      body.assert.include?('<title>Smeagol - Home</title>')
+      body.assert.include?('<p>Welcome to the Home page!</p>')
+    end
+
+    test "Test Page" do
+      get '/Test-page'
+      body = last_response.body.gsub(/^\s+| +$/, '')
+      body.assert.include?('<h1>Test page</h1>')
+      body.assert.include?('<p>This is the <strong>test</strong> <em>page</em>.</p>')
+      body.assert.include?('<li>Item 1</li>')
+    end
+
+    test "Code Page" do
+      get '/Code-page'
+      body = last_response.body.gsub(/^\s+| +$/, '')
+      body.assert.include?('<h1>Code page</h1>')
+      body.assert.include?('<p>This is Ruby code:</p>')
+      body.assert.include?('<div class="highlight">')
+      body.assert.include?('<span class="k">')
+      body.assert.include?('<span class="s2">"Hello World!"</span>')
+    end
+
+    #
+    def app
+      @app ||= (
+        path = @wiki_directory
+
+        Rack::Builder.new do
+          Smeagol::App.set :environment, :test
+          Smeagol::App.set :repositories, [Smeagol::Repository.new(:path => path)]
+          Smeagol::App.set :cache_enabled, false
+          Smeagol::App.set :mount_path, ''
+
+          run Smeagol::App
+        end
+      )
+    end
+
+  end
+
+end

data/test/test_cache.rb

@@ -1,32 +1,31 @@
-require File.dirname(__FILE__) + '/helper'
-require 'fileutils'
+require 'helper'
 
-class CacheTestCase < MiniTest::Unit::TestCase
-  def setup
-    @wiki = Smeagol::Wiki.new(ENV['SMEAGOL_TEST_WIKI_PATH'])
+testcase Smeagol::Cache do
+  setup do
+    @wiki = Smeagol::Wiki.new(test_wiki)
     @cache = Smeagol::Cache.new(@wiki)
     @cache.clear()
   end
 
-  def test_should_show_cache_hit
+  test 'should show cache hit' do
     @cache.set_page('Home', 'master', 'abc')
     assert @cache.cache_hit?('Home')
   end
   
-  def test_should_show_cache_miss
+  test 'should show cache miss' do
     assert !@cache.cache_hit?('Home')
   end
 
-  def test_should_show_cache_miss_for_nonexistent_page
+  test 'should show cache miss for nonexistent_page' do
     assert !@cache.cache_hit?('THIS_IS_NOT_A_PAGE!')
   end
 
-  def test_should_cache_page
+  test 'should cache page' do
     @cache.set_page('Home', 'master', 'abc')
-    assert_equal 'abc', @cache.get_page('Home')
+    @cache.get_page('Home').assert == 'abc'
   end
 
-  def test_should_remove_cache
+  test 'should remove cache' do
     @cache.set_page('Home', 'master', 'abc')
     @cache.remove_page('Home')
     assert !@cache.cache_hit?('Home')

data/test/test_init.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+testcase Smeagol::Console do
+
+  context "init" do
+
+    setup do
+      @test_dir = 'tmp/fresh-wiki'
+      FileUtils.rm_r(@test_dir) if File.exist?(@test_dir)
+      FileUtils.mkdir(@test_dir)
+      FileUtils.mkdir(File.join(@test_dir, '.git')) # fake a git repo for testing
+    end
+
+    test "init should create default files." do
+      Dir.chdir(@test_dir) do
+        Smeagol::Console.init()
+
+        File.assert.file?('_settings.yml')
+        File.assert.directory?('_layouts')
+        File.assert.directory?('assets/smeagol')
+      end
+    end
+
+  end
+
+end
+

data/test/test_update.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+testcase Smeagol::Console do
+
+  context "update" do
+
+    setup do
+      @test_dir = test_wiki('smeagol-test')
+    end
+
+    test "update should fit pull down current repo" do
+      Dir.chdir(@test_dir) do
+        Smeagol::Console.update('.')
+      end
+    end
+
+  end
+
+end
+

data/test/test_wiki.rb

@@ -1,15 +1,18 @@
-require File.dirname(__FILE__) + '/helper'
+require 'helper'
 
-class WikiTestCase < MiniTest::Unit::TestCase
-  def setup
-    @wiki = Smeagol::Wiki.new(ENV['SMEAGOL_TEST_WIKI_PATH'])
-  end
-  
-  def test_settings_should_be_open_struct
-    assert_kind_of OpenStruct, @wiki.settings
+testcase Smeagol::Wiki do
+
+  setup do
+    @wiki = Smeagol::Wiki.new(test_wiki)
   end
 
-  def test_settings_should_be_read_from_file
-    assert_equal 'Smeagol', @wiki.settings.title
+  test 'settings should be Settings instance' do
+    assert Smeagol::Settings === @wiki.settings
   end
+
+  #test 'settings should be read from file' do
+  #   @wiki.settings.title.assert == 'Smeagol'
+  #end
+
 end
+

metadata

@@ -1,272 +1,198 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: smeagol
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 9
-  version: 0.5.9
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ben Johnson
+- Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-26 00:00:00 -06:00
-default_executable: smeagol
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &31364960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: gollum
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 1
-        - 1
-        - 1
-        version: 1.1.1
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: sinatra
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *31364960
+- !ruby/object:Gem::Dependency
+  name: gollum
+  requirement: &31364360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: OptionParser
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *31364360
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &31363760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 5
-        - 1
-        version: 0.5.1
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: daemons
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *31363760
+- !ruby/object:Gem::Dependency
+  name: rubypython
+  requirement: &31363180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
-        version: 1.1.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *31363180
+- !ruby/object:Gem::Dependency
+  name: citron
+  requirement: &31362700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
-        version: 0.8.3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *31362700
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: &31362140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 7
-        - 0
-        version: 1.7.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *31362140
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &31361600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *31361600
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &31361080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 53
-        segments: 
-        - 0
-        - 8
-        - 5
-        version: 0.8.5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
-  type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: capybara
-  prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 3
-        - 9
-        version: 0.3.9
-  type: :development
-  version_requirements: *id011
-description: 
-email: 
+  version_requirements: *31361080
+description: ! 'Smeagol is a customizable read-only Gollum wiki server.
+
+  Smeagol makes it possible to maintain a standalone website,
+
+  but update it through the Gollum wiki interface, e.g. via GitHub.'
+email:
 - benbjohnson@yahoo.com
-executables: 
-- smeagol
+- transfire@gmail.com
+executables:
 - smeagold
-- smeagol-static
+- smeagol-update
+- smeagol
+- smeagol-preview
+- smeagol-serve
+- smeagol-init
 extensions: []
-
-extra_rdoc_files: []
-
-files: 
-- lib/file.rb
+extra_rdoc_files:
+- LICENSE.txt
+- HISTORY.md
+- README.md
+files:
+- .ruby
+- .yardopts
+- bin/smeagol
+- bin/smeagol-init
+- bin/smeagol-preview
+- bin/smeagol-serve
+- bin/smeagol-update
+- bin/smeagold
 - lib/smeagol/app.rb
 - lib/smeagol/cache.rb
-- lib/smeagol/hash.rb
-- lib/smeagol/option_parser.rb
-- lib/smeagol/public/smeagol/html5.js
-- lib/smeagol/public/smeagol/main.css
-- lib/smeagol/public/smeagol/pygment.css
-- lib/smeagol/templates/page.mustache
-- lib/smeagol/templates/versions.mustache
+- lib/smeagol/cli.rb
+- lib/smeagol/config.rb
+- lib/smeagol/console.rb
+- lib/smeagol/controller.rb
+- lib/smeagol/core_ext.rb
+- lib/smeagol/gollum/blob_entry.rb
+- lib/smeagol/gollum/file.rb
+- lib/smeagol/gollum/page.rb
+- lib/smeagol/gollum/wiki.rb
+- lib/smeagol/helpers/rss.rb
+- lib/smeagol/helpers/toc.rb
+- lib/smeagol/public/assets/smeagol/gollum.css
+- lib/smeagol/public/assets/smeagol/html5.js
+- lib/smeagol/public/assets/smeagol/pygment.css
+- lib/smeagol/public/assets/smeagol/template.css
+- lib/smeagol/repository.rb
+- lib/smeagol/settings.rb
+- lib/smeagol/templates/layouts/page.mustache
+- lib/smeagol/templates/layouts/versions.mustache
+- lib/smeagol/templates/partials/footer.mustache
+- lib/smeagol/templates/partials/header.mustache
+- lib/smeagol/templates/settings.yml
 - lib/smeagol/version.rb
 - lib/smeagol/views/base.rb
+- lib/smeagol/views/form.rb
 - lib/smeagol/views/page.rb
+- lib/smeagol/views/post.rb
 - lib/smeagol/views/versions.rb
 - lib/smeagol/wiki.rb
 - lib/smeagol.rb
-- README.md
 - test/helper.rb
+- test/test_app.rb
 - test/test_cache.rb
-- test/test_file.rb
-- test/test_hash.rb
+- test/test_init.rb
+- test/test_update.rb
 - test/test_wiki.rb
-- bin/smeagol
-- bin/smeagold
-- bin/smeagol-static
-has_rdoc: true
-homepage: http://smeagolrb.info
-licenses: []
-
+- HISTORY.md
+- README.md
+- LICENSE.txt
+homepage: http://rubyworks.github.com/smeagol
+licenses:
+- BSD-2-Clause
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: A read-only server for Gollum wikis
-test_files: 
-- test/helper.rb
-- test/test_cache.rb
-- test/test_file.rb
-- test/test_hash.rb
-- test/test_wiki.rb
+summary: Wiki Cum Website
+test_files: []