gems-cli 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG +2 -0
  3. data/CONTRIBUTING.md +8 -0
  4. data/Gemfile.lock +3 -5
  5. data/README.md +22 -7
  6. data/Rakefile +0 -7
  7. data/gems-cli.gemspec +10 -12
  8. data/lib/gems-cli/paginator.rb +8 -0
  9. data/lib/gems-cli/version.rb +1 -1
  10. data/lib/gems-cli.rb +0 -2
  11. metadata +12 -19
  12. data/README.rdoc +0 -6
  13. data/gems-cli.rdoc +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6a8900fd82b7e823c789fb04fd5c873665df6bbd
4
- data.tar.gz: a5ade079b7bf16149c21f47cb00761968ddf6776
3
+ metadata.gz: ea244e679740034f4d7fcff0f2bee463a70c5954
4
+ data.tar.gz: cd52eea0f981a4077267a035fc2245dc71fc8242
5
5
  SHA512:
6
- metadata.gz: 8e5f4df4416d7a19ad89c47c6261befd8c022543e64ac116c08a9249900a7c7e65f7a0ee5017a7677eb7319e96a928ecff9190d00b0c0ec729cf8bd80a020e22
7
- data.tar.gz: f98f578d04e5bd1a995a159f22ad203333f85d0d8caeda180db34291b06a13125b8aaa33517bd0b4a215d5f7ab1d24d1fe4079587b38e7af697fa30c6ac2baba
6
+ metadata.gz: f5ca1200731680d95eea6516a514275c18524614331069233e11e8eba2e2211627430682ce1167fb136ad31f236f0babc324eb4acc743901d4c58435a5b2c948
7
+ data.tar.gz: ca1918e41f7ad829f452493009d4c7f5a827da7996bd542624a3222eca1aff8ee6feeb7df2f73a9ed3208144f6f05d210abf52e174ed858bc0e27fda9abe80cf
data/CHANGELOG CHANGED
@@ -5,3 +5,5 @@ Version 0.0.1: basic search and send selection to clipboard
5
5
  Version 0.1.0: adds pagination to search results
6
6
 
7
7
  Version 0.1.1: require at least ruby 1.9
8
+
9
+ Version 0.1.4: update gemspec, remove rdoc for yard, add some more documentation
data/CONTRIBUTING.md ADDED
@@ -0,0 +1,8 @@
1
+ # Contributing to gems-cli
2
+
3
+ 1. `git clone git@github.com:chaserx/gems-cli.git`
4
+ 1. Create a branch to add your feature/fix a bug: `git checkout -b my-new-feature`.
5
+ 1. Add your feature/fix while following the [style guide](http://learning-things.cirrusmio.com/style-guides/ruby.html).
6
+ 1. Commit and push your changes to the branch to Github.
7
+ 1. [Create a new Pull Request](https://github.com/chaserx/gems-cli/compare).
8
+
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- gems-cli (0.1.3)
4
+ gems-cli (0.1.4)
5
5
  clipboard (= 1.0.5)
6
6
  gems (= 0.8.3)
7
7
  gli (= 2.12.2)
@@ -17,11 +17,8 @@ GEM
17
17
  gems (0.8.3)
18
18
  gli (2.12.2)
19
19
  highline (1.6.21)
20
- json (1.8.1)
21
20
  rainbow (2.0.0)
22
21
  rake (10.3.2)
23
- rdoc (4.1.2)
24
- json (~> 1.4)
25
22
  rspec (3.1.0)
26
23
  rspec-core (~> 3.1.0)
27
24
  rspec-expectations (~> 3.1.0)
@@ -35,6 +32,7 @@ GEM
35
32
  rspec-support (~> 3.1.0)
36
33
  rspec-support (3.1.2)
37
34
  will_paginate (3.0.7)
35
+ yard (0.8.7.6)
38
36
 
39
37
  PLATFORMS
40
38
  ruby
@@ -42,5 +40,5 @@ PLATFORMS
42
40
  DEPENDENCIES
43
41
  gems-cli!
44
42
  rake (~> 10.3.2)
45
- rdoc (~> 4.1.2)
46
43
  rspec (~> 3.1.0)
44
+ yard (~> 0.8.7.6)
data/README.md CHANGED
@@ -4,14 +4,20 @@ gems-cli
4
4
  [![Build Status](https://travis-ci.org/chaserx/gems-cli.svg?branch=master)](https://travis-ci.org/chaserx/gems-cli)
5
5
 
6
6
  Using the [gems](https://github.com/rubygems/gems) gem to lookup Ruby Gems on
7
- the command line. Copy formatted gem details for your project's Gemfile.
7
+ the command line. Copy formatted gem details for your Gemfile.
8
+
9
+ ## Installation
10
+
11
+ ```bash
12
+ gem install gems-cli
13
+ ```
8
14
 
9
15
  ## Usage
10
16
 
11
17
  `gems search chase` or `gems s chase`
12
18
 
13
- ```
14
- running search for chase...
19
+ ```bash
20
+ Running search for chase...
15
21
  0: gem 'purchase', '~> 1.0.15'
16
22
  1: gem 'fuel_purchase', '~> 0.0.14'
17
23
  2: gem 'enju_purchase_request', '~> 0.0.14'
@@ -20,11 +26,20 @@ running search for chase...
20
26
  5: gem 'exemplor-chaser', '~> 0.0.2'
21
27
  6: gem 'rail_chaser', '~> 0.0.3'
22
28
  7: gem 'rack-in-app-purchase', '~> 0.1.1'
23
- select from 0..7, or q(uit)
29
+ Page: 1/1
30
+
31
+ Select from 0..9, (n)ext, (p)revious, or (q)uit #=> 0
32
+ Copied purchase to your clipboard!
33
+ ```
34
+
35
+ ```bash
36
+ pbpaste #=> gem 'purchase', '~> 1.0.15'
24
37
  ```
25
38
 
26
- `Copied to clipboard!`
39
+ ## TODO
40
+
41
+ - needs [Aruba](https://github.com/cucumber/aruba) tests for the CLI itself.
27
42
 
28
- ### TODO
43
+ ## Contributing
29
44
 
30
- - needs more tests
45
+ Pull requests welcome! Please see the [contribution guide](CONTRIBUTING.md).
data/Rakefile CHANGED
@@ -1,13 +1,6 @@
1
1
  require 'rake/clean'
2
2
  require 'rubygems'
3
3
  require 'rubygems/package_task'
4
- require 'rdoc/task'
5
-
6
- Rake::RDocTask.new do |rd|
7
- rd.main = "README.rdoc"
8
- rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
9
- rd.title = 'gems-cli'
10
- end
11
4
 
12
5
  spec = eval(File.read('gems-cli.gemspec'))
13
6
 
data/gems-cli.gemspec CHANGED
@@ -12,21 +12,19 @@ spec = Gem::Specification.new do |s|
12
12
  s.license = 'MIT'
13
13
  s.files = `git ls-files`.split(" ")
14
14
  s.require_paths << 'lib'
15
- s.has_rdoc = true
16
- s.extra_rdoc_files = ['README.rdoc','gems-cli.rdoc']
17
- s.rdoc_options << '--title' << 'gems-cli' << '--main' << 'README.rdoc' << '-ri'
18
15
  s.bindir = 'bin'
19
16
  s.executables << 'gems'
20
17
  s.required_ruby_version = '>= 2.0'
21
18
  s.post_install_message = "Thanks for installing! \ngems-cli usage: `gems s chase`"
22
- s.add_development_dependency('rake', '~> 10.3.2')
23
- s.add_development_dependency('rdoc', '~> 4.1.2')
24
- s.add_development_dependency('rspec', '~> 3.1.0')
25
19
 
26
- s.add_runtime_dependency('gli','2.12.2')
27
- s.add_runtime_dependency('gems','0.8.3')
28
- s.add_runtime_dependency('highline', '1.6.21')
29
- s.add_runtime_dependency('clipboard', '1.0.5')
30
- s.add_runtime_dependency('rainbow', '2.0.0')
31
- s.add_runtime_dependency('will_paginate', '3.0.7')
20
+ s.add_development_dependency 'rake', '~> 10.3.2'
21
+ s.add_development_dependency 'rspec', '~> 3.1.0'
22
+ s.add_development_dependency 'yard', '~> 0.8.7.6'
23
+
24
+ s.add_runtime_dependency 'gli','2.12.2'
25
+ s.add_runtime_dependency 'gems','0.8.3'
26
+ s.add_runtime_dependency 'highline', '1.6.21'
27
+ s.add_runtime_dependency 'clipboard', '1.0.5'
28
+ s.add_runtime_dependency 'rainbow', '2.0.0'
29
+ s.add_runtime_dependency 'will_paginate', '3.0.7'
32
30
  end
data/lib/gems-cli/paginator.rb CHANGED
@@ -17,37 +17,45 @@ class Paginator
17
17
  @ary[*args]
18
18
  end
19
19
 
20
+ # run calculation if you've initialized without arguments
20
21
  def calculate_pagination
21
22
  @paged_results = @ary.paginate(per_page: @per_page)
22
23
  @size = @paged_results.total_entries
23
24
  @pages = @paged_results.total_pages
24
25
  end
25
26
 
27
+ # test if the current page is on the last page of results
26
28
  def last_page?
27
29
  @page.eql? @pages
28
30
  end
29
31
 
32
+ # test if the current page is on the first page of results
30
33
  def first_page?
31
34
  @page.eql? 1
32
35
  end
33
36
 
37
+ # return the first page of results
34
38
  def first_page
35
39
  @ary.paginate(per_page: @per_page, page: 1)
36
40
  end
37
41
 
42
+ # return the last page of results
38
43
  def last_page
39
44
  @ary.paginate(per_page: @per_page, page: @pages)
40
45
  end
41
46
 
47
+ # return the current page of results
42
48
  def current_page
43
49
  @ary.paginate(per_page: @per_page, page: @page)
44
50
  end
45
51
 
52
+ # move the page index forward
46
53
  def next_page
47
54
  @page += 1 unless last_page?
48
55
  @ary.paginate(per_page: @per_page, page: @page)
49
56
  end
50
57
 
58
+ # move the page index back
51
59
  def previous_page
52
60
  @page -= 1 unless first_page?
53
61
  @ary.paginate(per_page: @per_page, page: @page)
data/lib/gems-cli/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module GemsCli
2
- VERSION = '0.1.3'
2
+ VERSION = '0.1.4'
3
3
  end
data/lib/gems-cli.rb CHANGED
@@ -5,5 +5,3 @@ require 'rainbow/ext/string'
5
5
  require 'will_paginate/array'
6
6
  require 'gems-cli/version.rb'
7
7
  require 'gems-cli/paginator.rb'
8
- # Add requires for other files you add to your project here, so
9
- # you just need to require this one file in your bin file
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gems-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chase Southard
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-11-30 00:00:00.000000000 Z
11
+ date: 2015-01-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -25,33 +25,33 @@ dependencies:
25
25
  - !ruby/object:Gem::Version
26
26
  version: 10.3.2
27
27
  - !ruby/object:Gem::Dependency
28
- name: rdoc
28
+ name: rspec
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: 4.1.2
33
+ version: 3.1.0
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: 4.1.2
40
+ version: 3.1.0
41
41
  - !ruby/object:Gem::Dependency
42
- name: rspec
42
+ name: yard
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: 3.1.0
47
+ version: 0.8.7.6
48
48
  type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: 3.1.0
54
+ version: 0.8.7.6
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: gli
57
57
  requirement: !ruby/object:Gem::Requirement
@@ -142,24 +142,21 @@ email: chase.southard@gmail.com
142
142
  executables:
143
143
  - gems
144
144
  extensions: []
145
- extra_rdoc_files:
146
- - README.rdoc
147
- - gems-cli.rdoc
145
+ extra_rdoc_files: []
148
146
  files:
149
147
  - ".gitignore"
150
148
  - ".rspec"
151
149
  - ".travis.yml"
152
150
  - CHANGELOG
151
+ - CONTRIBUTING.md
153
152
  - Gemfile
154
153
  - Gemfile.lock
155
154
  - LICENSE
156
155
  - NOTES
157
156
  - README.md
158
- - README.rdoc
159
157
  - Rakefile
160
158
  - bin/gems
161
159
  - gems-cli.gemspec
162
- - gems-cli.rdoc
163
160
  - lib/gems-cli.rb
164
161
  - lib/gems-cli/paginator.rb
165
162
  - lib/gems-cli/version.rb
@@ -170,12 +167,7 @@ licenses:
170
167
  - MIT
171
168
  metadata: {}
172
169
  post_install_message: "Thanks for installing! \ngems-cli usage: `gems s chase`"
173
- rdoc_options:
174
- - "--title"
175
- - gems-cli
176
- - "--main"
177
- - README.rdoc
178
- - "-ri"
170
+ rdoc_options: []
179
171
  require_paths:
180
172
  - lib
181
173
  - lib
@@ -197,3 +189,4 @@ specification_version: 4
197
189
  summary: Search rubygems.org from the command line. Copy formatted gem details for
198
190
  your Gemfile.
199
191
  test_files: []
192
+ has_rdoc:
data/README.rdoc DELETED
@@ -1,6 +0,0 @@
1
- = gems-cli
2
-
3
- Describe your project here
4
-
5
- :include:gems-cli.rdoc
6
-
data/gems-cli.rdoc DELETED
@@ -1,5 +0,0 @@
1
- = gems-cli
2
-
3
- Generate this with
4
- gems-cli rdoc
5
- After you have described your command line interface