rateaux 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c92e8a64452ffcdeaa7a0c340d306b6faed460c6
-  data.tar.gz: 54316ccaa4cab77cd3860ea58b4693057ea60554
+SHA256:
+  metadata.gz: 83add348cf984a12112d1b43d1b5311062fe76e9c96b70ea11a9c187848f2319
+  data.tar.gz: bce392df04ca3321a3096c77f0fb56a5c75a7ba64b4213473255ebd692b9f713
 SHA512:
-  metadata.gz: 9fa54f57c0bafb85148e928e23e5b3ab556e335c20098dccbd15472e864879e10ce63282a4a3ff991e6c8bbf44d912c7ba34eb1a6e774e08c6cab734aed51293
-  data.tar.gz: 060e40c0c6f3da09883046271dc5939e4eaebd35599bdbc8316ab6fd4bc1adf5547298378c33b615eed8b9865cbb6f6bec17bff49fa5cfbe24e1c910f0c89ca6
+  metadata.gz: 7838b9980e77d57d20ba7e90c8c38c8fbff6feb33334889200b41464fa4cc488a818ba20bbf81a9419b78bb5951288e8c3ffa8ea9689944f079aafbb1938d811
+  data.tar.gz: 9983ea851dedcdf0a4575e8fab405f9240462c23022383889a27f7200586bc95623ed1779041c4a21d54881aacba76e8c5b1782e1f21c697cc40fd0cf9e88e3b

data/README.md

@@ -1,21 +1,26 @@
 # Rateaux
 
