thor-zsh_completion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d2b258587a459e70ec955724fb631aafc73786f
+  data.tar.gz: 24905d7c013630ac13c9bea4e6a29cfb3af9f2b3
+SHA512:
+  metadata.gz: 1b30db3b9e7649a2f3253aa6f54d061d40db7b5381829ceae9b923d6435ff68653f3c7d582a677dd304e73c84e0cd5b091f7028f82b7507c79548f6cde369877
+  data.tar.gz: b69f1767db423e6f957573fe30f866adf44d7e0bd17b70a9cb3b06f77cdc5136a23feea4749ab5db07d3e481fcb52bc97070449fc59ff99b387da29e7f0fd4ed

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 labocho
+
+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,81 @@
+# Thor::ZshCompletion
+
+Create zsh completion script for [Thor](http://whatisthor.com/) subclass.
+
+
+## Feature
+
+This creates completion script that completes...
+
+- Subcommands (includes nested subcommands such as `knife solo cook ...`)
+- Options for subcommands.
+
+But...
+
+- Does not support arguments for subcommand, all arguments are completed as file.
+- Does not support arguments for options, all arguments are completed as file.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thor-zsh_completion'
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thor-zsh_completion
+
+
+## Usage
+
+To generate completion script:
+
+    require "thor"
+    require "thor/zsh_completion"
+
+    class YourCommand < Thor
+      # ...
+    end
+
+    puts Thor::ZshCompletion::Generator.new(YourCommand, "yourcommand").generate
+
+Or include `Thor::ZshCompletion::Command` to add subcommand `zsh-completion`
+
+    require "thor"
+    require "thor/zsh_completion"
+
+    class YourCommand < Thor
+      include ZshCompletion::Command
+      # ...
+    end
+
+    YourCommand.start(ARGV)
+
+and execute below.
+
+    $ yourcommand zsh-completion [--name=yourcommand] > path/to/fpath/_yourcommand
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/thor-zsh_completion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "thor/zsh_completion"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thor/zsh_completion/command.rb

@@ -0,0 +1,16 @@
+class Thor
+  module ZshCompletion
+    module Command
+      def self.included(klass)
+        klass.class_eval do
+          desc "zsh-completion", "Print zsh completion script"
+          option :name, aliases: [:n]
+          def zsh_completion
+            name = options.name || File.basename($0)
+            puts ZshCompletion::Generator.new(self.class, name).generate
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thor/zsh_completion/generator.rb

@@ -0,0 +1,96 @@
+class Thor
+  module ZshCompletion
+    class Generator
+      SUBCOMMAND_FUNCTION_TEMPLATE = ERB.new(File.read("#{__dir__}/template/subcommand_function.erb"), nil, "-")
+      attr_reader :thor, :name
+
+      def initialize(thor, name)
+        @thor = thor
+        @name = name
+      end
+
+      def generate
+        # Format command information like below:
+        #
+        # { name: "__iterm",
+        #   options: [],
+        #   subcommands: [
+        #     { name: "list-sessions",
+        #       description: "List name of all sessions in current terminal",
+        #       options: [],
+        #       subcommands: [],
+        #     },
+        #     { name: "new-session",
+        #       description: "Create new session in current terminal",
+        #       options: [
+        #         { names: ["--name", "-n"],
+        #           description: nil,
+        #         },
+        #       ],
+        #       subcommands: [],
+        #     },
+        #     { name: "sessions",
+        #       description: "Manage sessions by .iterm-sessions",
+        #       options: [],
+        #       subcommands: [
+        #         { name: "start",
+        #           description: "Start all sessions if it's not started",
+        #           options: [],
+        #           subcommands: [],
+        #         }
+        #       ]
+        #     }
+        #   ]
+        # }
+
+        main = {
+          name: "__#{name}",
+          description: nil,
+          options: [],
+          subcommands: subcommand_metadata(thor)
+        }
+
+        erb = File.read("#{__dir__}/template/main.erb")
+        ERB.new(erb, nil, "-").result(binding)
+      end
+
+      private
+      def render_subcommand_function(subcommand, prefix: [])
+        source = []
+
+        prefix = (prefix + [subcommand[:name]])
+        function_name = prefix.join("_")
+        depth = prefix.size + 1
+
+        source << SUBCOMMAND_FUNCTION_TEMPLATE.result(binding)
+        subcommand[:subcommands].each do |subcommand|
+          source << render_subcommand_function(subcommand, prefix: prefix)
+        end
+        source.join("\n").strip + "\n"
+      end
+
+      def subcommand_metadata(thor)
+        thor.tasks.map do |(name, command)|
+          if subcommand_class = thor.subcommand_classes[name]
+            subcommands = subcommand_metadata(subcommand_class)
+          else
+            subcommands = []
+          end
+          { name: command.name.gsub("_", "-"),
+            usage: command.usage,
+            description: command.description,
+            options: thor.class_options.map{|_, o| option_metadata(o) } +
+                     command.options.map{|(_, o)| option_metadata(o) },
+            subcommands: subcommands
+          }
+        end
+      end
+
+      def option_metadata(option)
+        { names: ["--#{option.name}"] + option.aliases.map{|a| "-#{a}" },
+          description: option.description,
+        }
+      end
+    end
+  end
+end

data/lib/thor/zsh_completion/template/main.erb

@@ -0,0 +1,11 @@
+#compdef <%= name %>
+
+local state
+
+_<%= name %>() {
+  __<%= name %>
+}
+
+<%= render_subcommand_function(main) %>
+
+compdef _<%= name %> <%= name %>

data/lib/thor/zsh_completion/template/subcommand_function.erb

@@ -0,0 +1,55 @@
+<%- if subcommand[:subcommands].any? %>
+<%= function_name %>() {
+  readonly local DEPTH=<%= depth %>
+
+  case $CURRENT in
+    $DEPTH)
+      _arguments \
+        <%- subcommand[:options].each do |option| -%>
+        {<%= option[:names].join(",") %>}<%= option[:description].gsub(/'/, "''") if option[:description] %> \
+        <%- end -%>
+        '*: :->subcommands'
+
+      case $state in
+        subcommands)
+          _values \
+            'subcommand' \
+            <%- subcommand[:subcommands].each do |subcommand| -%>
+            '<%= subcommand[:name] %>[<%= subcommand[:description].gsub(/'/, "''") %>]' \
+            <%- end -%>
+            ;
+          ;;
+      esac
+      ;;
+    *)
+      case $words[$DEPTH] in
+        <%- subcommand[:subcommands].each do |subcommand| -%>
+        <%= subcommand[:name] %>)
+          <%= function_name %>_<%= subcommand[:name] %>
+          ;;
+        <%- end -%>
+        *)
+          # if does not match any subcommand
+          # complete rest arguments
+          _files
+          ;;
+      esac
+      ;;
+  esac
+}
+<%- else %>
+<%= function_name %>() {
+  _arguments \
+    <%- subcommand[:options].each do |option| -%>
+    {<%= option[:names].join(",") %>}<%= option[:description].gsub(/'/, "''") if option[:description] %> \
+    <%- end -%>
+    '*: :->rest'
+
+  case $state in
+    rest)
+      # complete rest arguments
+      _files
+      ;;
+  esac
+}
+<%- end %>

data/lib/thor/zsh_completion/version.rb

@@ -0,0 +1,5 @@
+class Thor
+  module ZshCompletion
+    VERSION = "0.1.0"
+  end
+end

data/lib/thor/zsh_completion.rb

@@ -0,0 +1,11 @@
+require "thor"
+require "thor/zsh_completion/version"
+require "erb"
+
+class Thor
+  module ZshCompletion
+  end
+end
+
+require "thor/zsh_completion/command"
+require "thor/zsh_completion/generator"

data/thor-zsh_completion.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thor/zsh_completion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thor-zsh_completion"
+  spec.version       = Thor::ZshCompletion::VERSION
+  spec.authors       = ["labocho"]
+  spec.email         = ["labocho@penguinlab.jp"]
+
+  spec.summary       = %q{Create zsh completion script for Thor subclass}
+  spec.description   = %q{Create zsh completion script for Thor subclass}
+  spec.homepage      = "https://github.com/labocho/thor-zsh_completion"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: thor-zsh_completion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- labocho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  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'
+description: Create zsh completion script for Thor subclass
+email:
+- labocho@penguinlab.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thor/zsh_completion.rb
+- lib/thor/zsh_completion/command.rb
+- lib/thor/zsh_completion/generator.rb
+- lib/thor/zsh_completion/template/main.erb
+- lib/thor/zsh_completion/template/subcommand_function.erb
+- lib/thor/zsh_completion/version.rb
+- thor-zsh_completion.gemspec
+homepage: https://github.com/labocho/thor-zsh_completion
+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.1
+signing_key: 
+specification_version: 4
+summary: Create zsh completion script for Thor subclass
+test_files: []