raygun 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeaeb612fe4e56ab156e26d6d8299598274e0e5a8baf66647a62a399c3245067
-  data.tar.gz: c41f24ad804b4e7301bc54de9d1ecb0f04390fc909cb9823e7855cc820c2442f
+  metadata.gz: 6464c730d406fd0cd161d886375e52ef103781865bfb7c81f382987351c08597
+  data.tar.gz: f01fc5f9e573314b6852e002e79e18ca49a1163fbcc9052008ab94ac24ab4d1e
 SHA512:
-  metadata.gz: 88423daeb034fca34d5db7c3b97836e61a462064c87788c07a3fa20d36774a9f86be6b782dff428eccc52651a919a1483dce2caae0591842577fb19ef6ef56bf
-  data.tar.gz: 86dd56014f3ddb0255f9ebc0796cdf038f06f8e7b7fc57c0fe9f72efeff9912a92a9c565c16bc4020b483013f667e6be4673a0a05a237ab4edddac79dcfbd094
+  metadata.gz: 9ac1c6b995395e8dffeb309443f204b7bd7799083b45e2ac3cf51dcc0d73a15621dcb9648da7fadb8aae133aa94bf06619d7285bc03c2c9b5b627e55bc9e2361
+  data.tar.gz: 1a6b817213c3ed7138a231e2f8b728b6d509c17a3e72f1a0e23248e6582261673156453c36f37fda3796774b2f0bd2946c66c32165ce9dc54281334a2a938828

data/CHANGES.md

@@ -3,11 +3,17 @@
 **Note:** Don't let the apparent lack of activity here scare you away. Almost all changes are captured in the
 prototype repo (see [raygun-rails](https://github.com/carbonfive/raygun-rails)), and it's kept pretty well up to date.
 
+## 1.2.0 [2021-05-20]
+
+New features:
+
+* Copy the new rubocop conventions from the `main` branch of the c5-conventions repo (#163).
+
 ## 1.1.1 [2020-07-02]
 
 Housekeeping:
 
-* Fix compatibility so that any supported Rudy (currently 2.5+) is allowed (#165).
+* Fix compatibility so that any supported Ruby (currently 2.5+) is allowed (#165).
 
 ## 1.1.0 [2020-07-02]
 

data/lib/raygun/c5_conventions.rb

@@ -0,0 +1,65 @@
+require "colorize"
+require "open-uri"
+
+module Raygun
+  class C5Conventions
+    REPO = "carbonfive/c5-conventions".freeze
+
+    SOURCES = [
+      "https://raw.githubusercontent.com/#{REPO}/main/rubocop/.rubocop.yml",
+      "https://raw.githubusercontent.com/#{REPO}/main/rubocop/.rubocop-common.yml",
+      "https://raw.githubusercontent.com/#{REPO}/main/rubocop/.rubocop-performance.yml",
+      "https://raw.githubusercontent.com/#{REPO}/main/rubocop/.rubocop-rails.yml",
+      "https://raw.githubusercontent.com/#{REPO}/main/rubocop/.rubocop-rspec.yml"
+    ].freeze
+
+    ATTRIBUTION_HEADER = <<~TEXT
+      # Sourced from #{REPO} @ %<sha>s
+      #
+      # If you make changes to this file, consider opening a PR to backport them to the c5-conventions repo:
+      # https://github.com/#{REPO}
+    TEXT
+
+    # Install the latest copy of c5-conventions rubocop config in the given directory.
+    # If the latest files can't be downloaded from GitHub, print a warning, don't raise an exception.
+    # Any existing .rubocop.yml will be overwritten.
+    def self.install(target:, sources: SOURCES)
+      new(target: target, sources: sources).install
+    rescue Errno::ENOENT, OpenURI::HTTPError => e
+      puts ""
+      puts "Failed to install the CarbonFive conventions from the #{REPO} GitHub repo".colorize(:light_red)
+      puts "Error: #{e}".colorize(:light_red)
+      puts "You'll have to manage your own `.rubocop.yml` setup".colorize(:light_red)
+    end
+
+    def initialize(sources:, target:)
+      @sources = sources
+      @target = target
+    end
+
+    def install
+      sources.each do |url_str|
+        uri = URI(url_str)
+        contents = [attribution_header, uri.open.read].join("\n")
+        filename = File.basename(uri.path)
+
+        IO.write(File.join(target, filename), contents)
+      end
+    end
+
+    private
+
+    attr_reader :sources, :target
+
+    def attribution_header
+      format(ATTRIBUTION_HEADER, sha: latest_commit_sha)
+    end
+
+    def latest_commit_sha
+      @latest_commit_sha ||= begin
+        stdout = `git ls-remote https://github.com/#{REPO} main`
+        stdout[/^(\h{7})/, 1] || "main"
+      end
+    end
+  end
+end

data/lib/raygun/raygun.rb

@@ -3,17 +3,16 @@ require "ostruct"
 require "fileutils"
 require "securerandom"
 require "net/http"
-require "open-uri"
 require "json"
 require "colorize"
 
 require_relative "version"
+require_relative "c5_conventions"
 require_relative "template_repo"
 
 module Raygun
   class Runner
     CARBONFIVE_REPO = "carbonfive/raygun-rails"
-    C5_CONVENTIONS_REPO = "carbonfive/c5-conventions"
 
     attr_accessor :target_dir, :app_dir, :app_name, :dash_name, :snake_name,
                   :camel_name, :title_name, :prototype_repo,
@@ -108,7 +107,7 @@ module Raygun
       FileUtils.mv         dirs_to_move, app_dir
       FileUtils.remove_dir extraneous_dir
 
-      fetch_rubocop_file if @prototype_repo == CARBONFIVE_REPO
+      C5Conventions.install(target: app_dir) if @prototype_repo == CARBONFIVE_REPO
     end
 
     def rename_new_app
@@ -222,30 +221,6 @@ module Raygun
 
     protected
 
-    def fetch_rubocop_file
-      sha = shell("git ls-remote https://github.com/#{C5_CONVENTIONS_REPO} master") || ""
-      sha = sha.slice(0..6)
-
-      rubocop_file = "https://raw.githubusercontent.com/#{C5_CONVENTIONS_REPO}/master/rubocop/rubocop.yml"
-      begin
-        rubocop_contents = URI.open(rubocop_file)
-        IO.write("#{@app_dir}/.rubocop.yml", <<~RUBOCOP_YML)
-          # Sourced from #{C5_CONVENTIONS_REPO} @ #{sha}
-          #
-          # If you make changes to this file, consider opening
-          # a PR to backport them to the c5-conventions repo:
-          # https://github.com/#{C5_CONVENTIONS_REPO}/blob/master/rubocop/rubocop.yml
-
-          #{rubocop_contents.string}
-        RUBOCOP_YML
-      rescue Errno::ENOENT, OpenURI::HTTPError => e
-        puts ""
-        puts "Failed to find the CarbonFive conventions rubocop file at #{rubocop_file}".colorize(:light_red)
-        puts "Error: #{e}".colorize(:light_red)
-        puts "You'll have to manage you're own `.rubocop.yml` setup".colorize(:light_red)
-      end
-    end
-
     def camelize(string)
       result = string.sub(/^[a-z\d]*/) { $&.capitalize }
       result.gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/raygun/c5_conventions_spec.rb

@@ -0,0 +1,41 @@
+require_relative "../spec_helper"
+require_relative "../../lib/raygun/c5_conventions"
+
+require "tmpdir"
+
+describe Raygun::C5Conventions do
+  subject(:install) { described_class.install(target: target, sources: sources) }
+
+  let(:target) { Dir.mktmpdir }
+  let(:sources) { described_class::SOURCES }
+
+  describe ".install" do
+    it "puts rubocop files into the target directory" do
+      install
+
+      paths = %w[
+        .rubocop.yml
+        .rubocop-common.yml
+        .rubocop-performance.yml
+        .rubocop-rails.yml
+        .rubocop-rspec.yml
+      ].map { |path| Pathname.new(File.join(target, path)) }
+
+      expect(paths).to all(be_file)
+    end
+
+    it "inserts an attribution header" do
+      install
+      rubocop_config = IO.read(File.join(target, ".rubocop.yml"))
+      expect(rubocop_config).to match(%r{^# Sourced from carbonfive/c5-conventions @ \h{7}$})
+    end
+  end
+
+  context "when a source doesn't exist" do
+    let(:sources) { ["https://raw.githubusercontent.com/carbonfive/c5-conventions/main/rubocop/.rubocop-whatever.yml"] }
+
+    it "prints a warning to stdout" do
+      expect { install }.to output(/Failed to install/).to_stdout
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Christian Nelson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,12 +90,13 @@ files:
 - bin/raygun
 - bin/setup
 - lib/colorize.rb
+- lib/raygun/c5_conventions.rb
 - lib/raygun/raygun.rb
 - lib/raygun/template_repo.rb
 - lib/raygun/version.rb
 - marvin.jpg
 - raygun.gemspec
-- spec/raygun/runner_spec.rb
+- spec/raygun/c5_conventions_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/carbonfive/raygun
 licenses:
@@ -116,11 +117,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
 summary: Generates and customizes Rails applications with Carbon Five best practices
   baked in.
 test_files:
-- spec/raygun/runner_spec.rb
+- spec/raygun/c5_conventions_spec.rb
 - spec/spec_helper.rb

data/spec/raygun/runner_spec.rb

@@ -1,27 +0,0 @@
-require_relative "../spec_helper"
-require_relative "../../lib/raygun/raygun"
-
-describe Raygun::Runner do
-  describe "#fetch_rubocop_file" do
-    context "the repo is the standard carbonfive raygun-rails repo" do
-      before do
-        @runner = described_class.new("target/dir", "carbonfive/raygun-rails")
-        allow(URI).to receive(:open).and_return(StringIO.new("# rubocop contents"))
-        allow(IO).to receive(:write)
-        allow(@runner).to receive(:shell).and_return("GitSHAgoeshere")
-      end
-      it "inserts a copy of the rubocop file pulled from the carbonfive/c5-conventions repo" do
-        @runner.send(:fetch_rubocop_file)
-        expect(@runner).to have_received(:shell)
-          .with("git ls-remote https://github.com/carbonfive/c5-conventions master")
-        expect(URI).to have_received(:open)
-          .with("https://raw.githubusercontent.com/carbonfive/c5-conventions/master/rubocop/rubocop.yml")
-        expect(IO).to have_received(:write) do |path, contents|
-          expect(path).to eq(File.absolute_path("target/dir/.rubocop.yml"))
-          expect(contents).to include("@ GitSHA")
-          expect(contents).to include("# rubocop contents")
-        end
-      end
-    end
-  end
-end