yap-shell 0.6.0 → 0.7.0

data/lib/yap/cli/commands/generate/addonrb.template

@@ -0,0 +1,22 @@
+require 'yap/addon'
+require '%{addon_dir}/version'
+
+module %{constant_name}
+  class Addon < ::Yap::Addon::Base
+    self.export_as :%{export_as}
+
+    def initialize_world(world)
+      @world = world
+
+      # Initialize your addon here. A few helpful things:
+      #
+      # @world is an Yap::World instance and it brings together
+      #   all the things you may want to interact with. E.g.
+      #   aliases, builtins, env, shell_commands, key bindings,
+      #   editor, prompt, etc.
+      #
+      # For more information see:
+      #    https://github.com/zdennis/yap-shell/wiki/Addons
+    end
+  end
+end

data/lib/yap/cli/commands/generate/gemspec.template

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/lib/%{addon_dir}/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = '%{addon_dir}'
+  spec.version = %{constant_name}::VERSION
+  spec.authors  = ['Your name']
+  spec.email    = '%{email}'
+  spec.date    = Date.today.to_s
+
+  spec.summary = '%{summary}'
+  spec.description = '%{description}'
+  spec.homepage = '%{homepage}'
+  spec.license = '%{license}'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yap-shell", "~> %{yap_version}"
+
+  spec.add_development_dependency "bundler", "~> %{bundler_version}"
+  spec.add_development_dependency "rake", "~> %{rake_version}"
+  spec.add_development_dependency "rspec", "~> %{rspec_version}"
+end

data/lib/yap/cli/commands/generate/license.template

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 %{username}
+
+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/lib/yap/cli/commands/generate/rakefile.template

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

data/lib/yap/cli/commands/generate/readme.template

@@ -0,0 +1,40 @@
+# %{addon_name} for yap-shell
+
+Welcome to your new yap addon! In this directory, you'll find the files you need to be able to package up your addon into a gem. Put your Ruby code in the file `%{lib_addon_path}`.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '%{gem_safe_addon_name}'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install %{gem_safe_addon_name}
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/%{gem_safe_addon_name}.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/yap/cli/options.rb

@@ -0,0 +1,162 @@
+require 'pathname'
+require 'yap/cli/options'
+
+module Yap
+  module Cli
+    module OptionsLoader
+
+      def load_command(path)
+        load_constant_from_path Pathname.new('yap/cli/commands').join(path)
+      end
+
+      def load_constant_from_path(path)
+        requiring_parts = []
+        path_parts = path.to_s.split('/')
+        requiring_path = nil
+        constant = path_parts.reduce(Object) do |constant, path_part|
+          requiring_parts << path_part
+          file2load = Yap.root.join('lib', requiring_parts.join('/') + "*.rb")
+          requiring_path = Dir[ file2load ].sort.first
+          if requiring_path
+            require requiring_path
+            path_part = File.basename(requiring_path).sub(/\.rb$/, '')
+            requiring_parts.pop
+            requiring_parts.push path_part
+            constant_name = path_part.capitalize
+            if constant.const_defined?(constant_name)
+              constant = constant.const_get(constant_name)
+            else
+              fail "Couldn't find #{path_part} in #{constant}"
+            end
+          else
+            fail LoadError, "Couldn't load any file for #{file2load}"
+          end
+        end
+        Treefell['shell'].puts "#{inspect} loaded: #{constant}"
+        constant
+      end
+
+      def load_relative_constant(path_str)
+        base_path = self.class.name.downcase.gsub(/::/, '/')
+        require_path = Pathname.new(base_path)
+        load_constant_from_path require_path.join(path_str).to_s
+      end
+    end
+
+    class Options
+      include OptionsLoader
+
+      attr_reader :options
+
+      def initialize(options: {})
+        @options = options
+        @commands = []
+      end
+
+      def [](key)
+        @options[key]
+      end
+
+      def commands
+        @commands.dup.freeze
+      end
+
+      def parse(args)
+        option_parser.order!(args)
+        options_instance = self
+
+        Yap.configuration.run_shell = false if args.any?
+
+        scope = []
+        require_path = Pathname.new("yap/cli/options")
+        args_processed = []
+
+        while args.any?
+          if args_processed == args
+            puts "Unknown option(s*): #{scope.concat([args.first]).join(' ')}"
+            exit 1
+          end
+          args_processed = args.dup
+
+          option_str = args.shift
+          current_scope = scope + [option_str]
+
+
+          begin
+            options_class = load_relative_constant current_scope.join('/')
+            options_instance = options_class.new(options: options)
+            options[:option] = options_instance
+            options_instance.parse(args)
+            @commands << options_instance.command
+
+            scope << option_str
+          rescue LoadError => ex
+            puts "Unknown option: #{option_str}"
+            puts
+            puts options_instance.help_message
+            exit 1
+          end
+        end
+      end
+
+      def help_message
+        option_parse.to_s
+      end
+
+      private
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = <<-TEXT.gsub(/^\s*\|/, '')
+            |Usage: #{opts.program_name} [option|command]
+            |
+            |When a command is omitted the yap shell starts an interactive
+            |session. Otherwise, the command is executed.
+            |
+            |Shell options:
+          TEXT
+          opts.on('-h', '--help', 'Prints this help') do
+            puts opts
+            commands = Dir[ File.dirname(__FILE__) + '/commands/*.rb' ].map do |path|
+              command = File.basename(path).sub(/\.rb$/, '')
+              "#{command}: #{Term::ANSIColor.cyan(opts.program_name + ' ' + command + ' --help')}"
+            end
+            commands = %|  #{commands.join("\n  ")}|
+            puts <<-TEXT.gsub(/^\s*\|/, '')
+              |
+              |Commands:
+              |
+              |#{commands}
+              |
+            TEXT
+            exit 0
+          end
+
+          opts.on('--skip-first-time', 'Disables creating ~/.yap directory on shell startup') do
+            Yap.configuration.skip_first_time = true
+          end
+
+          opts.on('--addon-paths=PATHS', 'Paths to directories containing addons (comma-separated). This overwrites the default addon paths.') do |paths|
+            Yap.configuration.addon_paths = paths.split(',').map(&:strip)
+          end
+
+          opts.on('--no-addons', 'Disables auto-loading addons on shell startup') do
+            Yap.configuration.use_addons = false
+          end
+
+          opts.on('--no-history', 'Disables auto-loading or saving history') do
+            Yap.configuration.use_history = false
+          end
+
+          opts.on('--rcfiles=PATHS', 'Paths to Yap rcfiles in the order they should load (comma-separated). This overwrites the default rcfiles.') do |paths|
+            Yap.configuration.rcfiles = paths.split(',').map(&:strip)
+          end
+
+          opts.on('--no-rcfiles', 'Disables auto-loading rcfiles on shell startup') do
+            Yap.configuration.use_rcfiles = false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yap/cli/options/addon.rb

@@ -0,0 +1,64 @@
+module Yap
+  module Cli
+    class Options::Addon
+      include OptionsLoader
+
+      attr_reader :command, :options
+
+      def initialize(options:)
+        @options = options
+      end
+
+      def parse(args)
+        option_parser.order!(args)
+      end
+
+      def command
+        @command
+      end
+
+      def help_message
+        option_parser.to_s
+      end
+
+      private
+
+      def set_command(command)
+        @command = load_command('addon').new
+      end
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = <<-TEXT.gsub(/^\s*\|/, '')
+            |Usage: #{opts.program_name} addon [command] [addon-name] [options]
+            |
+            |#{Term::ANSIColor.cyan('yap addon')} can be used to control yap addons
+            |
+            |Generate commands:
+            |
+            |  #{Term::ANSIColor.yellow('enable')} - enables a yap addon
+            |  #{Term::ANSIColor.yellow('disable')} - disables a yap addon
+            |
+            |Generate options:
+          TEXT
+
+          opts.on('-h', '--help', 'Prints this help') do
+            puts opts
+            puts
+            puts  <<-TEXT.gsub(/^\s*\|/, '')
+              |Example: disabling an addon
+              |
+              |   #{opts.program_name} addon disable foo-bar
+              |
+              |Example: enabling an addon
+              |
+              |   #{opts.program_name} addon enable foo-bar
+              |
+            TEXT
+            exit 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yap/cli/options/addon/disable.rb

@@ -0,0 +1,62 @@
+module Yap
+  module Cli
+    class Options::Addon::Disable
+      include OptionsLoader
+
+      attr_reader :command, :options
+
+      def initialize(options:)
+        @options = options
+      end
+
+      def parse(args)
+        @addon_name = args.shift unless args.first =~ /^-/
+        unless @addon_name
+          args.unshift '--help'
+          STDERR.puts "Missing addon-name!"
+          @exit_status = 1
+          puts
+        end
+        option_parser.order!(args)
+      end
+
+      def command
+        @command ||= load_command('addon/disable').new(@addon_name)
+      end
+
+      def help_message
+        option_parser.to_s
+      end
+
+      private
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = <<-TEXT.gsub(/^\s*\|/, '')
+            |Usage: #{opts.program_name} addon disable [addon-name] [options]
+            |
+            |#{Term::ANSIColor.cyan('yap addon disable')} can be used to disable yap addons.
+            |
+            |Addon disable options:
+          TEXT
+
+          opts.on('-h', '--help', 'Prints this help') do
+            puts opts
+            puts
+            puts  <<-TEXT.gsub(/^\s*\|/, '')
+              |Example: Disable an addon
+              |
+              |   #{opts.program_name} addon disable magical-key-bindings
+              |
+              |Example: Enable an addon
+              |
+              |   #{opts.program_name} addon disable magical-key-bindings
+              |
+            TEXT
+            exit @exit_status
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yap/cli/options/addon/enable.rb

@@ -0,0 +1,63 @@
+module Yap
+  module Cli
+    class Options::Addon::Enable
+      include OptionsLoader
+
+      attr_reader :command, :options
+
+      def initialize(options:)
+        @options = options
+        @exit_status = 0
+      end
+
+      def parse(args)
+        @addon_name = args.shift unless args.first =~ /^-/
+        unless @addon_name
+          args.unshift '--help'
+          STDERR.puts "Missing addon-name!"
+          @exit_status = 1
+          puts
+        end
+        option_parser.order!(args)
+      end
+
+      def command
+        @command ||= load_command('addon/enable').new(@addon_name)
+      end
+
+      def help_message
+        option_parser.to_s
+      end
+
+      private
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = <<-TEXT.gsub(/^\s*\|/, '')
+            |Usage: #{opts.program_name} addon enable [addon-name] [options]
+            |
+            |#{Term::ANSIColor.cyan('yap addon enable')} can be used to enable yap addons.
+            |
+            |Addon enable options:
+          TEXT
+
+          opts.on('-h', '--help', 'Prints this help') do
+            puts opts
+            puts
+            puts  <<-TEXT.gsub(/^\s*\|/, '')
+              |Example: Disable an addon
+              |
+              |   #{opts.program_name} addon disable magical-key-bindings
+              |
+              |Example: Enable an addon
+              |
+              |   #{opts.program_name} addon enable magical-key-bindings
+              |
+            TEXT
+            exit @exit_status
+          end
+        end
+      end
+    end
+  end
+end