rubocop-schema-gen 0.1.0 → 0.1.5

data/lib/rubocop/schema/helpers.rb

@@ -0,0 +1,62 @@
+require 'uri'
+require 'yaml'
+require 'net/http'
+require 'cgi'
+
+module RuboCop
+  module Schema
+    module Helpers
+      def self.templates
+        @templates ||= {}
+      end
+
+      def deep_dup(obj)
+        case obj
+        when String
+          obj.dup
+        when Hash
+          obj.transform_values &method(:deep_dup)
+        when Array
+          obj.map &method(:deep_dup)
+        else
+          obj
+        end
+      end
+
+      def deep_merge(old, new, &block)
+        return old if old.class != new.class
+
+        case old
+        when Hash
+          old.merge(new.map { |k, v| [k, old.key?(k) ? deep_merge(old[k], v, &block) : v] }.to_h)
+            .tap { |merged| yield merged if block_given? }
+        when Array
+          old | new
+        else
+          old
+        end
+      end
+
+      def boolean
+        { 'type' => 'boolean' }
+      end
+
+      def template(name)
+        deep_dup(Helpers.templates[name] ||= YAML.load_file(ROOT.join('assets', 'templates', "#{name}.yml")).freeze)
+      end
+
+      # Used for stripping HTML from Asciidoctor output, where raw output is not available, or not
+      # appropriate to use.
+      def strip_html(str)
+        CGI.unescapeHTML str.gsub(/<.*?>/, '').gsub(/\s+/, ' ')
+      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,91 @@
+require 'json'
+
+require 'rubocop/schema/helpers'
+require 'rubocop/schema/diff'
+require 'rubocop/schema/extension_spec'
+require 'rubocop/schema/value_objects'
+
+module RuboCop
+  module Schema
+    class Repo
+      include Helpers
+
+      # GitHub public APIs have a rate limit of 60/hour when making unauthenticated requests. 100 items
+      # per page is the maximum allowed, which we'll use to keep the number of requests to a minimum.
+      TAGS_PER_PAGE     = 100
+      TAGS_URL_TEMPLATE = -"https://api.github.com/repos/rubocop/%s/tags?page=%d&per_page=#{TAGS_PER_PAGE}"
+
+      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)
+        tags = []
+        loop do
+          json = http_get(format(TAGS_URL_TEMPLATE, name, (tags.length / TAGS_PER_PAGE) + 1))
+          raise "No tags available for #{name}" if json == ''
+
+          parsed = JSON.parse(json)
+          tags += parsed
+          break unless parsed.length == TAGS_PER_PAGE
+        end
+
+        tags.reverse.map { |obj| obj['name'].to_s[/(?<=\Av)\d.+/] }.compact
+      end
+    end
+  end
+end

data/lib/rubocop/schema/value_objects.rb

@@ -1,7 +1,33 @@
 module RuboCop
   module Schema
-    CopInfo   = Struct.new(:name, :description, :attributes, :supports_autocorrect, keyword_init: true)
-    Attribute = Struct.new(:name, :type, :default, keyword_init: true)
-    Event     = Struct.new(:type, :message, keyword_init: true)
+    CopInfo   = Struct.new(:name, :description, :attributes, :supports_autocorrect, :enabled_by_default)
+    Attribute = Struct.new(:name, :type, :default)
+
+    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'
+
+        name[8..-1]
+      end
+
+      def to_s
+        "#{short_name || name}-#{version}"
+      end
+    end
+
+    # Support for Ruby 2.4
+    module KeywordInitPatch
+      def initialize(**attrs)
+        super *self.class.members.map { |k| attrs[k] }
+      end
+    end
+
+    [CopInfo, Attribute, Event, Spec].each { |klass| klass.include KeywordInitPatch }
   end
 end

data/lib/rubocop/schema/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Schema
-    VERSION = -'0.1.0'
+    VERSION = -'0.1.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-schema-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Neil E. Pearson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -24,21 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.14
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-description: Generate JSON schemas for IDE integration with Rubocop
+description: Generate JSON schemas for IDE integration with RuboCop
 email:
 - neil@helium.net.au
 executables:
@@ -46,32 +32,30 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
+- LICENSE
 - 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/cache.rb
+- lib/rubocop/schema/ascii_doc/base.rb
+- lib/rubocop/schema/ascii_doc/cop.rb
+- lib/rubocop/schema/ascii_doc/department.rb
+- lib/rubocop/schema/ascii_doc/index.rb
+- lib/rubocop/schema/ascii_doc/stringifier.rb
+- lib/rubocop/schema/cached_http_client.rb
 - lib/rubocop/schema/cli.rb
+- lib/rubocop/schema/cop_info_merger.rb
 - lib/rubocop/schema/cop_schema.rb
-- lib/rubocop/schema/lockfile_inspector.rb
-- lib/rubocop/schema/scraper.rb
-- lib/rubocop/schema/templates.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
@@ -87,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -97,5 +81,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Generate JSON schemas for IDE integration with Rubocop
+summary: Generate JSON schemas for IDE integration with RuboCop
 test_files: []

data/.gitignore

@@ -1,19 +0,0 @@
-# Actual stuff
-
-/cache
-/.cache
-/Gemfile.lock
-
-# Generated by `bundle gem`
-
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,38 +0,0 @@
-# The behavior of RuboCop can be controlled via the .rubocop.yml
-# configuration file. It makes it possible to enable/disable
-# certain cops (checks) and to alter their behavior if they accept
-# any parameters. The file can be placed either in your home
-# directory or in some project directory.
-#
-# RuboCop will start looking for the configuration file in the directory
-# where the inspected file is and continue its way up to the root directory.
-#
-# See https://docs.rubocop.org/rubocop/configuration
-
-require:
-  - rubocop-rspec
-  - rubocop-rake
-
-AllCops:
-  SuggestExtensions: false
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-Layout/HashAlignment:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Style/FrozenStringLiteralComment:
-  EnforcedStyle: never
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringConcatenation:
-  Enabled: false
-
-Style/StderrPuts:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-3.0.0

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 3.0.0
-before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-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.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at neil.pearson@bigcommerce.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/