-This is a collection of useful Rake tasks for Rails.
+This is a collection of useful Rake tasks for Ruby on Rails applications.
+
+![Photo of an old wooden Rake on top of hay](https://github.com/user-attachments/assets/a1549ae8-a20f-4c87-a634-4298223bbb6e)
+
+_[Hay Rake](https://www.flickr.com/photos/49708076@N05/23047850374/) photo by Larry Lamb_
 
 ## Install
 
-Add this line to your Gemfile to install it with Bundler:
+Add these lines to your app's Gemfile:
 
 ```ruby
 # Rake tasks for Rails
 gem "rateaux"
 ```
 
-Then type `bundle install` in a terminal.
+Then call `bundle install`.
+
 
-## Rake Tasks
+## Tasks
 
-### Truncate
+### DB Truncate
 
 Delete all data from the current database.
 
@@ -23,22 +28,15 @@ Delete all data from the current database.
 $ rake db:truncate
 ```
 
-### Drop tables
+### DB Drop tables
 
-Delete all data and tables from the current database. This is similar to `db:drop` but it does not drop the database itself.
+Delete all data and tables from the current database. This is similar to
+`db:drop` but it does not drop the database itself.
 
 ```sh
 $ rake db:drop_tables
 ```
 
-### Encoding headers
-
-Add the `# encoding: UTF-8` header to all ruby files in the project. Useful before Ruby 2.
-
-```sh
-$ rake encoding_headers
-```
-
 ### Checkout
 
 Remove migrations then checkout a git branch.
@@ -58,24 +56,45 @@ This will:
 
 ### Cache clear
 
-Empty the cache store.
+Empty the Rails cache store.
+
+```sh
+$ rake cache:clear
+```
+
+### Sidekiq flush
+
+Empty Sidekiq’s queues.
 
 ```sh
-$ rake cache_clear
+$ rake sidekiq:flush
 ```
 
 ### Assets Copy Non Digested
 
-Copy assets files with a digest (for example `application-d45e…565.css`) to their non-digested form (for example `application.css`).
+Copy assets files with a digest (for example `application-d45e…565.css`)
+to their non-digested form (for example `application.css`).
 
 ```sh
 $ rake assets:copy_non_digested
 ```
 
-### View DB schema
+### DB schema view
 
-View the database structure
+View the database structure.
 
 ```sh
 $ rake db:schema:view
 ```
+
+### Frozen string literal
+
+Add the `# frozen_string_literal: true` header to all Ruby files in the project.
+
+```sh
+$ rake add_frozen_string_literal_headers
+```
+
+## The name
+
+In French _rateaux_ means _rakes_.

data/Rakefile

@@ -1,32 +1,33 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 
 # bundler
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
 Bundler::GemHelper.install_tasks
 
 # rdoc
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Rateaux'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Rateaux"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 # rspec
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/lib/rateaux/file_task.rb

@@ -1,40 +1,37 @@
-# encoding: UTF-8
-#
-# File Task
-#
-# Adds a task and a file task. The file depends on the task that it creates.
-#
-#
-# For example:
-#
-#     require "rateaux/file_task"
-#     include Rateaux::FileTask
-#
-#     file_task "foo.txt", create: :environment do
-#       touch "foo.txt"
-#     end
-#
-# You can then:
-#
-#     $ rake foo.txt  # Will create the file only if it does not exist
-#     $ rake create   # Will create the file all the time
-#
-# Your tasks can now depend on the file beeing present or create them :
-#
-#     task send: "foo.txt"
-#
-# With file_task you don't have to add this block to the file task:
-#
-#     file "foo.txt" do
-#       Rake::Task["create"]
-#     end
-#
+# frozen_string_literal: true
+
 module Rateaux
+  # File Task
+  #
+  # Adds a task and a file task. The file depends on the task that it creates.
+  #
+  # For example:
+  #
+  #     require "rateaux/file_task"
+  #     include Rateaux::FileTask
+  #
+  #     file_task "foo.txt", create: :environment do
+  #       touch "foo.txt"
+  #     end
+  #
+  # You can then:
+  #
+  #     $ rake foo.txt  # Will create the file only if it does not exist
+  #     $ rake create   # Will create the file all the time
+  #
+  # Your tasks can now depend on the file beeing present or create them :
+  #
+  #     task send: "foo.txt"
+  #
+  # With file_task you don't have to add this block to the file task:
+  #
+  #     file "foo.txt" do
+  #       Rake::Task["create"]
+  #     end
+  #
   module FileTask
-    def file_task(path, definition)
-      t = task(definition) do
-        yield
-      end
+    def file_task(path, definition, &block)
+      t = task(definition, &block)
 
       file(path) do
         Rake::Task[t.name].invoke

data/lib/rateaux/namespaced.rb

@@ -1,42 +1,40 @@
-# encoding: UTF-8
-#
-# Namespaced
-#
-# Adds a namespace and a task with that namespace name.
-#
-# Choose the tasks you want to launch when using the namespace name
-# by giving them as a second argument or by defning a "default" task.
-#
-# For example:
-#
-#     require "rateaux/namespaced"
-#     include Rateaux::Namespaced
-#
-#     desc "Export everything"
-#     namespaced :export do
-#       default: [:a, :b]
-#
-#       …
-#     end
-#
-# Is the same as:
-#
-#     require "rateaux/namespaced"
-#     include Rateaux::Namespaced
-#
-#     desc "Export everything"
-#     namespaced :export, [:a, :b] do
-#       …
-#     end
-#
-# Both definitions add a task "export" that cals "export:a" and "export:b"
-# without having to add:
-#
-#     task export: ["export:a", "export:b"]
-#
+# frozen_string_literal: true
+
 module Rateaux
+  # Adds a namespace and a task with that namespace name.
+  #
+  # Choose the tasks you want to launch when using the namespace name
+  # by giving them as a second argument or by defning a "default" task.
+  #
+  # For example:
+  #
+  #     require "rateaux/namespaced"
+  #     include Rateaux::Namespaced
+  #
+  #     desc "Export everything"
+  #     namespaced :export do
+  #       default: [:a, :b]
+  #
+  #       ...
+  #     end
+  #
+  # Is the same as:
+  #
+  #     require "rateaux/namespaced"
+  #     include Rateaux::Namespaced
+  #
+  #     desc "Export everything"
+  #     namespaced :export, [:a, :b] do
+  #       ...
+  #     end
+  #
+  # Both definitions add a task "export" that cals "export:a" and "export:b"
+  # without having to add:
+  #
+  #     task export: ["export:a", "export:b"]
+  #
   module Namespaced
-    def namespaced(name, defaults = :default)
+    def namespaced(name, defaults = :default, &block)
       case defaults
       when Symbol, String
         task name => "#{name}:#{defaults}"
@@ -46,9 +44,7 @@ module Rateaux
         task name => defaults.to_a.map { |t| "#{name}:#{t}" }
       end
 
-      namespace name do
-        yield
-      end
+      namespace name, &block
     end
   end
 end

data/lib/rateaux/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rateaux
-  VERSION = "1.6.1".freeze
+  VERSION = "2.0.0"
 end

data/lib/rateaux.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Rateaux
+  # Tie to Rails
   class Railtie < Rails::Railtie
     rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+      Dir[File.join(File.dirname(__FILE__), "tasks/*.rake")].each { |f| load f }
     end
   end
 end

data/lib/tasks/rateaux_add_frozen_string_literal_headers.rake

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Adds "frozen_string_literal: true" to the top of all Ruby files.
+#
+#     $ rake add_frozen_string_literal_headers
+
+desc "Adds the frozen_string_literal header to all Ruby files"
+task add_frozen_string_literal_headers: :environment do
+  files = []
+  ["*.rb", "*.rake"].each do |extension|
+    files.concat(Dir[File.join(Dir.getwd.split("\\"), "**", extension)])
+  end
+
+  header = "# frozen_string_literal: true\n"
+
+  files.each do |file|
+    content = File.read(file)
+    next if content[0..header.length] == header
+
+    content = content.gsub(/^# (frozen_string_literal: true)\n/i, "")
+    content = "#{header}#{content}"
+
+    new_file = File.open(file, "w")
+    new_file.write(content)
+    new_file.close
+  end
+end

data/lib/tasks/rateaux_cache_clear.rake

@@ -1,10 +1,12 @@
-# encoding: UTF-8
-#
-# Empty Rails cache
+# frozen_string_literal: true
+
+# Empty Rails cache.
 #
-#     $ rake cache_clear
+#     $ rake cache:clear
 
-desc "Empty Rails cache"
-task :cache_clear => :environment do
-  Rails.cache.clear
+namespace :cache do
+  desc "Empty Rails cache"
+  task clear: :environment do
+    Rails.cache.clear
+  end
 end

data/lib/tasks/rateaux_copy_non_digested_assets.rake

@@ -1,24 +1,22 @@
-# encoding: UTF-8
-#
+# frozen_string_literal: true
+
 # Copy all assets to their non-digested form.
 #
 # Via https://github.com/rails/sprockets-rails/issues/49#issuecomment-20535134
 
 namespace :assets do
-
   desc "Copy non digested assets"
   task copy_non_digested: :environment do
-    assets = Dir.glob(File.join(Rails.root, 'public/assets/**/*'))
+    assets = Dir.glob(File.join(Rails.root, "public/assets/**/*"))
     regex = /(-{1}[a-z0-9]{32}*\.{1}){1}/
     assets.each do |file|
       next if File.directory?(file) || file !~ regex
 
-      source = file.split('/')
-      source.push(source.pop.gsub(regex, '.'))
+      source = file.split("/")
+      source.push(source.pop.gsub(regex, "."))
 
       non_digested = File.join(source)
       FileUtils.cp(file, non_digested)
     end
   end
-
 end

data/lib/tasks/rateaux_db.rake

@@ -1,11 +1,11 @@
-# encoding: UTF-8
-#
+# frozen_string_literal: true
+
 # Truncate or delete all data from an SQL database.
 #
 #     $ rake db:truncate
 #     $ rake db:drop_tables
 
-require 'database_cleaner'
+require "database_cleaner"
 
 namespace :db do
   desc "Truncate all tables"

data/lib/tasks/rateaux_db_schema_view.rake

@@ -1,22 +1,27 @@
-# encoding: UTF-8
-#
+# frozen_string_literal: true
+
 # View database schema.
 #
 #     $ rake db:schema:view
-require 'terminal-table'
+require "terminal-table"
 namespace :db do
-    namespace :schema do
-      desc 'View database schema'
-       task :view  do
-         @environment = ENV['RACK_ENV'] || 'development'
-         @dbconfig = YAML.load(File.read('config/database.yml'))
-         ActiveRecord::Base.establish_connection @dbconfig[@environment]
-         tables = ActiveRecord::Base.connection.tables.reject { |t| t == "schema_migrations" }
-         tables.each do |table|
-           rows = ActiveRecord::Base.connection.columns(table).map{|column| [column.name, column.type] }
-           table = Terminal::Table.new :title => "#{table.capitalize}", :headings => ['Name', 'Type'], :rows => rows
-           puts table
-         end
-       end
+  namespace :schema do
+    desc "View database schema"
+    task :view do
+      @environment = ENV["RACK_ENV"] || "development"
+      @dbconfig = YAML.load_file("config/database.yml")
+      ActiveRecord::Base.establish_connection @dbconfig[@environment]
+      tables = ActiveRecord::Base.connection.tables.reject do |t|
+        t == "schema_migrations"
+      end
+      tables.each do |table|
+        rows = ActiveRecord::Base.connection.columns(table).map do |column|
+          [column.name, column.type]
+        end
+        table = Terminal::Table.new title: table.capitalize.to_s,
+                                    headings: %w[Name Type], rows: rows
+        puts table
+      end
     end
+  end
 end

data/lib/tasks/rateaux_git_checkout.rake

@@ -1,6 +1,6 @@
-# encoding: UTF-8
-#
-# Remove migrations then checkout a git branch
+# frozen_string_literal: true
+
+# Remove migrations then checkout a git branch.
 #
 #     $ rake checkout new_branch_name
 #
@@ -15,29 +15,31 @@
 
 desc "Switch git branches and apply migrations"
 task "checkout" do
-
   # We can't checkout if we're dirty
   unless `git diff --shortstat`.blank?
-    $stderr.puts "error: Your local changes would be overwritten by checkout."
-    $stderr.puts "Please, commit your changes or stash them before you can switch branches."
+    warn "error: Your local changes would be overwritten by checkout."
+    warn "Please, commit your changes or stash them before you can switch " \
+         "branches."
     abort "Aborting"
   end
 
   # Last argument trick
   # Via http://itshouldbeuseful.wordpress.com/2011/11/07/passing-parameters-to-a-rake-task/
-  task ARGV.last do ; end
+  task ARGV.last do
+    # DO nothing
+  end
   branch_name = ARGV.last
 
   # List migrations
   changes = `git diff #{branch_name} --name-status`.lines
-  migrations = changes.map { |change|
-    match = /^A.*migrate\/([0-9]+)/.match(change)
+  migrations = changes.map do |change|
+    match = %r{^A.*migrate/([0-9]+)}.match(change)
     match ? match[1] : nil
-  }.compact
+  end.compact
 
   # Drop it like it's hot
   migrations.sort.reverse.each do |migration|
-    # TODO we're already in rake, we should call these tasks directly
+    # TODO: we're already in rake, we should call these tasks directly
     sh "bundle exec rake db:migrate:down VERSION=#{migration}"
   end
 

data/lib/tasks/rateaux_notes_mine.rake

@@ -1,10 +1,10 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 namespace :notes do
   task :mine do
     me = `whoami`.strip
-    p Rake::Task['notes:custom'].arg_names
-    #Rake::Task['notes:custom'].set_arg_names([:annotation])
-    Rake::Task['notes:custom'].invoke("TODO @#{me}")
+    p Rake::Task["notes:custom"].arg_names
+    # Rake::Task["notes:custom"].set_arg_names([:annotation])
+    Rake::Task["notes:custom"].invoke("TODO @#{me}")
   end
 end

data/lib/tasks/rateaux_sidekiq_flush.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Empty all of Sidekiq's queues.
+#
+#     $ rake sidekiq:flush
+
+namespace :sidekiq do
+  desc "Empty Sidekiq queues"
+  task flush: :environment do
+    if Rails.env.production? && ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] != "1"
+      raise "This task should not be run in production. Set " \
+            "DISABLE_DATABASE_ENVIRONMENT_CHECK=1 to override."
+    end
+
+    # Via https://stackoverflow.com/a/38672157/311657
+    require "sidekiq/api"
+    Sidekiq::RetrySet.new.clear
+    Sidekiq::ScheduledSet.new.clear
+    Sidekiq::DeadSet.new.clear
+    Sidekiq::Stats.new.reset
+    Sidekiq::Queue.all.map(&:clear)
+  end
+end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rateaux
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Sunny Ripert
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.20
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,13 +52,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +94,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,17 +149,18 @@ files:
 - lib/rateaux/file_task.rb
 - lib/rateaux/namespaced.rb
 - lib/rateaux/version.rb
+- lib/tasks/rateaux_add_frozen_string_literal_headers.rake
 - lib/tasks/rateaux_cache_clear.rake
 - lib/tasks/rateaux_copy_non_digested_assets.rake
 - lib/tasks/rateaux_db.rake
 - lib/tasks/rateaux_db_schema_view.rake
-- lib/tasks/rateaux_encoding_headers.rake
 - lib/tasks/rateaux_git_checkout.rake
 - lib/tasks/rateaux_notes_mine.rake
+- lib/tasks/rateaux_sidekiq_flush.rake
 homepage: http://github.com/sunny/rateaux
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -126,16 +168,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A collection of usefull Rake tasks for Rails.
 test_files: []

data/lib/tasks/rateaux_encoding_headers.rake

@@ -1,25 +0,0 @@
-# encoding: UTF-8
-#
-# Add 'encoding: UTF-8' to all files
-#
-#     $ rake encoding_headers
-
-desc "Adds the missing utf-8 encoding header on all Ruby files"
-task :encoding_headers => :environment do
-  files = []
-  ["*.rb", "*.rake"].each do |extension|
-    files.concat(Dir[ File.join(Dir.getwd.split(/\\/), "**", extension) ])
-  end
-
-  encoding = "# encoding: UTF-8\n"
-
-  files.each do |file|
-    content = File.read(file)
-    next if content[0..encoding.length] == encoding
-    content = content.gsub(/^# (encoding: UTF-8|coding: UTF-8|-*- coding: UTF-8 -*-)\n/i, "")
-    new_file = File.open(file, "w")
-    new_file.write(encoding+content)
-    new_file.close
-  end
-end
-