term-slides 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 39be56c089c1497a34db87736a1c6bfd92cfae66c30f15dca398e08d475c5090
4
+ data.tar.gz: 60a483a945685053b6491355cefb882c7900d6d4a4df19d76290cdcf028b1e83
5
+ SHA512:
6
+ metadata.gz: 0504c136cb0e33737d0e913924922029b6ce0056b0c13ba76e2c6e57c34f988c52cf3a73a682524a3948cc158b4e93b3d8305a9fe237228f385f65959ec56f35
7
+ data.tar.gz: 16929e079368e042f4bba8fab7b1cdbd6f003bcfd894901f7c1837562e0dc2524f56aa9dd7ecd3ba0094bb33f3519612b614494447edfa7a710044c61abeb413
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.2
7
+ before_install: gem install bundler -v 2.0.1
@@ -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 yazgoo@gmail.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 term-slides.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 yazgoo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # Term::Slides
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/term/slides`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'term-slides'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install term-slides
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/term-slides. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the Term::Slides project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/term-slides/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "term/slides"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
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
@@ -0,0 +1,5 @@
1
+ module Term
2
+ module Slides
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,243 @@
1
+ require "term/slides/version"
2
+
3
+ module Term
4
+ module Slides
5
+ class Error < StandardError; end
6
+ require 'io/console'
7
+ require 'colorize'
8
+ require 'tty-table'
9
+ require 'tty-command'
10
+ require 'highline'
11
+
12
+ class TTYRenderer
13
+ def render_code code
14
+ path = "code.#{code.format}"
15
+ File.write(path, code.content)
16
+ out, err = TTY::Command.new(pty: true, printer: :null).run('vimcat', path)
17
+ puts out
18
+ end
19
+ def render_table table
20
+ puts center(TTY::Table.new(table.headers, table.rows).render(:unicode))
21
+ end
22
+ def center text
23
+ width = HighLine::SystemExtensions.terminal_size.first
24
+ text.split("\n").map { |x| x.center(width) }.join("\n")
25
+ end
26
+ def render_text text
27
+ puts center(text.text)
28
+ end
29
+ def render_image_file src
30
+ kitty = '/Applications/kitty.app/Contents/MacOS/kitty'
31
+ kitty = 'kitty' unless File.exists? kitty
32
+ `#{kitty} +kitten icat #{src}`
33
+ end
34
+ def render_image image
35
+ render_image_file image.src
36
+ end
37
+ def render_diagram diagram
38
+ render_image_file diagram.build
39
+ end
40
+ def render_slide slide
41
+ puts center(slide.name.colorize(:light_blue).bold)
42
+ puts
43
+ slide.content.each { |c| c.render }
44
+ end
45
+ end
46
+
47
+ class HovercraftRenderer
48
+ def render_code code
49
+ puts ".. code:: #{code.format}"
50
+ puts
51
+ puts code.content.gsub(/^/, " ")
52
+ end
53
+ def render_table table
54
+ puts
55
+ puts ".. table::"
56
+ puts
57
+ a = TTY::Table.new(table.headers, table.rows).render(:ascii).split("\n")
58
+ s = (a[0..2] + a[3..-1].map { |l| l += "\n#{a[0]}"}).join("\n")
59
+ puts s.gsub(/^/, " ")
60
+ puts
61
+ end
62
+ def render_text text
63
+ puts text.text
64
+ end
65
+ def render_image image
66
+ puts ".. image:: #{image.src}"
67
+ end
68
+ def render_diagram diagram
69
+ puts ".. image:: #{diagram.build}"
70
+ puts " :width: #{diagram.width}" if not diagram.width.nil?
71
+ puts " :height: #{diagram.height}" if not diagram.height.nil?
72
+ puts
73
+ end
74
+ def render_slide slide
75
+ puts
76
+ puts slide.name
77
+ puts slide.name.gsub(/./, "=")
78
+ puts
79
+ slide.content.each { |c| c.render }
80
+ puts
81
+ puts "----"
82
+ puts
83
+ end
84
+ end
85
+
86
+ class Code
87
+ attr_reader :format, :content
88
+ def initialize renderer, format, content
89
+ @renderer = renderer
90
+ @format = format
91
+ @content = content
92
+ end
93
+ def render
94
+ @renderer.render_code self
95
+ end
96
+ end
97
+
98
+ class Table
99
+ attr_reader :rows, :headers
100
+ def row *r
101
+ @rows << r
102
+ end
103
+ def initialize renderer, headers, &block
104
+ @renderer = renderer
105
+ @headers = headers
106
+ @rows = []
107
+ instance_eval &block
108
+ end
109
+ def render
110
+ @renderer.render_table self
111
+ end
112
+ end
113
+
114
+ class Text
115
+ attr_reader :text
116
+ def initialize renderer, text
117
+ @renderer = renderer
118
+ @text = text
119
+ end
120
+
121
+ def render
122
+ @renderer.render_text self
123
+ end
124
+ end
125
+
126
+ class Diagram
127
+ attr_reader :dot, :width, :height
128
+ def initialize renderer, dot, width = nil, height = nil
129
+ @renderer = renderer
130
+ @dot = dot
131
+ @width = width
132
+ @height = height
133
+ end
134
+ def build
135
+ $i ||= 0
136
+ path = "graph#{$i}.png"
137
+ `echo "#{@dot.gsub('"', '\\"')}" | dot -Tpng > #{path}`
138
+ $i += 1
139
+ path
140
+ end
141
+ def render
142
+ @renderer.render_diagram self
143
+ end
144
+ end
145
+
146
+ class Image
147
+ attr_reader :src
148
+ def initialize renderer, src
149
+ @renderer = renderer
150
+ @src = src
151
+ end
152
+ def render
153
+ @renderer.render_image self
154
+ end
155
+ end
156
+
157
+ class Slide
158
+ attr_accessor :name, :content, :renderer
159
+ def text s
160
+ @content << Text.new(@renderer, s)
161
+ end
162
+ alias t text
163
+ def code format, s
164
+ @content << Code.new(@renderer, format, s)
165
+ end
166
+ def table *headers, &block
167
+ @content << Table.new(@renderer, headers, &block)
168
+ end
169
+ def diagram dot
170
+ @content << Diagram.new(@renderer, dot)
171
+ end
172
+ def image src
173
+ @content << Image.new(@renderer, src)
174
+ end
175
+ def initialize renderer, name, &block
176
+ @renderer = renderer
177
+ @name = name
178
+ @content = []
179
+ instance_eval &block
180
+ end
181
+ def render
182
+ @renderer.render_slide self
183
+ end
184
+ end
185
+
186
+ class Slides
187
+ def slide name, &block
188
+ @slides << Slide.new(@renderer, name, &block)
189
+ end
190
+ def initialize args, &block
191
+ @args = args
192
+ if @args.size > 0 and @args[0] == "hovercraft"
193
+ @renderer = HovercraftRenderer.new
194
+ else
195
+ @renderer = TTYRenderer.new
196
+ end
197
+ @slides = []
198
+ instance_eval &block
199
+ end
200
+ def read_char
201
+ STDIN.echo = false
202
+ STDIN.raw!
203
+
204
+ input = STDIN.getc.chr
205
+ if input == "\e" then
206
+ input << STDIN.read_nonblock(3) rescue nil
207
+ input << STDIN.read_nonblock(2) rescue nil
208
+ end
209
+ ensure
210
+ STDIN.echo = true
211
+ STDIN.cooked!
212
+
213
+ return input
214
+ end
215
+ def run
216
+ i = 0
217
+ if @args.size > 0
218
+ if @args[0] == "hovercraft"
219
+ @slides.each do |slide|
220
+ slide.render
221
+ end
222
+ else
223
+ @slides[@args[0].to_i].render
224
+ end
225
+ return
226
+ end
227
+ while true
228
+ puts `clear`
229
+ puts "#{i + 1}/#{@slides.size}"
230
+ @slides[i].render
231
+ s = read_char
232
+ if s == "q"
233
+ break
234
+ elsif s == "p"
235
+ i -= 1 if i > 0
236
+ elsif s == "n"
237
+ i += 1 if i < (@slides.size - 1)
238
+ end
239
+ end
240
+ end
241
+ end
242
+ end
243
+ end
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "term/slides/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "term-slides"
8
+ spec.version = Term::Slides::VERSION
9
+ spec.authors = ["yazgoo"]
10
+ spec.email = ["yazgoo@gmail.com"]
11
+
12
+ spec.summary = %q{run presentations in your terminal}
13
+ spec.description = %q{run presentations in your terminal}
14
+ spec.homepage = "https://github.com/yazgoo/term-slides"
15
+ spec.license = "MIT"
16
+
17
+
18
+ # Specify which files should be added to the gem when it is released.
19
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
20
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
21
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
22
+ end
23
+ spec.bindir = "exe"
24
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ spec.require_paths = ["lib"]
26
+
27
+ spec.add_development_dependency "bundler", "~> 2.0"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "minitest", "~> 5.0"
30
+ end
metadata ADDED
@@ -0,0 +1,97 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: term-slides
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - yazgoo
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-04-08 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: '2.0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
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: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ description: run presentations in your terminal
56
+ email:
57
+ - yazgoo@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".travis.yml"
64
+ - CODE_OF_CONDUCT.md
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - lib/term/slides.rb
72
+ - lib/term/slides/version.rb
73
+ - term-slides.gemspec
74
+ homepage: https://github.com/yazgoo/term-slides
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubygems_version: 3.0.3
94
+ signing_key:
95
+ specification_version: 4
96
+ summary: run presentations in your terminal
97
+ test_files: []