xommelier 0.1.34 → 0.1.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7cbfd8f546a2bbc53ff4c9e6a1afc454ad6d84d9
-  data.tar.gz: 0a1ea0a41b9f169e02cbc65b20763e67aa597d55
+SHA256:
+  metadata.gz: 4705ce526033f604f2622bec11450dd7afd4032a34df09d5b71beb569c6f1022
+  data.tar.gz: 485c88af2cbbca7b477073ab18ac1077b7d70e993dab591a429c34c315b41858
 SHA512:
-  metadata.gz: 0c4a70b3018965c81ad18c362e8fc3a59d8755ad7713eaedcb18f736651867044b68a599a506bccbf0c5c3497eff07ff130ae98552978afe241ec423afa07384
-  data.tar.gz: b68e31e5b1c23981ae55ac1b62d735cdd188e089a5071e3a9cf083d372a620f17e7a6c63238e98da117e3e3e8d8e988334d04069982709b2d8cc9c856fd1055a
+  metadata.gz: f90951abc1a2e9d35192a3bc254a040a12cb81c310f8a142ce39d62d1d66ee3d2b86ec52bf9eb25df0164e81da1a30ff1a00b1d5eeef7c03578f30f0071069ed
+  data.tar.gz: dd753cd00aea1bdac155918206d7731c8fa85078392a493dbea8154657a70981a89bd40b0bf0e1e600cfe6e0c178757aa6e081e5618cce0dd66d1bd22ba0b577

data/.gitlab-ci.yml

@@ -0,0 +1,19 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+image: ruby:latest
+
+# Cache gems in between builds
+cache:
+  paths:
+  - .bundle
+
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+- ruby -v                                   # Print out ruby version for debugging
+- gem install bundler --no-ri --no-rdoc     # Bundler is not installed with the image
+- bundle install -j $(nproc) --path .bundle # Install dependencies into ./.bundle
+
+rake:
+  script:
+  - rake

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-04-06 23:00:54 +0300 using RuboCop version 0.48.1.
+# on 2018-10-07 22:45:49 +0300 using RuboCop version 0.59.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -9,15 +9,49 @@
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/Gemfile, **/gems.rb
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
 Bundler/OrderedGems:
   Exclude:
     - 'Gemfile'
 
+# Offense count: 11
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/xommelier/common.rb'
+    - 'lib/xommelier/core_ext/float.rb'
+    - 'lib/xommelier/core_ext/numeric.rb'
+    - 'lib/xommelier/core_ext/string.rb'
+    - 'lib/xommelier/core_ext/time.rb'
+    - 'lib/xommelier/core_ext/uri.rb'
+    - 'lib/xommelier/ds.rb'
+    - 'lib/xommelier/dsig11.rb'
+    - 'lib/xommelier/xml/element/serialization.rb'
+    - 'lib/xommelier/xml/element/structure/property.rb'
+    - 'lib/xommelier/xml/schema.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    - 'bin/rake'
+    - 'bin/rubocop'
+    - 'example/atom.rb'
+    - 'example/xml.rb'
+
 # Offense count: 1
 Lint/ShadowingOuterLocalVariable:
   Exclude:
-    - 'examples/atom.rb'
+    - 'example/atom.rb'
+
+# Offense count: 1
+# Configuration parameters: CheckForMethodsWithNoSideEffects.
+Lint/Void:
+  Exclude:
+    - 'lib/xommelier/xml/schema.rb'
 
 # Offense count: 9
 Metrics/AbcSize:
@@ -25,6 +59,7 @@ Metrics/AbcSize:
 
 # Offense count: 15
 # Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 96
 
@@ -32,26 +67,46 @@ Metrics/BlockLength:
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 125
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 265
-
-# Offense count: 10
-# Configuration parameters: CountComments.
+# Offense count: 9
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 46
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 203
+  Max: 199
 
 # Offense count: 3
 Metrics/PerceivedComplexity:
   Max: 15
 
+# Offense count: 3
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/xommelier/rss.rb'
+    - 'lib/xommelier/xml/schema.rb'
+
+# Offense count: 1
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/xommelier/ds.rb'
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/xommelier/xml/element/serialization.rb'
+
 # Offense count: 1
 RSpec/DescribeSymbol:
   Exclude:
@@ -65,7 +120,14 @@ RSpec/EmptyExampleGroup:
     - 'spec/lib/xommelier/xml_spec.rb'
     - 'spec/lib/xommelier_spec.rb'
 
+# Offense count: 2
+# Cop supports --auto-correct.
+RSpec/EmptyLineAfterExampleGroup:
+  Exclude:
+    - 'spec/functional/xommelier/atom/feed/parsing_spec.rb'
+
 # Offense count: 5
+# Cop supports --auto-correct.
 RSpec/EmptyLineAfterFinalLet:
   Exclude:
     - 'spec/functional/xommelier/atom/feed/parsing_spec.rb'
@@ -75,6 +137,7 @@ RSpec/EmptyLineAfterFinalLet:
     - 'spec/lib/xommelier/ds/signature_spec.rb'
 
 # Offense count: 12
+# Cop supports --auto-correct.
 RSpec/EmptyLineAfterSubject:
   Exclude:
     - 'spec/functional/xommelier/atom/feed/parsing_spec.rb'
@@ -84,7 +147,8 @@ RSpec/EmptyLineAfterSubject:
     - 'spec/lib/xommelier/ds/transform_spec.rb'
 
 # Offense count: 101
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
 # SupportedStyles: is_expected, should
 RSpec/ImplicitExpect:
   Exclude:
@@ -104,7 +168,16 @@ RSpec/ImplicitExpect:
     - 'spec/lib/xommelier/ds/transform_spec.rb'
     - 'spec/lib/xommelier/ds_spec.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: single_line_only, disallow
+RSpec/ImplicitSubject:
+  Exclude:
+    - 'spec/functional/xommelier/atom/feed/parsing_spec.rb'
+
 # Offense count: 6
+# Cop supports --auto-correct.
 RSpec/LeadingSubject:
   Exclude:
     - 'spec/functional/xommelier/atom/feed/building_hash_spec.rb'
@@ -115,6 +188,7 @@ RSpec/LeadingSubject:
     - 'spec/lib/xommelier/ds/signature_spec.rb'
 
 # Offense count: 1
+# Configuration parameters: AggregateFailuresByDefault.
 RSpec/MultipleExpectations:
   Max: 2
 
@@ -127,17 +201,21 @@ RSpec/NamedSubject:
     - 'spec/support/schema_validatable.rb'
 
 # Offense count: 5
-# Configuration parameters: Max.
 RSpec/NestedGroups:
-  Exclude:
-    - 'spec/functional/xommelier/atom/feed/parsing_spec.rb'
+  Max: 5
 
 # Offense count: 2
 RSpec/RepeatedExample:
   Exclude:
     - 'spec/functional/xommelier/rss/rss/parsing_spec.rb'
 
+# Offense count: 1
+Security/Open:
+  Exclude:
+    - 'spec/support/fixtures.rb'
+
 # Offense count: 69
+# Configuration parameters: AllowedChars.
 Style/AsciiComments:
   Enabled: false
 
@@ -147,7 +225,8 @@ Style/CaseEquality:
     - 'lib/xommelier/xml/element/serialization.rb'
 
 # Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Exclude:
@@ -168,18 +247,6 @@ Style/EachWithObject:
   Exclude:
     - 'lib/xommelier/xml/element/serialization.rb'
 
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/EmptyLineAfterMagicComment:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'bin/rake'
-    - 'bin/rubocop'
-    - 'examples/atom.rb'
-    - 'examples/xml.rb'
-
 # Offense count: 2
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
@@ -193,10 +260,15 @@ Style/IfInsideElse:
     - 'lib/xommelier/xml/element/serialization.rb'
 
 # Offense count: 1
-Style/MethodMissing:
+Style/MissingRespondToMissing:
   Exclude:
     - 'lib/xommelier/rss.rb'
 
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'example/atom.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/MultilineIfModifier:
@@ -214,16 +286,6 @@ Style/PercentLiteralDelimiters:
     - 'spec/lib/xommelier/atom/entry_spec.rb'
     - 'spec/lib/xommelier/xml/element_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-Style/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/xommelier/ds.rb'
