shugo 0.1.1

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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 629e5e978cd8aa39a9473dd699d6e6d19934a95d
4
+ data.tar.gz: 04356aeaa6055c5346921595ee73765da3cc0521
5
+ SHA512:
6
+ metadata.gz: 66abec890d40dd2996c0cabc14b995e28e3ae3e4f41eb33dfaa561bca4f1eb9a50bfa31f5096509f66fe6f5b3547d2cd65d7987d497dcd2f1e14175e94c33cf6
7
+ data.tar.gz: 3fc24bf47714c331464d6c2a7220abcb3acb9ade97e1802cdce80904dbb499dd249aac4bf5d876e8cb8a5a27249340d0dc8110b1114184442534a4f5afcc8458
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at andrew.markle@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in shugo.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Andrew Markle
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # Shugo
2
+
3
+ Shugo (守護) was a title, commonly translated as "governor", "protector" or "constable", given to certain officials in feudal Japan. They were each appointed by the Shogun to oversee one or many provinces of Japan.
4
+
5
+ This gem uses [Rubocop](https://github.com/bbatsov/rubocop) to enforce Industrial's Ruby Style Guide across multiple projects.
6
+
7
+
8
+ ## Installation in Rails
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'shugo'
14
+ ```
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+
21
+ `shugo` comes with a Rails generator which can set up your rubocop files. With `shugo` declared in your Gemfile:
22
+
23
+ ```bash
24
+ $ rails generate shugo:install
25
+ ```
26
+
27
+ This will create `.rubocop.yml` file in your project root that inherits from the gem and also one
28
+ in the db/migrations with some rules that make sense for them.
29
+
30
+ Or you can just manually inherit from your `rubocop.yml` file.
31
+
32
+ ```yaml
33
+ inherit_gem:
34
+ shugo: rails/rubocop.yml
35
+ ```
36
+
37
+ ## Installation in Ruby
38
+
39
+ For gems and non-Rails projects, add the following to the top of your `.rubocop.yml` file:
40
+
41
+ ```yaml
42
+ inherit_gem:
43
+ shugo: ruby/rubocop.yml
44
+ ```
45
+
46
+ ### Releasing a new version
47
+
48
+ Update the version number in `shugo.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
49
+
50
+ ## Contributing
51
+
52
+ Bug reports and pull requests are welcome on GitHub at https://github.com/altmetric/shugo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
53
+
54
+ ## License
55
+
56
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
57
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << 'test'
6
+ t.libs << 'lib'
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "shugo"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,25 @@
1
+ require 'rails/generators'
2
+ require 'rails/generators/base'
3
+
4
+ module Shugo
5
+ # Installs the rubocop.yml files into a rails project that inherits from this gem.
6
+ class InstallGenerator < Rails::Generators::Base
7
+ def self.source_root
8
+ @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
9
+ end
10
+
11
+ def create_root_rubocop_yml
12
+ template 'rubocop.yml', '.rubocop.yml'
13
+ end
14
+
15
+ def create_db_migrate_rubocop_yml
16
+ template 'db_migrate_rubocop.yml', 'db/migrate/.rubocop.yml' if Dir.exist?(db_path)
17
+ end
18
+
19
+ private
20
+
21
+ def db_path
22
+ File.join(Rails.root, 'db')
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,3 @@
1
+ inherit_from: ../../.rubocop.yml
2
+ inherit_gem:
3
+ house_style: rails/db_migrate.yml
@@ -0,0 +1,2 @@
1
+ inherit_gem:
2
+ shugo: rails/rubocop.yml
@@ -0,0 +1,3 @@
1
+ module Shugo
2
+ VERSION = '0.1.1'
3
+ end
data/lib/shugo.rb ADDED
@@ -0,0 +1,5 @@
1
+ require "shugo/version"
2
+
3
+ module Shugo
4
+ # Your code goes here...
5
+ end
@@ -0,0 +1,16 @@
1
+ Metrics/ClassLength:
2
+ Enabled: false
3
+ Metrics/LineLength:
4
+ Enabled: false
5
+ Metrics/MethodLength:
6
+ Enabled: false
7
+ Style/BlockDelimiters:
8
+ Enabled: false
9
+ Style/Documentation:
10
+ Enabled: false
11
+ Style/EmptyLineBetweenDefs:
12
+ Enabled: false
13
+ Style/StringLiterals:
14
+ Enabled: false
15
+ Metrics/AbcSize:
16
+ Enabled: false
data/rails/rubocop.yml ADDED
@@ -0,0 +1,20 @@
1
+ inherit_from: ../ruby/rubocop.yml
2
+ AllCops:
3
+ Exclude:
4
+ - 'db/schema.rb'
5
+ Rails:
6
+ Enabled: true
7
+
8
+ # Exclude documentation for classes where it's unnecessary
9
+ Style/Documentation:
10
+ Description: 'Document classes and non-namespace modules.'
11
+ Enabled: true
12
+ Exclude:
13
+ - 'test/**/*'
14
+ - 'app/models/**/*'
15
+ - 'app/controllers/**/*'
16
+ - 'app/serializers/**/*'
17
+
18
+ # Don't enforce delegation. Use only when it makes sense.
19
+ Rails/Delegate:
20
+ Enabled: false
data/ruby/rubocop.yml ADDED
@@ -0,0 +1,39 @@
1
+ # Rubocop setup based off of the Ruby Style Guide:
2
+ # https://github.com/bbatsov/ruby-style-guide
3
+ #
4
+ # Rubocop configuration and instructions:
5
+ # https://github.com/bbatsov/rubocop/blob/master/config/
6
+
7
+ AllCops:
8
+ DisplayCopNames: true
9
+ DisplayStyleGuide: true
10
+ ExtraDetails: true
11
+ UseCache: true
12
+
13
+ Exclude:
14
+ - 'vendor/**/*'
15
+ - 'bin/**/*'
16
+ - 'test/fixtures/**/*'
17
+ - 'tmp/**/*'
18
+
19
+ # Outdent private/protected/public so it's easy to read & indentify
20
+ Style/AccessModifierIndentation:
21
+ EnforcedStyle: outdent
22
+
23
+ # Projects that have a migration path to Ruby 3+ should have this enabled
24
+ Style/FrozenStringLiteralComment:
25
+ Enabled: false
26
+
27
+ Metrics/BlockLength:
28
+ Exclude:
29
+ - 'Rakefile'
30
+ - '**/*.rake'
31
+ - 'test/**/*.rb'
32
+
33
+ # Prefers [:this, :array] instead of %i(this array)
34
+ Style/SymbolArray:
35
+ EnforcedStyle: brackets
36
+
37
+ # Not too little, but not too much.
38
+ Metrics/LineLength:
39
+ Max: 120
data/shugo-0.1.0.gem ADDED
Binary file
data/shugo.gemspec ADDED
@@ -0,0 +1,42 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'shugo/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'shugo'
8
+ spec.version = Shugo::VERSION
9
+ spec.authors = ['Andrew Markle']
10
+ spec.email = ['andrew.markle@gmail.com']
11
+
12
+ spec.summary = %q{Industrial Ruby Style Guide.}
13
+ spec.description = %q{Shugo (守護) was a title, commonly translated as "governor", "protector" or "constable", given to certain officials in feudal Japan. They were appointed by the Shogun to oversee one or more of the provinces of Japan.}
14
+ spec.homepage = 'https://github.com/industrialdev/shugo'
15
+ spec.license = 'MIT'
16
+
17
+ spec.post_install_message = <<-ENDOFMESSAGE
18
+ Make sure to inherit from shugo in your .rubocopy.yml file to get all the style goodness.
19
+
20
+ If you're in Rails:
21
+
22
+ inherit_gem:
23
+ house_style: ruby/rubocop.yml
24
+
25
+ or...if not in Rails
26
+
27
+ inherit_gem:
28
+ house_style: ruby/rubocop.yml
29
+
30
+ ENDOFMESSAGE
31
+
32
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
33
+ spec.bindir = 'exe'
34
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
35
+ spec.require_paths = ['lib']
36
+
37
+ spec.add_dependency 'rubocop', '~> 0.49.1'
38
+
39
+ spec.add_development_dependency 'bundler', '~> 1.12'
40
+ spec.add_development_dependency 'rake', '~> 10.0'
41
+ spec.add_development_dependency 'minitest', '~> 5.0'
42
+ end
metadata ADDED
@@ -0,0 +1,132 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shugo
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Andrew Markle
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-06 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.49.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.49.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.12'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.12'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: minitest
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '5.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '5.0'
69
+ description: Shugo (守護) was a title, commonly translated as "governor", "protector"
70
+ or "constable", given to certain officials in feudal Japan. They were appointed
71
+ by the Shogun to oversee one or more of the provinces of Japan.
72
+ email:
73
+ - andrew.markle@gmail.com
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".gitignore"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - lib/generators/shugo/install_generator.rb
87
+ - lib/generators/shugo/templates/db_migrate_rubocop.yml
88
+ - lib/generators/shugo/templates/rubocop.yml
89
+ - lib/shugo.rb
90
+ - lib/shugo/version.rb
91
+ - rails/db_migrate.yml
92
+ - rails/rubocop.yml
93
+ - ruby/rubocop.yml
94
+ - shugo-0.1.0.gem
95
+ - shugo.gemspec
96
+ homepage: https://github.com/industrialdev/shugo
97
+ licenses:
98
+ - MIT
99
+ metadata: {}
100
+ post_install_message: |+
101
+ Make sure to inherit from shugo in your .rubocopy.yml file to get all the style goodness.
102
+
103
+ If you're in Rails:
104
+
105
+ inherit_gem:
106
+ house_style: ruby/rubocop.yml
107
+
108
+ or...if not in Rails
109
+
110
+ inherit_gem:
111
+ house_style: ruby/rubocop.yml
112
+
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.5.1
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: Industrial Ruby Style Guide.
132
+ test_files: []