renee-core 0.1.1 → 0.2.0

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

@@ -59,6 +59,7 @@ class Renee
           end
         end
 
+        private
         def chain(blk, &proxy)
           blk ? yield(blk) : ChainingProxy.new(self, proxy)
         end

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

@@ -80,7 +80,7 @@ class Renee
           when Integer then Renee::Core::Response.new("Status code #{response}", response).finish
           when Symbol  then interpret_response(HTTP_CODES[response] || response.to_s)
           when Proc    then instance_eval(&response)
-          else              interpret_response(response.to_s)
+          else              raise "Unable to render #{response.inspect}"
           end
         end
 

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

@@ -43,7 +43,7 @@ class Renee
         end
         chain_method :exact_path
 
-        # Like #path, doesn't look for leading slashes.
+        # Like #path, but doesn't look for leading slashes.
         def part(p, &blk)
           p = /\/?#{Regexp.quote(p)}/ if p.is_a?(String)
           if match = env['PATH_INFO'][p]
@@ -196,7 +196,7 @@ class Renee
         # Match only when the path has been completely consumed.
         #
         # @example
-        #   delete { halt [200, {}, "hello world"] }
+        #   complete { halt [200, {}, "hello world"] }
         #
         # @api public
         def complete(&blk)

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

@@ -1,6 +1,9 @@
 class Renee
   class Core
     class Application
+      # Module used for transforming arbitrary values using the registerd variable types.
+      # @see #register_variable_name.
+      #
       module Transform
         # Transforms a value according to the rules specified by #register_variable_name.
         # @param [Symbol] name The name of the variable type.

data/lib/renee-core/matcher.rb

@@ -1,32 +1,39 @@
 class Renee
   class Core
-    # @private
+    # Class used for variable matching.
     class Matcher
       attr_accessor :name
 
+      # @param [Regexp] matcher The regexp matcher to determine what is part of the variable.
       def initialize(matcher)
         @matcher = matcher
       end
 
+      # Used to specific the error handler if the matcher doesn't match anything. By default, there is no error handler.
+      # @yield The block to be executed it fails to match.
       def on_error(&blk)
         @error_handler = blk
         self
       end
 
+      # Used to transform the value matched.
+      # @yield TODO
       def on_transform(&blk)
         @transform_handler = blk
         self
       end
 
-      def transform(val)
-        val
-      end
-
+      # Convienence method to creating halting error handler.
+      # @param [Symbol, Integer] error_code The HTTP code to halt with.
+      # @see #interpret_response
       def raise_on_error!(error_code = :bad_request)
         on_error { halt error_code }
         self
       end
 
+      # Matcher for string
+      # @param [String] val The value to attempt to match on.
+      # @raise [ClientError] If the match fails to match and there is an error handler defined.
       def [](val)
         match = nil
         case @matcher
@@ -47,6 +54,8 @@ class Renee
         end
       end
     end
+
+    # Matcher for Integers
     IntegerMatcher = Matcher.new(/\d+/).on_transform{|v| Integer(v)}
   end
 end

data/lib/renee-core/settings.rb

@@ -12,11 +12,12 @@ class Renee
       def initialize
         @includes = []
         @variable_types = {}
+        @encoding = 'utf-8'
         register_variable_type :integer, IntegerMatcher
         register_variable_type :int, :integer
       end
 
-      # Get or sets the views_path for an application.
+      # Gets or sets the views_path for an application.
       #
       # @param [String] path The path to the view files.
       #
@@ -29,7 +30,15 @@ class Renee
         path ? @views_path = path : @views_path
       end
 
+      # Gets or sets the default encoding used.
+      #
+      # @param [String] encoding The encoding to use. e.g. "utf-8"
+      def default_encoding(encoding = nil)
+        encoding ? @encoding = encoding : @encoding
+      end
+
       # Module(s) to include into the base application.
+      #
       # @param [Module] mods Modules to include.
       def include(*mods)
         mods.each { |mod| includes << mod }

data/lib/renee-core/version.rb

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

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: renee-core
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.1.1
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Hull
@@ -12,63 +17,88 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-19 00:00:00 Z
+date: 2011-10-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rack
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
+  requirement: *id001
   type: :runtime
   prerelease: false
-  version_requirements: *id001
+  name: rack
 - !ruby/object:Gem::Dependency 
-  name: minitest
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
         version: 2.6.1
+  requirement: *id002
   type: :development
   prerelease: false
-  version_requirements: *id002
+  name: minitest
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
         version: 1.0.10
+  requirement: *id003
   type: :development
   prerelease: false
-  version_requirements: *id003
+  name: bundler
 - !ruby/object:Gem::Dependency 
-  name: rack-test
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
         version: 0.5.0
+  requirement: *id004
   type: :development
   prerelease: false
-  version_requirements: *id004
+  name: rack-test
 - !ruby/object:Gem::Dependency 
-  name: rake
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
+  requirement: *id005
   type: :development
   prerelease: false
-  version_requirements: *id005
+  name: rake
 description: The super-friendly rack helpers.
 email: 
 - joshbuddy@gmail.com
@@ -119,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4467242971935136938
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -128,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4467242971935136938
+      hash: 3
       segments: 
       - 0
       version: "0"