RubyGems - rackful - Versions diffs - 0.1.2 → 0.1.3 - Mend

rackful 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

data/example/config.ru +6 -3
data/lib/rackful.rb +6 -6
data/lib/{rackful_http_status.rb → rackful/http_status.rb} +39 -42
data/lib/rackful/middleware.rb +3 -0
data/lib/rackful/{header_spoofing.rb → middleware/header_spoofing.rb} +4 -5
data/lib/rackful/{method_spoofing.rb → middleware/method_spoofing.rb} +0 -1
data/lib/rackful/{relative_location.rb → middleware/relative_location.rb} +0 -1
data/lib/rackful/path.rb +179 -0
data/lib/{rackful_request.rb → rackful/request.rb} +6 -15
data/lib/{rackful_resource.rb → rackful/resource.rb} +125 -101
data/lib/{rackful_serializer.rb → rackful/serializer.rb} +159 -80
data/lib/{rackful_server.rb → rackful/server.rb} +3 -8
data/rackful.gemspec +3 -3
metadata +57 -55
data/example/config2.ru +0 -41
data/lib/rackful_path.rb +0 -119

data/lib/{rackful_serializer.rb → rackful/serializer.rb} RENAMED Viewed

@@ -16,59 +16,54 @@ module Rackful
 Base class for all serializers.
 The default serializers defined in this library ({Rackful::XHTML} and {Rackful::JSON})
-depend on the availability of method {Rackful::Resource#to_rackful.}
+depend on the availability of method {Rackful::Resource#to_rackful}.
 @abstract Subclasses must implement method `#each` end define constant
   `CONTENT_TYPES`
-@since 0.1.0
 =end
 class Serializer
   include Enumerable
   attr_reader :resource, :content_type
-  # @since 0.1.0
   def initialize resource, content_type
     @resource, @content_type = resource, content_type
   end
 =begin markdown
 Every serializer must implement this method.
 @abstract
-@since 0.1.0
 @yield [data] the entity body
 =end
   def each
-    raise HTTP500InternalServerError, "Class #{self.class} doesn't implement #each()."
+    raise "Class #{self.class} doesn't implement #each()."
   end
-=begin markdown
-You don't have to include the `Content-Type` header, as this is done _for_ you.
-This method is optional.
+=begin markdown
 @!method headers()
-@return [Hash, nil]
-@abstract
-@since 0.1.0
-=end
+  Extra response headers that a serializer likes to return.
+  You don't have to include the `Content-Type` header, as this is done _for_ you.
-=begin markdown
-The content types this serializer can produce.
-@!const CONTENT_TYPES
-@return [(String)]
-@abstract
-@since 0.1.0
+  This method is optional.
+  @return [Hash, nil]
+  @abstract
 =end
 end # class Serializer
 =begin markdown
-@since 0.1.0
 =end
 class XHTML < Serializer
   # The content types served by this serializer.
   # @see Serializer::CONTENT_TYPES
   CONTENT_TYPES = [
@@ -79,21 +74,9 @@ class XHTML < Serializer
   ]
-  # Turns a relative URI (starting with `/`) into a relative path (starting with `./`)
-  # @param path [Path]
-  # @return [String]
-  # @since 0.1.0
-  def htmlify path
-    @rackful_bp ||= Request.current.base_path # caching
-    length = @rackful_bp.length
-    if @rackful_bp == path[0, length]
-      './' + path[length .. -1]
-    else
-      path.dup
-    end
-  end
+=begin
+@yieldparam xhtml [String]
+=end
   def each &block
     request = Request.current
     if /xml/ === self.content_type
@@ -105,15 +88,16 @@ EOS
 <!DOCTYPE html>
 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xs="http://www.w3.org/2001/XMLSchema">
 <head>
+<title>#{ Rack::Utils.escape_html(resource.title) }</title>
 EOS
-    unless request.path == request.content_path
+    #~ unless request.path == request.content_path
       yield <<EOS
-<base href="#{request.base_path}"/>
+<base href="#{request.base_path.relative request.path}"/>
 EOS
-    end
+    #~ end
     unless '/' == request.path
       yield <<EOS
-<link rel="contents" href="#{File::dirname(request.path).to_path.slashify}"/>
+<link rel="contents" href="#{'/' === request.content_path[-1] ? '../' : './' }"/>
 EOS
     end
     yield header + '<div id="rackful_content">'
@@ -121,61 +105,131 @@ EOS
     yield '</div>' + footer
   end
   # Look at the source code!
   def header
-    "<title>#{ Rack::Utils.escape_html(resource.title) }</title></head><body>"
+    self.class.class_variable_defined?( :@@header ) && @@header ?
+      @@header.call( self ) :
+      "</head><body>"
   end
+  def self.header &block
+    @@header = block
+    self
+  end
   # Look at the source code!
   def footer
-    '<div class="rackful_powered">Powered by <a href="http://github.com/pieterb/Rackful">Rackful</a></div></body></html>'
+    self.class.class_variable_defined?( :@@footer ) && @@footer ?
+      @@footer.call( self ) :
+      '<div class="rackful_powered">Powered by <a href="http://github.com/pieterb/Rackful">Rackful</a></div></body></html>'
   end
-  # Serialize almost any kind of Ruby object to XHTML.
+  def self.footer &block
+    @@footer = block
+    self
+  end
+=begin markdown
+Serializes many kinds of objects to XHTML.
+How an object is serialized, depends:
+*   A *{Resource}* will be serialized by its own
+    {Resource#serializer serializer}.
+*   A *{Path}* will be serialized as a hyperlink.
+*   An Object responding to *`#each_pair`* (i.e. something {Hash}-like) will
+    be represented by
+    *   a descriptive list, with
+*   An Object responding to *`#each`* (i.e. something {Enumerable}) will
+    be represented as a JSON array.
+*   A *binary encoded {String}* (i.e. a blob} is represented by a JSON string,
+    containing the base64 encoded version of the data.
+*   A *{Time}* is represented by a string containing a dateTime as defined by
+    XMLSchema.
+*   On *all the rest,* method `#to_json` is invoked.
+@overload each_nested
+  @yieldparam xhtml[String]
+=end
   def each_nested p = self.resource.to_rackful, &block
-    # p = (args.size > 0) ? args[0] : self.resource.to_rackful
-    if p.kind_of?( Path )
-      yield "<a href=\"#{self.htmlify(p)}\">" +
-        Rack::Utils.escape_html( File::basename(p.unslashify).to_path.unescape ) +
-        '</a>'
-    elsif p.kind_of?( Resource ) && ! p.equal?( self.resource )
+    if p.kind_of?( Resource ) && ! p.equal?( self.resource )
       p.serializer( self.content_type ).each_nested &block
-    # elsif p.kind_of?( Hash )
-      # yield '<dl class="rackful_object">'
-      # p.each_pair do
-        # |key, value|
-        # yield '<dt>' + key.to_s.split('_').join(' ').escape_html +
-          # "</dt><dd class=\"rackful_object_#{key.to_s.escape_html}\"#{self.xsd_type(value)}>"
-        # self.each_nested value, &block
-        # yield "</dd>\n"
-      # end
-      # yield '</dl>'
-    elsif p.kind_of?( Enumerable ) and p.respond_to?( :each_pair ) and
-          p.all? { |r, s| r.kind_of?( Path ) }
-      yield '<dl class="rackful-resources">'
-      p.each_pair do
-        |path, child|
-        yield '<dt>'
-        self.each_nested path, &block
-        yield '</dt><dd>'
-        self.each_nested child, &block
-        yield "</dd>\n"
-      end
-      yield '</dl>'
+    elsif p.kind_of?( Path )
+      yield "<a href=\"#{p.relative}\">" +
+        Rack::Utils.escape_html( Rack::Utils.unescape(
+          File::basename(p.unslashify)
+        ) ) + '</a>'
+#     elsif p.kind_of?( Collection )
+#       if p.recurse?
+#         yield '<dl class="rackful-resources">'
+#         p.each_pair do
+#           |path, child|
+#           yield '<dt>'
+#           self.each_nested path, &block
+#           yield "</dt><dd#{self.xsd_type(child)}>"
+#           self.each_nested child, &block
+#           yield "</dd>\n"
+#         end
+#         yield '</dl>'
+      #~ elsif ( q = p.first ) and
+            #~ q.kind_of?( Enumerable )
+              #~ q.respond_to?( :keys ) && ( keys = q.keys ) &&
+              #~ p.all? { |r| r.respond_to?( :keys ) && r.keys == keys }
+            #~ )
+        #~ yield '<table class="rackful-objects"><thead><tr>' +
+          #~ keys.collect {
+            #~ |column|
+            #~ '<th>' +
+            #~ Rack::Utils.escape_html( column.to_s.split('_').join(' ') ) +
+            #~ "</th>\n"
+          #~ }.join + '</tr></thead><tbody>'
+        #~ p.each do
+          #~ |h|
+          #~ yield '<tr>'
+          #~ h.each_pair do
+            #~ |key, value|
+            #~ yield "<td class=\"rackful-objects-#{Rack::Utils.escape_html( key.to_s )}\"#{self.xsd_type(value)}>"
+            #~ self.each_nested value, &block
+            #~ yield "</td>\n"
+          #~ end
+          #~ yield '</tr>'
+        #~ end
+        #~ yield "</tbody></table>"
+#       else
+#         yield '<ul class="rackful-resources">'
+#         p.each do
+#           |value|
+#           yield "<li#{self.xsd_type(value)}>"
+#           self.each_nested value, &block
+#           yield "</li>\n"
+#         end
+#         yield '</ul>'
+#       end
     elsif p.respond_to?( :each_pair )
-      yield '<dl class="rackful-object">'
+      yield '<br/><dl class="rackful-object">'
       p.each_pair do
-        |path, child|
-        yield '<dt>'
-        self.each_nested path, &block
-        yield '</dt><dd>'
-        self.each_nested child, &block
+        |key, value|
+        yield "<dt#{self.xsd_type(key)}>"
+        self.each_nested key, &block
+        yield "</dt><dd#{self.xsd_type(value)}>"
+        self.each_nested value, &block
         yield "</dd>\n"
       end
       yield '</dl>'
-    elsif p.kind_of?( Enumerable ) and ( q = p.first ) and (
-            q.respond_to?(:keys) && ( keys = q.keys ) &&
-            p.all? { |r| r.respond_to?(:keys) && r.keys == keys }
+    elsif p.kind_of?( Enumerable ) and
+          ( q = p.first ) and
+          (
+            q.respond_to?( :keys ) && ( keys = q.keys ) &&
+            p.all? { |r| r.respond_to?( :keys ) && r.keys == keys }
           )
       yield '<table class="rackful-objects"><thead><tr>' +
         keys.collect {
@@ -196,6 +250,7 @@ EOS
         yield '</tr>'
       end
       yield "</tbody></table>"
     elsif p.kind_of?( Enumerable )
       yield '<ul class="rackful-array">'
       p.each do
@@ -205,12 +260,16 @@ EOS
         yield "</li>\n"
       end
       yield '</ul>'
     elsif p.kind_of?( Time )
       yield p.utc.xmlschema
     elsif p.kind_of?( String ) && p.encoding == Encoding::BINARY
       yield Base64.encode64(p).chomp
     else
       yield Rack::Utils.escape_html( p.to_s )
     end
   end
@@ -251,12 +310,30 @@ class JSON < Serializer
 =begin markdown
-@yield [json]
-@yieldparam json [String]
+Serializes many kinds of objects to JSON.
+How an object is serialized, depends:
+*   A *{Resource}* will be serialized by its own
+    {Resource#serializer serializer}.
+*   A *{Path}* will be serialized by a string, containing the relative path.
+*   An Object responding to *`#each_pair`* (i.e. something {Hash}-like) will
+    be represented as a JSON object.
+*   An Object responding to *`#each`* (i.e. something {Enumerable}) will
+    be represented as a JSON array.
+*   A *binary encoded {String}* (i.e. a blob} is represented by a JSON string,
+    containing the base64 encoded version of the data.
+*   A *{Time}* is represented by a string containing a dateTime as defined by
+    XMLSchema.
+*   On *all the rest,* method `#to_json` is invoked.
+@overload each
+  @yieldparam json [String]
 =end
   def each thing = self.resource.to_rackful, &block
     if thing.kind_of?( Resource ) && ! thing.equal?( self.resource )
       thing.serializer( self.content_type ).each &block
+    elsif thing.kind_of?( Path )
+      yield thing.relative.to_json
     elsif thing.respond_to? :each_pair
       first = true
       thing.each_pair do
@@ -293,6 +370,7 @@ class JSON < Serializer
     self.recursive_datetime_parser r
   end
   def self.recursive_datetime_parser p
     if p.kind_of?(String)
       begin
@@ -316,4 +394,5 @@ class JSON < Serializer
 end # class HTTPStatus::JSON
 end # module Rackful

data/lib/{rackful_server.rb → rackful/server.rb} RENAMED Viewed

@@ -7,7 +7,6 @@ module Rackful
 =begin markdown
 Rack compliant server class for implementing RESTful web services.
-@since 0.0.1
 =end
 class Server
@@ -35,14 +34,12 @@ If there's no resource at the given path, but you'd still like to respond to
 {Resource#empty? empty resource}.
 @return [#[]]
 @see #initialize
-@since 0.0.1
 =end
   attr_reader :resource_factory
 =begin markdown
 @param resource_factory [#[]] see Server#resource_factory
-@since 0.0.1
 =end
   def initialize(resource_factory)
     super()
@@ -56,19 +53,17 @@ As required by the Rack specification.
 For thread safety, this method clones `self`, which handles the request in
 {#call!}. A similar approach is taken by the Sinatra library.
 @return [Array<(status_code, response_headers, response_body)>]
-@since 0.0.1
 =end
   def call(p_env)
     start = Time.now
     retval = dup.call! p_env
-    #$stderr.puts( 'Duration: ' + ( Time.now - start ).to_s )
+    #$stderr.puts( p_env.inspect )
     retval
   end
 =begin markdown
 @return [Array<(status_code, response_headers, response_body)>]
-@since 0.0.1
 =end
   def call!(p_env)
     request = Request.new( self.resource_factory, p_env )
@@ -76,7 +71,7 @@ For thread safety, this method clones `self`, which handles the request in
     Thread.current[:rackful_request] = request
     response = Rack::Response.new
     begin
-      raise HTTP404NotFound \
+      raise HTTP404NotFound, request.path \
         unless resource = self.resource_factory[Path.new(request.path)]
       unless resource.path == request.path
         response.header['Content-Location'] = resource.path
@@ -113,7 +108,7 @@ For thread safety, this method clones `self`, which handles the request in
       response.headers.merge! new_resource.default_headers
     end
     r = response.finish
-    $stderr.puts r.inspect
+    #~ $stderr.puts r.inspect
     r
   end

data/rackful.gemspec CHANGED Viewed

@@ -2,16 +2,16 @@ Gem::Specification.new do |s|
   # Required properties:
   s.name        = 'rackful'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   s.summary     = "Library for building ReSTful web services with Rack"
   s.description = <<EOS
 Rackful provides a minimal interface for developing ReSTful web services with
 Rack and Ruby. Instead of writing HTTP method handlers, you'll implement
 resource objects, which expose their state at URLs.
-This version is NOT backward compatible with versions 0.0.x.
+This version is not backward compatible with v0.0.x.
 EOS
-  s.files       = Dir[ '{*.md,example/*,lib/**/*}' ] +
+  s.files       = Dir[ '{*.md,example/*.ru,lib/**/*.rb}' ] +
                   %w( rackful.gemspec mkdoc.sh )
   # Optional properties:

metadata CHANGED Viewed

@@ -1,88 +1,90 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: rackful
-version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.1.2
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.3
 platform: ruby
-authors:
+authors:
 - Pieter van Beek
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-10-11 00:00:00 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+date: 2012-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
     none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: "1.4"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    none: false
+  prerelease: false
   type: :runtime
-  version_requirements: *id001
-description: |
-  Rackful provides a minimal interface for developing ReSTful web services with
-  Rack and Ruby. Instead of writing HTTP method handlers, you'll implement
+description: ! 'Rackful provides a minimal interface for developing ReSTful web services
+  with
+  Rack and Ruby. Instead of writing HTTP method handlers, you''ll implement
   resource objects, which expose their state at URLs.
-  This version is NOT backward compatible with versions 0.0.x.
+  This version is not backward compatible with v0.0.x.
+  '
 email: rackful@djinnit.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
+files:
 - RACKFUL.md
 - README.md
 - LICENSE.md
 - CHANGES.md
-- example/config2.ru
 - example/config.ru
-- lib/rackful_request.rb
-- lib/rackful_path.rb
-- lib/rackful/method_spoofing.rb
-- lib/rackful/header_spoofing.rb
-- lib/rackful/relative_location.rb
-- lib/rackful_http_status.rb
-- lib/rackful_server.rb
 - lib/rackful.rb
-- lib/rackful_resource.rb
-- lib/rackful_serializer.rb
+- lib/rackful/resource.rb
+- lib/rackful/path.rb
+- lib/rackful/http_status.rb
+- lib/rackful/serializer.rb
+- lib/rackful/server.rb
+- lib/rackful/request.rb
+- lib/rackful/middleware.rb
+- lib/rackful/middleware/method_spoofing.rb
+- lib/rackful/middleware/header_spoofing.rb
+- lib/rackful/middleware/relative_location.rb
 - rackful.gemspec
 - mkdoc.sh
 homepage: http://pieterb.github.com/Rackful/
-licenses:
+licenses:
 - Apache License 2.0
-post_install_message:
+post_install_message:
 rdoc_options: []
-require_paths:
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: "0"
 requirements: []
-rubyforge_project:
+rubyforge_project:
 rubygems_version: 1.8.24
-signing_key:
+signing_key:
 specification_version: 3
 summary: Library for building ReSTful web services with Rack
 test_files: []
-has_rdoc:
+...