rails_config_validator 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbb9506342925e85eeca4059dee9057bc2cf7d95
+  data.tar.gz: 724b787b2b6096b52493765d389ddd22a06b38d3
+SHA512:
+  metadata.gz: 288657094f81e9571fa8d81c1ece0c27b91d64121ccdfe11dde7c2db0056aeddcdc27ff772a412a431629ed404c927c086bff80b271862e0de64b5f01bd8888b
+  data.tar.gz: 6ba09385a82eda2c0767635ef515a292229b79a6bd57a04dbd4088344c87d83de2ef2c1f1c1841702a4c6989f23d4b2f3b7218929062be0177dd876cc375b2db

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_u2i.yml

data/.rubocop_u2i.yml

@@ -0,0 +1,56 @@
+require: rubocop-rspec
+
+AllCops:
+  RunRailsCops: true
+  Include:
+    - '**/Rakefile'
+    - config.ru
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - db/schema.rb
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+  Exclude:
+    - spec/**/*
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/MultilineBlockChain:
+  Enabled: true
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+#Style/TrailingComma:
+#  # If EnforcedStyleForMultiline is comma, the cop allows a comma after the
+#  # last item of a list, but only for lists where each item is on its own line.
+#  EnforcedStyleForMultiline: comma
+
+Metrics/LineLength:
+  Max: 120
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 30

data/.travis.yml

@@ -0,0 +1,6 @@
+env:
+  - COVERAGE=1
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.1

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# This group allows to skip running RuboCop if RSpec.
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+
+    watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, all_on_start: false, cli: %w(--format fuubar) do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -0,0 +1,44 @@
+# RailsConfigValidator
+
+[![Build Status](https://travis-ci.org/u2i/rails_config_validator.svg)](https://travis-ci.org/u2i/rails_config_validator)
+[![Dependency Status](https://gemnasium.com/u2i/rails_config_validator.svg)](https://gemnasium.com/u2i/rails_config_validator)
+[![Code Climate](https://codeclimate.com/github/u2i/rails_config_validator/badges/gpa.svg)](https://codeclimate.com/github/u2i/rails_config_validator)
+[![Test Coverage](https://codeclimate.com/github/u2i/rails_config_validator/badges/coverage.svg)](https://codeclimate.com/github/u2i/rails_config_validator/coverage)
+
+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/rails_config_validator`. 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 'rails_config_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_config_validator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[my-github-username]/rails_config_validator/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,23 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  puts e
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop)
+rescue LoadError => e
+  puts e
+end
+
+begin
+  require 'ci/reporter/rake/rspec'
+rescue LoadError => e
+  puts e
+end
+
+task default: [:spec, :rubocop]

data/bin/console

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

@@ -0,0 +1,7 @@
+module RailsConfigValidator
+  class Error < RuntimeError; end
+
+  class InvalidConfigurationError < Error; end
+
+  class InvalidSchemaError < Error; end
+end

data/lib/rails_config_validator/railtie.rb

@@ -0,0 +1,18 @@
+module RailsConfigValidator
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      config.config_validator = ActiveSupport::OrderedOptions.new
+      config.config_validator.files %w(database.yml)
+    end
+
+    initializer 'config_validator.configure' do
+      config_paths = config.config_validator.files.map { |c| File.join(Rails.root, 'config', c) }
+
+      validators = config_paths.map do |config|
+        RailsConfigValidator::Validator.new(config, Rails.env)
+      end
+
+      validators.each(&:valid!)
+    end
+  end
+end

data/lib/rails_config_validator/rake_task.rb

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/tasklib'
+
+module RailsConfigValidator
+  class RakeTask < ::Rake::TaskLib
+    include ::Rake::DSL if defined?(::Rake::DSL)
+
+    def initialize
+      require 'rails_config_validator/validator'
+
+      desc 'Validates Rails config file against YML schema'
+      namespace :config_validator do
+        task :validate, [:config, :schema, :env] do |_, args|
+          config = args[:config]
+          schema = args[:schema]
+          env = args[:env] || Rails.env
+          fail 'Missing parameter :config' if args[:config].nil?
+
+          v = RailsConfigValidator::Validator.new(config, env, schema_path: schema)
+          v.valid!
+        end
+      end
+    end
+  end
+end

data/lib/rails_config_validator/validator.rb

@@ -0,0 +1,83 @@
+require 'kwalify'
+require 'yaml'
+require 'rails_config_validator/errors'
+
+module RailsConfigValidator
+  class Validator
+    def initialize(config_path, env, schema_path: nil)
+      @config_path = config_path
+      @schema_path = schema_path || config_to_schema_path(config_path)
+      @env = env
+    end
+
+    def valid?
+      meta_validate.empty? && validate.empty?
+    rescue
+      # ignored
+      false
+    end
+
+    def valid!
+      mv = meta_validate
+      fail InvalidSchemaError,
+           "Incorrect schema #{schema_path}; errors: #{mv}" unless mv.empty?
+      v = validate
+      fail InvalidConfigurationError,
+           "Incorrect config #{config_path}; errors: #{v}" unless v.empty?
+    end
+
+    def meta_validate
+      meta_validator = Kwalify::MetaValidator.instance
+      errors = meta_validator.validate(schema)
+      errors.map do |error|
+        "[#{error.path}](#{error.error_symbol}) #{error.message}"
+      end
+    rescue Errno::ENOENT => e
+      raise InvalidSchemaError, e
+    end
+
+    def validate
+      validator = kwalify_validator
+      env_settings = env_config
+      errors = validator.validate(env_settings)
+      errors.map do |error|
+        "[#{error.path}](#{error.error_symbol}) #{error.message}"
+      end
+    rescue InvalidConfigurationError => e
+      [e.message]
+    rescue Errno::ENOENT => e
+      raise InvalidConfigurationError, e
+    end
+
+    private
+
+    attr_reader :config_path, :schema_path
+
+    def kwalify_validator
+      Kwalify::Validator.new(schema)
+    rescue Errno::ENOENT => e
+      raise InvalidSchemaError, e
+    end
+
+    def schema
+      YAML.load_file(schema_path)
+    end
+
+    def config
+      YAML.load_file(config_path)
+    end
+
+    def env_config
+      document = config
+      fail InvalidConfigurationError,
+           "config file #{config_path} is empty" unless document
+      fail InvalidConfigurationError,
+           "missing configuration for env #{@env} in #{config_path}" unless document.key?(@env)
+      document[@env]
+    end
+
+    def config_to_schema_path(yml)
+      yml.sub(/\.yml$/, '.schema.yml')
+    end
+  end
+end

data/lib/rails_config_validator/version.rb

@@ -0,0 +1,3 @@
+module RailsConfigValidator
+  VERSION = '0.1.2'
+end

data/lib/rails_config_validator.rb

@@ -0,0 +1,6 @@
+require 'rails_config_validator/version'
+require 'rails_config_validator/validator'
+require 'rails_config_validator/railtie' if defined?(Rails)
+
+module RailsConfigValidator
+end

data/rails_config_validator.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_config_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rails_config_validator'
+  spec.version = RailsConfigValidator::VERSION
+  spec.authors = ['Michał Knapik']
+  spec.email = ['michal.knapik@u2i.com']
+
+  spec.summary = %q{Gem for validating Rails YAML configuration files.}
+  spec.description = %q{The gem uses Kwalify schema validator to check Rails configuration files syntax.}
+  spec.homepage = 'https://github.com/u2i/rails_config_validator'
+  spec.license = 'MIT'
+
+  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']
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  end
+
+  spec.add_dependency 'kwalify', '~> 0.7.2'
+  # spec.add_dependency 'rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'rubocop', '~> 0.31'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.3'
+  spec.add_development_dependency 'rubocop-checkstyle_formatter', '~> 0.2'
+
+  spec.add_development_dependency 'ci_reporter', '~> 2.0'
+  spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
+
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+  spec.add_development_dependency 'simplecov-rcov-text', '~> 0.0.3'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: rails_config_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Michał Knapik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kwalify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-checkstyle_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov-text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: The gem uses Kwalify schema validator to check Rails configuration files
+  syntax.
+email:
+- michal.knapik@u2i.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_u2i.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_config_validator.rb
+- lib/rails_config_validator/errors.rb
+- lib/rails_config_validator/railtie.rb
+- lib/rails_config_validator/rake_task.rb
+- lib/rails_config_validator/validator.rb
+- lib/rails_config_validator/version.rb
+- rails_config_validator.gemspec
+homepage: https://github.com/u2i/rails_config_validator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Gem for validating Rails YAML configuration files.
+test_files: []