alpinelab-codestyle 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e002b181855a8142c04483917605a6360576787b819394290e3c4da762cced3f
-  data.tar.gz: 21c60ffe6445da80b0570032265665d99c67a7c4124180c3285c106789ba2851
+  metadata.gz: 628744994fc69aab7a1ff55eb49c0829477104e7ff84ea0bddfb88663a191375
+  data.tar.gz: af6dc45ea9c63ad60d7a095c84627d8cd41667bd596c5d8fed19934ba645b0aa
 SHA512:
-  metadata.gz: de5ad48ccfb31ae393f8896142ecdb161d707ace596194e6c7418b1937d0ffe3c9bca844c3b4841ec56197cb0d40a4f042ddfaf9238a3d079540e132d37ad594
-  data.tar.gz: 0b035ca6c1734b6474ff091655308b6e97968135fa0fca39667bffcba0229d7f184e6548e5ce5c4cacc61faafa102d4420585e64525bd0a93cff0ede6d83ae02
+  metadata.gz: c285da9851b4b8e1a72cf9d69392fbe822bd6bbdfa219015a507fcb1a395c7854016c686ceed6fd73f0068f88340dbca97d5bcbe17a8c2e9aad031ca88d967db
+  data.tar.gz: 80145ae9669899be70a046ec2e6ea7373220ca327cb11312e30861e9eff4a4feecf823aa6553dffe428e3200e2ec35eb581aa5220bfe719c81314357e3fde928

data/README.md

@@ -4,10 +4,11 @@ Code style used by AlpineLab in all our projects.
 
 ## Usage
 
-1. Add `rubocop` gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`):
+1. Add those gems to your `Gemfile` (or `gems.rb`, or `gems.deps.rb`):
 
     ```ruby
     group :development, :test do
+      gem "alpinelab-codestyle", "~> x.y", require: false
       gem "rubocop", "~> x.y", require: false
       gem "rubocop-md", "~> x.y", require: false
     end
@@ -16,53 +17,33 @@ Code style used by AlpineLab in all our projects.
     or install them manually:
 
     ```shell
-    gem install rubocop rubocop-md
+    gem install alpinelab-codestyle rubocop rubocop-md
     ```
 
-2. Add `alpinelab-codestyle` gem to your `Gemfile`
-(or `gems.rb`, or `gems.deps.rb`):
-
-    ```ruby
-    group :development, :test do
-      gem "alpinelab-codestyle", "~> x.y"
-    end
-    ```
-
-    or install it manually:
-
-    ```shell
-    gem install alpinelab-codestyle
-    ```
-
-3. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with:
+2. Create or prepend your Rubocop configuration (usually `.rubocop.yml`) with:
 
     ```yaml
     inherit_gem:
       alpinelab-codestyle:
         - config/default.yml
-        - config/rails.yml
+        - config/rails.yml # for Rails projects only
     ```
 
 ## Best practices
 
-Some conventions are adopted and enforced, in no particular order:
-
-1. Developer-specific configuration files must be git-ignored globally, _e.g._:
+Some conventions are adopted and enforced, but cannot be translated as Rubocop
+rules (or are not supposed to). You will find those conventions as Markdown
+files in the [`docs`](docs) directory of this project, organized by subject:
 
-    * `.ruby-{version,gemset}`
-    * `docker-compose.override.yml`
-
-2. Project-specific configuration files must be git-ignored per project, _e.g._:
-
-    * `config/database.yml`
+* [File structure and organisation](docs/files.md)
+* [Rails-specific conventions](docs/rails.md)
+* [HTTP API development guidelines](docs/http-api.md)
 
 ## Releases
 
 To release this very gem:
 
-1. Bump its version number in
-[`lib/alpine_lab/code_style/version.rb`](lib/alpine_lab/code_style/version.rb)
-according to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)
+1. Bump its version number in [`version.rb`] respecting [Semantic Versioning 2]
 
 2. Use Bundler Rake task to build, tag and push the gem:
 
@@ -70,13 +51,21 @@ according to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html)
     rake release
     ```
 
-    _(with Docker, you need to have configured both
-    [Git authentication](https://github.com/alpinelab/docker-ruby-dev/blob/latest/RECIPES.md#git-authentication)
-    and [Rubygems authentication](https://github.com/alpinelab/docker-ruby-dev/blob/latest/RECIPES.md#rubygems-authentication)
-    then you can run the same command with `docker-compose run app rake release`)_
+    _(using Docker, both [Git authentication] and [Rubygems authentication] must
+    be configured to run `docker-compose run app rake release`)_
 
 ## License
 
-This project is developed by [Alpine Lab](https://www.alpine-lab.com) and released under the terms of the [MIT license](LICENSE.md).
+This project is developed by [Alpine Lab] and released under the terms of the
+[MIT license].
+
+<a href="https://www.alpine-lab.com">
+  <img src=".github/alpinelab-logo.png" width="40%" />
+</a>
 
-<a href="https://www.alpine-lab.com"><img src=".github/alpinelab-logo.png" width="40%" /></a>
+[Alpine Lab]: https://www.alpine-lab.com
+[git authentication]: https://github.com/alpinelab/docker-ruby-dev/blob/latest/RECIPES.md#git-authentication
+[MIT license]: LICENSE.md
+[RubyGems authentication]: https://github.com/alpinelab/docker-ruby-dev/blob/latest/RECIPES.md#rubygems-authentication
+[Semantic Versioning 2]: https://semver.org/spec/v2.0.0.html
+[`version.rb`]: lib/alpine_lab/code_style/version.rb

data/config/default.yml

@@ -58,6 +58,9 @@ Style/Lambda:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alpinelab-codestyle
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - AlpineLab developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler