metadatacop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ee79d74b339b80a9f7053d5c7c5f972c206c7cf
+  data.tar.gz: caca883eb5d399d5e61f78de6d04098c9825dda9
+SHA512:
+  metadata.gz: d1b3907b800a7bbb4e6924767191432541fac2a543757f72ed5505fa3d41b0b872bbf449718e16607f84e9ee72e205a1a46c81301228a06c282410621d3ab479
+  data.tar.gz: bafc15c1a639085170383eb6668263fb6c9f8299bee680e1c0aae404838baed5843b25e90cfe10cefa54503efdd89b0304c83a68513b5e719dba97022dab8a1a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# MetadataCop
+
+MetadataCop is a metadata quality analyzer, in the same vein as [RuboCop](https://github.com/bbatsov/rubocop) and other static code analyzers.
+
+## Installation
+
+MetadataCop is distributed as a Ruby gem:
+
+```console
+$ gem install metadatacop
+```
+
+## Basic Usage
+
+Run MetadataCop against specific files:
+
+```console
+$ metadatacop -t mods path/to/my/mods.xml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/cbeer/metadatacop/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'metadatacop'
+
+# 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

data/bin/setup

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

data/config/mods/default.yml

@@ -0,0 +1,8 @@
+Xml/Lint/Valid:
+  Description: Check if the XML is valid XML
+  Enabled: true
+
+Xml/Lint/Schema_Valid:
+  Description: Check that the XML conforms to the MODS schema
+  EnforcedSchema: http://www.loc.gov/standards/mods/v3/mods-3-6.xsd
+  Enabled: true

data/exe/metadatacop

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'metadatacop'
+require 'optparse'
+
+options = MetadataCop::Options.parse(ARGV)
+
+if options[:type].nil?
+  MetadataCop::Options.parse(['--help'])
+  exit 1
+end
+
+cli = MetadataCop::CLI.new options
+
+exit_code = cli.run ARGV
+
+exit exit_code

data/lib/metadata_cop.rb

@@ -0,0 +1 @@
+require 'metadatacop'

data/lib/metadatacop.rb

@@ -0,0 +1,22 @@
+require 'metadatacop/version'
+
+module MetadataCop
+  require 'metadatacop/logger'
+  require 'metadatacop/cli'
+  require 'metadatacop/runner'
+  require 'metadatacop/options'
+  require 'metadatacop/config_loader'
+  require 'metadatacop/offense'
+
+  require 'metadatacop/cop'
+  require 'metadatacop/cop/team'
+
+  require 'active_support/inflector'
+  require 'nokogiri'
+  require 'open-uri'
+  require 'yaml'
+
+  require 'metadatacop/cop/base_cop'
+  require 'metadatacop/cop/xml/lint/valid'
+  require 'metadatacop/cop/xml/lint/schema_valid'
+end

data/lib/metadatacop/cli.rb

@@ -0,0 +1,46 @@
+module MetadataCop
+  class CLI
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def run(*paths)
+      runner = Runner.new(runner_options)
+      runner.run(paths)
+
+      report_offenses(runner.offenses)
+
+      runner.success? ? 0 : 1
+    rescue StandardError => e
+      $stderr.puts e.message
+      $stderr.puts e.backtrace
+      1
+    end
+
+    private
+
+    def report_offenses(runner_offenses)
+      return if runner_offenses.empty?
+
+      runner_offenses.each do |file, offenses|
+        offenses.each do |o|
+          puts "#{file}: #{o.message} (#{o.cop})"
+        end
+      end
+    end
+
+    def runner_options
+      options.merge(cop_options)
+    end
+
+    def cop_options
+      { cops: enabled_cops }
+    end
+
+    def enabled_cops
+      ConfigLoader.new(options).cops
+    end
+  end
+end

data/lib/metadatacop/config_loader.rb

@@ -0,0 +1,42 @@
+module MetadataCop
+  class ConfigLoader
+    METADATACOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
+    DEFAULT_PATH = File.join(METADATACOP_HOME, 'config', '%{type}', 'default.yml')
+
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def configuration
+      @configuration ||= YAML.load_file(default_path)
+    end
+
+    def cops
+      configuration.select(&method(:cop?)).select(&method(:enabled?)).map do |cop, options|
+        cop_class(cop).new(options)
+      end
+    end
+
+    private
+
+    def cop?(cop, _)
+      cop_class(cop) < MetadataCop::Cop::BaseCop
+    rescue NameError
+      false
+    end
+
+    def cop_class(cop_name)
+      "MetadataCop/Cop/#{cop_name}".classify.constantize
+    end
+
+    def enabled?(_, options)
+      options['Enabled'] == true
+    end
+
+    def default_path
+      self.class::DEFAULT_PATH % options
+    end
+  end
+end

data/lib/metadatacop/cop.rb

@@ -0,0 +1,4 @@
+module MetadataCop
+  module Cop
+  end
+end

data/lib/metadatacop/cop/base_cop.rb

@@ -0,0 +1,23 @@
+module MetadataCop
+  module Cop
+    class BaseCop
+      attr_reader :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def message(params = {})
+        self.class::MSG % params
+      end
+
+      def lint?
+        self.class.to_s =~ /Lint/
+      end
+
+      def offense(message)
+        MetadataCop::Offense.new(cop: self.class, message: message)
+      end
+    end
+  end
+end

data/lib/metadatacop/cop/team.rb

@@ -0,0 +1,29 @@
+module MetadataCop
+  module Cop
+    class Team
+      attr_reader :cops, :options
+
+      def initialize(cops, options = {})
+        @cops = cops
+        @options = options
+      end
+
+      def inspect_file(file)
+        linters, others = @cops.partition(&:lint?)
+
+        result = run_cops(linters, file)
+
+        # if the linters failed, no reason to run the others
+        result += run_cops(others, file) if result.empty?
+
+        result
+      end
+
+      def run_cops(cops, file)
+        cops.inject([]) do |offenses, cop|
+          offenses + cop.investigate(file)
+        end
+      end
+    end
+  end
+end

data/lib/metadatacop/cop/xml/lint/schema_valid.rb

@@ -0,0 +1,29 @@
+module MetadataCop
+  module Cop
+    module Xml
+      module Lint
+        class SchemaValid < Valid
+          def investigate(file)
+            doc = Nokogiri::XML(File.read(file))
+
+            xsd.validate(doc).map { |m| offense(m) }
+          end
+
+          private
+
+          def xsd
+            @schema = Nokogiri::XML::Schema(open(xsd_schema_path).read)
+          end
+
+          def xsd_schema_path
+            options.fetch('EnforcedSchema') { class_schema_path }
+          end
+
+          def class_schema_path
+            self.class::SCHEMA_PATH if defined? self.class::SCHEMA_PATH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metadatacop/cop/xml/lint/valid.rb

@@ -0,0 +1,16 @@
+module MetadataCop
+  module Cop
+    module Xml
+      module Lint
+        class Valid < BaseCop
+          def investigate(file)
+            doc = Nokogiri::XML(File.read(file))
+            return if doc.errors.empty?
+
+            doc.errors.map { |m| offense(m) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metadatacop/logger.rb

@@ -0,0 +1,9 @@
+require 'logger'
+
+module MetadataCop
+  class << self
+    attr_accessor :logger
+  end
+
+  self.logger = Logger.new(STDERR)
+end

data/lib/metadatacop/offense.rb

@@ -0,0 +1,17 @@
+module MetadataCop
+  class Offense
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def cop
+      options[:cop].to_s.sub('MetadataCop::Cop::', '').underscore
+    end
+
+    def message
+      options[:message]
+    end
+  end
+end

data/lib/metadatacop/options.rb

@@ -0,0 +1,25 @@
+require 'optparse'
+
+module MetadataCop
+  class Options
+    def self.parse(args)
+      options = {}
+
+      parser(options).parse!(args)
+      options
+    end
+
+    def self.parser(options)
+      OptionParser.new do |opts|
+        opts.on('-t', '--type [TYPE]', 'Rules to apply') do |t|
+          options[:type] = t
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/metadatacop/runner.rb

@@ -0,0 +1,47 @@
+module MetadataCop
+  class Runner
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+      @ran = false
+    end
+
+    def offenses
+      @offenses ||= {}
+    end
+
+    def run(*paths)
+      paths.flatten.each_with_object(offenses) do |file, h|
+        file_offenses = process_file(file).flatten
+
+        h[file] ||= []
+        h[file] += file_offenses
+      end
+
+      @ran = true
+
+      offenses
+    end
+
+    def success?
+      offenses.empty? && ran?
+    end
+
+    def ran?
+      @ran
+    end
+
+    private
+
+    def process_file(file)
+      MetadataCop.logger.debug "Scanning #{file}"
+
+      cop_team.inspect_file(file)
+    end
+
+    def cop_team
+      MetadataCop::Cop::Team.new(options[:cops], options)
+    end
+  end
+end

data/lib/metadatacop/version.rb

@@ -0,0 +1,3 @@
+module MetadataCop
+  VERSION = '0.0.1'
+end

data/metadatacop.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metadatacop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metadatacop'
+  spec.version       = MetadataCop::VERSION
+  spec.authors       = ['Chris Beer']
+  spec.email         = ['chris@cbeer.info']
+
+  spec.summary       = 'Style enforcement for metadata'
+  spec.homepage      = 'https://github.com/cbeer/metadatacop'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: metadatacop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: 
+email:
+- chris@cbeer.info
+executables:
+- metadatacop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/mods/default.yml
+- exe/metadatacop
+- lib/metadata_cop.rb
+- lib/metadatacop.rb
+- lib/metadatacop/cli.rb
+- lib/metadatacop/config_loader.rb
+- lib/metadatacop/cop.rb
+- lib/metadatacop/cop/base_cop.rb
+- lib/metadatacop/cop/team.rb
+- lib/metadatacop/cop/xml/lint/schema_valid.rb
+- lib/metadatacop/cop/xml/lint/valid.rb
+- lib/metadatacop/logger.rb
+- lib/metadatacop/offense.rb
+- lib/metadatacop/options.rb
+- lib/metadatacop/runner.rb
+- lib/metadatacop/version.rb
+- metadatacop.gemspec
+homepage: https://github.com/cbeer/metadatacop
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Style enforcement for metadata
+test_files: []