metatag_cop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b699a58b7d2c344ba5162cc93dd6fa00627e4d9
+  data.tar.gz: 961c0ca29e2fcc37aeec5ba42c4fe44a878ef814
+SHA512:
+  metadata.gz: b1d83924b720e8f865ffd8ddcb6e2293f580714bcc2d0108a93bbff5816ad04efc412b06171c3422ba63d7a11a99c0ef3bdc1ec7902baa6ac5fd07dc7e0e9227
+  data.tar.gz: 197316a16bf961c78a8c5306c659954bdf67ca59c3c4bd5882b3ffa96880f3ec3224a43c96dc9a7cc1042cb7d7882813c982afda4b5a0cd996ae77768d587ba0

data/.gitignore

@@ -0,0 +1,122 @@
+### https://raw.github.com/github/gitignore/f57304e9762876ae4c9b02867ed0cb887316387e/Ruby.gitignore
+*.DS_store
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+### https://raw.github.com/github/gitignore/f57304e9762876ae4c9b02867ed0cb887316387e/Global/JetBrains.gitignore
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+### https://raw.github.com/github/gitignore/f57304e9762876ae4c9b02867ed0cb887316387e/Global/SublimeText.gitignore
+
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+
+### https://raw.github.com/github/gitignore/f57304e9762876ae4c9b02867ed0cb887316387e/Global/vim.gitignore
+
+# swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-v][a-z]
+[._]sw[a-p]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+
+# auto-generated tag files
+tags
+.tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mailto.takita.yusuke@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in metatag_cop.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    metatag_cop (0.1.0)
+      nokogiri (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.1.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  metatag_cop!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 tackeyy
+
+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

@@ -0,0 +1,41 @@
+# MetatagCop
+
+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/metatag_cop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metatag_cop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metatag_cop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/metatag_cop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metatag_cop"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/metatag_cop

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'metatag_cop'
+
+puts MetatagCop::Handler.execute

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/metatag_cop/builders/csv.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MetatagCop
+  module Builders
+    #
+    class Csv
+      def self.build(file_path)
+        records = []
+        CSV.table(file_path).each do |row|
+          records.push MetatagCop::Models::Csv.new(
+            url: row[:url],
+            title: row[:title],
+            description: row[:description],
+            keywords: row[:keywords],
+            h1: row[:h1]
+          )
+        end
+        records
+      end
+    end
+  end
+end

data/lib/metatag_cop/cops/cop.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MetatagCop
+  module Cops
+    #
+    class Cop
+      attr_reader :records
+
+      def initialize(records)
+        @records = records
+      end
+
+      def run
+        error_msgs = []
+        records.each do |record|
+          error_msg = []
+          parser = MetatagCop::Parser.new(record.url)
+          error_msg.push error_msg(:title, record.title, parser.title)  unless parser.title == record.title
+          error_msg.push error_msg(:description, record.description, parser.description) unless parser.description == record.description
+          error_msg.push error_msg(:keywords, record.keywords, parser.keywords) unless parser.keywords == record.keywords
+          error_msg.push error_msg(:h1, record.h1, parser.h1) unless parser.h1 == record.h1
+          error_msg.unshift "url: #{record.url}" unless error_msg.empty?
+          error_msgs.push error_msg unless error_msg.empty?
+        end
+        error_msgs
+      end
+
+      private
+
+      def error_msg(tag, expected, actual)
+        "[#{tag}] expected: #{expected}, actual: #{actual}"
+      end
+    end
+  end
+end

data/lib/metatag_cop/handler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'nokogiri'
+
+require_relative 'parser'
+require_relative 'cops/cop'
+require_relative 'models/csv'
+require_relative 'builders/csv'
+
+module MetatagCop
+  #
+  class Handler
+    def self.execute
+      file_path = ARGV[0]
+
+      return print 'Require file path as a first argument.' if file_path.nil?
+
+      records = MetatagCop::Builders::Csv.build(file_path)
+      MetatagCop::Cops::Cop.new(records).run
+    end
+  end
+end
+
+if __FILE__ == $0
+  MetatagCop::Handler.execute
+end

data/lib/metatag_cop/models/csv.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MetatagCop
+  module Models
+    #
+    class Csv
+      attr_reader :url, :title, :description, :keywords, :h1
+
+      def initialize(url: nil, title: nil,
+                     description: nil, keywords: nil, h1: nil)
+        @url         = url
+        @title       = title
+        @description = description
+        @keywords    = keywords
+        @h1          = h1
+      end
+    end
+  end
+end

data/lib/metatag_cop/parser.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'nokogiri'
+require 'pry-byebug'
+
+module MetatagCop
+  #
+  class Parser
+    attr_accessor :document
+
+    def initialize(url)
+      @document = parse(url)
+    end
+
+    def title
+      document.css('head title').inner_text
+    end
+
+    def description
+      document.at('meta[name=description]')['content']
+    end
+
+    def keywords
+      document.at('meta[name=keywords]')['content']
+    end
+
+    def h1
+      h1 = document.at('h1')
+      return h1['content'] unless h1['content'].nil?
+
+      # it regards alt as h1 content if h1 content is blank.
+      a = find_tag_by(h1, 'a')
+      img = find_tag_by(a, 'img')
+      img.attributes['alt'].value
+    end
+
+    private
+
+    def find_tag_by(parent, tag)
+      parent.children.find { |child| child.name == tag }
+    end
+
+    def parse(url)
+      charset = nil
+      html = open(url) do |f|
+        charset = f.charset
+        f.read
+      end
+      Nokogiri::HTML.parse(html, nil, charset)
+    end
+  end
+end

data/lib/metatag_cop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MetatagCop
+  VERSION = '0.1.0'
+end

data/lib/metatag_cop.rb

@@ -0,0 +1,8 @@
+require 'csv'
+
+require 'metatag_cop/version'
+require 'metatag_cop/handler'
+require 'metatag_cop/parser'
+require 'metatag_cop/cops/cop'
+require 'metatag_cop/models/csv'
+require 'metatag_cop/builders/csv'

data/metatag_cop.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metatag_cop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metatag_cop'
+  spec.version       = MetatagCop::VERSION
+  spec.authors       = ['tackeyy']
+  spec.email         = ['mailto.takita.yusuke@gmail.com']
+
+  spec.summary       = 'metatag_cop loads csv file and checks whether meta tags is set proper value.'
+  spec.description   = 'metatag_cop loads csv file and checks whether meta tags is set proper value.'
+  spec.homepage      = 'http://tackeyy.com/'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['metatag_cop']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: metatag_cop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tackeyy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: metatag_cop loads csv file and checks whether meta tags is set proper
+  value.
+email:
+- mailto.takita.yusuke@gmail.com
+executables:
+- metatag_cop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/metatag_cop
+- bin/setup
+- lib/metatag_cop.rb
+- lib/metatag_cop/builders/csv.rb
+- lib/metatag_cop/cops/cop.rb
+- lib/metatag_cop/handler.rb
+- lib/metatag_cop/models/csv.rb
+- lib/metatag_cop/parser.rb
+- lib/metatag_cop/version.rb
+- metatag_cop.gemspec
+homepage: http://tackeyy.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: metatag_cop loads csv file and checks whether meta tags is set proper value.
+test_files: []