-
 # Offense count: 4
 # Cop supports --auto-correct.
 Style/RedundantFreeze:
@@ -235,15 +297,21 @@ Style/RedundantFreeze:
 
 # Offense count: 3
 # Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles.
+# Configuration parameters: MinSize.
 # SupportedStyles: percent, brackets
 Style/SymbolArray:
   EnforcedStyle: brackets
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, AllowSafeAssignment.
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
 # SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
 Style/TernaryParentheses:
   Exclude:
     - 'lib/xommelier/xml/element/serialization.rb'
+
+# Offense count: 125
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 265

data/.travis.yml

@@ -2,6 +2,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.3.0
+- 2.5.0
 bundler_args: --without ide documentation

data/.yardopts

@@ -1,2 +1,6 @@
 --title=Xommelier
 --markup=markdown
+--files=example/building_an_atom_feed.rb
+--files=example/building_an_atom_feed_using_hash.rb
+--files=example/reading_an_atom_feed.rb
+--readme=README.md

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+© Alex Semyonov, 2011-2017
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -17,170 +17,13 @@ Look into {Xommelier::Atom}, {Xommelier::Atom::Threading}, and {Xommelier::Atom:
 * [![Build Status](https://travis-ci.org/alsemyonov/xommelier.png?branch=master)](http://travis-ci.org/alsemyonov/xommelier)
 * [![Dependency Status](https://gemnasium.com/alsemyonov/xommelier.png)](https://gemnasium.com/alsemyonov/xommelier)
 
-## Examples with Atom
-
-```ruby
-require 'xommelier/atom/full'
-```
-
-### Reading a feed
-
-```ruby
-feed = Xommelier::Atom::Feed.parse(open('spec/fixtures/feed.atom.xml'))
-puts feed.id, feed.title, feed.updated
-
-feed.entries do |entry|
-  puts entry.id, entry.title, entry.published, entry.updated
-  puts entry.content || entry.summary
-end
-```
-
-### Building a feed
-
-```ruby
-feed = Xommelier::Atom::Feed.new
-feed.id = 'http://example.com/blog'
-feed.title = 'Example.com blog'
-feed.complete = Xommelier::Atom::History::Complete.new
-
-entry = feed.entry = Xommelier::Atom::Entry.new(
-  id: 'http://example.com/blog/2012/03/05',
-  title: "Happy Xommelier's day!",
-  updated: 5.days.ago
-).tap do |entry|
-  entry.link = Xommelier::Atom::Link.new(
-    href: entry.id,
-    rel:  'alternate',
-    type: 'text/html'
-  )
-  entry.links << Xommelier::Atom::Link.new(
-    href:  "#{entry.id}/comments.atom",
-    rel:   'replies',
-    type:  'application/atom+xml',
-    count: 5
-  )
-end
-
-# Add Comments
-3.times do |i|
-  feed.entries << Xommelier::Atom::Entry.new(
-    id: "http://example.com/blog/2012/03/05#comment_#{i}",
-    title: ('Hooray! ' * (i + 1)).strip,
-    updated: (5 - i).days.ago
-  ).tap do |comment|
-    comment.in_reply_to = Xommelier::Atom::Threading::InReplyTo.new(
-      ref: entry.id,
-      href: entry.link.href
-    )
-  end
-end
-
-puts feed.to_xml
-```
-
-will output:
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0" xmlns:fh="http://purl.org/syndication/history/1.0">
-  <id>http://example.com/blog</id>
-  <title>Example.com blog</title>
-  <fh:complete/>
-  <entry>
-    <id>http://example.com/blog/2012/03/05</id>
-    <title>Happy Xommelier's day!</title>
-    <updated>2012-02-29T07:52:51+04:00</updated>
-    <link href="http://example.com/blog/2012/03/05" rel="alternate" type="text/html"/>
-    <link href="http://example.com/blog/2012/03/05/comments.atom" rel="replies" type="application/atom+xml" thr:count="5"/>
-  </entry>
-  <entry>
-    <id>http://example.com/blog/2012/03/05#comment_0</id>
-    <title>Hooray!</title>
-    <updated>2012-02-29T07:52:51+04:00</updated>
-    <thr:in-reply-to ref="http://example.com/blog/2012/03/05" href="http://example.com/blog/2012/03/05"/>
-  </entry>
-  <entry>
-    <id>http://example.com/blog/2012/03/05#comment_1</id>
-    <title>Hooray! Hooray!</title>
-    <updated>2012-03-01T07:52:51+04:00</updated>
-    <thr:in-reply-to ref="http://example.com/blog/2012/03/05" href="http://example.com/blog/2012/03/05"/>
-  </entry>
-  <entry>
-    <id>http://example.com/blog/2012/03/05#comment_2</id>
-    <title>Hooray! Hooray! Hooray!</title>
-    <updated>2012-03-02T07:52:51+04:00</updated>
-    <thr:in-reply-to ref="http://example.com/blog/2012/03/05" href="http://example.com/blog/2012/03/05"/>
-  </entry>
-</feed>
-```
-
-### Building from hash
-
-```ruby
-feed = Xommelier::Atom::Feed.new(
-  {
-    title: 'Xommelier nest elements',
-    subtitle: 'Xommelier is able to build complex objects from very nested hash',
-    author: { name: 'Alexander', email: 'al@semyonov.us' },
-    updated: Time.utc(2012, 04, 04, 04, 04),
-    contributors: [
-      { name: 'Ivan', email: 'ivan@example.com' },
-      { name: 'Pyotr', email: 'pyotr@example.com' },
-      { name: 'Sidor', email: 'sidor@example.com' },
-    ],
-    entries: [
-      { title: 'First article', updated: Time.utc(2012, 01, 01, 01, 01) },
-      { title: 'Second article', updated: Time.utc(2012, 02, 02, 02, 02) },
-      { title: 'Third article', updated: Time.utc(2012, 03, 03, 03, 03) },
-    ]
-  }
-)
-
-Xommelier::Atom::Person === feed.author           #=> true
-Xommelier::Atom::Person === feed.contributors[1]  #=> true
-Xommelier::Atom::Entry === feed.entries[2]        #=> true
-
-puts feed.to_xml
-```
-
-will output
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom">
-  <title>Xommelier nest elements</title>
-  <subtitle>Xommelier is able to build complex objects from very nested hash</subtitle>
-  <author>
-    <name>Alexander</name>
-    <email>al@semyonov.us</email>
-  </author>
-  <updated>2012-04-04T04:04:00Z</updated>
-  <contributor>
-    <name>Ivan</name>
-    <email>ivan@example.com</email>
-  </contributor>
-  <contributor>
-    <name>Pyotr</name>
-    <email>pyotr@example.com</email>
-  </contributor>
-  <contributor>
-    <name>Sidor</name>
-    <email>sidor@example.com</email>
-  </contributor>
-  <entry>
-    <title>First article</title>
-    <updated>2012-01-01T01:01:00Z</updated>
-  </entry>
-  <entry>
-    <title>Second article</title>
-    <updated>2012-02-02T02:02:00Z</updated>
-  </entry>
-  <entry>
-    <title>Third article</title>
-    <updated>2012-03-03T03:03:00Z</updated>
-  </entry>
-</feed>
-```
+## Examples
+
+See `examples` dir for examples of:
+
+* reading an Atom feed;
+* building an Atom feed;
+* building an Atom feed from hash;
 
 ## Built in XML namespaces:
 
@@ -191,6 +34,7 @@ will output
 
 ## TODO
 
+* Rebuild on top of ROM
 * Validating built XML against RelaxNG
 * Converting XML Schema, RelaxNG, RelaxNG Compact and DTD into Xommelier Ruby DSL
 * ActiveRecord-like automatic loading of XML Schema, RelaxNG, RelaxNG Compact and DTD without needing to write it down into ruby code
@@ -200,8 +44,6 @@ will output
 * Art Semyonov, [@artps](https://github.com/artps)
 * Sergey Ukustov, [@ukstv](https://github.com/ukstv)
 
-© Alexander Semyonov, 2011-2012. See MIT-LICENSE for details
-
+© Alex Semyonov, 2011-2017. See LICENSE for details
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/alsemyonov/xommelier/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-