tamplier 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fea1bfad7a66cbbf76e0750bb1dee17b250338ec
-  data.tar.gz: 019c9084db0414d3b27631751c61b1b3e6398f7b
+  metadata.gz: c19c4b86a92337ec4c88daf48eac19b48f18ba0d
+  data.tar.gz: ae4d04d4295cbbe1574f375599939c7dbb6283c6
 SHA512:
-  metadata.gz: dfaedf18b8a739b2c16e50bb73ea5bd021e2e4dba19524f42e710c46a47057dd3bf772df4a6cebf6a91e179df0c3fe07f0a8a069b7633d0ad25c9eb3d8761664
-  data.tar.gz: a0d2dfc274ede643f08ebc8ff3419877d1053f98c10d795749fd2db421ac421ffcc0fd679c54699ded135bf4ce6c93c2f68357e46cc0e37737bd91893d3a1f4e
+  metadata.gz: 1c02be62ff4cb55581ab70ef4f3dff913c2a765bb263983b41e097ecd5ecafe61c533d67b96dc3233fb0381bdaa9ced476058ce22c6396774e445f5b1f621e11
+  data.tar.gz: 782e381c1d7ff8a869d30ea50fae8c0b4fd437c64a13b415dc1fd3c8e7d2da85063b091cd02384868efc8fadaa08d1e30595205923ec5b46a34ac311f2354d47

data/lib/tamplier.rb

@@ -1,4 +1,8 @@
-require "tamplier/version"
+require 'pathname'
+require 'yaml'
 
-module Tamplier
-end
+require 'tamplier/version'
+require 'tamplier/exceptions/configuration_exception'
+require 'tamplier/validator'
+
+require 'tamplier/railtie' if defined?(Rails)

data/lib/tamplier/exceptions/configuration_exception.rb

@@ -0,0 +1,2 @@
+class ConfigurationException < RuntimeError
+end

data/lib/tamplier/railtie.rb

@@ -0,0 +1,7 @@
+module Tamplier
+  class Railtie < Rails::Railtie
+    initializer('tamplier.initializer') do
+      Validator.new.ensure(Rails.root.join('config'), Rails.env)
+    end
+  end
+end

data/lib/tamplier/validator.rb

@@ -0,0 +1,33 @@
+module Tamplier
+  class Validator
+    def ensure(root, environment = nil)
+      Pathname.glob(File.join(root, '*.yml.sample')).each do |sample_file|
+        config_file = sample_file.sub_ext('')
+        raise ConfigurationException.new("Configuration file #{config_file} does not exist, but sample file #{sample_file} does.") unless config_file.exist?
+
+        if environmental_file?(sample_file)
+          raise ConfigurationException.new("There is no #{environment} environment in the #{config_file} file.") unless YAML.load(config_file.read)[environment].present?
+        end
+
+        diff = environmental_file?(sample_file) ?
+          flat_keys(YAML.load(sample_file.read)['development']) - flat_keys(YAML.load(config_file.read)[environment]) :
+          flat_keys(YAML.load(sample_file.read))                - flat_keys(YAML.load(config_file.read))
+
+        raise ConfigurationException.new("Several keys #{diff.inspect} from #{sample_file} are not in #{config_file} file.") unless diff.empty?
+      end
+    end
+
+    private
+
+    def environmental_file?(file)
+      (YAML.load(file.read).keys & %w[development test]).present?
+    end
+
+    def flat_keys(hash, path = '')
+      return path unless hash.is_a?(Hash)
+      hash.map do |key, value|
+        flat_keys(value, "#{path}/#{key}")
+      end.flatten
+    end
+  end
+end

data/lib/tamplier/version.rb

@@ -1,3 +1,3 @@
 module Tamplier
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/dummy/config/environment.rb

@@ -0,0 +1,20 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup'
+
+require 'rails'
+
+Bundler.require(*Rails.groups)
+require 'tamplier'
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+
+Rails.application.configure do
+  config.eager_load = false
+  config.root = File.dirname(File.expand_path('../', __FILE__))
+end
+
+Rails.application.initialize!

data/spec/dummy/config/test.yml.sample

@@ -0,0 +1 @@
+test.yml.sample

data/spec/examples/absent_environment/environment.yml

@@ -0,0 +1,2 @@
+development:
+  key: value

data/spec/examples/absent_environment/environment.yml.sample

@@ -0,0 +1,2 @@
+development:
+  key: value

data/spec/examples/absent_environment_key/environment.yml

@@ -0,0 +1,2 @@
+production:
+  exist: value

data/spec/examples/absent_environment_key/environment.yml.sample

@@ -0,0 +1,3 @@
+development:
+  exist: value
+  not_exist: value

data/spec/examples/absent_environment_keys/environment.yml

@@ -0,0 +1,4 @@
+production:
+  first:
+    second:
+      third: value

data/spec/examples/absent_environment_keys/environment.yml.sample

@@ -0,0 +1,5 @@
+development:
+  first:
+    second:
+      third: value
+      fourth: value

data/spec/examples/absent_file/invalid.yml.sample

@@ -0,0 +1 @@
+invalid.yml.sample

data/spec/examples/absent_file/valid.yml

@@ -0,0 +1 @@
+valid.yml

data/spec/examples/absent_file/valid.yml.sample

@@ -0,0 +1 @@
+valid.yml.sample

data/spec/examples/absent_keys/non_environment.yml

@@ -0,0 +1,6 @@
+first:
+  second_misspell:
+    third:
+      - 1
+      - 2
+    fourth: value

data/spec/examples/absent_keys/non_environment.yml.sample

@@ -0,0 +1,6 @@
+first:
+  second:
+    third:
+      - 1
+      - 2
+    fourth: value

data/spec/railtie_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'tamplier/exceptions/configuration_exception'
+
+describe 'integration test' do
+  it 'should not let application start without proper config' do
+    expect { require File.expand_path("../dummy/config/environment", __FILE__) }.to raise_error(ConfigurationException)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+end

data/spec/validator_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'tamplier/exceptions/configuration_exception'
+require 'tamplier/validator'
+
+describe Tamplier::Validator do
+  it 'checks, that all required config files are present' do
+    expect { subject.ensure('spec/examples/absent_file/') }.to raise_error(ConfigurationException, %q[Configuration file spec/examples/absent_file/invalid.yml does not exist, but sample file spec/examples/absent_file/invalid.yml.sample does.])
+  end
+
+  it 'checks, that there is a valid environment in yml file' do
+    expect { subject.ensure('spec/examples/absent_environment/', 'production') }.to raise_error(ConfigurationException, %q[There is no production environment in the spec/examples/absent_environment/environment.yml file.])
+  end
+
+  it 'checks, that all environmental keys from sample file exist in real file' do
+    expect { subject.ensure('spec/examples/absent_environment_key/', 'production') }.to raise_error(ConfigurationException, %q[Several keys ["/not_exist"] from spec/examples/absent_environment_key/environment.yml.sample are not in spec/examples/absent_environment_key/environment.yml file.])
+  end
+
+  it 'checks, that all environmental keys (in deep) from sample file exist in real file' do
+    expect { subject.ensure('spec/examples/absent_environment_keys/', 'production') }.to raise_error(ConfigurationException, %q[Several keys ["/first/second/fourth"] from spec/examples/absent_environment_keys/environment.yml.sample are not in spec/examples/absent_environment_keys/environment.yml file.])
+  end
+
+  it 'checks, that all non enviromental keys from sample file exist in real file' do
+    expect { subject.ensure('spec/examples/absent_keys/') }.to raise_error(ConfigurationException, %q[Several keys ["/first/second/third", "/first/second/fourth"] from spec/examples/absent_keys/non_environment.yml.sample are not in spec/examples/absent_keys/non_environment.yml file.])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamplier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexander Shestakov
@@ -38,6 +38,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   How many times your deploys were failed, because you forgot to update .yml files on server... No more!
   Tamplier gem checks, that all keys from any .yml.sample files are actually exist in real .yml files.
@@ -50,7 +106,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/tamplier.rb
+- lib/tamplier/exceptions/configuration_exception.rb
+- lib/tamplier/railtie.rb
+- lib/tamplier/validator.rb
 - lib/tamplier/version.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/test.yml.sample
+- spec/dummy/log/development.log
+- spec/examples/absent_environment/environment.yml
+- spec/examples/absent_environment/environment.yml.sample
+- spec/examples/absent_environment_key/environment.yml
+- spec/examples/absent_environment_key/environment.yml.sample
+- spec/examples/absent_environment_keys/environment.yml
+- spec/examples/absent_environment_keys/environment.yml.sample
+- spec/examples/absent_file/invalid.yml.sample
+- spec/examples/absent_file/valid.yml
+- spec/examples/absent_file/valid.yml.sample
+- spec/examples/absent_keys/non_environment.yml
+- spec/examples/absent_keys/non_environment.yml.sample
+- spec/railtie_spec.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb
 homepage: https://github.com/maksar/tamplier
 licenses:
 - MIT
@@ -76,4 +152,21 @@ signing_key:
 specification_version: 4
 summary: Tamplier gem provides ability to manage .yml.sample config files in your
   ruby projects.
-test_files: []
+test_files:
+- spec/dummy/config/environment.rb
+- spec/dummy/config/test.yml.sample
+- spec/dummy/log/development.log
+- spec/examples/absent_environment/environment.yml
+- spec/examples/absent_environment/environment.yml.sample
+- spec/examples/absent_environment_key/environment.yml
+- spec/examples/absent_environment_key/environment.yml.sample
+- spec/examples/absent_environment_keys/environment.yml
+- spec/examples/absent_environment_keys/environment.yml.sample
+- spec/examples/absent_file/invalid.yml.sample
+- spec/examples/absent_file/valid.yml
+- spec/examples/absent_file/valid.yml.sample
+- spec/examples/absent_keys/non_environment.yml
+- spec/examples/absent_keys/non_environment.yml.sample
+- spec/railtie_spec.rb
+- spec/spec_helper.rb
+- spec/validator_spec.rb