gem_polisher 0.4.6 → 0.4.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -0
  3. data/lib/gem_polisher/version.rb +1 -1
  4. metadata +15 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 88371b1d43f0c0af9feb354a8d7e9fb0d03e6558
4
- data.tar.gz: c7f92e9d7c71349702e49ba3983de2a703b5de98
3
+ metadata.gz: 1f287d1705af7c17ee8c5362a55a77d8ce8adcb7
4
+ data.tar.gz: ee3449d70e515417c02bff628cabab056cd3dc82
5
5
  SHA512:
6
- metadata.gz: 824a980d4170da2cb25887b8ab02f3a171567e971c007946715dc652cd800d2fcd86ab9dcd1f6e16556d22d502a385ef0c7261e3c2b30eafde47cb1fd1fa7126
7
- data.tar.gz: d804ada023a240ec6c1e009cc52bf1bd838b72a4921cd820748edcc823d32b6250eda243f4e9d988096e09b3dd54e2c83e0f6c9eed6480fb074c5fc23bb1615e
6
+ metadata.gz: 130f896c18a5c53ea8c1249faa21a7bbf0e7b0df9cfdb5295f64576e45e89977f18c3eb5021a8b79a97d801e3a59d2d53b93e06c01243a470a8dd2ee017ea20b
7
+ data.tar.gz: 2eebc9f291057e2c723fd4c5dfe5a4aee6d3cf7f67fca0a5a5dad48fbfa39f90a84746bd2d450c12981ba979ecb8ae559559f6f06c3b1ca8fd1b1761cbfa5399
data/README.md CHANGED
@@ -19,6 +19,7 @@ This Gem provides Rake tasks to assist Ruby Gem development workflow.
19
19
  * Follow [already established naming conventions](http://guides.rubygems.org/name-your-gem/).
20
20
  * Tip: if you does not use strict camel casing (eg: RDoc and not Rdoc), see <tt>GemPolisher#initialize</tt>'s <tt>gem_main_constant_s</tt> option.
21
21
  * When creating your <tt>.gemspec</tt> file, point its <tt>version</tt> attribute to an external file. Eg:
22
+
22
23
  ```ruby
23
24
  require_relative 'lib/my/gem/with_long_name/version'
24
25
  Gem::Specification.new do |s|
@@ -26,7 +27,9 @@ This Gem provides Rake tasks to assist Ruby Gem development workflow.
26
27
  s.add_development_dependency 'gem_polisher', '~>0.4' # Change to latest available version!
27
28
  end
28
29
  ```
30
+
29
31
  * Create the version file accordingly. Eg:
32
+
30
33
  ```ruby
31
34
  class My
32
35
  class Gem
@@ -36,24 +39,30 @@ This Gem provides Rake tasks to assist Ruby Gem development workflow.
36
39
  end
37
40
  end
38
41
  ```
42
+
39
43
  * Add this to your <tt>Rakefile</tt>:
44
+
40
45
  ```ruby
41
46
  require 'gem_polisher'
42
47
  GemPolisher.new
43
48
  ```
49
+
44
50
  * Create your <tt>Gemfile</tt> and <tt>Gemfile.lock</tt> using [Bundler](http://bundler.io/).
45
51
 
46
52
  At this point, you have at your disposal some Rake tasks:
53
+
47
54
  ```
48
55
  $ bundle exec rake -T
49
56
  rake gem:release[type] # Update bundle, run tests, increment version, build and publish Gem; type can be major, minor or patch
50
57
  rake test # Run all tests
51
58
  ```
59
+
52
60
  That you can use to generate new releases. The <tt>gem:release[type]</tt> task will:
53
61
  * Make sure you are at master, with everything commited.
54
62
  * Update your bundle (<tt>Gemfile.lock</tt>).
55
63
  * Execute Rake task <tt>test</tt>.
56
64
  * Tip: You can define your own test tasks tied to this. Eg:
65
+
57
66
  ```ruby
58
67
  desc "Run RSpec"
59
68
  task :rspec do
@@ -61,15 +70,18 @@ That you can use to generate new releases. The <tt>gem:release[type]</tt> task w
61
70
  end
62
71
  task test: [:rspec]
63
72
  ```
73
+
64
74
  * Build your <tt>.gem</tt>.
65
75
  * Publish it to https://rubygems.org/.
66
76
 
67
77
  ## Documentation
68
78
 
69
79
  Documentation is provided via RDoc. The easiest way to read it:
80
+
70
81
  ```
71
82
  gem install --rdoc gem_polisher
72
83
  gem install bdoc
73
84
  bdoc
74
85
  ```
86
+
75
87
  You can read it with <tt>ri</tt> also, of course.
@@ -1,3 +1,3 @@
1
1
  class GemPolisher
2
- VERSION = '0.4.6'
2
+ VERSION = '0.4.7'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gem_polisher
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.6
4
+ version: 0.4.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fabio Pugliese Ornellas
@@ -72,6 +72,20 @@ dependencies:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
74
  version: '10.4'
75
+ - !ruby/object:Gem::Dependency
76
+ name: rdoc
77
+ requirement: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '4.2'
82
+ type: :development
83
+ prerelease: false
84
+ version_requirements: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '4.2'
75
89
  - !ruby/object:Gem::Dependency
76
90
  name: rspec
77
91
  requirement: !ruby/object:Gem::Requirement