earl 0.2.0 → 0.3.0

data/lib/earl.rb

@@ -1,19 +1,24 @@
-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 :EntityBase,     'earl/entity_base'
+  autoload :URLEntity,      'earl/url_entity'
+  autoload :URLAssembler,   'earl/url_assembler'
+  autoload :EmailEntity,    'earl/email_entity'
+  autoload :EmailAssembler, 'earl/email_assembler'
+  autoload :HashInquirer,   'earl/hash_inquirer'
   autoload :StringInquirer, 'earl/string_inquirer'
 
   class << self
-    def parse( string )
-      Earl::URL.new string
+    def URL( source )
+      Earl::URLEntity.new source
+    end
+    def Email( source )
+      Earl::EmailEntity.new source
     end
   end
 
-  class EarlError < StandardError; end
+  class EarlError       < StandardError; end
   class InvalidURLError < EarlError; end
+  class SubclassError   < EarlError; end
 end

data/lib/earl/email_assembler.rb

@@ -0,0 +1,11 @@
+module Earl
+  class EmailAssembler
+
+    def assemble( parts={} )
+      ''.tap do |email|
+        email << [ parts[ :username ], parts[ :domain ] ].join( '@' )
+        email << " <#{parts[ :contact ]}>" if parts[ :contact ]
+      end
+    end
+  end
+end

data/lib/earl/email_entity.rb

@@ -0,0 +1,27 @@
+require 'treetop'
+require 'earl/email_parser'
+
+module Earl
+  class EmailEntity < EntityBase
+
+    part_accessor :contact
+
+    part_accessor :username do |value|
+      raise InvalidURLError if value.nil?
+    end
+
+    part_accessor :domain do |value|
+      raise InvalidURLError if value.nil?
+    end
+
+    protected
+
+    def parser
+      @parser ||= EmailParser.new
+    end
+
+    def assembler
+      @assembler ||= EmailAssembler.new
+    end
+  end
+end

data/lib/earl/email_parser.tt

@@ -0,0 +1,58 @@
+module Earl
+  grammar Email
+
+    rule program
+      whitespace v:( email ) whitespace {
+        def resolve
+          { }.merge v.resolve
+        end
+      }
+    end
+
+    rule whitespace
+      [\s]*
+    end
+
+    rule email
+      username '@' domain whitespace contact {
+        def resolve
+          username.resolve.merge domain.resolve.merge contact.resolve
+        end
+      }
+      /
+      username '@' domain {
+        def resolve
+          username.resolve.merge domain.resolve
+        end
+      }
+    end
+
+    rule username
+      [^@\s]+ {
+        def resolve
+          { :username => text_value }
+        end
+      }
+    end
+
+    rule domain
+      characters '.' characters {
+        def resolve
+          { :domain => text_value }
+        end
+      }
+    end
+
+    rule contact
+      '<' [^>]+ '>' {
+        def resolve
+          { :contact => elements[ 1 ].text_value }
+        end
+      }
+    end
+
+    rule characters
+      [a-zA-Z0-9]+
+    end
+  end
+end

data/lib/earl/entity_base.rb

@@ -0,0 +1,37 @@
+module Earl
+  class EntityBase < HashInquirer
+    def initialize( source )
+      super parser.parse( source ).resolve rescue raise InvalidURLError
+    end
+
+    def to_s
+      assembler.assemble self
+    end
+
+    def self.part_accessor( *parts, &block )
+      parts.each do |part|
+        define_method part do
+          if self[ part ].is_a? String
+            StringInquirer.new self[ part ]
+          else
+            self[ part ]
+          end
+        end
+        define_method :"#{part}=" do |value|
+          self[ part ] = value
+          yield value if block_given?
+        end
+      end
+    end
+
+    protected
+
+    def parser
+      raise SubclassError
+    end
+
+    def assembler
+      raise SubclassError
+    end
+  end
+end

data/lib/earl/hash_inquirer.rb

