rubocop-openhab-scripting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 955f29cdd76ba5e7858aaa48cc1ceb9b303a4f517927bce3a1192649f058959e
+  data.tar.gz: a5f2b10777e796688fde4c4d2e97d37c8d2da10fd299a08bb6093f2e65748826
+SHA512:
+  metadata.gz: 1eda9a0893cd037dc92d8789bc4c077be92a36b655e50f1af85ee62efa2ed2b81d8e00a8e5bbc069a430a089f7a8155c31648d5288ce047dc4c6c547a8585c00
+  data.tar.gz: 9af9e6189c68c27ad52b9bdcec5e896080ddeed5591708afca0c8e5b19395a269c900dd20faf9fa96a830542ce67f51b3505f9a8cb902648d572aed4d0654fe5

data/config/default.yml

@@ -0,0 +1,8 @@
+OpenHAB:
+  Enabled: true
+  Include:
+    - '**/ruby/personal/**/*.rb'
+
+OpenHAB/StatePredicate:
+  Description: 'When comparing against named states and commands, prefer predicate methods.'
+  Enabled: true

data/lib/rubocop/cop/openhab/state_predicate.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenHAB
+      # When comparing against named states and commands, prefer predicate methods.
+      #
+      # @example
+      #   # bad
+      #   Switch == ON
+      #
+      #   # bad
+      #   event.command == UP
+      #
+      #   # good
+      #   Switch.on?
+      #
+      #   # good
+      #   event.command.up?
+      #
+      class StatePredicate < Base
+        MSG = "Use `%<predicate>s?` instead of `== %<constant>s`."
+
+        METHODS = %i[
+          REFRESH
+          OPEN
+          CLOSED
+          ON
+          OFF
+          INCREASE
+          DECREASE
+          UP
+          DOWN
+          STOP
+          MOVE
+          PLAYING
+          PAUSED
+          REWINDING
+          FASTFORWARDING
+          PLAY
+          PAUSE
+          REWIND
+          FASTFORWARD
+          NEXT
+          PREVIOUS
+        ].to_set.freeze
+        def_node_matcher :bad_comparison?, <<~PATTERN
+          (send _ :== (const nil? $METHODS))
+        PATTERN
+
+        def message(constant)
+          format(MSG, predicate: constant.downcase, constant: constant)
+        end
+
+        def on_send(node)
+          bad_comparison?(node) { |constant| add_offense(node, message: message(constant)) }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/openhab_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "openhab/state_predicate"

data/lib/rubocop/openhab/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 OpenHAB
+    # 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/openhab/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module OpenHAB
+    VERSION = "0.1.0"
+  end
+end

data/lib/rubocop/openhab.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "openhab/version"
+
+module RuboCop
+  module OpenHAB
+    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-openhab.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/openhab"
+require_relative "rubocop/openhab/version"
+require_relative "rubocop/openhab/inject"
+
+RuboCop::OpenHAB::Inject.defaults!
+
+require_relative "rubocop/cop/openhab_cops"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-openhab-scripting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description:
+email:
+- cody@cutrer.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config/default.yml
+- lib/rubocop-openhab.rb
+- lib/rubocop/cop/openhab/state_predicate.rb
+- lib/rubocop/cop/openhab_cops.rb
+- lib/rubocop/openhab.rb
+- lib/rubocop/openhab/inject.rb
+- lib/rubocop/openhab/version.rb
+homepage: https://github.com/ccutrer/rubocop-openhab-scripting
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ccutrer/rubocop-openhab-scripting
+  source_code_uri: https://github.com/ccutrer/rubocop-openhab-scripting
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.27
+signing_key:
+specification_version: 4
+summary: RuboCop cops for openhab-scripting rules
+test_files: []