ogp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76a5e1d09ecf649ed6ae42c9210670fc975e97dc
-  data.tar.gz: 5b3247e18f9d7dcbad25d56772fdf89da37c2ac0
+  metadata.gz: ca2fa62d7e09874c7999112994aa53385734c2b1
+  data.tar.gz: e44b5cb9f6eebf69a0a1e03f931f9502af687f10
 SHA512:
-  metadata.gz: e7bad59e8dd573ab9ff01753c6f846be1faad91870162b90c924849694aff9f548aa6163e113e440e4703635c18eb53e4826548136e77e0e4ea7f7c92448845a
-  data.tar.gz: b92431e1f01c0233bda839f3a3a165dc14c53c59ee1222109046a56e0e178359060a264c41b5fa6866191bdb8f23b8748d4c5ee54a5ce227ca6e9af186b3f698
+  metadata.gz: 824aee85a548ab9eb7cbcf46369567f238b01bac1a2d9969d82bad2b5b182a004e071c91a33bab8cb9045bc0a5052c91c5647362e666a7bf528f75e928fde6ae
+  data.tar.gz: 9b16c4795d015b03fe307dc98a0ce4830d8ae70c85de99a7072d2f5943f1f85ae1b0174926ce14a83d35c9bc910a9300224582f586dedaae1d929b4c28914bed

data/.rubocop.yml

@@ -0,0 +1,120 @@
+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
+
+Rails:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+LineLength:
+  Max: 200
+
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+IfUnlessModifier:
+  Enabled: false
+
+CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+
+MethodLength:
+  CountComments: false
+  Max: 25
+
+SignalException:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ParameterLists:
+  CountKeywordArgs: false
+
+SingleLineBlockParams:
+  Methods:
+    - reduce:
+      - memo
+      - item
+
+MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/IndentArray:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 200
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '()'
+    '%I': '()'
+    '%w': '()'
+    '%W': '()'
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Rails/OutputSafety:
+  Enabled: false
+
+Performance/StringReplacement:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+
+language: ruby
+
+rvm:
+  - 2.3
+
+script: "bundle exec rake spec"

data/README.md

@@ -1,6 +1,16 @@
-# OGP
+<p align="center">
+  <a href="https://github.com/mirego/ogp">
+    <img src="https://i.imgur.com/qZrMsLq.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>.
+  <br /><br />
+  <a href="https://rubygems.org/gems/ogp"><img src="http://img.shields.io/gem/v/ogp.svg" /></a>
+  <a href="https://codeclimate.com/github/jcouture/ogp"><img src="http://img.shields.io/codeclimate/github/jcouture/ogp.svg" /></a>
+  <a href="https://gemnasium.com/jcouture/ogp"><img src="http://img.shields.io/gemnasium/jcouture/ogp.svg" /></a>
+  <a href="https://travis-ci.org/jcouture/ogp"><img src="http://img.shields.io/travis/jcouture/ogp.svg" /></a>
+</p>
 
-OGP is a minimalist Ruby library that does only one thing: parse Open Graph protocol information from web sites. For more information: http://ogp.me.
 
 ## Installation
 
@@ -44,3 +54,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jcoutu
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+The OGP pirate logo is based on [this icon](https://thenounproject.com/term/pirate/9414/) by [Simon Child](https://thenounproject.com/Simon%20Child/), from the Noun Project. Used under a [Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
 
-task :default => :spec
+task default: :spec

data/lib/ogp/open_graph.rb

@@ -1,14 +1,14 @@
 require 'oga'
 require 'ostruct'
 
-REQUIRED_ATTRIBUTES = %w(title type image url)
+REQUIRED_ATTRIBUTES = %w(title type image url).freeze
 
 module OGP
   class OpenGraph
     # Required Accessors
     attr_accessor :title, :type, :url
     attr_accessor :images
-    
+
     # Optional Accessors
     attr_accessor :description, :determiner, :site_name
     attr_accessor :audios
@@ -17,12 +17,10 @@ module OGP
 
     def initialize(source)
       if source.nil? || source.empty?
-        raise ArgumentError.new('`source` cannot be nil or empty.')
+        raise ArgumentError, '`source` cannot be nil or empty.'
       end
 
-      if !source.include?('</html>')
-        raise MalformedSourceError
-      end
+      raise MalformedSourceError unless source.include?('</html>')
 
       self.images = []
       self.audios = []
@@ -35,17 +33,15 @@ module OGP
     end
 
     def image
-      return if self.images.nil?
-      return self.images.first
+      return if images.nil?
+      images.first
     end
 
-    private
+  private
 
     def check_required_attributes(document)
       REQUIRED_ATTRIBUTES.each do |attribute_name|
-        if !attribute_exists(document, attribute_name)
-          raise MissingAttributeError.new("Missing required attribute: #{attribute_name}")
-        end
+        raise MissingAttributeError, "Missing required attribute: #{attribute_name}" unless attribute_exists(document, attribute_name)
       end
     end
 
@@ -53,22 +49,22 @@ module OGP
       document.xpath('//head/meta[starts-with(@property, \'og:\')]').each do |attribute|
         attribute_name = attribute.get('property').downcase.gsub('og:', '')
         case attribute_name
-        when /^image$/i
-          self.images << OpenStruct.new(url: attribute.get('content').to_s)
-        when /^image:(.+)/i
-          self.images.last[$1.gsub('-','_')] = attribute.get('content').to_s
-        when /^audio$/i
-          self.audios << OpenStruct.new(url: attribute.get('content').to_s)
-        when /^audio:(.+)/i
-          self.audios.last[$1.gsub('-','_')] = attribute.get('content').to_s
-        when /^locale/i
-          self.locales << attribute.get('content').to_s
-        when /^video$/i
-          self.videos << OpenStruct.new(url: attribute.get('content').to_s)
-        when /^video:(.+)/i
-          self.videos.last[$1.gsub('-','_')] = attribute.get('content').to_s
-        else
-          instance_variable_set("@#{attribute_name}", attribute.get('content'))
+          when /^image$/i
+            images << OpenStruct.new(url: attribute.get('content').to_s)
+          when /^image:(.+)/i
+            images.last[Regexp.last_match[1].gsub('-', '_')] = attribute.get('content').to_s
+          when /^audio$/i
+            audios << OpenStruct.new(url: attribute.get('content').to_s)
+          when /^audio:(.+)/i
+            audios.last[Regexp.last_match[1].gsub('-', '_')] = attribute.get('content').to_s
+          when /^locale/i
+            locales << attribute.get('content').to_s
+          when /^video$/i
+            videos << OpenStruct.new(url: attribute.get('content').to_s)
+          when /^video:(.+)/i
+            videos.last[Regexp.last_match[1].gsub('-', '_')] = attribute.get('content').to_s
+          else
+            instance_variable_set("@#{attribute_name}", attribute.get('content'))
         end
       end
     end

data/lib/ogp/version.rb

@@ -1,3 +1,3 @@
 module OGP
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

data/ogp.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ogp/version'
@@ -9,13 +10,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jean-Philippe Couture']
   spec.email         = ['jcouture@gmail.com']
 
-  spec.summary       = spec.description
-  spec.description   = %q{Simple Ruby library for parsing Open Graph prototocol information from websites. See http://ogp.me for more information.}
+  spec.summary       = 'Simple Ruby library for parsing Open Graph prototocol information.'
+  spec.description   = 'Simple Ruby library for parsing Open Graph prototocol information. See http://ogp.me for more information.'
   spec.homepage      = 'https://github.com/jcouture/ogp'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.require_paths = ['lib']
 
@@ -24,4 +25,5 @@ Gem::Specification.new do |spec|
   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'
 end

data/spec/ogp/open_graph_spec.rb

@@ -17,26 +17,26 @@ describe OGP::OpenGraph do
     context 'with missing one of the required attributes' do
       it 'should raise an error' do
         content = File.read("#{File.dirname(__FILE__)}/../fixtures/missing_required_attributes.html")
-        
-        expect{OGP::OpenGraph.new(content)}.to raise_error(OGP::MissingAttributeError)
+
+        expect { OGP::OpenGraph.new(content) }.to raise_error(OGP::MissingAttributeError)
       end
     end
 
     context 'with nil source' do
       it 'should raise an error' do
-        expect{OGP::OpenGraph.new(nil)}.to raise_error(ArgumentError)
+        expect { OGP::OpenGraph.new(nil) }.to raise_error(ArgumentError)
       end
     end
 
     context 'with empty source' do
       it 'should raise an error' do
-        expect{OGP::OpenGraph.new('')}.to raise_error(ArgumentError)
+        expect { OGP::OpenGraph.new('') }.to raise_error(ArgumentError)
       end
     end
 
     context 'with malformed source' do
       it 'should raise an error' do
-        expect{OGP::OpenGraph.new('Lorem ipsum dolor sit amet, consectetur adipiscing elit.')}.to raise_error(OGP::MalformedSourceError)
+        expect { OGP::OpenGraph.new('Lorem ipsum dolor sit amet, consectetur adipiscing elit.') }.to raise_error(OGP::MalformedSourceError)
       end
     end
 

data/spec/spec_helper.rb

@@ -1,7 +1,3 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'ogp'
-
-RSpec.configure do |config|
-  
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean-Philippe Couture
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -66,8 +66,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description: Simple Ruby library for parsing Open Graph prototocol information from
-  websites. See http://ogp.me for more information.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: Simple Ruby library for parsing Open Graph prototocol information. See
+  http://ogp.me for more information.
 email:
 - jcouture@gmail.com
 executables: []
@@ -76,6 +90,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -117,7 +133,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Simple Ruby library for parsing Open Graph prototocol information.
 test_files:
 - spec/fixtures/audio_structured_attributes.html
 - spec/fixtures/image_structured_attributes.html