@@ -7,7 +7,7 @@ module Earl
 
     def method_missing( meth, *args, &block )
       if meth.to_s[ -1 ] == '?'
-        self[ meth.to_s[ 0..-2 ].to_sym ] || false
+        self.has_key? meth.to_s[ 0..-2 ].to_sym
       else
         super
       end

data/lib/earl/url_assembler.rb

@@ -1,15 +1,14 @@
 module Earl
-  class UrlAssembler
+  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[ :port ].to_s ) if parts[ :port ]
         url << ( '/' + parts[ :path ]      ) if parts[ :path ]
         url << ( '?' + parts[ :search ]    ) if parts[ :search ]
-        url
       end
     end
   end

data/lib/earl/url_entity.rb

@@ -0,0 +1,23 @@
+require 'treetop'
+require 'earl/url_parser'
+
+module Earl
+  class URLEntity < EntityBase
+
+    part_accessor :scheme, :subdomain, :port, :path, :search
+
+    part_accessor :host do |value|
+      raise InvalidURLError if value.nil?
+    end
+
+    protected
+
+    def parser
+      @parser ||= URLParser.new
+    end
+
+    def assembler
+      @assembler ||= URLAssembler.new
+    end
+  end
+end

data/lib/earl/url_parser.tt

@@ -1,5 +1,5 @@
 module Earl
-  grammar Url
+  grammar URL
 
     rule program
       whitespace v:( url ) whitespace {

data/lib/earl/version.rb

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

data/spec/earl/earl_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Earl do
+  subject { Earl }
+
+  it { should respond_to( :URL ) }
+  describe '#URL' do
+    subject { Earl::URL( 'http://foo.com' ) }
+    it { should be_kind_of( Earl::URLEntity ) }
+  end
+
+  it { should respond_to( :Email ) }
+  describe '#Email' do
+    subject { Earl::Email( 'foo@bar.com' ) }
+    it { should be_kind_of( Earl::EmailEntity ) }
+  end
+end

data/spec/earl/email_entity_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Earl::EmailEntity do
+  subject { Earl::EmailEntity }
+
+  # username
+
+  it { should produce( 'foo@bar.com' ).from( 'baz@bar.com' ).when_given( :username => 'foo' ) }
+  it 'must have a username when parsing an email' do
+    expect { Earl::Email( '@bar.com' ) }.to raise_error( Earl::InvalidURLError )
+  end
+  it 'wont let you set the username to nil' do
+    expect { Earl::Email( 'foo@bar.com' ).username = nil }.to raise_error( Earl::InvalidURLError )
+  end
+
+  # domain
+
+  it { should produce( 'foo@bar.com' ).from( 'foo@baz.com' ).when_given( :domain => 'bar.com' ) }
+  it 'must have a domain when parsing an email' do
+    expect { Earl::Email( 'foo@' ) }.to raise_error( Earl::InvalidURLError )
+  end
+  it 'wont let you set the domain to nil' do
+    expect { Earl::Email( 'foo@bar.com' ).domain = nil }.to raise_error( Earl::InvalidURLError )
+  end
+
+  # contact
+
+  it { should produce( 'foo@bar.com <Woot!>' ).from( 'foo@bar.com <Foo Bar>' ).when_given( :contact => 'Woot!' ) }
+  it { should produce( 'foo@bar.com <Woot!>' ).from( 'foo@bar.com' ).when_given( :contact => 'Woot!' ) }
+  it { should produce( 'foo@bar.com' ).from( 'foo@bar.com <Woot!>' ).when_given( :contact => nil ) }
+end

data/spec/earl/email_parser_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Earl do
+  let( :parser    ){ Earl::EmailParser.new    }
+  let( :assembler ){ Earl::EmailAssembler.new }
+
+  [
+    [ 'foo@bar.com', {
+      :username => 'foo',
+      :domain => 'bar.com'
+    } ],
+    [ 'foo.bar@baz.com', {
+      :username => 'foo.bar',
+      :domain => 'baz.com'
+    } ],
+    [ 'foo.bar@baz.com <Foo Bar>', {
+      :username => 'foo.bar',
+      :domain => 'baz.com',
+      :contact => 'Foo Bar'
+    } ]
+  ].each do |string, parts|
+    it "should correctly parse the email parts for #{string}" do
+      parser.parse( string ).resolve.should eql( parts )
+    end
+    it "should correctly assemble the email parts to #{string}" do
+      assembler.assemble( parts ).should eql( string )
+    end
+  end
+end

data/spec/earl/entity_base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Earl::EntityBase do
+
+  describe 'the entity dsl' do
+    subject { Class.new( Earl::EntityBase ) do
+      def initialize; end # so we don't invoke our parser
+
+      part_accessor :foo, :bar
+
+      part_accessor :baz do |value|
+        raise EarlError if value == 'woot!'
+      end
+    end.new }
+
+    it { should be_kind_of( Earl::HashInquirer ) }
+
+    [ :foo, :foo=, :bar, :bar=, :baz, :baz= ].each do |method|
+      it { should respond_to( method ) }
+    end
+
+    it 'should define setters/getters' do
+      subject.foo = 'foo!'
+      subject.foo.should eq( 'foo!' )
+      subject[ :foo ].should eq( 'foo!' )
+      subject.foo?.should eq( true )
+    end
+
+    it 'should call the block if given' do
+      expect { subject.baz = 'baz!'  }.not_to raise_error
+      expect { subject.baz = 'woot!' }.to raise_error
+    end
+
+    it 'should return a string inquirer for string attributes' do
+      subject.foo = 'sup'
+      subject.foo.kind_of?( Earl::StringInquirer ).should == true
+    end
+  end
+end

data/spec/earl/hash_inquirer_spec.rb

@@ -15,7 +15,7 @@ describe Earl::HashInquirer do
   end
 
   describe 'boolean keys' do
-    its( :woo? ){ should be_false }
+    its( :woo? ){ should be_true }
   end
 
   describe 'nonexistant keys' do

data/spec/earl/string_inquirer_spec.rb

@@ -7,11 +7,3 @@ describe Earl::StringInquirer do
   its( :foo? ){ should be_true }
   its( :bar? ){ should be_false }
 end
-
-describe Earl::URL do
-  subject { Earl::URL.new 'http://www.foo.com' }
-
-  its( :scheme    ){ should be_a( Earl::StringInquirer ) }
-  its( :subdomain ){ should be_a( Earl::StringInquirer ) }
-  its( :host      ){ should be_a( Earl::StringInquirer ) }
-end

data/spec/earl/url_entity_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Earl::URLEntity do
+  subject { Earl::URLEntity }
+
+  # scheme
+
+  it { should produce( 'https://foo.com' ).from( 'http://foo.com' ).when_given( :scheme => 'https' ) }
+  it { should produce( 'http://foo.com' ).from( 'foo.com' ).when_given( :scheme => 'http' ) }
+  it { should produce( 'foo.com' ).from( 'http://foo.com' ).when_given( :scheme => nil ) }
+
+  # subdomain
+
+  it { should produce( 'baz.bar.com' ).from( 'foo.bar.com' ).when_given( :subdomain => 'baz' ) }
+  it { should produce( 'bar.foo.com' ).from( 'foo.com' ).when_given( :subdomain => 'bar' ) }
+  it { should produce( 'bar.com' ).from( 'foo.bar.com' ).when_given( :subdomain => nil ) }
+
+  # port
+
+  it { should produce( 'foo.com:4567' ).from( 'foo.com:80' ).when_given( :port => 4567 ) }
+  it { should produce( 'foo.com:4567' ).from( 'foo.com' ).when_given( :port => 4567 ) }
+  it { should produce( 'foo.com' ).from( 'foo.com:4567' ).when_given( :port => nil ) }
+
+  # path
+
+  it { should produce( 'foo.com/bar' ).from( 'foo.com/baz' ).when_given( :path => 'bar' ) }
+  it { should produce( 'foo.com/bar' ).from( 'foo.com' ).when_given( :path => 'bar' ) }
+  it { should produce( 'foo.com' ).from( 'foo.com/bar' ).when_given( :path => nil ) }
+
+  # search
+
+  it { should produce( 'foo.com?bar=asdf' ).from( 'foo.com?bar=baz' ).when_given( :search => 'bar=asdf' ) }
+  it { should produce( 'foo.com?bar=asdf' ).from( 'foo.com' ).when_given( :search => 'bar=asdf' ) }
+  it { should produce( 'foo.com' ).from( 'foo.com?bar=asdf' ).when_given( :search => nil ) }
+
+  # host
+
+  it { should produce( 'www.foo.edu' ).from( 'www.foo.com' ).when_given( :host => 'foo.edu' ) }
+  it 'must have a host when parsing a url' do
+    expect { Earl::URL( 'http://' ) }.to raise_error( Earl::InvalidURLError )
+  end
+  it 'wont let you set the host to nil' do
+    expect { Earl::URL( 'www.foo.com' ).host = nil }.to raise_error( Earl::InvalidURLError )
+  end
+end

data/spec/earl/url_parser_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Earl do
-  let( :parser    ){ Earl::UrlParser.new    }
-  let( :assembler ){ Earl::UrlAssembler.new }
+  let( :parser    ){ Earl::URLParser.new    }
+  let( :assembler ){ Earl::URLAssembler.new }
 
   [
     [ 'localhost', {

data/spec/spec_helper.rb

@@ -7,3 +7,28 @@ RSpec.configure do |config|
   # Change the formatter
   config.formatter = :documentation
 end
+
+# Custom entity manipulation matcher
+RSpec::Matchers.define :produce do |expected|
+
+  match do |entity_class|
+    entity = entity_class.new @start
+    @changes.each do |key, value|
+      entity.send :"#{key}=", value
+    end
+    @actual = entity.to_s
+    @actual == expected
+  end
+
+  failure_message_for_should do |entity|
+    %Q{expected that "#{@start}" would become "#{expected}" when given #{@changes}, but was "#{@actual}"}
+  end
+
+  chain :from do |start|
+    @start = start
+  end
+
+  chain :when_given do |changes|
+    @changes = changes
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: earl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-16 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &705960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.4.10
   type: :runtime
   prerelease: false
-  version_requirements: *705960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.10
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &705680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,12 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *705680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 description: What URI wishes it could look like
 email:
 - jeremy.ruppel@gmail.com
@@ -48,18 +58,24 @@ files:
 - Rakefile
 - earl.gemspec
 - lib/earl.rb
+- lib/earl/email_assembler.rb
+- lib/earl/email_entity.rb
+- lib/earl/email_parser.tt
+- lib/earl/entity_base.rb
 - lib/earl/hash_inquirer.rb
 - lib/earl/string_inquirer.rb
-- lib/earl/url.rb
 - lib/earl/url_assembler.rb
+- lib/earl/url_entity.rb
 - lib/earl/url_parser.tt
 - lib/earl/version.rb
+- spec/earl/earl_spec.rb
+- spec/earl/email_entity_spec.rb
+- spec/earl/email_parser_spec.rb
+- spec/earl/entity_base_spec.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_entity_spec.rb
 - spec/earl/url_parser_spec.rb
-- spec/earl/url_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/remind101/earl
 licenses: []
@@ -81,15 +97,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
 summary: What URI wishes it could look like
 test_files:
+- spec/earl/earl_spec.rb
+- spec/earl/email_entity_spec.rb
+- spec/earl/email_parser_spec.rb
+- spec/earl/entity_base_spec.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_entity_spec.rb
 - spec/earl/url_parser_spec.rb
-- spec/earl/url_spec.rb
 - spec/spec_helper.rb

data/lib/earl/url.rb

@@ -1,35 +0,0 @@
-module Earl
-  class URL < HashInquirer
-    def initialize( source )
-      super parser.parse( source ).resolve rescue raise InvalidURLError
-    end
-
-    %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
-      assembler.assemble self
-    end
-
-    protected
-
-    def parser
-      @parser ||= UrlParser.new
-    end
-
-    def assembler
-      @assembler ||= UrlAssembler.new
-    end
-  end
-end

data/spec/earl/parse_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe Earl do
-
-  describe '#parse' do
-    it 'should return an Earl::URL' do
-      Earl.parse( 'www.foo.com' ).should be_an( Earl::URL )
-    end
-  end
-end

data/spec/earl/parts_spec.rb

@@ -1,90 +0,0 @@
-require 'spec_helper'
-
-describe Earl::URL do
-
-  describe '#scheme' do
-    context 'when provided' do
-      subject { Earl::URL.new 'http://www.foo.com' }
-      its( :scheme  ){ should eq( 'http' ) }
-      its( :scheme? ){ should be_true }
-
-      it 'should be settable' do
-        subject.scheme = 'https'
-        subject.scheme.should eq( 'https' )
-      end
-    end
-
-    context 'when not provided' do
-      subject { Earl::URL.new 'www.foo.com' }
-      its( :scheme  ){ should eq( nil ) }
-      its( :scheme? ){ should be_false }
-
-      it 'should be settable' do
-        subject.scheme = 'https'
-        subject.scheme.should eq( 'https' )
-      end
-    end
-  end
-
-  describe '#domain' do
-    pending
-  end
-
-  describe '#subdomain' do
-    context 'when provided' do
-      subject { Earl::URL.new 'http://www.foo.com' }
-      its( :subdomain  ){ should eq( 'www' ) }
-      its( :subdomain? ){ should be_true }
-
-      it 'should be settable' do
-        subject.subdomain = 'secure'
-        subject.subdomain.should eq( 'secure' )
-      end
-    end
-
-    context 'when not provided' do
-      subject { Earl::URL.new 'foo.com' }
-      its( :subdomain  ){ should eq( nil ) }
-      its( :subdomain? ){ should be_false }
-
-      it 'should be settable' do
-        subject.subdomain = 'secure'
-        subject.subdomain.should eq( 'secure' )
-      end
-    end
-  end
-
-  describe '#host' do
-    context 'when provided' do
-      subject { Earl::URL.new 'http://www.foo.com' }
-      its( :host  ){ should eq( 'foo.com' ) }
-      its( :host? ){ should be_true }
-
-      it 'should be settable' do
-        subject.host = 'bar.com'
-        subject.host.should eq( 'bar.com' )
-      end
-    end
-
-    context 'when not provided' do
-      it 'should raise an error' do
-        expect { Earl::URL.new( 'http://' ).host }.to raise_error( Earl::InvalidURLError )
-      end
-    end
-  end
-
-  describe '#path' do
-    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_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-
-describe Earl::URL do
-
-  it 'should be able to change the scheme' do
-    url = Earl::URL.new 'http://foo.com'
-    url.scheme = 'https'
-    url.to_s.should eq( 'https://foo.com' )
-  end
-  it 'should be able to add a scheme' do
-    url = Earl::URL.new 'foo.com'
-    url.scheme = 'http'
-    url.to_s.should eq( 'http://foo.com' )
-  end
-  it 'should be able to remove the scheme' do
-    url = Earl::URL.new 'http://foo.com'
-    url.scheme = nil
-    url.to_s.should eq( 'foo.com' )
-  end
-
-  it 'should be able to change the subdomain' do
-    url = Earl::URL.new 'foo.bar.com'
-    url.subdomain = 'baz'
-    url.to_s.should eq( 'baz.bar.com' )
-  end
-  it 'should be able to add a subdomain' do
-    url = Earl::URL.new 'foo.com'
-    url.subdomain = 'bar'
-    url.to_s.should eq( 'bar.foo.com' )
-  end
-  it 'should be able to remove the subdomain' do
-    url = Earl::URL.new 'foo.bar.com'
-    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