earl 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,6 @@
 # Earl
 
-TODO: Write a gem description
+What URI wishes it could look like.
 
 ## Installation
 
@@ -18,7 +18,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+``` rb
+url = Earl::URL.new 'http://www.foo.com'
+
+url.scheme         		# => 'http'
+url.scheme?        		# => true
+
+url.subdomain      		# => 'www'
+url.subdomain.www? 		# => true
+url.subdomain.baz? 		# => false
+
+url.host = 'foo.edu'
+url.to_s           		# => 'http://www.foo.edu'
+```
 
 ## Contributing
 

data/earl.gemspec

@@ -15,5 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Earl::VERSION
 
+  gem.add_dependency 'treetop', '>= 1.4.10'
+
   gem.add_development_dependency 'rspec', '>= 2.9.0'
 end

data/lib/earl.rb

@@ -1,7 +1,11 @@
+require 'treetop'
 require 'earl/version'
+require 'earl/url_parser'
 
 module Earl
   autoload :URL, 'earl/url'
+  autoload :UrlAssembler, 'earl/url_assembler'
+  autoload :HashInquirer, 'earl/hash_inquirer'
   autoload :StringInquirer, 'earl/string_inquirer'
 
   class << self
@@ -9,4 +13,7 @@ module Earl
       Earl::URL.new string
     end
   end
+
+  class EarlError < StandardError; end
+  class InvalidURLError < EarlError; end
 end

data/lib/earl/hash_inquirer.rb

@@ -0,0 +1,16 @@
+module Earl
+  class HashInquirer < ::Hash
+    def initialize( hash, &block )
+      merge! hash
+      super block
+    end
+
+    def method_missing( meth, *args, &block )
+      if meth.to_s[ -1 ] == '?'
+        self[ meth.to_s[ 0..-2 ].to_sym ] || false
+      else
+        super
+      end
+    end
+  end
+end

data/lib/earl/url.rb

@@ -1,78 +1,35 @@
-require 'uri'
-
 module Earl
-  class URL
+  class URL < HashInquirer
     def initialize( source )
-      @uri = URI.parse( source )
-    end
-
-    def scheme
-      StringInquirer.new( parts[ :scheme ] ) rescue nil
-    end
-    def scheme=( value )
-      parts[ :scheme ] = value
-    end
-    def scheme?
-      !( parts[ :scheme ].nil? || parts[ :scheme ].empty? )
+      super parser.parse( source ).resolve rescue raise InvalidURLError
     end
 
-    def subdomain
-      StringInquirer.new( parts[ :subdomain ] ) rescue nil
-    end
-    def subdomain=( value )
-      parts[ :subdomain ] = value
-    end
-    def subdomain?
-      !( parts[ :subdomain ].nil? || parts[ :subdomain ].empty? )
-    end
-
-    def host
-      StringInquirer.new( [ domain, top_level_domain ].compact.join( '.' ) ) rescue nil
-    end
-    def host=( value )
-      parts[ :domain ], parts[ :top_level_domain ] = value.split( '.' )
-    end
-    def host?
-      [ domain, top_level_domain ].compact.any?
+    %w| scheme subdomain host port path search |.each do |part|
+      define_method :"#{part}" do
+        if self[ part.to_sym ].is_a? String
+          StringInquirer.new self[ part.to_sym ]
+        else
+          self[ part.to_sym ]
+        end
+      end
+      define_method :"#{part}=" do |value|
+        raise InvalidURLError if part.to_sym == :host && value == nil
+        self[ part.to_sym ] = value
+      end
     end
 
     def to_s
-      out = ''
-      out << "#{scheme}://" if scheme?
-      out << [ subdomain, domain, top_level_domain ].compact.join( '.' )
+      assembler.assemble self
     end
 
     protected
 
-    def domain
-      StringInquirer.new( parts[ :domain ] ) rescue nil
-    end
-    def top_level_domain
-      StringInquirer.new( parts[ :top_level_domain ] ) rescue nil
+    def parser
+      @parser ||= UrlParser.new
     end
 
-    def parts
-      @parts ||= begin
-        { }.tap do |hsh|
-          hsh[ :scheme    ] = @uri.scheme
-          hsh[ :subdomain ], hsh[ :domain ], hsh[ :top_level_domain ] = domain_parts
-        end
-      end
-    end
-
-    def domain_parts
-      parts = host_parts || [ nil ]
-      parts << nil      if parts.size == 1
-      parts.unshift nil if parts.size == 2
-      parts
-    end
-
-    def host_parts
-      if @uri.host
-        @uri.host.split '.'
-      elsif @uri.path
-        @uri.path.split '.'
-      end
+    def assembler
+      @assembler ||= UrlAssembler.new
     end
   end
 end

data/lib/earl/url_assembler.rb

@@ -0,0 +1,16 @@
+module Earl
+  class UrlAssembler
+
+    def assemble( parts={} )
+      ''.tap do |url|
+        url << ( parts[ :scheme ] + '://'  ) if parts[ :scheme ]
+        url << ( parts[ :subdomain ] + '.' ) if parts[ :subdomain ]
+        url << ( parts[ :host ]            ) if parts[ :host ]
+        url << ( ':' + parts[ :port ]      ) if parts[ :port ]
+        url << ( '/' + parts[ :path ]      ) if parts[ :path ]
+        url << ( '?' + parts[ :search ]    ) if parts[ :search ]
+        url
+      end
+    end
+  end
+end

data/lib/earl/url_parser.tt

@@ -0,0 +1,163 @@
+module Earl
+  grammar Url
+
+    rule program
+      whitespace v:( url ) whitespace {
+        def resolve
+          { }.merge v.resolve
+        end
+      }
+    end
+
+    rule whitespace
+      [\s]*
+    end
+
+    rule url
+      scheme host port path search {
+        def resolve
+          scheme.resolve.merge port.resolve.merge host.resolve.merge path.resolve.merge search.resolve
+        end
+      }
+      /
+      scheme host port path {
+        def resolve
+          scheme.resolve.merge port.resolve.merge host.resolve.merge path.resolve
+        end
+      }
+      /
+      scheme host port search {
+        def resolve
+          scheme.resolve.merge port.resolve.merge host.resolve.merge search.resolve
+        end
+      }
+      /
+      scheme host port {
+        def resolve
+          scheme.resolve.merge port.resolve.merge host.resolve
+        end
+      }
+      /
+      scheme host path search {
+        def resolve
+          scheme.resolve.merge host.resolve.merge path.resolve.merge search.resolve
+        end
+      }
+      /
+      scheme host path {
+        def resolve
+          scheme.resolve.merge host.resolve.merge path.resolve
+        end
+      }
+      /
+      scheme host search {
+        def resolve
+          scheme.resolve.merge host.resolve.merge search.resolve
+        end
+      }
+      /
+      scheme host {
+        def resolve
+          scheme.resolve.merge host.resolve
+        end
+      }
+      /
+      host port path search {
+        def resolve
+          port.resolve.merge host.resolve.merge path.resolve.merge search.resolve
+        end
+      }
+      /
+      host port path {
+        def resolve
+          port.resolve.merge host.resolve.merge path.resolve
+        end
+      }
+      /
+      host port search {
+        def resolve
+          port.resolve.merge host.resolve.merge search.resolve
+        end
+      }
+      /
+      host port {
+        def resolve
+          port.resolve.merge host.resolve
+        end
+      }
+      /
+      host path {
+        def resolve
+          host.resolve.merge path.resolve
+        end
+      }
+      /
+      host search {
+        def resolve
+          host.resolve.merge search.resolve
+        end
+      }
+      /
+      host
+    end
+
+    rule scheme
+      characters '://' {
+        def resolve
+          { :scheme => characters.text_value }
+        end
+      }
+    end
+
+    rule host
+      subdomain:characters '.' domain:characters '.' tld:characters {
+        def resolve
+          {
+            :subdomain => subdomain.text_value,
+            :host => "#{domain.text_value}.#{tld.text_value}"
+          }
+        end
+      }
+      /
+      domain:characters '.' tld:characters {
+        def resolve
+          { :host => text_value }
+        end
+      }
+      /
+      characters {
+        def resolve
+          { :host => text_value }
+        end
+      }
+    end
+
+    rule port
+      ':' port:([0-9]1..4) {
+        def resolve
+          { :port => port.text_value }
+        end
+      }
+    end
+
+    rule path
+      '/' characters {
+        def resolve
+          { :path => characters.text_value }
+        end
+      }
+    end
+
+    rule search
+      '?' search:( characters '=' characters ) {
+        def resolve
+          { :search => search.text_value }
+        end
+      }
+    end
+
+    rule characters
+      [a-zA-Z0-9]+
+    end
+  end
+end

data/lib/earl/version.rb

@@ -1,3 +1,3 @@
 module Earl
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/earl/hash_inquirer_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Earl::HashInquirer do
+  subject { Earl::HashInquirer.new :foo => 'bar', :baz => 123, :woo => false }
+
+  it { should be_a( Hash ) }
+  it { should eql( :foo => 'bar', :baz => 123, :woo => false ) }
+
+  describe 'string keys' do
+    its( :foo? ){ should be_true }
+  end
+
+  describe 'numeric keys' do
+    its( :baz? ){ should be_true }
+  end
+
+  describe 'boolean keys' do
+    its( :woo? ){ should be_false }
+  end
+
+  describe 'nonexistant keys' do
+    its( :sup? ){ should be_false }
+  end
+end

data/spec/earl/parse_spec.rb

@@ -4,7 +4,7 @@ describe Earl do
 
   describe '#parse' do
     it 'should return an Earl::URL' do
-      Earl.parse( '' ).should be_an( Earl::URL )
+      Earl.parse( 'www.foo.com' ).should be_an( Earl::URL )
     end
   end
 end

data/spec/earl/parts_spec.rb

@@ -68,12 +68,23 @@ describe Earl::URL do
 
     context 'when not provided' do
       it 'should raise an error' do
-        expect { Earl::URL.new 'http://' }.to raise_error( URI::InvalidURIError )
+        expect { Earl::URL.new( 'http://' ).host }.to raise_error( Earl::InvalidURLError )
       end
     end
   end
 
   describe '#path' do
-    pending
+    context 'when provided' do
+      subject { Earl::URL.new 'http://www.foo.com/bar' }
+      its( :path  ){ should eq( 'bar' ) }
+      its( :path? ){ should be_true }
+    end
+
+    context 'when not provided' do
+      subject { Earl::URL.new 'http://www.foo.com' }
+
+      its( :path  ){ should eq( nil ) }
+      its( :path? ){ should be_false }
+    end
   end
 end

data/spec/earl/url_parser_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe Earl do
+  let( :parser    ){ Earl::UrlParser.new    }
+  let( :assembler ){ Earl::UrlAssembler.new }
+
+  [
+    [ 'localhost', {
+      :host => 'localhost'
+    } ],
+    [ 'foo.com', {
+      :host => 'foo.com'
+    } ],
+
+    [ 'foo.edu', {
+      :host => 'foo.edu'
+    } ],
+
+    [ 'foo2bar.biz', {
+      :host => 'foo2bar.biz'
+    } ],
+
+    [ 'www.foo.com', {
+      :host => 'foo.com',
+      :subdomain => 'www'
+    } ],
+
+    [ 'http://localhost', {
+      :scheme => 'http',
+      :host => 'localhost'
+    } ],
+
+    [ 'http://foo.com', {
+      :scheme => 'http',
+      :host => 'foo.com'
+    } ],
+
+    [ 'http://www.foo.com', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :subdomain => 'www'
+    } ],
+
+    [ 'localhost:3000', {
+      :host => 'localhost',
+      :port => '3000'
+    } ],
+
+    [ 'http://localhost:3000', {
+      :scheme => 'http',
+      :host => 'localhost',
+      :port => '3000'
+    } ],
+
+    [ 'www.foo.com:8080', {
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :port => '8080'
+    } ],
+
+    [ 'http://www.foo.com:8080', {
+      :scheme => 'http',
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :port => '8080'
+    } ],
+
+    [ 'localhost/bar', {
+      :host => 'localhost',
+      :path => 'bar'
+    } ],
+
+    [ 'foo.com/bar', {
+      :host => 'foo.com',
+      :path => 'bar'
+    } ],
+
+    [ 'www.foo.com/bar', {
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :path => 'bar'
+    } ],
+
+    [ 'http://localhost/bar', {
+      :scheme => 'http',
+      :host => 'localhost',
+      :path => 'bar'
+    } ],
+
+    [ 'http://foo.com/bar', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :path => 'bar'
+    } ],
+
+    [ 'http://www.foo.com/bar', {
+      :scheme => 'http',
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :path => 'bar'
+    } ],
+
+    [ 'localhost?baz=woo', {
+      :host => 'localhost',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'localhost:3000?baz=woo', {
+      :host => 'localhost',
+      :port => '3000',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'localhost:3000/bar?baz=woo', {
+      :host => 'localhost',
+      :port => '3000',
+      :path => 'bar',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'foo.com?baz=woo', {
+      :host => 'foo.com',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'www.foo.com?baz=woo', {
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'http://foo.com?baz=woo', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'http://www.foo.com?baz=woo', {
+      :scheme => 'http',
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'http://foo.com/bar?baz=woo', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :path => 'bar',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'http://www.foo.com/bar?baz=woot', {
+      :scheme => 'http',
+      :subdomain => 'www',
+      :host => 'foo.com',
+      :path => 'bar',
+      :search => 'baz=woot'
+    } ],
+
+    [ 'http://localhost:3000?baz=woo', {
+      :scheme => 'http',
+      :host => 'localhost',
+      :port => '3000',
+      :search => 'baz=woo'
+    } ],
+
+    [ 'http://foo.com:8080?baz=woooo', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :port => '8080',
+      :search => 'baz=woooo'
+    } ],
+
+    [ 'http://foo.com:8080/bar?baz=woo', {
+      :scheme => 'http',
+      :host => 'foo.com',
+      :port => '8080',
+      :path => 'bar',
+      :search => 'baz=woo'
+    } ]
+  ].each do |string, parts|
+    it "should correctly parse the url parts for #{string}" do
+      parser.parse( string ).resolve.should eql( parts )
+    end
+    it "should correctly assemble the url parts to #{string}" do
+      assembler.assemble( parts ).should eql( string )
+    end
+  end
+end

data/spec/earl/url_spec.rb

@@ -33,4 +33,17 @@ describe Earl::URL do
     url.subdomain = nil
     url.to_s.should eq( 'bar.com' )
   end
+
+  it 'should be able to change the host' do
+    url = Earl::URL.new 'www.foo.com'
+    url.host = 'foo.edu'
+    url.to_s.should eq( 'www.foo.edu' )
+  end
+  it 'should not be able to add a host' do
+    expect { url = Earl::URL.new 'http://' }.to raise_error( Earl::InvalidURLError )
+  end
+  it 'should not be able to remove a host' do
+    url = Earl::URL.new 'http://foo.com'
+    expect { url.host = nil }.to raise_error( Earl::InvalidURLError )
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: earl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000 Z
+date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  name: treetop
+  requirement: &705960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
-  type: :development
+        version: 1.4.10
+  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  version_requirements: *705960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &705680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *705680
 description: What URI wishes it could look like
 email:
 - jeremy.ruppel@gmail.com
@@ -42,12 +48,17 @@ files:
 - Rakefile
 - earl.gemspec
 - lib/earl.rb
+- lib/earl/hash_inquirer.rb
 - lib/earl/string_inquirer.rb
 - lib/earl/url.rb
+- lib/earl/url_assembler.rb
+- lib/earl/url_parser.tt
 - lib/earl/version.rb
+- spec/earl/hash_inquirer_spec.rb
 - spec/earl/parse_spec.rb
 - spec/earl/parts_spec.rb
 - spec/earl/string_inquirer_spec.rb
+- spec/earl/url_parser_spec.rb
 - spec/earl/url_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/remind101/earl
@@ -70,13 +81,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: What URI wishes it could look like
 test_files:
+- spec/earl/hash_inquirer_spec.rb
 - spec/earl/parse_spec.rb
 - spec/earl/parts_spec.rb
 - spec/earl/string_inquirer_spec.rb
+- spec/earl/url_parser_spec.rb
 - spec/earl/url_spec.rb
 - spec/spec_helper.rb