rubocop-schema-gen 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9896f77d8a3c4c39bd31f21878bffdb2d8979dee897b5fe38b3ef090bd11043d
-  data.tar.gz: bfa9fe9b715b977f1dc973f48e80eafe59a448545bbef559247055bd98cfc5bd
+  metadata.gz: 99db5861b36cfdf148861814554c532213934e810770b8ed61f570b81a51ea1c
+  data.tar.gz: f7a310fbab5d4889cf24d8e138ca3acacf1fe66ab823699561d60b6db4320b02
 SHA512:
-  metadata.gz: 074f101c7a87e0ce7e1de730a82b6bc83682bf0068d60519c1b042ca6bbcc7d3ca574e5ed47f3fec0f2cb63ce3639b98ab2915b90644b1e349aa4c589c3d6cab
-  data.tar.gz: aeafc3e4661bed171c7d182ffbf6c752ded81d002623984bd0e146072c70fca9609d79410a8f5c23fe031c49caf15755d8ad5a3fe120955e7f23b9ddbd813398
+  metadata.gz: 6b646939f86c4db226daf43887e9039fb487143d8ceea498124d9b84f0297a0815558494982531edab03a2754e2a26c8f6c6f06e04f6d3a406f63f3ac7d526e9
+  data.tar.gz: 42c0d2d6769be3de1ec6aec0dbb8efa8a609bfd59f82615587757a8bcbe5b79cad6e7ccbda6186cbe0f6ae59b4dc4fb84c106182b58ea05dcecabf8b059dc660

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2021 Neil E. Pearson
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,44 +1,39 @@
-# Rubocop::Schema
+# RuboCop Config Schema Generator
 
-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/schema`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem generates a JSON schema for your RuboCop configuration files, which you can use in your IDE (e.g. RubyMine) for autocompletion and validation.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rubocop-schema'
-```
-
-And then execute:
+    $ gem install rubocop-schema-gem
 
-    $ bundle install
+## Usage
 
-Or install it yourself as:
+Change to a directory containing a `Gemfile.lock`, which the generator will use to target your version of `rubocop`, and any extensions you may be using (e.g. `rubocop-rails`).
 
-    $ gem install rubocop-schema
+```
+$ cd ./my_project
+$ rubocop-schema-gen
+Generating rubocop-1.13.1-config-schema.json … complete in 5.2s
+```
 
-## Usage
+The name of the generated file is based on your gem version(s). You can override it with an argument.
 
-TODO: Write usage instructions here
+```
+$ rubocop-schema-gen rubocop-schema.json
+Generating rubocop-schema.json … complete in 0.7s
+```
 
-## Development
+Pass `-` to write to standard output.
 
-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.
+The generator caches pages from https://raw.githubusercontent.com/rubocop in `~/.rubocop-schema-cache`.
 
-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).
+Please refer to your IDE's documentation regarding applying the schema to your `.rubocop.yml` file.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-schema. 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-schema/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/hx/rubocop-schema. 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/hx/rubocop-schema/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::Schema project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-schema/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

data/assets/templates/cop_schema.yml

@@ -1,9 +1,7 @@
 type: object
 additionalProperties: true
 
-propertyNames:
-  type: string
-  pattern: '^[A-Z][A-Za-z]*$'
+propertyNames: { $ref: '#/definitions/attributeName' }
 
 properties:
   Enabled: { type: boolean }

data/assets/templates/schema.yml

@@ -41,6 +41,10 @@ definitions:
       - type: array
         items: { type: string }
 
+  attributeName:
+    type: string
+    pattern: '^[A-Z][A-Za-z]*$'
+
 properties:
   inherit_from: { type: string }
 

data/exe/rubocop-schema-gen

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
+Dir.chdir File.expand_path('..', __dir__) do
+  require 'bundler/setup'
+end
 require 'rubocop/schema'
 require 'rubocop/schema/cli'
 require 'json'
 
-RuboCop::Schema::CLI.new(Dir.pwd, ENV, ARGV).run
+RuboCop::Schema::CLI.new.run

data/lib/rubocop/schema.rb

@@ -1,10 +1,6 @@
 require 'pathname'
-require 'rubocop'
 
 require 'rubocop/schema/version'
-require 'rubocop/schema/cache'
-require 'rubocop/schema/scraper'
-require 'rubocop/schema/lockfile_inspector'
 
 module RuboCop
   module Schema

data/lib/rubocop/schema/ascii_doc/base.rb

@@ -0,0 +1,52 @@
+require 'rubocop/schema/ascii_doc/stringifier'
+require 'rubocop/schema/helpers'
+
+module RuboCop
+  module Schema
+    module AsciiDoc
+      class Base
+        include Helpers
+
+        # @param [Asciidoctor::AbstractBlock] ascii_block
+        def initialize(ascii_block)
+          @root = ascii_block
+          scan
+        end
+
+        protected
+
+        # @return [Asciidoctor::Document]
+        attr_reader :root
+
+        def scan
+          raise NotImplementedError
+        end
+
+        def link_text(str)
+          # The Asciidoctor API doesn't provide access to the raw title, or parts of it.
+          str[%r{<a\s.+?>(.+?)</a>}, 1]&.then &method(:strip_html)
+        end
+
+        # @param [Asciidoctor::Table] table
+        # @return [Array<Hash>] A hash for each row, with table headings as keys
+        def table_to_hash(table)
+          headings = table.rows.head.first.map(&:text)
+          table.rows.body.map do |row|
+            headings.each_with_index.map do |heading, i|
+              [heading, strip_html(row[i].text)]
+            end.to_h
+          end
+        end
+
+        def stringify_section(section)
+          @stringifier ||= Stringifier.new
+          @stringifier.stringify section
+        end
+
+        def presence(str)
+          str unless str.strip == ''
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/ascii_doc/cop.rb

@@ -0,0 +1,93 @@
+require 'rubocop/schema/ascii_doc/base'
+require 'rubocop/schema/value_objects'
+
+module RuboCop
+  module Schema
+    module AsciiDoc
+      class Cop < Base
+        # @return [String]
+        attr_reader :name
+
+        # @return [String]
+        attr_reader :description
+
+        # @return [TrueClass, FalseClass]
+        attr_reader :enabled_by_default
+
+        # @return [TrueClass, FalseClass]
+        attr_reader :supports_autocorrect
+
+        # @return [Array<Attribute>]
+        attr_reader :attributes
+
+        ATTRS = public_instance_methods(false).freeze
+
+        def to_h
+          ATTRS.map { |k| [k, __send__(k)] }.to_h
+        end
+
+        protected
+
+        def scan
+          @name = root.title
+          read_stats_table
+          read_description
+          read_attributes
+        end
+
+        private
+
+        def read_stats_table
+          return unless stats_table
+
+          @enabled_by_default   = stats_table['Enabled by default'] == 'Enabled'
+          @supports_autocorrect = stats_table['Supports autocorrection'] == 'Yes'
+        end
+
+        def read_description
+          blocks       = root.blocks[find_description_range]
+          @description = blocks.map(&method(:stringify_section)).join("\n\n") if blocks.any?
+        end
+
+        def read_attributes
+          return unless attr_table_block
+
+          @attributes = table_to_hash(attr_table_block).map do |row|
+            Attribute.new(
+              name:    row['Name'],
+              default: presence(row['Default value']),
+              type:    presence(row['Configurable values'])
+            )
+          end
+        end
+
+        def find_description_range
+          top    = stats_table_block ? root.blocks.index(stats_table_block) + 1 : 0
+          bottom = root.blocks.index(root.sections.first) || 0
+          top..(bottom - 1)
+        end
+
+        # @return [Asciidoctor::Block, nil]
+        def stats_table_block
+          @stats_table_block ||= root
+            .query(context: :table) { |t| t.rows.head.first.first.text == 'Enabled by default' }
+            .first
+        end
+
+        # @return [Asciidoctor::Block, nil]
+        def attr_table_block
+          @attr_table_block ||= root
+            .query(context: :section) { |s| s.title == 'Configurable attributes' }
+            &.first
+            &.query(context: :table)
+            &.first
+        end
+
+        # @return [Array<Hash>, nil]
+        def stats_table
+          @stats_table ||= stats_table_block && table_to_hash(stats_table_block).first
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/ascii_doc/department.rb

