term_canvas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5d343b9c662b9a2613d77e82f2cd905103e78416715e6c26044f5605169a847
+  data.tar.gz: 1feb22194cfa0a56d7ef10d6e01b270976cfba79e89711a52049e1b8460766d0
+SHA512:
+  metadata.gz: 052d7fac4a035d0257c196ed36b637dec5ff03e39dcde2dc60096a32b34cfe0bb82fa6fab79c14f036f5670b817ce0eb56d19997bd25f9ec00821f5fbaedbd27
+  data.tar.gz: 7821d72cfa812494e3a098f0ad14453cf3b610ea53dee76d74a6a4c254e300ef45fa74937f9fe898a65d4199048500c8cfc34d47cc7df02301d4e9569d025b0a

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/bundle
+
+log*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    term_canvas (0.1.0)
+      curses
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curses (1.2.7)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  term_canvas!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 kthatoto
+
+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,23 @@
+# TermCanvas
+Wrapper library for `curses` of ruby.
+You can handle colors easily.
+
+## Installation
+
+    $ gem install term_canvas
+
+## Usage
+
+## 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]/term_canvas.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "term_canvas"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/update

@@ -0,0 +1,2 @@
+#!/bin/bash
+gem specific_install -l 'kthatoto/term_canvas'

data/examples/curses.rb

@@ -0,0 +1,23 @@
+require 'curses'
+
+Curses.init_screen
+Curses::noecho
+Curses.curs_set(0)
+Curses.start_color
+Curses.use_default_colors
+
+win = Curses::Window.new(10, 10, 10, 10)
+
+color_struct = Struct.new(:id, :r, :g, :b)
+id = 1
+color = color_struct.new(id, 300, 900, 300)
+Curses.init_color(*color)
+Curses.init_pair(id, 0, id)
+pair = Curses.color_pair(id)
+win.attron(pair)
+win.addstr("123")
+win.attroff(pair)
+win.refresh
+sleep 3
+
+Curses.close_screen

data/examples/simplified_chart.rb

@@ -0,0 +1,34 @@
+require 'curses'
+Curses.init_screen
+Curses.stdscr.nodelay = 1
+Curses::noecho
+Curses.curs_set(0)
+Curses.start_color
+Curses.use_default_colors
+255.times do |i|
+  Curses.init_pair(i, 0, i)
+end
+win = Curses::Window.new(Curses.lines, Curses.cols, 0, 0)
+loop do
+  key = Curses.getch
+  case key
+  when ?q
+    break
+  end
+  l = 30
+  255.times do |i|
+    win.setpos(i / l, (i % l) * 3)
+    win.attron(Curses.color_pair(i))
+    win.addstr(format("%3d", i))
+    win.attroff(Curses.color_pair(i))
+  end
+  255.times do |i|
+    win.setpos(i / l + 10, (i % l) * 3)
+    win.attron(Curses.color_pair(i + 256))
+    win.addstr(format("%3d", i))
+    win.attroff(Curses.color_pair(i + 256))
+  end
+  win.refresh
+  sleep 0.5
+end
+Curses.close_screen

data/examples/test.rb

@@ -0,0 +1,36 @@
+require 'term_canvas'
+
+field = TermCanvas.new(x: 0, y: 0, w: 50, h: 30)
+
+text_pos = {y: 0, x: 0}
+loop do
+  key = TermCanvas.gets
+  case key
+  when ?k
+    text_pos[:y] -= 1
+  when ?j
+    text_pos[:y] += 1
+  when ?h
+    text_pos[:x] -= 2
+  when ?l
+    text_pos[:x] += 2
+  when ?q
+    break
+  end
+
+  field.clear
+  field.rect(
+    Rect.new(
+      x: 0, y: 0, width: 10, height: 10, background_color: {r: 200, b: 200, g: 800}
+    )
+  )
+  field.text(
+    Text.new(
+      x: text_pos[:x], y: text_pos[:y], body: "test",
+      background_color: {r: 800, g: 800, b: 800}, foreground_color: {r: 200, g: 200, b: 200}
+    )
+  )
+  field.update
+  sleep 0.05
+end
+TermCanvas.close

data/lib/term_canvas/base_screen.rb

@@ -0,0 +1,78 @@
+require 'singleton'
+require 'curses'
+class BaseScreen
+  include Singleton
+
+  def initialize
+    Curses.init_screen
+    Curses::noecho
+    Curses.curs_set(0)
+    Curses.stdscr.nodelay = 1
+    Curses.start_color
+    Curses.use_default_colors
+    @color_struct = Struct.new(:id, :r, :g, :b)
+    @color_pair_struct = Struct.new(:id, :fc_id, :bc_id)
+    @color_pairs = [@color_pair_struct.new(0, 1, 0)]
+    @colors = [@color_struct.new(0, 0, 0, 0)]
+    @color_id_offset = 16
+  end
+
+  # @param foreground_color [Hash]
+  #   :r Red element of color of text.
+  #   :g Green element of color of text.
+  #   :b Blue element of color of text.
+  # @param background_color [Hash]
+  #   :r Red element of color of background.
+  #   :g Green element of color of background.
+  #   :b Blue element of color of background.
+  def find_or_create_color_pair(foreground_color: nil, background_color:)
+    response_color_pair = nil
+    fc_id = find_or_create_color(
+      @color_struct.new(*foreground_color&.values_at(*@color_struct.members))
+    ).id
+    bc_id = find_or_create_color(
+      @color_struct.new(*background_color&.values_at(*@color_struct.members))
+    ).id
+    @color_pairs.each do |cp|
+      if cp.fc_id == fc_id && cp.bc_id == bc_id
+        response_color_pair = cp
+        break
+      end
+    end
+    return response_color_pair || create_color_pair(fc_id, bc_id)
+  end
+
+  private
+
+    def find_or_create_color(color)
+      return @colors.find { |c| c.id == 0 } if color.r.nil?
+      response_color = nil
+      @colors.each do |_color|
+        if same_color?(color, _color)
+          response_color = _color
+          break
+        end
+      end
+      return response_color || create_color(r: color.r, g: color.g, b: color.b)
+    end
+
+    def create_color(r:, g:, b:)
+      new_color_id = @colors.count + @color_id_offset
+      new_color = @color_struct.new(new_color_id, r, g, b)
+      Curses.init_color(*new_color)
+      @colors << new_color
+      return new_color
+    end
+
+    def create_color_pair(fc_id, bc_id)
+      new_color_pair_id = @color_pairs.count
+      new_color_pair = @color_pair_struct.new(new_color_pair_id, fc_id, bc_id)
+      Curses.init_pair(*new_color_pair)
+      @color_pairs << new_color_pair
+      return new_color_pair
+    end
+
+    def same_color?(color1, color2)
+      return color1.r == color2.r && color1.g == color2.g && color1.b == color2.b
+    end
+end

data/lib/term_canvas/object.rb

@@ -0,0 +1,8 @@
+class Object::TermCanvas
+  attr_reader :index
+
+  # @param index [Integer]
+  def set_index(index)
+    @object_index = index
+  end
+end

data/lib/term_canvas/rect.rb

@@ -0,0 +1,35 @@
+class Rect < Object::TermCanvas
+  attr_reader :background_color
+
+  # @param x [Integer] Horizontal position of the object.
+  # @param y [Integer] Vertical position of the object.
+  # @param background_color [Hash] :r Red element of color of background.
+  # @param background_color [Hash] :g Green element of color of background.
+  # @param background_color [Hash] :b Blue element of color of background.
+  def initialize(x:, y:, width:, height:, background_color:)
+    @x = x
+    @y = y
+    @width = width
+    @height = height
+    @background_color = background_color
+  end
+
+  def foreground_color
+    nil
+  end
+
+  # @param win [Curses::Window] Window to draw
+  def draw(win)
+    color_pair_id = BaseScreen.instance.find_or_create_color_pair(
+      background_color: @background_color,
+    ).id
+    color_pair = Curses.color_pair(color_pair_id)
+    win.setpos(@y, @x)
+    win.attron(color_pair)
+    @height.times do
+      win.addstr(" " * @width)
+      win.setpos(win.cury + 1, @x)
+    end
+    win.attroff(color_pair)
+  end
+end

data/lib/term_canvas/text.rb

@@ -0,0 +1,35 @@
+class Text < Object::TermCanvas
+  attr_reader :foreground_color, :background_color
+
+  # @param x [Integer] Horizontal position of the object.
+  # @param y [Integer] Vertical position of the object.
+  # @param body [String] Text body.
+  # @param foreground_color [Hash]
+  #   :r Red element of color of text.
+  #   :g Green element of color of text.
+  #   :b Blue element of color of text.
+  # @param background_color [Hash]
+  #   :r Red element of color of background.
+  #   :g Green element of color of background.
+  #   :b Blue element of color of background.
+  def initialize(x:, y:, body:, foreground_color:, background_color:)
+    @x = x
+    @y = y
+    @body = body
+    @foreground_color = foreground_color
+    @background_color = background_color
+  end
+
+  # @param win [Curses::Window] Window to draw
+  def draw(win)
+    color_pair_id = BaseScreen.instance.find_or_create_color_pair(
+      foreground_color: @foreground_color,
+      background_color: @background_color,
+    ).id
+    color_pair = Curses.color_pair(color_pair_id)
+    win.setpos(@y, @x)
+    win.attron(color_pair)
+    win.addstr(@body)
+    win.attroff(color_pair)
+  end
+end

data/lib/term_canvas/version.rb

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

data/lib/term_canvas.rb

@@ -0,0 +1,89 @@
+require 'curses'
+require 'term_canvas/base_screen'
+require 'term_canvas/object'
+require 'term_canvas/text'
+require 'term_canvas/rect'
+class TermCanvas
+  attr_accessor :width, :height
+  # Create a convenient window.
+  # @param x [Integer] Horizontal position of the window. From left to right.
+  # @param y [Integer] Vertical position of the window. From top to bottom.
+  # @param w [Integer] Width of the window.
+  # @param h [Integer] Height of the window.
+  def initialize(x:, y:, w:, h:)
+    BaseScreen.instance
+    @win = Curses::Window.new(h, w, y, x)
+    @x = x
+    @y = y
+    @width = w
+    @height = h
+    @objects = []
+    @object_index = 0
+  end
+
+  class << self
+    # Get key input.
+    # @return [String] Inputted key.
+    # @return [nil]
+    def gets
+      Curses.getch
+    end
+
+    # Close.
+    def close
+      Curses.close_screen
+    end
+  end
+
+  # Clear objects and remove from the window.
+  def clear
+    @win.clear
+    @objects = []
+    @object_index = 0
+  end
+
+  # @return [Integer] Horizontal center of the window.
+  def centerx
+    @win.width / 2 + @win.width % 2
+  end
+
+  # @return [Integer] Vertical center of the window.
+  def centery
+    @win.height / 2 + @win.height % 2
+  end
+
+  # Add text object to the window but not display.
+  # @param object [Text] Text instance
+  def text(object)
+    raise 'The argument must be Text' if !(Text === object)
+    object.set_index(@object_index)
+    @objects << object
+    @object_index += 1
+  end
+
+  # Add rect object to the window but not display.
+  def rect(object)
+    raise 'The argument must be Rect' if !(Rect === object)
+    object.set_index(@object_index)
+    @objects << object
+    @object_index += 1
+  end
+
+  # Display objects that are added into this instance.
+  def update
+    draw
+    @win.refresh
+  end
+
+  def close
+    @win.close
+  end
+
+  private
+
+    def draw
+      @objects.each do |object|
+        object.draw(@win)
+      end
+    end
+end

data/term_canvas.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "term_canvas/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "term_canvas"
+  spec.version       = TermCanvas::VERSION
+  spec.authors       = ["kthatoto"]
+  spec.email         = ["kthatoto@gmail.com"]
+
+  spec.summary       = %q{Wrapper library for curses of ruby}
+  spec.description   = %q{Wrapper library for curses of ruby. You can handle colors easily.}
+  spec.homepage      = "https://github.com/kthatoto/term_canvas"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "curses"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: term_canvas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kthatoto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Wrapper library for curses of ruby. You can handle colors easily.
+email:
+- kthatoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/update
+- examples/curses.rb
+- examples/simplified_chart.rb
+- examples/test.rb
+- lib/term_canvas.rb
+- lib/term_canvas/base_screen.rb
+- lib/term_canvas/object.rb
+- lib/term_canvas/rect.rb
+- lib/term_canvas/text.rb
+- lib/term_canvas/version.rb
+- term_canvas.gemspec
+homepage: https://github.com/kthatoto/term_canvas
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Wrapper library for curses of ruby
+test_files: []