inspecstyle 0.1.3 → 0.2.1

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# NOTE TO SELF - this one works BUT not if other its statements are defined. Needs
+# to work in any arrangement. This is a powerful one to crack as this pattern
+# will be used in a LOT of other cops.
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # Users resource deprecated matchers
+      #
+      # @example EnforcedStyle: InSpecStyle (default)
+      #
+      #   # bad
+      #   describe users('/etc/my-custom-place/users') do
+      #     its('has_home_directory?') { should eq 'foo' }
+      #   end
+      #
+      #   # good
+      #   describe users('/etc/my-custom-place/users') do
+      #     its('users') { should eq 'foo' }
+      #   end
+      #
+      class UsersResourceMatchers < Cop
+        MSG = 'Use `%<solution>s` instead of `%<violation>s` as a matcher ' \
+        "for the `users` resource. \nThis matcher will be removed in InSpec 5"
+
+        MAP = {
+            has_home_directory?: "its('home')",
+            has_login_shell?: "its('shell')",
+            has_authorized_key?: "another matcher",
+            maximum_days_between_password_change: :maxdays,
+            has_uid?: "another matcher",
+            minimum_days_between_password_change: "mindays"
+          }
+
+        def_node_matcher :deprecated_users_matcher?, <<~PATTERN
+          (send _ ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
+        PATTERN
+
+        def_node_matcher :spec?, <<-PATTERN
+          (block
+            (send nil? :describe ...)
+          ...)
+        PATTERN
+
+        def_node_matcher :users_resource?, <<-PATTERN
+          (block
+            (send nil? :describe
+              (send nil? :users ...)
+            ...)
+          ...)
+        PATTERN
+
+        def on_block(node)
+          return unless inside_users_spec?(node)
+          node.descendants.each do |descendant|
+            deprecated_users_matcher?(descendant) do |violation|
+              add_offense(
+                descendant,
+                location: offense_range(descendant),
+                message: format(
+                  MSG,
+                  violation: violation,
+                  solution: MAP[violation]
+                )
+              )
+            end
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            # Only these two matchers are autocorrectable
+            [
+              'maximum_days_between_password_change',
+              'minimum_days_between_password_change'
+            ].map do |violation|
+              if node.inspect.include?(violation)
+                corrector.replace(node.loc.selector, MAP[violation.to_sym])
+              end
+            end
+          end
+        end
+
+        private
+
+        def inside_users_spec?(root)
+          spec?(root) && users_resource?(root)
+        end
+
+        def offense_range(node)
+          node.loc.selector
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # windows_registry_key has been deprecated as a resource. Use registry_key instead
+      #
+      class WindowsRegistryKey < Cop
+        MSG = 'Use `registry_key` instead of `windows_registry_key`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :windows_registry_key?, <<~PATTERN
+          (send _ :windows_registry_key ...)
+        PATTERN
+
+        def on_send(node)
+          return unless windows_registry_key?(node)
+          add_offense(node, location: :selector)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module InSpecStyle
+      # @example EnforcedStyle: InSpecStyle (default)
+      #   # wmi_wmis_class has been deprecated as a resource. Use iis_site instead
+      #
+      class WmiWmisClass < Cop
+        MSG = 'Use `iis_site` instead of `wmi_wmis_class`. '\
+              'This resource will be removed in InSpec 5.'
+
+        def_node_matcher :wmi_wmis_class?, <<~PATTERN
+          (send _ :wmi
+            (str "wmisclass") ...)
+        PATTERN
+
+        def on_send(node)
+          return unless wmi_wmis_class?(node)
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.source_range, preferred_replacement)
+          end
+        end
+
+        private
+
+        def preferred_replacement
+          cop_config.fetch('PreferredReplacement')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/inspecstyle_cops.rb

@@ -1,4 +1,20 @@
 # frozen_string_literal: true
-require_relative 'inspecstyle/first_cop'
-require_relative 'inspecstyle/deprecated_attributes'
 require_relative 'inspecstyle/azure_generic_resource'
+require_relative 'inspecstyle/shadow_properties'
+require_relative 'inspecstyle/oracle_db_session_pass'
+require_relative 'inspecstyle/file_size'
+require_relative 'inspecstyle/apache'
+require_relative 'inspecstyle/script_resource'
+require_relative 'inspecstyle/users_resource_matchers'
+require_relative 'inspecstyle/iis_website'
+require_relative 'inspecstyle/host_proto'
+require_relative 'inspecstyle/linux_kernel_parameter'
+require_relative 'inspecstyle/mssql_session_pass'
+require_relative 'inspecstyle/ppa_resource'
+require_relative 'inspecstyle/processes_list'
+require_relative 'inspecstyle/windows_registry_key'
+require_relative 'inspecstyle/aws_iam_user_property'
+require_relative 'inspecstyle/file_be_mounted'
+require_relative 'inspecstyle/wmi_wmis_class'
+require_relative 'inspecstyle/deprecated_attributes1'
+require_relative 'inspecstyle/deprecated_attributes'

