rubocopfmt 0.1.0.beta9 → 0.1.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba8786eb7c1bdd55ed396f709f087a429429d92b
-  data.tar.gz: 48d71ff1a78aeb97b949522cdfbec764b7f2ac09
+  metadata.gz: '0499af5d4df26074ce977b4ea3b342a4fee80f01'
+  data.tar.gz: 69f4c237faf44139cdeea5e55016ddba7b9e030c
 SHA512:
-  metadata.gz: 3011db0eae54d67284643febd3a73a27eb730d5713c263876664a6ea2d9004b13cf485302c374ec3c728e857f826cb324f255804e77ffbec082605f70589489f
-  data.tar.gz: 9bc6f35aab4deddfca561b25f101bcc7b3a506b20355af0fb60e897f5c53b8024e790e031de545432a8569ad3f15e225ff0e36b30f69b7e61f3de3ee1d2606ea
+  metadata.gz: 9085840c6e9be2546e22c685ae294f1515baa74b8884ce961cc9386190b2b14199f6c84efed555e0ba66444abcd1266de88f7304040b9b6780511c9fc4d83a62
+  data.tar.gz: 9961b01ba0dbd6fd1aa406556d20f178c4beba1a76c90ef49f53944229ea67b4ebd4c0f112c01e554bc13febdbaac99ea758b71e7860bedae1af6e4c0ba13430

data/README.md

@@ -4,6 +4,9 @@ Easy formatting of Ruby code
 using [RuboCop](https://github.com/bbatsov/rubocop). Analogous
 to [`gofmt`](https://golang.org/cmd/gofmt/).
 
+Currently the main focus is to provide a simple way to format Ruby code on save
+in various editors. As such the feature set is very minimal for the time being.
+
 ## Installation
 
 ```
@@ -21,6 +24,7 @@ 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
+  -i, --interactive        Disable cops that cause confusion in text editors
   -S, --src-dir=<s>        Operate as if code resides in specified directory
   -D, --diff-format=<s>    Display diffs using format: unified, rcs, context
 
@@ -35,7 +39,25 @@ RuboCop's [Documentation](http://rubocop.readthedocs.io/en/latest/).
 
 ## Editor Integration
 
-_Coming Soon!_
+- Emacs: https://github.com/jimeh/rubocopfmt-emacs
+- _More coming soon!_
+
+## Interactive Mode
+
+When called from an editor on save, there's a few of Cops that causes
+confusion when run against half-finished code. Interactive mode disables those
+cops and should be used by all editor plugins.
+
+Cops disabled in Interactive mode:
+
+- `Lint/Debugger`: Removes `debugger` statements. Not helpful when you need to
+  debug something.
+- `Lint/UnusedBlockArgument`: Don't prefix unused block variable names with
+  `_`. This causes issues if you save after defining a block, but before you use
+  all arguments of the block.
+- `Lint/UnusedMethodArgument`: Don't prefix unused method variable names with
+  `_`. This causes issues if you save after defining a method, but before you
+  use all arguments of the method.
 
 ## Todo
 

data/lib/rubocopfmt/auto_corrector.rb

@@ -4,6 +4,12 @@ require 'rubocopfmt/rubocop_formatter'
 
 module RuboCopFMT
   class AutoCorrector
+    BAD_INTERACTIVE_COPS = [
+      'Lint/Debugger',
+      'Lint/UnusedBlockArgument',
+      'Lint/UnusedMethodArgument'
+    ].freeze
+
     attr_reader :input
     attr_reader :runner
 
@@ -12,10 +18,13 @@ module RuboCopFMT
       @path = path
     end
 
-    def correct
+    def correct(interactive = false)
       Rainbow.enabled = false if defined?(Rainbow)
 
-      @runner = ::RuboCop::Runner.new(options, config_store)
+      options = default_options.clone
+      options[:except] = BAD_INTERACTIVE_COPS if interactive
+
+      @runner = ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new)
       @runner.run(paths)
 
       options[:stdin]
@@ -24,34 +33,16 @@ module RuboCopFMT
     private
 
     def paths
-      @paths ||= [@path || 'fake.rb']
+      @paths ||= [@path || '__fake__.rb']
     end
 
-    def options
-      @options ||= {
+    def default_options
+      {
         stdin: @input,
         auto_correct: true,
         cache: 'false',
-        formatters: [['RuboCopFMT::RubocopFormatter']],
-        except: disabled_cops
+        formatters: [['RuboCopFMT::RubocopFormatter']]
       }
     end
-
-    def disabled_cops
-      [
-        'Lint/Debugger',
-        'Lint/UnusedMethodArgument',
-        'Lint/UnusedBlockArgument'
-      ]
-    end
-
-    def config_store
-      return @config_store if @config_store
-
-      @config_store = ::RuboCop::ConfigStore.new
-      @config_store.options_config = options[:config] if options[:config]
-      @config_store.force_default_config! if options[:force_default_config]
-      @config_store
-    end
   end
 end

data/lib/rubocopfmt/cli.rb

@@ -17,7 +17,7 @@ module RuboCopFMT
     end
 
     def run
-      format_sources
+      @sources = format_sources
 
       if options.list
         print_corrected_list
@@ -37,7 +37,7 @@ module RuboCopFMT
     def format_sources
       formatter = Formatter.new(options)
       formatter.run
-      @sources = formatter.sources
+      formatter.sources
     end
 
     def print_corrected_list

data/lib/rubocopfmt/cli_options.rb

@@ -46,6 +46,7 @@ module RuboCopFMT
           opt :diff, 'Display diffs instead of rewriting files'
           opt :list, 'List files whose formatting is incorrect'
           opt :write, 'Write result to (source) file instead of STDOUT'
+          opt :interactive, 'Disable cops that cause confusion in text editors'
           opt :src_dir, 'Operate as if code resides in specified directory',
               short: 'S', type: :string
           opt :diff_format, 'Display diffs using format: unified, rcs, context',

data/lib/rubocopfmt/formatter.rb

@@ -16,7 +16,7 @@ module RuboCopFMT
       sources = []
       sources << new_source_from_str(options.input) if options.input
       sources += options.paths.map { |path| new_source_from_file(path) }
-      sources.map(&:auto_correct)
+      sources.map { |s| s.auto_correct(options.interactive) }
 
       @sources = sources
     end

data/lib/rubocopfmt/options.rb

@@ -23,5 +23,10 @@ module RuboCopFMT
       @write.nil? ? false : @write
     end
     attr_writer :write
+
+    def interactive
+      @interactive.nil? ? false : @interactive
+    end
+    attr_writer :interactive
   end
 end

data/lib/rubocopfmt/source.rb

@@ -13,11 +13,11 @@ module RuboCopFMT
       @src_dir = src_dir
     end
 
-    def auto_correct
+    def auto_correct(interactive = false)
       return unless output.nil?
 
       @corrector = AutoCorrector.new(input, full_path)
-      @output = @corrector.correct
+      @output = @corrector.correct(interactive)
     end
 
     def corrected?

data/lib/rubocopfmt/version.rb

@@ -1,3 +1,3 @@
 module RuboCopFMT
-  VERSION = '0.1.0.beta9'.freeze
+  VERSION = '0.1.0.beta10'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocopfmt
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta9
+  version: 0.1.0.beta10
 platform: ruby
 authors:
 - Jim Myhrberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler