avo_upgrade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7c4c205f4c99041d674a65cd96474518f4694c14b63134e09f33c35b54f9308
+  data.tar.gz: a8aeb29143b89d99422223c63fe59a9e8773663b5eea19a6966b6dd85a147306
+SHA512:
+  metadata.gz: 44266214d009dd85c00aeff57aa83b981b414a05eab37ac9d048e2b3193d62d418fc00465efbed077638a390f9c400524b6e6a7a581effdb408e3dde047f3926
+  data.tar.gz: a554b83067e15a6992e01a88a2e9b9c5eb54426d8634da5d0865db13abd1ec92e3a3aeea6093e35732f5c7f16df8a15e13d1e88c26f28a1704b29294b6e1ad36

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Adrian Marin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# AvoUpgrade
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "avo_upgrade"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install avo_upgrade
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/avo_upgrade/railtie.rb

@@ -0,0 +1,8 @@
+module AvoUpgrade
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/../tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/avo_upgrade/upgrade29to30.rb

@@ -0,0 +1,113 @@
+module AvoUpgrade
+  class Upgrade29to30 < AvoUpgrade::UpgradeTool
+    def run
+      # Replace all resource files with the new ones without the _resource suffix
+      replace_in_filename "_resource", "", path: resources_path
+
+      # Replace all "Avo::Dashboards::" with "AvoDashboards::" in all files
+      replace_text_on(avo_global_files, { "Avo::Dashboards::" => "AvoDashboards::" }, exact_match: false)
+
+      # Create a hash with old class names as keys and new class names as values
+      # Example: { "Avo::Resources::UserResource" => "Avo::Resources::User" }
+      old_text_new_text_hash = class_names_for(:resources).map do |class_name|
+        [class_name, "Avo::Resources::#{class_name.sub(/Resource$/, '')}"]
+      end.to_h
+
+      # Same as above but for all components, class name don't change, only the namespace
+      [:actions, :filters, :resource_tools, :dashboards, :cards].each do |component|
+        old_text_new_text_hash.merge! change_class_name_hash_for(component)
+      end
+
+      replace_text_on(files_from(actions_path), {"model" => "record"}, exact_match: false)
+      replace_text_on(
+        files_from(resources_path),
+        {
+          "model." => "record.",
+          "model_class." => "query.",
+          "scope." => "query.",
+          "resolve_query_scope" => "index_query",
+        },
+        exact_match: false
+      )
+      replace_text_on(avo_global_files, old_text_new_text_hash)
+
+      # Remove arguments from the blocks
+      remove_text = [
+        "(resource:)",
+        "(model_class:, id:, params:)",
+        "(model_class:)",
+        "(value)",
+        "|model|",
+        "|model, resource|",
+        "|model, resource, view|",
+        "|model, resource, view, field|",
+        "|model, &args|"
+      ]
+      remove_text_on(files_from(resources_path) + files_from(actions_path) + files_from(filters_path), remove_text)
+
+      print "\n\nUpgrade to Avo 3.0 completed! 🚀\n\n"
+    end
+
+    def summary
+      # Get the names of all the resources, actions, filters, resource tools, dashboards and cards
+      resources_names = class_names_for(:resources)
+      actions_names = class_names_for(:actions)
+      filters_names = class_names_for(:filters)
+      resource_tools_names = class_names_for(:resource_tools)
+      dashboards_names = class_names_for(:dashboards)
+      cards_names = class_names_for(:cards)
+
+      # Print a summary of the upgrade process
+      puts "\n\nSummary of changes:\n" +
+        "---------------------\n" +
+        "Renaming Avo::Dashboards:: to AvoDashboards::\n" +
+        "Renaming resources naming from ClassNameResource to Avo::Resources::ClassName\n" +
+        "Renaming actions naming from ClassName to Avo::Actions::ClassName\n" +
+        "Renaming filters naming from ClassName to Avo::Filters::ClassName\n" +
+        "Renaming resource tools naming from ClassName to Avo::ResourceTools::ClassName\n" +
+        "Renaming dashboards naming from ClassName to Avo::Dashboards::ClassName\n" +
+        "Renaming cards naming from ClassName to Avo::Cards::ClassName\n" +
+        "Renaming 'resolve_query_scope' method in resource files to 'index_query'\n" +
+        "Removing unused arguments from blocks in resource, action and filter files\n" +
+        "Updating resource and action files to use 'record' instead of 'model'\n" +
+        "Updating resource files to use 'query' instead of 'model_class' and 'scope'\n" +
+        "Renaming resource files to remove the '_resource' suffix\n" +
+        "\n" +
+        "  - There are 2 ways of renaming the resource files:\n" +
+        "    1. Using `git mv` command, that automaticly stage the changes and makes the commit review process easier.\n" +
+        "    2. Using `mv` command, that will rename the files without relying on any specific version control system. You will have to stage the changes manually.\n"
+      @mv_cmd = nil
+      while @mv_cmd != "1" && @mv_cmd != "2"
+        print "  Choose the one you prefer (1 or 2) and press enter: "
+        @mv_cmd = gets.chomp
+      end
+      puts "---------------------\n" +
+      "The following components will be upgraded:\n" +
+      "\nResources: \n -#{resources_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nActions: \n -#{actions_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nFilters: \n -#{filters_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nResource tools: \n -#{resource_tools_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nDashboards: \n -#{dashboards_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nCards: \n -#{cards_names.join("\n -")}\n"
+      enter_to_continue
+      puts "\nThis upgrade will NOT:\n" +
+        "- Apply the `def fields` and `def cards` API\n" +
+        "- Remove the argument from lambda functions if they are not as we specify them on docs.\n" +
+        "- Remove the index_text_align option\n" +
+        "- Swap disabled with readonly\n\n"
+    end
+
+    private
+
+    def change_class_name_hash_for(component)
+      pluralized_component = component.to_s.camelize.pluralize
+
+      class_names_for(component).map { |class_name| [class_name, "Avo::#{pluralized_component}::#{class_name}"] }.to_h
+    end
+  end
+end

