summaryrefslogtreecommitdiff
path: root/lib/rss/atom.rb
blob: 48c27330d0b8f29a21d726f6a0d18ba88d0aa57c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
# frozen_string_literal: false
require_relative 'parser'

module RSS
  ##
  # Atom is an XML-based document format that is used to describe 'feeds' of related information.
  # A typical use is in a news feed where the information is periodically updated and which users
  # can subscribe to.  The Atom format is described in http://tools.ietf.org/html/rfc4287
  #
  # The Atom module provides support in reading and creating feeds.
  #
  # See the RSS module for examples consuming and creating feeds.
  module Atom

    ##
    # The Atom URI W3C Namespace

    URI = "http://www.w3.org/2005/Atom"

    ##
    # The XHTML URI W3C Namespace

    XHTML_URI = "http://www.w3.org/1999/xhtml"

    module CommonModel
      NSPOOL = {}
      ELEMENTS = []

      def self.append_features(klass)
        super
        klass.install_must_call_validator("atom", URI)
        [
         ["lang", :xml],
         ["base", :xml],
        ].each do |name, uri, required|
          klass.install_get_attribute(name, uri, required, [nil, :inherit])
        end
        klass.class_eval do
          class << self
            # Returns the Atom URI W3C Namespace
            def required_uri
              URI
            end

            # Returns true
            def need_parent?
              true
            end
          end
        end
      end
    end

    module ContentModel
      module ClassMethods
        def content_type
          @content_type ||= nil
        end
      end

      class << self
        def append_features(klass)
          super
          klass.extend(ClassMethods)
          klass.content_setup(klass.content_type, klass.tag_name)
        end
      end

      def maker_target(target)
        target
      end

      private
      def setup_maker_element_writer
        "#{self.class.name.split(/::/).last.downcase}="
      end

      def setup_maker_element(target)
        target.__send__(setup_maker_element_writer, content)
        super
      end
    end

    module URIContentModel
      class  << self
        def append_features(klass)
          super
          klass.class_eval do
            @content_type = [nil, :uri]
            include(ContentModel)
          end
        end
      end
    end

    # The TextConstruct module is used to define a Text construct Atom element,
    # which is used to store small quantities of human-readable text.
    #
    # The TextConstruct has a type attribute, e.g. text, html, xhtml
    #
    # Reference: https://validator.w3.org/feed/docs/rfc4287.html#text.constructs
    module TextConstruct
      def self.append_features(klass)
        super
        klass.class_eval do
          [
           ["type", ""],
          ].each do |name, uri, required|
            install_get_attribute(name, uri, required, :text_type)
          end

          content_setup
          add_need_initialize_variable("xhtml")

          class << self
            def xml_getter
              "xhtml"
            end

            def xml_setter
              "xhtml="
            end
          end
        end
      end

      attr_writer :xhtml

      # Returns or builds the XHTML content.
      def xhtml
        return @xhtml if @xhtml.nil?
        if @xhtml.is_a?(XML::Element) and
            [@xhtml.name, @xhtml.uri] == ["div", XHTML_URI]
          return @xhtml
        end

        children = @xhtml
        children = [children] unless children.is_a?(Array)
        XML::Element.new("div", nil, XHTML_URI,
                         {"xmlns" => XHTML_URI}, children)
      end

      # Returns true if type is "xhtml".
      def have_xml_content?
        @type == "xhtml"
      end

      # Raises a MissingTagError or NotExpectedTagError
      # if the element is not properly formatted.
      def atom_validate(ignore_unknown_element, tags, uri)
        if have_xml_content?
          if @xhtml.nil?
            raise MissingTagError.new("div", tag_name)
          end
          unless [@xhtml.name, @xhtml.uri] == ["div", XHTML_URI]
            raise NotExpectedTagError.new(@xhtml.name, @xhtml.uri, tag_name)
          end
        end
      end

      private
      def maker_target(target)
        target.__send__(self.class.name.split(/::/).last.downcase) {|x| x}
      end

      def setup_maker_attributes(target)
        target.type = type
        target.content = content
        target.xml_content = @xhtml
      end
    end

    # The PersonConstruct module is used to define a person Atom element that can be
    # used to describe a person, corporation or similar entity.
    #
    # The PersonConstruct has a Name, Uri and Email child elements.
    #
    # Reference: https://validator.w3.org/feed/docs/rfc4287.html#atomPersonConstruct
    module PersonConstruct

      # Adds attributes for name, uri, and email to the +klass+
      def self.append_features(klass)
        super
        klass.class_eval do
          [
           ["name", nil],
           ["uri", "?"],
           ["email", "?"],
          ].each do |tag, occurs|
            install_have_attribute_element(tag, URI, occurs, nil, :content)
          end
        end
      end

      def maker_target(target)
        target.__send__("new_#{self.class.name.split(/::/).last.downcase}")
      end

      # The name of the person or entity.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.name
      class Name < RSS::Element
        include CommonModel
        include ContentModel
      end

      # The URI of the person or entity.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.uri
      class Uri < RSS::Element
        include CommonModel
        include URIContentModel
      end

      # The email of the person or entity.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.email
      class Email < RSS::Element
        include CommonModel
        include ContentModel
      end
    end

    # Element used to describe an Atom date and time in the ISO 8601 format
    #
    # Examples:
    # * 2013-03-04T15:30:02Z
    # * 2013-03-04T10:30:02-05:00
    module DateConstruct
      def self.append_features(klass)
        super
        klass.class_eval do
          @content_type = :w3cdtf
          include(ContentModel)
        end
      end

      # Raises NotAvailableValueError if element content is nil
      def atom_validate(ignore_unknown_element, tags, uri)
        raise NotAvailableValueError.new(tag_name, "") if content.nil?
      end
    end

    module DuplicateLinkChecker
      # Checks if there are duplicate links with the same type and hreflang attributes
      # that have an alternate (or empty) rel attribute
      #
      # Raises a TooMuchTagError if there are duplicates found
      def validate_duplicate_links(links)
        link_infos = {}
        links.each do |link|
          rel = link.rel || "alternate"
          next unless rel == "alternate"
          key = [link.hreflang, link.type]
          if link_infos.has_key?(key)
            raise TooMuchTagError.new("link", tag_name)
          end
          link_infos[key] = true
        end
      end
    end

    # Defines the top-level element of an Atom Feed Document.
    # It consists of a number of children Entry elements,
    # and has the following attributes:
    #
    # * author
    # * categories
    # * category
    # * content
    # * contributor
    # * entries (aliased as items)
    # * entry
    # * generator
    # * icon
    # * id
    # * link
    # * logo
    # * rights
    # * subtitle
    # * title
    # * updated
    #
    # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.feed
    class Feed < RSS::Element
      include RootElementMixin
      include CommonModel
      include DuplicateLinkChecker

      install_ns('', URI)

      [
       ["author", "*", :children],
       ["category", "*", :children, "categories"],
       ["contributor", "*", :children],
       ["generator", "?"],
       ["icon", "?", nil, :content],
       ["id", nil, nil, :content],
       ["link", "*", :children],
       ["logo", "?"],
       ["rights", "?"],
       ["subtitle", "?", nil, :content],
       ["title", nil, nil, :content],
       ["updated", nil, nil, :content],
       ["entry", "*", :children, "entries"],
      ].each do |tag, occurs, type, *args|
        type ||= :child
        __send__("install_have_#{type}_element",
                 tag, URI, occurs, tag, *args)
      end

      # Creates a new Atom feed
      def initialize(version=nil, encoding=nil, standalone=nil)
        super("1.0", version, encoding, standalone)
        @feed_type = "atom"
        @feed_subtype = "feed"
      end

      alias_method :items, :entries

      # Returns true if there are any authors for the feed or any of the Entry
      # child elements have an author
      def have_author?
        authors.any? {|author| !author.to_s.empty?} or
          entries.any? {|entry| entry.have_author?(false)}
      end

      private
      def atom_validate(ignore_unknown_element, tags, uri)
        unless have_author?
          raise MissingTagError.new("author", tag_name)
        end
        validate_duplicate_links(links)
      end

      def have_required_elements?
        super and have_author?
      end

      def maker_target(maker)
        maker.channel
      end

      def setup_maker_element(channel)
        prev_dc_dates = channel.dc_dates.to_a.dup
        super
        channel.about = id.content if id
        channel.dc_dates.replace(prev_dc_dates)
      end

      def setup_maker_elements(channel)
        super
        items = channel.maker.items
        entries.each do |entry|
          entry.setup_maker(items)
        end
      end

      # PersonConstruct that contains information regarding the author
      # of a Feed or Entry.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.author
      class Author < RSS::Element
        include CommonModel
        include PersonConstruct
      end

      # Contains information about a category associated with a Feed or Entry.
      # It has the following attributes:
      #
      # * term
      # * scheme
      # * label
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.category
      class Category < RSS::Element
        include CommonModel

        [
         ["term", "", true],
         ["scheme", "", false, [nil, :uri]],
         ["label", ""],
        ].each do |name, uri, required, type|
          install_get_attribute(name, uri, required, type)
        end

        private
        def maker_target(target)
          target.new_category
        end
      end

      # PersonConstruct that contains information regarding the
      # contributors of a Feed or Entry.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.contributor
      class Contributor < RSS::Element
        include CommonModel
        include PersonConstruct
      end

      # Contains information on the agent used to generate the feed.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.generator
      class Generator < RSS::Element
        include CommonModel
        include ContentModel

        [
         ["uri", "", false, [nil, :uri]],
         ["version", ""],
        ].each do |name, uri, required, type|
          install_get_attribute(name, uri, required, type)
        end

        private
        def setup_maker_attributes(target)
          target.generator do |generator|
            generator.uri = uri if uri
            generator.version = version if version
          end
        end
      end

      # Defines an image that provides a visual identification for a eed.
      # The image should have an aspect ratio of 1:1.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.icon
      class Icon < RSS::Element
        include CommonModel
        include URIContentModel
      end

      # Defines the Universally Unique Identifier (UUID) for a Feed or Entry.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.id
      class Id < RSS::Element
        include CommonModel
        include URIContentModel
      end

      # Defines a reference to a Web resource. It has the following
      # attributes:
      #
      # * href
      # * rel
      # * type
      # * hreflang
      # * title
      # * length
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.link
      class Link < RSS::Element
        include CommonModel

        [
         ["href", "", true, [nil, :uri]],
         ["rel", ""],
         ["type", ""],
         ["hreflang", ""],
         ["title", ""],
         ["length", ""],
        ].each do |name, uri, required, type|
          install_get_attribute(name, uri, required, type)
        end

        private
        def maker_target(target)
          target.new_link
        end
      end

      # Defines an image that provides a visual identification for the Feed.
      # The image should have an aspect ratio of 2:1 (horizontal:vertical).
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.logo
      class Logo < RSS::Element
        include CommonModel
        include URIContentModel

        def maker_target(target)
          target.maker.image
        end

        private
        def setup_maker_element_writer
          "url="
        end
      end

      # TextConstruct that contains copyright information regarding
      # the content in an Entry or Feed. It should not be used to
      # convey machine readable licensing information.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.rights
      class Rights < RSS::Element
        include CommonModel
        include TextConstruct
      end

      # TextConstruct that conveys a description or subtitle for a Feed.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.subtitle
      class Subtitle < RSS::Element
        include CommonModel
        include TextConstruct
      end

      # TextConstruct that conveys a description or title for a Feed or Entry.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.title
      class Title < RSS::Element
        include CommonModel
        include TextConstruct
      end

      # DateConstruct indicating the most recent time when a Feed or
      # Entry was modified in a way the publisher considers
      # significant.
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.updated
      class Updated < RSS::Element
        include CommonModel
        include DateConstruct
      end

      # Defines a child Atom Entry element of an Atom Feed element.
      # It has the following attributes:
      #
      # * author
      # * category
      # * categories
      # * content
      # * contributor
      # * id
      # * link
      # * published
      # * rights
      # * source
      # * summary
      # * title
      # * updated
      #
      # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.entry
      class Entry < RSS::Element
        include CommonModel
        include DuplicateLinkChecker

        [
         ["author", "*", :children],
         ["category", "*", :children, "categories"],
         ["content", "?", :child],
         ["contributor", "*", :children],
         ["id", nil, nil, :content],
         ["link", "*", :children],
         ["published", "?", :child, :content],
         ["rights", "?", :child],
         ["source", "?"],
         ["summary", "?", :child],
         ["title", nil],
         ["updated", nil, :child, :content],
        ].each do |tag, occurs, type, *args|
          type ||= :attribute
          __send__("install_have_#{type}_element",
                   tag, URI, occurs, tag, *args)
        end

        # Returns whether any of the following are true:
        #
        # * There are any authors in the feed
        # * If the parent element has an author and the +check_parent+
        #   parameter was given.
        # * There is a source element that has an author
        def have_author?(check_parent=true)
          authors.any? {|author| !author.to_s.empty?} or
            (check_parent and @parent and @parent.have_author?) or
            (source and source.have_author?)
        end

        private
        def atom_validate(ignore_unknown_element, tags, uri)
          unless have_author?
            raise MissingTagError.new("author", tag_name)
          end
          validate_duplicate_links(links)
        end

        def have_required_elements?
          super and have_author?
        end

        def maker_target(items)
          if items.respond_to?("items")
            # For backward compatibility
            items = items.items
          end
          items.new_item
        end

        # Feed::Author
        Author = Feed::Author
        # Feed::Category
        Category = Feed::Category

        # Contains or links to the content of the Entry.
        # It has the following attributes:
        #
        # * type
        # * src
        #
        # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.content
        class Content < RSS::Element
          include CommonModel

          class << self
            def xml_setter
              "xml="
            end

            def xml_getter
              "xml"
            end
          end

          [
           ["type", ""],
           ["src", "", false, [nil, :uri]],
          ].each do |name, uri, required, type|
            install_get_attribute(name, uri, required, type)
          end

          content_setup
          add_need_initialize_variable("xml")

          # Returns the element content in XML.
          attr_writer :xml

          # Returns true if the element has inline XML content.
          def have_xml_content?
            inline_xhtml? or inline_other_xml?
          end

          # Returns or builds the element content in XML.
          def xml
            return @xml unless inline_xhtml?
            return @xml if @xml.nil?
            if @xml.is_a?(XML::Element) and
                [@xml.name, @xml.uri] == ["div", XHTML_URI]
              return @xml
            end

            children = @xml
            children = [children] unless children.is_a?(Array)
            XML::Element.new("div", nil, XHTML_URI,
                             {"xmlns" => XHTML_URI}, children)
          end

          # Returns the element content in XHTML.
          def xhtml
            if inline_xhtml?
              xml
            else
              nil
            end
          end

          # Raises a MissingAttributeError, NotAvailableValueError,
          # MissingTagError or NotExpectedTagError if the element is
          # not properly formatted.
          def atom_validate(ignore_unknown_element, tags, uri)
            if out_of_line?
              raise MissingAttributeError.new(tag_name, "type") if @type.nil?
              unless (content.nil? or content.empty?)
                raise NotAvailableValueError.new(tag_name, content)
              end
            elsif inline_xhtml?
              if @xml.nil?
                raise MissingTagError.new("div", tag_name)
              end
              unless @xml.name == "div" and @xml.uri == XHTML_URI
                raise NotExpectedTagError.new(@xml.name, @xml.uri, tag_name)
              end
            end
          end

          # Returns true if the element contains inline content
          # that has a text or HTML media type, or no media type at all.
          def inline_text?
            !out_of_line? and [nil, "text", "html"].include?(@type)
          end

          # Returns true if the element contains inline content that
          # has a HTML media type.
          def inline_html?
            return false if out_of_line?
            @type == "html" or mime_split == ["text", "html"]
          end

          # Returns true if the element contains inline content that
          # has a XHTML media type.
          def inline_xhtml?
            !out_of_line? and @type == "xhtml"
          end

          # Returns true if the element contains inline content that
          # has a MIME media type.
          def inline_other?
            return false if out_of_line?
            media_type, subtype = mime_split
            return false if media_type.nil? or subtype.nil?
            true
          end

          # Returns true if the element contains inline content that
          # has a text media type.
          def inline_other_text?
            return false unless inline_other?
            return false if inline_other_xml?

            media_type, = mime_split
            return true if "text" == media_type.downcase
            false
          end

          # Returns true if the element contains inline content that
          # has a XML media type.
          def inline_other_xml?
            return false unless inline_other?

            media_type, subtype = mime_split
            normalized_mime_type = "#{media_type}/#{subtype}".downcase
            if /(?:\+xml|^xml)$/ =~ subtype or
                %w(text/xml-external-parsed-entity
                   application/xml-external-parsed-entity
                   application/xml-dtd).find {|x| x == normalized_mime_type}
              return true
            end
            false
          end

          # Returns true if the element contains inline content
          # encoded in base64.
          def inline_other_base64?
            inline_other? and !inline_other_text? and !inline_other_xml?
          end

          # Returns true if the element contains linked content.
          def out_of_line?
            not @src.nil?
          end

          # Splits the type attribute into an array, e.g. ["text", "xml"]
          def mime_split
            media_type = subtype = nil
            if /\A\s*([a-z]+)\/([a-z\+]+)\s*(?:;.*)?\z/i =~ @type.to_s
              media_type = $1.downcase
              subtype = $2.downcase
            end
            [media_type, subtype]
          end

          # Returns true if the content needs to be encoded in base64.
          def need_base64_encode?
            inline_other_base64?
          end

          private
          def empty_content?
            out_of_line? or super
          end
        end

        # Feed::Contributor
        Contributor = Feed::Contributor
        # Feed::Id
        Id = Feed::Id
        # Feed::Link
        Link = Feed::Link

        # DateConstruct that usually indicates the time of the initial
        # creation of an Entry.
        #
        # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.published
        class Published < RSS::Element
          include CommonModel
          include DateConstruct
        end

        # Feed::Rights
        Rights = Feed::Rights

        # Defines a Atom Source element. It has the following attributes:
        #
        # * author
        # * category
        # * categories
        # * content
        # * contributor
        # * generator
        # * icon
        # * id
        # * link
        # * logo
        # * rights
        # * subtitle
        # * title
        # * updated
        #
        # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.source
        class Source < RSS::Element
          include CommonModel

          [
           ["author", "*", :children],
           ["category", "*", :children, "categories"],
           ["contributor", "*", :children],
           ["generator", "?"],
           ["icon", "?"],
           ["id", "?", nil, :content],
           ["link", "*", :children],
           ["logo", "?"],
           ["rights", "?"],
           ["subtitle", "?"],
           ["title", "?"],
           ["updated", "?", nil, :content],
          ].each do |tag, occurs, type, *args|
            type ||= :attribute
            __send__("install_have_#{type}_element",
                     tag, URI, occurs, tag, *args)
          end

          # Returns true if the Source element has an author.
          def have_author?
            !author.to_s.empty?
          end

          # Feed::Author
          Author = Feed::Author
          # Feed::Category
          Category = Feed::Category
          # Feed::Contributor
          Contributor = Feed::Contributor
          # Feed::Generator
          Generator = Feed::Generator
          # Feed::Icon
          Icon = Feed::Icon
          # Feed::Id
          Id = Feed::Id
          # Feed::Link
          Link = Feed::Link
          # Feed::Logo
          Logo = Feed::Logo
          # Feed::Rights
          Rights = Feed::Rights
          # Feed::Subtitle
          Subtitle = Feed::Subtitle
          # Feed::Title
          Title = Feed::Title
          # Feed::Updated
          Updated = Feed::Updated
        end

        # TextConstruct that describes a summary of the Entry.
        #
        # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.summary
        class Summary < RSS::Element
          include CommonModel
          include TextConstruct
        end

        # Feed::Title
        Title = Feed::Title
        # Feed::Updated
        Updated = Feed::Updated
      end
    end

    # Defines a top-level Atom Entry element,
    # used as the document element of a stand-alone Atom Entry Document.
    # It has the following attributes:
    #
    # * author
    # * category
    # * categories
    # * content
    # * contributor
    # * id
    # * link
    # * published
    # * rights
    # * source
    # * summary
    # * title
    # * updated
    #
    # Reference: https://validator.w3.org/feed/docs/rfc4287.html#element.entry]
    class Entry < RSS::Element
      include RootElementMixin
      include CommonModel
      include DuplicateLinkChecker

      [
       ["author", "*", :children],
       ["category", "*", :children, "categories"],
       ["content", "?"],
       ["contributor", "*", :children],
       ["id", nil, nil, :content],
       ["link", "*", :children],
       ["published", "?", :child, :content],
       ["rights", "?"],
       ["source", "?"],
       ["summary", "?"],
       ["title", nil],
       ["updated", nil, nil, :content],
      ].each do |tag, occurs, type, *args|
        type ||= :attribute
        __send__("install_have_#{type}_element",
                 tag, URI, occurs, tag, *args)
      end

      # Creates a new Atom Entry element.
      def initialize(version=nil, encoding=nil, standalone=nil)
        super("1.0", version, encoding, standalone)
        @feed_type = "atom"
        @feed_subtype = "entry"
      end

      # Returns the Entry in an array.
      def items
        [self]
      end

      # Sets up the +maker+ for constructing Entry elements.
      def setup_maker(maker)
        maker = maker.maker if maker.respond_to?("maker")
        super(maker)
      end

      # Returns where there are any authors present or there is a
      # source with an author.
      def have_author?
        authors.any? {|author| !author.to_s.empty?} or
          (source and source.have_author?)
      end

      private
      def atom_validate(ignore_unknown_element, tags, uri)
        unless have_author?
          raise MissingTagError.new("author", tag_name)
        end
        validate_duplicate_links(links)
      end

      def have_required_elements?
        super and have_author?
      end

      def maker_target(maker)
        maker.items.new_item
      end

      # Feed::Entry::Author
      Author = Feed::Entry::Author
      # Feed::Entry::Category
      Category = Feed::Entry::Category
      # Feed::Entry::Content
      Content = Feed::Entry::Content
      # Feed::Entry::Contributor
      Contributor = Feed::Entry::Contributor
      # Feed::Entry::Id
      Id = Feed::Entry::Id
      # Feed::Entry::Link
      Link = Feed::Entry::Link
      # Feed::Entry::Published
      Published = Feed::Entry::Published
      # Feed::Entry::Rights
      Rights = Feed::Entry::Rights
      # Feed::Entry::Source
      Source = Feed::Entry::Source
      # Feed::Entry::Summary
      Summary = Feed::Entry::Summary
      # Feed::Entry::Title
      Title = Feed::Entry::Title
      # Feed::Entry::Updated
      Updated = Feed::Entry::Updated
    end
  end

  Atom::CommonModel::ELEMENTS.each do |name|
    BaseListener.install_get_text_element(Atom::URI, name, "#{name}=")
  end

  module ListenerMixin
    private
    def initial_start_feed(tag_name, prefix, attrs, ns)
      check_ns(tag_name, prefix, ns, Atom::URI, false)

      @rss = Atom::Feed.new(@version, @encoding, @standalone)
      @rss.do_validate = @do_validate
      @rss.xml_stylesheets = @xml_stylesheets
      @rss.lang = attrs["xml:lang"]
      @rss.base = attrs["xml:base"]
      @last_element = @rss
      pr = Proc.new do |text, tags|
        @rss.validate_for_stream(tags) if @do_validate
      end
      @proc_stack.push(pr)
    end

    def initial_start_entry(tag_name, prefix, attrs, ns)
      check_ns(tag_name, prefix, ns, Atom::URI, false)

      @rss = Atom::Entry.new(@version, @encoding, @standalone)
      @rss.do_validate = @do_validate
      @rss.xml_stylesheets = @xml_stylesheets
      @rss.lang = attrs["xml:lang"]
      @rss.base = attrs["xml:base"]
      @last_element = @rss
      pr = Proc.new do |text, tags|
        @rss.validate_for_stream(tags) if @do_validate
      end
      @proc_stack.push(pr)
    end
  end
end