bestie 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b736bca5e3a201bb31ec5de100af1ee0af915932
+  data.tar.gz: a736f5adafa4207bb6bd3b45612ddf42ae3c199c
+SHA512:
+  metadata.gz: 9bf70ed7993698c9be76f85ca0c35409dfeab5507bf83cd5c71b09a2b8be3121f11b0f9f2accc92279bed769124eb1ccccc4a554d6ee504f82d8d22e03fcd1a6
+  data.tar.gz: 69d9d3140e9ea834340e25159a729acb583a70305bce7c91b3571baf236ad646c11ea0f89b1e03ee7d5ab2204757d7c159a1bc683b5b096a1b8401768c826f29

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bestie.gemspec
+gemspec

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,8 @@
+Kicked off with:
+#### Description
+#### Testing Notes/Scenarios
+#### Cucumber Tests
+#### Not in Scope
+#### Downtime Release
+#### Release Notes
+Bestie: XXX

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Damir Svrtan
+
+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,59 @@
+[![Build Status](https://travis-ci.org/lonelyplanet/bestie.svg?branch=master)](https://travis-ci.org/lonelyplanet/bestie)
+
+# Bestie
+
+Utility gem to enforce generic best practice for rails application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bestie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bestie
+
+## Usage
+
+In applicaiton's `Rakefile`, add
+
+```
+load 'tasks/bestie.rake'
+```
+
+Rake tasks are available after including the gem:
+
+- [brakeman](https://github.com/presidentbeef/brakeman)
+- [debride](https://github.com/seattlerb/debride)
+- [fasterer](https://github.com/DamirSvrtan/fasterer)
+- [flay](https://github.com/seattlerb/flay)
+- [reek](https://github.com/troessner/reek)
+- [rubocop](https://github.com/bbatsov/rubocop)
+- [rubycritic](https://github.com/whitesmith/rubycritic)
+- `bestie` => run all :point_up: tasks to check ruby best practice
+
+## Configure individual quality check
+
+### RuboCop
+
+```
+bundle exec rails g rubo_cop:config
+```
+
+### SimpleCov
+
+```
+bundle exec rails g simple_cov:config
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lonelyplanet/bestie.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bestie.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bestie/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bestie'
+  spec.version       = Bestie::VERSION
+  spec.authors       = ['SPP Product Team']
+  spec.email         = ['atlas2ninjas@lonelyplanet.com.au']
+
+  spec.summary       = 'Utility gem to enforce rails application best practice'
+  spec.homepage      = 'https://github.com/lonelyplanet/bestie'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rubocop'
+  spec.add_runtime_dependency 'reek'
+  spec.add_runtime_dependency 'brakeman'
+  spec.add_runtime_dependency 'simplecov'
+  spec.add_runtime_dependency 'fasterer'
+  spec.add_runtime_dependency 'debride'
+  spec.add_runtime_dependency 'fray'
+  spec.add_runtime_dependency 'rubycritic'
+
+  spec.add_development_dependency 'rails', '~> 3.2.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bestie'
+
+# 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,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/config.reek

@@ -0,0 +1,2 @@
+IrresponsibleModule:
+  enabled: false

data/lib/bestie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'bestie/version'
+
+module Bestie
+  def self.root
+    File.dirname __dir__
+  end
+end

data/lib/bestie/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bestie
+  VERSION = '0.2.0'
+end

data/lib/generators/rubo_cop/config_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module RuboCop
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_default_config
+      copy_file '.rubocop.yml', '.rubocop.yml'
+    end
+  end
+end

data/lib/generators/rubo_cop/templates/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  Exclude:
+    - 'Gemfile'
+    - 'config/**/*'
+    - 'db/**/*'
+    - 'doc/**/*'
+    - 'log/**/*'
+    - 'public/**/*'
+    - 'script/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+Documentation:
+  Enabled: false

data/lib/generators/simple_cov/config_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module SimpleCov
+  class ConfigGenerator < Rails::Generators::Base
+    CONFIG_PATH = File.expand_path('../templates/config.rb', __FILE__)
+
+    def insert_configuration_to_spec_helper
+      prepend_file 'spec/spec_helper.rb' do
+        File.read(CONFIG_PATH)
+      end
+    end
+  end
+end

data/lib/generators/simple_cov/templates/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'config'
+  add_filter 'spec'
+  add_filter 'vendor'
+  coverage_dir 'target/reports/coverage'
+  minimum_coverage 100
+end
+
+# End of SimpleCov cofniguration

data/lib/tasks/bestie.rake

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+load 'tasks/rubocop.rake'
+load 'tasks/debride.rake'
+load 'tasks/flay.rake'
+load 'tasks/reek.rake'
+load 'tasks/brakeman.rake'
+load 'tasks/fasterer.rake'
+load 'tasks/rubycritic.rake'
+
+namespace :bestie do
+  task style: %i[
+    rubocop
+    rubycritic
+  ]
+
+  task smell: %i[
+    debride
+    flay
+    reek
+  ]
+
+  task security: [
+    :brakeman
+  ]
+
+  task performance: [
+    :fasterer
+  ]
+
+  task all: %i[
+    style
+    smell
+    security
+    performance
+  ]
+end
+
+task bestie: ['bestie:all']

data/lib/tasks/brakeman.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :brakeman do
+  task :run, :output_files do |_, args|
+    require 'brakeman'
+
+    files = args[:output_files].split(' ') if args[:output_files]
+    Brakeman.run app_path: '.', output_files: files, print_report: true
+  end
+end
+
+task brakeman: ['brakeman:run']

data/lib/tasks/debride.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+task :debride do
+  require 'debride'
+
+  Debride.run(['lib']).report
+end

data/lib/tasks/fasterer.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'fasterer/file_traverser'
+
+task :fasterer do
+  file_traverser = Fasterer::FileTraverser.new('.')
+  file_traverser.traverse
+  # abort if file_traverser.offenses_found?
+end

data/lib/tasks/flay.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+task :flay do
+  require 'flay'
+
+  ARGV.clear
+  Flay.run.report
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+task :reek do
+  require 'reek/rake/task'
+
+  source_files = FileList.new('lib/**/*.rb', 'app/**/*.rb', 'spec/**/*.rb')
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+    t.source_files  = source_files
+  end
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+task :rubocop do
+  require 'rubocop/rake_task'
+
+  RuboCop::RakeTask.new
+end

data/lib/tasks/rubycritic.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+task :rubycritic do
+  require 'rubycritic/rake_task'
+
+  RubyCritic::RakeTask.new do |task|
+    task.paths = FileList['app/**/*.rb']
+    task.options = '--no-browser --path ./target/reports/rubycritic'
+  end
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: bestie
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- SPP Product Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-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: reek
+  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: brakeman
+  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: simplecov
+  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: fasterer
+  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: debride
+  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: fray
+  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: rubycritic
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: byebug
+  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: pry
+  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: 
+email:
+- atlas2ninjas@lonelyplanet.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- ISSUE_TEMPLATE.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bestie.gemspec
+- bin/console
+- bin/setup
+- config.reek
+- lib/bestie.rb
+- lib/bestie/version.rb
+- lib/generators/rubo_cop/config_generator.rb
+- lib/generators/rubo_cop/templates/.rubocop.yml
+- lib/generators/simple_cov/config_generator.rb
+- lib/generators/simple_cov/templates/config.rb
+- lib/tasks/bestie.rake
+- lib/tasks/brakeman.rake
+- lib/tasks/debride.rake
+- lib/tasks/fasterer.rake
+- lib/tasks/flay.rake
+- lib/tasks/reek.rake
+- lib/tasks/rubocop.rake
+- lib/tasks/rubycritic.rake
+homepage: https://github.com/lonelyplanet/bestie
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Utility gem to enforce rails application best practice
+test_files: []