yap-shell-addon-history 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f225f7f8a96a37e251e59d3a04ef272580eef13d
+  data.tar.gz: f3ceb4f3e76d016278f6b35d413c353dc836023a
+SHA512:
+  metadata.gz: 36ecd7187c1509a8e2fc78f359649392dcb839904d211e04099d546edd47eaa0f6ca1b0df9812f9f53322bbc58aebee7823468f2898386fca5355f30d6be1259
+  data.tar.gz: b4dcca6eaffde1a322a2fae81826c793aca79b0ea03a5386a260672f85c72b0f526cdde84825a96f093e992285d4c44924ad0c28dff8b1e2ce3e9a46e8874dc0

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/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yap-shell-addon-history.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,51 @@
+# History for yap-shell
+
+The History addon is provides primitive history capabilities:
+
+* Loads history from ~/.yap/history when yap is loaded
+* Saves history to ~/.yap/history when yap exits
+* Saving is an append-only operation
+* ~/.yap/history is in YAML format
+
+## Shell Functions
+
+The history addon provides the `history` shell function that prints the contents of the history.
+
+## Limitations
+
+The history addon currently does not support any kind of advanced history operations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yap-shell-addon-history'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yap-shell-addon-history
+
+## 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]/yap-shell-addon-history.
+
+
+## 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-history.rb

@@ -0,0 +1,89 @@
+require 'yap/addon'
+require 'yap-shell-addon-history/version'
+
+module YapShellAddonHistory
+  class Addon < ::Yap::Addon::Base
+    self.export_as :history
+
+    attr_reader :file
+    attr_reader :position
+
+    def initialize_world(world)
+      return unless world.configuration.use_history?
+      @world = world
+
+      @file = world.configuration.path_for('history')
+      @position = 0
+
+      load_history
+
+      world.func(:history) do |args:, stdin:, stdout:, stderr:|
+        history_length = @world.editor.history.length
+        first_arg = args.first.to_i
+        size = first_arg > 0 ? first_arg + 1 : history_length
+
+        # start from -2 since we don't want to include the current history
+        # command being run.
+        stdout.puts @world.editor.history[history_length-size..-2]
+      end
+    end
+
+    def back
+      logger.puts "entered"
+      current_position = @world.editor.line.text_up_to_position
+      found_text = @world.history.find_match_backward(@world.editor.line.text_up_to_position)
+      if found_text
+        logger.puts "match found: #{found_text.inspect}"
+        @world.editor.overwrite_line found_text, position: :preserve
+      else
+        logger.puts "no match found"
+      end
+    end
+
+    def forward
+      logger.puts "entered"
+      current_position = @world.editor.line.text_up_to_position
+      found_text = @world.history.find_match_forward(@world.editor.line.text_up_to_position)
+      if found_text
+        logger.puts "match found: #{found_text.inspect}"
+        @world.editor.overwrite_line found_text, position: :preserve
+      else
+        logger.puts "no match found"
+      end
+    end
+
+    def save
+      logger.puts "saving history file=#{file.inspect}"
+      File.open(file, "a") do |file|
+        # Don't write the YAML header because we're going to append to the
+        # history file, not overwrite. YAML works fine without it.
+        unwritten_history = @world.editor.history.to_a[@position..-1]
+        if unwritten_history.any?
+          contents = unwritten_history
+            .each_with_object([]) { |line, arr| arr << line unless line == arr.last  }
+            .map { |str| str.respond_to?(:without_ansi) ? str.without_ansi : str }
+            .to_yaml
+            .gsub(/^---.*?^/m, '')
+          file.write contents
+        end
+      end
+    end
+
+    private
+
+    def load_history
+      logger.puts "loading history file=#{file.inspect}"
+      at_exit { save }
+
+      if File.exists?(file) && File.readable?(file)
+        history = YAML.load_file(file) || []
+
+        # History starts at the end of the history loaded from file.
+        @position = history.length
+
+        # Rely on the builtin history for now.
+        @world.editor.history.replace(history)
+      end
+    end
+  end
+end

data/lib/yap-shell-addon-history/version.rb

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

data/yap-shell-addon-history.gemspec

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/lib/yap-shell-addon-history/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'yap-shell-addon-history'
+  spec.version = YapShellAddonHistory::VERSION
+  spec.authors  = ['Your name']
+  spec.email    = 'you@example.com'
+  spec.date    = Date.today.to_s
+
+  spec.summary = 'history summary goes here.'
+  spec.description = 'history description goes here.'
+  spec.homepage = ''
+  spec.license = 'MIT'
+
+  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", "~> 0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: yap-shell-addon-history
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Your name
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 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.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: history description goes here.
+email: you@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yap-shell-addon-history.rb
+- lib/yap-shell-addon-history/version.rb
+- yap-shell-addon-history.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: history summary goes here.
+test_files: []
+has_rdoc: