gry 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c54e917086fa41a5b62398662b2c32f7e0188173
-  data.tar.gz: 06f3a5e3b7a4462e3f45bb9ae87a24d5b9ccf50c
+  metadata.gz: 33d1bfe1ac908ccdb01f9277c21baac9f73fbffe
+  data.tar.gz: f318d2d9613aff6348b5a4381e74fa1996fc30bb
 SHA512:
-  metadata.gz: c0fe5457c19c379f412e23736f93cae17eb92e9cbb75f5bf69057ef5403ea99e4c8fa176e4c2fa50dbe46ca18118610856da52a67c7a4fdbb8e7c8a3f3ce507f
-  data.tar.gz: 148ce9a7abfe1e8d5f0c4f88fdadbe19e5715bcded3d7b7b04861781bb563f9cf1a6a575e1b56338912f131d3cb98f86bee14fd4eaf41989ae73240f59abaf13
+  metadata.gz: abe9020e5308c428f7e3091a8029f8aa884f14ac268492effb2bbbe3ee36fd46cf45edcc093ab33237e3c4b2b2d9fd5218902ede86fc89132991c51a74029be3
+  data.tar.gz: 9f61103cb653094a324e5fca6e97b8f04b031bcca3c910f7760fa5eceff95ddf639722d816c9af2d233a67d59c89e6d3a5c8ec436e4aa979f6f378d7ab813ac8

data/.gitignore

@@ -1,4 +1,4 @@
-/.bundle/
+.bundle/
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gemfiles/*.lock

data/.travis.yml

@@ -2,4 +2,8 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.3
+  - 2.4.0
   - ruby-head
+gemfile:
+  - gemfiles/rubocop_0.47.0.gemfile
+  - gemfiles/rubocop_head.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rubocop-head" do
+  gem "rubocop", github: 'bbatsov/rubocop'
+end
+
+appraise "rubocop-0.47.0" do
+  gem "rubocop", "0.47.0"
+end

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gry.gemspec
 gemspec
-
-gem 'rubocop', github: 'bbatsov/rubocop'
-gem 'meowcop', github: 'pocke/meowcop', branch: 'rubocop-master'

data/README.md

@@ -1,10 +1,13 @@
-# Gry (Work In Progress!)
+# Gry
+
+Gry Generates a .Rubocop.Yml automatically.
 
 [![Build Status](https://travis-ci.org/pocke/gry.svg?branch=master)](https://travis-ci.org/pocke/gry)
 [![Coverage Status](https://coveralls.io/repos/github/pocke/gry/badge.svg?branch=master)](https://coveralls.io/github/pocke/gry?branch=master)
 [![Gem Version](https://badge.fury.io/rb/gry.svg)](https://badge.fury.io/rb/gry)
 
-Gry generates `.rubocop.yml` automatically from your source code.
+Gry extracts coding style guide as a `.rubocop.yml` from your code that already exists.
+
 
 ## Installation
 
@@ -15,18 +18,12 @@ $ gem install gry
 ## Usage
 
 ```sh
-$ gry Style/EmptyElse Style/AlignParameters
-```
-
-## Development
+# Generate a .rubocop.yml for all configuratble cops.
+$ gry >> .rubocop.yml
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/gry.
+# Generate a .rubocop.yml for specified cops only.
+$ gry Style/AndOr Style/VariableName >> .rubocop.yml
+```
 
 
 License

data/exe/gry

@@ -2,4 +2,4 @@
 
 require 'gry'
 
-Gry::CLI.new(ARGV).run
+Gry::CLI.new(ARGV).run(STDOUT)

data/gemfiles/rubocop_0.47.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "0.47.0"
+
+gemspec :path => "../"

data/gemfiles/rubocop_head.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", :github => "bbatsov/rubocop"
+
+gemspec :path => "../"

data/gry.gemspec

@@ -31,10 +31,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "guard-bundler", "~> 2.1.0"
   spec.add_development_dependency "guard-rubocop", "~> 1.2.0"
-  spec.add_development_dependency "rubocop", ">= 0.46.0"
-  spec.add_development_dependency "meowcop", ">= 1.4.0"
+  spec.add_development_dependency "rubocop", ">= 0.47.0"
+  spec.add_development_dependency "meowcop", ">= 1.7.0"
+  spec.add_development_dependency "appraisal"
 
-  # TODO: specify 0.47.0
-  spec.add_runtime_dependency "rubocop", ">= 0.46.0"
+  spec.add_runtime_dependency "rubocop", ">= 0.47.0"
   spec.add_runtime_dependency "parallel", "~> 1.10.0"
 end

data/lib/gry.rb

@@ -10,11 +10,12 @@ require 'parallel'
 
 require "gry/version"
 require 'gry/rubocop_runner'
-require 'gry/analyzer'
+require 'gry/congress'
+require 'gry/law'
+require 'gry/pilot_study'
 require "gry/option"
 require 'gry/cli'
 require 'gry/rubocop_adapter'
-require 'gry/strategy'
 require 'gry/formatter'
 
 module Gry

data/lib/gry/cli.rb

@@ -4,19 +4,31 @@ module Gry
       @argv = argv
     end
 
-    def run
+    def run(writer)
       opt = Option.new(@argv)
       if opt.version
         rubocop_version, = *Open3.capture3('rubocop', '--verbose-version')
-        puts "gry #{VERSION} (RuboCop #{rubocop_version.chomp})"
+        writer.puts "gry #{VERSION} (RuboCop #{rubocop_version.chomp})"
         return
       end
-      cops = opt.all ? RubocopAdapter.configurable_cops : opt.args
+
+      cops = opt.args.empty? ? RubocopAdapter.configurable_cops : opt.args
       if opt.fast
         cops.reject!{|cop| cop == 'Style/AlignHash'}
       end
-      analyzer = Gry::Analyzer.new(cops, process: opt.process)
-      puts analyzer.analyze
+      pilot_study = Gry::PilotStudy.new(cops, process: opt.process)
+
+      bills = pilot_study.analyze
+      # TODO: Specify the value from option
+      congress = Congress.new(
+        max_count: opt.max_count,
+        min_difference: opt.min_difference,
+      )
+      laws = bills.map do |cop_name, bill|
+        congress.discuss(cop_name, bill)
+      end.compact
+
+      writer.puts Formatter.format(laws)
     end
   end
 end

data/lib/gry/congress.rb

@@ -0,0 +1,29 @@
+module Gry
+  class Congress
+    def initialize(max_count:, min_difference:)
+      @max_count = max_count
+      @min_difference = min_difference
+    end
+
+    # @param name [String] cop name
+    # @param bill [Hash{Hash => Integer}] rubocop results
+    #   {
+    #     {config1} => 20,
+    #     {config2} =>  0,
+    #     {config3} => 10,
+    #   }
+    # @return [Law]
+    def discuss(name, bill)
+      # [[conf, count], ...]
+      sorted = bill.sort_by{|_conf, count| count}
+      min_count = sorted.first.last
+      return nil if min_count > @max_count
+
+      second_count = sorted[1].last
+      return nil if second_count - min_count < @min_difference
+
+      letter = sorted.first.first
+      Law.new(name, bill, letter)
+    end
+  end
+end

data/lib/gry/formatter.rb

@@ -1,13 +1,11 @@
 module Gry
   module Formatter
-    # @param gry_result [Hash]
-    #   {'Style/DotPosition' => { {conf} => count}}
+    # @param gry_result [Array<Law>]
     # @return [String] a yaml string
-    def self.format(gry_result)
-      confs = gry_result.map do |cop_name, set_count|
-        setting = Strategy.results_to_config(set_count)
-        next unless setting
-        to_comment(set_count) + to_yaml({cop_name => setting})
+    def self.format(laws)
+      confs = laws.map do |law|
+        to_comment(law.bill) +
+          to_yaml({law.name => law.letter})
       end.compact
 
       to_yaml(RubocopAdapter.config_base) +

data/lib/gry/law.rb

@@ -0,0 +1,3 @@
+module Gry
+  Law = Struct.new(:name, :bill, :letter)
+end

data/lib/gry/option.rb

@@ -1,27 +1,25 @@
 module Gry
   class Option
-    class ParseError < StandardError; end
-
-    attr_reader :args, :all, :process, :version, :fast
+    attr_reader :args, :process, :version, :fast, :max_count, :min_difference
 
     def initialize(argv)
       opt = OptionParser.new
-      @all = false
       @version = false
       @process = Parallel.processor_count
-      @fast = false
+      @fast = true
+      @max_count = 10
+      @min_difference = 10
 
-      opt.on('-d', '--debug') {Gry.debug_mode!}
-      opt.on('-a', '--all') {@all = true}
-      opt.on('-p', '--process=VAL') {|v| @process = v.to_i}
-      opt.on('-v', '--version') {@version = true}
-      opt.on('-f', '--fast') {@fast = true}
+      opt.banner = 'Usage: gry [options] [Cop1, Cop2, ...]'
 
-      @args = opt.parse(argv)
+      opt.on('-d', '--debug', 'Output debug log.') {Gry.debug_mode!}
+      opt.on('-p', '--process=VAL', 'Number of parallel processes.') {|v| @process = v.to_i}
+      opt.on('-v', '--version', 'Display version.') {@version = true}
+      opt.on('--[no-]fast', 'Run only fast cops. Default: true') {|v| @fast = v}
+      opt.on('--max-count=10', 'Upper limit of issues.') {|v| @max_count = v.to_i}
+      opt.on('--min-difference=10', 'Lower limit of issues number difference') {|v| @min_difference = v.to_i}
 
-      if @all && !@args.empty?
-        raise ParseError, 'Do not specify cop name with --all option'
-      end
+      @args = opt.parse(argv)
     end
   end
 end

data/lib/gry/{analyzer.rb → pilot_study.rb}

@@ -1,5 +1,5 @@
 module Gry
-  class Analyzer
+  class PilotStudy
     # @param cops [Array<String>] cop names. e.g.) ['Style/EmptyElse']
     def initialize(cops, process:)
       @cops = cops
@@ -23,8 +23,7 @@ module Gry
         [cops, setting]
       end
 
-      gry_result = execute_rubocop(rubocop_args)
-      Formatter.format(gry_result)
+      execute_rubocop(rubocop_args)
     end
 
 

data/lib/gry/version.rb

@@ -1,3 +1,3 @@
 module Gry
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Masataka Kuwabara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-14 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,42 +156,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
   name: meowcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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.0
+        version: 0.47.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +232,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - Guardfile
 - LICENSE
@@ -226,15 +241,18 @@ files:
 - bin/console
 - bin/setup
 - exe/gry
+- gemfiles/rubocop_0.47.0.gemfile
+- gemfiles/rubocop_head.gemfile
 - gry.gemspec
 - lib/gry.rb
-- lib/gry/analyzer.rb
 - lib/gry/cli.rb
+- lib/gry/congress.rb
 - lib/gry/formatter.rb
+- lib/gry/law.rb
 - lib/gry/option.rb
+- lib/gry/pilot_study.rb
 - lib/gry/rubocop_adapter.rb
 - lib/gry/rubocop_runner.rb
-- lib/gry/strategy.rb
 - lib/gry/version.rb
 homepage: https://github.com/pocke/gry
 licenses:

data/lib/gry/strategy.rb

@@ -1,24 +0,0 @@
-module Gry
-  # Strategy decides a rule config from rubocop results.
-  module Strategy
-    # The method returns
-    # @param results [Hash{Hash => Integer}] rubocop results
-    #   {
-    #     {config1} => 20,
-    #     {config2} =>  0,
-    #     {config3} => 10,
-    #   }
-    # @return [Hash{}] returns a config decided from received configs
-    #   {
-    #     EnforcedStyle: 'foobar',
-    #   }
-    # @return [NilClass] if config is not available, retunrs nil
-    def self.results_to_config(results, count_limit: 10)
-      results
-        .select{|_conf, count| count <= count_limit }
-        .sort_by{|_conf, count| count}
-        .first # to get minimum conf and count
-        &.first # to get conf
-    end
-  end
-end