yamlsh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 430146c89706b6f3af849d42eb882f0e8503b0be
+  data.tar.gz: 6d58467576bed5951376106b4b07715eade68ec7
+SHA512:
+  metadata.gz: 4c6c148646409f954b14e1ec0853a45a1f398d04e3c8855bc43e8e141ba5a49478f05243918e97aa35399d81137aa7f5353ee1ca2a1a3c6caf67950ac9a9728c
+  data.tar.gz: da4550c096f1b6d59053d17e2f4e55aff7fe62773093728dc313bbec1e013d3a50553c75ea21596f5451afbd319e7fac5e03913673c82177574a60e16d15ffd5

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 yamlsh.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Franck Verrot
+
+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,60 @@
+# yamlsh
+
+`yamlsh` is a YAML editing tool.
+
+Editing YAML, especially on large files, is a total nightmare. Most tooling
+rely on IDE/text editors folding-like features, but it's still up to the
+developers and translators to search and scroll up and down.
+
+Also when it comes to translations, the common guideline is to have one file
+per language. Synchronizing language files manually leads to many errors.
+
+`yamlsh` brings:
+
+  1. An easy command-line navigation a-la-shell (`cd`, `ls`, etc.)
+  2. An extensible command infrastructure
+
+
+# Pre-requisite
+
+* Any Ruby & 2.0 installation 
+
+
+# Installation
+
+    sudo gem install yamlsh
+
+
+# Usage
+
+    λ yamlsh foo.yml
+    # yamlsh - Franck Verrot <franck@verrot.fr> - MIT License - 2015
+    $(root)> ls
+    => en
+    $(root)> cd en
+    $(en)> ls
+    => key1
+    key2
+    $(en)> get key1
+    => Hello
+    $(en)> get key2
+    => {"foo"=>"bar", "baz"=>"bat"}
+    $(en)> set key1
+    Hit ENTER to stop typing
+    > Hello World!
+    => Hello World!
+    $(en)> get key1
+    => Hello World!
+    $(en)> save
+    => ok
+    $(en)> quit
+
+
+    Quitting...
+
+    λ
+
+
+# License
+
+MIT License, Franck Verrot, Copyright 2015

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rubygems/specification'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+  t.warning = true
+end
+
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'yamlsh'
+
+def gemspec
+  @gemspec ||= begin
+                 file = File.expand_path('../yamlsh.gemspec', __FILE__)
+                 eval(File.read(file), binding, file)
+               end
+end
+
+desc "Clean the current directory"
+task :clean do
+  rm_rf 'tmp'
+  rm_rf 'pkg'
+end
+
+desc "Run the full spec suite"
+task :full => ["clean", "test"]
+
+desc "install the gem locally"
+task :install => :package do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
+
+desc "validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build the gem"
+task :gem => [:gemspec, :build] do
+  mkdir_p "pkg"
+  sh "gem build yamlsh.gemspec"
+  mv "#{gemspec.full_name}.gem", "pkg"
+
+  require 'digest/sha2'
+  built_gem_path = "pkg/#{gemspec.full_name}.gem"
+  checksum = Digest::SHA512.new.hexdigest(File.read(built_gem_path))
+  checksum_path = "checksums/#{gemspec.version}.sha512"
+  File.open(checksum_path, 'w' ) {|f| f.write(checksum) }
+end
+
+desc "Install yamlsh"
+task :install => :gem do
+  sh "gem install pkg/#{gemspec.full_name}.gem"
+end
+
+task :default => :full
+

data/bin/yamlsh

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby -w
+# set ft=ruby
+$:<< 'lib'
+require 'yamlsh'
+
+def show_program_name(out = $stdout)
+  out.puts "# yamlsh - Franck Verrot <franck@verrot.fr> - MIT License - 2015"
+end
+
+def show_banner(out = $stdout)
+  show_program_name(out)
+  out.puts <<-EOS
+  usage: yamlsh <yaml file>
+  EOS
+end
+
+if ARGV.length != 1
+  show_banner
+  puts "Missing yaml file argument"
+  exit 1
+else
+  home = ENV.fetch('HOME','~/')
+  history_file = ENV.fetch('HISTORY_FILE', File.join(home, '.yamlsh_history'))
+  Yamlsh::CLI.new(ARGV.shift, history_file).run
+  exit 0
+end

data/lib/yamlsh.rb

@@ -0,0 +1,16 @@
+module Yamlsh
+end
+
+require 'yamlsh/path'
+require 'yamlsh/commands'
+require 'yamlsh/cli/output'
+require 'yamlsh/cli/no_output'
+require 'yamlsh/cli'
+
+require 'yamlsh/commands/cd'
+require 'yamlsh/commands/get'
+require 'yamlsh/commands/ls'
+require 'yamlsh/commands/save'
+require 'yamlsh/commands/set'
+require 'yamlsh/commands/pwd'
+require 'yamlsh/commands/quit'

data/lib/yamlsh/cli.rb

@@ -0,0 +1,73 @@
+require 'readline'
+require 'yamlsh/env'
+
+module Yamlsh
+  class CLI
+    def initialize(file, history_file)
+      @env = Env.new(file)
+      @history_file = history_file
+    end
+
+    def show_prompt
+      Readline.readline("$(#{@env.current_path})> ", true)
+    end
+
+    def load_history
+      IO.foreach(@history_file) do |line|
+        Readline::HISTORY.push line.chomp if line.size > 0
+      end
+    rescue Errno::ENOENT
+      if $-w
+        puts "No history file located at: #{@history_file}"
+      end
+    end
+
+    def add_to_history line
+      File.open(@history_file, 'a+') { |f| f.puts line }
+    end
+
+    def run
+      show_program_name
+
+      Readline.completion_append_character = ""
+      Readline.completion_proc = Proc.new do |str|
+        @env.keys.grep(/^#{Regexp.escape(str)}/)
+      end
+
+      trap('INT') do
+        Readline.delete_text
+        Readline.point = 0
+        Readline.refresh_line
+      end
+
+      load_history
+
+      begin
+        loop do
+          command_line = show_prompt
+          exit 0 if command_line.nil?
+
+          command, *args = command_line.split
+
+          unless command
+            Readline::HISTORY.pop# unless command && command.size == 0
+          end
+
+          begin
+            if Readline::HISTORY[Readline::HISTORY.length-2] == command
+              Readline::HISTORY.pop
+            end
+          rescue IndexError
+          end
+          status, output, @env = Commands[command.downcase][@env, command, args]
+          output.show
+          add_to_history command_line if status == Command::Success
+        end
+      rescue RuntimeError => e
+        puts "\n\nQuitting #{e.class} #{e.message}...\n"
+        puts e.backtrace
+        exit 1
+      end
+    end
+  end
+end

data/lib/yamlsh/cli/no_output.rb

@@ -0,0 +1,3 @@
+class NoOutput < Struct.new(:content)
+  def show; end
+end

data/lib/yamlsh/cli/output.rb

@@ -0,0 +1,5 @@
+class Output < Struct.new(:content)
+  def show
+    $stdout.puts "=> #{content}"
+  end
+end

data/lib/yamlsh/commands.rb

@@ -0,0 +1,13 @@
+require 'yamlsh/cli/output'
+require 'yamlsh/cli/no_output'
+
+Commands = Hash.new do
+  lambda do |env, command, args|
+    [Command::Error, Output.new("unknown command #{command}"), env]
+  end
+end
+
+module Command
+  Success = Class.new
+  Error = Class.new
+end

data/lib/yamlsh/commands/cd.rb

@@ -0,0 +1,8 @@
+Commands['cd'] = lambda do |env, command, args|
+  begin
+    env.cd(args.first)
+    [Command::Success, NoOutput.new, env] 
+  rescue Yamlsh::Env::CdError => e
+    [Command::Error, Output.new("cd: #{e.message}"), env] 
+  end
+end

data/lib/yamlsh/commands/get.rb

@@ -0,0 +1,4 @@
+Commands['get'] = lambda do |env, command, args|
+  value = env.get(args.first)
+  [Command::Success, Output.new(value), env]
+end

data/lib/yamlsh/commands/ls.rb

@@ -0,0 +1,6 @@
+Commands['ls'] = lambda do |env, command, args|
+  output = env.keys.map do |key|
+    key
+  end.join("\n")
+  [Command::Success, Output.new(output), env]
+end

data/lib/yamlsh/commands/pwd.rb

@@ -0,0 +1,8 @@
+Commands['pwd'] = lambda do |env, command, args|
+  begin
+    pwd = env.pwd
+    [Command::Success, Output.new(pwd), env]
+  rescue Yamlsh::Env::PwdError => e
+    [Command::Error, Output.new("pwd: #{e.message}"), env] 
+  end
+end

data/lib/yamlsh/commands/quit.rb

@@ -0,0 +1,3 @@
+Commands['quit'] = lambda do |env, command, args|
+  exit 0
+end

data/lib/yamlsh/commands/save.rb

@@ -0,0 +1,8 @@
+Commands['save'] = lambda do |env, command, args|
+  begin
+    value = env.save
+    [Command::Success, Output.new(value), env]
+  rescue Yaml::Env::SaveError => e
+    [Command::Error, Output.new("save: #{e.message}"), env] 
+  end
+end

data/lib/yamlsh/commands/set.rb

@@ -0,0 +1,20 @@
+Commands['set'] = lambda do |env, command, args|
+  begin
+    target, _ = args
+    Readline.pre_input_hook = proc do
+      old_value = begin
+                    env.get(target).to_s || ''
+                  rescue
+                    ''
+                  end
+      Readline.insert_text(old_value)
+      Readline.redisplay
+    end
+    new_value = Readline.readline("Hit ENTER to stop typing\n> ", true)
+    env.set(target, new_value)
+    Readline.pre_input_hook = nil
+    [Command::Success, Output.new(new_value), env]
+  rescue Yamlsh::Env::SetError => e
+    [Command::Error, Output.new("set: #{e.message}"), env] 
+  end
+end

data/lib/yamlsh/env.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+
+module Yamlsh
+  class Env
+    CdError   = Class.new(RuntimeError)
+    PwdError  = Class.new(RuntimeError)
+    SetError  = Class.new(RuntimeError)
+    SaveError = Class.new(RuntimeError)
+
+    def initialize(data_store, path = Path.new)
+      @data_store = data_store
+      @yaml = YAML.load_file(data_store)
+      @path = path
+      @current_yaml_at_path = @yaml.dup
+    end
+
+    def keys
+      @current_yaml_at_path.keys.sort
+    end
+
+    def get(key)
+      @current_yaml_at_path[key]
+    end
+
+    def set(key, value)
+      @current_yaml_at_path[key] = value
+    end
+
+    def pwd
+      @path.to_s
+    end
+
+    def cd key_path # . separated path
+      key_path ||= ''
+
+      if key_path == 'root'
+        @path.reset
+        @current_yaml_at_path = @yaml
+      elsif key_path == '.'
+        # nop
+      elsif key_path == '..'
+        @path.pop
+        new_path = @path.to_s
+        cd 'root'
+        cd new_path
+      else
+        segments = key_path.split('.')
+        segments.each do |segment|
+          yaml = @current_yaml_at_path[segment]
+
+          if yaml.respond_to? :keys
+            @current_yaml_at_path = yaml
+            @path.push segment
+          else
+            raise CdError, "#{segment} is a key, use SET to modify it"
+          end
+        end
+      end
+    end
+
+    def save
+      begin
+        File.open(@data_store, 'w') { |f| f.puts @yaml.to_yaml }
+        "ok"
+      rescue => e
+        "ko -- #{e.message}"
+      end
+    end
+
+    def current_path
+      @path.to_s
+    end
+  end
+end

data/lib/yamlsh/path.rb

@@ -0,0 +1,31 @@
+module Yamlsh
+  class Path
+    def initialize
+      @segments = Array.new
+    end
+
+    def to_s
+      if @segments.any?
+        segments
+      else
+        ['root']
+      end.join('.')
+    end
+
+    def push path
+      @segments.push path
+    end
+
+    def reset
+      @segments.clear
+    end
+
+    def pop
+      @segments.pop
+    end
+
+    def segments
+      @segments
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require 'minitest/autorun'

data/test/path_test.rb

@@ -0,0 +1,29 @@
+require 'helper'
+require 'yamlsh/path'
+
+class PathTest < Minitest::Test
+  def setup
+    @path = Yamlsh::Path.new
+  end
+
+  def test_initialize_empty
+    assert_equal 0, @path.segments.size
+  end
+
+  def test_push_pop_segmnets
+    @path.push 'foo'
+    assert_equal 1, @path.segments.size
+    assert_equal ['foo'], @path.segments
+
+    result = @path.pop
+    assert_equal 0, @path.segments.size
+    assert_equal 'foo', result
+  end
+
+  def test_reset
+    @path.push 'foo'
+    @path.reset
+
+    assert_equal 0, @path.segments.size
+  end
+end

data/yamlsh.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "yamlsh"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Franck Verrot"]
+  spec.email         = ["franck@verrot.fr"]
+  spec.summary       = %q{yamlsh - a YAML editor}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/franckverrot/yamlsh"
+  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 "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: yamlsh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Franck Verrot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-09 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: yamlsh - a YAML editor
+email:
+- franck@verrot.fr
+executables:
+- yamlsh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/yamlsh
+- lib/yamlsh.rb
+- lib/yamlsh/cli.rb
+- lib/yamlsh/cli/no_output.rb
+- lib/yamlsh/cli/output.rb
+- lib/yamlsh/commands.rb
+- lib/yamlsh/commands/cd.rb
+- lib/yamlsh/commands/get.rb
+- lib/yamlsh/commands/ls.rb
+- lib/yamlsh/commands/pwd.rb
+- lib/yamlsh/commands/quit.rb
+- lib/yamlsh/commands/save.rb
+- lib/yamlsh/commands/set.rb
+- lib/yamlsh/env.rb
+- lib/yamlsh/path.rb
+- test/helper.rb
+- test/path_test.rb
+- yamlsh.gemspec
+homepage: https://github.com/franckverrot/yamlsh
+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.4
+signing_key: 
+specification_version: 4
+summary: yamlsh - a YAML editor
+test_files:
+- test/helper.rb
+- test/path_test.rb
+has_rdoc: