yap-shell-addon-prompt-refresh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a452ea20f5c284b4aec365ac271a217f497a50c1
+  data.tar.gz: 404db831ef2fdaa0038d250733df1f8b6685d5c9
+SHA512:
+  metadata.gz: 7717ac8ba43b2c472dacd1d0cf8a137b5678edd38affd541a9a537b4625ad702ab955f8ee1af92195366597b0d5c9fbba989936723cb326ee8c49e648599302c
+  data.tar.gz: a663ba362f7505f7bc4c0f021b5dee530f0c19b2850a611a7ed2cb17960c2575b2bc40814745975ee2323d81b6e73027001a5d463820b35044af1a8d162de6c2

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+wiki/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yap-shell-addon-prompt-refresh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zach Dennis
+
+
+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,61 @@
+# prompt-refresh for yap-shell
+
+prompt-refresh is a yap-shell addon that automatically refreshes your prompt.
+
+By default, it will refresh it every 100 milliseconds, but this is configurable thru your `yaprc` file.
+
+![Prompt live refreshes across shell instances](/yap-shell-addon-prompt-refresh.gif?raw=true)
+
+## Installation
+
+Within the yap-shell you can install it as an addon via:
+
+    $ yap addon install prompt-refresh
+
+And then execute:
+
+    $ reload!
+
+Or install it yourself as:
+
+    $ gem install yap-shell-addon-prompt-refresh
+
+## Usage
+
+If you have customized your yap-shell prompt to be a lambda/proc then it is possible to have yap automatically refresh it.
+
+For example, say you put your current git branch into your prompt and you wanted every shell session you had open to always have the up-to-date branch displayed (without you having to do a thing).
+
+You might have your prompt configured like this in your `~/.yap/yaprc` file:
+
+    world.prompt = -> do
+      # use ~ instead of full-path to home directory
+      pwd = Dir.pwd.sub Regexp.new(ENV['HOME']), '~'
+
+      # identify our current branch
+      git_current_branch = `git branch 2>/dev/null | sed -n '/\* /s///p'`.chomp
+
+      # is the current directory a part of a git enabled directory structure?
+      is_git_aware = git_current_branch.length > 0
+
+      git_branch = is_git_aware ? cyan(git_current_branch) : ''
+
+      # E.g. ~/source/my-project master $
+      "#{yellow(pwd)} #{git_branch} $ "
+    end
+
+After install this add-on your prompt will automatically refresh with the latest prompt every 100 milliseconds.
+
+To change this you can configure this through your addon:
+
+  world.addons[:'prompt-refresh'].refresh_interval_in_ms = 150
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zdennis/yap-shell-addon-prompt-refresh.
+
+
+## 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 "yap/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/yap-shell-addon-prompt-refresh.rb

@@ -0,0 +1,56 @@
+require 'yap/addon'
+require 'yap-shell-addon-prompt-refresh/version'
+
+module YapShellAddonPromptRefresh
+  class Addon < ::Yap::Addon::Base
+    self.export_as :'prompt-refresh'
+
+    DEFAULT_REFRESH_INTERVAL_IN_MS = 100
+    EVENT_NAME = 'addon:prompt-refresh'
+
+    attr_accessor :refresh_interval_in_ms
+
+    def initialize_world(world)
+      @world = world
+      self.refresh_interval_in_ms = DEFAULT_REFRESH_INTERVAL_IN_MS
+
+      @last_fired_at = nil
+      @world.subscribe EVENT_NAME do
+        fired_at = Time.now
+
+        message = "refreshing prompt"
+        message << " #{fired_at - @last_fired_at} seconds since last fired" if @last_fired_at
+        @last_fired_at = fired_at
+
+        logger.puts message
+        world.refresh_prompt
+      end
+    end
+
+    def refresh_interval_in_ms=(milliseconds)
+      logger.puts "setting refresh interval to #{milliseconds.inspect} ms"
+      clear_recurring_event
+      if milliseconds
+        @refresh_interval_in_ms = milliseconds
+        initialize_recurring_event
+      end
+    end
+
+    private
+
+    def clear_recurring_event
+      if @event_id
+        logger.puts "clearing previous refresh prompt event id=#{@event_id.inspect}"
+        @world.events.clear @event_id
+        @event_id = nil
+      end
+    end
+
+    def initialize_recurring_event
+      logger.puts "initializing recurring event for event #{EVENT_NAME.inspect}"
+      @event_id = @world.events.recur \
+        name: EVENT_NAME,
+        interval_in_ms: refresh_interval_in_ms
+    end
+  end
+end

data/lib/yap-shell-addon-prompt-refresh/version.rb

@@ -0,0 +1,3 @@
+module YapShellAddonPromptRefresh
+  VERSION = '0.1.0'
+end

data/yap-shell-addon-prompt-refresh.gemspec

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/lib/yap-shell-addon-prompt-refresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'yap-shell-addon-prompt-refresh'
+  spec.version = YapShellAddonPromptRefresh::VERSION
+  spec.authors  = ['Your name']
+  spec.email    = 'you@example.com'
+  spec.date    = Date.today.to_s
+
+  spec.summary = 'prompt-refresh summary goes here.'
+  spec.description = 'prompt-refresh description goes here.'
+  spec.homepage = ''
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test\/|spec\/|features\/|.*\.gif$)/)
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yap-shell", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: yap-shell-addon-prompt-refresh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your name
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yap-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: prompt-refresh description goes here.
+email: you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yap-shell-addon-prompt-refresh.rb
+- lib/yap-shell-addon-prompt-refresh/version.rb
+- yap-shell-addon-prompt-refresh.gemspec
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: prompt-refresh summary goes here.
+test_files: []
+has_rdoc: