blue_steel 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5380af4e3107116fccabf7cdf28f97e6e579f8bf
+  data.tar.gz: 7246764080dc351c0f0a0ca840a8e74ce7705d90
+SHA512:
+  metadata.gz: bca8b7184a076d00d9411d9125c1a5f13089f8cc5124f5d78a3f752b2a494c6ec8500a5d9e56e5c9c4620e45fab196ad1d5116c2003ba5d60b6d1c76251ee619
+  data.tar.gz: 711a4abcb66fcba2901bdc5e8e2f4683f7a4a442809bce0ef423c86253d262740a6bb679f2eda6e6a7b5d432c0091dc7dbd2d36327d79f32f065a6c10867ac5c

data/README.md

@@ -0,0 +1,22 @@
+# Coding In Style
+
+We all recognize that style matters, and particularly that having _a_ consistent
+style matters more than _my_ or _your_ particular preference for a style (See
+Sandi Metz's _Looks Matter_). This repository contains the Apartment List style.
+
+# Installation
+
+See each directory for installation in that language:
+- [Ruby](/ruby)
+
+# Changing Style
+
+Thrash is anathema to consistency, so we are making it very difficult to change
+styles. Consider it a Constitution. We all agreed on it hundreds of years ago,
+and though everyone has some gripes with it, it's pretty good and we're leaving
+it alone.
+
+Since we're intentionally making it difficult to change, I'm only going to give
+you one criterion to consider when you want to propose a change:
+
+1. The style is probably not going to change, and that's ok!

data/ruby/README.md

@@ -0,0 +1,52 @@
+# Installation
+
+1. Add these gems to your `Gemfile`, most likely just in the `development`
+   group:
+
+    - [`rubocop`](https://github.com/bbatsov/rubocop) - The base rules, more or
+      less agreed upon by the Ruby community.
+    - [`rubocop-rspec`](https://github.com/backus/rubocop-rspec) - More
+      customized rules for the `spec/` directory, where RSpec's DSL is more
+      valuable than "normal" Ruby style.
+    - [`rubocop-git`](https://github.com/m4i/rubocop-git) - This lets you run
+      style checks on just your changes, so you're not responsible for a whole
+      history of accumulated style mishaps.
+
+2. Copy the minimal Rubocop configuration to your repository:
+
+    ```
+    cp style/ruby/sample.yml my_app/.rubocop.yml
+    ```
+
+    This file does little more than inherit from `global.yml`, which allows us
+    to configure and change global style in a single place.
+
+3. Add this pattern to your repo's `.gitignore`:
+
+    ```
+    .rubocop-http*yml
+    ```
+
+    When Rubocop inherits from a URL, it downloads and caches the file locally
+    so you don't have to hit the network every time. There's no need for that
+    cache to be committed to the repository or clutter `git status`.
+
+4. Install the Rake tasks:
+
+    ```
+    cp style/ruby/lib/tasks/style.rake my_app/lib/tasks/
+    ```
+
+    This provides you three Rake tasks:
+    - `style:branch` - Runs style checks only on your diff from `master`
+    - `style:all` - Runs all style checks
+    - `style:count` - Prints counts of all style violations
+
+5. Set your `Rakefile` default to include style checks:
+
+    ```
+    task default: %i[spec style:branch]
+    ```
+
+    Style checks will only run if specs passed, so you don't have to worry about
+    pretty code until you have working code.

data/ruby/blue_steel/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/ruby/blue_steel/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: global.yml

data/ruby/blue_steel/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blue_steel.gemspec
+gemspec

data/ruby/blue_steel/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cameron Irmas
+
+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/ruby/blue_steel/README.md

@@ -0,0 +1,51 @@
+# BlueSteel
+
+We all recognize that style matters, and particularly that having _a_ consistent
+style matters more than _my_ or _your_ particular preference for a style (See
+Sandi Metz's _Looks Matter_). This repository contains the Apartment List style.
+
+### Changing Style
+
+Thrash is anathema to consistency, so we are making it very difficult to change
+styles. Consider it a Constitution. We all agreed on it hundreds of years ago,
+and though everyone has some gripes with it, it's pretty good and we're leaving
+it alone.
+
+Since we're intentionally making it difficult to change, I'm only going to give
+you one criterion to consider when you want to propose a change:
+
+1. The style is probably not going to change, and that's ok!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blue_steel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blue_steel
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blue_steel.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/ruby/blue_steel/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+load 'lib/tasks/style.rake'
+task default: %i[style:branch]
+
+task :environment do
+end

data/ruby/blue_steel/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blue_steel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/ruby/blue_steel/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ruby/blue_steel/blue_steel.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "blue_steel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "blue_steel"
+  spec.version       = BlueSteel::VERSION
+  spec.authors       = ["Cameron Irmas"]
+  spec.email         = ["cirmas@apartmentlist.com"]
+
+  spec.summary       = %q{Apartment List's internal coding style guide}
+  spec.homepage      = "https://github.com/apartmentlist/style/tree/master/ruby/blue_steel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop-git", "~> 0.1"
+  spec.add_dependency "rubocop-rspec", "~> 1.15"
+  spec.add_dependency "rubocop", "~> 0.36"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/ruby/blue_steel/global.yml

@@ -0,0 +1,81 @@
+require: rubocop-rspec
+
+AllCops:
+  # Ruby files that are otherwise missed, since default is just *.rb
+  Include:
+    - config.ru
+    - Gemfile
+    - Rakefile
+  # Files that aren't helpful to check, even if they're Ruby
+  Exclude:
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+
+CollectionMethods:
+  PreferredMethods:
+    collect: map
+    inject: reduce
+    # Avoid confusion with ActiveRecord methods
+    find_all: select
+    find: detect
+
+FileName:
+  Exclude:
+    - Guardfile # Like Rakefile
+
+# Default is 79, a whole 1.25% reduction in usable space!
+LineLength:
+  Max: 80
+
+# RSpec's DSL leads to long blocks, and that's ok
+Metrics/BlockLength:
+  ExcludedMethods: ['context', 'describe', 'shared_examples']
+
+# Don't require underscores in long numbers, eg. 123_456_789.
+# We often have IDs, not "numbers".
+NumericLiterals:
+  Enabled: false
+
+# We've set RSpec to infer_spec_type_from_file_location!, but RuboCop doesn't
+# have access to that config. Rather than have to tag everything `type: :view`,
+# just ignore the cop for those specs.
+RSpec/DescribeClass:
+  Exclude:
+    - spec/views/**/*_spec.rb
+
+# The default is not_to, but we've historically used to_not basically 100% of
+# the time. There doesn't appear to be a particular reason one is better, and
+# it's not worth changing.
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+# Don't force single line blocks to name their block arguments things like
+# |a, e| for accumulator, element. Eg:
+#
+#   things.reduce { |a, e| ... }
+#
+# We have more semantic context than Rubocop, so there's no reason it should be
+# dictating our variable names.
+SingleLineBlockParams:
+  Enabled: false
+
+# Migrations are particularly self-explanatory, so there's very little reason to
+# write class documentation for them.
+Style/Documentation:
+  Exclude:
+    - db/migrate/*.rb
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    # Prefer [] for things that are arrays
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+    # Prefer () otherwise
+    '%':  '()'
+    '%q': '()'
+    '%Q': '()'
+    '%r': '()'
+    '%s': '()'
+    '%x': '()'

data/ruby/blue_steel/lib/blue_steel/railtie.rb

@@ -0,0 +1,9 @@
+# Allows Rails to load the style tasks
+module BlueSteel
+  # Inherits from Railtie
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/style.rake'
+    end
+  end
+end

data/ruby/blue_steel/lib/blue_steel/version.rb

@@ -0,0 +1,3 @@
+module BlueSteel
+  VERSION = '0.1.1'.freeze
+end

data/ruby/blue_steel/lib/blue_steel.rb

@@ -0,0 +1,7 @@
+require 'blue_steel/version'
+require 'blue_steel/railtie' if defined?(Rails)
+
+# Top level module
+module BlueSteel
+  # Your code goes here...
+end

data/ruby/blue_steel/lib/tasks/style.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# No need to have Rubocop in production, so be careful loading it.
+begin
+  require 'rubocop/git/cli'
+rescue LoadError
+  puts <<-MSG
+    Warning: RuboCop::Git is not available.
+    Run `gem install rubocop-git` or add it to your Gemfile
+  MSG
+end
+
+namespace :style do
+  desc 'Run style checks for the entire repository'
+  task all: :environment do
+    system('rubocop --display-cop-names')
+  end
+
+  desc 'Run style checks on your diff from `master`'
+  task branch: :environment do
+    RuboCop::Git::CLI.new.run(%w[--display-cop-names master])
+  end
+
+  desc 'Print total violation counts'
+  task count: :environment do
+    puts `
+      rubocop --display-cop-names |
+      grep -oE '[CW]: [^:]+'      | # Extract "C: Thing/YouBroke"
+      sort                        |
+      uniq -c                     |
+      sort -rn
+    `
+  end
+end

data/ruby/global.yml

@@ -0,0 +1,87 @@
+require: rubocop-rspec
+
+AllCops:
+  # Ruby files that are otherwise missed, since default is just *.rb
+  Include:
+    - config.ru
+    - Gemfile
+    - Rakefile
+  # Files that aren't helpful to check, even if they're Ruby
+  Exclude:
+    - 'db/schema.rb'
+    - 'node_modules/**/*'
+
+CollectionMethods:
+  PreferredMethods:
+    collect: map
+    inject: reduce
+    # Avoid confusion with ActiveRecord methods
+    find_all: select
+    find: detect
+
+FileName:
+  Exclude:
+    - Guardfile # Like Rakefile
+
+# Default is 79, a whole 1.25% reduction in usable space!
+LineLength:
+  Max: 80
+
+# RSpec's DSL leads to long blocks, and that's ok
+Metrics/BlockLength:
+  ExcludedMethods: ['context', 'describe', 'shared_examples']
+
+# Don't require underscores in long numbers, eg. 123_456_789.
+# We often have IDs, not "numbers".
+NumericLiterals:
+  Enabled: false
+
+# We've set RSpec to infer_spec_type_from_file_location!, but RuboCop doesn't
+# have access to that config. Rather than have to tag everything `type: :view`,
+# just ignore the cop for those specs.
+RSpec/DescribeClass:
+  Exclude:
+    - spec/views/**/*_spec.rb
+
+# The default is not_to, but we've historically used to_not basically 100% of
+# the time. There doesn't appear to be a particular reason one is better, and
+# it's not worth changing.
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+# Don't force single line blocks to name their block arguments things like
+# |a, e| for accumulator, element. Eg:
+#
+#   things.reduce { |a, e| ... }
+#
+# We have more semantic context than Rubocop, so there's no reason it should be
+# dictating our variable names.
+SingleLineBlockParams:
+  Enabled: false
+
+# Migrations are particularly self-explanatory, so there's very little reason to
+# write class documentation for them.
+Style/Documentation:
+  Exclude:
+    - db/migrate/*.rb
+
+# This requires us to parenthesize simple things like (a % 10).zero?, which
+# we've never done and find cumbersome without improving clarity. The community
+# doesn't appear to have a clear reason why one is superior.
+Style/NumericPredicate:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    # Prefer [] for things that are arrays
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+    # Prefer () otherwise
+    '%':  '()'
+    '%q': '()'
+    '%Q': '()'
+    '%r': '()'
+    '%s': '()'
+    '%x': '()'

data/ruby/lib/tasks/style.rake

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# No need to have Rubocop in production, so be careful loading it.
+begin
+  require 'rubocop/git/cli'
+rescue LoadError
+  puts <<-MSG
+    Warning: RuboCop::Git is not available.
+    Run `gem install rubocop-git` or add it to your Gemfile
+  MSG
+end
+
+namespace :style do
+  desc 'Run style checks for the entire repository'
+  task all: :environment do
+    system('rubocop --display-cop-names')
+  end
+
+  desc 'Run style checks on your diff from `master`'
+  task branch: :environment do
+    RuboCop::Git::CLI.new.run(%w[--display-cop-names master])
+  end
+
+  desc 'Print total violation counts'
+  task count: :environment do
+    puts `
+      rubocop --display-cop-names |
+      grep -oE '[CW]: [^:]+'      | # Extract "C: Thing/YouBroke"
+      sort                        |
+      uniq -c                     |
+      sort -rn
+    `
+  end
+end

data/ruby/sample.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/apartmentlist/style/master/ruby/global.yml

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: blue_steel
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cameron Irmas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- cirmas@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- ruby/README.md
+- ruby/blue_steel/.gitignore
+- ruby/blue_steel/.rubocop.yml
+- ruby/blue_steel/Gemfile
+- ruby/blue_steel/LICENSE.txt
+- ruby/blue_steel/README.md
+- ruby/blue_steel/Rakefile
+- ruby/blue_steel/bin/console
+- ruby/blue_steel/bin/setup
+- ruby/blue_steel/blue_steel.gemspec
+- ruby/blue_steel/global.yml
+- ruby/blue_steel/lib/blue_steel.rb
+- ruby/blue_steel/lib/blue_steel/railtie.rb
+- ruby/blue_steel/lib/blue_steel/version.rb
+- ruby/blue_steel/lib/tasks/style.rake
+- ruby/global.yml
+- ruby/lib/tasks/style.rake
+- ruby/sample.yml
+homepage: https://github.com/apartmentlist/style/tree/master/ruby/blue_steel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Apartment List's internal coding style guide
+test_files: []