feedjira-opml 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201ffda52b0713dc676b59f0670b8cb06d1047a8
-  data.tar.gz: 0404f07ac3fe2dfd6c50b0797994983507034b8b
+  metadata.gz: 08527b867147e345f87f219b2a948b0b5c7b15ab
+  data.tar.gz: d937389bbc4bf1ea30ca557dae8bbda16d4917e2
 SHA512:
-  metadata.gz: 21bd60a38ef3f0ba63a05f7cad2b0bb4f20f33e1f0981cd38f98b5138ca9aa301f8eb554b87b7149502ac87798ad3ee369cfb8f5be40e3819340c88bee62ac1b
-  data.tar.gz: 7338d989446d8211db7ea16fc8a15be453f0a7d7f435dea5b880b0b65d741a0d4fc30caf52ff275ef42b53bd134738fdaff80bedd548550f58d74a9e6d838bf5
+  metadata.gz: cf06beb6bd7995d17cb3cc541c6196b4ecf3a2d2e1456e9de236d461528e507d558e56d73ae674ef45f439ee8117c17d6d7173b76dee147328032df92a9ef02c
+  data.tar.gz: 07d5288c8e396c3e88bc7d562fff624ec424033158e8e2047f805abcf70b979b621b4318b873495299e4af7810884dd5ad4f2a8f499f41e05a2ff151dcd1d960

data/README.md

@@ -1,39 +1,54 @@
 # Feedjira::Opml
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/feedjira/opml`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](http://img.shields.io/gem/v/feedjira-opml.svg)](https://rubygems.org/gems/feedjira-opml)
+[![Dependency Status](https://gemnasium.com/farski/feedjira-opml.svg)](https://gemnasium.com/farski/feedjira-opml)
+[![Build Status](https://travis-ci.org/farski/feedjira-opml.svg)](https://travis-ci.org/farski/feedjira-opml)
+[![Code Climate](https://codeclimate.com/github/farski/feedjira-opml/badges/gpa.svg)](https://codeclimate.com/github/farski/feedjira-opml)
+[![Coverage Status](https://coveralls.io/repos/farski/feedjira-opml/badge.svg)](https://coveralls.io/r/farski/feedjira-opml)
 
-TODO: Delete this and the text above, and describe your gem
+This gem registers a new parser with [Feedjira](http://feedjira.com/) which provides basic support for OPML files. It is based on OPML version 2.0, but does not currently support all aspects of the specification (directories, for example, are not supported).
 
-## Installation
+Beyond what is provided by [Feedjira](https://github.com/feedjira/feedjira), there is no support for converting OPML files to hashes, or generating valid OPML from other data sources.
 
-Add this line to your application's Gemfile:
+## Usage
+
+Since **feedjira-opml** automatically registers its OPML parser with Feedjira, using the standard processing methods should generally yield the desired results.
 
 ```ruby
-gem 'feedjira-opml'
+Feedjira::Feed.parse(string_of_xml)
 ```
 
-And then execute:
+The OPML parser will match on `/\<opml/`, so it won't conflict with `RSS`, `Atom`, or other native Feedjira parsers.
+
+If its necessary to use the OPML parser explicitly:
 
-    $ bundle
+```ruby
+Feedjira::Feed.parse_with(Feedjira::Parser::OPML, string_of_xml)
+```
 
-Or install it yourself as:
+### Output
 
-    $ gem install feedjira-opml
+All elements and attributes are typecast based on the OPML specification. The behavior for handling that don't adhere to the spec is undefined.
 
-## Usage
+```ruby
+@opml.head.title
+@opml.head.owner_name
+@opml.head.date_created # Returns a Time
+@opml.head.expansion_state # Returns an Array
+```
 
-TODO: Write usage instructions here
+Working with outlines is similar.
 
-## Development
+```ruby
+outline = @opml.body.outlines.first
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+url = outline.xml_url # Returns a URI
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The `isComment` and `isBreakpoint` attributes are converted to booleans and accessed through convenience methods.
 
-## Contributing
+```ruby
+is_comment = outline.comment?
+```
 
-1. Fork it ( https://github.com/[my-github-username]/feedjira-opml/fork )
-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 a new Pull Request
+There are certain situations where the spec requires certain values meet some criteria based on other values, (e.g. _"An outline element whose type is link must have a url attribute whose value is an http address."_). These requirements are not currently enforced by the parser.

data/feedjira-opml.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.5'
+  spec.add_development_dependency 'coveralls'
 
   spec.add_runtime_dependency 'feedjira', '~> 1.6'
 end

data/lib/feedjira/opml/version.rb

@@ -1,5 +1,5 @@
 module Feedjira
   module OPML
-    VERSION = '1.0.3'
+    VERSION = '2.0.0'
   end
 end

data/lib/feedjira/parser/opml_head.rb

@@ -5,18 +5,43 @@ module Feedjira
       include FeedUtilities
 
       element :title
-      element :dateCreated, as: :date_created
-      element :dateModified, as: :date_modified
+
+      element :dateCreated, as: :date_created do |s|
+        Time.parse(s)
+      end
+
+      element :dateModified, as: :date_modified do |s|
+        Time.parse(s)
+      end
+
       element :ownerName, as: :owner_name
       element :ownerEmail, as: :owner_email
       element :ownerId, as: :owner_id
       element :docs
-      element :expansionState, as: :expansion_state
-      element :vertScrollState, as: :vert_scroll_state
-      element :windowTop, as: :window_top
-      element :windowLeft, as: :window_left
-      element :windowBottom, as: :window_bottom
-      element :windowRight, as: :window_right
+
+      element :expansionState, as: :expansion_state do |s|
+        s.split(',').map{ |x| x.to_f }
+      end
+
+      element :vertScrollState, as: :vert_scroll_state do |s|
+        s.to_f
+      end
+
+      element :windowTop, as: :window_top do |s|
+        s.to_f
+      end
+
+      element :windowLeft, as: :window_left do |s|
+        s.to_f
+      end
+
+      element :windowBottom, as: :window_bottom do |s|
+        s.to_f
+      end
+
+      element :windowRight, as: :window_right do |s|
+        s.to_f
+      end
     end
   end
 end

data/lib/feedjira/parser/opml_outline.rb

@@ -6,17 +6,40 @@ module Feedjira
 
       attribute :type
       attribute :text
-      attribute :xmlUrl, as: :xml_url
+
+      attribute :xmlUrl, as: :xml_url do |s|
+        URI(s)
+      end
+
       attribute :isComment, as: :is_comment
       attribute :isBreakpoint, as: :is_breakpoint
-      attribute :created
+
+      attribute :created do |s|
+        Time.parse(s)
+      end
+
       attribute :category
       attribute :description
-      attribute :htmlUrl, as: :html_url
+
+      attribute :htmlUrl, as: :html_url do |s|
+        URI(s)
+      end
+
       attribute :language
       attribute :title
       attribute :version
-      attribute :url
+
+      attribute :url do |s|
+        URI(s)
+      end
+
+      def comment?
+        !!is_comment && is_comment == 'true'
+      end
+
+      def breakpoint?
+        !!is_breakpoint && is_breakpoint == 'true'
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedjira-opml
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Kalafarski
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: feedjira
   requirement: !ruby/object:Gem::Requirement