tmux-erb-parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1609219d3c43082d5419e05ce2b64430b0524f0b6b09acb1e447e1efd4a5f243
+  data.tar.gz: 841d87ef8ccf1c9d618a301df1de3248cff2bac12d790f4ce8025c679fbcc626
+SHA512:
+  metadata.gz: ab1579f7d6bd609b12cfc58423e612595dbd534af28335ac7574766234fd6faa40dcf1f00695fb5afcfd8ae00bdc6e7f28077d960f87e7f91172cf527be7632f
+  data.tar.gz: e52c39ca365fc048fbdf0b4b2547ab76196b9c634c6de3b3b6f473512c11519fb9549ef4d52f3aee646f3f710a1f6e91ccdf13bfbedc66d070a1af4fbbab3d32

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+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,51 @@
+# Tmux ERB Parser
+[![Build Status](https://travis-ci.org/epaew/tmux-erb-parser.svg?branch=master)](https://travis-ci.org/epaew/tmux-erb-parser)
+
+A Tmux plugin to load tmux.conf.erb  
+[What's ERB?](https://ruby-doc.org/stdlib-2.5.1/libdoc/erb/rdoc/ERB.html)
+
+## Requirements
+* bash
+    * For script execution.
+    * You can use whatever you like as the default shell.
+* git
+* ruby:
+    * 2.3 or higher is required.
+* tmux
+
+## How to use
+1. Create your `tmux.conf.erb` and place it.
+    * By default, tmux-erb-parser loads all `*.erb` files in `~/.config/tmux/`
+    * Or you can change the load path. (Please see below.)
+2. Install tmux-erb-parser and run tmux!
+
+### Install with tpm (Tmux Plugin Manager)
+* Put this at the bottom of `~/.tmux.conf` (**Not your tmux.conf.erb !**):
+    ```tmux
+    setenv -g TMUX_CONF_EXT_PATH "path/to/tmux.conf.erb" # set your tmux.conf.erb's path
+    # Note: You can specify multiple files using glob expressions. This is parsed by bash.
+
+    set -g @plugin 'epaew/tmux-erb-parser'
+    set -g @plugin 'tmux-plugins/tpm'
+    # and list other plugins you want to install
+
+    # Initialize Tmux plugin manager (keep this line at the very bottom of tmux.conf)
+    run '~/.tmux/plugins/tpm/tpm'
+    ```
+
+* Run tmux and press `Prefix + I` to install plugins!
+
+### Install and configure with git
+* Install:
+    ```bash
+    git clone https://github.com/epaew/tmux-erb-parser ~/.tmux/plugins/tmux-erb-parser
+    ```
+
+* Configure:
+    * Put this in `~/.tmux.conf`:
+    ```tmux
+    run '~/.tmux/plugins/tmux-erb-parser/bin/tmux-erb-parser --inline path/to/tmux.conf.erb'
+    ```
+
+## License
+[MIT](LICENSE)

data/bin/tmux-erb-parser

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# vim:set ft=ruby:
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'tmux-erb-parser'
+
+cmd = TmuxERBParser::Command.new(ARGV)
+cmd.run

data/erb-parser.tmux

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# vim:set ft=sh:
+
+CURRENT_DIR=$(cd $(dirname ${BASH_SOURCE:-$0}) && pwd)
+cmd="${CURRENT_DIR}/bin/tmux-erb-parser"
+opts="--inline"
+
+TMUX_CONF_EXT_DEFAULT="${HOME}/.config/tmux/*.erb"
+tmux run-shell "${cmd} ${opts} ${TMUX_CONF_EXT_PATH:-$TMUX_CONF_EXT_DEFAULT}"

data/lib/tmux-erb-parser/command.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module TmuxERBParser
+  class Command
+    def initialize(args = [])
+      @command_name = File.basename($PROGRAM_NAME)
+      @args         = args.empty? ? ['--help'] : args
+      @options      = {}
+      @logger       = Logger.instance
+    end
+
+    def run
+      @option_parser = OptionParser.new(&method(:command_opts))
+      @option_parser.parse!(@args)
+      process
+      exit 0
+    rescue StandardError => e
+      err_msg = "#{e.message}\n#{e.backtrace.join("\n\t")}"
+      warn err_msg unless @options[:quiet]
+      @logger.error err_msg
+      exit 1
+    end
+
+    private
+
+    def check_args
+      msg = 'INPUT_ERB_FILES are required.' if @args.empty?
+      unless @options[:inline] ^ @options[:output]
+        msg = 'Please specify either --inline or --output option.'
+      end
+
+      raise ArgumentError, msg if msg
+    end
+
+    def process
+      check_args
+
+      args = @args.dup
+      args.each do |arg|
+        @logger.info "open #{arg}."
+        File.open(arg, 'r') do |input|
+          p = Parser.new(input,
+                         @options[:output],
+                         File.extname(arg.downcase)[1..-1].to_sym,
+                         @options)
+          p.parse
+        end
+      end
+    end
+
+    def command_opts(opts) # rubocop:disable Metrics/MethodLength
+      opts.banner = "Usage: #{@command_name} INPUT_FILES [options]"
+
+      opts.on('-i',
+              '--inline',
+              'Exec tmux subcommands to the current tmux-server.') do
+        @options[:inline] = true
+      end
+
+      opts.on('-o',
+              '--output [OUTPUT_FILE_NAME]',
+              String,
+              'Output the configuration to a file with the specified name.'\
+              ' If the file name is omitted, output to stdout') do |fname|
+        @options[:output] = File.open(fname, 'w') if fname
+        @options[:output] ||= $stdout
+      end
+
+      opts.on('-h', '--help', 'Print this help message') do
+        puts opts
+        exit
+      end
+
+      opts.on('-v', '--version', 'Print version information') do
+        puts "#{@command_name} #{TmuxERBParser::VERSION}"
+        exit
+      end
+    end
+  end
+end

data/lib/tmux-erb-parser/helpers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TmuxERBParser
+  module Helpers
+    module_function
+
+    def prefix_key
+      `tmux show-option -g prefix`.split[1]
+    end
+
+    def server_started?
+      !ENV['TMUX'].nil?
+    end
+
+    def tmux_version
+      (ENV['TMUX_VERSION'] || `tmux -V`.split[1]).to_f
+    end
+
+    def uname
+      ENV['UNAME'] || `uname`.chomp
+    end
+  end
+end

data/lib/tmux-erb-parser/logger.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'singleton'
+
+module TmuxERBParser
+  class Logger < ::Logger
+    include Singleton
+
+    def initialize
+      super(File.join(File.dirname(__dir__),
+                      "../log/#{File.basename($PROGRAM_NAME)}.log"))
+      self.level = ENV['DEBUG'] ? DEBUG : WARN
+    end
+  end
+end

data/lib/tmux-erb-parser/parser.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'json'
+require 'yaml'
+
+module TmuxERBParser
+  PARSER_CMD = File.expand_path('../../bin/tmux-erb-parser', __dir__)
+
+  class ParseError < StandardError; end
+
+  class Parser
+    def initialize(input, output, type = :erb, options = {})
+      @input = input
+      @output = output
+      @type = type
+      @options = options
+      @logger = Logger.instance
+    end
+
+    def parse
+      conf_lines = parse_file(@input, @type)
+      converted_lines = conf_lines.map(&method(:replace_source_file))
+      exec(converted_lines, @output)
+    end
+
+    private
+
+    def exec(commands, output = nil)
+      if output
+        commands.each(&output.method(:puts))
+      else
+        commands.inject(+'', &method(:exec_tmux))
+      end
+    end
+
+    def exec_tmux(buf, line)
+      buf = +buf if buf.frozen?
+      buf << line
+      buf = strip_comments(buf)
+      return buf if buf.empty?
+
+      if buf.end_with?('\\')
+        buf.chop!
+      else
+        command = "tmux #{buf.gsub(%(\\;), %( '\\;'))}"
+        @logger.debug "exec: #{command}"
+
+        `#{command}` unless ENV['DEBUG']
+        buf.clear
+      end
+    end
+
+    def generate_conf(_structured)
+      # TODO
+      parse_result = []
+    end
+
+    def parse_file(input, type)
+      erb_result = ERB.new(input.read).result
+
+      case type
+      when :json
+        generate_conf(JSON.parse(erb_result))
+      when :yml, :yaml
+        generate_conf(YAML.load_stream(erb_result))
+      else
+        # rubocop:disable Metrics/LineLength
+        erb_result
+          .gsub(/(\R){3,}/) { Regexp.last_match(1) * 2 } # reduce continuity blanklines
+          .gsub(/(\R)+\z/) { Regexp.last_match(1) }      # remove blankline at EOF
+          .each_line
+          .map(&:chomp)
+        # rubocop:enable Metrics/LineLength
+      end
+    end
+
+    def replace_source_file(line)
+      # source file -> run-shell "parser --inline file"
+      if line =~ /source/ && line !~ /run(-shell)?/
+        line = line.gsub(/"source(-file)?( -q)?\s([^\s\\;]+)"/) do
+          %("run-shell \\"#{PARSER_CMD} --inline #{Regexp.last_match(3)}\\"")
+        end
+        line = line.gsub(/source(-file)?( -q)?\s([^\s\\;]+)/) do
+          %(run-shell "#{PARSER_CMD} --inline #{Regexp.last_match(3)}")
+        end
+      end
+      line
+    end
+
+    def strip_comments(str)
+      return '' if str.empty? || str.lstrip.start_with?('#')
+
+      strip_eol_comments(str)
+    end
+
+    # TODO: refactoring
+    def strip_eol_comments(str)
+      flags = {}
+      str = str.each_char.inject(+'') do |result, char|
+        case char
+        when '\''
+          if !flags[:double] || (flags[:single] && result[-1] != '\\')
+            flags[:single] = !flags[:single]
+          end
+        when '"'
+          if !flags[:single] || (flags[:double] && result[-1] != '\\')
+            flags[:double] = !flags[:double]
+          end
+        when '#'
+          break result if flags.values.none?
+        end
+
+        result << char
+      end
+      str.rstrip
+    end
+  end
+end

data/lib/tmux-erb-parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TmuxERBParser
+  VERSION = '0.1.1'
+end

data/lib/tmux-erb-parser.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'tmux-erb-parser/command'
+require_relative 'tmux-erb-parser/helpers'
+require_relative 'tmux-erb-parser/logger'
+require_relative 'tmux-erb-parser/parser'
+require_relative 'tmux-erb-parser/version'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: tmux-erb-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- epaew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  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: simplecov-console
+  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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: A Tmux plugin to load tmux.conf.erb
+email:
+- epaew.333@gmail.com
+executables:
+- tmux-erb-parser
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/tmux-erb-parser
+- erb-parser.tmux
+- lib/tmux-erb-parser.rb
+- lib/tmux-erb-parser/command.rb
+- lib/tmux-erb-parser/helpers.rb
+- lib/tmux-erb-parser/logger.rb
+- lib/tmux-erb-parser/parser.rb
+- lib/tmux-erb-parser/version.rb
+homepage: https://github.com/epaew/tmux-erb-parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- bash
+- tmux
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Tmux plugin to load tmux.conf.erb
+test_files: []