confoog 0.4.3 → 0.4.5
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 +4 -4
- data/README.md +9 -6
- data/Rakefile +13 -5
- data/confoog.gemspec +4 -2
- data/lib/confoog/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 81ec77ff9a1cd8a233bb54f1efdfc75c71c71484
|
4
|
+
data.tar.gz: 8bcdc84ef266ce9f9bd7cece30d98626ef8a6c34
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f1b469e7ab0fd62f7ef2b1c64371bacd282ce63ea88eb3e7cba171be0b34326390dcd4c1b8986ee1071e43e7d252abddb54971bbbc3385558f4d1c507ad32c14
|
7
|
+
data.tar.gz: a7bb409ec43d023304c765ae9f069c36e4908bfbaad553a2857ff3bf72c0d4774cfcdee1c30b1f0404783c3e8412d3ccf5d94e14b5e3fc68ab282f56570a9c77
|
data/README.md
CHANGED
@@ -1,6 +1,5 @@
|
|
1
|
-
# Confoog
|
2
|
-
|
3
|
-
[](https://travis-ci.org/seapagan/confoog)
|
1
|
+
# Confoog [](http://badge.fury.io/rb/confoog) [](https://travis-ci.org/seapagan/confoog)
|
2
|
+
|
4
3
|
[](https://gemnasium.com/seapagan/confoog)
|
5
4
|
[](https://coveralls.io/github/seapagan/confoog?branch=master)
|
6
5
|
[](https://codeclimate.com/github/seapagan/confoog)
|
@@ -129,6 +128,9 @@ Thoughts in no particular order.
|
|
129
128
|
- Restrict configuration variables to a specified subset, or to only those that already exist in the YAML file.
|
130
129
|
- A better way of dealing with multi-level variables - i.e. nested arrays, hashes etc.
|
131
130
|
- Write standalone tests for the 'Status' class - right now it is tested at 100% by the application tests though would probably be good to have dedicated tests too
|
131
|
+
- Check Windows compatibility, certainly at least the tests will fail since there are issue with FakeFS on Window. Should be ok as a production Gem though (TBC)
|
132
|
+
- Add other file formats for storing config - XML? (Yuk!)
|
133
|
+
- Document properly on a dedicated website with full example usage and help.
|
132
134
|
|
133
135
|
## Development
|
134
136
|
|
@@ -136,7 +138,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
|
|
136
138
|
|
137
139
|
To install this gem onto your local machine, run `bundle exec rake install`.
|
138
140
|
|
139
|
-
Run `rake` to run the RSpec tests, which also runs `RuboCop` and `inch --pedantic` too.
|
141
|
+
Run `rake` to run the RSpec tests, which also runs `RuboCop`, `Reek` and `inch --pedantic` too.
|
140
142
|
|
141
143
|
## Contributing
|
142
144
|
|
@@ -146,10 +148,11 @@ Run `rake` to run the RSpec tests, which also runs `RuboCop` and `inch --pedanti
|
|
146
148
|
4. Push to the branch (`git push origin my-new-feature`)
|
147
149
|
5. Create new Pull Request
|
148
150
|
|
149
|
-
Please note - This Gem currently passes 100% on
|
150
|
-
Running `rake` will automatically test
|
151
|
+
Please note - This Gem currently passes 100% on [RuboCop][rubocop], [Reek][reek] and [Inch-CI][inch] (on pedantic mode), so all pull requests should do likewise. Ask for guidance if needed.
|
152
|
+
Running `rake` will automatically test all 3 of those along with the RSpec tests. Note that Failures of Rubocop will cause the CI (Travis) to fail, however 'Reek' failures will not.
|
151
153
|
|
152
154
|
[rubocop]: https://github.com/bbatsov/rubocop
|
155
|
+
[reek]: https://github.com/troessner/reek
|
153
156
|
[inch]: https://inch-ci.org
|
154
157
|
|
155
158
|
## Versioning
|
data/Rakefile
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
require 'bundler/gem_tasks'
|
2
2
|
require 'rspec/core/rake_task'
|
3
3
|
require 'rubocop/rake_task'
|
4
|
-
|
4
|
+
|
5
5
|
require 'inch/rake'
|
6
6
|
|
7
7
|
RSpec::Core::RakeTask.new(:spec)
|
@@ -14,10 +14,18 @@ Inch::Rake::Suggest.new do |suggest|
|
|
14
14
|
suggest.args << '--pedantic'
|
15
15
|
end
|
16
16
|
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
17
|
+
# reek is not comp[atible with Ruby < 2.0]
|
18
|
+
if RUBY_VERSION > '2.0'
|
19
|
+
require 'reek/rake/task'
|
20
|
+
Reek::Rake::Task.new do |t|
|
21
|
+
t.fail_on_error = false
|
22
|
+
t.verbose = true
|
23
|
+
t.reek_opts = '-U'
|
24
|
+
end
|
25
|
+
else
|
26
|
+
task :reek do
|
27
|
+
# Empty task
|
28
|
+
end
|
21
29
|
end
|
22
30
|
|
23
31
|
task default: [:rubocop, :inch, :reek, :spec]
|
data/confoog.gemspec
CHANGED
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
|
|
13
13
|
|
14
14
|
spec.summary = 'This will add a class that takes care of all your configuration needs for Ruby scripts and Gems. Simple and basic'
|
15
15
|
spec.description = 'A simple Gem to add YAML configuration files to your Ruby script or Gem'
|
16
|
-
spec.homepage = '
|
16
|
+
spec.homepage = 'http://confoog.seapagan.net'
|
17
17
|
spec.license = 'MIT'
|
18
18
|
|
19
19
|
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
@@ -31,5 +31,7 @@ Gem::Specification.new do |spec|
|
|
31
31
|
spec.add_development_dependency 'inch'
|
32
32
|
spec.add_development_dependency 'simplecov', '~> 0.10'
|
33
33
|
spec.add_development_dependency 'pullreview-coverage'
|
34
|
-
|
34
|
+
|
35
|
+
# Depend on Ruby version
|
36
|
+
spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION > '2.0'
|
35
37
|
end
|
data/lib/confoog/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: confoog
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.4.
|
4
|
+
version: 0.4.5
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Seapagan
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2015-09-
|
11
|
+
date: 2015-09-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -185,7 +185,7 @@ files:
|
|
185
185
|
- lib/confoog.rb
|
186
186
|
- lib/confoog/status.rb
|
187
187
|
- lib/confoog/version.rb
|
188
|
-
homepage:
|
188
|
+
homepage: http://confoog.seapagan.net
|
189
189
|
licenses:
|
190
190
|
- MIT
|
191
191
|
metadata: {}
|