yamlclean 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fcc6602a56f8c64065bfe7ac93b5e6207aae728
-  data.tar.gz: c2799bcd40b95976bc563d3ce0710b9650ca840d
+  metadata.gz: 9e311f3cd3e04000ded8310f7b003bfd02a81755
+  data.tar.gz: e51f949ef7cb759d1fa6c49bb3e7f249febe3497
 SHA512:
-  metadata.gz: cb8e6cee999a679f564031633e4f6b2142961ae80ad0f11f22d0917d9f5341e473c12d2764fcfbe9b1801df0caf7b1f9658bea4e53b31653b4f5c7d08b23e9e5
-  data.tar.gz: 65605b7aa7fbcf519940bcc7fce0ba8d15b99b0fb0c256fd169cf670792599f6d81b8fb5afb84a5fc6f1d1503d97b502d3634556b8454a84e03e1a96c6e0037d
+  metadata.gz: 83ecbfe0f212cdb20009f3a6b39e1b2c4fd88a5db75b20db75823efd3e3c80be806e5fed97b7a7eb6ceaace93830d5fc09dd4fbc2f42df934fc861279032edf6
+  data.tar.gz: 65bab2e705bac69f8b5042b22a2e99369df577f9c61233532467dcd47266cf6d353d15c075b43219744d0e145676d5ab2a3ac02983132587fffc2c003c15a217

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    yamlclean (0.1.0)
+    yamlclean (0.1.1)
+      ya2yaml
 
 GEM
   remote: https://rubygems.org/
@@ -17,7 +18,6 @@ DEPENDENCIES
   bundler (~> 1.13)
   minitest (~> 5.0)
   rake (~> 10.0)
-  ya2yaml
   yamlclean!
 
 BUNDLED WITH

data/README.md

@@ -19,6 +19,43 @@ Usage
 
     $> yamlclean input.yml > output.yml
 
+What does it do?
+----------------
+
+The most significant change that this script makes is reformatting of multi-line strings.
+
+It will convert this:
+
+
+```yml
+en_GB:
+  GroupImportForm:
+    Help2:                '<div class="advanced">
+
+      <h4>Advanced usage</h4>
+
+      <ul><li>Allowed columns: <em>%s</em></li><li>Existing groups are matched by their unique <em>Code</em> value, and updated with any new values from the imported file</li><li>Group hierarchies can be created by using a <em>ParentCode</em> column.</li><li>Permission codes can be assigned by the <em>PermissionCode</em> column. Existing permission codes are not cleared.</li>
+
+      </ul>
+
+      </div>'
+```
+
+To this:
+
+```yml
+en_GB:
+  GroupImportForm:
+    Help2: |-
+        <div class="advanced">
+        <h4>Advanced usage</h4>
+        <ul><li>Allowed columns: <em>%s</em></li><li>Existing groups are matched by their unique <em>Code</em> value, and updated with any new values from the imported file</li><li>Group hierarchies can be created by using a <em>ParentCode</em> column.</li><li>Permission codes can be assigned by the <em>PermissionCode</em> column. Existing permission codes are not cleared.</li>
+        </ul>
+        </div>
+```
+
+This is important because many PHP and JavaScript yaml parsers won't parse the former syntax.
+
 Contributing and development
 ----------------------------
 

data/lib/yamlclean/version.rb

@@ -1,3 +1,3 @@
 module YamlClean
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/yamlclean.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = [ "yamlclean" ]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "ya2yaml"
+  spec.add_dependency "ya2yaml"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yamlclean
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sam Minnee
@@ -17,7 +17,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: