defra_ruby_style 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +8 -0
- data/README.md +59 -0
- data/Rakefile +14 -0
- data/lib/defra/style/version.rb +7 -0
- data/lib/defra/style.rb +8 -0
- metadata +93 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 29b0b223aa2eeffdc62e2d839134a2c71db7a354
|
4
|
+
data.tar.gz: 602b2ce08954050f68f36f26dd2df67bedabb023
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1841e1547bb97ed4ae7ced8f608a4b22f103e0dd1640effb8ad483a47059e50bed83608aa5a058555da1ece901a977c9e72cb42a6d73b7dab69c021266e2a7fd
|
7
|
+
data.tar.gz: 7055b465fbca3f84a69b478090878a2690d1349bb2d43bf9c35bf0ae0521a0d96de1df91fc1a77594750d4769e95f1dd1bc2cabd78733983c6dd6714e01f6113
|
data/LICENSE
ADDED
@@ -0,0 +1,8 @@
|
|
1
|
+
The Open Government Licence (OGL) Version 3
|
2
|
+
|
3
|
+
Copyright (c) 2018 Environment Agency
|
4
|
+
|
5
|
+
This source code is licensed under the Open Government Licence v3.0. To view this
|
6
|
+
licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
|
7
|
+
or write to the Information Policy Team, The National Archives, Kew, Richmond,
|
8
|
+
Surrey, TW9 4DU.
|
data/README.md
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
<img src="/defra-ruby-style.png" alt="Defra ruby style logo" />
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-style.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-style)
|
4
|
+
|
5
|
+
This repository is used to manage the ruby code style we use at DEFRA.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add the following to your `Gemfile`
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
group :test, :development do
|
13
|
+
gem "defra_ruby_style"
|
14
|
+
end
|
15
|
+
```
|
16
|
+
|
17
|
+
And then update your dependencies by calling
|
18
|
+
|
19
|
+
```bash
|
20
|
+
bundle install
|
21
|
+
```
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
If your project hasn't got one, create the file `.rubocop.yml` in its root and add the following:
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
inherit_gem:
|
29
|
+
defra_ruby_style:
|
30
|
+
- default.yml
|
31
|
+
```
|
32
|
+
|
33
|
+
If it has just replace the existing content with this. Now you can run `rubocop` as usual.
|
34
|
+
|
35
|
+
```bash
|
36
|
+
bundle exec rubocop
|
37
|
+
```
|
38
|
+
|
39
|
+
## Contributing to this project
|
40
|
+
|
41
|
+
If you have an idea you'd like to contribute please log an issue.
|
42
|
+
|
43
|
+
All contributions should be submitted via a pull request.
|
44
|
+
|
45
|
+
## License
|
46
|
+
|
47
|
+
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
|
48
|
+
|
49
|
+
http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
|
50
|
+
|
51
|
+
The following attribution statement MUST be cited in your products and applications when using this information.
|
52
|
+
|
53
|
+
> Contains public sector information licensed under the Open Government license v3
|
54
|
+
|
55
|
+
### About the license
|
56
|
+
|
57
|
+
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
|
58
|
+
|
59
|
+
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.
|
data/Rakefile
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
begin
|
4
|
+
require "bundler/setup"
|
5
|
+
rescue LoadError
|
6
|
+
puts "You must `gem install bundler` and `bundle install` to run rake tasks"
|
7
|
+
end
|
8
|
+
|
9
|
+
Bundler::GemHelper.install_tasks
|
10
|
+
|
11
|
+
require "github_changelog_generator/task"
|
12
|
+
|
13
|
+
GitHubChangelogGenerator::RakeTask.new :changelog do |config|
|
14
|
+
end
|
data/lib/defra/style.rb
ADDED
metadata
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: defra_ruby_style
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Defra
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-01-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rubocop
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: github_changelog_generator
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: A gem to simplify the process of ensuring ruby based Defra projects are
|
56
|
+
using our agreed coding style and standards.
|
57
|
+
email:
|
58
|
+
- alan.cruikshanks@environment-agency.gov.uk
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- LICENSE
|
64
|
+
- README.md
|
65
|
+
- Rakefile
|
66
|
+
- lib/defra/style.rb
|
67
|
+
- lib/defra/style/version.rb
|
68
|
+
homepage: https://github.com/DEFRA/defra-ruby-style
|
69
|
+
licenses:
|
70
|
+
- The Open Government Licence (OGL) Version 3
|
71
|
+
metadata:
|
72
|
+
allowed_push_host: https://rubygems.org
|
73
|
+
post_install_message:
|
74
|
+
rdoc_options: []
|
75
|
+
require_paths:
|
76
|
+
- lib
|
77
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - ">="
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '0'
|
82
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
83
|
+
requirements:
|
84
|
+
- - ">="
|
85
|
+
- !ruby/object:Gem::Version
|
86
|
+
version: '0'
|
87
|
+
requirements: []
|
88
|
+
rubyforge_project:
|
89
|
+
rubygems_version: 2.6.13
|
90
|
+
signing_key:
|
91
|
+
specification_version: 4
|
92
|
+
summary: Defra ruby coding standards
|
93
|
+
test_files: []
|