rails_config_validator 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbb9506342925e85eeca4059dee9057bc2cf7d95
-  data.tar.gz: 724b787b2b6096b52493765d389ddd22a06b38d3
+  metadata.gz: ff18f579ada65dfbdd3d7c2d2678e04a6f610de8
+  data.tar.gz: af9422fa2f2b1dc175cc853b5991675b4773e32b
 SHA512:
-  metadata.gz: 288657094f81e9571fa8d81c1ece0c27b91d64121ccdfe11dde7c2db0056aeddcdc27ff772a412a431629ed404c927c086bff80b271862e0de64b5f01bd8888b
-  data.tar.gz: 6ba09385a82eda2c0767635ef515a292229b79a6bd57a04dbd4088344c87d83de2ef2c1f1c1841702a4c6989f23d4b2f3b7218929062be0177dd876cc375b2db
+  metadata.gz: 3ec6cbd1d5e01d9abfe746f09dc2fcb681eae068e89dfc1e7477af69e15ff4458468e9abe208c9e24a2561acba69eee2c7a07205f4b892f5290541f47afc633a
+  data.tar.gz: 8b23315e6016df39b9a14075e5e9e1da7ca4c714b6e943717d6ef0dd8196f0cded39a4570e2b60056e62561ab9b559baad0d6add6533f970e36289b712de6aca

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .idea
+rails_config_validator-*.gem

data/README.md

@@ -4,41 +4,60 @@
 [![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)
+[![Gem Version](https://badge.fury.io/rb/rails_config_validator.svg)](http://badge.fury.io/rb/rails_config_validator)
 
-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
+The gem uses [Kwalify](http://www.kuwata-lab.com/kwalify/) schema validator to check Rails configuration files syntax.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
-gem 'rails_config_validator'
+gem 'rails_config_validator', '~> 0.1'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Add Rake tasks to `Rakefile`:
+
+```ruby
+require 'rails_config_validator/rake_task'
+RailsConfigValidator::RakeTask.new
+```
+
+Run Rake task to copy default `database.yml` schema file and add `config/database.schema.yml` to your version control:
+
+    rake config_validator:init
+    git add config/database.schema.yml
 
-    $ gem install rails_config_validator
+Specify files for which the gem should run validation `config/application.rb` or in environment file:
+
+```ruby
+config.config_validator.files = %w(database.yml your-config.yml)
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+After deployment the schema can be validated with Rake task:
+
+    export RAILS_ENV=production
+    bundle exec rake config_validator:validate[config/database.yml]
 
 ## 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.
+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.
+
+Use `bundle exec guard` to run `rspec` and `rubocop` on each code change.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## 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`)
+1. [Fork it](https://github.com/u2i/rails_config_validator/fork)
+2. Create your feature branch (`git checkout -b feature/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
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request to branch `develop`.

data/Rakefile

@@ -4,20 +4,20 @@ begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError => e
-  puts e
+  STDERR.puts e
 end
 
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new(:rubocop)
 rescue LoadError => e
-  puts e
+  STDERR.puts e
 end
 
 begin
   require 'ci/reporter/rake/rspec'
 rescue LoadError => e
-  puts e
+  STDERR.puts e
 end
 
 task default: [:spec, :rubocop]

data/lib/rails_config_validator/rake_task.rb

@@ -3,22 +3,38 @@ 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?
+        task_init
+        task_validate
+      end
+    end
+
+    private
+
+    def task_init
+      desc "Copies database.schema.yml to Rails's config directory"
+      task :init do
+        rake_file_dir = File.expand_path(File.dirname(__FILE__))
+        FileUtils.cp(
+          File.join(rake_file_dir, 'templates', 'database.schema.yml'),
+          File.join(Dir.pwd, 'config')
+        )
+      end
+    end
+
+    def task_validate
+      desc 'Validates Rails config file against YML schema'
+      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
+        v = RailsConfigValidator::Validator.new(config, env, schema_path: schema)
+        v.valid!
       end
     end
   end

data/lib/rails_config_validator/templates/database.schema.yml

@@ -0,0 +1,26 @@
+type: map
+mapping:
+  adapter:
+    type: str
+    required: true
+  pool:
+    type: int
+  timeout:
+    type: int
+  database:
+    type: str
+  hostname:
+    type: str
+  username:
+    type: str
+  password:
+    type: str
+  socket:
+    type: str
+  encoding:
+    type: str
+  port:
+    type: int
+    range:
+      min: 0
+      max: 65535

data/lib/rails_config_validator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_config_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Michał Knapik
@@ -229,6 +229,7 @@ files:
 - lib/rails_config_validator/errors.rb
 - lib/rails_config_validator/railtie.rb
 - lib/rails_config_validator/rake_task.rb
+- lib/rails_config_validator/templates/database.schema.yml
 - lib/rails_config_validator/validator.rb
 - lib/rails_config_validator/version.rb
 - rails_config_validator.gemspec