iwamot-rupta 0.9.1 → 0.9.2

data/CHANGELOG

@@ -1,3 +1,7 @@
+Rupta 0.9.2 (2009-09-20)
+
+ * restructured whole API
+
 Rupta 0.9.1 (2009-06-25)
 
  * changed the factory method to static

data/README.rdoc

@@ -1,8 +1,8 @@
 = README
 
-== Descrption
+== Description
 
-Rupta is a router library for Web applications. The routes can be defined with {URI Template}[http://bitworking.org/projects/URI-Templates/]. The usage is so simple. See the following examples.
+Rupta is a router library for web applications. The routes can be defined with {URI Template}[http://bitworking.org/projects/URI-Templates/]. The usage is so simple. See the following examples.
 
 == Installation
 
@@ -10,56 +10,61 @@ Rupta is a router library for Web applications. The routes can be defined with {
 
 == Examples
 
-=== examples/fixtures/routes.yml
-
-  bookmark:
-    - http://example.com/bookmarks/{bookmark_id}
-    - http://example.com/bookmarks/{bookmark_id}.{format}
-  static_path:
-    - http://example.com/static_path
-  search:
-    - http://example.com/search
+=== examples/routing.rb
 
-=== examples/routing_with_yaml.rb
-
-  yaml_path = File.expand_path('fixtures/routes.yml', File.dirname(__FILE__))
+  routes = {'bookmark'    => ['http://example.com/bookmarks/{bookmark_id}',
+                              'http://example.com/bookmarks/{bookmark_id}.{format}'],
+            'static_path' => ['http://example.com/static_path'],
+            'search'      => ['http://example.com/search']}
 
   require 'rupta/factory'
-  rupta = Rupta::Factory.create
+  router = Rupta::Factory.new.create
 
-  # Rupta#detect returns the name of a detected route, a matched URI template and extracted URI parameters
-  p rupta.detect(yaml_path, 'http://example.com/bookmarks/123.atom')
-  # => ["user", "http://example.com/bookmarks/{bookmark_id}.{format}", {"bookmark_id"=>"123", "format"=>"atom"}]
+  # Rupta#detect returns the name of a detected route,
+  # a matched URI template and extracted URI parameters
+  p router.detect(route, 'http://example.com/bookmarks/123.atom')
+  # => ["bookmark",
+  #     "http://example.com/bookmarks/{bookmark_id}.{format}",
+  #     {"bookmark_id"=>"123", "format"=>"atom"}]
 
   # if the uri is static, the extracted parameters is empty
-  p rupta.detect(yaml_path, 'http://example.com/static_path')
+  p router.detect(routes, 'http://example.com/static_path')
   # => ["static_path", "http://example.com/static_path", {}]
 
   # query strings are omitted
-  p rupta.detect(yaml_path, 'http://example.com/search?q=foo')
+  p router.detect(routes, 'http://example.com/search?q=foo')
   # => ["search", "http://example.com/search", {}]
 
   # when no route is found, Rupta#detect returns nil
-  p rupta.detect(yaml_path, 'http://example.com/not_found')
+  p router.detect(routes, 'http://example.com/not_found')
   # => nil
 
-=== examples/routing_with_hash.rb
+=== examples/fixtures/routes.yml
 
-  routes = {'bookmark'    => ['http://example.com/bookmarks/{bookmark_id}',
-                              'http://example.com/bookmarks/{bookmark_id}.{format}'],
-            'static_path' => ['http://example.com/static_path'],
-            'search'      => ['http://example.com/search']}
+  bookmark:
+    - http://example.com/bookmarks/{bookmark_id}
+    - http://example.com/bookmarks/{bookmark_id}.{format}
+  static_path:
+    - http://example.com/static_path
+  search:
+    - http://example.com/search
 
-  require 'rupta/factory'
-  rupta = Rupta::Factory.create
+=== examples/routing_with_yaml_file.rb
 
-  # use Rupta#detect_with_hash, if you can create the routes manually
-  p rupta.detect_with_hash(route, 'http://example.com/bookmarks/123.atom')
-  # => ["user", "http://example.com/bookmarks/{bookmark_id}.{format}", {"bookmark_id"=>"123", "format"=>"atom"}]
+  yaml_path = File.expand_path('fixtures/routes.yml', File.dirname(__FILE__))
+
+  # use Rupta::Yaml::Factory, if you define routes in a YAML file
+  require 'rupta/yaml/factory'
+  rupta = Rupta::Yaml::Factory.new.create
+
+  p rupta.detect(yaml_path, 'http://example.com/bookmarks/123.atom')
+  # => ["bookmark",
+  #     "http://example.com/bookmarks/{bookmark_id}.{format}",
+  #     {"bookmark_id"=>"123", "format"=>"atom"}]
 
 == Requirement
 
-Rupta-0.9.1 was tested with Ruby 1.8.7 and 1.9.1.
+Rupta-0.9.2 was tested with Ruby 1.9.1.
 
 == Dependencies
 

data/lib/rupta.rb

@@ -1,11 +1,10 @@
 class Rupta
-  def initialize(uri_purifier, uri_extractor, yaml_loader)
+  def initialize(uri_purifier, uri_extractor)
     @uri_purifier = uri_purifier
     @uri_extractor = uri_extractor
-    @yaml_loader = yaml_loader
   end
 
-  def detect_with_hash(routes, uri, omittable_uri_components = [:query])
+  def detect(routes, uri, omittable_uri_components = [:query])
     pure_uri = @uri_purifier.purify(uri, omittable_uri_components)
     routes.each do |route_name, uri_templates|
       uri_template, uri_parameters = @uri_extractor.extract(uri_templates, pure_uri)
@@ -13,10 +12,4 @@ class Rupta
     end
     nil
   end
-
-  def detect_with_file(yaml_path, uri, omittable_uri_components = [:query])
-    self.detect_with_hash(@yaml_loader.load_file(yaml_path), uri, omittable_uri_components)
-  end
-
-  alias :detect :detect_with_file
 end

data/lib/rupta/factory.rb

@@ -1,16 +1,19 @@
 require 'rupta'
-require 'rupta/uri_extract_processor/default'
-require 'rupta/uri_extractor'
-require 'rupta/uri_purifier'
-require 'rupta/yaml_loader'
+require 'rupta/helper/uri_extract_processor/default'
+require 'rupta/helper/uri_extractor'
+require 'rupta/helper/uri_parser'
+require 'rupta/helper/uri_purifier'
 
 class Rupta
   class Factory
-    def self.create(uri_extract_processor = Rupta::UriExtractProcessor::Default.new)
+    def initialize(uri_extract_processor = Rupta::Helper::UriExtractProcessor::Default.new)
+      @uri_extract_processor = uri_extract_processor
+    end
+
+    def create
       Rupta.new(
-        Rupta::UriPurifier.new,
-        Rupta::UriExtractor.new(uri_extract_processor),
-        Rupta::YamlLoader.new
+        Rupta::Helper::UriPurifier.new(Rupta::Helper::UriParser.new),
+        Rupta::Helper::UriExtractor.new(@uri_extract_processor)
       )
     end
   end

data/lib/rupta/helper/uri_extract_processor/default.rb

@@ -0,0 +1,11 @@
+class Rupta
+  module Helper
+    module UriExtractProcessor
+      class Default
+        def match(name)
+          '[^/.]*'
+        end
+      end
+    end
+  end
+end

data/lib/rupta/helper/uri_extractor.rb

@@ -0,0 +1,20 @@
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'addressable/template'
+
+class Rupta
+  module Helper
+    class UriExtractor
+      def initialize(uri_extract_processor)
+        @uri_extract_processor = uri_extract_processor
+      end
+
+      def extract(uri_templates, uri)
+        uri_templates.each do |uri_template|
+          uri_parameters = Addressable::Template.new(uri_template).extract(uri, @uri_extract_processor)
+          return [uri_template, uri_parameters] if uri_parameters
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/rupta/helper/uri_parser.rb

@@ -0,0 +1,12 @@
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'addressable/uri'
+
+class Rupta
+  module Helper
+    class UriParser
+      def parse(uri)
+        Addressable::URI.parse(uri)
+      end
+    end
+  end
+end

data/lib/rupta/helper/uri_purifier.rb

@@ -0,0 +1,13 @@
+class Rupta
+  module Helper
+    class UriPurifier
+      def initialize(uri_parser)
+        @uri_parser = uri_parser
+      end
+
+      def purify(uri, omittable_uri_components)
+        @uri_parser.parse(uri).omit(*omittable_uri_components)
+      end
+    end
+  end
+end

data/lib/rupta/helper/yaml_loader.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+
+class Rupta
+  module Helper
+    class YamlLoader
+      def load_file(path)
+        YAML.load_file(path)
+      end
+    end
+  end
+end

data/lib/rupta/yaml.rb

@@ -0,0 +1,13 @@
+class Rupta
+  class Yaml
+    def initialize(router, yaml_loader)
+      @router = router
+      @yaml_loader = yaml_loader
+    end
+
+    def detect(path, uri, omittable_uri_components = [:query])
+      routes = @yaml_loader.load_file(path)
+      @router.detect(routes, uri, omittable_uri_components)
+    end
+  end
+end

data/lib/rupta/yaml/factory.rb

@@ -0,0 +1,21 @@
+require 'rupta/factory'
+require 'rupta/helper/uri_extract_processor/default'
+require 'rupta/helper/yaml_loader'
+require 'rupta/yaml'
+
+class Rupta
+  class Yaml
+    class Factory
+      def initialize(uri_extract_processor = Rupta::Helper::UriExtractProcessor::Default.new)
+        @uri_extract_processor = uri_extract_processor
+      end
+
+      def create
+        Rupta::Yaml.new(
+          Rupta::Factory.new(@uri_extract_processor).create,
+          Rupta::Helper::YamlLoader.new
+        )
+      end
+    end
+  end
+end

data/spec/{routing_with_hash_spec.rb → routing_spec.rb}

@@ -5,7 +5,7 @@ rescue LoadError
   require 'rupta/factory'
 end
 
-describe "Rupta#detect_with_hash" do
+describe "Rupta#detect" do
   before(:all) do
     @routes = {'bookmark'    => ['http://example.com/bookmarks/{bookmark_id}',
                                 'http://example.com/bookmarks/{bookmark_id}.{format}.{lang}',
@@ -14,11 +14,11 @@ describe "Rupta#detect_with_hash" do
                'static_path' => ['http://example.com/static_path'],
                'search'      => ['http://example.com/search']}
 
-    @rupta = Rupta::Factory.create
+    @router = Rupta::Factory.new.create
   end
 
   it "should detect a correct route" do
-    route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/bookmarks/123.atom')
+    route_name, uri_template, uri_parameters = @router.detect(@routes, 'http://example.com/bookmarks/123.atom')
     route_name.should == 'bookmark'
     uri_template.should == 'http://example.com/bookmarks/{bookmark_id}.{format}'
     uri_parameters.values_at('bookmark_id', 'format').should == ['123', 'atom']
@@ -26,14 +26,14 @@ describe "Rupta#detect_with_hash" do
 
   describe "when passed a static URI" do
     it "should return an empty hash as the URI parameters" do
-      route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/static_path')
+      route_name, uri_template, uri_parameters = @router.detect(@routes, 'http://example.com/static_path')
       uri_parameters.should be_empty
     end
   end
 
   describe "when passed a URI which has query strings" do
     it "should omit the query strings" do
-      route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/search?q=foo')
+      route_name, uri_template, uri_parameters = @router.detect(@routes, 'http://example.com/search?q=foo')
       route_name.should == 'search'
       uri_template.should == 'http://example.com/search'
       uri_parameters.should be_empty
@@ -42,7 +42,7 @@ describe "Rupta#detect_with_hash" do
 
   describe "when passed an invalid URI" do
     it "should return nil" do
-      result = @rupta.detect_with_hash(@routes, 'http://example.com/not_found')
+      result = @router.detect(@routes, 'http://example.com/not_found')
       result.should be_nil
     end
   end

data/spec/{routing_with_yaml_spec.rb → routing_with_yaml_file_spec.rb}

@@ -1,18 +1,18 @@
 begin
-  require 'rupta/factory'
+  require 'rupta/yaml/factory'
 rescue LoadError
   $LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
-  require 'rupta/factory'
+  require 'rupta/yaml/factory'
 end
 
-describe "Rupta#detect" do
+describe "Rupta::Yaml#detect" do
   before(:all) do
     @yaml_path = File.expand_path('fixtures/routes.yml', File.dirname(__FILE__))
-    @rupta = Rupta::Factory.create
+    @router = Rupta::Yaml::Factory.new.create
   end
 
   it "should detect a correct route" do
-    route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/bookmarks/123.atom')
+    route_name, uri_template, uri_parameters = @router.detect(@yaml_path, 'http://example.com/bookmarks/123.atom')
     route_name.should == 'bookmark'
     uri_template.should == 'http://example.com/bookmarks/{bookmark_id}.{format}'
     uri_parameters.values_at('bookmark_id', 'format').should == ['123', 'atom']
@@ -20,14 +20,14 @@ describe "Rupta#detect" do
 
   describe "when passed a static URI" do
     it "should return an empty hash as the URI parameters" do
-      route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/static_path')
+      route_name, uri_template, uri_parameters = @router.detect(@yaml_path, 'http://example.com/static_path')
       uri_parameters.should be_empty
     end
   end
 
   describe "when passed a URI which has query strings" do
     it "should omit the query strings" do
-      route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/search?q=foo')
+      route_name, uri_template, uri_parameters = @router.detect(@yaml_path, 'http://example.com/search?q=foo')
       route_name.should == 'search'
       uri_template.should == 'http://example.com/search'
       uri_parameters.should be_empty
@@ -36,7 +36,7 @@ describe "Rupta#detect" do
 
   describe "when passed an invalid URI" do
     it "should return nil" do
-      result = @rupta.detect(@yaml_path, 'http://example.com/not_found')
+      result = @router.detect(@yaml_path, 'http://example.com/not_found')
       result.should be_nil
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iwamot-rupta
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - IWAMOTO Takashi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 -07:00
+date: 2009-09-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,12 +37,16 @@ files:
 - README.rdoc
 - lib/rupta.rb
 - lib/rupta/factory.rb
-- lib/rupta/uri_extract_processor/default.rb
-- lib/rupta/uri_extractor.rb
-- lib/rupta/uri_purifier.rb
-- lib/rupta/yaml_loader.rb
+- lib/rupta/helper/uri_extract_processor/default.rb
+- lib/rupta/helper/uri_extractor.rb
+- lib/rupta/helper/uri_parser.rb
+- lib/rupta/helper/uri_purifier.rb
+- lib/rupta/helper/yaml_loader.rb
+- lib/rupta/yaml.rb
+- lib/rupta/yaml/factory.rb
 has_rdoc: false
 homepage: http://github.com/iwamot/rupta
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -63,10 +67,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A template-based URI router
 test_files: 
-- spec/routing_with_yaml_spec.rb
-- spec/routing_with_hash_spec.rb
+- spec/routing_spec.rb
+- spec/routing_with_yaml_file_spec.rb

data/lib/rupta/uri_extract_processor/default.rb

@@ -1,9 +0,0 @@
-class Rupta
-  module UriExtractProcessor
-    class Default
-      def match(name)
-        '[^/.]*'
-      end
-    end
-  end
-end

data/lib/rupta/uri_extractor.rb

@@ -1,18 +0,0 @@
-require 'rubygems' if RUBY_VERSION < '1.9.0'
-require 'addressable/template'
-
-class Rupta
-  class UriExtractor
-    def initialize(uri_extract_processor)
-      @uri_extract_processor = uri_extract_processor
-    end
-
-    def extract(uri_templates, uri)
-      uri_templates.each do |uri_template|
-        uri_parameters = Addressable::Template.new(uri_template).extract(uri, @uri_extract_processor)
-        return [uri_template, uri_parameters] if uri_parameters
-      end
-      nil
-    end
-  end
-end

data/lib/rupta/uri_purifier.rb

@@ -1,10 +0,0 @@
-require 'rubygems' if RUBY_VERSION < '1.9.0'
-require 'addressable/uri'
-
-class Rupta
-  class UriPurifier
-    def purify(uri, omittable_uri_components)
-      Addressable::URI.parse(uri).omit(*omittable_uri_components)
-    end
-  end
-end

data/lib/rupta/yaml_loader.rb

@@ -1,9 +0,0 @@
-require 'yaml'
-
-class Rupta
-  class YamlLoader
-    def load_file(path)
-      YAML.load_file(path)
-    end
-  end
-end