guard-yamlsort 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b69e36e81d47dea40c33abf82ad0ba2ed112b1f
+  data.tar.gz: 61a93e036188631fe64e73f303bd1dd0e208a48f
+SHA512:
+  metadata.gz: 8cf1888cda4813de585c6b1b9e2f77530b4b0eeb39d935814177c8ff09a9781d0f44c2ba456376ae933840caee03b2571b47979fe8f4d999c6a6dfe5e6cc0657
+  data.tar.gz: 21b4e9ab65c9a14587e8b59b411819ae97d6f2dde86f6a7eee36768cb6723b57ab7be716cfa150ed10dc7f7e4ec936cdda5b8c13af955c013c7cbd4036b9ec8e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,59 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'yard', port: "8899", quiet: true do
+  watch(%r{app/.+\.rb})
+  watch(%r{lib/.+\.rb})
+  watch(%r{ext/.+\.c})
+end
+
+guard :minitest do
+
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Thomas Vendetta
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Guard::Yamlsort
+Guard::Yamlsort alphabetically sorts keys in yaml files when a modification is detected.
+
+![Preview of guard-yamlsort](https://raw.githubusercontent.com/thomasv314/guard-yamlsort/master/preview.gif "Preview of Guard yamlsort")
+
+## Requirements
+* The [Guard](https://github.com/guard/guard) rubygem.
+* Ruby 1.9.2 or higher.
+
+## Install
+
+Add guard-yamlsort to your Gemfile (inside development group):
+
+```bash
+gem 'guard-yamlsort'
+```
+
+Install or update your bundle:
+
+```bash
+bundle install
+```
+
+Add the default guard-yard definition to your Guardfile:
+
+```bash
+  guard init yamlsort
+```
+
+## Guardfile
+
+```ruby
+guard 'yamlsort' do
+  watch(%r{^config/locales/.+\.yml})
+end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/guard-yamlsort.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/yamlsort/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-yamlsort"
+  spec.version       = Guard::YamlsortVersion::VERSION
+  spec.authors       = ["Thomas Vendetta"]
+  spec.email         = ["thomas@vendetta.io"]
+  spec.summary       = %q{Sorts YAML files alphabetically by key}
+  spec.description   = %q{Sorts YAML files alphabetically by key. }
+  spec.homepage      = "http://vendetta.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.6"
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-minitest", "~> 2.4"
+  spec.add_development_dependency "guard-yard", "~> 2.1"
+  spec.add_dependency 'guard-compat', '~> 1.1'
+
+end

data/lib/guard/yamlsort.rb

@@ -0,0 +1,90 @@
+require 'guard/compat/plugin'
+require 'guard/yamlsort/version'
+
+module Guard
+  class Yamlsort < Guard::Plugin 
+
+    require 'guard/yamlsort/file_sorter'
+
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(options = {})
+      super
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      Guard::UI.info("Started YAML sorter.") 
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    #
+    # @raise [:task_has_failed] when stop has failed
+    # @return [Object] the task result
+    #
+    def stop
+      true
+    end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+    #
+    # @raise [:task_has_failed] when reload has failed
+    # @return [Object] the task result
+    #
+    def reload
+      true
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    def run_all
+      true
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    def run_on_additions(paths)
+      true
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    def run_on_modifications(paths)
+      Guard::UI.info("Running YAML sorter.") 
+      paths.each { |p| FileSorter.new(p) }
+    end
+
+    # Called on file(s) removals that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    # @return [Object] the task result
+    #
+    def run_on_removals(paths)
+      true 
+    end
+
+  end
+end

data/lib/guard/yamlsort/file_sorter.rb

@@ -0,0 +1,63 @@
+module Guard
+  class Yamlsort
+    class FileSorter
+
+      attr_accessor :yaml
+
+      # Initialized with the path of the YAML file we want to sort. It automatically
+      # loads the file, stores any comments in memory, and then starts sorting 
+      # unless otherwise specified with the start_on_init parameter.
+      # If no parameters are passed a Generic  
+      # @param path [String] the path on disc this file is located at
+      # @param start_on_init [Boolean] whether or not to automatically sort & write on 
+      #   initialization of a FileSorter (for testing purposes)
+      def initialize(path, start_on_init = true)
+        @path = path
+        @comments = []
+        load_yaml 
+        sort_yaml
+        write_yaml
+      end
+      
+      # Load the YAML file contents into @yaml and store the comments in @comments 
+      def load_yaml
+        self.yaml= File.open(@path, "r") do |f| 
+          contents = f.read
+          contents.split("\n").each do |line|
+            @comments.push(line) if line[0] == '#'
+          end
+          YAML.load(contents) 
+        end
+      end
+
+      # Recursively sort the contents of @yaml
+      def sort_yaml
+        self.yaml= self.class.sort(yaml)
+      end
+
+      # Sorts the hash alphabetically by it's keys and then writes the original comments 
+      # plus the sorted hash to the same path in a valid YAML file.
+      def write_yaml
+        File.open(@path, "w") do |f| 
+          if !@comments.empty?
+            f.write @comments.join("\n")
+            f.write("\n")
+          end
+          f.write YAML.dump(yaml)
+        end
+      end
+
+      # Recursively sorts any hash it's given by key using Array#sort
+      def self.sort(obj)
+        if obj.is_a? Hash
+          sorted = {}
+          obj.keys.sort.each { |k| sorted[k] = sort(obj[k]) }
+          sorted
+        else 
+          return obj
+        end
+      end
+
+    end
+  end
+end

data/lib/guard/yamlsort/templates/Guardfile

@@ -0,0 +1,5 @@
+guard 'yamlsort' do
+
+  watch('config/locales/en.yml')
+
+end

data/lib/guard/yamlsort/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module YamlsortVersion
+    VERSION = "0.0.1"
+  end
+end

data/test/test_file_sorter.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+class TestFileSorter < MiniTest::Test
+
+  def setup
+    # Create an unsorted hash
+    @sample_data = { 
+      "b" => { "bravo" => true, "zulu" => false, "charlie" => true }, 
+      "c" => { "alpha" => true }, 
+      "a" => { "zulu" => false, "charlie" => true, "bravo" => true },
+    }
+  end
+  
+  def test_unsorted_file_gets_sorted
+    # Write the unsorted hash to a temporary YAML file to test
+    test_file = "/tmp/guard-yamlsort-test.yml"
+    File.open(test_file, "w") do |f|
+      f.write YAML.dump(@sample_data)
+    end
+
+    # Make sure the file was written properly is unsorted
+    unsortedYAML = File.open(test_file, "r") do |file|
+      YAML.load(file)
+    end
+
+    assert_equal ["b", "c", "a"], unsortedYAML.keys
+
+    # Create a new FileSorter that loads and writes yaml 
+    Guard::Yamlsort::FileSorter.new(test_file)
+       
+    # Test sorted YAML
+    sortedYAML = File.open(test_file, "r") do |file|
+      YAML.load(file)
+    end
+    
+    assert_equal ["a", "b", "c"], sortedYAML.keys
+  end
+  
+  def test_unsorted_file_gets_sorted_and_retains_header_comments
+    # Write some comments and sample data to a temporary YAML file to test
+    test_file = "/tmp/guard-yamlsort-test-comments.yml"
+    File.open(test_file, "w") do |f|
+      f.write "# this is a comment\n"
+      f.write "# so is this\n"
+      f.write YAML.dump(@sample_data)
+    end
+      
+    Guard::Yamlsort::FileSorter.new(test_file)
+    fs = File.open(test_file, "r") { |file| file.read }
+   
+    lines = fs.split("\n")
+    
+    assert_equal "#", lines[0][0], "1st comment not written"
+    assert_equal "#", lines[1][0], "2nd comment not written"
+  end
+
+  protected
+  def test_path(name)
+    File.join(Dir.pwd, "test", name)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'guard/yamlsort'
+require 'minitest/autorun'
+require 'yaml'
+

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: guard-yamlsort
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Vendetta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 'Sorts YAML files alphabetically by key. '
+email:
+- thomas@vendetta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-yamlsort.gemspec
+- lib/guard/yamlsort.rb
+- lib/guard/yamlsort/file_sorter.rb
+- lib/guard/yamlsort/templates/Guardfile
+- lib/guard/yamlsort/version.rb
+- preview.gif
+- test/test_file_sorter.rb
+- test/test_helper.rb
+homepage: http://vendetta.io
+licenses:
+- MIT
+metadata: {}
+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.5
+signing_key: 
+specification_version: 4
+summary: Sorts YAML files alphabetically by key
+test_files:
+- test/test_file_sorter.rb
+- test/test_helper.rb
+has_rdoc: