polishgeeks-dev-tools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2cfc9419ae8508626d77a5455eb886d1a89c20a
+  data.tar.gz: 413ff1e0091e908259ec11fcbda3856dff8f6c32
+SHA512:
+  metadata.gz: 5fe73b0e2f5e6cdd1312a020a10f4ee6d420cd42c5ef41fd32c0a325afda7ed2a89140a7720dbe1ad0d2eb3c3a836528923c4f967c4767612340eb55fddfb747
+  data.tar.gz: ae87dbbaa7e11a683a519702b8c6082aec66fa8f240ab11fb3cf40a8fa6627d4f219c4f4e27b017d86d1a945ed1614e62f18b0990ded21dddf6cb0264a2bfe73

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.idea
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+polishgeeks-dev-tools

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.2
+script:
+  - bundle exec rake

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,193 @@
+PATH
+  remote: .
+  specs:
+    polishgeeks-dev-tools (1.0.0)
+      brakeman
+      faker
+      haml-lint
+      mongoid-rspec
+      pry
+      rspec
+      rubocop
+      rubycritic (= 1.2.1)
+      shoulda
+      simplecov
+      timecop
+      yard
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (3.0.5)
+      erubis (~> 2.6)
+      fastercsv (~> 1.5)
+      haml (>= 3.0, < 5.0)
+      highline (~> 1.6.20)
+      multi_json (~> 1.2)
+      ruby2ruby (~> 2.1.1)
+      ruby_parser (~> 3.7.0)
+      sass (~> 3.0)
+      terminal-table (~> 1.4)
+    bson (3.2.1)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    connection_pool (2.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    faker (1.4.3)
+      i18n (~> 0.5)
+    fastercsv (1.5.5)
+    flay (2.4.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.2.1)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    haml (4.0.7)
+      tilt
+    haml-lint (0.13.0)
+      haml (~> 4.0)
+      rubocop (>= 0.25.0)
+      sysexits (~> 1.1)
+    highline (1.6.21)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    minitest (5.8.0)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-rspec (2.2.0)
+      mongoid (~> 4.0.0)
+      rake
+      rspec (~> 3.1)
+    moped (2.0.6)
+      bson (~> 3.0)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.11.2)
+    optionable (0.2.0)
+    origin (2.1.1)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    procto (0.0.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    reek (1.6.3)
+      parser (~> 2.2.0.pre.7)
+      rainbow (>= 1.99, < 3.0)
+      unparser (~> 0.2.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.33.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    ruby2ruby (2.1.4)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.7.1)
+      sexp_processor (~> 4.1)
+    rubycritic (1.2.1)
+      flay (= 2.4.0)
+      flog (= 4.2.1)
+      parser (>= 2.2.0, < 3.0)
+      reek (= 1.6.3)
+      ruby2ruby (>= 2.1.1, < 3.0)
+      virtus (~> 1.0)
+    sass (3.4.16)
+    sexp_processor (4.6.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sysexits (1.2.0)
+    terminal-table (1.5.2)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    timecop (0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unparser (0.2.4)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.2)
+      procto (~> 0.0.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  polishgeeks-dev-tools!
+  rake

data/README.md

@@ -0,0 +1,112 @@
+# PolishGeeks Dev Tools
+
+[![Build Status](https://travis-ci.org/polishgeeks/polishgeeks-dev-tools.png)](https://travis-ci.org/polishgeeks/polishgeeks-dev-tools)
+[![Code Climate](https://codeclimate.com/github/polishgeeks/polishgeeks-dev-tools/badges/gpa.svg)](https://codeclimate.com/github/polishgeeks/polishgeeks-dev-tools)
+
+Gem with a set of useful tools used when developing Ruby based applications.
+
+## Installation
+
+```ruby
+group :development, :test do
+  gem 'polishgeeks-dev-tools'
+end
+```
+
+## Setup
+
+There are multiple options you can set either to true or false. All of them are available with configurator. Please use it only for development and testing environments. This config should be put in config/initializers/polishgeeks_dev_tools.rb file.
+
+Note that all the options are turned on by default it depends on an app, which of the you should use.
+
+If you want to use DevTools with all the default settings, you don't need to create an initializer.
+
+### Rack apps (Sinatra)
+```ruby
+if %i( test development ).include?(App.environment)
+  PolishGeeks::DevTools.setup do |config|
+    # For example - lowering a simplecov_threshold
+    config.simplecov_threshold = 98
+  end
+end
+```
+### Rack apps (Rails)
+```ruby
+if %w( test development ).include?(Rails.env)
+  PolishGeeks::DevTools.setup do |config|
+    config.brakeman = true # Rails only
+    # You can disable any command that is executed by setting it to false
+    config.rubycritic = false
+  end
+end
+```
+
+### Available options
+
+Some options might be available only for given framework (Ruby on Rails, Sinatra, etc). Please refer to this table to
+determine, which you can use in your project:
+
+| Option                | Framework | Description                                                                           |
+|-----------------------|-----------|---------------------------------------------------------------------------------------|
+| brakeman              | Rails     | A static analysis security vulnerability scanner for Ruby on Rails                    |
+| rubocop               | -         | Used to check Ruby syntax according to our styling                                    |
+| expires_in            | -         | Checks if there are typos like expire_in, etc that might brake app caching            |
+| haml_lint             | -         | User to check HAML syntax in the app views                                            |
+| yard                  | -         | YARD documentation standards checking                                                 |
+| rspec_files_names     | -         | Checks if all the rspec files have proper sufix (_spec.rb)                            |
+| rspec_files_structure | -         | Checks if we have corresponding _spec.rb files for each app/ lib ruby file            |
+| tasks_files_names     | -         | Checks if all the tasks for Capistrano and Rake files have proper extensions          |
+| rspec                 | -         | Specs framework                                                                       |
+| coverage              | -         | Specs code coverage generator                                                         |
+| simplecov             | -         | Simplecov code coverage threshold checking                                            |
+| simplecov_threshold   | -         | Threshold level for code coverage                                                     |
+| examples_comparator   | -         | Compares yml *.example files with non-examples and checks if they have same structure |
+| rubycritic            | -         | Generates a RubyCritic for given project                                              |
+| allowed_extensions    | -         | Checks that all the files in ./config directory have an allowed extension             |
+| yml_parser            | -         | Checks that parameters of all yaml files in ./config directory have some value        |
+
+## Config options
+
+Some validators might accept additional config settings - please refer to this table for a description on how to use them:
+
+| Option                        | Validator             | Description                                              |
+|-------------------------------|-----------------------|----------------------------------------------------------|
+| rspec_files_structure_ignored | rspec_files_structure | You can provide an array of files that should be ignored |
+
+## Usage in any Rails/Ruby application
+
+Once you've set up all the options and a config initializer, please execute following command:
+
+```bash
+bundle exec rake polishgeeks:dev-tools:check
+```
+
+## Usage with other Ruby gems
+
+If you want to use this gem to check other gems quality, you will have to put following things in your gem Rakefile:
+
+```ruby
+require 'bundler'
+require 'rake'
+require 'polishgeeks-dev-tools'
+
+desc 'Self check using command maintained in this gem'
+task :check do
+  PolishGeeks::DevTools.setup do |config|
+    # Any config option you want to disable/enable
+    config.brakeman = false
+  end
+
+  PolishGeeks::DevTools::Runner.new.execute(
+    PolishGeeks::DevTools::Logger.new
+  )
+end
+
+task default: :check
+```
+
+And then from command line, run:
+
+```bash
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+require 'rake'
+require 'polishgeeks-dev-tools'
+
+desc 'Self check using command maintained in this gem'
+task :check do
+  PolishGeeks::DevTools.setup do |config|
+    config.brakeman = false
+    config.haml_lint = false
+    config.expires_in_files_ignored = %w(
+      lib/polishgeeks/dev-tools/command/expires_in.rb
+    )
+  end
+
+  PolishGeeks::DevTools::Runner.new.execute(
+    PolishGeeks::DevTools::Logger.new
+  )
+end
+
+task default: :check

data/config/haml-lint.yml

@@ -0,0 +1,74 @@
+skip_frontmatter: false
+
+linters:
+  ClassAttributeWithStaticValue:
+    enabled: true
+
+  ClassesBeforeIds:
+    enabled: false
+
+  ConsecutiveComments:
+    enabled: true
+
+  ConsecutiveSilentScripts:
+    enabled: true
+    max_consecutive: 2
+
+  EmptyScript:
+    enabled: true
+
+  HtmlAttributes:
+    enabled: true
+
+  ImplicitDiv:
+    enabled: true
+
+  LeadingCommentSpace:
+    enabled: true
+
+  LineLength:
+    enabled: false
+
+  MultilinePipe:
+    enabled: true
+
+  ObjectReferenceAttributes:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+    # These cops are incredibly noisy when it comes to HAML templates, so we
+    # ignore them.
+    ignored_cops:
+      - Lint/BlockAlignment
+      - Lint/EndAlignment
+      - Lint/Void
+      - Metrics/BlockNesting
+      - Metrics/LineLength
+      - Style/AlignParameters
+      - Style/AsciiComments
+      - Style/FileName
+      - Style/IfUnlessModifier
+      - Style/IndentationWidth
+      - Style/Next
+      - Style/SpaceBeforeComment
+      - Style/TrailingWhitespace
+      - Style/WhileUntilModifier
+
+  RubyComments:
+    enabled: true
+
+  SpaceBeforeScript:
+    enabled: true
+
+  TagName:
+    enabled: true
+
+  TrailingWhitespace:
+    enabled: true
+
+  UnnecessaryInterpolation:
+    enabled: true
+
+  UnnecessaryStringOutput:
+    enabled: true