massa 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d050a750692a0d7575d8ace635776d83cd31f6c6
-  data.tar.gz: d6efc60953e32aa8eacace97ac64a07d452b9c7b
+  metadata.gz: c2ba08bdec35891e253256b7ba9886ba361d72d2
+  data.tar.gz: 1f9e9b2cb0b09545e2f87e53b32fd8015b5a674f
 SHA512:
-  metadata.gz: d99d7854705f604d82aea1f6b160301033de8980a558f3ac935ff2155c334a93759ed5ea5f1c7484459c37c600c7cbf515837d89c16d53e634d4a8683bcf60bc
-  data.tar.gz: 6d2c31cd9718bec759d0018de7c6aa71bf6cf6dff899923547cc91acb5f0dc06be795eb44543556511b40a3590b9076f52e4af52a353391940321cca0a188822
+  metadata.gz: 0d6f304f6f0dc662fd5d171c8b47e8126a49835b6fcf419a98750efc36c8e3d7a0e1707590b824ee361ede8cb0a8f267a68dd2f5ee8eb498f28423c7078095b6
+  data.tar.gz: a263467e79bf57730572ce65a39dc8f2202482d8ac8dd654024a80589acac0a1002b663655b14aa8dce9dff0ef2e687efe30780b7a8b193a83c6a246aed207bc

data/README.md

@@ -2,13 +2,13 @@
 
 [![Gem Version](https://badge.fury.io/rb/massa.svg)](https://rubygems.org/gems/massa)
 [![Build Status](https://travis-ci.org/lucascaton/massa.svg?branch=master)](https://travis-ci.org/lucascaton/massa)
-[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/lucascaton/massa.svg)](https://codeclimate.com/github/lucascaton/massa)
+[![Test Coverage](https://codeclimate.com/github/lucascaton/massa/badges/coverage.svg)](https://codeclimate.com/github/lucascaton/massa/coverage)
 [![Code Climate](https://codeclimate.com/github/lucascaton/massa/badges/gpa.svg)](https://codeclimate.com/github/lucascaton/massa)
 
-It's common to see Ruby (and Rails) projects becomming hard to maintain and less fun after a while.
-This gem helps you to keep its quality, good practices and security.
+It's not rare to have Ruby (and Rails) projects becomming hard to maintain and less fun after a while.
+This gem helps you to keep or increase the quality, good practices and security of your projects.
 
-**Massa** can run in your CI and it will run different code analyzers tools, instead of only running your automated tests.
+**Massa** can run in your CI using different code analyzers tools along with automated tests, instead of running only your automated tests.
 
 You can either use only the [default tools](https://github.com/lucascaton/massa/blob/master/config/default_tools.yml) or adding custom ones by using a [simple config file](https://github.com/lucascaton/massa#usage).
 
@@ -34,11 +34,11 @@ And then execute:
 
 ## Usage
 
-Create a configuration file:
+Generate a config file:
 
-    $ ... # TODO
+    $ bundle exec massa -g
 
-Then, run
+Then, run:
 
     $ bundle exec massa
 
@@ -48,8 +48,7 @@ It's recommended to use `-V` (or `--verbose`) flag when running it in a CI:
 
 ## About the gem name
 
-"Massa" is a Portuguese slang which means "awesome",
-so once you add it to your project, it becomes "massa"!
+**"Massa"** is a Portuguese slang which means "awesome", so once you add it to your project, it becomes "massa"!
 
 ## Contributing
 

data/bin/massa

@@ -9,6 +9,12 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = 'Usage: massa [options]'
 
+  opts.on('-g', '--generate-config', 'Generate config file') do
+    template = File.expand_path('../../lib/massa/templates/massa.yml', __FILE__)
+    FileUtils.cp(template, "#{Dir.pwd}/config/massa.yml")
+    exit
+  end
+
   opts.on('-h', '--help', 'Display this help') do
     puts opts
     puts

data/config/default_tools.yml

@@ -1,29 +1,29 @@
-- :description: 'Rubocop'
-  :gem_name:    'rubocop'
-  :command:     'bundle exec rubocop'
-  :required:    true
+rubocop:
+  description: 'Rubocop'
+  command:     'bundle exec rubocop'
+  required:    true
 
-- :description: 'Brakeman'
-  :gem_name:    'brakeman'
-  :command:     'bundle exec brakeman -Aqz'
-  :required:    true
+brakeman:
+  description: 'Brakeman'
+  command:     'bundle exec brakeman -Aqz'
+  required:    true
 
-- :description: 'Rails Best Practices'
-  :gem_name:    'rails_best_practices'
-  :command:     'bundle exec rails_best_practices'
-  :required:    true
+rails_best_practices:
+  description: 'Rails Best Practices'
+  command:     'bundle exec rails_best_practices'
+  required:    true
 
-- :description: 'HAML lint'
-  :gem_name:    'haml_lint'
-  :command:     'bundle exec haml-lint app/views'
-  :required:    true
+haml_lint:
+  description: 'HAML lint'
+  command:     'bundle exec haml-lint app/views'
+  required:    true
 
-- :description: 'I18n translations'
-  :gem_name:    'i18n-tasks'
-  :command:     'bundle exec i18n-tasks missing'
-  :required:    false
+i18n-tasks:
+  description: 'I18n translations'
+  command:     'bundle exec i18n-tasks missing'
+  required:    false
 
-- :description: 'RSpec'
-  :gem_name:    'rspec-rails'
-  :command:     'RAILS_ENV=test bundle exec rspec'
-  :required:    true
+rspec-rails:
+  description: 'RSpec'
+  command:     'RAILS_ENV=test bundle exec rspec'
+  required:    true

data/lib/massa/analyzer.rb

@@ -19,10 +19,10 @@ module Massa
     end
 
     def run!
-      Massa::Tool.list.each do |tool|
-        Massa::CLI.colorize :blue, "➙ #{tool.description}"
+      Massa::Tool.list.each do |gem_name, tool|
+        Massa::CLI.colorize :blue, "➙ #{tool['description']}"
 
-        next unless gem_installed?(tool.gem_name, required: tool.required)
+        next unless gem_installed?(gem_name, required: tool['required'])
 
         execute(tool)
       end
@@ -42,18 +42,18 @@ module Massa
       command_output = ''
 
       if verbose?
-        system(tool.command)
+        system(tool['command'])
       else
-        IO.popen(tool.command, err: [:child, :out]) { |io| command_output = io.read }
+        IO.popen(tool['command'], err: [:child, :out]) { |io| command_output = io.read }
       end
 
       unless $CHILD_STATUS.success?
-        Massa::CLI.colorize :red, "¯\\_(ツ)_/¯ #{tool.description} failed:"
-        Massa::CLI.colorize :yellow, "$ #{tool.command}"
+        Massa::CLI.colorize :red, "¯\\_(ツ)_/¯ #{tool['description']} failed:"
+        Massa::CLI.colorize :yellow, "$ #{tool['command']}"
 
         puts command_output if command_output.to_s != ''
 
-        exit 1 if tool.required
+        exit 1 if tool['required']
       end
     end
   end

data/lib/massa/templates/massa.yml

@@ -0,0 +1,11 @@
+# Default tools will run by default:
+# https://github.com/lucascaton/massa/blob/master/config/default_tools.yml
+# You can overwrite any tool completely or just change its `require` config to `false`
+
+# rspec-rails:
+#   required: false
+#
+# minitest:
+#   description: 'minitest'
+#   command:     'bundle exec rake'
+#   required:    true

data/lib/massa/tool.rb

@@ -4,11 +4,15 @@ module Massa
   class Tool
     class << self
       def list
-        YAML.load_file(tools_yaml_file).map { |tool| OpenStruct.new(tool) }
+        YAML.load_file(config_file_from_gem).merge YAML.load_file(config_file_from_project)
       end
 
-      def tools_yaml_file
-        "#{Gem::Specification.find_by_name('massa').gem_dir}/config/default_tools.yml"
+      def config_file_from_gem
+        File.expand_path('../../../config/default_tools.yml', __FILE__)
+      end
+
+      def config_file_from_project
+        "#{Dir.pwd}/config/massa.yml"
       end
     end
   end

data/lib/massa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Massa
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: massa
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Lucas Caton
@@ -130,6 +130,7 @@ files:
 - lib/massa.rb
 - lib/massa/analyzer.rb
 - lib/massa/cli.rb
+- lib/massa/templates/massa.yml
 - lib/massa/tool.rb
 - lib/massa/version.rb
 - massa.gemspec