data/lib/rubocop/inspecstyle/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module InSpecStyle
-    VERSION = "0.1.3"
+    VERSION = "0.2.1"
   end
 end

data/notes-for-development.md

@@ -42,4 +42,14 @@ node = source.ast
 node.type
 node.children
 node.source
+NodePattern.new('(send ...)').match(node) # => true
 ```
+
+- Implement CI
+
+Correction docs at rubocop's: lib/rubocop/cop/corrector.rb
+
+### Great Repos for cop examples
+- rubocop-ast
+- rubocop-rspec
+- rubocop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspecstyle
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Nick Schwaderer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -49,9 +49,26 @@ files:
 - doc/RuboCop.html
 - doc/RuboCop/Cop.html
 - doc/RuboCop/Cop/InSpecStyle.html
+- doc/RuboCop/Cop/InSpecStyle/Apache.html
+- doc/RuboCop/Cop/InSpecStyle/AwsIamUserProperty.html
 - doc/RuboCop/Cop/InSpecStyle/AzureGenericResource.html
 - doc/RuboCop/Cop/InSpecStyle/DeprecatedAttributes.html
+- doc/RuboCop/Cop/InSpecStyle/DeprecatedAttributes1.html
+- doc/RuboCop/Cop/InSpecStyle/FileBeMounted.html
+- doc/RuboCop/Cop/InSpecStyle/FileSize.html
 - doc/RuboCop/Cop/InSpecStyle/FirstCop.html
+- doc/RuboCop/Cop/InSpecStyle/HostProto.html
+- doc/RuboCop/Cop/InSpecStyle/IisWebsite.html
+- doc/RuboCop/Cop/InSpecStyle/LinuxKernelParameter.html
+- doc/RuboCop/Cop/InSpecStyle/MSSQLSessionPass.html
+- doc/RuboCop/Cop/InSpecStyle/OracleDbSessionPass.html
+- doc/RuboCop/Cop/InSpecStyle/PPAResource.html
+- doc/RuboCop/Cop/InSpecStyle/ProcessesList.html
+- doc/RuboCop/Cop/InSpecStyle/ScriptResource.html
+- doc/RuboCop/Cop/InSpecStyle/ShadowProperties.html
+- doc/RuboCop/Cop/InSpecStyle/UsersResourceMatchers.html
+- doc/RuboCop/Cop/InSpecStyle/WindowsRegistryKey.html
+- doc/RuboCop/Cop/InSpecStyle/WmiWmisClass.html
 - doc/RuboCop/InSpecStyle.html
 - doc/RuboCop/InSpecStyle/Error.html
 - doc/RuboCop/InSpecStyle/Inject.html
@@ -71,9 +88,25 @@ files:
 - doc/top-level-namespace.html
 - inspecstyle.gemspec
 - lib/inspecstyle.rb
+- lib/rubocop/cop/inspecstyle/apache.rb
+- lib/rubocop/cop/inspecstyle/aws_iam_user_property.rb
 - lib/rubocop/cop/inspecstyle/azure_generic_resource.rb
 - lib/rubocop/cop/inspecstyle/deprecated_attributes.rb
-- lib/rubocop/cop/inspecstyle/first_cop.rb
+- lib/rubocop/cop/inspecstyle/deprecated_attributes1.rb
+- lib/rubocop/cop/inspecstyle/file_be_mounted.rb
+- lib/rubocop/cop/inspecstyle/file_size.rb
+- lib/rubocop/cop/inspecstyle/host_proto.rb
+- lib/rubocop/cop/inspecstyle/iis_website.rb
+- lib/rubocop/cop/inspecstyle/linux_kernel_parameter.rb
+- lib/rubocop/cop/inspecstyle/mssql_session_pass.rb
+- lib/rubocop/cop/inspecstyle/oracle_db_session_pass.rb
+- lib/rubocop/cop/inspecstyle/ppa_resource.rb
+- lib/rubocop/cop/inspecstyle/processes_list.rb
+- lib/rubocop/cop/inspecstyle/script_resource.rb
+- lib/rubocop/cop/inspecstyle/shadow_properties.rb
+- lib/rubocop/cop/inspecstyle/users_resource_matchers.rb
+- lib/rubocop/cop/inspecstyle/windows_registry_key.rb
+- lib/rubocop/cop/inspecstyle/wmi_wmis_class.rb
 - lib/rubocop/cop/inspecstyle_cops.rb
 - lib/rubocop/inspecstyle.rb
 - lib/rubocop/inspecstyle/inject.rb

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

@@ -1,69 +0,0 @@
-# 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