data/lib/avo_upgrade/upgrade_tool.rb

@@ -0,0 +1,80 @@
+require "fileutils"
+
+# class generated by ChatGPT. Update it as you see fit.
+module AvoUpgrade
+  class UpgradeTool
+    class << self
+      def run
+        upgrade_tool = new
+        puts "DISCLAIMER: Please be aware that this is an automated upgrade and may make unintended changes to your files. We recommend that you carefully review all changes before committing them. While we have taken steps to ensure that the upgrade process is safe and reliable, there is always a possibility of unintended consequences. It is your responsibility to ensure that the modifications made by the upgrade are acceptable for your use case."
+        upgrade_tool.enter_to_continue
+        print upgrade_tool.summary
+        puts "Please make sure you commited all your changes before running this upgrade."
+        print "Do you want to run this upgrade? [y/n]: "
+        input = gets.chomp
+        return unless input == "y" || input == "Y"
+        upgrade_tool.run
+      end
+    end
+
+    def avo_global_files
+      Dir.glob(File.join(Rails.root.join("app", "avo"), '**/*')).select { |f| File.file?(f) } +
+      Dir.glob(File.join(Rails.root.join("app", "controllers", "avo"), '**/*')).select { |f| File.file?(f) } +
+      Dir.glob(File.join(Rails.root.join("app", "views", "avo"), '**/*')).select { |f| File.file?(f) }
+    end
+
+    def class_names_for(component)
+      names = []
+
+      Dir.glob(File.join(send("#{component}_path"), '**/*.rb')).each do |file|
+        # Match class definitions in the file
+        File.read(file).scan(/class\s+(\w+)/).each do |match|
+          # Add the matched class names to the list
+          names << match.first
+        end
+      end
+
+      names
+    end
+
+    # Dynamicly create path method for each component
+    # def resources_path, def actions_path, def filters_path, def resource_tools_path def dashboards_path, def cards_path
+    [:resources, :actions, :filters, :resource_tools, :dashboards, :cards].each do |component|
+      define_method "#{component}_path" do
+        Rails.root.join("app", "avo", component.to_s)
+      end
+    end
+
+    def files_from(path)
+      Dir.glob("#{path}/*.rb").select { |file| File.file?(file) }
+    end
+
+    def replace_text_on(files, hash, exact_match: true)
+      files.each do |file|
+        text = File.read(file)
+
+        hash.each do |old_text, new_text|
+          old_text = /\b#{Regexp.escape(old_text)}\b/ if exact_match
+          text.gsub!(old_text, new_text)
+        end
+
+        File.open(file, 'w') { |f| f.write(text) }
+      end
+    end
+
+    def remove_text_on(files, text_array)
+      replace_text_on(files, text_array.map { |text| [text, ""] }.to_h, exact_match: false)
+    end
+
+    def replace_in_filename(old_text, new_text, path:)
+      Dir.glob("#{path}/*.rb").each do |file_path|
+        `#{@mv_cmd == "1" ? "git mv" : "mv"} #{file_path} #{file_path.gsub(/#{old_text}/, new_text)}`
+      end
+    end
+
+    def enter_to_continue
+      print "\nPress ENTER to continue."
+      gets.chomp
+    end
+  end
+end

data/lib/avo_upgrade/version.rb

@@ -0,0 +1,3 @@
+module AvoUpgrade
+  VERSION = "0.1.0"
+end

data/lib/avo_upgrade.rb

@@ -0,0 +1,12 @@
+require "avo_upgrade/version"
+require "avo_upgrade/railtie"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module AvoUpgrade
+  # Your code goes here...
+end
+
+loader.eager_load

data/lib/tasks/avo_upgrade_tasks.rake

@@ -0,0 +1,4 @@
+desc "Upgrades Avo from 2.x to 3.0"
+task "avo:upgrade:2_to_3" do
+  AvoUpgrade::Upgrade29to30.run
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: avo_upgrade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Marin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  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'
+description: The friendly upgrade helper for Avo.
+email:
+- adrian@adrianthedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/avo_upgrade.rb
+- lib/avo_upgrade/railtie.rb
+- lib/avo_upgrade/upgrade29to30.rb
+- lib/avo_upgrade/upgrade_tool.rb
+- lib/avo_upgrade/version.rb
+- lib/tasks/avo_upgrade_tasks.rake
+homepage: https://avohq.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://avohq.io
+  source_code_uri: https://github.com/avo-hq/avo_upgrade
+  changelog_uri: https://github.com/avo-hq/avo_upgrade
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: The friendly upgrade helper for Avo.
+test_files: []