rubocop-facter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46f23a12f0b06ea5ef21512d8445a38ffe5c6fa0
+  data.tar.gz: d4c33c8a59a38ee1b2e7c94fd2f6814f151afea4
+SHA512:
+  metadata.gz: ff13ef23e6f4fcb3e4453522672a3a8750d33deb76211fb664d3e592572dd500785fe37d9e92f071b46d43611c7904afaca237d9bd2ed2a5dfacef66b1c95d33
+  data.tar.gz: 59f728e346ac41febb70e012813fbb750e3056569f84310eb18b1d5b92c6d3a97c239f57bf416fa2eb8323f3712a048a9274e1ff396f7599a33db41c2128f02d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.2.0
+
+ - Detect use of `require facter/util/*`, which no longer exists in recent versions of Facter.
+
+## 0.1.0
+
+ - Support for detection of `require_relative` in custom facts.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at zee@zee.space. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,35 @@
+# rubocop-facter
+
+The goal of `rubocop-facter` is to extend rubocop to support facter-specific checks. 
+There are various "gotchas" that apply to facter specifically, and not general Ruby programming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-facter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-facter
+
+## 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-facter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :rubocop
+
+RuboCop::RakeTask.new

data/config/default.yml

@@ -0,0 +1,3 @@
+Facter/RequireRelative:
+  Description: 'Check that custom facts are not using require_relative'
+  Enabled: true

data/lib/rubocop/cop/facter/facter_util.rb

@@ -0,0 +1,25 @@
+module RuboCop
+  module Cop
+    module Facter
+      # Check that custom facts do not require files in facter/util, as they've all been removed in cfacter.
+      #
+      # @example
+      #   # bad
+      #   Facter::Util::Macaddress.standardize('eth1')
+      #
+      #   # good
+      #   Facter::Core::Resolution.exec('ip  addr show eth1|sed -n 2p').split(' ')[1]
+      class FacterUtil < Cop
+        # rubocop:disable Metrics/LineLength
+        MSG = 'Functionality under facter/util has been mostly removed and must be implemented at the fact-level'.freeze
+        # rubocop:enable Metrics/LineLength
+
+        def on_send(node)
+          _receiver, method_name, *args = *node
+
+          add_offense(node, :selector) if (method_name == :require && _receiver == nil && args.first.children.first =~ /facter\/util/)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/facter/require_relative.rb

@@ -0,0 +1,28 @@
+module RuboCop
+  module Cop
+    module Facter
+      # Check that custom facts do no use require_relative, as many Puppet deployments
+      # may be using a version of Ruby that doesn't support it. require_relative was
+      # introduced in Ruby 1.9.3, but many Puppet installations still use 1.8.7, as this
+      # is the default version supplied with RHEL 6
+      #
+      # @example
+      #   # bad
+      #   require_relative 'helpers/custom_fact_helper'
+      #
+      #   # good
+      #   require 'helpers/custom_fact_helper'
+      class RequireRelative < Cop
+        # rubocop:disable Metrics/LineLength
+        MSG = 'Avoid use of `require_relative` as it is not supported in Ruby 1.8.7, still used in many Puppet deployments'.freeze
+        # rubocop:enable Metrics/LineLength
+
+        def on_send(node)
+          _receiver, method_name, *args = *node
+
+          add_offense(node, :selector) if (method_name == :require_relative && _receiver == nil)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/facter/inject.rb

@@ -0,0 +1,18 @@
+module RuboCop
+  module Facter
+    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/facter/version.rb

@@ -0,0 +1,14 @@
+module RuboCop
+  module Facter
+    # Central reference point for current version of rubocop-facter
+    module Version
+      # rubocop:disable all
+      VERSION = '0.2.0'
+      # rubocop:enable all
+
+      def self.current
+        VERSION
+      end
+    end
+  end
+end

data/lib/rubocop-facter.rb

@@ -0,0 +1,16 @@
+require 'rubocop'
+require 'rubocop/facter/version'
+require 'rubocop/facter/inject'
+
+module RuboCop
+  module Cop
+    module Facter
+
+    end
+  end
+end
+RuboCop::Facter::Inject.defaults!
+
+# cops
+require 'rubocop/cop/facter/require_relative'
+require 'rubocop/cop/facter/facter_util'

data/rubocop-facter.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/facter/version'
+
+Gem::Specification.new do |spec|
+  # rubocop:disable Metrics/LineLength
+  spec.name          = 'rubocop-facter'
+  spec.version       = RuboCop::Facter::Version.current
+  spec.authors       = ['Zee Alexander']
+  spec.email         = ['zee@puppet.com']
+  spec.license       = 'Apache-2.0'
+
+  spec.summary       = 'RuboCop Custom Cops for Puppet/Facter Custom Facts'
+  spec.homepage      = 'https://github.com/pizzaops/rubocop-facter'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = ['>= 1.9.3']
+
+  spec.add_dependency 'rubocop', '~> 0.33'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0', '< 11'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  # rubocop:enable Metrics/LineLength
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-facter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Zee Alexander
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-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.33'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.33'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- zee@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop-facter.rb
+- lib/rubocop/cop/facter/facter_util.rb
+- lib/rubocop/cop/facter/require_relative.rb
+- lib/rubocop/facter/inject.rb
+- lib/rubocop/facter/version.rb
+- rubocop-facter.gemspec
+homepage: https://github.com/pizzaops/rubocop-facter
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: RuboCop Custom Cops for Puppet/Facter Custom Facts
+test_files: []