rubocop-gemfile 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed344acd76ba9e93b93397e7e4f9871e97dd32ba
-  data.tar.gz: df19136e1b5e6af09269089f6ab71648f9f69bf0
+  metadata.gz: 6a0697ca088fd3ff185890ccfb0d280f8fa2d3b4
+  data.tar.gz: 25fe1ed50f3818b478ecb14d87f7d4cecd3ed46b
 SHA512:
-  metadata.gz: e70539e5cb5bc38f46ef40014de5592623dbba972e837dc80a70de4308344ae00488d57e2d818cc3aa7f6f9b15c8967cdeca4fa4008f5635f95b9fd9746bc545
-  data.tar.gz: 9c77b8c820ad81e3d13a268192686a0d9ff1ac28b5a2410fc3c84475e778015d5dcd2bdb594d469b2fb63147b1b363a0543f67e4968d6881d8aff5eaf98b2a21
+  metadata.gz: 07a2f20800fa4c82582b5d3d6296836066c8cf753f45bd1ebccb05a7662a695297e184c805502fd49db833eb8cb18b9e14dc648642ce6edb329136c371a85815
+  data.tar.gz: 319858fc8bded038f97547e81a5ba89b33cfb17971d34b1979f2023e11a8e6ac145675d7b8b96c3f47086c532b9a1e80da86136b71def7725a4fc03573354912

data/Rakefile

@@ -4,3 +4,5 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+Dir["lib/tasks/*.rake"].each { |f| load f }

data/config/default.yml

@@ -15,3 +15,8 @@ Gemfile/GroupType:
     - double_quotes
     - single_quotes
   Enabled: true
+
+Gemfile/SortGemAscending:
+  Description: "Sort the gem in alphabetical order"
+  TopGems:
+  Enabled: true

data/lib/rubocop/cop/gemfile/group_type.rb

@@ -6,8 +6,7 @@ module RuboCop
       # This cop makes sure that `group` has symbol group name
       #
       # @example
-      #
-      #   EnforcedStyle: symbol
+      #   # EnforcedStyle: symbol
       #
       #   # bad
       #   group "test" do
@@ -23,7 +22,7 @@ module RuboCop
       #     gem "rspec-rails"
       #   end
       #
-      #   EnforcedStyle: single_quotes
+      #   # EnforcedStyle: single_quotes
       #
       #   # bad
       #   group :test do
@@ -39,7 +38,7 @@ module RuboCop
       #     gem "rspec-rails"
       #   end
       #
-      #   EnforcedStyle: double_quotes
+      #   # EnforcedStyle: double_quotes
       #
       #   # bad
       #   group :test do
@@ -57,6 +56,10 @@ module RuboCop
       class GroupType < Cop
         MSG = 'Use %s group'.freeze
 
+        ENFORCED_STYLE_SYMBOL        = "symbol".freeze
+        ENFORCED_STYLE_DOUBLE_QUOTES = "double_quotes".freeze
+        ENFORCED_STYLE_SINGLE_QUOTES = "single_quotes".freeze
+
         def on_send(node)
           _, method_name, *args = *node
 
@@ -71,11 +74,11 @@ module RuboCop
 
           args.each do |arg|
             case enforced_style
-            when "symbol"
+            when ENFORCED_STYLE_SYMBOL
               add_offense(node, arg.loc.expression, message) if arg.str_type?
-            when "double_quotes"
+            when ENFORCED_STYLE_DOUBLE_QUOTES
               add_offense(node, arg.loc.expression, message) if arg.sym_type? || single_quotes?(arg)
-            when "single_quotes"
+            when ENFORCED_STYLE_SINGLE_QUOTES
               add_offense(node, arg.loc.expression, message) if arg.sym_type? || double_quotes?(arg)
             end
           end
@@ -85,21 +88,21 @@ module RuboCop
           _receiver, _method_name, *args = *node
 
           case cop_config["EnforcedStyle"]
-          when "symbol"
+          when ENFORCED_STYLE_SYMBOL
             lambda do |corrector|
               args.each do |arg|
                 content = arg_content(arg)
                 corrector.replace(arg_location(arg), to_symbol_literal(content)) if content
               end
             end
-          when "double_quotes"
+          when ENFORCED_STYLE_DOUBLE_QUOTES
             lambda do |corrector|
               args.each do |arg|
                 content = arg_content(arg)
                 corrector.replace(arg_location(arg), content.inspect) if content
               end
             end
-          when "single_quotes"
+          when ENFORCED_STYLE_SINGLE_QUOTES
             lambda do |corrector|
               args.each do |arg|
                 content = arg_content(arg)

data/lib/rubocop/cop/gemfile/single_group.rb

@@ -23,12 +23,12 @@ module RuboCop
 
           return unless method_name == :group
 
-          add_offense(node, arg_location(args)) if args.length >= 2
+          add_offense(node, args_location(args)) if args.length >= 2
         end
 
         private
 
-        def arg_location(args)
+        def args_location(args)
           begin_pos = args.first.loc.begin.begin_pos
           end_pos = args.last.loc.expression.end_pos
           Parser::Source::Range.new(args.first.loc.expression.source_buffer, begin_pos, end_pos)

data/lib/rubocop/cop/gemfile/sort_gem_ascending.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemfile
+      # This cop makes sure that `gem` is sorted by ascending
+      #
+      # @example
+      #   # TopGems: []
+      #
+      #   # bad
+      #   gem "sass-rails"
+      #   gem "coffee-rails"
+      #
+      #   # good
+      #   gem "coffee-rails"
+      #   gem "sass-rails"
+      #
+      #   # TopGems:
+      #   #   - rails
+      #
+      #   # bad
+      #   gem "coffee-rails"
+      #   gem "rails"
+      #   gem "sass-rails"
+      #
+      #   # good
+      #   gem "rails"
+      #   gem "coffee-rails"
+      #   gem "sass-rails"
+      class SortGemAscending < Cop
+        MSG = "gem should be sorted by ascending".freeze
+
+        def on_begin(node)
+          gems = string_arg_gems(node)
+
+          gems.each_cons(2) do |gem1, gem2|
+            gem_name1 = gem_name(gem1)
+            gem_name2 = gem_name(gem2)
+
+            if !top_gem?(gem1) && top_gem?(gem2)
+              add_offense(node, gem2.loc.expression, "gem '#{gem_name2}' should be top of Gemfile")
+            elsif top_gem?(gem1) && !top_gem?(gem2)
+              # nop
+            else
+              add_offense(node, gem2.loc.expression) if gem_name1 > gem_name2
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            gems        = string_arg_gems(node)
+            sorted_gems = gems.sort_by do |gem|
+              sort_key = top_gem?(gem) ? 0 : 1
+              [sort_key, gem_name(gem)]
+            end
+
+            gems_enum        = gems.to_enum
+            sorted_gems_enum = sorted_gems.to_enum
+
+            loop do
+              gem        = gems_enum.next
+              sorted_gem = sorted_gems_enum.next
+
+              unless gem == sorted_gem
+                corrector.replace(gem.loc.expression, sorted_gem.source)
+              end
+            end
+          end
+        end
+
+        private
+
+        def string_arg_gems(node)
+          gems = node.children.select { |n| gem_type?(n) }
+          gems.select { |gem| gem_name(gem) }
+        end
+
+        def gem_type?(node)
+          _, method_name, *_args = *node
+          method_name == :gem
+        end
+
+        def gem_name(node)
+          _, method_name, *args = *node
+
+          return nil unless method_name == :gem
+
+          arg = args.first
+          return nil unless arg
+          return nil unless arg.str_type?
+
+          arg.str_content
+        end
+
+        def top_gems
+          @top_gems ||= Array(cop_config["TopGems"])
+        end
+
+        def top_gem?(gem)
+          gem_name =
+            if gem.is_a?(RuboCop::Node)
+              gem_name(gem)
+            else
+              gem
+            end
+
+          top_gems.include?(gem_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/gemfile.rb

@@ -7,3 +7,4 @@ RuboCop::Gemfile::Inject.defaults!
 # cops
 require "rubocop/cop/gemfile/single_group"
 require "rubocop/cop/gemfile/group_type"
+require "rubocop/cop/gemfile/sort_gem_ascending"

data/lib/rubocop/gemfile/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Gemfile
-    VERSION = "0.1.0.beta1"
+    VERSION = "0.1.0.beta2"
   end
 end

data/lib/tasks/yard.rake

@@ -0,0 +1,7 @@
+require "yard"
+require "yard/rake/yardoc_task"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ["lib/**/*.rb"]
+  t.options = []
+  t.options << '--debug' << '--verbose' if $trace
+end

data/rubocop-gemfile.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5.0"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-gemfile
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: Code style checking for Gemfile
 email:
 - sue445@sue445.net
@@ -100,9 +114,11 @@ files:
 - lib/rubocop-gemfile.rb
 - lib/rubocop/cop/gemfile/group_type.rb
 - lib/rubocop/cop/gemfile/single_group.rb
+- lib/rubocop/cop/gemfile/sort_gem_ascending.rb
 - lib/rubocop/gemfile.rb
 - lib/rubocop/gemfile/inject.rb
 - lib/rubocop/gemfile/version.rb
+- lib/tasks/yard.rake
 - rubocop-gemfile.gemspec
 homepage: 
 licenses: