Permalink
Browse files

Substantially updated the documentation.

  • Loading branch information...
Bob Aman
Bob Aman committed Aug 10, 2010
1 parent de1dc05 commit fb5645859bc6168ec244add2516212713d09ef60
Showing with 162 additions and 146 deletions.
  1. +1 −0 .yardopts
  2. +62 −62 CHANGELOG
  3. +12 −2 README
  4. +87 −82 lib/addressable/uri.rb
View
@@ -0,0 +1 @@
+-o doc/ - CHANGELOG LICENSE
View
124 CHANGELOG
@@ -1,89 +1,89 @@
=== Addressable 2.1.2
- * added HTTP request URI methods
- * added site methods
- * better handling of Windows file paths
- * validation_deferred boolean replaced with defer_validation block
- * normalization of percent-encoded paths should now be correct
- * fixed issue with constructing URIs with relative paths
- * fixed warnings
+- added HTTP request URI methods
+- added site methods
+- better handling of Windows file paths
+- validation_deferred boolean replaced with defer_validation block
+- normalization of percent-encoded paths should now be correct
+- fixed issue with constructing URIs with relative paths
+- fixed warnings
=== Addressable 2.1.1
- * more type checking changes
- * fixed issue with unicode normalization
- * added method to find template defaults
- * symbolic keys are now allowed in template mappings
- * numeric values and symbolic values are now allowed in template mappings
+- more type checking changes
+- fixed issue with unicode normalization
+- added method to find template defaults
+- symbolic keys are now allowed in template mappings
+- numeric values and symbolic values are now allowed in template mappings
=== Addressable 2.1.0
- * refactored URI template support out into its own class
- * removed extract method due to being useless and unreliable
- * removed Addressable::URI.expand_template
- * removed Addressable::URI#extract_mapping
- * added partial template expansion
- * fixed minor bugs in the parse and heuristic_parse methods
- * fixed incompatibility with Ruby 1.9.1
- * fixed bottleneck in Addressable::URI#hash and Addressable::URI#to_s
- * fixed unicode normalization exception
- * updated query_values methods to better handle subscript notation
- * worked around issue with freezing URIs
- * improved specs
+- refactored URI template support out into its own class
+- removed extract method due to being useless and unreliable
+- removed Addressable::URI.expand_template
+- removed Addressable::URI#extract_mapping
+- added partial template expansion
+- fixed minor bugs in the parse and heuristic_parse methods
+- fixed incompatibility with Ruby 1.9.1
+- fixed bottleneck in Addressable::URI#hash and Addressable::URI#to_s
+- fixed unicode normalization exception
+- updated query_values methods to better handle subscript notation
+- worked around issue with freezing URIs
+- improved specs
=== Addressable 2.0.2
- * fixed issue with URI template expansion
- * fixed issue with percent escaping characters 0-15
+- fixed issue with URI template expansion
+- fixed issue with percent escaping characters 0-15
=== Addressable 2.0.1
- * fixed issue with query string assignment
- * fixed issue with improperly encoded components
+- fixed issue with query string assignment
+- fixed issue with improperly encoded components
=== Addressable 2.0.0
- * the initialize method now takes an options hash as its only parameter
- * added query_values method to URI class
- * completely replaced IDNA implementation with pure Ruby
- * renamed Addressable::ADDRESSABLE_VERSION to Addressable::VERSION
- * completely reworked the Rakefile
- * changed the behavior of the port method significantly
- * Addressable::URI.encode_segment, Addressable::URI.unencode_segment renamed
- * documentation is now in YARD format
- * more rigorous type checking
- * to_str method implemented, implicit conversion to Strings now allowed
- * Addressable::URI#omit method added, Addressable::URI#merge method replaced
- * updated URI Template code to match v 03 of the draft spec
- * added a bunch of new specifications
+- the initialize method now takes an options hash as its only parameter
+- added query_values method to URI class
+- completely replaced IDNA implementation with pure Ruby
+- renamed Addressable::ADDRESSABLE_VERSION to Addressable::VERSION
+- completely reworked the Rakefile
+- changed the behavior of the port method significantly
+- Addressable::URI.encode_segment, Addressable::URI.unencode_segment renamed
+- documentation is now in YARD format
+- more rigorous type checking
+- to_str method implemented, implicit conversion to Strings now allowed
+- Addressable::URI#omit method added, Addressable::URI#merge method replaced
+- updated URI Template code to match v 03 of the draft spec
+- added a bunch of new specifications
=== Addressable 1.0.4
- * switched to using RSpec's pending system for specs that rely on IDN
- * fixed issue with creating URIs with paths that are not prefixed with '/'
+- switched to using RSpec's pending system for specs that rely on IDN
+- fixed issue with creating URIs with paths that are not prefixed with '/'
=== Addressable 1.0.3
- * implemented a hash method
+- implemented a hash method
=== Addressable 1.0.2
- * fixed minor bug with the extract_mapping method
+- fixed minor bug with the extract_mapping method
=== Addressable 1.0.1
- * fixed minor bug with the extract_mapping method
+- fixed minor bug with the extract_mapping method
=== Addressable 1.0.0
- * heuristic parse method added
- * parsing is slightly more strict
- * replaced to_h with to_hash
- * fixed routing methods
- * improved specifications
- * improved heckle rake task
- * no surviving heckle mutations
+- heuristic parse method added
+- parsing is slightly more strict
+- replaced to_h with to_hash
+- fixed routing methods
+- improved specifications
+- improved heckle rake task
+- no surviving heckle mutations
=== Addressable 0.1.2
- * improved normalization
- * fixed bug in joining algorithm
- * updated specifications
+- improved normalization
+- fixed bug in joining algorithm
+- updated specifications
=== Addressable 0.1.1
- * updated documentation
- * added URI Template variable extraction
+- updated documentation
+- added URI Template variable extraction
=== Addressable 0.1.0
- * initial release
- * implementation based on RFC 3986, 3987
- * support for IRIs via libidn
- * support for the URI Template draft spec
+- initial release
+- implementation based on RFC 3986, 3987
+- support for IRIs via libidn
+- support for the URI Template draft spec
View
14 README
@@ -1,10 +1,20 @@
+== About
+
+Homepage:: Addressable[http://addressable.rubyforge.org/]
+Authors:: Bob Aman (mailto:bob@sporkmonger.com)
+Copyright:: Copyright 2010 Bob Aman
+License:: MIT
+
Addressable is a replacement for the URI implementation that is part of
Ruby's standard library. It more closely conforms to the relevant RFCs and
adds support for IRIs and URI templates. Additionally, it provides extensive
support for URI templates.
-Example usage:
-
+== Classes
+- {Addressable::URI}
+- {Addressable::Template}
+
+== Example usage
require "addressable/uri"
uri = Addressable::URI.parse("http://example.com/path/to/resource/")
Oops, something went wrong.

0 comments on commit fb56458

Please sign in to comment.