ruumba 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c8728a15051d8b738eefad002020f1d547e1f16
-  data.tar.gz: b8d749c81d4719fc52f68a23d6243ac022ac7625
+  metadata.gz: 4c7ba4f2f438b17471122538d849e61eb25051b6
+  data.tar.gz: efb4b191828bb4e6369ea8d99336c86f70833957
 SHA512:
-  metadata.gz: ccc655259643fda1b72c3ea786088641be4da80fc240a92ce2a5495cd9839a7c8156277a517c374fb850027536d297ad4c2ab5c3ecf6b328d438fd0246db78ac
-  data.tar.gz: 2672a943fb32fc126d459eb5c47d6355fa6d5b612c5befefa325c02beff3af90997e9b5d39d276c43a5cd04d770e3ede0a3df38f3ba900d36b26b05351e0a845
+  metadata.gz: 1fdaa76bbf68eeca255cdcaaa5d8f66ba9e5959a35d241026fa63758f1c787015023b43ccb53e954ada3b14ba5a5d5f2b200e1401d9fa427aa5cfc882ef1779d
+  data.tar.gz: 0c793eb2f6396d70d9cb746e897f8d31a6cbbba808d1d4bb7d601909d9371071b7fcfaa4d826df499cf84bb36a57f76b8678ef89e32b54efe4beb7f7b07d92ed

data/README.md

@@ -1,5 +1,8 @@
 Ruumba
 ======
+
+[![Build Status](https://travis-ci.org/ericqweinstein/ruumba.svg?branch=master)](https://travis-ci.org/ericqweinstein/ruumba)
+
 > .erb or .rb, you're coming with me.
 
 > — RuboCop
@@ -38,6 +41,51 @@ Then:
 λ bundle exec rake ruumba
 ```
 
+## Fix paths and unapplicable cops
+
+By default, Rubocop only scan `.rb` files and so does Ruumba. If you want shown
+paths to reflect original paths, you can add create a `.ruumba.yml` config file
+with the following contents:
+
+```yaml
+AllCops:
+  Include:
+    - '**/*.erb'
+```
+
+You can then disable `.rb` extension auto-append and use your config file:
+
+```bash
+λ ruumba -D -e app/views -c .ruumba.yml
+```
+
+Since Ruumba rewrites new files form `.erb` files contents, some formatting cops
+cannot apply, you can disable them in your Ruumba file:
+
+```yaml
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/AlignHash:
+  Enabled: false
+Layout/AlignParameters:
+  Enabled: false
+Layout/IndentationWidth:
+  Enabled: false
+Layout/TrailingBlankLines:
+  Enabled: false
+```
+
+You can use `ruumba -a` or `ruumba -D` to look for other cops if this list is
+missing some.
+
+You might want to include your existing rubocop config file by appending this in
+front of your Ruumba config:
+
+```yaml
+inherit_from: .rubocop.yml
+```
+
+
 ## Contributing
 1. Branch (`git checkout -b fancy-new-feature`)
 2. Commit (`git commit -m "Fanciness!"`)

data/Rakefile

@@ -29,9 +29,3 @@ desc 'Run all the tests, lint all the things'
 namespace :test do
   task all: %i(spec rubocop)
 end
-
-desc 'Generate Ruby documentation'
-YARD::Rake::YardocTask.new do |t|
-  t.files   = %w(lib/**/*.rb)
-  t.options = %w(--protected --private)
-end

data/bin/ruumba

@@ -4,19 +4,44 @@
 require 'optparse'
 require_relative '../lib/ruumba'
 
-opt_parser = OptionParser.new do |opts|
+options = { arguments: [] }
+opts_parser = OptionParser.new do |opts|
   opts.banner = 'Usage: ruumba path/to/ERBs/'
 
   opts.on('-h', '--help', 'Display this screen') do
     puts opts_parser
     exit
   end
+
+  opts.on('-a', '--auto-gen-config', 'Generate a configuration file acting as a TODO list.') do
+    options[:arguments] << '--auto-gen-config'
+  end
+
+  opts.on('-t', '--tmp-folder [TEMP_FOLDER]', 'Use this suffix for the temporary folder') do |f|
+    options[:tmp_folder] = f
+  end
+
+  opts.on('-c', '--config [CONFIG]', 'Use this config for rubocop') do |c|
+    options[:arguments] << "--config #{File.expand_path(c)}"
+  end
+
+  opts.on('-D', '--display-cop-names', 'Display cop names') do ||
+    options[:arguments] << "--display-cop-names"
+  end
+
+  opts.on('-F', '--fail-level [LEVEL]', 'Rubocop fail level') do |l|
+    options[:arguments] << "--fail-level #{l}"
+  end
+
+  opts.on('-e', '--disable-ruby-ext', 'Disable auto-append of .rb extension') do
+    options[:disable_rb_extension] = true
+  end
 end
 
-begin opt_parser.parse!
+begin opts_parser.parse!
   rescue OptionParser::InvalidOption => e
   abort "An error occurred: #{e}. Run ruumba -h for help."
 end
 
-analyzer = Ruumba::Analyzer.new
+analyzer = Ruumba::Analyzer.new(options)
 analyzer.run

data/lib/ruumba/analyzer.rb

@@ -1,6 +1,8 @@
 # @author Eric Weinstein <eric.q.weinstein@gmail.com>
 
 require 'securerandom'
+require 'pathname'
+require 'tmpdir'
 
 # Ruumba: RuboCop's sidekick.
 module Ruumba
@@ -8,24 +10,22 @@ module Ruumba
   # to RuboCop for linting (style, correctness, &c).
   class Analyzer
     # The regular expression to capture interpolated Ruby.
-    ERB_REGEX = /<%=?(.*?)%>/
+    ERB_REGEX = /<%[-=]?(.*?)-?%>/m
+
+    def initialize(opts = nil)
+      @options = opts || {}
+    end
 
     # Performs static analysis on the provided directory.
     # @param [Array<String>] dir The directory to analyze.
     def run(dir = ARGV)
-      fq_dir = File.expand_path dir.first
-      suffix = SecureRandom.hex
+      fq_dir = Pathname.new(File.expand_path(dir.first))
+      pwd = Pathname.new ENV['PWD']
+      target = fq_dir.relative_path_from(pwd)
+      tmp = create_temp_dir
 
-      Dir["#{fq_dir}/**/*.erb"].each do |f|
-        File.open("#{f}-#{suffix}.rb", 'w+') do |file|
-          code = extract f
-          file.write code
-        end
-      end
-
-      system("rubocop #{fq_dir}")
-
-      Dir.glob(Dir["#{fq_dir}/**/*-#{suffix}.rb"]).each { |f| File.delete(f) }
+      copy_erb_files(fq_dir, tmp, pwd)
+      run_rubocop(target, tmp)
     end
 
     # Extracts Ruby code from an ERB template.
@@ -34,5 +34,39 @@ module Ruumba
     def extract(filename)
       File.read(filename).scan(ERB_REGEX).map(&:last).map(&:strip).join("\n")
     end
+
+    private
+
+    def create_temp_dir
+      if @options[:tmp_folder]
+        Pathname.new(File.expand_path(@options[:tmp_folder]))
+      else
+        Pathname.new(Dir.mktmpdir)
+      end
+    end
+
+    def copy_erb_files(fq_dir, tmp, pwd)
+      extension = '.rb' unless @options[:disable_rb_extension]
+
+      Dir["#{fq_dir}/**/*.erb"].each do |f|
+        n = tmp + Pathname.new(f).relative_path_from(pwd)
+        FileUtils.mkdir_p(File.dirname(n))
+
+        File.open("#{n}#{extension}", 'w+') do |file|
+          code = extract f
+          file.write code
+        end
+      end
+    end
+
+    def run_rubocop(target, tmp)
+      args = (@options[:arguments] || []).join(' ')
+      todo = tmp + '.rubocop_todo.yml'
+
+      system("cd #{tmp} && rubocop #{args} #{target}").tap do
+        FileUtils.cp(todo, ENV['PWD']) if File.exist?(todo)
+        FileUtils.rm_rf(tmp) unless @options[:tmp_folder]
+      end
+    end
   end
 end

data/lib/ruumba/rake_task.rb

@@ -6,7 +6,7 @@ require 'rake/tasklib'
 module Ruumba
   # Provides a custom Rake task.
   class RakeTask < Rake::TaskLib
-    attr_accessor :name, :dir
+    attr_accessor :name, :dir, :options
 
     # Sets up the custom Rake task.
     # @param [Array<String>] args Arguments to the Rake task.
@@ -15,9 +15,9 @@ module Ruumba
     def initialize(*args, &block)
       @name = args.shift || :ruumba
       @dir  = []
+      @options = nil
 
-      desc 'Run RuboCop on ERB files' unless ::Rake.application.last_comment
-
+      desc 'Run RuboCop on ERB files'
       task(name, *args) do |_, task_args|
         block.call(*[self, task_args].slice(0, block.arity)) if block
         run
@@ -33,10 +33,10 @@ module Ruumba
       # doesn't substantially impact Rakefile load time.
       require 'ruumba'
 
-      analyzer = Ruumba::Analyzer.new
+      analyzer = Ruumba::Analyzer.new(@options)
       puts 'Running Ruumba...'
 
-      analyzer.run @dir
+      analyzer.run(@dir) || exit(1)
     end
   end
 end

metadata

@@ -1,29 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: ruumba
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Weinstein
+- Jan Biniok
+- Yvan Barthélemy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: '0'
 description: RuboCop linting for ERB templates.
 email: eric.q.weinstein@gmail.com
 executables:
@@ -57,10 +59,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Allows users to lint Ruby code in ERB templates the same way they lint source
   code (using RuboCop).
 test_files: []
-has_rdoc: