rubocop-sorted_methods_by_call 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a05a73b134e3c92389b69552df981d71c730623059376b90029f1875bdf6945
-  data.tar.gz: cf522e97fabcf31eafb02ddf9b52980d9c681adc6f04bc297729dfe1f9f53af7
+  metadata.gz: fb5b1320e0c36ea11d3931c04aad10d03a3c909cf16added71b537bb540e9851
+  data.tar.gz: c2e121be2bfa362e5e6b8f7acaae7378d82158fbecdcb0c6b562e9eb4f4f1b0b
 SHA512:
-  metadata.gz: 2f5e49e6eefca4dcce2a4de646afae45292170f2389672fcc6a17120ac6d16d22e50e81fafaaf0c8e008300da816d1d886f4d43e5180ebe5c40b267d6a36e064
-  data.tar.gz: 7a0dc929281d31759bdef79d990d61427bc277421ae096df8f49662a04fd74fcae98b6f785912308d360ce35d9ac4a1a26947208c167265da00d0f240bd66f81
+  metadata.gz: 45b61992be6ad19b714eaa67929b0782c0cfb6b237cfb0a9770aca073f5672b817586305b8588052d636556e73afcd54826112d19ec67cb3d13df9af554a6e2b
+  data.tar.gz: 2983a3c4e99c5c58cb4361b2ac93b588230df3e318e79c1f4ec8b0b0f16d49ac69ff0e9f2fd443ecf5ac3ef8be3d673f3116f18854498590f129d23093079da8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-sorted_methods_by_call (1.0.0)
+    rubocop-sorted_methods_by_call (1.0.1)
       lint_roller
       rubocop (>= 1.72.0)
 

data/README.md

@@ -20,6 +20,7 @@
         * [Release Process](#release-process)
     * [Requirements](#requirements)
     * [Contributing](#contributing)
+    * [Documentation](#documentation)
     * [License](#license)
     * [Code of Conduct](#code-of-conduct)
 
@@ -82,7 +83,6 @@ SortedMethodsByCall/Waterfall:
 ### Good Code (waterfall order)
 
 ```ruby
-
 class Service
   def call
     do_smth
@@ -103,7 +103,6 @@ end
 ### Bad Code (violates waterfall order)
 
 ```ruby
-
 class Service
   def call
     do_smth
@@ -132,7 +131,6 @@ bundle exec rubocop -A
 This will reorder the methods while preserving comments and visibility modifiers:
 
 ```ruby
-
 class Service
   def call
     do_smth
@@ -207,6 +205,11 @@ Bug reports and pull requests are welcome! Please follow these guidelines:
 
 Please ensure your code passes all tests and follows the existing style.
 
+## Documentation
+
+Code is covered with YARD docs, you can access online docs
+at https://unurgunite.github.io/rubocop-sorted_methods_by_call_docs/
+
 ## License
 
 The gem is available as open source under the terms of

data/config/default.yml

@@ -2,6 +2,6 @@
 SortedMethodsByCall/Waterfall:
   Description: "Enforces waterfall ordering: define methods after the methods that call them."
   Enabled: false
-  VersionAdded: "1.0.0"
+  VersionAdded: "1.0.1"
   SafeAutoCorrect: false
   AllowedRecursion: true

data/lib/rubocop/sorted_methods_by_call/extensions/util.rb

@@ -18,7 +18,7 @@ module RuboCop
       #   RuboCop::SortedMethodsByCall::Util.deep_merge(base, other)
       #   #=> { main: [:abc], class_T: [:hi, :h1] }
       #
-      # @param [Hash] hash  The base hash to merge from.
+      # @param [Hash] h  The base hash to merge from.
       # @param [Hash] other The hash to merge into +hash+.
       # @return [Hash] A new hash with accumulated values per key.
       # @see Hash#merge

data/lib/rubocop/sorted_methods_by_call/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module SortedMethodsByCall
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/rakelib/docs.rake

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'yard'
+require 'fileutils'
+
+GEM_NAME = Bundler.load_gemspec(Dir.glob('*.gemspec').first).name
+DOCS_REPO_NAME = "#{GEM_NAME}_docs".freeze
+DOCS_REPO_PATH = "../#{DOCS_REPO_NAME}".freeze
+
+namespace :docs do # rubocop:disable Metrics/BlockLength
+  desc 'Generate new docs and push them to repo'
+  task generate: :clean do
+    puts 'Generating docs...'
+    YARD::CLI::Yardoc.run
+    puts 'OK!'
+  end
+
+  desc 'Clean existing docs'
+  task :clean do
+    if File.directory?('doc')
+      FileUtils.rm_rf('doc')
+      puts 'Cleaned existing docs directory'
+    end
+  end
+
+  desc 'Pushes docs to github'
+  task push: :generate do
+    unless File.directory?(DOCS_REPO_PATH)
+      puts "Error: Docs repo not found at #{DOCS_REPO_PATH}"
+      puts 'Please clone the docs repo first:'
+      puts "  git clone git@github.com:unurgunite/#{DOCS_REPO_NAME}.git #{DOCS_REPO_PATH}"
+      exit 1
+    end
+
+    puts "Copying docs to #{DOCS_REPO_PATH}..."
+    FileUtils.mkdir_p('doc') unless File.directory?('doc')
+    FileUtils.cp_r('doc/.', DOCS_REPO_PATH)
+
+    puts 'Changing dir...'
+    Dir.chdir(DOCS_REPO_PATH) do
+      puts 'Checking git status...'
+      status_output = `git status --porcelain`
+
+      if status_output.strip.empty?
+        puts 'No changes to commit'
+      else
+        puts 'Committing git changes...'
+        puts `git add .`
+        commit_result = `git commit -m "Update docs for #{GEM_NAME} #{Time.now.utc.strftime('%Y-%m-%d %H:%M:%S UTC')}"`
+        puts commit_result
+
+        if $CHILD_STATUS.success?
+          puts 'Pushing to GitHub...'
+          push_result = `git push origin master 2>&1`
+          puts push_result
+          if $CHILD_STATUS.success?
+            puts 'Docs successfully pushed!'
+          else
+            puts 'Push failed!'
+            exit 1
+          end
+        else
+          puts 'Commit failed!'
+          exit 1
+        end
+      end
+    end
+  end
+
+  desc 'Generate and push docs in one command'
+  task deploy: :push
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sorted_methods_by_call
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - unurgunite
@@ -160,6 +160,7 @@ files:
 - lib/rubocop/sorted_methods_by_call/extensions/util.rb
 - lib/rubocop/sorted_methods_by_call/plugin.rb
 - lib/rubocop/sorted_methods_by_call/version.rb
+- rakelib/docs.rake
 - test_project/.rubocop.test.yml
 - test_project/Gemfile
 homepage: https://github.com/unurgunite/rubocop-sorted_methods_by_call