vanilla 1.12.5 → 1.13.1

data/Rakefile

@@ -24,7 +24,7 @@ if Object.const_defined?(:Gem)
 
     # Change these as appropriate
     s.name              = "vanilla"
-    s.version           = "1.12.5"
+    s.version           = Vanilla::VERSION
     s.summary           = "A bliki-type web content thing."
     s.author            = "James Adam"
     s.email             = "james@lazyatom.com.com"
@@ -41,16 +41,15 @@ if Object.const_defined?(:Gem)
 
     # All the other gems we need.
     s.add_dependency("rack", ">= 0.9.1")
-    s.add_dependency("soup", ">= 1.0.1")
+    s.add_dependency("soup", ">= 1.0.3")
     s.add_dependency("ratom", ">= 0.3.5")
     s.add_dependency("RedCloth", ">= 4.1.1")
     s.add_dependency("BlueCloth", ">= 1.0.0")
     s.add_dependency("treetop", ">= 1.4.1")
-    s.add_dependency("warden", ">= 0.5.2")
+    s.add_dependency("haml")
 
     s.add_development_dependency("shoulda") # add any other gems for testing/development
     s.add_development_dependency("mocha")
-    s.add_development_dependency("haml")
 
     # If you want to publish automatically to rubyforge, you'll may need
     # to tweak this, and the publishing task below too.

data/config.example.yml

@@ -2,5 +2,6 @@
 :soups: 
   - soup
   - soup/dynasnips
+  - soup/tutorial
   - soup/system
   - soup/system/dynasnips

data/config.ru

@@ -6,19 +6,5 @@ require 'vanilla'
 require 'vanilla/static'
 
 app = Vanilla::App.new(ENV['VANILLA_CONFIG'])
-
-use Rack::Session::Cookie, :key => 'vanilla.session',
-                           :path => '/',
-                           :expire_after => 2592000,
-                           :secret => app.config[:secret]
-
-require 'vanilla/authentication/warden'
-app.authenticator = Vanilla::Authentication::Warden.new(app)
-use Warden::Manager do |manager|
-  manager.default_strategies :vanilla
-  manager.failure_app = Vanilla::Authentication::Warden::FailApp.new
-end
-
 use Vanilla::Static, File.join(File.dirname(__FILE__), 'public')
-
 run app

data/lib/tasks/vanilla.rake

@@ -13,50 +13,6 @@ namespace :vanilla do
     puts "TODO, but should be easier thanks to multi-space soup."
   end
 
-  desc 'Add a user (or change an existing password)'
-  task :add_user => :prepare do
-    puts "Adding a new user"
-    # config_file = ENV['VANILLA_CONFIG'] || 'config.yml'
-    # config_file = YAML.load(File.open(config_file)) rescue {}
-    app = Vanilla::App.new(ENV['VANILLA_CONFIG'])
-    print "Username: "
-    username = STDIN.gets.chomp.strip
-    print "Password: "
-    password = STDIN.gets.chomp.strip
-    print "Confirm password: "
-    confirm_password = STDIN.gets.chomp.strip
-    if password != confirm_password
-      raise "Passwords don't match!"
-    else
-      app.config[:credentials] ||= {}
-      app.config[:credentials][username] = MD5.md5(password).to_s
-      app.config.save!
-      puts "User '#{username}' added."
-    end
-  end
-
-  desc 'Generate file containing secret for cookie-based session storage'
-  task :generate_secret do
-    print "Generating cookie secret... "
-    # Adapted from old rails secret generator.
-    require 'openssl'
-    if !File.exist?("/dev/urandom")
-      # OpenSSL transparently seeds the random number generator with
-      # data from /dev/urandom. On platforms where that is not
-      # available, such as Windows, we have to provide OpenSSL with
-      # our own seed. Unfortunately there's no way to provide a
-      # secure seed without OS support, so we'll have to do with
-      # rand() and Time.now.usec().
-      OpenSSL::Random.seed(rand(0).to_s + Time.now.usec.to_s)
-    end
-    data = OpenSSL::BN.rand(2048, -1, false).to_s
-    secret = OpenSSL::Digest::SHA1.new(data).hexdigest
-    app = Vanilla::App.new(ENV['VANILLA_CONFIG'])
-    app.config[:secret] = secret
-    app.config.save!
-    puts "done; cookies are twice baked. BIS-CUIT!"
-  end
-
   desc 'Prepare a new vanilla.rb installation'
   task :setup do
     puts <<-EOM
@@ -67,7 +23,6 @@ thing ever. Lets get started.
 
 EOM
   Rake::Task['vanilla:setup:prepare_files'].invoke
-  Rake::Task['vanilla:generate_secret'].invoke
   Rake::Task['vanilla:setup:load_snips'].invoke
 
   puts <<-EOM
@@ -95,17 +50,25 @@ load 'tasks/vanilla.rake'
 EOF
         f.write rakefile.strip
       end
+      File.open("Gemfile", "w") do |f|
+        gemfile =<<-EOF
+source :rubygems
+
+gem "vanilla", #{Vanilla::VERSION.inspect}
+EOF
+        f.write gemfile.strip
+      end
     end
 
     task :load_snips do
       print "Preparing soup... "
-      system_soup = ::Soup.new(::Soup::Backends::FileBackend.new("soup/system"))
-      system_soup << eval(File.read(File.join(File.dirname(__FILE__), '..', 'vanilla', 'snips', 'system.rb')))
+
+      mkdir_p "soup/system"
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), '..', 'vanilla', 'snips', 'system'), "soup")
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), '..', 'vanilla', 'snips', 'tutorial'), "soup")
+
       dynasnip_soup = ::Soup.new(::Soup::Backends::FileBackend.new("soup/system/dynasnips"))
       Dynasnip.all.each { |ds| dynasnip_soup << ds.snip_attributes }
-      Dir[File.join(File.dirname(__FILE__), '..', 'vanilla', 'snips', '{start,tutorial}.rb')].each do |f|
-        load f
-      end
       puts "the soup is simmering."
     end
   end

data/lib/vanilla/app.rb

@@ -1,6 +1,5 @@
 require 'soup'
 require 'vanilla/request'
-require 'vanilla/authentication'
 require 'vanilla/routes'
 
 # Require the base set of renderers
@@ -13,12 +12,10 @@ module Vanilla
     include Routes
 
     attr_reader :request, :response, :config, :soup
-    attr_accessor :authenticator
 
     def initialize(config_file=nil)
       prepare_configuration(config_file)
       @soup = prepare_soup(config)
-      @authenticator = Vanilla::Authentication::Base.new(self)
     end
 
     # Returns a Rack-appropriate 3-element array (via Rack::Response#finish)

data/lib/vanilla/dynasnips/comments.rb

@@ -1,13 +1,12 @@
 require 'vanilla/dynasnip'
-require 'defensio'
 require 'date'
 
 class Comments < Dynasnip
   usage %|
     Embed comments within snips!
-    
+
     {comments <false>}
-    
+
     This will embed a list of comments, and a comment form, in a snip
     If the snip is being rendered within another snip, it will show a link to the snip,
     with the number of comments. Add a parameter to disable new comments.
@@ -25,29 +24,23 @@ class Comments < Dynasnip
     end
     return comments_html
   end
-  
+
   def post(*args)
     snip_name = app.request.params[:snip]
     existing_comments = app.soup.with(:commenting_on => snip_name)
     comment = app.request.params.reject { |k,v| ![:author, :email, :website, :content].include?(k) }
-    
+
     return "You need to add some details!" if comment.empty?
-    
-    comment = check_for_spam(comment)
-    
-    if comment[:spam]
-      "Sorry - your comment looks like spam, according to Defensio :("
-    else
-      return "No spam today, thanks anyway" unless app.request.params[:human] == 'human'
-      app.soup << comment.merge({
-       :name => "#{snip_name}-comment-#{existing_comments.length + 1}", 
-       :commenting_on => snip_name,
-       :created_at => Time.now
-      })
-      "Thanks for your comment! Back to {link_to #{snip_name}}"
-    end
+    return "No spam today, thanks anyway" unless app.request.params[:human] == 'human'
+
+    app.soup << comment.merge({
+     :name => "#{snip_name}-comment-#{existing_comments.length + 1}",
+     :commenting_on => snip_name,
+     :created_at => Time.now
+    })
+    "Thanks for your comment! Back to {link_to #{snip_name}}"
   end
-  
+
   def render_comments(comments)
     "<h2>Comments</h2><ol class='comments'>" + comments.map do |comment|
       rendered_comment = comment_template.gsub('COMMENT_CONTENT', app.render(comment)).
@@ -60,40 +53,16 @@ class Comments < Dynasnip
         rendered_comment.gsub!('COMMENT_AUTHOR', author)
       end
       rendered_comment
-    end.join + "</ol>"    
-  end
-  
-  def check_for_spam(comment)
-    snip_date = Date.parse(app.soup[app.request.params[:snip]].updated_at)
-    Defensio.configure(app.config[:defensio])
-    defensio_params = {
-      :comment_author_email => comment[:email], 
-      :comment_author => comment[:author], 
-      :comment_author_url => comment[:website],
-      :comment_content => comment[:content],
-      :comment_type => "comment", 
-      :user_ip => app.request.ip, 
-      :article_date => snip_date.strftime("%Y/%m/%d")
-    }
-    audit = Defensio.audit_comment(defensio_params)
-    
-    # Augment the comment hash
-    comment[:user_ip] = app.request.ip
-    comment[:spamminess] = audit["defensio_result"]["spaminess"]
-    comment[:spam] = audit["defensio_result"]["spam"]
-    comment[:defensio_signature] = audit["defensio_result"]["signature"]
-    comment[:defensio_message] = audit["defensio_result"]["message"] if audit["defensio_result"]["message"]
-    comment[:defensio_status] = audit["defensio_result"]["status"]
-    comment
+    end.join + "</ol>"
   end
-  
+
   attribute :comment_template, %{
     <li>
       <p>COMMENT_AUTHOR (COMMENT_DATE)</p>
       <div>COMMENT_CONTENT</div>
     </li>
   }
-  
+
   attribute :comment_form, %{
     <form class="comments" action="/#{snip_name}?snip=SNIP_NAME" method="POST">
       <label>Name: <input type="text" name="author"></input></label>

data/lib/vanilla/dynasnips/index.rb

@@ -2,9 +2,9 @@ require 'vanilla/dynasnip'
 
 class Index < Dynasnip
   def get(*args)
-    list = app.soup.all_snips.sort_by { |a| a.updated_at || Time.at(0) }.reverse.map { |snip|
+    list = app.soup.instance_eval { @backend }.send(:all_snips).sort_by { |a| a.updated_at || Time.at(0) }.reverse.map { |snip|
       "<li>#{link_to snip.name}</li>"
     }
     "<ol>#{list}</ol>"
   end
-end
+end

data/lib/vanilla/request.rb

@@ -36,22 +36,6 @@ module Vanilla
       @rack_request.env["rack.session"]
     end
 
-    def authenticated?
-      @app.authenticator.authenticated?
-    end
-
-    def user
-      @app.authenticator.user
-    end
-
-    def authenticate!
-      @app.authenticator.authenticate!
-    end
-
-    def logout
-      @app.authenticator.logout
-    end
-
     private
 
     def determine_request_uri_parts

data/lib/vanilla/snips/system/layout.snip

@@ -0,0 +1,19 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+  <title>{title}</title>
+  <link rel="stylesheet" type="text/css" media="screen"  href="<%= url_to("system", "css.css") %>" />
+</head>
+<body>
+  <div id="content">
+    <div id="controls">
+      <strong><a href="/">home</a></strong> ::
+      <strong>{link_to_current_snip}</strong>
+    </div>
+    {current_snip}
+  </div>
+</body>
+</html>
+
+:render_as: Erb

data/lib/vanilla/snips/{start.rb → system/start.snip}

@@ -1,6 +1,3 @@
-app = Vanilla::App.new(ENV['VANILLA_CONFIG'])
-start = app.snip(:name => 'start')
-start.content = <<-START
 Welcome to Vanilla.rb
 =============
 
@@ -23,6 +20,6 @@ In fact - I'll include it here for you:
 That was the end of the tutorial snip. We're back in the start snip now. There's also the {link_to test} snip, that might be interesting.
 
 Anyway, welcome.
-START
-start.render_as = "Markdown"
-start.save
+
+
+:render_as: "Markdown"

data/lib/vanilla/snips/system/system.snip

@@ -0,0 +1,17 @@
+You're in the system snip now.
+
+
+:css: |
+  body {
+    font-family: Helvetica;
+    background-color: #666;
+    margin: 0;
+    padding: 0;
+  }
+
+  div#content {
+    width: 800px;
+    margin: 0 auto;
+    background-color: #fff;
+    padding: 1em;
+  }

data/lib/vanilla/snips/tutorial/bad_dynasnip.snip

@@ -0,0 +1,8 @@
+class BadDynasnip
+  def get(*args)
+    raise "Oh no"
+  end
+end
+BadDynasnip
+
+:render_as: Ruby

data/lib/vanilla/snips/tutorial/hello_world.snip

@@ -0,0 +1,20 @@
+class HelloWorld
+  # although the name doesn't need to match the snip name,
+  # it's simple to follow that convention where appropriate
+
+  def handle(name=nil)
+    if name
+      "Hey \#{name} - Hello World!"
+    else
+      "Hello World!"
+    end
+  end
+
+  # note that this code must evaluate to a class. One way of achieving that is by 
+  # putting 'self' at the end of the class definition.
+  self
+end
+# Another way is by referring to the class at the end of the content. Either works fine.
+HelloWorld
+
+:render_as: Ruby

data/lib/vanilla/snips/tutorial/markdown_example.snip

@@ -0,0 +1,13 @@
+
+# testing header
+
+so, how are you?
+
+- item one
+- item two
+- item three
+
+
+what the *hell* are looking at, [beyotch](http://example.com)?
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/snip.snip

@@ -0,0 +1,9 @@
+A snip is the basic building block of information for {link_to vanilla-rb}. Essentially, it is a piece of content with arbitrary attributes. Vanilla anticipates the presence of some key attributes:
+
+ * `name` - the name of the snip, which is how it will be referred to. The `name` of this snip is _snip_.
+ * `content` - the default part of the snip to render. You can see the `content` of this snip <a href="/snip/content.raw">here</a>.
+ * `render_as` - the name of the renderer to use when rendering the content. The `render_as` of this snip is {snip.render_as}.
+
+One implementation of the snip store is {link_to soup}.
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/soup.snip

@@ -0,0 +1,5 @@
+Soup is a data store supporting the {link_to snip}-space that {link_to vanilla-rb} expects.
+
+It's hosted on github <a href="http://github.com/lazyatom/soup">here</a>.
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/test.snip

@@ -0,0 +1,30 @@
+Linking is good: {link_to bold}
+Here's a bold snip: {bold}
+
+- Here's a random number between 5 and 15: {rand 5,15}
+- Here's a random number between 1 and 90 (the default min): {rand 90}
+- Here's a random number between 1 and 100 (the default range): {rand}
+
+And lets include some textile: 
+
+{textile_example}
+
+The source for that was 
+
+{pre textile_example}
+
+And lets include some markdown!: 
+
+{markdown_example}
+
+The source for that was 
+
+{pre markdown_example}
+
+How about some {link_to debug} information: {debug}
+
+What about a missing snip? Lets try to include one: {monkey}
+
+And an error when running? {bad_dynasnip}
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/textile_example.snip

@@ -0,0 +1,11 @@
+
+# testing lists
+# because lists are common things
+
+monkey
+
+what the *hell* are __you__ looking at?
+
+"Beyotch":http://example.com
+
+:render_as: Textile

data/lib/vanilla/snips/tutorial/tutorial-another-snip.snip

@@ -0,0 +1 @@
+this is another snip!

data/lib/vanilla/snips/tutorial/tutorial-basic-snip-inclusion.snip

@@ -0,0 +1 @@
+This is a snip, which includes another {link_to snip}: {tutorial-another-snip}

data/lib/vanilla/snips/tutorial/vanilla-rb-tutorial.snip

@@ -0,0 +1,73 @@
+Basic Concepts
+------------
+
+Firstly, open the raw contents of this snip - either in your edit (search for 'vanilla-rb-tutorial.snip'), or by opening <a href="vanilla-rb-tutorial.raw">this snip in raw format</a> in a new window or tab. Ready? OK.
+
+Every piece of information displayed here is stored as a {link_to snip}. Snips, within their contents, can also reference other snips. When you request a snip, it will render into a page (or another kind of response), and also render any snips that it internally references.
+
+For example, consider the snip {link_to tutorial-basic-snip-inclusion}:
+
+{raw tutorial-basic-snip-inclusion}
+
+When this snip is rendered, it appears like this:
+
+{tutorial-basic-snip-inclusion}
+
+Notice the use of curly brackets to reference one snip from inside another. Vanilla.rb finds these references to snips, then renders that snip and replaces it in the first snip. Neat!
+
+Renderers
+--------
+
+The way that a snip is rendered depends on whether or not it has a `render_as` attribute set. For instance, the `render_as` property of this snip is "Markdown". Scroll to the bottom of the raw snip you opened earlier, and you'll see this being declared.
+
+This means that the `content` of this snip will be passed through `Vanilla::Renderers::Markdown` before it is then rendered to the page. There are several different renders provided by Vanilla.rb at the moment:
+
+  * Markdown - as described above
+  * Textile - which performs similarly for Textile. This means that you can mix how you write the content of snips!
+  * Raw - which simply returns the content of the snip, as-is. If you attach a `.raw` extension to this url, you'll see it in action
+  * Bold - simply wraps the content in bold. It's a demo, essentially.
+  * Erb - passes the snip contents through Ruby's `Erb` library. It also makes some information available for use by ruby code within the snip's contents
+  * Ruby - parses the snips content as Ruby itself.
+
+It's using this last renderer that a second concept of Vanilla is implemented - dynasnips.
+
+
+Dynasnips
+--------
+
+Because the curly braces simply cause a snip to be rendered, we can use this in conjunction with the Ruby renderer to run actual code. For instance, in the snip above:
+
+{raw tutorial-basic-snip-inclusion}
+
+we can see a reference to the `link_to` snip - <tt>&#123;link\_to snip&#125;</tt>.
+
+Lets look at the raw content of `link_to`:
+
+{raw link_to}
+
+As you can see, it simply refers to the Ruby class `LinkTo`, which is contained within the vanilla-rb codebase. When the Ruby renderer is called, expects the given code to evaulate to a Ruby class. It then instantiates the class, and calls a `handle` method on the instance, passing it any other arguments from the snip inclusion. So, in the case of <tt>&#123;link\_to snip&#125;</tt>, the only argument is `snip`.
+
+Vanilla.rb includes a number of dynasnips by default. Here are a couple:
+
+  * `rand`, which generates a random number (a silly demo really); {link_to rand}, or an example: {rand}
+  * `link_to`, to produce a link to another snip
+  * `kind`, which selects and renders sets of snips based on their `kind` attribute (this is how the blog is currently implemented)
+  * `raw`, which displays the raw contents of a snip
+  * `index`, which shows all of the available snips: {link_to index}
+  * ... and several others.
+
+While dynasnip classes can be provided as part of the vanilla codebase, it's envisioned that much of these will be created by end users in their own sites, either by refering to local classes, or defining the classes directly as the content. Here's an example of that, as the raw content of hello_world:
+
+{raw hello_world}
+
+which, when rendered, gives:
+
+{hello_world}
+
+Note that the `handle` method can take one (optional) argument. Lets try including it with <tt>&#123;hello\_world Dave&#125;</tt>:
+
+{hello_world Dave}
+
+Anyway - that should be enough to get you started.
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/vanilla-rb.snip

@@ -0,0 +1,16 @@
+Vanilla.rb is the software powering this site. It's a sort-of wiki/bliki thing, based on {link_to vanilla}.
+
+Here's the [introductory blog post][3].
+
+It's developed on [github][1], and has a [lighthouse bug tracker][2]. At the moment it's not very well documented, since I'm exploring how the concept might work and the internals are subject to change. However, please do play around with it.
+
+Here's the tutorial (helpfully included from {link_to vanilla-rb-tutorial}).
+
+{vanilla-rb-tutorial}
+
+
+[1]: http://github.com/lazyatom/vanilla
+[2]: http://lazyatom.lighthouseapp.com/projects/11797-vanilla/tickets
+[3]: http://interblah.net/introducing-vanilla-rb
+
+:render_as: Markdown

data/lib/vanilla/snips/tutorial/vanilla.snip

@@ -0,0 +1,8 @@
+The bliki upon which {link_to vanilla-rb} is based, writen by [Christian Langreiter][1]
+
+[Official Web HQ][2]
+
+[1]: http://www.langreiter.com
+[2]: http://www.vanillasite.at
+
+:render_as: Markdown

data/lib/vanilla.rb

@@ -1,5 +1,9 @@
 require 'vanilla/app'
 
+module Vanilla
+  VERSION = "1.13.1"
+end
+
 # Load all the other renderer subclasses
 Dir[File.join(File.dirname(__FILE__), 'vanilla', 'renderers', '*.rb')].each { |f| require f }  
 

data/test/tmp/config.yml

@@ -1,2 +1,2 @@
 --- 
-:soup: /Users/james/Dropbox/Code/vanilla-rb/test/tmp/soup
+:soup: /Users/james/Code/lazyatom/vanilla-rb/test/tmp/soup

data/test/tmp/soup/current_snip.snip

@@ -1,7 +1,5 @@
 CurrentSnip
 
-:render_as: Ruby
-:name: current_snip
 :usage: |-
   The current_snip dyna normally returns the result of rendering the snip named by the 
       'snip' value in the parameters. This way, it can be used in templates to place the currently
@@ -12,3 +10,5 @@ CurrentSnip
         {current_snip name}
         
       will output the name of the current snip, or the name of the snip currently being edited.
+:name: current_snip
+:render_as: Ruby