rubocop-gemfile 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed344acd76ba9e93b93397e7e4f9871e97dd32ba
+  data.tar.gz: df19136e1b5e6af09269089f6ab71648f9f69bf0
+SHA512:
+  metadata.gz: e70539e5cb5bc38f46ef40014de5592623dbba972e837dc80a70de4308344ae00488d57e2d818cc3aa7f6f9b15c8967cdeca4fa4008f5635f95b9fd9746bc545
+  data.tar.gz: 9c77b8c820ad81e3d13a268192686a0d9ff1ac28b5a2410fc3c84475e778015d5dcd2bdb594d469b2fb63147b1b363a0543f67e4968d6881d8aff5eaf98b2a21

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 sue445
+
+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,41 @@
+# RuboCop::Gemfile
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/gemfile`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-gemfile'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-gemfile
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/[USERNAME]/rubocop-gemfile.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "rubocop/gemfile"
+
+# 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/config/default.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Gemfile:
+    Patterns:
+    - "Gemfile"
+
+Gemfile/SingleGroup:
+  Description: "Check that `group` method has single group name"
+  Enabled: true
+
+Gemfile/GroupType:
+  Description: "Use enforced type group"
+  EnforcedStyle: symbol
+  SupportedStyles:
+    - symbol
+    - double_quotes
+    - single_quotes
+  Enabled: true

data/lib/rubocop-gemfile.rb

@@ -0,0 +1 @@
+require "rubocop/gemfile"

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemfile
+      # This cop makes sure that `group` has symbol group name
+      #
+      # @example
+      #
+      #   EnforcedStyle: symbol
+      #
+      #   # bad
+      #   group "test" do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   group 'test' do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   # good
+      #   group :test do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   EnforcedStyle: single_quotes
+      #
+      #   # bad
+      #   group :test do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   group "test" do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   # good
+      #   group 'test' do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   EnforcedStyle: double_quotes
+      #
+      #   # bad
+      #   group :test do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   group 'test' do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   # good
+      #   group "test" do
+      #     gem "rspec-rails"
+      #   end
+      class GroupType < Cop
+        MSG = 'Use %s group'.freeze
+
+        def on_send(node)
+          _, method_name, *args = *node
+
+          return unless method_name == :group
+
+          enforced_style = cop_config["EnforcedStyle"]
+          unless cop_config["SupportedStyles"].include?(enforced_style)
+            raise ValidationError, "EnforcedStyle(#{enforced_style}) is not neither double_quotes, single_quotes or symbol"
+          end
+
+          message = MSG % enforced_style
+
+          args.each do |arg|
+            case enforced_style
+            when "symbol"
+              add_offense(node, arg.loc.expression, message) if arg.str_type?
+            when "double_quotes"
+              add_offense(node, arg.loc.expression, message) if arg.sym_type? || single_quotes?(arg)
+            when "single_quotes"
+              add_offense(node, arg.loc.expression, message) if arg.sym_type? || double_quotes?(arg)
+            end
+          end
+        end
+
+        def autocorrect(node)
+          _receiver, _method_name, *args = *node
+
+          case cop_config["EnforcedStyle"]
+          when "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"
+            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"
+            lambda do |corrector|
+              args.each do |arg|
+                content = arg_content(arg)
+                corrector.replace(arg_location(arg), to_string_literal(content)) if content
+              end
+            end
+          end
+        end
+
+        private
+
+        def single_quotes?(arg)
+          quotes?(arg, "'")
+        end
+
+        def double_quotes?(arg)
+          quotes?(arg, '"')
+        end
+
+        def quotes?(arg, quote)
+          arg.str_type? && arg.loc.expression.source_buffer.source[arg.loc.begin.begin_pos] == quote
+        end
+
+        def arg_location(arg)
+          begin_pos = arg.loc.begin.begin_pos
+          end_pos = arg.loc.expression.end_pos
+          Parser::Source::Range.new(arg.loc.expression.source_buffer, begin_pos, end_pos)
+        end
+
+        def arg_content(arg)
+          if arg.sym_type?
+            arg.to_a.first.to_s
+          elsif arg.str_type?
+            arg.str_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Gemfile
+      # This cop makes sure that `group` method has single group name
+      #
+      # @example
+      #   # bad
+      #   group :test, :development do
+      #     gem "rspec-rails"
+      #   end
+      #
+      #   # good
+      #   group :test do
+      #     gem "rspec-rails", group: :development
+      #   end
+      class SingleGroup < Cop
+        MSG = '`group` should not have multiple groups'.freeze
+
+        def on_send(node)
+          _, method_name, *args = *node
+
+          return unless method_name == :group
+
+          add_offense(node, arg_location(args)) if args.length >= 2
+        end
+
+        private
+
+        def arg_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)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/gemfile.rb

@@ -0,0 +1,9 @@
+require "rubocop"
+require "rubocop/gemfile/version"
+require "rubocop/gemfile/inject"
+
+RuboCop::Gemfile::Inject.defaults!
+
+# cops
+require "rubocop/cop/gemfile/single_group"
+require "rubocop/cop/gemfile/group_type"

data/lib/rubocop/gemfile/inject.rb

@@ -0,0 +1,20 @@
+module RuboCop
+  module Gemfile
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      DEFAULT_FILE = File.expand_path(
+        '../../../../config/default.yml', __FILE__
+      )
+
+      def self.defaults!
+        path = File.absolute_path(DEFAULT_FILE)
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path)
+        puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/gemfile/version.rb

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

data/rubocop-gemfile.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/gemfile/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-gemfile"
+  spec.version       = RuboCop::Gemfile::VERSION
+  spec.authors       = ["sue445"]
+  spec.email         = ["sue445@sue445.net"]
+
+  spec.summary       = %q{Code style checking for Gemfile}
+  spec.description   = %q{Code style checking for Gemfile}
+  # TODO make public
+  # spec.homepage      = "https://github.com/sue445/rubocop-gemfile"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop", ">= 0.35.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-gemfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- sue445
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry-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: 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.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Code style checking for Gemfile
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-gemfile.rb
+- lib/rubocop/cop/gemfile/group_type.rb
+- lib/rubocop/cop/gemfile/single_group.rb
+- lib/rubocop/gemfile.rb
+- lib/rubocop/gemfile/inject.rb
+- lib/rubocop/gemfile/version.rb
+- rubocop-gemfile.gemspec
+homepage: 
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Code style checking for Gemfile
+test_files: []