renee-core 0.1.0 → 0.1.1

data/.yardopts

@@ -1,4 +1,4 @@
---output-dir ../doc/core
+--output-dir ../../renee-site/public/doc/core
 --readme README.md
 --no-private
 --title Renee Core

data/Rakefile

@@ -1,4 +1,3 @@
-require "bundler/gem_tasks"
 require 'rake/testtask'
 require 'yard'
 

data/lib/renee-core/application/chaining.rb

@@ -3,8 +3,18 @@ require 'set'
 class Renee
   class Core
     class Application
+      # Module for creating chainable methods. To use this within your own modules, first `include Chaining`, then,
+      # mark methods you want to be available with `chain_method :method_name`.
+      # @example
+      #    module MoreRoutingMethods
+      #      include Chaining
+      #      def other_routing_method
+      #        # ..
+      #      end
+      #      chain_method :other_routing_method
+      #
       module Chaining
-        private
+        # @private
         class ChainingProxy
           def initialize(target, proxy_blk)
             @target, @proxy_blk, @calls = target, proxy_blk, []
@@ -34,6 +44,7 @@ class Renee
           end
         end
 
+        # @private
         module ClassMethods
           def chain_method(*methods)
             methods.each do |m|

data/lib/renee-core/application/rack_interaction.rb

@@ -12,6 +12,11 @@ class Renee
           run Rack::Builder.new(&blk).to_app
         end
 
+        # Creates an ad-hoc Rack application within the context of a Rack::Builder that immediately halts when done.
+        # @see #run!
+        # @example
+        #     get { halt build { use Rack::ContentLength; run proc { |env| Rack::Response.new("Hello!").finish } } }
+        #
         def build!(&blk)
           run! build(&blk)
         end
@@ -25,7 +30,7 @@ class Renee
           (app || blk).call(env)
         end
 
-        # Runs a rack application and responds immediately.
+        # Runs a rack application and halts immediately.
         #
         # @see #run
         # @example

data/lib/renee-core/application/routing.rb

@@ -54,8 +54,7 @@ class Renee
 
         # Match parts off the path as variables. The parts matcher can conform to either a regular expression, or be an Integer, or
         # simply a String.
-        # @param[Object] type the type of object to match for. If you supply Integer, this will only match integers in addition to
-        #                     casting your variable for you.
+        # @param[Object] type the type of object to match for. If you supply Integer, this will only match integers in addition to casting your variable for you.
         # @param[Object] default the default value to use if your param cannot be successfully matched.
         #
         # @example
@@ -83,6 +82,9 @@ class Renee
         alias_method :var, :variable
         chain_method :variable, :var
 
+        # Same as variable except you can match multiple variables with the same type.
+        # @param [Range, Integer] count The number of parameters to capture.
+        # @param [Symbol] type The type to use for match.
         def multi_variable(count, type = nil, &blk)
           complex_variable(type, '/', count, &blk)
         end
@@ -90,6 +92,8 @@ class Renee
         alias_method :mvar, :multi_variable
         chain_method :multi_variable, :multi_var, :mvar
 
+        # Same as variable except it matches indefinitely.
+        # @param [Symbol] type The type to use for match.
         def repeating_variable(type = nil, &blk)
           complex_variable(type, '/', nil, &blk)
         end

data/lib/renee-core/application/transform.rb

@@ -2,6 +2,10 @@ class Renee
   class Core
     class Application
       module Transform
+        # Transforms a value according to the rules specified by #register_variable_name.
+        # @param [Symbol] name The name of the variable type.
+        # @param [String] value The value to transform.
+        # @return The transformed value or nil.
         def transform(type, value)
           if settings.variable_types.key?(type) and m = settings.variable_types[type][value]
             m.first == value ? m.last : nil

data/lib/renee-core/exceptions.rb

@@ -1,8 +1,12 @@
 class Renee
   class Core
+    # Used to indicate a client-error has occurred (e.g. 4xx)
     class ClientError < StandardError
       attr_reader :response
-      def initialize(message, response = nil)
+
+      # @param [String] message The message for this exception.
+      # @yield The optional block to instance-eval in the case this error is raised.
+      def initialize(message, &response)
         super(message)
         @response = response
       end

data/lib/renee-core/matcher.rb

@@ -1,5 +1,6 @@
 class Renee
   class Core
+    # @private
     class Matcher
       attr_accessor :name
 
@@ -42,7 +43,7 @@ class Renee
         if match
           match
         elsif @error_handler
-          raise ClientError.new("There was an error interpreting the value #{val.inspect} for #{name.inspect}", @error_handler)
+          raise ClientError.new("There was an error interpreting the value #{val.inspect} for #{name.inspect}", &@error_handler)
         end
       end
     end

data/lib/renee-core/settings.rb

@@ -29,10 +29,16 @@ class Renee
         path ? @views_path = path : @views_path
       end
 
-      def include(mod)
-        includes << mod
+      # Module(s) to include into the base application.
+      # @param [Module] mods Modules to include.
+      def include(*mods)
+        mods.each { |mod| includes << mod }
       end
 
+      # Registers a new variable type for use within {Renee::Application::Routing#variable} and others.
+      # @param [Symbol] name The name of the variable.
+      # @param [Regexp] matcher A regexp describing what part of an arbitrary string to capture.
+      # @return [Renee::Core::Matcher] A matcher
       def register_variable_type(name, matcher)
         matcher = case matcher
         when Matcher then matcher

data/lib/renee-core/url_generation.rb

@@ -62,7 +62,7 @@ class Renee
         generator = url_generators[name]
         generator ? generator.url(*args) : raise("Generator for #{name} doesn't exist")
       end
-
+      
       private
       def url_generators
         @url_generators ||= {}
@@ -72,7 +72,6 @@ class Renee
         @generation_defaults && defaults ? @generation_defaults.merge(defaults) : (defaults || @generation_defaults)
       end
 
-      # Manages generating paths and urls for a given name.
       # @private
       class Generator
         attr_reader :defaults

data/lib/renee-core/version.rb

@@ -1,5 +1,6 @@
 class Renee
   class Core
-    VERSION = "0.1.0"
+    # Current Renee-core version number.
+    VERSION = "0.1.1"
   end
 end

data/lib/renee-core.rb

@@ -7,7 +7,7 @@ require 'renee-core/application'
 require 'renee-core/url_generation'
 require 'renee-core/exceptions'
 
-# Renee top-level constant
+# Top-level Renee constant
 class Renee
   # The top-level class for creating core application.
   # For convience you can also used a method named #Renee
@@ -19,14 +19,18 @@ class Renee
   class Core
     include URLGeneration
 
-    attr_reader :application_block, :settings
+    # The application block used to initialize this application.
+    attr_reader :application_block
+    # The {Settings} object used to initialize this application. 
+    attr_reader :settings
 
     # @param [Proc] application_block The block of code that will be executed on each invocation of call #call.
     #                                 Each time #call is called, a new instance of {Renee::Core::Application} will
     #                                 be created. The block given will be #instance_eval 'd within
     #                                 the context of that new instance.
     #
-    def initialize(&application_block)
+    def initialize(base_application_class = Application, &application_block)
+      @base_application_class = base_application_class
       @application_block = application_block
       @settings = Settings.new
     end
@@ -40,9 +44,8 @@ class Renee
     # @see http://rack.rubyforge.org/doc/SPEC.html
     #
     def call(env)
-      Application.new(settings, &application_block).call(env)
+      application_class.new(settings, &application_block).call(env)
     end
-    alias_method :[], :call
 
     ##
     # Configure settings for your Renee application. Accepts a settings file path
@@ -62,5 +65,14 @@ class Renee
       end
       self
     end
+
+    private
+    def application_class
+      @application_class ||= begin
+        app_cls = Class.new(@base_application_class)
+        settings.includes.each { |inc| app_cls.send(:include, inc) }
+        app_cls
+      end
+    end
   end
 end

data/renee-core.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Renee::Core::VERSION
   s.authors     = ["Josh Hull", "Nathan Esquenazi", "Arthur Chiu"]
   s.email       = ["joshbuddy@gmail.com", "nesquena@gmail.com", "mr.arthur.chiu@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{The super-friendly rack helpers.}
+  s.homepage    = "http://reneerb.com"
+  s.summary     = %q{The super-friendly rack helpers}
   s.description = %q{The super-friendly rack helpers.}
 
   s.rubyforge_project = "renee"

data/test/include_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../test_helper', __FILE__)
+
+describe "Route::Settings#include" do
+  it "should allow the inclusion of arbitrary modules" do
+    type = { 'Content-Type' => 'text/plain' }
+    @app = Renee::Core.new {
+      halt :ok if respond_to?(:hi)
+    }.setup {
+      include Module.new { def hi; end }
+    }
+    get '/'
+    assert_equal 200,   response.status
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: renee-core
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Josh Hull
@@ -84,7 +84,6 @@ files:
 - .yardopts
 - README.md
 - Rakefile
-- ideal.rb
 - lib/renee-core.rb
 - lib/renee-core/application.rb
 - lib/renee-core/application/chaining.rb
@@ -101,12 +100,13 @@ files:
 - lib/renee-core/version.rb
 - renee-core.gemspec
 - test/chaining_test.rb
+- test/include_test.rb
 - test/responding_test.rb
 - test/routing_test.rb
 - test/test_helper.rb
 - test/url_generation_test.rb
 - test/variable_type_test.rb
-homepage: ""
+homepage: http://reneerb.com
 licenses: []
 
 post_install_message: 
@@ -119,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2644091870970264113
+      hash: 4467242971935136938
       segments: 
       - 0
       version: "0"
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2644091870970264113
+      hash: 4467242971935136938
       segments: 
       - 0
       version: "0"
@@ -138,9 +138,10 @@ rubyforge_project: renee
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: The super-friendly rack helpers.
+summary: The super-friendly rack helpers
 test_files: 
 - test/chaining_test.rb
+- test/include_test.rb
 - test/responding_test.rb
 - test/routing_test.rb
 - test/test_helper.rb

data/ideal.rb

@@ -1,49 +0,0 @@
-require 'rubygems'
-require 'benchmark'
-
-$: << 'lib'
-require 'renee'
-
-router = Renee::Core.new {
-  path 'test/time' do
-    query_string 'ok' do
-      get { halt "ok" }
-      post { halt [200, {}, ['POSTED!']] }
-    end
-  end
-  variable do |id1, id2|
-    path 'more' do
-      get {
-        halt [200, {}, "this is the id1: #{id1} id2: #{id2}" ]
-      }
-    end
-  end
-  remainder do |rest|
-    halt "the rest is #{rest}"
-  end
-}.setup {
-  view_path('views')
-  environment(:development)
-}
-
-app = Renee do
-  path "add" do
-    variable Integer do |first, second|
-      "#{first} + #{second} = #{first + second}"
-    end
-  end
-end
-
-p router.call(Rack::MockRequest.env_for('/add/3/4')) # => "3 + 4 = 7"
-
-p router.call(Rack::MockRequest.env_for('/test/time?ok'))
-p router.call(Rack::MockRequest.env_for('/test/josh/more'))
-p router.call(Rack::MockRequest.env_for('/'))
-
-
-#puts Benchmark.measure {
-  #50_000.times do
-#    router.call(Rack::MockRequest.env_for('/test/josh/more'))
-    #router.call(Rack::MockRequest.env_for('/test/time?ok', :method => 'POST' ))  
-  #end
-#}