yarss 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb088fb3631b5463bb8927d313274cf60231cc77
-  data.tar.gz: 3d32d941a069626c5ca40095aa94141d336e2ca8
+  metadata.gz: f5fc31207ee7282e79e3f9d031087d1c77e8dba7
+  data.tar.gz: 0e06a204c7c09a60c6c9ea09666b1aebe6a82d2a
 SHA512:
-  metadata.gz: cd09570af97b5d8abe25d824293b5a7d5bd08411b6e8e968d9fe72ea274ae4e08f42066a49f6507245f714a8321775bd7e503ed26522557b541c4a1ae58b676e
-  data.tar.gz: 7ed021d0ec037c09e6e19fbb023450f9d8b8e36ad0d23236e38fca69cc1876acb2db6ae0da88aa97a129e993168ffee464982f2fd04e7ad3a319f87cd64d29b5
+  metadata.gz: d2c85c04789c1e6864756f26bd5951ba92475dea47f228b78f09c2300e0f719c00042a198a5c515855aee9b275f3cf64bd4154d506a2485247b6f224c10136da
+  data.tar.gz: 581178f47cc9542e111f2211ecf79e05961657807f8cf92c4a4fe5a94e3be46db2e601d3b9095c4a7be5634665b2f157c14418914780933051099480d75a7dee

data/README.md

@@ -12,13 +12,17 @@ the fastest XML parser I know of. JRuby users should probably use
 
 ```ruby
 ['path/to/feed.rss', 'path/to/feed.atom', 'path/to/feed.rdf'].each do |file_path|
-  feed = Yarss.new(file_path)
-
-  puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  feed.title       # => "Foo's bars"
+  feed.link        # => 'http://foo.bar/'
+  feed.description # => 'Bars everywhere!'
 
   feed.items.each do |item|
-    puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
-    puts item.content
+    item.id         # => 'id'
+    item.title      # => 'Hello!'
+    item.updated_at # => #<DateTIme ...>
+    item.link       # => 'http://foo.bar/1'
+    item.author     # => 'Joe'
+    item.content    # => '<p>Hi!</p>'
   end
 end
 ```

data/lib/yarss/atom/item_parser.rb

@@ -28,6 +28,7 @@ module Yarss
           title:      title,
           updated_at: updated,
           link:       link,
+          author:     author,
           content:    content
         )
       end
@@ -76,6 +77,15 @@ module Yarss
         raise ParseError, e
       end
 
+      # Extract the author.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def author
+        Attribute.author_value(data['author'] || '')
+      end
+
       # Extract the content.
       #
       # @return [String]

data/lib/yarss/attribute.rb

@@ -30,6 +30,32 @@ module Yarss
       raise ParseError, e
     end
 
+    # Extract a +String+ value from a given author attribute.
+    #
+    # @raise [ParseError] If type of value is not known.
+    #
+    # @example
+    #   Yarss::Attribute.author_value('Foo') # => 'Foo'
+    #   Yarss::Attribute.author_value('name' => 'Foo') # => 'Foo'
+    #
+    # @param value [String, Hash] An attribute.
+    #
+    # @return [String]
+    def self.author_value(value)
+      value ||= ''
+
+      case value
+      when Hash
+        value(value.fetch('name'))
+      when String
+        value.strip
+      else
+        raise ParseError, "Unknown #{value.class} attribute: #{value.inspect}"
+      end
+    rescue KeyError => e
+      raise ParseError, e
+    end
+
     # Extract a +String+ value from a given link attribute.
     #
     # @raise [ParseError] If type of value is not known or no link is found.

data/lib/yarss/item.rb

@@ -23,6 +23,11 @@ module Yarss
     # @return [String]
     attr_accessor :link
 
+    # Author.
+    #
+    # @return [String]
+    attr_accessor :author
+
     # Content.
     #
     # @return [String]
@@ -41,13 +46,14 @@ module Yarss
     # @param other [Item]
     #
     # @return [Bool]
-    def ==(other) # rubocop:disable Metrics/AbcSize
+    def ==(other)
       return false unless other.is_a?(self.class)
 
       id           == other.id         &&
         title      == other.title      &&
         updated_at == other.updated_at &&
         link       == other.link       &&
+        author     == other.author     &&
         content    == other.content
     end
   end

data/lib/yarss/rdf/item_parser.rb

