yaml-validator 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77d97bf3baf6728ffb9da7c658caa53775fbd621
-  data.tar.gz: e8b5e202a428c260fe0978bf9ef1353cd39c677a
+  metadata.gz: c503fa73edea28c9fe2799bfaaf4758eca1b36ed
+  data.tar.gz: 60bef9cd8b188825561a14e8aeeb16fa38fb2ff1
 SHA512:
-  metadata.gz: d19beeb8c9657d58c7c279e52d3b5e4c247a0a6639e789aa69851c9622cfce25eba4b72c6a1a2143801b30c47432bac2e7a9f72ba89b8fbf9e1fa9f38202ea8d
-  data.tar.gz: 3ae273ea3a8a7b98f6a4a3a50b284038fb3adec9e115789a17161babba4427b8ea48bc57c046a8d663fd124e653c0f71a2deb02a3de03ac211f4d84ed6aea7ed
+  metadata.gz: 61c78d39bc78edd00f46e64e61518fc41f13a14c03006e3b1ed6503acf4f83e0ef2ef1b07a70e1494377f582869c9c8b3bece037a57ed58cf15ae7f359a093c5
+  data.tar.gz: b65227a65b0551438e3f6498cf095f60a7bcd26d1cd29a73295835f356339471bdfe98d6e00d3371a15d310649c42b3a7935db51cc1055a0f81606e8002544ec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yaml-validator (0.1.7)
+    yaml-validator (0.1.8)
       colorize
       rake
       rspec

data/lib/locked_keys.rb

@@ -0,0 +1,31 @@
+class LockedKeys
+  def initialize(root_path)
+    @locked_patterns = []
+
+    fullpath = File.join(root_path, 'locked_keys')
+    if File.exists? fullpath
+      read_locked_patterns(fullpath) unless File.directory?(fullpath)
+    end
+  end
+
+  def locked?(full_key)
+    @locked_patterns.each do |pattern|
+      if full_key =~ pattern
+        return true
+      end
+    end
+
+    false
+  end
+
+private
+
+  def read_locked_patterns(fullpath)
+    File.open(fullpath) do |f|
+      f.each_line do |line|
+        next if line.empty? or line.start_with? '#'
+        @locked_patterns << Regexp.new(line.rstrip)
+      end
+    end
+  end
+end

data/lib/yaml-validator.rb

@@ -1,21 +1,24 @@
+# encoding: utf-8
 require 'yaml'
 require 'yaml-validator/version'
 require_relative './helpers'
 require_relative './pluralization-validator'
 require_relative './sanitized-html-validator'
+require_relative './locked_keys'
 
 class YamlValidator
   
   def initialize(root_path, options = {})
     @options = options
     @root_path = root_path
+    @locked_keys = LockedKeys.new(@root_path) unless @root_path.nil?
   end
   
   def en
     return @en unless @en.nil?
 
     fullpath = File.join(@root_path, 'en.yml')
-    return nil unless File.exists?(fullpath)
+    return nil unless File.readable?(fullpath)
 
     @en = YAML.load_file(fullpath)['en']
     @en = Helpers.normalize_yaml(@en)
@@ -135,9 +138,25 @@ class YamlValidator
   def validate_item(full_key, value, is_pluralization = false)
     errors = validate_item_vars(full_key, value, is_pluralization)
     errors.concat validate_item_characters(full_key, value)
+    errors.concat validate_locked_key(full_key, value)
     errors
   end
 
+  def validate_locked_key(full_key, value)
+    errors = []
+    if @locked_keys.locked? full_key
+      locked_value = find_english_value(full_key)
+      if locked_value != value
+        errors << "#{full_key}: locked key value changed from '#{locked_value}' to '#{value}'"
+      end
+    end
+    errors
+  end
+
+  def find_english_value(full_key)
+    self.class.find_key_in_yaml_object(full_key, en)
+  end
+
   def validate_item_characters(full_key, value)
     bad_chars = '⏎'
     bad_chars_found = []

data/lib/yaml-validator/version.rb

@@ -1,3 +1,3 @@
 class YamlValidator
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/fixtures/locked_keys/en.yml

@@ -0,0 +1,15 @@
+en:
+  key1: value
+  locked_key1: locked value
+  locked_key2: locked value
+  locked_key3: locked value
+  unlocked_key4: locked value
+  key3:
+    subkey1: value
+    locked_subkey1: locked value
+    locked_subkey2: locked value
+  items:
+    - locked_key1: locked value
+      unlocked_key1: bla bla
+    - locked_key1: locked value
+

data/spec/fixtures/locked_keys/es.yml

@@ -0,0 +1,15 @@
+es:
+  key1: different value
+  locked_key1: locked value
+  locked_key2: changed value
+  locked_key3: changed value
+  unlocked_key4: changed value
+  key3:
+    subkey1: value
+    locked_subkey1: changed value
+    locked_subkey2: changed value
+  items:
+    - locked_key1: changed value
+      unlocked_key1: changed value
+    - locked_key1: changed value
+

data/spec/fixtures/locked_keys/locked_keys

@@ -0,0 +1,4 @@
+^locked_key[0-9]
+key3.locked_subkey1
+locked_subkey2
+items.[0-9]+.locked_key

data/spec/yaml-validator_spec.rb

@@ -35,6 +35,21 @@ describe YamlValidator do
       end
     end
 
+    describe "locked_keys scenario" do
+      it "returns errors" do
+        validator = YamlValidator.new('spec/fixtures/locked_keys', missing: false)
+        errors = validator.validate()
+        errors.should == [
+          "es.yml: locked_key2: locked key value changed from 'locked value' to 'changed value'",
+          "es.yml: locked_key3: locked key value changed from 'locked value' to 'changed value'",
+          "es.yml: key3.locked_subkey1: locked key value changed from 'locked value' to 'changed value'",
+          "es.yml: key3.locked_subkey2: locked key value changed from 'locked value' to 'changed value'",
+          "es.yml: items.0.locked_key1: locked key value changed from 'locked value' to 'changed value'",
+          "es.yml: items.1.locked_key1: locked key value changed from 'locked value' to 'changed value'"
+        ]
+      end
+    end
+
     describe "bad_chars scenario" do
       it "returns two errors" do
         validator = YamlValidator.new('spec/fixtures/bad_chars')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml-validator
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - David Elentok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - bin/yaml-validator
 - lib/helpers.rb
+- lib/locked_keys.rb
 - lib/pluralization-validator.rb
 - lib/sanitized-html-validator.rb
 - lib/yaml-validator.rb
@@ -109,6 +110,9 @@ files:
 - spec/fixtures/inconsistent_types/he.yml
 - spec/fixtures/invalid_yml/en.yml
 - spec/fixtures/invalid_yml/invalid.yml
+- spec/fixtures/locked_keys/en.yml
+- spec/fixtures/locked_keys/es.yml
+- spec/fixtures/locked_keys/locked_keys
 - spec/fixtures/missing_translations/en.yml
 - spec/fixtures/missing_translations/he.yml
 - spec/fixtures/numbered_keys/en.yml
@@ -153,6 +157,9 @@ test_files:
 - spec/fixtures/inconsistent_types/he.yml
 - spec/fixtures/invalid_yml/en.yml
 - spec/fixtures/invalid_yml/invalid.yml
+- spec/fixtures/locked_keys/en.yml
+- spec/fixtures/locked_keys/es.yml
+- spec/fixtures/locked_keys/locked_keys
 - spec/fixtures/missing_translations/en.yml
 - spec/fixtures/missing_translations/he.yml
 - spec/fixtures/numbered_keys/en.yml