rubocop-itamae 0.1.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43b0711e43b2fe39e6b0b5115686d402e602801b3df7be1cdf397d4007ba4ad8
+  data.tar.gz: de4843a38e16ab19b2f4867d866a0a97ac1e23ace11742cada1d55b287bf7e4b
+SHA512:
+  metadata.gz: a684ebe47004196a3e0e203478207171f20deb418e7d0ca3afdbd503c77fa3a0bccd8bcb265cff9109efb4dc2d944aae2e30cd9d92f83e2b8c348b18092595eb
+  data.tar.gz: fe327d5b6f73761648e04f54510aef76332887f3eda1470880e473f614e49af26483f857244cf37834952433b3f891ad9e2c3224eae08c73a69d780a6f070c04

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  # rubocop requires ruby 2.1+ since v0.51.0
+  # https://github.com/rubocop-hq/rubocop/commit/753227914c1ad311e6116311fc1ef76d9b0904dc
+  TargetRubyVersion: 2.1
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Metrics/LineLength:
+  Exclude:
+    - "spec/spec_helper.rb"
+
+Style/HashSyntax:
+  Exclude:
+    - "Rakefile"

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master
+[full changelog](http://github.com/sue445/rubocop-itamae/compare/v0.1.0...master)
+
+## v0.1.0
+* first release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rubocop-itamae.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,39 @@
+# RuboCop::Itamae
+
+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/itamae`. 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-itamae'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-itamae
+
+## 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-itamae.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubocop/itamae'
+
+# 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(__FILE__)

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,9 @@
+Itamae/CdInExecute:
+  Description: Check that `cd` in `execute`.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-itamae/RuboCop/Cop/Itamae/CdInExecute
+
+Itamae/CommandEqualsToName:
+  Description: Check that `command` doesn't equals to name of `execute`.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-itamae/RuboCop/Cop/Itamae/CommandEqualsToName

data/lib/rubocop/cop/itamae/cd_in_execute.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Itamae
+      # Check that `cd` in `execute`.
+      #
+      # @example
+      #   # bad
+      #   execute 'cd /tmp && rm -rf /tmp/*'
+      #
+      #   # good
+      #   execute 'rm -rf /tmp/*' do
+      #     cwd '/tmp'
+      #   end
+      class CdInExecute < Cop
+        MSG = "Insert `cwd '%<dir>s'` and remove this.".freeze
+
+        def_node_search :find_execute_with_block, <<-PATTERN
+          (block
+            (send nil? :execute
+              (str $_)
+            )
+            args
+            $...
+          )
+        PATTERN
+
+        def_node_search :find_execute_without_block, <<-PATTERN
+          (send nil? :execute
+            (str $_)
+          )
+        PATTERN
+
+        def_node_search :find_command, <<-PATTERN
+          (send nil? :command
+            (str $_)
+          )
+        PATTERN
+
+        def on_block(node)
+          find_execute_with_block(node) do |name, param_nodes|
+            add_offence_for_execute_block_name(node, name)
+
+            param_nodes.compact.each do |param_node|
+              find_command(param_node) do |command|
+                add_offense_for_command_param(param_node, command)
+              end
+            end
+          end
+        end
+
+        def on_send(node)
+          return if node.parent && node.parent.block_type?
+
+          find_execute_without_block(node) do |name|
+            add_offense_for_execute_name(node, name)
+          end
+        end
+
+        # rubocop:disable Metrics/LineLength
+        # def autocorrect(node)
+        #   if node.block_type?
+        #     lambda do |corrector|
+        #       find_execute_with_block(node) do |name, param_nodes|
+        #         if offence_command?(name)
+        #           corrector.remove(cd_location(node.child_nodes.first.child_nodes.first, name))
+        #
+        #           # TODO: insert cwd
+        #           next
+        #         end
+        #       end
+        #     end
+        #   elsif node.begin_type?
+        #     lambda do |corrector|
+        #       find_command(node) do |command|
+        #         next unless offence_command?(command)
+        #
+        #         command_node = node.child_nodes.first.child_nodes.first
+        #         corrector.remove(cd_location(command_node, command))
+        #
+        #         # TODO: insert cwd
+        #       end
+        #     end
+        #   elsif node.send_type?
+        #     lambda do |corrector|
+        #       find_execute_without_block(node) do |name|
+        #         next unless offence_command?(name)
+        #
+        #         corrector.remove(cd_location(node.child_nodes.first, name))
+        #
+        #         # TODO: insert cwd
+        #       end
+        #
+        #       find_command(node) do |command|
+        #         next unless offence_command?(command)
+        #
+        #         command_node = node.child_nodes.first
+        #         corrector.remove(cd_location(command_node, command))
+        #
+        #         # TODO: insert cwd
+        #       end
+        #     end
+        #   end
+        # end
+        # rubocop:enable Metrics/LineLength
+
+        private
+
+        def add_offense_for_execute_name(node, name)
+          dir = cd_dir_in_command(name)
+          return unless dir
+
+          loc = cd_location(node.child_nodes.first, name)
+          add_offense(node, message: format(MSG, dir: dir), location: loc)
+        end
+
+        def add_offence_for_execute_block_name(node, name)
+          dir = cd_dir_in_command(name)
+          return unless dir
+
+          loc = cd_location(node.child_nodes.first.child_nodes.first, name)
+          add_offense(node, message: format(MSG, dir: dir), location: loc)
+        end
+
+        def add_offense_for_command_param(param_node, command)
+          dir = cd_dir_in_command(command)
+          return unless dir
+
+          command_node =
+            if param_node.child_nodes.first.child_nodes.empty?
+              param_node.child_nodes.first
+            else
+              param_node.child_nodes.first.child_nodes.first
+            end
+
+          loc = cd_location(command_node, command)
+          add_offense(param_node, message: format(MSG, dir: dir), location: loc)
+        end
+
+        def cd_dir_in_command(command)
+          dir, = parse_command(command)
+          dir
+        end
+
+        def parse_command(command)
+          command =~ /^\s*cd\s+(.+?)&&(.+)$/
+          if Regexp.last_match(1) && Regexp.last_match(2)
+            [Regexp.last_match(1).strip, Regexp.last_match(2).strip]
+          else
+            [nil, nil]
+          end
+        end
+
+        def cd_location(node, command)
+          _, second_command = parse_command(command)
+          second_command_pos = command.index(second_command)
+          begin_pos = node.loc.begin.end_pos
+          end_pos = begin_pos + second_command_pos
+          Parser::Source::Range.new(node.loc.expression.source_buffer,
+                                    begin_pos, end_pos)
+        end
+
+        # def indent_num(node)
+        #   node.loc.expression.source_buffer.source =~ /^(\s+)/
+        #
+        #   return Regexp.last_match(1).length if Regexp.last_match(1)
+        #   0
+        # end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/itamae/command_equals_to_name.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Itamae
+      # Check that `command` doesn't equals to name of `execute`.
+      #
+      # @example
+      #   # bad
+      #   execute 'rm -rf /tmp/*' do
+      #     command 'rm -rf /tmp/*'
+      #   end
+      #
+      #   # good
+      #   execute 'rm -rf /tmp/*'
+      #
+      #   execute 'Remove temporary files' do
+      #     command 'rm -rf /tmp/*'
+      #   end
+      class CommandEqualsToName < Cop
+        include RangeHelp
+
+        MSG = 'Prefer to omit `command` if `command` equals to ' \
+              'name of `execute`'.freeze
+
+        def_node_search :find_execute, <<-PATTERN
+          (block
+            (send nil? :execute
+              (str $_)
+            )
+            args
+            $...
+          )
+        PATTERN
+
+        def_node_search :find_command, <<-PATTERN
+          (send nil? :command
+            (str $_)
+          )
+        PATTERN
+
+        def on_block(node)
+          find_execute(node) do |name, param_nodes|
+            param_nodes.compact.each do |param_node|
+              find_command(param_node) do |command|
+                next unless name == command
+
+                add_offense(param_node, location: :expression)
+              end
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if node.begin_type?
+              node.each_child_node do |param_node|
+                remove_command_param(corrector, node.parent, param_node)
+              end
+
+            elsif node.send_type?
+              remove_command_param(corrector, node.parent, node)
+            end
+          end
+        end
+
+        private
+
+        def remove_command_param(corrector, parent_node, param_node)
+          find_execute(parent_node) do |name|
+            find_command(param_node) do |command|
+              next unless name == command
+
+              corrector.remove(node_range(param_node))
+            end
+          end
+        end
+
+        def node_range(node)
+          range_by_whole_lines(node.source_range, include_final_newline: true)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/itamae_cops.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'itamae/cd_in_execute'
+require_relative 'itamae/command_equals_to_name'

data/lib/rubocop/itamae/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Itamae
+    VERSION = '0.1.0.alpha1'.freeze
+  end
+end

data/lib/rubocop/itamae.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubocop/itamae/version'
+
+module RuboCop
+  module Itamae # rubocop:disable Style/Documentation
+    # Your code goes here...
+  end
+end

data/lib/rubocop-itamae.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/itamae'
+require_relative 'rubocop/itamae/version'
+
+require_relative 'rubocop/cop/itamae_cops'

data/rubocop-itamae.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/itamae/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rubocop-itamae'
+  spec.version       = RuboCop::Itamae::VERSION
+  spec.authors       = ['sue445']
+  spec.email         = ['sue445@sue445.net']
+
+  spec.summary       = 'Code style checking for itamae recipes'
+  spec.description   = 'Code style checking for itamae recipes'
+  spec.homepage      = 'https://github.com/sue445/rubocop-itamae'
+  spec.license       = 'MIT'
+
+  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_dependency 'rubocop'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '>= 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/tasks/new_cop.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+desc 'Generate a new cop template'
+task :new_cop, [:cop] do |_task, args|
+  cop_name = args.fetch(:cop) do
+    warn 'usage: bundle exec rake new_cop[Department/Name]'
+    exit!
+  end
+
+  github_user = `git config github.user`.chop
+  github_user = 'your_id' if github_user.empty?
+
+  generator = RuboCop::Cop::Generator.new(cop_name, github_user)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: 'lib/rubocop/cop/itamae_cops.rb')
+
+  begin
+    generator.inject_config(config_file_path: 'config/default.yml')
+  rescue TypeError # rubocop:disable Lint/HandleExceptions
+    # nop
+  end
+
+  # puts generator.todo
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-itamae
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha1
+platform: ruby
+authors:
+- sue445
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.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'
+description: Code style checking for itamae recipes
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-itamae.rb
+- lib/rubocop/cop/itamae/cd_in_execute.rb
+- lib/rubocop/cop/itamae/command_equals_to_name.rb
+- lib/rubocop/cop/itamae_cops.rb
+- lib/rubocop/itamae.rb
+- lib/rubocop/itamae/version.rb
+- rubocop-itamae.gemspec
+- tasks/new_cop.rake
+homepage: https://github.com/sue445/rubocop-itamae
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Code style checking for itamae recipes
+test_files: []