@@ -0,0 +1,21 @@
+require 'rubocop/schema/ascii_doc/base'
+require 'rubocop/schema/ascii_doc/cop'
+
+module RuboCop
+  module Schema
+    module AsciiDoc
+      class Department < Base
+        # @return [Array<Cop>]
+        attr_reader :cops
+
+        protected
+
+        def scan
+          @cops = root
+            .query(context: :section) { |s| s.title.start_with? "#{root.title}/" }
+            .map &Cop.method(:new)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/ascii_doc/index.rb

@@ -0,0 +1,20 @@
+require 'rubocop/schema/ascii_doc/base'
+
+module RuboCop
+  module Schema
+    module AsciiDoc
+      class Index < Base
+        # @return [Array<string>]
+        attr_reader :department_names
+
+        protected
+
+        def scan
+          @department_names = root
+            .query(context: :section) { |s| s.title.start_with? 'Department ' }
+            .map { |section| link_text section.title }
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/ascii_doc/stringifier.rb

@@ -0,0 +1,49 @@
+require 'rubocop/schema/helpers'
+
+module RuboCop
+  module Schema
+    module AsciiDoc
+      class Stringifier
+        include Helpers
+
+        # @param [Asciidoctor::Section] section
+        def stringify(section)
+          method = :"stringify_#{section.context}"
+          raise "Don't know what to do with #{section.context}" unless private_methods(false).include? method
+
+          __send__(method, section)
+        end
+
+        private
+
+        # @param [Asciidoctor::Section] section
+        def stringify_paragraph(section)
+          section.lines.join ' '
+        end
+
+        alias stringify_admonition stringify_paragraph
+        alias stringify_listing stringify_paragraph
+
+        # @param [Asciidoctor::Section] section
+        def stringify_literal(section)
+          section.lines.map { |l| "  #{l}" }.join "\n"
+        end
+
+        # @param [Asciidoctor::Section] section
+        def stringify_ulist(section)
+          section.blocks.map { |b| " - #{strip_html b.text}" }.join "\n\n" # TODO: single newline
+        end
+
+        # @param [Asciidoctor::Section] section
+        def stringify_olist(section)
+          section.blocks.map.with_index { |b, i| "  #{i + 1}. #{strip_html b.text}" }.join "\n\n" # TODO: single newline
+        end
+
+        # @param [Asciidoctor::Section] section
+        def stringify_dlist(section)
+          strip_html section.convert # Too hard, just go HTML for now
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/{cache.rb → cached_http_client.rb}

@@ -1,30 +1,29 @@
 require 'pathname'
 require 'uri'
-require 'net/http'
+
+require 'rubocop/schema/helpers'
 
 module RuboCop
   module Schema
-    class Cache
-      # @return [URI]
-      attr_reader :base_url
+    class CachedHTTPClient
+      include Helpers
 
-      def initialize(cache_dir, base_url: nil, &event_handler)
+      def initialize(cache_dir, &event_handler)
         @cache_dir     = Pathname(cache_dir)
-        @base_url      = validate_url(base_url)
         @event_handler = event_handler
       end
 
       def get(url)
         url = URI(url)
-        url = @base_url + url if @base_url && url.relative?
         validate_url url
 
         path = path_for_url(url)
         return path.read if path.readable?
 
         path.parent.mkpath
-        @event_handler&.call Event.new(type: :request)
-        Net::HTTP.get(url).force_encoding(Encoding::UTF_8).tap(&path.method(:write))
+        Event.dispatch type: :request, &@event_handler
+
+        http_get(url).tap(&path.method(:write))
       end
 
       private
@@ -34,13 +33,11 @@ module RuboCop
 
         raise ArgumentError, 'Expected an absolute URL' unless url.absolute?
         raise ArgumentError, 'Expected an HTTP URL' unless url.is_a? URI::HTTP
-
-        url
       end
 
       # @param [URI::HTTP] url
       def path_for_url(url)
-        @cache_dir + url.scheme + url.hostname + url.path[1..]
+        @cache_dir + url.scheme + url.hostname + url.path[1..-1]
       end
     end
   end

data/lib/rubocop/schema/cli.rb

@@ -1,67 +1,135 @@
 require 'pathname'
 require 'json'
 
+require 'rubocop/schema/document_loader'
+require 'rubocop/schema/cached_http_client'
+require 'rubocop/schema/generator'
+require 'rubocop/schema/extension_spec'
+require 'rubocop/schema/repo'
+
 module RuboCop
   module Schema
     class CLI
       # @param [Pathname] working_dir
       # @param [Hash] env
       # @param [Array<String>] args
-      def initialize(working_dir, env, args)
+      # @param [String] home
+      # @param [IO] out_file
+      # @param [IO] log_file
+      def initialize(working_dir: Dir.pwd, env: ENV, args: ARGV, home: Dir.home, out_file: nil, log_file: $stderr)
         @working_dir = Pathname(working_dir)
+        @home_dir    = Pathname(home)
         @env         = env
         @args        = args
+        @out_file    = out_file
+        @log_file    = log_file
+
+        raise ArgumentError, 'Cannot accept an out_file and an argument' if @out_file && args.first
       end
 
       def run
-        fail "Cannot read #{lockfile_path}" unless lockfile_path.readable?
-        fail 'RuboCop is not part of this project' unless lockfile.specs.any?
+        read_flag while @args.first&.start_with?('--')
+        assign_outfile
 
-        schema = report_duration { Scraper.new(lockfile, cache).schema }
-        puts JSON.pretty_generate schema
+        print "Generating #{@out_path} … " if @out_path
+
+        schema = report_duration(lowercase: @out_path) { Generator.new(spec.specs, document_loader).schema }
+        @out_file.puts JSON.pretty_generate schema
       end
 
       private
 
-      def report_duration
-        started  = Time.now
+      def read_flag
+        case @args.shift
+        when '--version'
+          info VERSION
+        when '--spec'
+          info spec
+        when /\A--spec=(\S+)/
+          @spec = ExtensionSpec.from_string($1)
+        when /\A--build-repo=(.+)/
+          build_repo $1
+        end
+      end
+
+      def build_repo(dir)
+        Repo.new(dir, document_loader, &method(:handle_event)).build
+        exit
+      end
+
+      def spec
+        @spec ||=
+          begin
+            lockfile_path = @working_dir + 'Gemfile.lock'
+            fail "Cannot read #{lockfile_path}" unless lockfile_path.readable?
+
+            spec = ExtensionSpec.from_lockfile(lockfile_path)
+            fail 'RuboCop is not part of this project' if spec.empty?
+
+            spec
+          end
+      end
+
+      def assign_outfile
+        return if @out_file
+
+        @out_path = path_from_arg(@args.first)
+
+        @out_file ||= File.open(@out_path, 'w') # rubocop:disable Naming/MemoizedInstanceVariableName
+      end
+
+      def path_from_arg(arg)
+        case arg
+        when '-'
+          @out_file = $stdout
+          nil
+        when nil
+          "#{spec}-config-schema.json"
+        else
+          arg
+        end
+      end
+
+      def report_duration(lowercase: false)
+        started = Time.now
         yield
       ensure
         finished = Time.now
-        handle_event Event.new(message: "Complete in #{(finished - started).round 1}s")
+        message  = "Complete in #{(finished - started).round 1}s"
+        message.downcase! if lowercase
+        handle_event Event.new(message: message)
       end
 
       def handle_event(event)
         case event.type
         when :request
-          $stderr << '.'
+          @log_file << '.'
           @line_dirty = true
         else
-          $stderr.puts '' if @line_dirty
+          @log_file.puts '' if @line_dirty
           @line_dirty = false
-          $stderr.puts event.message.to_s
+          @log_file.puts event.message.to_s
         end
       end
 
-      def fail(msg)
-        $stderr.puts msg.to_s
-        exit 1
-      end
-
-      def lockfile
-        @lockfile ||= LockfileInspector.new(lockfile_path)
+      def info(msg)
+        $stdout.puts msg
+        exit
       end
 
-      def lockfile_path
-        @lockfile_path ||= @working_dir + 'Gemfile.lock'
-      end
-
-      def cache
-        @cache ||= Cache.new(cache_dir, &method(:handle_event))
+      def fail(msg)
+        @log_file.puts msg.to_s
+        exit 1
       end
 
-      def cache_dir
-        @cache_dir ||= Pathname(Dir.home) + '.rubocop-schema-cache'
+      def document_loader
+        @document_loader ||=
+          DocumentLoader.new(
+            CachedHTTPClient.new(
+              @home_dir + '.rubocop-schema-cache',
+              &method(:handle_event)
+            )
+          )
       end
     end
   end