rubocop-schema-gen 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13b27e5b62cc1a35d64acf5a81f2c6443aae1d0e9597207634bb7defa2a6b34
-  data.tar.gz: 78ac1aadadf7a5f23700615d717262fa0601e54ac772f8a5f2a790fe3dcd37bf
+  metadata.gz: ad2887f7e9c6ed387de3ea9c44a785c2c846c351681226752d334bad5e42ac42
+  data.tar.gz: dd3787e2db023d2dfc5a391bbc628e9796dc63d4578e604d2bd0eb2f9fb86ca6
 SHA512:
-  metadata.gz: 4293f202f9132881733e84b280e1b4ba93df2ab1b9567efb7ae48703835dc4d3e5aebb8a797f05453766e7929a3efe5c2c150b8d575611c6c959deeefc290a5c
-  data.tar.gz: b61fcf727e203d2ca162eba0bd081c9bf008d8606774e8c16cd6727bd35c9e3f144606a375efdce1c115ae35001a04411cf70aebe09ecddd4cbf046b9ced3b6d
+  metadata.gz: 0cb67d04acc4d37ba1c8d4e05fb269b6f22be79b0928666c5e1639cb0d7840caacc3140c0320cead6fe311fe9aae3fd6cf9ff6474854f65ff3f07d28849204ab
+  data.tar.gz: 9f663797d40199ab878106996f4d6272c57c67f698ab9bb55fb222330c047330f49985eedd66cbcbd15acc0330e8da47dba38463f6039332d12d6fae2bc8514c

data/lib/rubocop/schema/cached_http_client.rb

@@ -2,9 +2,13 @@ require 'pathname'
 require 'uri'
 require 'net/http'
 
+require 'rubocop/schema/helpers'
+
 module RuboCop
   module Schema
     class CachedHTTPClient
+      include Helpers
+
       def initialize(cache_dir, &event_handler)
         @cache_dir     = Pathname(cache_dir)
         @event_handler = event_handler
@@ -18,11 +22,9 @@ module RuboCop
         return path.read if path.readable?
 
         path.parent.mkpath
-        @event_handler&.call Event.new(type: :request)
+        Event.dispatch type: :request, &@event_handler
 
-        res = Net::HTTP.get_response(url)
-        res.body = '' unless res.is_a? Net::HTTPOK
-        res.body.force_encoding(Encoding::UTF_8).tap(&path.method(:write))
+        http_get(url).tap(&path.method(:write))
       end
 
       private

data/lib/rubocop/schema/cli.rb

@@ -5,6 +5,7 @@ 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
@@ -22,19 +23,14 @@ module RuboCop
         @args        = args
         @out_file    = out_file
         @log_file    = log_file
-        @out_path    = args.first
 
-        raise ArgumentError, 'Cannot accept an out_file and an argument' if @out_file && @out_path
+        raise ArgumentError, 'Cannot accept an out_file and an argument' if @out_file && args.first
       end
 
       def run
-        lockfile_path = @working_dir + 'Gemfile.lock'
-        fail "Cannot read #{lockfile_path}" unless lockfile_path.readable?
+        read_flag while @args.first&.start_with?('--')
+        assign_outfile
 
-        spec = ExtensionSpec.from_lockfile(lockfile_path)
-        fail 'RuboCop is not part of this project' if spec.empty?
-
-        assign_outfile(spec)
         print "Generating #{@out_path} … " if @out_path
 
         schema = report_duration(lowercase: @out_path) { Generator.new(spec.specs, document_loader).schema }
@@ -43,18 +39,55 @@ module RuboCop
 
       private
 
-      def assign_outfile(spec)
+      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
 
-        case @out_path
+        @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
-          @out_path = nil
+          nil
         when nil
-          @out_path = "#{spec}-config-schema.json"
+          "#{spec}-config-schema.json"
+        else
+          arg
         end
-
-        @out_file ||= File.open(@out_path, 'w') # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
       def report_duration(lowercase: false)
@@ -79,6 +112,11 @@ module RuboCop
         end
       end
 
+      def info(msg)
+        $stdout.puts msg
+        exit
+      end
+
       def fail(msg)
         @log_file.puts msg.to_s
         exit 1

data/lib/rubocop/schema/diff.rb

@@ -0,0 +1,67 @@
+require 'rubocop/schema/helpers'
+
+module RuboCop
+  module Schema
+    class Diff
+      include Helpers
+
+      class << self
+        def instance
+          @instance ||= new
+        end
+
+        def diff(old, new)
+          instance.diff old, new
+        end
+
+        def apply(old, diff)
+          instance.apply old, diff
+        end
+      end
+
+      def diff(old, new)
+        return diff_hashes old, new if old.is_a?(Hash) && new.is_a?(Hash)
+
+        new
+      end
+
+      def apply(old, diff)
+        return apply_hash(old, diff) if old.is_a?(Hash) && diff.is_a?(Hash)
+
+        diff
+      end
+
+      private
+
+      def diff_hashes(old, new)
+        (old.keys - new.keys).map { |k| [k, nil] }.to_h.tap do |result|
+          new.each do |k, v|
+            if old.key? k
+              result[k] = diff(old[k], v) unless old[k] == v
+            else
+              result[k] = v
+            end
+          end
+        end
+      end
+
+      def apply_hash(old, diff)
+        deep_dup(old).tap do |result|
+          diff.each do |k, v|
+            apply_hash_pair result, k, v
+          end
+        end
+      end
+
+      def apply_hash_pair(hash, key, value)
+        if value.nil?
+          hash.delete key
+        elsif hash.key? key
+          hash[key] = apply(hash[key], value)
+        else
+          hash[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/schema/document_loader.rb

@@ -1,10 +1,19 @@
+require 'asciidoctor'
+
 module RuboCop
   module Schema
     class DocumentLoader
       DOCS_URL_TEMPLATE =
-        -'https://raw.githubusercontent.com/rubocop/%s/v%s/docs/modules/ROOT/pages/cops%s.adoc'
+        -'https://raw.githubusercontent.com/rubocop/%s/%s/docs/modules/ROOT/pages/cops%s.adoc'
       DEFAULTS_URL_TEMPLATE =
-        -'https://raw.githubusercontent.com/rubocop/%s/v%s/config/default.yml'
+        -'https://raw.githubusercontent.com/rubocop/%s/%s/config/default.yml'
+
+      CORRECTIONS = {
+        'rubocop' => {
+          # Fixes a typo that causes Asciidoctor to crash
+          '1.10.0' => '174bda389c2c23cffb17e9d6128f5e6bdbc0e8a0'
+        }
+      }.freeze
 
       # @param [CachedHTTPClient] http_client
       def initialize(http_client)
@@ -30,11 +39,15 @@ module RuboCop
       private
 
       def url_for_doc(spec, department)
-        format DOCS_URL_TEMPLATE, spec.name, spec.version, department && "_#{department.to_s.downcase}"
+        format DOCS_URL_TEMPLATE, spec.name, correct_version(spec), department && "_#{department.to_s.downcase}"
       end
 
       def url_for_defaults(spec)
-        format DEFAULTS_URL_TEMPLATE, spec.name, spec.version
+        format DEFAULTS_URL_TEMPLATE, spec.name, correct_version(spec)
+      end
+
+      def correct_version(spec)
+        CORRECTIONS.dig(spec.name, spec.version) || "v#{spec.version}"
       end
     end
   end

data/lib/rubocop/schema/extension_spec.rb

@@ -28,16 +28,24 @@ module RuboCop
         end.compact)
       end
 
+      # @param [Pathname] lockfile
       def self.from_lockfile(lockfile)
-        new(Bundler::LockfileParser.new(lockfile.to_s).sources.flat_map do |source|
-          source.specs.map do |stub|
-            next unless KNOWN_GEMS.include? stub.name
-
-            Spec.new(
-              name:    stub.name,
-              version: stub.version.to_s
-            )
-          end.compact
+        new(lockfile.readlines.map do |line|
+          next unless line =~ /\A\s+(rubocop(?:-\w+)?) \((\d+(?:\.\d+)+)\)\s*\z/
+          next unless KNOWN_GEMS.include? $1
+
+          Spec.new(name: $1, version: $2)
+        end.compact)
+      end
+
+      def self.from_string(string)
+        new(string.split('-').each_slice(2).map do |(name, version)|
+          name = "rubocop-#{name}" unless name == 'rubocop'
+
+          raise ArgumentError, "Unknown gem '#{name}'" unless KNOWN_GEMS.include? name
+          raise ArgumentError, "Invalid version '#{version}'" unless version&.match? /\A\d+(?:\.\d+)+\z/
+
+          Spec.new(name: name, version: version)
         end)
       end
 

data/lib/rubocop/schema/generator.rb

@@ -1,6 +1,3 @@
-require 'asciidoctor'
-require 'nokogiri'
-
 require 'rubocop/schema/value_objects'
 require 'rubocop/schema/cop_schema'
 require 'rubocop/schema/helpers'
@@ -32,6 +29,7 @@ module RuboCop
 
       def generate
         @specs.each &method(:generate_spec)
+        @props.delete 'AllCops' unless @specs.any? { |s| s.name == 'rubocop' }
       end
 
       def generate_spec(spec)

data/lib/rubocop/schema/helpers.rb

@@ -1,3 +1,6 @@
+require 'nokogiri'
+require 'uri'
+
 module RuboCop
   module Schema
     module Helpers
@@ -46,6 +49,13 @@ module RuboCop
       def strip_html(str)
         Nokogiri::HTML(str).text
       end
+
+      def http_get(url)
+        url = URI(url)
+        res = Net::HTTP.get_response(url)
+        res.body = '' unless res.is_a? Net::HTTPOK
+        res.body.force_encoding Encoding::UTF_8
+      end
     end
   end
 end

data/lib/rubocop/schema/repo.rb

@@ -0,0 +1,79 @@
+require 'json'
+
+require 'rubocop/schema/helpers'
+require 'rubocop/schema/diff'
+
+module RuboCop
+  module Schema
+    class Repo
+      include Helpers
+
+      TAGS_URL_TEMPLATE = -'https://api.github.com/repos/rubocop/%s/tags'
+
+      def initialize(dir, loader, &event_handler)
+        @dir           = Pathname(dir)
+        @loader        = loader
+        @event_handler = event_handler
+        @dir.mkpath
+      end
+
+      def build
+        ExtensionSpec::KNOWN_GEMS.each &method(:build_for_gem)
+        Event.dispatch message: "Repo updated: #{@dir}", &@event_handler
+      end
+
+      private
+
+      def build_for_gem(name)
+        existing = read(name).map { |h| [h['version'], h['diff']] }.to_h
+        previous = nil
+        body     = versions_of(name).map do |version|
+          previous, diff = fetch_for_spec(Spec.new(name: name, version: version), existing, previous)
+          {
+            'version' => version,
+            'diff'    => diff
+          }
+        end
+        write name, body.compact
+      end
+
+      def fetch_for_spec(spec, existing, previous)
+        if existing.key? spec.version
+          diff   = existing[spec.version]
+          schema = Diff.apply(previous, diff)
+        else
+          schema = build_for_spec(spec)
+          diff   = Diff.diff(previous, schema)
+        end
+        [schema, diff]
+      end
+
+      def build_for_spec(spec)
+        Event.dispatch message: "Generating: #{spec}", &@event_handler
+        Generator.new([spec], @loader).schema
+      end
+
+      def write(name, body)
+        path_for(name).binwrite JSON.pretty_generate body
+      end
+
+      def read(name)
+        path = path_for(name)
+        return [] unless path.exist?
+
+        JSON.parse path.read
+      end
+
+      def path_for(name)
+        @dir.join("#{name}.json")
+      end
+
+      def versions_of(name)
+        json = http_get(format(TAGS_URL_TEMPLATE, name))
+        raise "No tags available for #{name}" if json == ''
+
+        JSON.parse(json).reverse.map { |obj| obj['name'].to_s[/(?<=\Av)\d.+/] }.compact
+      end
+    end
+  end
+end

data/lib/rubocop/schema/value_objects.rb

@@ -2,8 +2,14 @@ module RuboCop
   module Schema
     CopInfo   = Struct.new(:name, :description, :attributes, :supports_autocorrect, :enabled_by_default)
     Attribute = Struct.new(:name, :type, :default)
-    Event     = Struct.new(:type, :message)
-    Spec      = Struct.new(:name, :version) do
+
+    Event = Struct.new(:type, :message) do
+      def self.dispatch(**kwargs)
+        yield new(**kwargs) if block_given?
+      end
+    end
+
+    Spec = Struct.new(:name, :version) do
       def short_name
         return nil if name == 'rubocop'
 

data/lib/rubocop/schema/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Schema
-    VERSION = -'0.1.1'
+    VERSION = -'0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-schema-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -60,21 +60,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
-- Rakefile
 - assets/templates/cop_schema.yml
 - assets/templates/schema.yml
-- bin/console
-- bin/setup
 - exe/rubocop-schema-gen
 - lib/rubocop/schema.rb
 - lib/rubocop/schema/ascii_doc/base.rb
@@ -87,14 +76,14 @@ files:
 - lib/rubocop/schema/cop_info_merger.rb
 - lib/rubocop/schema/cop_schema.rb
 - lib/rubocop/schema/defaults_ripper.rb
+- lib/rubocop/schema/diff.rb
 - lib/rubocop/schema/document_loader.rb
 - lib/rubocop/schema/extension_spec.rb
 - lib/rubocop/schema/generator.rb
 - lib/rubocop/schema/helpers.rb
+- lib/rubocop/schema/repo.rb
 - lib/rubocop/schema/value_objects.rb
 - lib/rubocop/schema/version.rb
-- rubocop-schema.gemspec
-- rubocop-schema.json
 homepage: https://github.com/hx/rubocop-schema
 licenses:
 - MIT
@@ -117,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
 summary: Generate JSON schemas for IDE integration with RuboCop