very_good 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ae61cbabf3c8158f6695f3f08834bd9b4b8add97
4
+ data.tar.gz: a0da0bfe466d788b5443f04c89e2a6fb78041cba
5
+ SHA512:
6
+ metadata.gz: af277b92c94fac12f46431f8a89c9492488b90e32867b926ce1766170570db990719e1929ab8c7c66f1fadf1767053ba34888572aa73baaafd0d07501478dc1e
7
+ data.tar.gz: 24106d716ecc629e4478f5bf954b191a8bd8a6759e6e9c168b3f6119151b6f7b0f9ec5320f5c555382ae78f47bc005249c0e0cdade25dc1f450c6c17e6ffafae
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.13.6
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at jared@creepywizard.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in very_good.gemspec
4
+ gemspec
data/README.md ADDED
@@ -0,0 +1,44 @@
1
+ # VeryGood
2
+
3
+ VeryGood gives you a nice API so you can set what letters should be where/what
4
+ colour ANSI them appear in your terminal.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'very_good'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install very_good
21
+
22
+ ## Usage
23
+
24
+ Don't. It's not ready.
25
+
26
+ ## Development
27
+
28
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run
29
+ `rake spec` to run the tests. You can also run `bin/console` for an interactive
30
+ prompt that will allow you to experiment.
31
+
32
+ To install this gem onto your local machine, run `bundle exec rake install`. To
33
+ release a new version, update the version number in `version.rb`, and then run
34
+ `bundle exec rake release`, which will create a git tag for the version, push
35
+ git commits and tags, and push the `.gem` file to
36
+ [rubygems.org](https://rubygems.org).
37
+
38
+ ## Contributing
39
+
40
+ Bug reports and pull requests are welcome on GitHub at
41
+ https://github.com/[USERNAME]/very_good. This project is intended to be a safe,
42
+ welcoming space for collaboration, and contributors are expected to adhere to
43
+ the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
44
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "very_good"
5
+
6
+ require "pry"
7
+ require "pry-stack_explorer"
8
+ Pry.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/bin/test ADDED
@@ -0,0 +1,26 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "very_good"
5
+
6
+ require "pry"
7
+ require "pry-stack_explorer"
8
+
9
+ VeryGood.start do |terminal|
10
+ terminal.update!
11
+
12
+ state = terminal.state
13
+ newState =
14
+ state.
15
+ set(0, 0, VeryGood::Cell.new("J", colour: VeryGood::Ansi::BLUE)).
16
+ set(1, 0, VeryGood::Cell.new("a", colour: VeryGood::Ansi::BLUE)).
17
+ set(2, 0, VeryGood::Cell.new("r", colour: VeryGood::Ansi::BLUE)).
18
+ set(3, 0, VeryGood::Cell.new("E", colour: VeryGood::Ansi::BLUE)).
19
+ set(4, 0, VeryGood::Cell.new("d", colour: VeryGood::Ansi::BLUE)).
20
+ set_cursor(VeryGood::Cursor.new(6, 0))
21
+
22
+ terminal.state = newState
23
+
24
+ terminal.update!
25
+ sleep 2
26
+ end
data/lib/very_good.rb ADDED
@@ -0,0 +1,48 @@
1
+ require "very_good/version"
2
+ require "very_good/cell"
3
+ require "very_good/state"
4
+ require "very_good/terminal"
5
+ require "very_good/ansi"
6
+ require "very_good/cursor"
7
+
8
+ module VeryGood
9
+ class << self
10
+ def start
11
+ save_tty
12
+ setup_tty
13
+ terminal = VeryGood::Terminal.new(
14
+ width: command("tput cols").strip.to_i,
15
+ height: command("tput lines").strip.to_i
16
+ )
17
+ terminal.clear!
18
+ terminal.move_cursor(0, 0)
19
+ yield terminal
20
+ ensure
21
+ restore_tty
22
+ end
23
+
24
+ private
25
+
26
+ def save_tty
27
+ @tty_settings = command("stty -g").strip
28
+ end
29
+
30
+ def setup_tty
31
+ command("stty raw -echo -icanon")
32
+ end
33
+
34
+ def restore_tty
35
+ command("stty #{@tty_settings}")
36
+ end
37
+
38
+ def command(command)
39
+ IO.pipe do |read_io, write_io|
40
+ pid = Process.spawn(command, :in => "/dev/tty", :out => write_io)
41
+ Process.wait(pid)
42
+ raise "Command failed: #{command.inspect}" unless $?.success?
43
+ write_io.close
44
+ read_io.read
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,21 @@
1
+ module VeryGood
2
+ module Ansi
3
+ BLUE = :blue
4
+
5
+ ESC = 27.chr
6
+
7
+ class << self
8
+ def escape(sequence)
9
+ ESC + "[" + sequence
10
+ end
11
+
12
+ def clear
13
+ escape "2J"
14
+ end
15
+
16
+ def move_cursor(x, y)
17
+ escape "#{y};#{x}H"
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,11 @@
1
+ module VeryGood
2
+ class Cell
3
+ def initialize(char, colour: nil)
4
+ @char = char
5
+ @colour = colour
6
+ end
7
+
8
+ attr_reader :char,
9
+ :colour
10
+ end
11
+ end
@@ -0,0 +1,10 @@
1
+ module VeryGood
2
+ class Cursor
3
+ def initialize(x, y)
4
+ @x = x
5
+ @y = y
6
+ end
7
+
8
+ attr_reader :x, :y
9
+ end
10
+ end
@@ -0,0 +1,48 @@
1
+ module VeryGood
2
+ class State
3
+ def initialize(width:, height:, state: nil, cursor: Cursor.new(0, 0))
4
+ @width = width
5
+ @height = height
6
+ @state = state || clean_state
7
+ @cursor = cursor
8
+ end
9
+
10
+ attr_reader :width, :height, :cursor
11
+
12
+ def set(x, y, cell)
13
+ new_state = @state.map do |line|
14
+ line.dup
15
+ end
16
+
17
+ new_state[y][x] = cell
18
+
19
+ State.new(
20
+ width: width,
21
+ height: height,
22
+ state: new_state,
23
+ cursor: cursor
24
+ )
25
+ end
26
+
27
+ def set_cursor(new_cursor)
28
+ State.new(
29
+ width: width,
30
+ height: height,
31
+ state: @state,
32
+ cursor: new_cursor
33
+ )
34
+ end
35
+
36
+ def lines
37
+ @state
38
+ end
39
+
40
+ private
41
+
42
+ def clean_state
43
+ (0..(@height - 1)).map do |x|
44
+ (0..(@width - 1)).map { Cell.new(' ') }
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,42 @@
1
+ module VeryGood
2
+ class Terminal
3
+ def initialize(width:, height:)
4
+ @state = State.new(width: width, height: height)
5
+ end
6
+
7
+ def state
8
+ @state
9
+ end
10
+
11
+ def state=(other)
12
+ @state = other
13
+ end
14
+
15
+ def update!
16
+ clear!
17
+ move_cursor(0, 0)
18
+
19
+ state.lines.each do |line|
20
+ line.each do |cell|
21
+ output.write(cell.char)
22
+ end
23
+ end
24
+
25
+ move_cursor(state.cursor.x, state.cursor.y)
26
+ end
27
+
28
+ def clear!
29
+ output.write Ansi.clear
30
+ end
31
+
32
+ def move_cursor(x, y)
33
+ output.write Ansi.move_cursor(x, y)
34
+ end
35
+
36
+ private
37
+
38
+ def output
39
+ STDOUT
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,3 @@
1
+ module VeryGood
2
+ VERSION = "0.1.0"
3
+ end
data/very_good.gemspec ADDED
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'very_good/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "very_good"
8
+ spec.version = VeryGood::VERSION
9
+ spec.authors = ["Jared Norman"]
10
+ spec.email = ["jared@creepywizard.com"]
11
+
12
+ spec.summary = "VeryGood gives you a nice API so you can set what letters should be where/what colour ANSI them appear in your terminal."
13
+ spec.description = "VeryGood gives you a nice API so you can set what letters should be where/what colour ANSI them appear in your terminal."
14
+ spec.homepage = "https://github.com/jarednorman/very_good"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.13"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ spec.add_development_dependency "pry"
27
+ spec.add_development_dependency "pry-stack_explorer"
28
+ end
metadata ADDED
@@ -0,0 +1,133 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: very_good
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jared Norman
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-21 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry-stack_explorer
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: VeryGood gives you a nice API so you can set what letters should be where/what
84
+ colour ANSI them appear in your terminal.
85
+ email:
86
+ - jared@creepywizard.com
87
+ executables: []
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - ".gitignore"
92
+ - ".rspec"
93
+ - ".travis.yml"
94
+ - CODE_OF_CONDUCT.md
95
+ - Gemfile
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - bin/test
101
+ - lib/very_good.rb
102
+ - lib/very_good/ansi.rb
103
+ - lib/very_good/cell.rb
104
+ - lib/very_good/cursor.rb
105
+ - lib/very_good/state.rb
106
+ - lib/very_good/terminal.rb
107
+ - lib/very_good/version.rb
108
+ - very_good.gemspec
109
+ homepage: https://github.com/jarednorman/very_good
110
+ licenses: []
111
+ metadata: {}
112
+ post_install_message:
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.5.2
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: VeryGood gives you a nice API so you can set what letters should be where/what
132
+ colour ANSI them appear in your terminal.
133
+ test_files: []