valerie 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4852cdd21e92043de8fce8c61d0772ca050173629b83f4ca937d470e6f8a2704
-  data.tar.gz: b012526eb2ed715eee6c6a306fcdc6bfae0b4a0f3d5990bdf4f73519f6eb1b6f
+  metadata.gz: ea7e19804b751742d2949d006db9f884f3baa7a17d0a0a1f6a6db00196a6c194
+  data.tar.gz: 49741e0b54e5c6ee460654d4f7134aae2912e74539625fe8c3b37e8621a23fa6
 SHA512:
-  metadata.gz: c045564a3aa04ad66f18fac276a4cd777106f9d43e49f48dde04d1e71132bacba2cc173ad97fcfaf3ad2d8c4c1e3819c01aa9c3c18b46eec0d708dfd48cef7be
-  data.tar.gz: d412316626501ab8917501cb03eb4b9ba01588fc8714ac9fceb24a3424b8e429cc7a11143ee4b9281f5a816cfce14872e512993f9861cc72eb8036aacd8ad629
+  metadata.gz: d2518a65329eb490ad21ce723bcab923c09db8b7b8f02afb678aac41469a6799203fa92cd03f530b6d11d451034d540fa3ce58f5eb7b80f214c2b9ddab75ec98
+  data.tar.gz: fa001df7282f3af9a1c1cc2aa3aaf6957b79158640808e45b11e1958e086bbe4ec52b5fb59cc2812b7cf25aa0ec0f8c010df0f81c9d9381d7a8e43572f42cdc6

data/README.md

@@ -0,0 +1,188 @@
+# VCard parser and generator
+
+This is a simple VCard parser and generator extracted from Hellotext.
+It implements the VCard 3.0 specification. It supports all of the cases we want to use in Hellotext.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valerie'
+```
+
+Or install it yourself as: 
+
+```bash
+gem install valerie
+```
+
+## Usage
+
+Parsing a VCard is as simple as passing a VCard string, like 
+
+```ruby
+data = "BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:-//Hellotext www.hellotext.com//EN\r\nN:Rosenbaum;Shira;;;\r\nTEL;:+598 00 000 00\r\nEND:VCARD"
+Valerie::Card.parse(data)
+```
+
+## Generating a VCard
+
+You usually start by initializing a new Card object.
+
+```ruby
+card = Valerie::Card.new
+```
+
+### Types of Properties
+
+According to the VCard 3.0 specification, some types of properties can have multiple values. From the specs, Valerie supports the following properties:
+
+- `EMAIL`: for email addresses
+- `TEL`: for telephone numbers
+- `ADR`: for addresses
+
+Aside from these, every other support property supports a single value. 
+
+
+### Single value properties
+
+#### Name
+
+To set the name property for the VCard, you can use the `Card#name=` setter. It accepts two types of arguments,
+
+A hash that contains the following
+
+```ruby
+{
+  first_name: 'Shira',
+  last_name: 'Rosenbaum',
+  middle_name: 'M',
+  prefix: 'Ms.',
+  suffix: 'PhD'
+}
+```
+
+Or an array with the following order `[first_name, last_name, middle_name, prefix, suffix]`.
+
+```ruby
+card.name = %w[Shira Rosenbaum M Ms. PhD]
+```
+
+#### Gender 
+
+To set the Gender of the card you can, set it value `Card#gender=`, this accepts one of the following constants: 
+`male`, `female`, `other`, `none` and `unknown`. Passing another value raises an `ArgumentError`.
+
+```ruby
+card.gender = 'female'
+```
+
+#### Birthday
+
+The birthday can be set via `Card#birthday=`. It accepts any object that responds to `strftime`, otherwise it stores the `to_s` version of the value.
+
+```ruby
+card.birthday = Date.new(1999, 11, 4)
+```
+
+#### Organization
+
+The organization can be an tuple of `[organization_name, department]`, or a hash of `{organization: 'organization_name', department: 'department'}`.
+When a string value is passed, only the `organization_name` is set.
+
+```ruby
+card.organization = %w[Hellotext Engineering]
+card.organization = { organization: 'Hellotext', department: 'Engineering' }
+card.organization = 'Hellotext'
+```
+
+### Collections 
+
+The card exposes methods to adding the respective collectable properties. Email, telephone and address.
+
+Adding an email,
+
+```ruby
+card.emails.add('user@domain.com')
+```
+
+Or a telephone number,
+
+```ruby
+card.phones.add('+598 00 000 00')
+```
+
+Or an address,
+
+```ruby
+card.addresses.add(
+  {
+    post_office_box: 'PO Box 123',
+    extended_address: 'Suite 123',
+    street_address: '123 Main St',
+    locality: 'Anytown',
+    region: 'CA',
+    postal_code: '12345',
+    country: 'United States'
+  }
+)
+```
+
+#### Positions 
+
+Emails, phones and addresses are ordered. They can include an optional `position` argument 
+to specify their order when the profile has multiple values. Whenever you add a new value,
+a default position argument is picked and the value is appended as the last element. 
+
+To specify the position, you can pass the `position` argument as a keyword argument. Unlike arrays
+the position is 1-based and not 0-based.
+
+```ruby
+card.emails.add('user@domain.com')
+card.emails.add('user@domain2.com', position: 1) # inserts the email as the first element
+```
+
+#### Types
+
+Emails, phones and addresses can have types. The types are defined in the VCard 3.0 specification.
+To specify the type of one of these properties, you can pass the `types` argument as a keyword argument.
+
+```ruby
+card.emails.add('user@domain.com', type: 'work')
+card.emails.add('user@domain.com', type: %w[work internet])
+```
+
+### Configuration 
+
+You can configure the following properties of the card. 
+
+- `prodid`: The product id of the card. This defaults to 'Valerie www.hellotext.com'.
+- `version`: The version of the card. This defaults to '3.0'.
+- `language`: The language of the card. This defaults to 'en'.
+
+```ruby
+Valerie.configure do |config|
+  config.product = 'Valerie www.hellotext.com'
+  config.version = '3.0'
+  config.language = 'en'
+end
+```
+
+### Licence
+
+This code is released under the MIT License. See the LICENSE file for more information.
+
+### Acknowledgements
+
+- [VCardigan](https://github.com/brewster/vcardigan)
+
+### Contributing
+
+Contributions are welcome. Please follow the steps below to contribute.
+
+1. Fork it 
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.pattern = 'test/**/*_test.rb'
+end
+
+desc 'Run tests'
+task default: :test

data/lib/valerie/address.rb

@@ -0,0 +1,70 @@
+require_relative 'ordered'
+
+module Valerie
+  class Address
+    include Ordered
+    
+    def self.from_s(data)
+      data = data[data.index("ADR;")..] unless data.start_with?("ADR;")
+      identifier = data.split(":").last.split(";")
+      options = data.gsub("ADR", "").split(":").first.split(";").compact.filter { _1.to_s.include?('=')}.map { _1.downcase.split("=") }.to_h
+
+      new(
+        post_office_box: identifier[0],
+        extended_address: identifier[1],
+        street_address: identifier[2],
+        locality: identifier[3],
+        region: identifier[4],
+        postal_code: identifier[5],
+        country: identifier[6],
+        **options
+      )
+    end
+
+    def initialize(post_office_box:, extended_address:, street_address:, locality:, region:, postal_code:, country:, **options)
+      @post_office_box = post_office_box
+      @extended_address = extended_address
+      @street_address = street_address
+      @locality = locality
+      @region = region
+      @postal_code = postal_code
+      @country = country
+      @options = options
+      
+      raise ArgumentError, 'Invalid Position' if invalid_position?
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+    def to_s
+      parts = ['ADR']
+      
+      parts << "PERF=#{position}" if position?
+      
+      @options.map do |key, value|
+        next if key == :position
+        parts << "#{key}=#{value}"
+      end
+      
+      parts.join(';') + ":#{identifier}"
+    end
+
+    def identifier
+      [@post_office_box, @extended_address, @street_address, @locality, @region, @postal_code, @country].join(';')
+    end
+
+    def to_h
+      {
+        post_office_box: @post_office_box,
+        extended_address: @extended_address,
+        street_address: @street_address,
+        locality: @locality,
+        region: @region,
+        postal_code: @postal_code,
+        country: @country
+      }
+    end
+  end
+end

data/lib/valerie/birthday.rb

@@ -0,0 +1,46 @@
+require 'date'
+
+module Valerie
+  class Birthday
+    def self.from_s(data)
+      new data.gsub("BDAY:", "")
+    end
+    
+    def initialize(date)
+      if date.respond_to?(:strftime)
+        @date = date.strftime("%Y-%m-%d")
+      else
+        @date = date
+      end
+    end
+    
+    def to_s
+      "BDAY:#{@date}"
+    end
+    
+    def to_date
+      Date.new(year, month, day)
+    end
+    
+    def to_h
+      {
+        day:,
+        month:,
+        year:
+      }
+    end
+    
+    private
+      def year
+        @year ||= @date.split('-')[0].to_i
+      end
+    
+      def month
+        @month ||=  @date.split('-')[1].to_i
+      end
+    
+      def day
+        @day ||=  @date.split('-')[-1].to_i
+      end
+  end
+end

data/lib/valerie/card.rb

@@ -0,0 +1,84 @@
+require_relative '../valerie'
+require_relative 'core/parser'
+
+module Valerie
+  class Card
+    extend Core::Parser
+    
+    attr_reader :name, :formatted_name, :organization, :gender, :birthday
+    
+    def name=(parts)
+      if parts.instance_of?(Name)
+        @name = parts
+      else
+        @name = Name.new parts
+      end
+      
+      if (@name.first_name || @name.last_name) && @formatted_name.nil?
+        @formatted_name = "#{@name.first_name} #{@name.last_name}".strip
+      end
+      
+      @name
+    end
+    
+    def organization=(*args)
+      if args.first.instance_of?(Organization)
+        @organization = args.flatten.first
+      else
+        @organization = Organization.new(*args)
+      end
+    end
+    
+    def gender=(value)
+      @gender = value.is_a?(Gender) ? value : Gender.new(value)
+    end
+    
+    def birthday=(value)
+      @birthday = value.is_a?(Birthday) ? value : Birthday.new(value)
+    end
+    
+    def emails
+      @emails ||= Collection::EmailCollection.new
+    end
+    
+    def addresses
+      @addresses ||= Collection::AddressCollection.new
+    end
+    
+    def phones
+      @phones ||= Collection::PhoneCollection.new
+    end
+    
+    def to_s
+      to_a.join("\r\n")
+    end
+    
+    def to_a
+      parts = [
+        'BEGIN:VCARD',
+        "VERSION:#{Valerie.configuration.version}",
+        "PRODID:-//#{Valerie.configuration.product}//#{Valerie.configuration.language}",
+      ]
+      
+      parts << @name.to_s if @name
+      parts << @organization.to_s if @organization
+      parts << @birthday.to_s if @birthday
+      parts << @gender.to_s if @gender
+      
+      emails.each do |email|
+        parts << email.to_s
+      end
+      
+      phones.each do |phone|
+        parts << phone.to_s
+      end
+      
+      addresses.each do |address|
+        parts << address.to_s
+      end
+      
+      parts << 'END:VCARD'
+      parts
+    end
+  end
+end

data/lib/valerie/collection/address_collection.rb

@@ -0,0 +1,21 @@
+require_relative 'collection'
+require_relative '../address'
+
+module Valerie
+  module Collection
+    class AddressCollection < Base
+      def add(address, **options)
+        @item = if address.is_a?(Address)
+          address.dup { _1.position = options[:position] || @items.size + 1 }
+        else
+          Address.new(**address, **options)
+        end
+      
+        @items << @item
+        @items = @items.sort_by(&:position)
+        
+        @item
+      end
+    end
+  end
+end

data/lib/valerie/collection/collection.rb

@@ -0,0 +1,41 @@
+module Valerie
+  module Collection
+    class Base
+      include Enumerable
+      
+      attr_reader :items
+      
+      def initialize
+        @items = []
+      end
+      
+      def each(&block)
+        items.each(&block)
+      end
+      
+      def add
+        raise NotImplementedError
+      end
+      
+      def blank?
+        @items.empty?
+      end
+      
+      def present?
+        !blank?
+      end
+      
+      def size
+        @items.size
+      end
+      
+      def count
+        @items.count
+      end
+      
+      def length
+        @items.length
+      end
+    end
+  end
+end

data/lib/valerie/collection/email_collection.rb

@@ -0,0 +1,23 @@
+require_relative 'collection'
+require_relative '../email'
+
+module Valerie
+  module Collection
+    class EmailCollection < Base
+      def add(email, **options)
+        @item = if email.is_a?(Email)
+          email.dup.tap { _1.position = options[:position] || @items.size + 1 }
+        elsif email.is_a?(Hash)
+          Email.new(address: email[:address], **email, **options, position: options[:position] || @items.size + 1)
+        else
+          Email.new(address: email, **options, position: options[:position] || @items.size + 1)
+        end
+        
+        @items << @item
+        @items = @items.sort_by(&:position)
+        
+        @item
+      end
+    end
+  end
+end

data/lib/valerie/collection/phone_collection.rb

@@ -0,0 +1,21 @@
+require_relative 'collection'
+require_relative '../phone'
+
+module Valerie
+  module Collection
+    class PhoneCollection < Base
+      def add(phone, **options)
+        @item = if phone.is_a?(Phone)
+          phone.dup.tap { _1.position = options[:position] || @items.size + 1 }
+        else
+          Phone.new(phone, **options, position: options[:position] || @items.size + 1)
+        end
+        
+        @items << @item
+        @items = @items.sort_by(&:position)
+        
+        @item
+      end
+    end
+  end
+end

data/lib/valerie/core/parser.rb

@@ -0,0 +1,90 @@
+require_relative '../../valerie'
+
+module Valerie
+  module Core
+    module Parser
+      def parse(data)
+        if data.instance_of?(String)
+          from_s(data)
+        elsif data.instance_of?(Array)
+          from_a(data)
+        else
+          raise ArgumentError, "Expected String or Array, got #{data.class}"
+        end
+      end
+      
+      private
+        def from_a(data)
+          Card.new.tap do |vcard|
+            if (name = data.find { _1.start_with?("N:") })
+              vcard.name = Name.from_s name.split(":").last
+            end
+            
+            if (organization = data.find { _1.start_with?("ORG:") })
+              vcard.organization = Organization.from_s(organization)
+            end
+            
+            if (birthday = data.find { _1.start_with?("BDAY:") })
+              vcard.birthday = Birthday.from_s(birthday)
+            end
+            
+            if (gender = data.find { _1.start_with?("GENDER:") })
+              vcard.gender = gender.split(":").last
+            end
+            
+            data.select { _1.include?("TEL;") }.each do |phone|
+              vcard.phones.add(Phone.from_s(phone))
+            end
+            
+            data.select { _1.start_with?("EMAIL;") }.each do |email|
+              vcard.emails.add(Email.from_s(email))
+            end
+          end
+        end
+        
+        def from_s(str)
+          vcards = []
+          vcard = []
+          
+          unfold(str).each do |entry|
+            if entry.include?("VERSION:")
+              vcards << from_a(vcard) unless vcard.empty?
+              vcard = []
+            else
+              vcard << entry
+            end
+          end
+          
+          vcards << from_a(vcard)
+          
+          vcards
+        end
+        
+        UNTERMINATED_QUOTED_PRINTABLE = /ENCODING=QUOTED-PRINTABLE:.*=$/
+        
+        def unfold(vcard)
+          unfolded = []
+          
+          prior_line = nil
+          vcard.lines do |line|
+            line.chomp!
+            # If it's a continuation line, add it to the last.
+            # If it's an empty line, drop it from the input.
+            if line =~ /^[ \t]/
+              unfolded[-1] << line[1, line.size - 1]
+            elsif line =~ /(^BEGIN:VCARD$)|(^END:VCARD$)/
+            elsif prior_line && (prior_line =~ UNTERMINATED_QUOTED_PRINTABLE)
+              # Strip the trailing = off prior line, then append current line
+              unfolded[-1] = prior_line[0, prior_line.length - 1] + line
+            elsif line =~ /^$/
+            else
+              unfolded << line
+            end
+            prior_line = unfolded[-1]
+          end
+          
+          unfolded
+        end
+    end
+  end
+end

data/lib/valerie/email.rb

@@ -0,0 +1,61 @@
+require_relative 'ordered'
+
+module Valerie
+  class Email
+    include Ordered
+    
+    def self.from_s(data)
+      data = data[data.index("EMAIL;")..] unless data.start_with?("EMAIL;")
+      identifier = data.split(":").last.split(";")
+      options = data.gsub("EMAIL", "").split(":").first.split(";").compact.filter { _1.to_s.include?('=')}.map { _1.downcase.split("=") }.to_h
+      
+      new(
+        address: identifier[0],
+        **options
+      )
+    end
+    
+    attr_reader :address, :options
+    
+    def initialize(address:, **options)
+      @address = address
+      @options = options
+      
+      raise ArgumentError, 'Invalid Position' if invalid_position?
+    end
+    
+    def [](key)
+      @options[key]
+    end
+    
+    def to_s
+      parts = ['EMAIL']
+      
+      parts << "PERF=#{@options[:position]}" if position?
+      parts << type_to_s if type?
+      
+      parts.join(';') + ":#{@address}"
+    end
+    
+    def to_h
+      {
+        address: @address,
+        position: @options[:position],
+        type: @options[:type],
+      }
+    end
+    
+    private
+      def type?
+        @options[:type]
+      end
+    
+      def type_to_s
+        if @options[:type].is_a?(Array)
+          "TYPE=\"#{@options[:type].join(',')}\""
+        else
+          "TYPE=#{@options[:type]}"
+        end
+      end
+  end
+end

data/lib/valerie/gender.rb

@@ -0,0 +1,42 @@
+module Valerie
+  class Gender
+    SEX_COMPONENTS = {
+      male: 'M',
+      female: 'F',
+      other: 'O',
+      unknown: 'U',
+      none: 'N'
+    }
+    
+    attr_reader :identifier
+    
+    def self.from_s(data)
+      new(data.split(":").last)
+    end
+    
+    def initialize(identifier)
+      if SEX_COMPONENTS.keys.include?(identifier.to_s.downcase.to_sym)
+        @identifier = SEX_COMPONENTS[identifier.to_s.downcase.to_sym]
+      else
+        @identifier = identifier
+      end
+      
+      raise ArgumentError, 'Invalid Sex identifier' unless SEX_COMPONENTS.values.include?(@identifier)
+    end
+    
+    def to_s
+      "GENDER:#{@identifier}"
+    end
+    
+    def to_h
+      {
+        identifier: @identifier,
+        sex:,
+      }
+    end
+    
+    def sex
+      @sex ||= SEX_COMPONENTS.key(@identifier)
+    end
+  end
+end

data/lib/valerie/name.rb

@@ -0,0 +1,44 @@
+module Valerie
+  class Name
+    class << self
+      def new(parts)
+        if parts.is_a?(Hash)
+          super **parts
+        else
+          first_name, last_name = parts.split(" ")
+          
+          super first_name:, last_name:
+        end
+      end
+      
+      def from_s(data)
+        parts = data.gsub("N:", "").split(";")
+        new first_name: parts[1], last_name: parts[0], middle_name: parts[2], prefix: parts[3], suffix: parts[4]
+      end
+    end
+    
+    attr_reader :first_name, :last_name
+    
+    def initialize(first_name: nil, last_name: nil, middle_name: nil, prefix: nil, suffix: nil)
+      @first_name = first_name
+      @last_name = last_name
+      @middle_name = middle_name
+      @prefix = prefix
+      @suffix = suffix
+    end
+    
+    def to_s
+      "N:#{[@last_name, @first_name, @middle_name, @prefix, @suffix].join(";")}"
+    end
+    
+    def to_h
+      {
+        first_name: @first_name,
+        last_name: @last_name,
+        middle_name: @middle_name,
+        prefix: @prefix,
+        suffix: @suffix,
+      }
+    end
+  end
+end

data/lib/valerie/ordered.rb

@@ -0,0 +1,19 @@
+module Valerie
+  module Ordered
+    def invalid_position?
+      position? && position.to_i < 1
+    end
+    
+    def position
+      @options[:position]
+    end
+    
+    def position=(value)
+      @options[:position] = value
+    end
+    
+    def position?
+      position
+    end
+  end
+end

data/lib/valerie/organization.rb

@@ -0,0 +1,47 @@
+module Valerie
+  class Organization
+    attr_reader :name, :department
+    
+    class << self
+      def new(*organization)
+        if organization.first.is_a?(Hash)
+          super(name: organization.first[:name], department: organization.first[:department])
+        else
+          name, department = organization.flatten
+          super(name:, department:)
+        end
+      end
+      
+      def from_s(data)
+        name, department = data.gsub("ORG:", "").split(";")
+        new(name:, department:)
+      end
+    end
+    
+    def initialize(name:, department: nil, **options)
+      @name, @department = name, department
+      @options = options
+    end
+    
+    def to_s
+      "ORG:#{@name};#{department_part}"
+    end
+    
+    def present?
+      @name.to_s.length > 0 || @department.to_s.length > 0
+    end
+    
+    private
+      def department_part
+        if @department.to_s.empty?
+          fallback_department
+        else
+          @department
+        end
+      end
+      
+      def fallback_department
+        " \n"
+      end
+  end
+end

data/lib/valerie/phone.rb

@@ -0,0 +1,61 @@
+require_relative 'ordered'
+
+module Valerie
+  class Phone
+    VALID_TYPES = %w[text voice fax cell video pager textphone].freeze
+    
+    include Ordered
+    
+    def self.from_s(data)
+      data = data[data.index("TEL;")..] unless data.start_with?("TEL;")
+      identifier = data.split(":").last
+      options = data.gsub("TEL", "").split(":").first.split(";").compact.filter { _1.to_s.include?('=')}.map { _1.downcase.split("=") }.to_h
+      
+      new(identifier, **options)
+    end
+    
+    attr_reader :number, :options
+    
+    def initialize(number, **options)
+      @number = number
+      @options = options.transform_keys!(&:to_sym)
+      @type = @options[:type] || 'voice'
+      
+      raise ArgumentError, 'Invalid Position' if invalid_position?
+    end
+    
+    def [](key)
+      @options[key]
+    end
+    
+    def to_s
+      parts = ['TEL']
+      
+      parts << "PERF=#{@options[:position]}" if position?
+      parts << type_to_s if type?
+      
+      parts.join(';') + ":#{@number}"
+    end
+    
+    def to_h
+      {
+        number: @tel,
+        type: @type,
+        position: @options[:position],
+      }
+    end
+    
+    private
+      def type?
+        @options[:type]
+      end
+      
+      def type_to_s
+        if @options[:type].is_a?(Array)
+          "TYPE=\"#{@options[:type].join(',')}\""
+        else
+          "TYPE=#{@options[:type]}"
+        end
+      end
+  end
+end

data/lib/valerie.rb

@@ -12,7 +12,7 @@ require 'valerie/collection/address_collection'
 require 'valerie/collection/phone_collection'
 
 module Valerie
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
   
   def self.configuration
     @configuration ||= Configuration.new

data/test/birthday_test.rb

@@ -0,0 +1,26 @@
+require_relative 'test_helper'
+
+class BirthdayTest < Minitest::Test
+  def test_from_s
+    Valerie::Birthday.from_s('BDAY:1999-11-04').to_date.tap do |date|
+      assert_equal(date.year, 1999)
+      assert_equal(date.month, 11)
+      assert_equal(date.day, 4)
+    end
+  end
+  
+  def test_to_s
+    assert_equal(
+      Valerie::Birthday.from_s('BDAY:1999-11-04').to_s,
+      'BDAY:1999-11-04'
+    )
+  end
+  
+  def test_to_h
+    Valerie::Birthday.from_s('BDAY:1999-11-04').to_h.tap do |hash|
+      assert_equal(hash[:year], 1999)
+      assert_equal(hash[:month], 11)
+      assert_equal(hash[:day], 4)
+    end
+  end
+end

data/test/card_test.rb

@@ -0,0 +1,73 @@
+require_relative 'test_helper'
+
+class VCardTest < Minitest::Test
+  def initialize(name)
+    super
+    @card = Valerie::Card.new
+  end
+  
+  def test_setting_name_with_hash_parameter
+    @card.name = { first_name: 'John', last_name: 'Doe' }
+    
+    assert_equal(@card.name.first_name, 'John')
+    assert_equal(@card.name.last_name, 'Doe')
+  end
+  
+  def test_setting_name_with_string_parameter
+    @card.name = 'Adam Hull'
+    
+    assert_equal(@card.name.first_name, 'Adam')
+    assert_equal(@card.name.last_name, 'Hull')
+  end
+  
+  def test_setting_organization_with_hash
+    @card.organization = { name: 'Hellotext', department: 'Product Development' }
+    
+    assert_equal(@card.organization.name, 'Hellotext')
+    assert_equal(@card.organization.department, 'Product Development')
+  end
+  
+  def test_setting_organization_with_string
+    @card.organization = ['Hellotext', 'Product Development']
+    
+    assert_equal(@card.organization.name, 'Hellotext')
+    assert_equal(@card.organization.department, 'Product Development')
+  end
+  
+  def test_setting_gender_with_valid_identifier
+    assert_runs_without_errors do
+      @card.gender = 'Male'
+      assert_equal(@card.gender.sex, :male)
+    end
+  end
+  
+  def test_setting_gender_with_invalid_identifier
+    assert_raises(ArgumentError) do
+      @card.gender = 'invalid-identifier'
+    end
+  end
+  
+  def test_parsing_array
+    data = ['PRODID:-//Hellotext', 'N:Doe;John;;;', "ORG:HelloText;", "TEL;type=CELL:+598 94 000 000"]
+    
+    Valerie::Card.parse(data).tap do |vcard|
+      assert_equal(vcard.name.first_name, 'John')
+      assert_equal(vcard.name.last_name, 'Doe')
+      
+      assert_equal(vcard.organization.name, 'HelloText')
+      
+      assert_equal(vcard.phones.first.number, '+598 94 000 000')
+      assert_equal(vcard.phones.first.options[:type], 'cell')
+    end
+  end
+  
+  def test_parsing_string
+    data = "BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:-//Hellotext www.hellotext.com//EN\r\nN:Rosenbaum;Shira;;;\r\nTEL;:+598 94 987 924\r\nEND:VCARD"
+    
+    Valerie::Card.parse(data).first.tap do |vcard|
+      assert_equal(vcard.name.first_name, 'Shira')
+      assert_equal(vcard.name.last_name, 'Rosenbaum')
+      assert_equal(vcard.phones.first.number, '+598 94 987 924')
+    end
+  end
+end

data/test/collection/email_collection_test.rb

@@ -0,0 +1,39 @@
+require_relative '../test_helper'
+
+class EmailCollectionTest < Minitest::Test
+  def setup
+    @collection = Valerie::Collection::EmailCollection.new
+  end
+  
+  def test_add_email_as_string
+    email = @collection.add('ahmed@hellotext.com', type: :work)
+    
+    assert_instance_of(Valerie::Email, email)
+    
+    assert_equal(email.address, 'ahmed@hellotext.com')
+    assert_equal(email[:type], :work)
+  end
+  
+  def test_add_email_as_hash
+    email = @collection.add({ address: 'john@hellotext.com', type: :home })
+    
+    assert_instance_of(Valerie::Email, email)
+    assert_equal(email.address, 'john@hellotext.com')
+    assert_equal(email[:type], :home)
+  end
+  
+  def test_add_email_as_email_object
+    email = Valerie::Email.new(address: 'ahmed@hellotext.com', type: :work)
+    @collection.add({ address: 'john@hellotext.com', type: :home })
+    
+    assert_equal(@collection.add(email).position, 2)
+  end
+  
+  def test_setting_the_position_for_each_inserted_email
+    email = @collection.add('ahmed@hellotext.com')
+    email2 = @collection.add('john@hellotext.com')
+    
+    assert_equal(email[:position], 1)
+    assert_equal(email2[:position], 2)
+  end
+end

data/test/collection/phone_collection_test.rb

@@ -0,0 +1,23 @@
+require_relative '../test_helper'
+
+class PhoneCollectionTest < Minitest::Test
+  def setup
+    @collection = Valerie::Collection::PhoneCollection.new
+  end
+  
+  def test_add_phone_as_string
+    phone = @collection.add('1234567890', type: :work)
+    
+    assert_instance_of(Valerie::Phone, phone)
+    
+    assert_equal(phone.number, '1234567890')
+    assert_equal(phone[:type], :work)
+  end
+  
+  def test_add_phone_as_phone_object
+    phone = Valerie::Phone.new('1234567890', type: :work)
+    @collection.add('0987654321', type: :home)
+    
+    assert_equal(@collection.add(phone).position, 2)
+  end
+end

data/test/email_test.rb

@@ -0,0 +1,26 @@
+require_relative 'test_helper'
+
+class EmailTest < Minitest::Test
+  def test_to_s_with_single_type
+    Valerie::Email.new(address: 'ahmed@hellotext.com', type: :work).tap do |email|
+      assert_equal(email.to_s.start_with?('EMAIL;TYPE=work:'), true)
+    end
+  end
+  
+  def test_with_invalid_position
+    error = assert_raises(ArgumentError) do
+      Valerie::Email.new(address: 'ahmed@hellotext.com', position: -1)
+    end
+    
+    assert_equal(error.message, 'Invalid Position')
+  end
+  
+  def test_to_s_with_preferred
+    Valerie::Email.new(address: 'ahmed@hellotext.com', type: :work, position: 1).tap do |email|
+      assert_equal(
+        email.to_s.include?(';PERF=1;'),
+        true
+      )
+    end
+  end
+end

data/test/gender_test.rb

@@ -0,0 +1,36 @@
+require_relative 'test_helper'
+
+class GenderTest < Minitest::Test
+  def test_from_s
+    identifier = 'GENDER:M'
+    
+    Valerie::Gender.from_s(identifier).tap do |entry|
+      assert_equal(entry.identifier, 'M')
+    end
+  end
+  
+  def test_initialize_with_valid_sex_component_key
+    assert_runs_without_errors do
+      Valerie::Gender.new('male').tap do |entry|
+        assert_equal(entry.identifier, 'M')
+        assert_equal(entry.sex, :male)
+      end
+    end
+  end
+  
+  def test_initialize_with_invalid_identifier
+    assert_raises(ArgumentError) do
+      Valerie::Gender.new('invalid-identifier')
+    end
+  end
+  
+  def test_to_s
+    assert_equal(Valerie::Gender.new('M').to_s, 'GENDER:M')
+  end
+  
+  def test_to_h
+    Valerie::Gender.new('M').to_h.tap do |hash|
+      assert_equal(hash[:identifier], 'M')
+    end
+  end
+end

data/test/name_test.rb

@@ -0,0 +1,17 @@
+require_relative 'test_helper'
+
+class NameTest < Minitest::Test
+  def test_initialize_with_hash
+    Valerie::Name.new(first_name: 'Ahmed', last_name: 'Khattab').tap do |name|
+      assert_equal(name.to_h[:first_name], 'Ahmed')
+      assert_equal(name.to_h[:last_name], 'Khattab')
+    end
+  end
+  
+  def test_initialize_with_string
+    Valerie::Name.new('Ahmed Khattab').tap do |name|
+      assert_equal(name.to_h[:first_name], 'Ahmed')
+      assert_equal(name.to_h[:last_name], 'Khattab')
+    end
+  end
+end

data/test/organization_test.rb

@@ -0,0 +1,48 @@
+require_relative 'test_helper'
+
+class OrganizationTest < Minitest::Test
+  def test_new_constructor_with_array
+    Valerie::Organization.new('Hellotext', 'Product Engineer').tap do |org|
+      assert_equal(org.name, 'Hellotext')
+      assert_equal(org.department, 'Product Engineer')
+    end
+  end
+  
+  def test_new_constructor_with_hash
+    Valerie::Organization.new(name: 'Hellotext', department: 'Product Engineer').tap do |org|
+      assert_equal(org.name, 'Hellotext')
+      assert_equal(org.department, 'Product Engineer')
+    end
+  end
+  
+  def test_from_s
+    Valerie::Organization.from_s('ORG:Hellotext;Product Engineer').tap do |org|
+      assert_equal(org.name, 'Hellotext')
+      assert_equal(org.department, 'Product Engineer')
+    end
+  end
+  
+  def test_to_s
+    Valerie::Organization.new(name: 'Hellotext', department: 'Product Engineer').tap do |org|
+      assert_equal(org.to_s, 'ORG:Hellotext;Product Engineer')
+    end
+  end
+  
+  def test_present_when_name_is_set
+    Valerie::Organization.new(name: 'Hellotext').tap do |org|
+      assert_equal(org.present?, true)
+    end
+  end
+  
+  def test_present_when_department_is_set
+    Valerie::Organization.new(department: 'Product Engineer').tap do |org|
+      assert_equal(org.present?, true)
+    end
+  end
+  
+  def test_present_when_none_is_set
+    Valerie::Organization.new.tap do |org|
+      assert_equal(org.present?, false)
+    end
+  end
+end

data/test/phone_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+class PhoneTest < Minitest::Test
+  def test_to_s_with_single_type
+    Valerie::Phone.new('01000000000', type: :voice).tap do |phone|
+      assert_equal(phone.to_s.start_with?('TEL;TYPE=voice:'), true)
+    end
+  end
+  
+  def test_to_s_with_multiple_types
+    Valerie::Phone.new('01000000000', type: %i[voice work]).tap do |phone|
+      assert_equal(phone.to_s, 'TEL;TYPE="voice,work":01000000000')
+    end
+  end
+  
+  def test_with_invalid_position
+    error = assert_raises(ArgumentError) do
+      Valerie::Phone.new('01000000000', position: -1)
+    end
+    
+    assert_equal(error.message, 'Invalid Position')
+  end
+  
+  def test_to_s_with_position
+    Valerie::Phone.new('01000000000', type: :voice, position: 1).tap do |phone|
+      assert_equal(phone.to_s, 'TEL;PERF=1;TYPE=voice:01000000000')
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require_relative '../lib/valerie'
+
+module Minitest::Assertions
+  def assert_runs_without_errors(*)
+    yield
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: valerie
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Hellotext
@@ -45,7 +45,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
 - lib/valerie.rb
+- lib/valerie/address.rb
+- lib/valerie/birthday.rb
+- lib/valerie/card.rb
+- lib/valerie/collection/address_collection.rb
+- lib/valerie/collection/collection.rb
+- lib/valerie/collection/email_collection.rb
+- lib/valerie/collection/phone_collection.rb
+- lib/valerie/core/parser.rb
+- lib/valerie/email.rb
+- lib/valerie/gender.rb
+- lib/valerie/name.rb
+- lib/valerie/ordered.rb
+- lib/valerie/organization.rb
+- lib/valerie/phone.rb
+- test/birthday_test.rb
+- test/card_test.rb
+- test/collection/email_collection_test.rb
+- test/collection/phone_collection_test.rb
+- test/email_test.rb
+- test/gender_test.rb
+- test/name_test.rb
+- test/organization_test.rb
+- test/phone_test.rb
+- test/test_helper.rb
 homepage: https://github.com/hellotext/valerie
 licenses:
 - MIT