ogp 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b67e536cdab955dfbff8f93724732c051a19df9337f8560c3e77033728f45ace
-  data.tar.gz: e661bc0cbe6c0466db428ad1feb3e33f9e27e28d22e60308aab191fc7cdb78f4
+  metadata.gz: ed92054f85b86a12e2ef262857950f7033c8606b1571064ebc73820130f74a8a
+  data.tar.gz: b619ff744508bc9beb66546558e9eee3fdb5a0cf5734d6e7ce5acf1685b49bd6
 SHA512:
-  metadata.gz: eb53f0ea1c971692ae08c716ed8f2d5c4d11a9f1aa6baad942765babde03e53cd11803e0a3f89763c87a36461e8e4eb7894e28a38a918d36b2b299d7e85eeab7
-  data.tar.gz: 9d52e2948173d732604afd2ce22cca452ea880ddf030ded4ffdf52d1209c354d8e62547b6cdf508c4ef94542785e63b5a7c6edaea1a6e604085e143aa3d19c3d
+  metadata.gz: e00d1b10d5a4c9abe289eb898d7b462fa0a67661a4bd0b856ec877590b4b254fae36eeddb54031c7a0c75f642506ba26f0ef911e7be4ccf9810339a95c334716
+  data.tar.gz: f31fe03b72b7056c92edeb5c0ccc0def400bc95fec134b78f918bf970e4419cad16aa9f3f7fdd2bc8f016aa184235808230874361b15a6ba8ce1ab55b1da6bf8

data/.rubocop.yml

@@ -1,120 +1,140 @@
 AllCops:
   DisplayCopNames: true
-  Include:
-    - Rakefile
-    - config.ru
-    - Gemfile
-    - app/tasks/**/*.rake
-  Exclude:
-    - bin/**
-    - db/schema.rb
-    - db/migrate/**
-    - script/**
-    - vendor/**/*
-    - node_modules/**/*
-  TargetRubyVersion: 2.3
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
 
-Rails:
+Bundler/OrderedGems: 
   Enabled: false
 
-Documentation:
-  Enabled: false
-
-Encoding:
-  Enabled: false
-
-LineLength:
-  Max: 200
+Gemspec/DateAssignment: 
+  Enabled: true
 
-AccessModifierIndentation:
+Layout/AccessModifierIndentation: 
   EnforcedStyle: outdent
-
-IfUnlessModifier:
-  Enabled: false
-
-CaseIndentation:
+Layout/CaseIndentation: 
   EnforcedStyle: end
   IndentOneStep: true
-
-MethodLength:
-  CountComments: false
-  Max: 25
-
-SignalException:
-  Enabled: false
-
-ColonMethodCall:
+Layout/ExtraSpacing: 
+  Enabled: true
+Layout/FirstArrayElementIndentation: 
   Enabled: false
-
-AsciiComments:
+Layout/HashAlignment: 
   Enabled: false
-
-RegexpLiteral:
+Layout/LineLength: 
+  Max: 200
+Layout/MultilineMethodCallIndentation: 
   Enabled: false
-
-AssignmentInCondition:
+Layout/ParameterAlignment: 
+  EnforcedStyle: with_fixed_indentation
+Layout/SpaceBeforeBrackets: 
+  Enabled: true
+Layout/SpaceInLambdaLiteral: 
   Enabled: false
 
-ParameterLists:
-  CountKeywordArgs: false
-
-SingleLineBlockParams:
-  Methods:
-    - reduce:
-      - memo
-      - item
-
-MethodCalledOnDoEndBlock:
+Lint/AmbiguousAssignment: 
   Enabled: true
-
-Metrics/AbcSize:
+Lint/AssignmentInCondition: 
   Enabled: false
-
-Style/CollectionMethods:
+Lint/DeprecatedConstants: 
   Enabled: true
-
-Style/SymbolArray:
+Lint/DuplicateBranch: 
   Enabled: true
-
-Layout/ExtraSpacing:
+Lint/DuplicateRegexpCharacterClassElement: 
+  Enabled: true
+Lint/EmptyBlock: 
+  Enabled: true
+Lint/EmptyClass: 
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: 
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: 
+  Enabled: true
+Lint/NumberedParameterAssignment: 
+  Enabled: true
+Lint/OrAssignmentToConstant: 
+  Enabled: true
+Lint/RedundantDirGlobSort: 
+  Enabled: true
+Lint/SymbolConversion: 
+  Enabled: true
+Lint/ToEnumArguments: 
+  Enabled: true
+Lint/TripleQuotes: 
+  Enabled: true
+Lint/UnexpectedBlockArity: 
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: 
   Enabled: true
 
-Layout/MultilineMethodCallIndentation:
+Metrics/AbcSize: 
   Enabled: false
-
-Layout/IndentArray:
+Metrics/BlockLength: 
+  Max: 200
+Metrics/MethodLength: 
+  CountComments: false
+  Max: 40
+Metrics/PerceivedComplexity:
   Enabled: false
+Metrics/ParameterLists: 
+  CountKeywordArgs: false
 
-Layout/AlignHash:
+Style/ArgumentsForwarding: 
+  Enabled: true
+Style/CollectionCompact: 
+  Enabled: true
+Style/CollectionMethods: 
+  Enabled: true
+Style/ColonMethodCall: 
   Enabled: false
-
-Layout/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/FrozenStringLiteralComment:
+Style/DocumentDynamicEvalDefinition: 
+  Enabled: true
+Style/Documentation: 
   Enabled: false
-
-Rails/SkipsModelValidations:
+Style/Encoding: 
   Enabled: false
-
-Metrics/BlockLength:
-  Max: 200
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    '%i': '()'
-    '%I': '()'
-    '%w': '()'
-    '%W': '()'
-
-Layout/SpaceInLambdaLiteral:
+Style/EndlessMethod: 
+  Enabled: true
+Style/FrozenStringLiteralComment: 
   Enabled: false
-
-Bundler/OrderedGems:
+Style/HashConversion: 
+  Enabled: true
+Style/HashExcept: 
+  Enabled: true
+Style/IfUnlessModifier: 
   Enabled: false
-
-Rails/OutputSafety:
+Style/IfWithBooleanLiteralBranches: 
+  Enabled: true
+Style/MethodCalledOnDoEndBlock: 
+  Enabled: true
+Style/NegatedIfElseCondition: 
+  Enabled: true
+Style/NilLambda: 
+  Enabled: true
+Style/PercentLiteralDelimiters: 
+  PreferredDelimiters: 
+    ? "%I"
+    : ()
+    ? "%W"
+    : ()
+    ? "%i"
+    : ()
+    ? "%w"
+    : ()
+Style/RedundantArgument: 
+  Enabled: true
+Style/RegexpLiteral: 
   Enabled: false
-
-Performance/StringReplacement:
+Style/SignalException: 
   Enabled: false
+Style/SingleLineBlockParams: 
+  Methods: 
+    - 
+      reduce: 
+        - memo
+        - item
+Style/StringChars: 
+  Enabled: true
+Style/SwapValues: 
+  Enabled: true
+Style/SymbolArray: 
+  Enabled: true

data/.travis.yml

@@ -3,6 +3,8 @@ sudo: false
 language: ruby
 
 rvm:
-  - 2.3
+  - 2.7.3
 
-script: "bundle exec rake spec"
+script:
+  - bundle exec rake spec
+  - bundle exec rubocop

data/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://github.com/jcouture/ogp">
-    <img src="https://i.imgur.com/qZrMsLq.png" alt="ogp" />
+    <img src="https://i.imgur.com/8ehwe6E.png" alt="ogp" />
   </a>
   <br />
   OGP is a minimalist Ruby library that does only one thing: parse Open Graph protocol information. For more information: <a href="http://ogp.me">http://ogp.me</a>.

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new('spec')
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+RSpec::Core::RakeTask.new(:test)
+
+task default: %i(rubocop test)

data/lib/ogp/open_graph.rb

@@ -1,28 +1,29 @@
 require 'oga'
 require 'ostruct'
 
-REQUIRED_ATTRIBUTES = %w(title type image url).freeze
+DEFAULT_REQUIRED_ATTRIBUTES = %w(title type image url).freeze
 
 module OGP
   class OpenGraph
+    REQUIRED_ATTRIBUTES = %w(title type image url).freeze
+
     # Accessor for storing all open graph data
     attr_accessor :data
 
     # Required Accessors
     attr_accessor :title, :type, :url
-    attr_accessor :images
+    attr_accessor :images, :audios, :locales, :videos
 
     # Optional Accessors
     attr_accessor :description, :determiner, :site_name
-    attr_accessor :audios
-    attr_accessor :locales
-    attr_accessor :videos
 
-    def initialize(source)
+    def initialize(source, opts = {})
       if source.nil? || source.empty?
         raise ArgumentError, '`source` cannot be nil or empty.'
       end
 
+      opts[:required_attributes] ||= DEFAULT_REQUIRED_ATTRIBUTES
+
       raise MalformedSourceError unless source.include?('</html>')
 
       source.force_encoding('UTF-8') if source.encoding != 'UTF-8'
@@ -34,19 +35,20 @@ module OGP
       self.videos = []
 
       document = Oga.parse_html(source)
-      check_required_attributes(document)
+      check_required_attributes(document, opts[:required_attributes])
       parse_attributes(document)
     end
 
     def image
       return if images.nil?
+
       images.first
     end
 
   private
 
-    def check_required_attributes(document)
-      REQUIRED_ATTRIBUTES.each do |attribute_name|
+    def check_required_attributes(document, required_attributes)
+      required_attributes.each do |attribute_name|
         raise MissingAttributeError, "Missing required attribute: #{attribute_name}" unless attribute_exists(document, attribute_name)
       end
     end
@@ -56,14 +58,14 @@ module OGP
       document.xpath('//head/meta[starts-with(@property, \'og:\')]').each do |attribute|
         attribute_name = attribute.get('property').downcase.gsub('og:', '')
 
-        if data.has_key?(attribute_name)
+        if data.key?(attribute_name)
           # There can be multiple entries for the same og tag, see
           # https://open.spotify.com/album/3NkIlQR6wZwPCQiP1vPjF8 for an example
           # where there are multiple `restrictions:country:allowed` og tags.
           #
           # In this case store the content values as an array.
-          if !data[attribute_name].kind_of?(Array)
-            data[attribute_name] = [ data[attribute_name] ]
+          unless data[attribute_name].is_a?(Array)
+            data[attribute_name] = [data[attribute_name]]
           end
           data[attribute_name] << attribute.get('content')
         else
@@ -101,6 +103,7 @@ module OGP
         end
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def attribute_exists(document, name)
       document.at_xpath("boolean(//head/meta[@property='og:#{name}'])")

data/lib/ogp/version.rb

@@ -1,3 +1,3 @@
 module OGP
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/ogp.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ogp/version'
 
@@ -20,10 +20,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'oga', '~> 2.15'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'bundler', '>= 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_dependency 'oga', '~> 3.3'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.12'
 end

data/spec/ogp/open_graph_spec.rb

@@ -15,11 +15,19 @@ describe OGP::OpenGraph do
     end
 
     context 'with missing one of the required attributes' do
-      it 'should raise an error' do
+      it 'should raise an error by default' do
         content = File.read("#{File.dirname(__FILE__)}/../fixtures/missing_required_attributes.html")
 
         expect { OGP::OpenGraph.new(content) }.to raise_error(OGP::MissingAttributeError)
       end
+      it 'should not raise an error if missing attribute is not required' do
+        content = File.read("#{File.dirname(__FILE__)}/../fixtures/missing_required_attributes.html")
+
+        open_graph = OGP::OpenGraph.new(content, { required_attributes: %w(title type url) })
+        expect(open_graph.title).to eql('The Rock')
+        expect(open_graph.type).to eql('video.movie')
+        expect(open_graph.url).to eql('http://www.imdb.com/title/tt0117500/')
+      end
     end
 
     context 'with nil source' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogp
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean-Philippe Couture
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-22 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.15'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '1.12'
 description: Simple Ruby library for parsing Open Graph prototocol information. See
   http://ogp.me for more information.
 email:
@@ -125,27 +125,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple Ruby library for parsing Open Graph prototocol information.
-test_files:
-- spec/fixtures/audio_structured_attributes.html
-- spec/fixtures/custom_attributes.html
-- spec/fixtures/i18n_encoding.html
-- spec/fixtures/image_structured_attributes.html
-- spec/fixtures/missing_required_attributes.html
-- spec/fixtures/multiple_images_attributes.html
-- spec/fixtures/no_root_attributes.html
-- spec/fixtures/optional_attributes.html
-- spec/fixtures/required_attributes.html
-- spec/fixtures/video_structured_attributes.html
-- spec/ogp/open_graph_spec.rb
-- spec/spec_helper.rb
+test_files: []