rubocop-inspecstyle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d113b952084f3a04f6adf9d76f47de6600cc53345da010a107cecd16cc53bd4
+  data.tar.gz: c783bd9c1d0bf84bfb81f4996949d5389a5ed87af18bb4f3de0b564e59d4fb6a
+SHA512:
+  metadata.gz: adade677d6740709fd7b05fd7783e28f79b6aa2acc064af5b7e0286aac84a1697a7a00eb0055f6da74ebaf8f8253f3290dc77608477a15a09f5e6d47bc6c33a4
+  data.tar.gz: c2cdaf1f8e2bc644fa0e2a1f877466caa59f5dfe5484cf2d01981b9b82a0d926ac15459ff9f19bc86820c6c6fb611172992d3c69ec4a288e5567d1d0a2a1cebc

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Naming/FileName:
+ Exclude:
+   - lib/rubocop-inspecstyle.rb

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nschwaderer@chef.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-inspecstyle.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    rubocop-inspecstyle (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    minitest (5.14.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.81.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rspec
+  rubocop-inspecstyle!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Nick Schwaderer
+
+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,44 @@
+# Rubocop::InSpecStyle
+
+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/inspecstyle`. 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-inspecstyle', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-inspecstyle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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-inspecstyle. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-inspecstyle/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::InSpecStyle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-inspecstyle/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Generate a new cop with a template'
+task :new_cop, [:cop] do |_task, args|
+  require 'rubocop'
+
+  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/inspecstyle_cops.rb')
+  generator.inject_config(config_file_path: 'config/default.yml')
+
+  puts generator.todo
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/inspecstyle"
+
+# 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 @@
+InSpecStyle/DeprecatedAttributes:
+  Description: 'Attributes are deprecated in favor of inputs'
+  Enabled: true
+  VersionAdded: '0.82'
+
+InspecStyle/FirstCop:
+  Description: 'This first cop is a sandbox for exploring new InspecStyle cops.'
+  Enabled: true
+  VersionAdded: '0.82'

data/lib/rubocop-inspecstyle.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/inspecstyle'
+require_relative 'rubocop/inspecstyle/version'
+require_relative 'rubocop/inspecstyle/inject'
+
+RuboCop::InSpecStyle::Inject.defaults!
+
+require_relative 'rubocop/cop/inspecstyle_cops'

data/lib/rubocop/cop/inspecstyle/deprecated_attributes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# TODO: when finished, run `rake generate_cops_documentation` to update the docs
+module RuboCop
+  module Cop
+    module InSpecStyle
+      #
+      # @example DeprecatedAttributes: Do not use attributes
+      #   # Attributes have been deprecated for inputs
+      #   # https://github.com/inspec/inspec/issues/3802
+      #
+      #   # bad
+      #   attribute('my_element', value: 10)
+      #
+      #   # good
+      #   input('my_element', value: 10)
+      #
+      class DeprecatedAttributes < Cop
+        include RangeHelp
+
+        MSG = 'Use `#input` instead of `#attribute`.'
+
+        def_node_matcher :attribute?, <<~PATTERN
+          (send nil? :attribute ...)
+        PATTERN
+
+        def on_send(node)
+          return unless attribute?(node)
+          add_offense(node, location: range(node))
+        end
+
+        private
+
+        def range(node)
+          # Only highlights the method 'attribute'
+          range_between(node.source_range.begin_pos,
+            node.source_range.begin_pos+9
+          )
+        end
+
+        # def autocorrect
+        #   ->(corrector) do
+        #     corrector.insert_before(node.source_range, 'input')
+        #     corrector.remove(node.source_range, 'attribute')
+        #   end
+        # end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle/first_cop.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# TODO: when finished, run `rake generate_cops_documentation` to update the docs
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # TODO: Write cop description and example of bad / good code. For every
+      # `SupportedStyle` and unique configuration, there needs to be examples.
+      # Examples must have valid Ruby syntax. Do not use upticks.
+      #
+      # @example EnforcedStyle: bar (default)
+      #   # Description of the `bar` style.
+      #
+      #   # bad
+      #   bad_bar_method
+      #
+      #   # bad
+      #   bad_bar_method(args)
+      #
+      #   # good
+      #   good_bar_method
+      #
+      #   # good
+      #   good_bar_method(args)
+      #
+      # @example EnforcedStyle: foo
+      #   # Description of the `foo` style.
+      #
+      #   # bad
+      #   bad_foo_method
+      #
+      #   # bad
+      #   bad_foo_method(args)
+      #
+      #   # good
+      #   good_foo_method
+      #
+      #   # good
+      #   good_foo_method(args)
+      #
+      class FirstCop < Cop
+        # TODO: Implement the cop in here.
+        #
+        # In many cases, you can use a node matcher for matching node pattern.
+        # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
+        #
+        # For example
+        MSG = 'Use `#good_method` instead of `#bad_method`. %<example_insertion>'
+
+        def_node_matcher :bad_method?, <<~PATTERN
+          (send nil? :bad_method ...)
+        PATTERN
+
+        def on_send(node)
+          return unless bad_method?(node)
+          message = format(MSG, example_insertion: node.first.source)
+          add_offense(node, message: message)
+        end
+
+        def autocorrect(node)
+          ->(corrector) do
+            corrector.insert_before(node.source_range, 'good_method')
+            corrector.remove(node.source_range)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require_relative 'inspecstyle/first_cop'
+require_relative 'inspecstyle/deprecated_attributes'

data/lib/rubocop/inspecstyle.rb

@@ -0,0 +1,14 @@
+require "rubocop/inspecstyle/version"
+
+module RuboCop
+  module InSpecStyle
+    class Error < StandardError; end
+    # Your code goes here...
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end
+

data/lib/rubocop/inspecstyle/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module InSpecStyle
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/inspecstyle/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module InSpecStyle
+    VERSION = "0.1.0"
+  end
+end

data/notes-for-development.md

@@ -0,0 +1,41 @@
+# Notes for Dev
+
+These are generic personal notes for useful documentation, approaches, and development strategies around constructing InSpecStyle. It's a bit hacked together like I will do for personal notes, but keeping together before this goes live to help others who might want to hack on InSpecStyle for the first time
+
+- Toolsets for cop development: https://github.com/rubocop-hq/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc
+
+- https://docs.rubocop.org/rubocop/development.html
+
+- Advanced example custom cop: https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/cop/rspec/not_to_not.rb
+
+- https://www.rubyguides.com/2015/08/static-analysis-in-ruby/
+
+- https://blog.arkency.com/using-ruby-parser-and-ast-tree-to-find-deprecated-syntax/
+
+- attribute autocorrect (audit-cookbook)
+
+- https://www.rubydoc.info/gems/rubocop-ast/RuboCop/AST/NodePattern
+
+- hack on these specs locally and docs to learn https://github.com/rubocop-hq/rubocop-ast
+
+<!-- (cookstyle)
+
+- part of inspec (& check)
+- part of cookstyle
+- atom -->
+
+```
+ruby-parse -e '1'
+(int 1)
+```
+
+Processing via IRB for AST parsing:
+
+```ruby
+code = '!something.empty?'
+source = RuboCop::ProcessedSource.new(code, RUBY_VERSION.to_f)
+node = source.ast
+node.type
+node.children
+node.source
+```

data/rubocop-inspecstyle.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rubocop/inspecstyle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-inspecstyle"
+  spec.version       = RuboCop::InSpecStyle::VERSION
+  spec.authors       = ["Nick Schwaderer"]
+  spec.email         = ["nschwaderer@chef.io"]
+
+  spec.summary       = %q{Preferred styling and performant InSpec code.}
+  spec.description   = %q{InSpecStyle allows InSpec developers to write code with predictable styling and in a secure/performant manner.}
+  spec.homepage      = "https://github.com/schwad/rubocop-inspecstyle"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/schwad/rubocop-inspecstyle"
+  spec.metadata["changelog_uri"] = "https://github.com/schwad/rubocop-inspecstyle"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-inspecstyle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Schwaderer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-10 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'
+description: InSpecStyle allows InSpec developers to write code with predictable styling
+  and in a secure/performant manner.
+email:
+- nschwaderer@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-inspecstyle.rb
+- lib/rubocop/cop/inspecstyle/deprecated_attributes.rb
+- lib/rubocop/cop/inspecstyle/first_cop.rb
+- lib/rubocop/cop/inspecstyle_cops.rb
+- lib/rubocop/inspecstyle.rb
+- lib/rubocop/inspecstyle/inject.rb
+- lib/rubocop/inspecstyle/version.rb
+- notes-for-development.md
+- rubocop-inspecstyle.gemspec
+homepage: https://github.com/schwad/rubocop-inspecstyle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/schwad/rubocop-inspecstyle
+  source_code_uri: https://github.com/schwad/rubocop-inspecstyle
+  changelog_uri: https://github.com/schwad/rubocop-inspecstyle
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Preferred styling and performant InSpec code.
+test_files: []