everyday-curses 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/README.md +61 -3
  4. data/everyday-curses.gemspec +4 -4
  5. data/lib/everyday-curses/version.rb +1 -1
  6. metadata +29 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 140960c2a64bf5610adbd265161134d148b1e646
4
- data.tar.gz: 178e30d3ce39b391dceca9ae08761bc0f326f9c2
3
+ metadata.gz: 1e642244c2af154b88f4a7d0de2f6fba91123efa
4
+ data.tar.gz: d62a0a4b84c048750f29941c27e02b474d0471b2
5
5
  SHA512:
6
- metadata.gz: 74b335625857f162a9a221722261e45cc920edb70a91dd64f99a5c67385feca1d53798608446526a49ea90b286a7d77b363e155f1bd8cc652bd9264355a6fa86
7
- data.tar.gz: 4fd164b58dd05016af386a73c9b1ea7d88e4f235224e04addc6e7bf40b709054acaa000ab350431be9d331ee09726a89ea5077c79ab56e1d8703698198d5d198
6
+ metadata.gz: 3415549639ed305217dd837c5cbf76e2636900ee7d3501a0bf21b87126fac3ac93aed12722d63cc97accc8752b3ec2a3b97e7da95b77758fe561f6ece99c6152
7
+ data.tar.gz: 56dff9e848a32b95b26708e803bb17d07c4106252048f64aea5e984f17ab211b084fd2995e096a57eddaae0c8a6cc62295286b8597aa4bf3fff22448d4f821be
data/.gitignore CHANGED
@@ -3,7 +3,6 @@
3
3
  .bundle
4
4
  .config
5
5
  .yardoc
6
- Gemfile.lock
7
6
  InstalledFiles
8
7
  _yardoc
9
8
  coverage
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # Everyday::Curses
1
+ # EverydayCurses
2
2
 
3
- TODO: Write a gem description
3
+ A utility for handling some curses stuff more easily. Split out from everyday-cli-utils.
4
4
 
5
5
  ## Installation
6
6
 
@@ -18,7 +18,65 @@ Or install it yourself as:
18
18
 
19
19
  ## Usage
20
20
 
21
- TODO: Write usage instructions here
21
+ ###EverydayCurses::MyCurses
22
+
23
+ Encapsulates the code for dealing with the curses library.
24
+
25
+ ###Fields:
26
+ ####MyCurses.headers
27
+ An array storing the header lines that will be printed out with `MyCurses.myprints`.
28
+
29
+ ####MyCurses.bodies
30
+ An array storing the body lines that will be printed out with `MyCurses.myprints`.
31
+
32
+ ####MyCurses.footers
33
+ An array storing the footer lines that will be printed out with `MyCurses.myprints`.
34
+
35
+ ###Methods:
36
+
37
+ ####MyCurses.new(use\_curses, linesh, linesf)
38
+ Initializes the class and sets the basic options.
39
+
40
+ ######Parameters
41
+ * `use_curses`: `true` to use curses, `false` to use `puts`
42
+ * `linesh`: the number of header lines
43
+ * `linesf`: the number of footer lines
44
+
45
+ ####MyCurses.clear
46
+ Clear the `headers`, `bodies`, and `footers` arrays
47
+
48
+ ####MyCurses.myprints
49
+ Print out all of the lines stored in the `headers`, `bodies`, and `footers` arrays. If `use_curses` is `true`, it will use curses and allow for scrolling. Otherwise, it will just print out all of the lines with `puts`
50
+
51
+ ####MyCurses.read\_ch
52
+ Update the character from the body pad.
53
+
54
+ ####MyCurses.clear\_ch
55
+ Clear out any newline, ENTER, UP, or DOWN characters from the queue.
56
+
57
+ ####MyCurses.scroll\_iteration
58
+ Update the display (including doing any scrolling) and read the next character.
59
+
60
+ ####MyCurses.header\_live\_append(str)
61
+ Append `str` to the header pad immediately and update it. Does not modify the `headers` array.
62
+
63
+ ######Parameters
64
+ * `str`: the string to append
65
+
66
+ ####MyCurses.body\_live\_append(str)
67
+ Append `str` to the body pad immediately and update it. Does not modify the `bodies` array.
68
+
69
+ ######Parameters
70
+ * `str`: the string to append
71
+
72
+ ####MyCurses.footer\_live\_append(str)
73
+ Append `str` to the footer pad immediately and update it. Does not modify the `footers` array.
74
+
75
+ ######Parameters
76
+ * `str`: the string to append
77
+
78
+ ####MyCurses.dispose
79
+ Close out the curses screen if curses was used.
22
80
 
23
81
  ## Contributing
24
82
 
data/everyday-curses.gemspec CHANGED
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
19
19
  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
20
20
  spec.require_paths = ['lib']
21
21
 
22
- spec.add_development_dependency 'bundler', '~> 1.5'
23
- spec.add_development_dependency 'rake', '~> 10.0'
22
+ spec.add_development_dependency 'bundler', '~> 1.10', '>= 1.10.4'
23
+ spec.add_development_dependency 'rake', '~> 10.4'
24
24
 
25
- spec.add_dependency 'curses'
26
- spec.add_dependency 'everyday-cli-utils'
25
+ spec.add_dependency 'curses', '~> 1.0', '>= 1.0.1'
26
+ spec.add_dependency 'everyday-cli-utils', '~> 1.8', '>= 1.8.2'
27
27
  end
data/lib/everyday-curses/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module EverydayCurses
2
- VERSION = '0.1.0'
2
+ VERSION = '0.1.1'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: everyday-curses
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Eric Henderson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-01-29 00:00:00.000000000 Z
11
+ date: 2015-06-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -16,56 +16,74 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '1.5'
19
+ version: '1.10'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 1.10.4
20
23
  type: :development
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
27
  - - "~>"
25
28
  - !ruby/object:Gem::Version
26
- version: '1.5'
29
+ version: '1.10'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 1.10.4
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: rake
29
35
  requirement: !ruby/object:Gem::Requirement
30
36
  requirements:
31
37
  - - "~>"
32
38
  - !ruby/object:Gem::Version
33
- version: '10.0'
39
+ version: '10.4'
34
40
  type: :development
35
41
  prerelease: false
36
42
  version_requirements: !ruby/object:Gem::Requirement
37
43
  requirements:
38
44
  - - "~>"
39
45
  - !ruby/object:Gem::Version
40
- version: '10.0'
46
+ version: '10.4'
41
47
  - !ruby/object:Gem::Dependency
42
48
  name: curses
43
49
  requirement: !ruby/object:Gem::Requirement
44
50
  requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '1.0'
45
54
  - - ">="
46
55
  - !ruby/object:Gem::Version
47
- version: '0'
56
+ version: 1.0.1
48
57
  type: :runtime
49
58
  prerelease: false
50
59
  version_requirements: !ruby/object:Gem::Requirement
51
60
  requirements:
61
+ - - "~>"
62
+ - !ruby/object:Gem::Version
63
+ version: '1.0'
52
64
  - - ">="
53
65
  - !ruby/object:Gem::Version
54
- version: '0'
66
+ version: 1.0.1
55
67
  - !ruby/object:Gem::Dependency
56
68
  name: everyday-cli-utils
57
69
  requirement: !ruby/object:Gem::Requirement
58
70
  requirements:
71
+ - - "~>"
72
+ - !ruby/object:Gem::Version
73
+ version: '1.8'
59
74
  - - ">="
60
75
  - !ruby/object:Gem::Version
61
- version: '0'
76
+ version: 1.8.2
62
77
  type: :runtime
63
78
  prerelease: false
64
79
  version_requirements: !ruby/object:Gem::Requirement
65
80
  requirements:
81
+ - - "~>"
82
+ - !ruby/object:Gem::Version
83
+ version: '1.8'
66
84
  - - ">="
67
85
  - !ruby/object:Gem::Version
68
- version: '0'
86
+ version: 1.8.2
69
87
  description: A utility for handling some curses stuff more easily. Split out from
70
88
  everyday-cli-utils.
71
89
  email:
@@ -104,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
104
122
  version: '0'
105
123
  requirements: []
106
124
  rubyforge_project:
107
- rubygems_version: 2.2.0
125
+ rubygems_version: 2.4.6
108
126
  signing_key:
109
127
  specification_version: 4
110
128
  summary: The MyCurses class from everyday-cli-utils
111
129
  test_files: []
112
- has_rdoc: