ruumba 0.0.1

checksums.yaml

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

data/README.md

@@ -0,0 +1,47 @@
+Ruumba
+======
+> .erb or .rb, you're coming with me.
+
+> — RuboCop
+
+## About
+Ruumba is [RuboCop's](https://github.com/bbatsov/rubocop) sidekick, allowing you to lint your .erb Rubies as well as your regular-type ones.
+
+## Dependencies
+* Ruby 2.2.2+
+
+## Installation
+```bash
+λ gem install ruumba
+```
+
+## Usage
+Command line:
+
+```bash
+λ ruumba directory_of_erb_files/
+```
+
+Rake task:
+
+```ruby
+require 'ruumba/rake_task'
+
+Ruumba::RakeTask.new(:ruumba) do |t|
+  t.dir = %w(lib/views)
+end
+```
+
+Then:
+
+```bash
+λ bundle exec rake ruumba
+```
+
+## Contributing
+1. Branch (`git checkout -b fancy-new-feature`)
+2. Commit (`git commit -m "Fanciness!"`)
+3. Test (`bundle exec rake spec`)
+4. Lint (`bundle exec rake rubocop`)
+5. Push (`git push origin fancy-new-feature`)
+6. Ye Olde Pulle Requeste

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+task default: 'test:all'
+
+desc 'Run IRB with the gem environment loaded'
+task :console do
+  puts '[+] Loading development console...'
+  system('irb -r ./lib/ruumba.rb')
+end
+
+desc 'Run tests'
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern    = './spec/**/*_spec.rb'
+    t.rspec_opts = ['--color --format d']
+  end
+end
+
+desc 'Lint'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.patterns = %w(lib/**/*.rb spec/**/*.rb)
+end
+
+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

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby -w
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+require 'optparse'
+require_relative '../lib/ruumba'
+
+opt_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
+end
+
+begin opt_parser.parse!
+  rescue OptionParser::InvalidOption => e
+  abort "An error occurred: #{e}. Run ruumba -h for help."
+end
+
+analyzer = Ruumba::Analyzer.new
+analyzer.run

data/lib/ruumba.rb

@@ -0,0 +1,3 @@
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+require_relative './ruumba/analyzer'

data/lib/ruumba/analyzer.rb

@@ -0,0 +1,38 @@
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+require 'securerandom'
+
+# Ruumba: RuboCop's sidekick.
+module Ruumba
+  # Generates analyzer objects that, when run, delegate
+  # to RuboCop for linting (style, correctness, &c).
+  class Analyzer
+    # The regular expression to capture interpolated Ruby.
+    ERB_REGEX = /<%=?(.*?)%>/
+
+    # 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
+
+      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) }
+    end
+
+    # Extracts Ruby code from an ERB template.
+    # @param [String] filename The filename.
+    # @return [String] The extracted Ruby code.
+    def extract(filename)
+      File.read(filename).scan(ERB_REGEX).map(&:last).map(&:strip).join("\n")
+    end
+  end
+end

data/lib/ruumba/rake_task.rb

@@ -0,0 +1,42 @@
+# @author Eric Weinstein <eric.q.weinstein@gmail.com>
+
+require 'rake'
+require 'rake/tasklib'
+
+module Ruumba
+  # Provides a custom Rake task.
+  class RakeTask < Rake::TaskLib
+    attr_accessor :name, :dir
+
+    # Sets up the custom Rake task.
+    # @param [Array<String>] args Arguments to the Rake task.
+    # @yield If called with a block, we'll call it to ensure
+    # additional options are included (_e.g._ dir).
+    def initialize(*args, &block)
+      @name = args.shift || :ruumba
+      @dir  = []
+
+      desc 'Run RuboCop on ERB files' unless ::Rake.application.last_comment
+
+      task(name, *args) do |_, task_args|
+        block.call(*[self, task_args].slice(0, block.arity)) if block
+        run
+      end
+    end
+
+    private
+
+    # Executes the custom Rake task.
+    # @private
+    def run
+      # Like RuboCop itself, we'll lazy load so the task
+      # doesn't substantially impact Rakefile load time.
+      require 'ruumba'
+
+      analyzer = Ruumba::Analyzer.new
+      puts 'Running Ruumba...'
+
+      analyzer.run @dir
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: ruumba
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Weinstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-09 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: RuboCop linting for ERB templates.
+email: eric.q.weinstein@gmail.com
+executables:
+- ruumba
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/ruumba
+- lib/ruumba.rb
+- lib/ruumba/analyzer.rb
+- lib/ruumba/rake_task.rb
+homepage: https://github.com/ericqweinstein/ruumba
+licenses:
+- MIT
+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.4.5
+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: