rails-metro 0.1.0

data/lib/rails/metro/feature_registry.rb

@@ -0,0 +1,147 @@
+module Rails
+  module Metro
+    class FeatureRegistry
+      class DependencyError < StandardError; end
+      class ConflictError < StandardError; end
+
+      def initialize
+        @packs = {}
+      end
+
+      def register(pack_class)
+        name = pack_class.pack_name
+        raise ArgumentError, "Pack must define a pack_name" unless name
+        @packs[name] = pack_class
+      end
+
+      def all
+        @packs.values
+      end
+
+      def names
+        @packs.keys.sort
+      end
+
+      def find(name)
+        @packs[name.to_s]
+      end
+
+      def categories
+        all.group_by { |p| p.category }
+      end
+
+      def resolve(selected_names)
+        selected = selected_names.map(&:to_s)
+        validate_existence!(selected)
+        validate_conflicts!(selected)
+        expand_dependencies(selected)
+      end
+
+      def as_catalog
+        all.sort_by(&:pack_name).map do |pack_class|
+          {
+            name: pack_class.pack_name,
+            description: pack_class.description,
+            category: pack_class.category,
+            depends_on: pack_class.depends_on,
+            conflicts_with: pack_class.conflicts_with
+          }
+        end
+      end
+
+      def validate_selection(selected_names)
+        selected = selected_names.map(&:to_s)
+        result = {valid: true, errors: [], auto_added: []}
+
+        unknown = selected - @packs.keys
+        if unknown.any?
+          result[:valid] = false
+          result[:errors] << "Unknown packs: #{unknown.join(", ")}"
+          return result
+        end
+
+        selected.each do |name|
+          pack = @packs[name]
+          conflicting = pack.conflicts_with & selected
+          if conflicting.any?
+            result[:valid] = false
+            result[:errors] << "Pack '#{name}' conflicts with: #{conflicting.join(", ")}"
+          end
+        end
+
+        return result unless result[:valid]
+
+        resolved = expand_dependencies(selected)
+        resolved_names = resolved.map(&:pack_name)
+        result[:auto_added] = resolved_names - selected
+        result
+      rescue DependencyError => e
+        result[:valid] = false
+        result[:errors] << e.message
+        result
+      end
+
+      def self.default
+        @default ||= build_default
+      end
+
+      def self.build_default
+        registry = new
+        load_builtin_packs
+        builtin_pack_classes.each { |klass| registry.register(klass) }
+        registry
+      end
+
+      def self.load_builtin_packs
+        Dir.glob(File.join(__dir__, "packs", "**", "*_pack.rb")).sort.each { |f| require f }
+      end
+
+      def self.builtin_pack_classes
+        ObjectSpace.each_object(Class).select { |c|
+          c < FeaturePack && c.pack_name && c.name&.start_with?("Rails::Metro::Packs::")
+        }
+      end
+
+      private
+
+      def validate_existence!(names)
+        unknown = names - @packs.keys
+        if unknown.any?
+          raise DependencyError, "Unknown packs: #{unknown.join(", ")}. Available: #{@packs.keys.sort.join(", ")}"
+        end
+      end
+
+      def validate_conflicts!(names)
+        names.each do |name|
+          pack = @packs[name]
+          conflicting = pack.conflicts_with & names
+          if conflicting.any?
+            raise ConflictError, "Pack '#{name}' conflicts with: #{conflicting.join(", ")}"
+          end
+        end
+      end
+
+      def expand_dependencies(names)
+        resolved = []
+        visited = Set.new
+        names.each { |name| visit(name, resolved, visited, []) }
+        resolved
+      end
+
+      def visit(name, resolved, visited, stack)
+        return if visited.include?(name)
+        if stack.include?(name)
+          raise DependencyError, "Circular dependency: #{(stack + [name]).join(" -> ")}"
+        end
+
+        stack.push(name)
+        pack = @packs[name]
+        pack.depends_on.each { |dep| visit(dep, resolved, visited, stack) }
+        stack.pop
+
+        visited.add(name)
+        resolved << @packs[name]
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/aasm_pack.rb

@@ -0,0 +1,29 @@
+module Rails
+  module Metro
+    module Packs
+      class AasmPack < FeaturePack
+        pack_name "aasm"
+        description "AASM for state machines in ActiveRecord models"
+        category "data"
+
+        def gems
+          [
+            {name: "aasm"}
+          ]
+        end
+
+        def template_lines
+          []
+        end
+
+        def post_install_notes
+          [
+            "AASM: Add `include AASM` to models",
+            "AASM: Define states with `aasm do; state :draft, initial: true; state :published; end`",
+            "AASM: Define events with `event :publish do; transitions from: :draft, to: :published; end`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/ab_testing_pack.rb

@@ -0,0 +1,39 @@
+module Rails
+  module Metro
+    module Packs
+      class AbTestingPack < FeaturePack
+        pack_name "ab_testing"
+        description "Split for A/B testing and experiments"
+        category "data"
+
+        def gems
+          [
+            {name: "split", version: "~> 4.0"}
+          ]
+        end
+
+        def template_lines
+          [
+            'create_file "config/initializers/split.rb", <<~RUBY',
+            "  Split.configure do |config|",
+            "    config.allow_multiple_experiments = true",
+            "    config.persistence = Split::Persistence::SessionAdapter",
+            "  end",
+            "RUBY",
+            "",
+            'route "mount Split::Dashboard, at: \\"/split\\""'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Split: Requires Redis for experiment storage",
+            "Split: Use `ab_test(\"button_color\", \"red\", \"blue\")` in views/controllers",
+            "Split: Call `ab_finished(\"button_color\")` on conversion",
+            "Split: Dashboard at /split"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/action_text_pack.rb

@@ -0,0 +1,29 @@
+module Rails
+  module Metro
+    module Packs
+      class ActionTextPack < FeaturePack
+        pack_name "action_text"
+        description "Action Text for rich text editing with Trix"
+        category "ui"
+
+        def gems
+          []
+        end
+
+        def template_lines
+          [
+            'rails_command "action_text:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Action Text: Run `bin/rails db:migrate` to create rich text tables",
+            "Action Text: Add `has_rich_text :body` to models",
+            "Action Text: Use `<%= form.rich_text_area :body %>` in forms"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/activeadmin_pack.rb

@@ -0,0 +1,32 @@
+module Rails
+  module Metro
+    module Packs
+      class ActiveadminPack < FeaturePack
+        pack_name "activeadmin"
+        description "ActiveAdmin -- classic, battle-tested admin framework"
+        category "admin"
+        conflicts_with "avo", "administrate", "madmin"
+
+        def gems
+          [
+            {name: "activeadmin"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate active_admin:install --skip-users"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "ActiveAdmin: Run `bin/rails db:migrate` to create admin tables",
+            "ActiveAdmin: Access admin at /admin",
+            "ActiveAdmin: Register resources with `bin/rails g active_admin:resource User`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/activity_feed_pack.rb

@@ -0,0 +1,31 @@
+module Rails
+  module Metro
+    module Packs
+      class ActivityFeedPack < FeaturePack
+        pack_name "activity_feed"
+        description "Public Activity for activity feeds and timelines"
+        category "data"
+
+        def gems
+          [
+            {name: "public_activity"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate public_activity:migration"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Activity Feed: Run `bin/rails db:migrate` to create activities table",
+            "Activity Feed: Add `include PublicActivity::Model` and `tracked` to models",
+            "Activity Feed: Query with `PublicActivity::Activity.order(created_at: :desc)`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/acts_as_list_pack.rb

@@ -0,0 +1,28 @@
+module Rails
+  module Metro
+    module Packs
+      class ActsAsListPack < FeaturePack
+        pack_name "acts_as_list"
+        description "Acts As List for sortable, orderable records"
+        category "data"
+
+        def gems
+          [
+            {name: "acts_as_list"}
+          ]
+        end
+
+        def template_lines
+          []
+        end
+
+        def post_install_notes
+          [
+            "Acts As List: Add `acts_as_list` to models with a `position` integer column",
+            "Acts As List: Use `item.move_to_top`, `item.move_lower`, `item.insert_at(2)`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/acts_as_votable_pack.rb

@@ -0,0 +1,32 @@
+module Rails
+  module Metro
+    module Packs
+      class ActsAsVotablePack < FeaturePack
+        pack_name "acts_as_votable"
+        description "Acts As Votable for likes, upvotes, and reactions"
+        category "data"
+
+        def gems
+          [
+            {name: "acts_as_votable"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate acts_as_votable:migration"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Votable: Run `bin/rails db:migrate` to create votes table",
+            "Votable: Add `acts_as_votable` to models that can be voted on",
+            "Votable: Add `acts_as_voter` to User model",
+            "Votable: Use `user.likes @post` and `@post.liked_by user`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/administrate_pack.rb

@@ -0,0 +1,31 @@
+module Rails
+  module Metro
+    module Packs
+      class AdministratePack < FeaturePack
+        pack_name "administrate"
+        description "Administrate -- Thoughtbot's lightweight admin framework"
+        category "admin"
+        conflicts_with "avo", "activeadmin", "madmin"
+
+        def gems
+          [
+            {name: "administrate"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate administrate:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Administrate: Access admin at /admin",
+            "Administrate: Generate dashboards with `bin/rails g administrate:dashboard User`"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/after_party_pack.rb

@@ -0,0 +1,31 @@
+module Rails
+  module Metro
+    module Packs
+      class AfterPartyPack < FeaturePack
+        pack_name "after_party"
+        description "AfterParty for one-time post-deploy tasks"
+        category "ops"
+
+        def gems
+          [
+            {name: "after_party"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate after_party:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "AfterParty: Generate tasks with `bin/rails g after_party:task seed_admin_user`",
+            "AfterParty: Run with `bin/rails after_party:run`",
+            "AfterParty: Tasks only run once (tracked in task_records table)"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/ahoy_pack.rb

@@ -0,0 +1,31 @@
+module Rails
+  module Metro
+    module Packs
+      class AhoyPack < FeaturePack
+        pack_name "ahoy"
+        description "Ahoy for visit and event tracking (first-party analytics)"
+        category "analytics"
+
+        def gems
+          [
+            {name: "ahoy_matey"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate ahoy:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Ahoy: Run `bin/rails db:migrate` to create visits and events tables",
+            "Ahoy: Track events with `ahoy.track \"Viewed product\", product_id: product.id`",
+            "Ahoy: Visits auto-tracked -- access with `current_visit` in controllers"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/amplitude_pack.rb

@@ -0,0 +1,45 @@
+module Rails
+  module Metro
+    module Packs
+      class AmplitudePack < FeaturePack
+        pack_name "amplitude"
+        description "Amplitude for product analytics, funnels, and retention"
+        category "analytics"
+
+        def gems
+          [
+            {name: "amplitude-api"}
+          ]
+        end
+
+        def template_lines
+          [
+            'create_file "config/initializers/amplitude.rb", <<~RUBY',
+            "  AmplitudeAPI.config.api_key = Rails.application.credentials.dig(:amplitude, :api_key) || ENV[\"AMPLITUDE_API_KEY\"]",
+            "RUBY",
+            "",
+            'create_file "app/views/layouts/_amplitude.html.erb", <<~ERB',
+            "  <script type=\"text/javascript\">",
+            '    !function(){"use strict";!function(e,t){var r=e.amplitude||{_q:[],_iq:{}};if(r.invoked)e.console&&console.error&&console.error("Amplitude snippet has been loaded.");else{var n=function(e,t){e.prototype[t]=function(){return this._q.push({name:t,args:Array.prototype.slice.call(arguments,0)}),this}},s=function(e,t,r){return function(n){e._q.push({name:t,args:Array.prototype.slice.call(arguments,0),resolve:n})}},o=function(e,t,r){e._q.push({name:t,args:Array.prototype.slice.call(arguments,0)})},i=function(e,t,r){e[t]=function(){if(r)return{promise:new Promise(s(e,t,r))};o(e,t,r)}},a=function(e){for(var t=0;t<g.length;t++)i(e,g[t],!1);for(var r=0;r<m.length;r++)i(e,m[r],!0)};r.invoked=!0;var c=t.createElement("script");c.type="text/javascript",c.integrity="sha384-PPfHw98myKtJkA9OdPBMQ6n8yvUaYk0EyUQccFSIQGmB05K6aAMZwvv8d/EmYKhv",c.crossOrigin="anonymous",c.async=!0,c.src="https://cdn.amplitude.com/libs/analytics-browser-2.11.1-min.js.gz",c.onload=function(){e.amplitude.runQueuedFunctions||console.log("[Amplitude] Error: could not load SDK")};var u=t.getElementsByTagName("script")[0];u.parentNode.insertBefore(c,u);for(var l=function(){return this._q=[],this},p=["add","append","clearAll","prepend","set","setOnce","unset","preInsert","postInsert","remove","getUserProperties"],d=0;d<p.length;d++)n(l,p[d]);r.Identify=l;for(var f=function(){return this._q=[],this},v=["getEventProperties","setProductId","setQuantity","setPrice","setRevenue","setRevenueType","setEventProperties"],y=0;y<v.length;y++)n(f,v[y]);r.Revenue=f;var g=["getDeviceId","setDeviceId","getSessionId","setSessionId","getUserId","setUserId","setOptOut","setTransport","reset","extendSession"],m=["init","add","remove","track","logEvent","identify","groupIdentify","setGroup","revenue","flush"];a(r),r.createInstance=function(e){return r._iq[e]={_q:[]},a(r._iq[e]),r._iq[e]},e.amplitude=r}}(window,document)}();',
+            '    amplitude.init("<%%= Rails.application.credentials.dig(:amplitude, :api_key) || ENV["AMPLITUDE_API_KEY"] %>");',
+            "  </script>",
+            "ERB",
+            "",
+            'inject_into_file "app/views/layouts/application.html.erb", after: "<head>\\n" do',
+            '  "    <%= render \\"layouts/amplitude\\" %>\\n"',
+            "end"
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Amplitude: Add your API key with `bin/rails credentials:edit`:",
+            "  amplitude:",
+            "    api_key: your_api_key",
+            "Amplitude: Use `AmplitudeAPI.track(event)` server-side for backend events"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/annotate_pack.rb

@@ -0,0 +1,30 @@
+module Rails
+  module Metro
+    module Packs
+      class AnnotatePack < FeaturePack
+        pack_name "annotate"
+        description "Annotate models and routes with schema info"
+        category "data"
+
+        def gems
+          [
+            {name: "annotaterb", group: :development}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate annotate_rb:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Annotate: Schema comments are auto-added to models after migrations",
+            "Annotate: Run `bin/rails annotate_models` to annotate manually"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/api_cors_pack.rb

@@ -0,0 +1,41 @@
+module Rails
+  module Metro
+    module Packs
+      class ApiCorsPack < FeaturePack
+        pack_name "api_cors"
+        description "Rack CORS for cross-origin API requests"
+        category "api"
+
+        def gems
+          [
+            {name: "rack-cors"}
+          ]
+        end
+
+        def template_lines
+          [
+            'create_file "config/initializers/cors.rb", <<~RUBY',
+            "  Rails.application.config.middleware.insert_before 0, Rack::Cors do",
+            "    allow do",
+            '      origins Rails.application.credentials.dig(:cors, :origins) || ENV.fetch("CORS_ORIGINS", "http://localhost:3000")',
+            "",
+            "      resource \"*\",",
+            "        headers: :any,",
+            "        methods: %i[get post put patch delete options head],",
+            "        credentials: true",
+            "    end",
+            "  end",
+            "RUBY"
+          ]
+        end
+
+        def post_install_notes
+          [
+            "CORS: Update allowed origins in config/initializers/cors.rb",
+            "CORS: Set CORS_ORIGINS env var in production (comma-separated domains)"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/api_docs_pack.rb

@@ -0,0 +1,34 @@
+module Rails
+  module Metro
+    module Packs
+      class ApiDocsPack < FeaturePack
+        pack_name "api_docs"
+        description "Rswag for Swagger/OpenAPI documentation from tests"
+        category "api"
+
+        def gems
+          [
+            {name: "rswag-api"},
+            {name: "rswag-ui"},
+            {name: "rswag-specs", group: :test}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate rswag:api:install"',
+            'rails_command "generate rswag:ui:install"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "Rswag: Write request specs with `describe 'API', swagger_doc: 'v1/swagger.yaml'`",
+            "Rswag: Generate docs with `rake rswag:specs:swaggerize`",
+            "Rswag: Swagger UI available at /api-docs"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/rails/metro/packs/api_guard_pack.rb

@@ -0,0 +1,31 @@
+module Rails
+  module Metro
+    module Packs
+      class ApiGuardPack < FeaturePack
+        pack_name "api_guard"
+        description "API Guard for JWT authentication in Rails APIs"
+        category "api"
+
+        def gems
+          [
+            {name: "api_guard"}
+          ]
+        end
+
+        def template_lines
+          [
+            'rails_command "generate api_guard:initializer"'
+          ]
+        end
+
+        def post_install_notes
+          [
+            "API Guard: Run `bin/rails db:migrate` to create token tables",
+            "API Guard: Add `api_guard_routes for: 'users'` to routes",
+            "API Guard: Endpoints: POST /users/sign_in, DELETE /users/sign_out, POST /users/tokens"
+          ]
+        end
+      end
+    end
+  end
+end