tty-cursor 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57fcf44408793c8b1b7b804e6dea8618b2dbc21e4fbe562c2d4b54e065dc8274
-  data.tar.gz: e7f8709d0d35f8f235357e000c4b90f4d783fc7b7bdf9dff5131939281319cbd
+  metadata.gz: c6621ad96826f2ad35be6c0f8dc2c68871109db0a550958a50849c657bef1c9f
+  data.tar.gz: 3d1808171b01aed1c46a14fdc0c75ed17aaf6781dcd96ece09b9e41af603d298
 SHA512:
-  metadata.gz: 9a2894c83345b6392d66fe9addefebfe1e8e982106ddd683ddfc24ac7f4e5de4e76a7e98a50d74a9118378c477155ed52961aeb9f0ed93244338be25190c4e10
-  data.tar.gz: 614ce96b7fd55b37d85e3bd957fe3adef839f71751414c686c4aeae8edcb904ad7e5b43a0cc5890fbc5dd815a9fe619e476bf22b99f9e3d87dbafa16b696ef08
+  metadata.gz: f9a294dbee365a732d9b60cc80d1d3e200ba33ec85b7c8bc6344e9b03e83483a7d8121b0bc29fc6d6c741d5c992db249b0bedffa23322917e8aca7db4973518a
+  data.tar.gz: 571d07e6127a46ea902f2f22e48b0e6084cf1a80d7dbd48837fbadf72d257864e9edf4222b47d3d5621c6dd5f5fa8d0ceedd77426e569ec8c7ab3c4cb2759684

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## [v0.7.0] - 2019-05-27
+
+### Added
+* Add #scroll_up & #scroll_down display by one line
+
+### Changed
+* Change to restrict gem to Ruby >= 2.0
+
 ## [v0.6.1] - 2019-02-28
 
 ### Changed
@@ -51,6 +59,7 @@
 
 * Initial implementation and release
 
+[v0.7.0]: https://github.com/piotrmurach/tty-cursor/compare/v0.6.1...v0.7.0
 [v0.6.1]: https://github.com/piotrmurach/tty-cursor/compare/v0.6.0...v0.6.1
 [v0.6.0]: https://github.com/piotrmurach/tty-cursor/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/piotrmurach/tty-cursor/compare/v0.4.0...v0.5.0

data/README.md

@@ -63,7 +63,7 @@ Or install it yourself as:
     * [2.2.1 show](#221-show)
     * [2.2.2 hide](#222-hide)
     * [2.2.3 invisible(stream)](#223-invisiblestream)
-  * [2.3 Text Modification](#23-text-modification)
+  * [2.3 Text Clearing](#23-text-clearing)
     * [2.3.1 clear_char(n)](#231-clear_charn)
     * [2.3.2 clear_line](#232-clear_line)
     * [2.3.3 clear_line_before](#233-clear_line_before)
@@ -72,6 +72,9 @@ Or install it yourself as:
     * [2.3.6 clear_screen_down](#236-clear_screen_down)
     * [2.3.7 clear_screen_up](#237-clear_screen_up)
     * [2.3.8 clear_screen](#238-clear_screen)
+  * [2.4 Scrolling](#24-scrolling)
+    * [2.4.1 scroll_down](#241-scroll_down)
+    * [2.4.2 scroll_up](#242-scroll_up)
 
 ## 1. Usage
 
@@ -143,7 +146,7 @@ Cursor moves to `<n>`th position horizontally in the current line.
 
 #### 2.1.8 row(n)
 
-Cursor moves the the `<n>`th position vertically in the current column.
+Cursor moves to the `<n>`th position vertically in the current column.
 
 #### 2.1.9 next_line
 
@@ -191,13 +194,13 @@ By default standard output will be used but you can change that by passing a dif
 cursor.invisible($stderr) { .... }
 ```
 
-### 2.3 Text Modification
+### 2.3 Text Clearing
 
 All methods in this section provide APIs to modify text buffer contents.
 
 #### 2.3.1 clear_char(n)
 
-Erase `<n>` characters from the current cursor position by overwritting them with space character.
+Erase `<n>` characters from the current cursor position by overwriting them with space character.
 
 #### 2.3.2 clear_line
 
@@ -231,6 +234,17 @@ Erase the screen from the current line down to the bottom of the screen.
 
 Erase the screen from the current line up to the top of the screen.
 
+### 2.4 Scrolling
+
+#### 2.4.1 scroll_down
+
+Scroll display down one line.
+
+### 2.4.2 scroll_up
+
+Scroll display up one line.
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/piotrmurach/tty-cursor/fork )

data/lib/tty/cursor.rb

@@ -191,5 +191,17 @@ module TTY
     def clear_screen
       CSI + '2J'
     end
+
+    # Scroll display up one line
+    # @api public
+    def scroll_up
+      ESC + 'M'
+    end
+
+    # Scroll display down one line
+    # @api public
+    def scroll_down
+      ESC + 'D'
+    end
   end # Cursor
 end # TTY

data/lib/tty/cursor/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   module Cursor
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end # Cursor
 end # TTY

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-if RUBY_VERSION > '1.9' and (ENV['COVERAGE'] || ENV['TRAVIS'])
+if ENV['COVERAGE'] || ENV['TRAVIS']
   require 'simplecov'
   require 'coveralls'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
-  ]
+  ])
 
   SimpleCov.start do
     command_name 'spec'

data/spec/unit/scroll_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Cursor do
+  subject(:cursor) { described_class }
+
+  it "scrolls down by one line" do
+    expect(cursor.scroll_down).to eq("\eD")
+  end
+
+  it "scrolls up by one line" do
+    expect(cursor.scroll_up).to eq("\eM")
+  end
+end

data/tasks/console.rake

@@ -1,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-desc 'Load gem inside irb console'
+desc "Load gem inside irb console"
 task :console do
   require 'irb'
   require 'irb/completion'
-  require File.join(__FILE__, '../../lib/pastel')
+  require File.join(__FILE__, '../../lib/tty-cursor')
   ARGV.clear
   IRB.start
 end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 desc 'Measure code coverage'
 task :coverage do

data/tasks/spec.rake

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 begin
   require 'rspec/core/rake_task'

data/tty-cursor.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-cursor
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - spec/unit/cursor_spec.rb
 - spec/unit/move_spec.rb
 - spec/unit/move_to_spec.rb
+- spec/unit/scroll_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -88,15 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Terminal cursor positioning, visibility and text manipulation.
@@ -106,3 +106,4 @@ test_files:
 - spec/unit/cursor_spec.rb
 - spec/unit/move_spec.rb
 - spec/unit/move_to_spec.rb
+- spec/unit/scroll_spec.rb