house_style 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1573476a3f4d373bcc6132043847a04a7e5b2c20
+  data.tar.gz: 62cd11dd3cc0929061beab267eeb091d04f3e731
+SHA512:
+  metadata.gz: 15354968b0a58855978283350283014b5d81ddec69d21924cf18a0db114a50249ea691f9afff8dd8184966f6f083d2439b14272188a9e8840417682b57052e2d
+  data.tar.gz: 157d8dfe82af737d320012674cbd822d7daec817f460a4cb43bed8c582509ee18aed2020ff580834cf3193ebab1282d66b8e414ee93c44fb36252717529f8b70

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+# This is the rubocop configuration file for this gem.
+# You probably shouldn't inherit from this in your own projects.
+# See the [README](README.md) for instructions on using `house_style`
+# style settings from within your own projects
+inherit_from: ruby/rubocop.yml

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/altmetric/house_style. 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.
+
+Pull requests are welcome for general changes such as:
+
+* Spelling and grammatical errors
+* Creation or amendment of extra descriptions of Rubocop rules
+* Support for new languages (e.g., JS, CoffeeScript, Sass, PHP)
+* Anything that helps the implementation of `house_style` in other projects
+
+However, for changes in the _house style_ itself (i.e., the various YAML files that amend, enable and disable rules) will generally only be accepted if they come from people within the Altmetric organisation.
+
+If the rules in `house_style` are not to your taste, you could override them in individual projects - but that kind of runs counter to the `house_style` ethos. Instead, fork this gem and run your own copy, changing your `Gemfile` accordingly:
+
+```ruby
+gem 'house_style', github: 'myorganisation/house_style'
+```
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Scott Matthewman
+
+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,55 @@
+# HouseStyle
+
+Be nice and consistent from project to project.
+
+This gem acts as a local repository for house style checkers for Ruby and Rails projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'house_style'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+For non-Rails projects, add the following to the top of your `.rubocop.yml` file:
+
+```yaml
+inherit_gem:
+  house_style: ruby/rubocop.yml
+```
+
+If your project is a Rails project, you should use the instruction below, which includes all the standard Ruby house styles, with Rails-specific cops:
+
+```yaml
+inherit_gem:
+  house_style: rails/rubocop.yml
+```
+
+
+## Development
+
+The gem has no executable code of its own, so there is no test suite to speak of.
+
+Before committing any changes, ensure that it conforms to its own rubocop settings.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing a new version
+
+Update the version number in `house_style.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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/altmetric/house_style. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'house_style'
+
+# 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

data/bin/setup

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

data/house_style.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'house_style'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Scott Matthewman']
+  spec.email         = ['scott@altmetric.com']
+
+  spec.summary       = 'A centralised store of house style rules'
+  spec.description   = 'Configuration files and other snippets to help you apply standards across multiple projects'
+  spec.homepage      = 'https://github.com/altmetric/house_style'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '~> 0.35.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/rails/rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../ruby/rubocop.yml
+
+AllCops:
+  RunRailsCops: true

data/ruby/configuration.yml

@@ -0,0 +1,27 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  RunRailsCops: false
+  UseCache: true
+
+  Include:
+    - '**/*.gemspec'
+    - '**/*.podspec'
+    - '**/*.jbuilder'
+    - '**/*.rake'
+    - '**/*.opal'
+    - '**/config.ru'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+    - '**/Guardfile'
+    - '**/Podfile'
+    - '**/Thorfile'
+    - '**/Vagrantfile'
+    - '**/Berksfile'
+    - '**/Cheffile'
+    - '**/Vagabondfile'
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/**/*'

data/ruby/metrics.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 120
+  Details: >-
+    If lines are too short, methods become hard to read because you must
+    constantly jump from line to line. If lines are too long, following
+    the flow can be hard because it becomes harder to scan back and
+    locate the start of the next line. 80 characters is generally a bit
+    too short; 120 characters is a good compromise.
+Metrics/MethodLength:
+  Max: 10
+

data/ruby/rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from:
+  - ./configuration.yml
+  - ./metrics.yml
+  - ./style.yml

data/ruby/style.yml

@@ -0,0 +1,58 @@
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+    - before
+    - given
+    - given!
+    - watch
+    - times
+    - try
+    # logger methods that can take blocks
+    - debug
+    - error
+    - info
+    - warning
+    # Rubocop defaults which may otherwise be overwritten
+    - let
+    - let!
+    - subject
+    - watch
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+  Details: >-
+    When the last (or only) argument to a method is a Hash,
+    omit the { } braces. The exception is if the preceding
+    argument is also a Hash.
+Style/CollectionMethods:
+  Enabled: true
+Style/CommandLiteral:
+  EnforcedStyle: mixed
+Style/Copyright:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+Style/Encoding:
+  EnforcedStyle: when_needed
+Style/GuardClause:
+  MinBodyLength: 3
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+Style/IndentHash:
+  EnforcedStyle: consistent
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/MultilineOperationIndentation:
+  Enabled: false
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+Style/NumericLiterals:
+  MinDigits: 6
+Style/StringLiterals:
+  Enabled: false
+Style/StringMethods:
+  Enabled: true

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: house_style
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Matthewman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: Configuration files and other snippets to help you apply standards across
+  multiple projects
+email:
+- scott@altmetric.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- house_style.gemspec
+- rails/rubocop.yml
+- ruby/configuration.yml
+- ruby/metrics.yml
+- ruby/rubocop.yml
+- ruby/style.yml
+homepage: https://github.com/altmetric/house_style
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A centralised store of house style rules
+test_files: []