advertilecop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 322ce47809d8b2c8453a58148640af7870b16770
+  data.tar.gz: 4fc02983121083ff851ef4e7b047b20b057379b2
+SHA512:
+  metadata.gz: 6ac365068ce22d5b3a48a79a9fee65036e2d3e11e3b35bb1d2481c6e4a828881dfff00204a92b67128d6759731bb0d9532ec0b906e4ee28a08571ecf5c898163
+  data.tar.gz: 9bc3535cac43151005b71072d5200919ffdbc9b16a7ce306229a39119d850cdd9a7f6b979f864062ca5aa2407663daf0674d8e187dd23efb0e0c6f16360c74e8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Mika Hel
+
+MIT License
+
+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,66 @@
+# AdvertileCop
+
+*20% MonkeyPatch, 80% YAML, 100% Style*
+
+AdvertileCop uses [RuboCop](https://github.com/bbatsov/rubocop) to enforce Advertile Mobiles's style guidelines.
+
+"What are the guidelines?", I hear you bellow. Well, [check out our commented settings file](https://github.com/Advertile/advertilecop/blob/master/lib/advertilecop.yml) for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'advertilecop', require: false
+
+And then execute:
+
+    $ bundle
+
+Or install it globally with:
+
+    $ gem install advertilecop
+
+## Usage
+
+In a Rakefile:
+
+```ruby
+require 'advertilecop/rake_task'
+AdvertileCop::RakeTask.new(:advertilecop)
+```
+
+This can be quite dramatic if you haven't been using a style checker previously and you have, say, 10 years of code written. Why not only lint files changed in the last N commits? This also makes advertilecop much faster in large codebases as you only have to lint recently changed files.
+
+```ruby
+require 'advertilecop/rake_task'
+AdvertileCop::RakeTask.new(:advertilecop) do |task|
+  task.patterns = advertilecop_files(5)
+  task.options = ['-D'] # Dispays name of failing cop in output. 
+  exit if task.patterns == []
+end
+
+def advertilecop_files(pedantry)
+  `git diff-tree --no-commit-id --name-only -r HEAD~#{pedantry} HEAD`
+    .split("\n").select { |f| f.match(/(\.rb\z)|Rakefile/) && File.exist?(f) && !f.match(/db/) }
+end
+```
+
+You can also use AdvertileCop stand-alone:
+
+```
+$ advertilecop
+```
+
+If you are introducing advertilecop to an existing project, or bumping the advertilecop version try:
+
+```
+$ advertilecop -a
+```
+Anything that can be auto corrected will be, this will save you a lot of time!
+
+## Configuring / Contributing
+
+1. You can't configure this, thats the point.
+2. If you need to change our style guidelines, update the `lib/advertilecop.yml` file and open a pull request.
+3. If you have a good reason to break the guidelines, you can [switch off the cop for the code like this.](https://github.com/bbatsov/rubocop#disabling-cops-within-source-code)
+4. Please don't open a pull request unless you work at Advertile Mobile

data/Rakefile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"
+require "advertilecop/rake_task"
+
+AdvertileCop::RakeTask.new(:advertilecop)
+
+task :advertilecop_cli do
+  sh "bin/advertilecop"
+end
+
+task default: [:advertilecop, :advertilecop_cli]
+task build: [:advertilecop, :advertilecop_cli]

data/advertilecop.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "advertilecop/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "advertilecop"
+  spec.version       = AdvertileCop::VERSION
+  spec.authors       = ["Mika Hel"]
+  spec.email         = ["mikael.henriksson@advertilemobile.com"]
+  spec.summary       = "Like RuboCop only for Advertile"
+  spec.description   = "RuboCop patched for to enforce the use of Advertile Style Guidelines"
+  spec.homepage      = "http://www.advertilemobile.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/bin/advertilecop

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + "/../lib")
+
+require "advertilecop"
+require "benchmark"
+
+cli = RuboCop::CLI.new
+result = 0
+
+time = Benchmark.realtime do
+  result = cli.run
+end
+
+puts "Finished in #{time} seconds" if cli.options[:debug]
+exit result

data/lib/advertilecop/rake_task.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require "rubocop/rake_task"
+
+module AdvertileCop
+  class RakeTask < RuboCop::RakeTask
+    def initialize(*args, &task_block) # rubocop:disable Metrics/AbcSize
+      setup_ivars(args)
+
+      desc "Run RuboCop" unless ::Rake.application.last_description
+
+      task(name, *args) do |_, task_args|
+        RakeFileUtils.send(:verbose, verbose) do
+          yield(*[self, task_args].slice(0, task_block.arity)) if block_given?
+          run_main_task(verbose)
+        end
+      end
+
+      setup_subtasks(name, *args, &task_block)
+    end
+
+    def run_cli(verbose, options)
+      require "advertilecop"
+      super(verbose, options)
+    end
+  end
+end

data/lib/advertilecop/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module AdvertileCop
+  VERSION = "0.0.1".freeze
+end

data/lib/advertilecop.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require "rubocop"
+
+module RuboCop
+  class ConfigLoader
+    class << self
+      def configuration_file_for(_target_dir)
+        File.join(File.realpath(File.dirname(__FILE__)), "advertilecop.yml")
+      end
+    end
+  end
+end

data/lib/advertilecop.yml

@@ -0,0 +1,74 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - !ruby/regexp /node_modules/
+    - !ruby/regexp /db\/schema\.rb/
+    - 'vendor/bundle/**/*'
+
+Documentation:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 120
+  IgnoreCopDirectives: true
+  Enabled: true
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 10
+  Enabled: true
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+  Enabled: true
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Max: 7
+  Enabled: true
+
+Style/AlignParameters:
+  Enabled: true
+  EnforcedStyle: with_first_parameter
+
+Style/AndOr:
+  Enabled: true
+  EnforcedStyle: always
+
+Style/BlockDelimiters:
+  Enabled: true
+  EnforcedStyle: braces_for_chaining
+  IgnoredMethods:
+    - lambda
+    - proc
+    - it
+    - feature
+    - background
+    - describe
+    - context
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  # If `true`, strings which span multiple lines using `\` for continuation must
+  # use the same type of quotes on each line.
+  ConsistentQuotesInMultiline: true
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+  Enabled: true
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: advertilecop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mika Hel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: RuboCop patched for to enforce the use of Advertile Style Guidelines
+email:
+- mikael.henriksson@advertilemobile.com
+executables:
+- advertilecop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- advertilecop.gemspec
+- bin/advertilecop
+- lib/advertilecop.rb
+- lib/advertilecop.yml
+- lib/advertilecop/rake_task.rb
+- lib/advertilecop/version.rb
+homepage: http://www.advertilemobile.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Like RuboCop only for Advertile
+test_files: []