renuo-bin-check 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 202e3b412e3df80b06111b7b2b2258216bb6d787
+  data.tar.gz: 6e5b397dbb112bd0815246f5f87b86f4f8d42a01
+SHA512:
+  metadata.gz: 8370dcb55c014cc6037104c61a5075393e1ac886ca6b886a81860d4801ced4c4d763e26c1558124cacf7e80001c3e78b1bb02913be071430b7cd47b3f0177a46
+  data.tar.gz: e204c67f5f9b2d2a5914f1da1aba397fe12228f24d16b1210ee1ca99840eb785223848e812632bb01a6d542e46afcb1dfe1161f069ce32cf67df11d7e68c993d

data/.codeclimate.yml

@@ -0,0 +1,33 @@
+---
+engines:
+  brakeman:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.erb"
+  - "**.haml"
+  - "**.rb"
+  - "**.rhtml"
+  - "**.slim"
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+exclude_paths:- spec/

data/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

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

data/.reek

@@ -0,0 +1,18 @@
+---
+IrresponsibleModule:
+  enabled: false
+Attribute:
+  enabled: false
+"app/helpers":
+  UtilityFunction:
+    enabled: false
+
+exclude_paths:
+  - tmp
+  - spec
+  - vendor
+  - log
+  - coverage
+  - config
+  - bin
+  - db/migrate

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Rails:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/NonNilCheck:
+  IncludeSemanticChanges: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+    - 'vendor/bundle/**/*'
+    - 'lib/renuo-bin-check.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,32 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+addons:
+  apt:
+    packages:
+    - zsh
+  postgresql: '9.4'
+  code_climate:
+    repo_token: c578db3d0b7d0bc01f2331b4027f54fbc0de43ede5a4c93646bf4957d3c1d962
+services:
+  - postgresql
+bundler_args: --jobs=3 --retry=3
+cache:
+  bundler: true
+  apt: true
+  directories:
+    - coverage
+    - node_modules
+before_install:
+  - export TZ=Europe/Zurich
+before_script:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+  - cp spec/code_climate.travis.rb spec/code_climate.rb
+# if you need tsd  - echo {\"token\":\"$TSDRC_TOKEN\"} > .tsdrc
+script: bin/setup
+notifications:
+  email:
+    on_success: change
+    on_failure: always

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## Version 0.0.0
+
+First release after 10 days of planning and developing. Main functionality is implemented.
+There is a known bug and it is not recommanded to use this version.
+
+## Version 0.1.0
+
+This release should make it possible to actually use the Gem:
+
+* known Bugs are fixed
+
+* New feature: Results can be reversed
+  * mark the script you configure as reversed if you want
+  * Output will be Error-Output
+  * Error-Output will be Output
+  * Exit code > 0 will be 0
+  * Exit code 0 will be 1
+  
+
+
+## Version 0.2.0
+
+In this release are more features implemented and the Gem is available in rubygems.org:
+
+* gem is generated and available on rubygems.org
+
+### New Features
+
+* Output will be shown if the Error-Ouput is empty, even though the Script failed.
+This was implemented as many Scripts use the Standard-Output for Outputs even if they fail.
+
+* Standard-Output can be appended or overridden
+
+* Error-Output can be appended or overridden
+
+* Default-Script for faster Configuration of a bin/check in rails applications

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,41 @@
+# Contributing
+
+### We love pull requests. Here's a quick guide.
+
+Fork, then clone the repo:
+```
+git clone git@github.com:your-username/renuo-bin-check.git
+```
+
+Set up your machine:
+```
+git checkout -b your-branch-name
+bin/setup
+```
+
+Make sure the tests pass:
+```
+bin/check
+```
+
+Make your change. Add tests for your change. Make the tests pass:
+```
+bin/check
+```
+
+Push to your fork and [submit a pull request][pr].
+```
+git push origin your-branch-name
+```
+
+[pr]: https://github.com/renuo/renuo-bin-check/compare/
+
+At this point you're waiting on us. We like to at least comment on pull requests within three business days
+(and, typically, one business day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Write tests.
+* Write a [good commit message][commit].
+
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Renuo GmbH
+
+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,142 @@
+[![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=master)](https://travis-ci.org/renuo/renuo-bin-check) [![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=develop)](https://travis-ci.org/renuo/renuo-bin-check)  [![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=testing)](https://travis-ci.org/renuo/renuo-bin-check) [![Code Climate](https://codeclimate.com/github/renuo/renuo-bin-check/badges/gpa.svg)](https://codeclimate.com/github/renuo/renuo-bin-check) [![Issue Count](https://codeclimate.com/github/renuo/renuo-bin-check/badges/issue_count.svg)](https://codeclimate.com/github/renuo/renuo-bin-check) [![Test Coverage](https://codeclimate.com/github/renuo/renuo-bin-check/badges/coverage.svg)](https://codeclimate.com/github/renuo/renuo-bin-check/coverage)
+# renuo-bin-check
+
+## Setup
+
+```
+git clone git@github.com:renuo/renuo-bin-check.git
+cd renuo-bin-check
+bin/setup
+```
+
+## Run Tests
+
+The following script will run rspec, rubocop, reek, scanner for debugging outputs and a scanner for TODOs
+
+```
+bin/check
+```
+
+Run automated tests only with: `rspec`
+
+Run Lining only: `rubocop`
+
+Run Code Smell detector only: `reek``
+
+## How To Use renuo-bin-check
+
+Install renuo-bin-check locally: see Setup
+
+Add renuo-bin-check to your Gemfile:
+
+```rb
+gem 'renuo-bin-check', path: '<path-to-renuo-bin-check>'
+```
+
+Create a file at any place you want. Usually it would be called bin/check though.
+
+You can now configure your scripts like that:
+
+```rb
+# Initialize bin-check
+require 'renuo-bin-check'
+
+bin_check = RenuoBinCheck::Initializer.new
+
+# add a script, do this for as many scripts as you would like to run
+bin_check.check do |config|
+  config.command "<a one line command or a path to a script>"
+  config.name "<name-of-script>"
+  config.files ['<path-to-file-1>', '<path-to-file-2>']
+  config.reversed_exit <true or false>
+end
+
+#run everything
+bin_check.run
+```
+
+### Options
+
+#### command
+
+This option is required. It is either a one-liner such as `ls -al` or a path to a script, that will be runned.
+If command is not configured, the program will raise a RuntimeError.
+
+#### name
+
+This option is optional. It makes it possible to configure the name of the script. 
+It will be used as folder name in the cache.
+
+If it is not set, the hashed command will be used as folder name in the cache.
+
+Attention: If you set the same name twice, it won't raise an error, 
+but it can cause unexpected behaviour, hence it is not recommanded to do so.
+
+#### files
+
+This option is optional. If configured the script output will be cached. You need to list all files in array form, 
+which influence the outcome of the configured script.
+
+Even though this option is optional, it is recommended to set it, as it can make a run much faster.
+
+#### success_message
+
+This option is optional. You can use it to override the standard output of a script or to append a further output.
+
+If you want to override it just write the message, that you want to be shown. If you want to append a message, start
+your message with a ```+```.
+
+#### error_message
+
+This option is optional. You can use it to override the error output of a script or to append a further output.
+
+If you want to override it just write the message, that you want to be shown. If you want to append a message, start
+your message with a ```+```.
+
+#### reversed_exit
+
+This option is optional. You can set it truthy or falsey. if not set it's automatically set falsey.
+
+If set to truthy, the output of the configured script will be reversed. Which means:
+* Error-Outputs will be Outputs
+* Outputs will be Error-Output
+* Exit Code of 0 will be 1
+* Exit Code of not-0 will be 0
+
+An example where this option is used, is the command that searches for TODOs. 
+The script should fail though if something is found and not if nothing is found.
+
+### Example
+
+The following example configures a script that looks for TODOs in a project.
+The configuration options can be called in any order.
+
+```rb
+bin_check.check do |config|
+  config.command "grep --exclude-dir='app/assets/typings/**' -i -r 'TODO'"\
+                  "app spec config db Rakefile README.md Gemfile"
+  config.name "todo-grepper"
+  config.files ['app/**/*', 'spec/**/*', 'config/**/*', 'db/**/*', 'Rakefile', 'README.md', 'Gemfile']
+  config.success_message "No TODO was found :)"
+  config.error_message "+TODO found! Please get rid of them"
+  config.reversed_exit true
+end
+```
+
+## Contribute
+
+If you would like to contribute, you're very welcome to.
+
+Please follow these instructions:
+
+https://github.com/renuo/renuo-bin-check/blob/develop/CONTRIBUTING.md
+
+https://github.com/renuo/renuo-bin-check/blob/develop/CODE_OF_CONDUCT.md
+
+## License
+
+Copyright (c) 2016 Renuo GmbH
+
+MIT License
+
+Read more: https://github.com/renuo/renuo-bin-check/blob/develop/LICENSE

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/check

@@ -0,0 +1,66 @@
+#!/bin/zsh
+
+source ~/.zshrc
+
+grep 'rack-mini-profiler' Gemfile.lock >> /dev/null
+if [ $? -eq 0 ]; then
+  echo 'rack-mini-profiler detected in Gemfile.lock.'
+  echo 'Please remove rack-mini-profiler from your Gemfile(.local), run bundle and commit again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r 'TODO' lib spec Gemfile
+if [ $? -eq 0 ]; then
+  echo 'TODOs found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r 'console.log' lib spec
+if [ $? -eq 0 ]; then
+  echo 'console.log found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r '  puts ' lib spec
+if [ $? -eq 0 ]; then
+  echo 'puts found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r '  puts(' lib spec
+if [ $? -eq 0 ]; then
+  echo 'puts found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r '  p ' lib spec
+if [ $? -eq 0 ]; then
+  echo 'p found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+grep --exclude-dir="lib/renuo_bin_check/default_scripts" -i -r '  p(' lib spec
+if [ $? -eq 0 ]; then
+  echo 'p found. Please fix them and try again, commit aborted'
+  exit 1
+fi
+
+bundle exec rubocop -D -c .rubocop.yml --fail-fast
+if [ ! $? -eq 0 ]; then
+  echo 'rubocop detected issues!'
+  bundle exec rubocop -a -D -c .rubocop.yml
+  echo 'Tried to auto correct the issues, but must be reviewed manually, commit aborted'
+  exit 1
+fi
+
+bundle exec reek
+if [ ! $? -eq 0 ]; then
+  echo 'reek detected code smells, commit aborted'
+  exit 1
+fi
+
+bundle exec rspec
+if [ ! $? -eq 0 ]; then
+  echo 'rspec did not run successfully, commit aborted'
+  exit 1
+fi