@@ -26,6 +26,7 @@ module Yarss
           title:      title,
           updated_at: updated,
           link:       link,
+          author:     author,
           content:    description
         )
       end
@@ -83,6 +84,23 @@ module Yarss
         raise ParseError, e
       end
 
+      # Extract the author.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def author
+        author = if data['dc:creator']
+                   data['dc:creator']
+                 else
+                   data.fetch('creator')
+                 end
+
+        Attribute.value(author)
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
       # Extract the description.
       #
       # @return [String]

data/lib/yarss/rss/item_parser.rb

@@ -28,6 +28,7 @@ module Yarss
           title:      title,
           updated_at: pub_date,
           link:       link,
+          author:     author,
           content:    description
         )
       end
@@ -78,6 +79,25 @@ module Yarss
         raise ParseError, e
       end
 
+      # Extract the author.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def author
+        author = if data['dc:creator']
+                   data['dc:creator']
+                 elsif data['creator']
+                   data['creator']
+                 elsif data['author']
+                   data['author']
+                 else
+                   ''
+                 end
+
+        Attribute.value(author)
+      end
+
       # Extract the content.
       #
       # @return [String]

data/lib/yarss/version.rb

@@ -2,5 +2,5 @@
 
 module Yarss
   # Version number, happy now?
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/yarss.rb

@@ -31,11 +31,17 @@ module Yarss
   # @example
   #   feed = Yarss.new('path/to/feed.rss')
   #
-  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #   feed.title       # => "Foo's bars"
+  #   feed.link        # => 'http://foo.bar/'
+  #   feed.description # => 'Bars everywhere!'
   #
   #   feed.items.each do |item|
-  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
-  #     puts item.content
+  #     item.id         # => 'id'
+  #     item.title      # => 'Hello!'
+  #     item.updated_at # => #<DateTIme ...>
+  #     item.link       # => 'http://foo.bar/1'
+  #     item.author     # => 'Joe'
+  #     item.content    # => '<p>Hi!</p>'
   #   end
   #
   # @return [Feed]
@@ -58,11 +64,17 @@ module Yarss
   #   feed = Yarss.from_io(Pathname.new('path/to/feed.rss'))
   #   feed = Yarss.from_io(File.open('path/to/feed.rss', 'rb'))
   #
-  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #   feed.title       # => "Foo's bars"
+  #   feed.link        # => 'http://foo.bar/'
+  #   feed.description # => 'Bars everywhere!'
   #
   #   feed.items.each do |item|
-  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
-  #     puts item.content
+  #     item.id         # => 'id'
+  #     item.title      # => 'Hello!'
+  #     item.updated_at # => #<DateTIme ...>
+  #     item.link       # => 'http://foo.bar/1'
+  #     item.author     # => 'Joe'
+  #     item.content    # => '<p>Hi!</p>'
   #   end
   #
   # @return [Feed]
@@ -81,11 +93,17 @@ module Yarss
   # @example
   #   feed = Yarss.from_file('path/to/feed.rss')
   #
-  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #   feed.title       # => "Foo's bars"
+  #   feed.link        # => 'http://foo.bar/'
+  #   feed.description # => 'Bars everywhere!'
   #
   #   feed.items.each do |item|
-  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
-  #     puts item.content
+  #     item.id         # => 'id'
+  #     item.title      # => 'Hello!'
+  #     item.updated_at # => #<DateTIme ...>
+  #     item.link       # => 'http://foo.bar/1'
+  #     item.author     # => 'Joe'
+  #     item.content    # => '<p>Hi!</p>'
   #   end
   #
   # @return [Feed]
@@ -105,11 +123,17 @@ module Yarss
   # @example
   #   feed = Yarss.from_string('...)
   #
-  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #   feed.title       # => "Foo's bars"
+  #   feed.link        # => 'http://foo.bar/'
+  #   feed.description # => 'Bars everywhere!'
   #
   #   feed.items.each do |item|
-  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
-  #     puts item.content
+  #     item.id         # => 'id'
+  #     item.title      # => 'Hello!'
+  #     item.updated_at # => #<DateTIme ...>
+  #     item.link       # => 'http://foo.bar/1'
+  #     item.author     # => 'Joe'
+  #     item.content    # => '<p>Hi!</p>'
   #   end
   #
   # @return [Feed]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarss
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Oldrich Vetesnik
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler