manageiq-style 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87713f5170c0b2e2264839443cd86efd7e0a2e0cf7350520c40bf3cad60a569d
-  data.tar.gz: 954625f619b519fe56af127ad53ba885e2c53b8accf191dcbd6bde88dbaca507
+  metadata.gz: 0c39d38f4271a8073edeef202ee92a1384823b678c273b5e21875d8b21af4dd7
+  data.tar.gz: 22c988be09d434be7fb20d06b96c6e1209711c073a2ddc6911537d35a29fe6ec
 SHA512:
-  metadata.gz: a4609edf44018bd8c3b0f315fbde1b8a36dceb41b19002f518a77186adaad012c1bdfa115af1c9b4ea9159eb7482700309809d04d13eada0c443e85d67b56b1c
-  data.tar.gz: 7a6712cd6fe92ec007c80990e96cecac67f39353b435c2e35514cf7c10dc2d6686a956c035d326a0455bb07f486b3bb9296a5e6362f479275df4f6a48378b480
+  metadata.gz: b8b8362e34ff3efb97007047af172b5a11f677fafe2ba0f1d465f30191b9b9cd4dcb7d03cf614e043d9af3573a00712d6d49466b373f766f50c373779ec701c6
+  data.tar.gz: b225d0b75481e663079b5dfc50d63845f6447f0c585d2d8703d870fba4580a9a3b649e3b5f34ecf00c12ee77fcc8d82d817b9c3c6e00126248c3e65b71316b00

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"
+    channel: rubocop-0-82

data/.rubocop_cc.yml

@@ -0,0 +1,4 @@
+inherit_from:
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/.rubocop_local.yml

@@ -0,0 +1 @@
+

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In the root of the repo that needs configuring, run `bundle exec manageiq-style -i` to install or update the rubocop and codeclimate configuration files.
 
 ## Development
 
@@ -32,7 +32,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/manageiq-style. 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]/manageiq-style/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/manageiq-style. 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/ManageIQ/.github/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## Code of Conduct

data/exe/manageiq-style

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path("../lib", __dir__)
+
+require 'bundler/setup'
+require 'manageiq/style/cli'
+
+Manageiq::Style::CLI.run

data/lib/manageiq/style/cli.rb

@@ -0,0 +1,137 @@
+require "manageiq/style"
+
+module Manageiq
+  module Style
+    class CLI
+      def self.run
+        new.run
+      end
+
+      def initialize(options = parse_cli_options)
+        @opts = options
+      end
+
+      def parse_cli_options
+        require 'optimist'
+
+        Optimist.options do
+          usage    "manageiq-version [OPTIONS]"
+          synopsis "The ManageIQ communities style configuration utility"
+          version  "v#{Manageiq::Style::VERSION}\n"
+
+          opt :install, "Install or update the style configurations", :default => false
+        end
+      end
+
+      def run
+        version if @opts[:version]
+        install if @opts[:install]
+      end
+
+      def install
+        require 'yaml'
+        require 'more_core_extensions/all'
+
+        check_for_codeclimate_channel
+        update_rubocop_yml
+        write_rubocop_cc_yml
+        ensure_rubocop_local_yml_exists
+        update_codeclimate_yml
+        update_generator
+      end
+
+      private
+
+      def check_for_codeclimate_channel
+        begin
+          require 'open-uri'
+          URI::HTTPS.build(
+            :host => "raw.githubusercontent.com",
+            :path => File.join("/codeclimate", "codeclimate-rubocop", "channel", cc_rubocop_channel, "Gemfile")
+          ).open
+        rescue OpenURI::HTTPError
+          puts "RuboCop version #{rubocop_version.version} is not supported by CodeClimate."
+          exit 1
+        end
+      end
+
+      def update_rubocop_yml(file = ".rubocop.yml")
+        data = begin
+          YAML.load_file(file)
+        rescue Errno::ENOENT
+          {}
+        end
+
+        data.store_path("inherit_gem", "manageiq-style", ".rubocop_base.yml")
+        data["inherit_from"] = [".rubocop_local.yml"]
+
+        File.write(".rubocop.yml", data.to_yaml.sub("---\n", ""))
+      end
+
+      def write_rubocop_cc_yml(file = ".rubocop_cc.yml")
+        data = {
+          "inherit_from" => [
+            ".rubocop_base.yml",
+            ".rubocop_cc_base.yml",
+            ".rubocop_local.yml"
+          ]
+        }
+
+        File.write(file, data.to_yaml.sub("---\n", ""))
+      end
+
+      def ensure_rubocop_local_yml_exists(file = ".rubocop_local.yml")
+        require 'fileutils'
+        FileUtils.touch(file)
+      end
+
+      def update_codeclimate_yml(file = ".codeclimate.yml")
+        data = begin
+          YAML.load_file(file)
+        rescue Errno::ENOENT
+          {}
+        end
+
+        data["prepare"] = {
+          "fetch" => [
+            {"url" => "https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml",    "path" => ".rubocop_base.yml"},
+            {"url" => "https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml", "path" => ".rubocop_cc_base.yml"}
+          ]
+        }
+
+        data.delete_path("engines", "rubocop")
+
+        data["plugins"] ||= {}
+        data["plugins"]["rubocop"] = {
+          "enabled" => true,
+          "config"  => ".rubocop_cc.yml",
+          "channel" => cc_rubocop_channel,
+        }
+
+        File.write(".codeclimate.yml", data.to_yaml.sub("---\n", ""))
+      end
+
+      def update_generator
+        plugin_dir = "lib/generators/manageiq/plugin/templates"
+
+        return unless File.directory?(plugin_dir)
+
+        update_rubocop_yml(File.join(plugin_dir, ".rubocop.yml"))
+        write_rubocop_cc_yml(File.join(plugin_dir, ".rubocop_cc.yml"))
+        ensure_rubocop_local_yml_exists(File.join(plugin_dir, ".rubocop_local.yml"))
+        update_codeclimate_yml(File.join(plugin_dir, ".codeclimate.yml"))
+      end
+
+      def cc_rubocop_channel
+        @cc_rubocop_channel ||= "rubocop-#{rubocop_version.segments[0]}-#{rubocop_version.segments[1]}"
+      end
+
+      def rubocop_version
+        @rubocop_version ||= begin
+          require 'rubocop'
+          Gem::Version.new(RuboCop::Version.version)
+        end
+      end
+    end
+  end
+end

data/lib/manageiq/style/version.rb

@@ -1,5 +1,5 @@
 module Manageiq
   module Style
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/manageiq-style.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "more_core_extensions"
+  spec.add_runtime_dependency "optimist"
   spec.add_runtime_dependency "rubocop",   "~> 0.82.0"
   spec.add_runtime_dependency "rubocop-performance"
   spec.add_runtime_dependency "rubocop-rails"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-style
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brandon Dunne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: more_core_extensions
+  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: optimist
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -55,16 +83,20 @@ dependencies:
 description: Style and linting configuration for ManageIQ projects.
 email:
 - brandondunne@hotmail.com
-executables: []
+executables:
+- manageiq-style
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".haml-lint.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_base.yml"
+- ".rubocop_cc.yml"
 - ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -72,7 +104,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/manageiq-style
 - lib/manageiq/style.rb
+- lib/manageiq/style/cli.rb
 - lib/manageiq/style/version.rb
 - manageiq-style.gemspec
 homepage: https://github.com/ManageIQ/manageiq-style