shop_storm_cops 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed7b2b5ed1e389be21ff9a8f66ff41fdd8237d03
+  data.tar.gz: 513d649114ade19569d56efb42e911b15204ebec
+SHA512:
+  metadata.gz: bee5da9e744668b74e3b445a113b1ff298654726212f6ca1c15392ebe3d90664dfc87707531d049ccdd0fb9c2a42227d64844c6e5061aa8abf299af6efae0e80
+  data.tar.gz: 14256daf9fa5cd0cd1e6d9697b16858d7d6218170d813837157b1cefc246c4374849cc2ee5a55dbd4d4c4cb86bccdea0679a97c8bd02ec1a24222d11955d795f

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - lib/shop_storm_cops/rubocop/shared_cops.yml

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 SkyVerge
+
+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,77 @@
+# ShopStormCops
+
+ShopStormCops is a little library that integrates [RuboCop](https://github.com/bbatsov/rubocop) into your Ruby project, configured for following the coding conventions we use at [SkyVerge](https://www.skyverge.com/) ([ShopStorm](https://shopstorm.com/) division). It is planned to add more 3rd party coding style tools in the future.
+
+## Installation
+
+Add the gem into your Gemfile’s development and test groups:
+
+```ruby
+group :development, :test do
+  gem ‘shop_storm_cops’
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+### Rubocop integration
+
+ShopStormCops adds RuboCop as a dependency and provides you with a shared cop file based in the coding conventions of SkyVerge. For use it you should create a `.rubocop.yml` file into your root rails directory with the following content:
+
+```yml
+# .rubocop.yml file located into the root rails directory
+
+inherit_gem:
+  shop_storm_cops: lib/shop_storm_cops/rubocop/shared_cops.yml
+```
+
+With `inherit_gem`, you’re configuring RuboCop for inheriting from a file inside this actual gem. You can review the shared cops in [`shared_cops.yml`](lib/shop_storm_cops/rubocop/shared_cops.yml). Now you’re free to execute the RuboCop standalone command with:
+
+    $ bundle exec rubocop
+
+You’re free to configure your `.rubocop.yml` file for inheriting also from a local file, like from `.rubocop_todo.yml`, as it is the typical workflow. This is how it’d look:
+
+```yml
+# .rubocop.yml file located into the root rails directory
+
+inherit_gem:
+  shop_storm_cops: lib/shop_storm_cops/rubocop/shared_cops.yml
+
+inherit_from:
+  - .rubocop_todo.yml
+```
+
+The file inherited via `inherit_from` will have more preference than the one inherited from the gem, so the repeated Cops would be overwritten according to https://github.com/bbatsov/rubocop#inheriting-configuration-from-a-dependency-gem.
+
+#### Common commands
+
+* `bundle exec rubocop`: Run the conventions suite.
+* `bundle exec rubocop —auto-gen-config`: Automatically generates the `.rubocop_todo.yml` according to the current offences.
+* `bundle exec rubocop —auto-correct`: Auto correct the current offences automatically. Use with caution. Intensive revision of the changes and the run of the test suite will be needed after using the auto correction. Not all the Cops implement auto correction, only some of them.
+
+Take a look at the https://github.com/bbatsov/rubocop documentation for a more advanced use.
+
+## Future platforms to integrate
+
+* [Rails best practices](https://github.com/railsbp/rails_best_practices)
+
+## Contributing
+
+We follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) model:
+
+1. Check for issues of your interest or create a new one.
+1. Fork the repo ( http://github.com/skyverge/shopstorm-cops/fork ).
+1. Create your branch with a descriptive name, prefixed with the type (feature, chore, bug, release) and the related issue number. (`git checkout -b feature/my-new-feature`).
+1. Implement a test covering what you’re going to develop.
+1. Push your branch with your changes and send us a pull request.
+
+Many thanks! :)
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shop_storm_cops'
+
+# 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/lib/shop_storm_cops/rubocop/shared_cops.yml

@@ -0,0 +1,45 @@
+# Rubocop config file with the fundamentals SkyVerge's coding conventions which
+# need to be overwriten from the standard Rubocop conventions. This config file
+# is the one to inherit from on apps using this gem.
+
+AllCops:
+  RunRailsCops: true
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+
+# Lint Cops
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+# Style Cops
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/Documentation:
+  Enabled: false
+
+# Allow compact `Module::Class` style inside tests.
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/**/*'
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+# Disabled regex literal style cop which seems to not work properly. Forcing
+# 'EnforcedStyle: slashes' keeps raising offeses advising the use of '%r'.
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Sometimes we align first args when many related methods are called together
+# like in /config/routes.rb
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false

data/lib/shop_storm_cops/version.rb

@@ -0,0 +1,3 @@
+module ShopStormCops
+  VERSION = '0.1.0'
+end

data/lib/shop_storm_cops.rb

@@ -0,0 +1 @@
+require 'shop_storm_cops/version'

data/shop_storm_cops.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shop_storm_cops/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'shop_storm_cops'
+  spec.version  = ShopStormCops::VERSION
+  spec.authors  = ['Daniel Madrid', 'Hannes Benson', 'Jory Hatton',
+                   'Justin Stern', 'Max Rice']
+  spec.email    = ['help@shopstorm.com']
+  spec.summary  = 'Ruby coding convention tools used in ShopStorm'
+  spec.homepage = 'https://github.com/skyverge/shopstorm-cops'
+  spec.license  = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'rubocop', '~> 0.35'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: shop_storm_cops
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Madrid
+- Hannes Benson
+- Jory Hatton
+- Justin Stern
+- Max Rice
+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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: 
+email:
+- help@shopstorm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shop_storm_cops.rb
+- lib/shop_storm_cops/rubocop/shared_cops.yml
+- lib/shop_storm_cops/version.rb
+- shop_storm_cops.gemspec
+homepage: https://github.com/skyverge/shopstorm-cops
+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.0.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: Ruby coding convention tools used in ShopStorm
+test_files: []