renee 0.4.0.pre1 → 0.4.0.pre2

data/Gemfile

@@ -1,17 +1,20 @@
 source :rubygems
 
-gemspec :name => 'renee'
-gemspec :name => 'renee-core'
-gemspec :name => 'renee-render'
+gemspec
 
-gem 'rdiscount'
-gem 'haml'
-gem 'rack-codehighlighter'
-gem 'rack-google-analytics'
-gem 'coderay'
+group :site do
+  gem 'rdiscount'
+  gem 'haml'
+  gem 'rack-codehighlighter'
+  gem 'rack-google-analytics'
+  gem 'coderay'
+end
 
 group :development do
+  gem 'minitest', '~> 2.11.1'
+  gem 'rack-test', '>= 0.5.0'
   gem 'shotgun'
   gem 'rake'
+  gem 'json'
   gem 'yard', '~> 0.7.4'
 end

data/README.md

@@ -1,5 +1,7 @@
 # Renee
 
+[![Build Status](https://secure.travis-ci.org/renee-project/renee.png)](http://travis-ci.org/renee-project/renee)
+
 The super friendly rack-based web framework.
 
 ## Introduction
@@ -132,4 +134,51 @@ run Renee.core {
 ```
 
 This implements the standard 7 REST actions in a very concise and simple way. The routes and the actions blended together utilizing the various
-Renee routing methods and block syntax. The routing methods are defined below, followed by an explanation of how to respond to a route.
+Renee routing methods and block syntax. The routing methods are defined below, followed by an explanation of how to respond to a route.
+
+# Renee Render
+
+Rendering templates in Renee should be familiar and intuitive using the `render` command:
+
+```ruby
+run Renee.core {
+ path('blog') do
+   get { render! "blogs/index", :haml }
+ end
+}
+```
+
+This above is the standard render syntax, specifying the engine followed by the template. You can also render without specifying an engine:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index" }
+end
+```
+
+This will do a lookup in the views path to find the appropriately named template. You can also pass locals and layout options as you would expect:
+
+```ruby
+path('blog') do
+  get { render! "blogs/index", :locals => { :foo => "bar" }, :layout => :bar }
+end
+```
+
+This will render the "blogs/index.erb" file if it exists, passing the 'foo' local variable
+and wrapping the result in the 'bar.erb' layout file. You can also render without returning the response by using:
+
+```ruby
+path('blog') do
+  get { render "blogs/index" }
+end
+```
+
+This allows you to render the content as a string without immediately responding.
+
+# Renee Session
+
+Defines methods for accessing the session.
+
+# Renee URL Generation
+
+The URL generation is pretty nifty.

data/Rakefile

@@ -1,113 +1,23 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'yard'
 
 ROOT = File.expand_path(File.dirname(__FILE__))
 
 task :default => :test
 
-def lsh(cmd, &block)
-  out, code = lsh_with_code(cmd, &block)
-  code == 0 ? out : raise(out.empty? ? "Running `#{cmd}' failed. Run this command directly for more detailed output." : out)
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path("../test/**/*_test.rb", __FILE__)]
+  t.verbose = true
 end
 
-def lsh_with_code(cmd, &block)
-  cmd << " 2>&1"
-  outbuf = ''
-  outbuf = `#{cmd}`
-  if $? == 0
-    block.call(outbuf) if block
-  end
-  [outbuf, $?]
-end
-
-renee_gems = %w[
-  renee-core
-  renee-render
-  renee-url-generation
-  renee-session
-  renee
-].freeze
-
-desc "build #{renee_gems.join(', ')} gems"
-task :build do
-  renee_gems.each do |g|
-    lsh "mkdir -p pkg && gem build #{g}.gemspec && mv *.gem pkg"
-    puts "#{g} built"
-  end
-end
-
-task :release => [:build, :yard] do
-  require File.join(ROOT, 'lib', 'renee', 'version')
-  version_tag = "v#{Renee::VERSION}"
-  begin
-    raise("#{version_tag} has already been committed") if lsh('git tag').split(/\n/).include?(version_tag)
-    sh "git tag #{version_tag}"
-    puts "adding tag #{version_tag}"
-    renee_gems.each do |g|
-      sh "gem push pkg/#{g}-#{Renee::VERSION}.gem"
-      puts "#{g} pushed"
-    end
-    sh "git push"
-    sh "git push --tags"
-  rescue
-    puts "something went wrong"
-    sh "git tag -d #{version_tag}"
-    raise
-  end
-end
-
-task :install => :build do
-  require File.join(ROOT, 'lib', 'renee', 'version')
-  renee_gems.each do |g|
-    lsh "gem install pkg/#{g}-#{Renee::VERSION}.gem"
-    puts "#{g} installed"
-  end
-end
-
-task :bundle do
-  renee_gems.each do |g|
-    sh "env BUNDLE_GEMFILE=Gemfile-#{g} bundle"
-  end
-end
-
-renee_gems_tasks = Hash[renee_gems.map{|rg| [rg, :"test_#{rg.gsub('-', '_')}"]}].freeze
-
-desc "Run tests for all renee stack gems"
-task :test do
-  renee_gems_tasks.values.each do |task|
-    Rake::Task[task].invoke
-  end
-end
-
-renee_gems_tasks.each do |g, tn|
-  desc "Run tests for #{g} (shell out)"
-  task tn do
-    sh "env BUNDLE_GEMFILE=Gemfile-#{g} bundle exec rake test-#{g}"
-  end
-
-  Rake::TestTask.new("test-#{g}") do |t|
-    t.libs.push "lib"
-    t.test_files = FileList[File.expand_path("../test/#{g}/**/*_test.rb", __FILE__)]
-    t.verbose = true
-  end
-end
-
-desc "Generate YARD documentation"
-task :'yard' do
-  require 'yard'
-  Dir['*.gemspec'].to_a.each do |gemspec|
-    spec = Gem::Specification.load(gemspec)
-    puts "spec #{spec.inspect}"
-    task_name = :"yard:#{spec.name}"
-    rb_files = spec.files.select{|f| f[/^lib/]}
-    readme = spec.name == 'renee' ? "README.md" : "README-#{spec.name}.md"
-    pid = fork do # yard has some shared state somewhere. poor poor yard.
-      YARD::Rake::YardocTask.new(task_name) do |t|
-        t.options = ['-o', File.expand_path("../site/public/docs/#{spec.name}", __FILE__), '--readme', readme, '--no-private', '--markup', 'markdown']
-        t.files   = rb_files
-      end
-      Rake::Task[task_name].execute
-    end
-    _, status = Process.waitpid2(pid)
-    raise unless status.success?
-  end
+YARD::Rake::YardocTask.new do |t|
+  t.options = [
+    '-o', File.expand_path("../site/public/docs/core", __FILE__),
+    '--readme', 'README.md',
+    '--no-private',
+    '--markup', 'markdown'
+  ]
+  t.files   = 'lib/**/*.rb'
 end

data/config.ru

@@ -1,3 +1,8 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+
 require 'renee'
 require 'haml'
 require 'rdiscount'

data/examples/blog/config.ru

@@ -40,6 +40,7 @@ run Renee {
     end
   end
 }.setup {
+  use Rack::Lint
   use Rack::MethodOverride
   views_path File.expand_path(File.dirname(__FILE__) + "/views")
 }

data/lib/renee.rb

@@ -1,5 +1,6 @@
-require 'renee/version'
 require 'renee/core'
+
+require 'renee/version'
 require 'renee/render'
 require 'renee/session'
 require 'renee/url_generation'
@@ -12,7 +13,7 @@ require 'renee/url_generation'
 #     }
 def Renee(&blk)
   app_class = Class.new(Renee::Application)
-  app_class.app(&blk)
+  app_class.run(&blk)
   app_class
 end
 

data/lib/renee/render.rb

@@ -52,7 +52,7 @@ module Renee
     ##
     # Exception responsible for when an expected template does not exist.
     #
-    class TemplateNotFound < RuntimeError; end
+    TemplateNotFound = Class.new(RuntimeError)
 
     # Same as render but automatically halts.
     # @param  (see #render)

data/lib/renee/url_generation.rb

@@ -8,12 +8,48 @@ module Renee
     # Current version of Renee::URLGeneration
     VERSION = Renee::VERSION
 
+    # @api private
     def self.included(o)
       o.extend(ClassMethods)
     end
 
+    # Generates a url
+    # @see ClassMethods#url
+    def make_url(name, *args)
+      self.class.url(name, *args)
+    end
+
+    # Generates a path
+    # @see ClassMethods#path
+    def make_path(name, *args)
+      self.class.path(name, *args)
+    end
+
     # Class-methods included by this module.
     module ClassMethods
+      def define_url_generation(&blk)
+        url_generator.instance_eval(&blk)
+      end
+
+      private
+      def url_generator
+        @generator ||= GeneratorSet.new
+      end
+    end
+
+    class GeneratorSet
+      attr_accessor :generation_prefix
+
+      def initialize(prefix = '', defaults = nil, generators = {})
+        @url_generators = generators
+        @generation_prefix = prefix
+        @generation_defaults = defaults
+      end
+
+      def defaults_for_generation(defaults)
+        @generation_defaults && defaults ? @generation_defaults.merge(defaults) : (defaults || @generation_defaults)
+      end
+
       # Registers new paths for generation.
       # @param [Symbol] name The name of the path
       # @param [String] pattern The pattern used for generation.
@@ -24,7 +60,7 @@ module Renee
       #     renee.path(:path, 123) # => "/my/123/path"
       #     renee.path(:path, :var => 'hey you') # => "/my/hey%20you/path"
       def register(name, pattern, defaults = nil)
-        url_generators[name] = Generator.new("#{@generation_prefix}#{pattern}", defaults_for_generation(defaults))
+        @url_generators[name] = Generator.new("#{@generation_prefix}#{pattern}", defaults_for_generation(defaults))
       end
 
       # Allows the creation of generation contexts.
@@ -37,13 +73,7 @@ module Renee
       #       renee.register(:prefix_path, "/path") # would register /prefix/path
       #     }
       def prefix(prefix, defaults = nil, &blk)
-        generator = self
-        subgenerator = Class.new {
-          include URLGeneration::ClassMethods
-          define_method(:url_generators) { generator.send(:url_generators) }
-        }.new
-        subgenerator.instance_variable_set(:@generation_prefix, "#{@generation_prefix}#{prefix}")
-        subgenerator.instance_variable_set(:@generation_defaults, defaults_for_generation(defaults))
+        subgenerator = GeneratorSet.new("#{@generation_prefix}#{prefix}", defaults_for_generation(defaults), @url_generators)
         if block_given?
           old_prefix, old_defaults = @generation_prefix, @generation_defaults
           @generation_prefix, @generation_defaults = "#{@generation_prefix}#{prefix}", defaults_for_generation(defaults)
@@ -60,7 +90,7 @@ module Renee
       #
       # @see #register
       def path(name, *args)
-        generator = url_generators[name]
+        generator = @url_generators[name]
         generator ? generator.path(*args) : raise("Generator for #{name} doesn't exist")
       end
 
@@ -68,49 +98,40 @@ module Renee
       # @param (see #path)
       # @see #path
       def url(name, *args)
-        generator = url_generators[name]
+        generator = @url_generators[name]
         generator ? generator.url(*args) : raise("Generator for #{name} doesn't exist")
       end
-    
-      private
-      def url_generators
-        @url_generators ||= {}
-      end
+    end
 
-      def defaults_for_generation(defaults)
-        @generation_defaults && defaults ? @generation_defaults.merge(defaults) : (defaults || @generation_defaults)
-      end
+    # @private
+    class Generator
+      attr_reader :defaults
 
-      # @private
-      class Generator
-        attr_reader :defaults
-
-        def initialize(template, defaults = nil)
-          @defaults = defaults
-          parsed_template = URI.parse(template)
-          @host = parsed_template.host
-          @template = parsed_template.path
-          @scheme = parsed_template.scheme
-          port = parsed_template.port
-          if !port.nil? and (@scheme.nil? or @scheme == "http" && port != '80' or @scheme == "https" && port != '443')
-            @port_part = ":#{port}"
-          end
+      def initialize(template, defaults = nil)
+        @defaults = defaults
+        parsed_template = URI.parse(template)
+        @host = parsed_template.host
+        @template = parsed_template.path
+        @scheme = parsed_template.scheme
+        port = parsed_template.port
+        if !port.nil? and (@scheme.nil? or @scheme == "http" && port != '80' or @scheme == "https" && port != '443')
+          @port_part = ":#{port}"
         end
+      end
 
-        def path(*args)
-          opts = args.last.is_a?(Hash) ? args.pop : nil
-          opts = opts ? defaults.merge(opts) : defaults.dup if defaults
-          path = @template.gsub(/:([a-zA-Z0-9_]+)/) { |name|
-            name = name[1, name.size - 1].to_sym
-            (opts && opts.delete(name)) || (defaults && defaults[name]) || args.shift || raise("variable #{name.inspect} not found")
-          }
-          URI.encode(opts.nil? || opts.empty? ? path : "#{path}?#{Rack::Utils.build_query(opts)}")
-        end
+      def path(*args)
+        opts = args.last.is_a?(Hash) ? args.pop : nil
+        opts = opts ? defaults.merge(opts) : defaults.dup if defaults
+        path = @template.gsub(/:([a-zA-Z0-9_]+)/) { |name|
+          name = name[1, name.size - 1].to_sym
+          (opts && opts.delete(name)) || (defaults && defaults[name]) || args.shift || raise("variable #{name.inspect} not found")
+        }
+        URI.encode(opts.nil? || opts.empty? ? path : "#{path}?#{Rack::Utils.build_query(opts)}")
+      end
 
-        def url(*args)
-          raise "This URL cannot be generated as no host has been defined." if @host.nil?
-          "#{@scheme}://#{@host}#{@port_part}#{path(*args)}"
-        end
+      def url(*args)
+        raise "This URL cannot be generated as no host has been defined." if @host.nil?
+        "#{@scheme}://#{@host}#{@port_part}#{path(*args)}"
       end
     end
   end

data/lib/renee/version.rb

@@ -1,4 +1,4 @@
 module Renee
   # The current version of Renee
-  VERSION = "0.4.0.pre1"
+  VERSION = "0.4.0.pre2"
 end

data/plan.txt

@@ -5,13 +5,9 @@ things to do to make renee more complete
 - authentication
 - admin
 
-things to do to make renee faster
-
-- shorten the callstack in routing, it can get long
-
 things to do to make renee easier to deal with
 
-- fenerators (a la padrino)
+- generators (a la padrino)
 
 things to do to explain it better
 

data/renee.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-$:.push File.expand_path("../../renee-core/lib", __FILE__)
 require "renee/version"
 
 Gem::Specification.new do |s|
@@ -19,11 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'rack', "~> 1.3.0"
+  s.add_runtime_dependency 'rack', ">= 1.3.0"
   s.add_runtime_dependency 'tilt', "~> 1.3.3"
   s.add_runtime_dependency 'callsite', '~> 0.0.6'
+  s.add_runtime_dependency 'renee-core', '0.4.0.pre2'
 
-  s.add_development_dependency 'minitest', "~> 2.6.1"
+  s.add_development_dependency 'minitest', "~> 2.11.1"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'bundler'
   s.add_development_dependency "rack-test", ">= 0.5.0"