alpinelab-codestyle 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25e5d9ac090dfa7090f47183e41db77c4204ef915c5f9e62a99ad5c07b85965e
+  data.tar.gz: 94d609cc4399dc91d6cd6dd974912eccdb1392cf7877296c799576d087d44857
+SHA512:
+  metadata.gz: 1e92ec6ba82dabfc80622a2e814d519f346eb21dd33e4e55419354d6739431e00fbc5383d5769860ff2cccd42877ecb23bd1a3e266a220d168dac2976b406aa7
+  data.tar.gz: 59797909106f54f00d7148b1b5abeb09bb58d7497dd52465224f7e8b8e1e6e8803bed03f2ac88302ae49c4d55a67c82675f64719f98f5f4218b0df9e63e615c4

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Alpine Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# AlpineLab code style
+
+Code style used by AlpineLab in all our projects.
+
+## Usage
+
+1. Add this gem to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`):
+
+    ```ruby
+    group :development do
+      gem "alpinelab-codestyle", "~> x.y"
+    end
+    ```
+
+    or install it manually:
+
+    ```shell
+    gem install alpinelab-codestyle
+    ```
+
+2. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with:
+
+    ```yaml
+    inherit_gem:
+      alpinelab-codestyle:
+        - config/default.yml
+    ```
+
+## Best practices
+
+Some conventions are adopted and enforced, in no particular order:
+
+1. Developer-specific configuration files must be git-ignored globally, _e.g._:
+
+    * `.ruby-{version,gemset}`
+    * `docker-compose.override.yml`
+
+2. Project-specific configuration files must be git-ignored per project, _e.g._:
+
+    * `config/database.yml`
+
+## License
+
+This project is developed by [Alpine Lab](https://www.alpine-lab.com) and released under the terms of the [MIT license](LICENSE.md).
+
+<a href="https://www.alpine-lab.com"><img src=".github/alpinelab-logo.png" width="40%" /></a>

data/config/default.yml

@@ -0,0 +1,17 @@
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Style/AndOr:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: alpinelab-codestyle
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- AlpineLab developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  This repository holds linter rules (e.g. Rubocop) that enforce our code
+  style in any project (thanks to Rubocop `inherit_gem' directive) as well as
+  other conventions not transposable as automated rules (those are explained
+  as plain Markdown).
+email:
+- dahu@alpine-lab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- config/default.yml
+homepage: https://www.alpine-lab.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Code style used by AlpineLab
+test_files: []