rubocopfmt 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a012ee79b8442b495047743bacaa7638bd12f39e
+  data.tar.gz: 0f68b98d269a76ea2a4049c1dc8ffc66f56e6653
+SHA512:
+  metadata.gz: 2db966f9d9b1e13cc952dfa6121cec9e08c63e7774ac0c5bd86d90175c43acb0a4611ebdc3b9ea57c42106d6df59a06edc6846e89bc312078017db352e9cbfb6
+  data.tar.gz: 4c957d666f21e30862be1b889659bcf36b6b9ab08cc2aa2307368e7673410dbb4b5eb8da074bbc5bcbf9a0526ba7963e08061baa8a1cce997cb9ad111426d6ab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocopfmt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Jim Myhrberg.
+
+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,66 @@
+# rubocopfmt
+
+Easy formatting of Ruby code
+using [RuboCop](https://github.com/bbatsov/rubocop). Analogous
+to [`gofmt`](https://golang.org/cmd/gofmt/).
+
+## Installation
+
+```
+gem install rubocopfmt
+```
+
+## Usage
+
+```
+Usage: rubocopfmt [options] [path ...]
+
+Reads from STDIN if no path is given.
+
+Options:
+    -d, --diff                       Display diffs instead of rewriting files.
+    -l, --list                       List files whose formatting is incorrect.
+    -w, --write                      Write result to (source) file instead of STDOUT.
+
+    -v, --version                    Show version.
+    -h, --help                       Show this message.
+```
+
+## Configure
+
+Please refer to
+RuboCop's [Documentation](http://rubocop.readthedocs.io/en/latest/).
+
+## Editor Integration
+
+_Coming Soon!_
+
+## Todo
+
+- Editor integration!
+- "Stable" release
+- Improve tests
+
+## License
+
+(The MIT license)
+
+Copyright (c) 2017 Jim Myhrberg.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocopfmt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rubocopfmt

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path('../../lib', File.realpath(__FILE__)))
+
+require 'rubocopfmt'
+
+result = RuboCopFMT::CLI.run(ARGV)
+
+exit result

data/lib/rubocopfmt/auto_corrector.rb

@@ -0,0 +1,50 @@
+require 'rubocopfmt/options_parser'
+require 'rubocopfmt/formatter'
+
+module RuboCopFMT
+  class AutoCorrector
+    DISABLED_COPS = [
+      'Lint/Debugger',
+      'Lint/UnusedMethodArgument',
+      'Lint/UnusedBlockArgument'
+    ].freeze
+
+    RUBOCOP_OPTS = [
+      '--auto-correct',
+      '--cache', 'false',
+      '--format', 'RuboCopFMT::Formatter',
+      '--except', DISABLED_COPS.join(','),
+      'fake.rb'
+    ].freeze
+
+    attr_reader :source
+    attr_reader :runner
+
+    def initialize(source)
+      @source = source
+    end
+
+    def correct
+      options, paths = RuboCop::Options.new.parse(RUBOCOP_OPTS)
+      config_store = RuboCop::ConfigStore.new
+
+      options[:stdin] = source
+
+      Rainbow.enabled = false
+      config_store.options_config = options[:config] if options[:config]
+      config_store.force_default_config! if options[:force_default_config]
+
+      @runner = RuboCop::Runner.new(options, config_store)
+      @runner.run(paths)
+      options[:stdin]
+    end
+
+    def warnings
+      runner && runner.warnings
+    end
+
+    def errors
+      runner && runner.errors
+    end
+  end
+end

data/lib/rubocopfmt/cli.rb

@@ -0,0 +1,111 @@
+require 'diffy'
+require 'rubocop'
+
+require 'rubocopfmt/errors'
+require 'rubocopfmt/source'
+
+module RuboCopFMT
+  class CLI
+    def self.run(args = ARGV)
+      new(args).run
+    end
+
+    attr_reader :options
+
+    def initialize(args)
+      @options = OptionsParser.parse(args)
+    end
+
+    def run
+      if @options.list
+        print_corrected_list
+      elsif @options.diff
+        print_diff_of_corrections
+      elsif @options.write
+        write_corrected_source
+      else
+        print_corrected_source
+      end
+
+      0
+    end
+
+    private
+
+    def auto_correct_sources
+      sources.map(&:auto_correct)
+    end
+
+    def require_real_files(flag)
+      return unless @options.files.empty?
+
+      $stderr.puts "ERROR: To use #{flag} you must specify one or more files"
+      exit 1
+    end
+
+    def print_corrected_list
+      require_real_files('--list')
+      auto_correct_sources
+
+      sources.each { |c| puts c.path if c.corrected? }
+    end
+
+    def print_diff_of_corrections
+      auto_correct_sources
+
+      sources.each do |source|
+        next unless source.corrected?
+        puts "diff #{source.path} rubocopfmt/#{source.path}" if source.path
+        puts diff_source(source)
+      end
+    end
+
+    def write_corrected_source
+      require_real_files('--write')
+      auto_correct_sources
+
+      sources.each do |source|
+        File.write(source.path, source.output) if source.corrected?
+      end
+    end
+
+    def print_corrected_source
+      auto_correct_sources
+
+      sources.each { |source| print source.output }
+    end
+
+    def sources
+      return @sources if @sources
+
+      if options.files.empty?
+        @sources = [new_source_from_stdin]
+      else
+        @sources = options.files.map do |path|
+          new_source_from_file(path)
+        end
+      end
+    end
+
+    def diff_source(source)
+      diff = Diffy::Diff.new(
+        source.input, source.output,
+        include_diff_info: true,
+        diff: '-U 3'
+      )
+
+      diff.to_s(:text)
+    end
+
+    def new_source_from_stdin
+      Source.new($stdin.binmode.read)
+    end
+
+    def new_source_from_file(path)
+      raise FileNotFound, "File not found: #{path}" unless File.exist?(path)
+
+      source = File.read(path, mode: 'rb')
+      Source.new(source, path)
+    end
+  end
+end

data/lib/rubocopfmt/errors.rb

@@ -0,0 +1,3 @@
+module RuboCopFMT
+  class FileNotFound < StandardError; end
+end

data/lib/rubocopfmt/formatter.rb

@@ -0,0 +1,6 @@
+require 'rubocop'
+
+module RuboCopFMT
+  # Does nothing, as we want nothing output but the corrected source code.
+  class Formatter < RuboCop::Formatter::BaseFormatter; end
+end

data/lib/rubocopfmt/options.rb

@@ -0,0 +1,25 @@
+require 'rubocopfmt/options_parser'
+
+module RuboCopFMT
+  class Options
+    def files
+      @files.nil? ? [] : @files
+    end
+    attr_writer :files
+
+    def diff
+      @diff.nil? ? false : @diff
+    end
+    attr_writer :diff
+
+    def list
+      @list.nil? ? false : @list
+    end
+    attr_writer :list
+
+    def write
+      @write.nil? ? false : @write
+    end
+    attr_writer :write
+  end
+end

data/lib/rubocopfmt/options_parser.rb

@@ -0,0 +1,65 @@
+require 'optparse'
+require 'rubocop'
+
+require 'rubocopfmt/options'
+require 'rubocopfmt/version'
+
+module RuboCopFMT
+  class OptionsParser
+    class << self
+      def parse(args, options = nil)
+        args = args.clone
+        options ||= Options.new
+
+        parse_flags(args, options)
+        options.files = args unless args.empty?
+
+        options
+      end
+
+      private
+
+      def parse_flags(args, options)
+        parser = OptionParser.new do |opts|
+          opts.program_name = 'rubocopfmt'
+          opts.version = RuboCopFMT::VERSION
+
+          opts.banner = 'Usage: rubocopfmt [options] [path ...]'
+          opts.separator ''
+          opts.separator 'Reads from STDIN if no path is given.'
+          opts.separator ''
+          opts.separator 'Options:'
+
+          opts.on(
+            '-d', '--diff',
+            'Display diffs instead of rewriting files.'
+          ) { |v| options.diff = v }
+
+          opts.on(
+            '-l', '--list',
+            'List files whose formatting is incorrect.'
+          ) { |v| options.list = v }
+
+          opts.on(
+            '-w', '--write',
+            'Write result to (source) file instead of STDOUT.'
+          ) { |v| options.write = v }
+
+          opts.separator ''
+
+          opts.on('-v', '--version', 'Show version.') do
+            puts "#{opts.program_name} #{opts.version}" \
+                 " (rubocop #{RuboCop::Version::STRING})"
+            exit
+          end
+
+          opts.on('-h', '--help', 'Show this message.') do
+            puts opts
+            exit
+          end
+        end
+        parser.parse!(args)
+      end
+    end
+  end
+end

data/lib/rubocopfmt/source.rb

@@ -0,0 +1,28 @@
+require 'rubocopfmt/auto_corrector'
+
+module RuboCopFMT
+  class Source
+    attr_reader :path
+    attr_reader :input
+    attr_reader :output
+
+    def initialize(input, path = nil)
+      @input = input
+      @path = path
+    end
+
+    def auto_correct
+      return unless output.nil?
+
+      @corrector = AutoCorrector.new(input)
+      @output = @corrector.correct
+    end
+
+    def corrected?
+      return @corrected unless @corrected.nil?
+      return false if @output.nil?
+
+      @corrected = (@input != @output)
+    end
+  end
+end

data/lib/rubocopfmt/version.rb

@@ -0,0 +1,3 @@
+module RuboCopFMT
+  VERSION = '0.1.0.beta1'.freeze
+end

data/lib/rubocopfmt.rb

@@ -0,0 +1,6 @@
+require 'rubocopfmt/cli'
+require 'rubocopfmt/version'
+
+module RuboCopFMT
+  # Your code goes here...
+end

data/rubocopfmt.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocopfmt/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rubocopfmt'
+  spec.version     = RuboCopFMT::VERSION
+  spec.authors     = ['Jim Myhrberg']
+  spec.email       = ['contact@jimeh.me']
+
+  spec.summary     = 'Easy formatting of Ruby code using RuboCop'
+  spec.description = 'Easy formatting of Ruby code using RuboCop'
+  spec.homepage    = 'https://github.com/jimeh/rubocopfmt'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug'
+
+  spec.add_runtime_dependency 'rubocop', '~> 0.46'
+  spec.add_runtime_dependency 'diffy', '~> 3.1'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rubocopfmt
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Jim Myhrberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Easy formatting of Ruby code using RuboCop
+email:
+- contact@jimeh.me
+executables:
+- rubocopfmt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rubocopfmt
+- lib/rubocopfmt.rb
+- lib/rubocopfmt/auto_corrector.rb
+- lib/rubocopfmt/cli.rb
+- lib/rubocopfmt/errors.rb
+- lib/rubocopfmt/formatter.rb
+- lib/rubocopfmt/options.rb
+- lib/rubocopfmt/options_parser.rb
+- lib/rubocopfmt/source.rb
+- lib/rubocopfmt/version.rb
+- rubocopfmt.gemspec
+homepage: https://github.com/jimeh/rubocopfmt
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Easy formatting of Ruby code using RuboCop
+test_files: []