rurses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eb3e03695e4454190b4a2d7803dae2adbb61e35
+  data.tar.gz: 80cdf3890c1ea5611f81112c1fc34f3378308a65
+SHA512:
+  metadata.gz: 89635579ca42b61cb372a41db098f387eb1cf8f90fcc4e8935a59cae181289ac2c173e048eb1d16a42ca2d7763a0c758167c7230f8d8a867b07cb23fa8a65323
+  data.tar.gz: 8b9c05b5bfc8ca8cbea1d07db552f4c7e1e52b84eac9e213ba0b27daea64e3a4f910bbc6ea8157410f878235d1eb1b25b3d3da7f7b8b26a8fe57dc8b033c8f8d

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,3 @@
+language: ruby
+rvm:
+  - 2.1.5

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, 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 rurses.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 James Edward Gray II
+
+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 @@
+# Rurses
+
+Rurses (pronounced like [Scooby-Doo](http://en.wikipedia.org/wiki/Scooby-Doo_%28character%29) saying "Curses") is meant to be a more Ruby-like interface to ncurses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rurses'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rurses
+
+## Usage
+
+```ruby
+Rurses.program(modes: %i[c_break no_echo keypad]) do |screen|
+  screen.draw_string("Enter a key:  ")
+
+  key = Rurses.get_key
+
+  screen.move_cursor(x: 0, y: 1)
+  screen.style(:bold) do
+    screen.draw_string("You typed %p." % key)
+  end
+
+  screen.refresh_in_memory
+  Rurses.update_screen
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rurses/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rurses"
+
+# 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/rurses.rb

@@ -0,0 +1,50 @@
+require "ffi-ncurses"
+
+require_relative "rurses/version"
+require_relative "rurses/panel_stack"
+require_relative "rurses/window"
+
+module Rurses
+  SPECIAL_KEYS = Hash[
+    FFI::NCurses::KeyDefs
+      .constants
+      .select { |name| name.to_s.start_with?("KEY_") }
+      .map    { |name|
+        [ FFI::NCurses::KeyDefs.const_get(name),
+          name.to_s.sub(/\AKEY_/, "").to_sym ]
+      }
+  ]
+
+  module_function
+
+  def curses
+    FFI::NCurses
+  end
+
+  def program(modes: [ ])
+    @stdscr = Window.new(curses_ref: curses.initscr, standard_screen: true)
+    @stdscr.change_modes(modes)
+    yield(@stdscr)
+  ensure
+    curses.endwin
+  end
+
+  def stdscr
+    @stdscr
+  end
+
+  def get_key
+    case (char = curses.getch)
+    when curses::KeyDefs::KEY_CODE_YES..curses::KeyDefs::KEY_MAX
+      SPECIAL_KEYS[char]
+    when curses::ERR
+      nil
+    else
+      char.chr
+    end
+  end
+
+  def update_screen
+    curses.doupdate
+  end
+end

data/lib/rurses/panel_stack.rb

@@ -0,0 +1,35 @@
+module Rurses
+  class PanelStack
+    def initialize
+      @window_to_panel_map = { }
+    end
+
+    attr_reader :window_to_panel_map
+    private     :window_to_panel_map
+
+    def add(window, add_subwindows: true)
+      window_to_panel_map[window] = Rurses.curses.new_panel(window.curses_ref)
+      if add_subwindows
+        window.subwindows.each_value do |subwindow|
+          add(subwindow, add_subwindows: add_subwindows)
+        end
+      end
+    end
+    alias_method :<<, :add
+
+    def remove(window, remove_subwindows: true)
+      if remove_subwindows
+        window.subwindows.each_value do |subwindow|
+          remove(subwindow, remove_subwindows: remove_subwindows)
+        end
+      end
+      window.clear
+      Rurses.curses.del_panel(window_to_panel_map[window])
+      Rurses.curses.delwin(window.curses_ref)
+    end
+
+    def refresh_in_memory
+      Rurses.curses.update_panels
+    end
+  end
+end

data/lib/rurses/version.rb

@@ -0,0 +1,3 @@
+module Rurses
+  VERSION = "0.1.0"
+end

data/lib/rurses/window.rb

@@ -0,0 +1,148 @@
+module Rurses
+  class Window
+    MODE_NAMES = {
+      c_break:      :cbreak,
+      no_echo:      :noecho,
+      keypad:       [:keypad, :window, true],
+      hide_cursor:  [:curs_set, 0],
+      non_blocking: [:timeout, 0]
+    }
+    ATTRIBUTES = Hash.new { |all, name|
+      all[name] = Rurses.curses.const_get("A_#{name.upcase}")
+    }
+
+    def initialize(**details)
+      @curses_ref      = details.fetch(:curses_ref) {
+        Rurses.curses.newwin(
+          details.fetch(:lines),
+          details.fetch(:columns),
+          details.fetch(:y),
+          details.fetch(:x)
+        )
+      }
+      @standard_screen = details.fetch(:standard_screen) { false }
+      @subwindows      = { }
+    end
+
+    attr_reader :curses_ref, :subwindows
+
+    def standard_screen?
+      @standard_screen
+    end
+
+    def cursor_x
+      Rurses.curses.getcurx(curses_ref)
+    end
+
+    def cursor_y
+      Rurses.curses.getcury(curses_ref)
+    end
+
+    def cursor_xy
+      y, x = Rurses.curses.getyx(curses_ref)
+      {x: x, y: y}
+    end
+
+    def columns
+      Rurses.curses.getmaxx(curses_ref)
+    end
+
+    def lines
+      Rurses.curses.getmaxy(curses_ref)
+    end
+
+    def size
+      {columns: columns, lines: lines}
+    end
+
+    def resize(lines: , columns: )
+      Rurses.curses.resizeterm(lines, columns) if standard_screen?
+      Rurses.curses.wresize(curses_ref, lines, columns)
+    end
+
+    def change_modes(modes)
+      modes.each do |name|
+        mode = Array(MODE_NAMES[name] || name)
+        Rurses.curses.send(*mode.map { |arg| arg == :window ? curses_ref : arg })
+      end
+    end
+
+    def draw_border( left:     0, right:     0, top:         0, bottom:       0,
+                     top_left: 0, top_right: 0, bottom_left: 0, bottom_right: 0 )
+      args = [
+        left,     right,     top,         bottom,
+        top_left, top_right, bottom_left, bottom_right
+      ].map { |c| c.is_a?(String) ? c.encode("UTF-8").codepoints.first : c }
+      if args.any? { |c| c >= 128 }
+        Rurses.curses.wborder_set(
+          curses_ref,
+          *args.map { |c|
+            char            = Rurses.curses::WinStruct::CCharT.new
+            char[:chars][0] = c
+          }
+        )
+      else
+        Rurses.curses.wborder(curses_ref, *args)
+      end
+    end
+
+    def move_cursor(x: , y: )
+      Rurses.curses.wmove(curses_ref, y, x)
+    end
+
+    def draw_string(content)
+      Rurses.curses.waddstr(curses_ref, content)
+    end
+
+    def draw_string_on_a_line(content)
+      old_y = cursor_y
+      draw_string(content)
+      new_y = cursor_y
+      move_cursor(x: 0, y: new_y + 1) if new_y == old_y
+    end
+
+    def skip_line
+      move_cursor(x: 0, y: cursor_y + 1)
+    end
+
+    def style(*attributes)
+      attributes.each do |attribute|
+        Rurses.curses.wattron(curses_ref, ATTRIBUTES[attribute])
+      end
+      yield
+    ensure
+      attributes.each do |attribute|
+        Rurses.curses.wattroff(curses_ref, ATTRIBUTES[attribute])
+      end
+    end
+
+    def clear(reset_cursor: true)
+      Rurses.curses.wclear(curses_ref)
+      move_cursor(x: 0, y: 0) if reset_cursor
+    end
+
+    def refresh_in_memory
+      Rurses.curses.wnoutrefresh(curses_ref)
+    end
+
+    def create_subwindow( name: , top_padding:   0, left_padding:   0,
+                                  right_padding: 0, bottom_padding: 0 )
+      s                = size
+      xy               = cursor_xy
+      subwindows[name] =
+        self.class.new(
+          curses_ref: Rurses.curses.derwin(
+            curses_ref,
+            s[:lines]   - (top_padding  + bottom_padding),
+            s[:columns] - (left_padding + right_padding),
+            xy[:y]      + top_padding,
+            xy[:x]      + left_padding
+          )
+        )
+    end
+
+    def subwindow(name)
+      subwindows[name]
+    end
+  end
+end

data/rurses.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rurses/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rurses"
+  spec.version       = Rurses::VERSION
+  spec.authors       = ["James Edward Gray II"]
+  spec.email         = ["james@graysoftinc.com"]
+
+  spec.summary       = %q{A more Ruby style wrapper over ncurses.}
+  spec.description   = %q{This library aims to make working with ncurses code feel more natural to Rubyists.  Full Ruby objects wrap C pointers, blocks are used where they make sense, and the library has some intelligent default behavior built in.}
+  spec.homepage      = "https://github.com/JEG2/rurses"
+
+  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_dependency "ffi-ncurses", "~> 0.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake",    "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rurses
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Edward Gray II
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi-ncurses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: This library aims to make working with ncurses code feel more natural
+  to Rubyists.  Full Ruby objects wrap C pointers, blocks are used where they make
+  sense, and the library has some intelligent default behavior built in.
+email:
+- james@graysoftinc.com
+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/rurses.rb
+- lib/rurses/panel_stack.rb
+- lib/rurses/version.rb
+- lib/rurses/window.rb
+- rurses.gemspec
+homepage: https://github.com/JEG2/rurses
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A more Ruby style wrapper over ncurses.
+test_files: []