rails_rules 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9be68c0ccba503fc0e42a71a14673463a20af8ffd94a914fb6102b5eb13262e
-  data.tar.gz: ea19c7d51efcca0cdeae7cb271eba93eb9a2be96c3d990d2202ba63855f1160c
+  metadata.gz: 189eaae24c2cb3bed4870749614cc557904504c7b37ca5665b0a729dc7d07dff
+  data.tar.gz: 74327970f054d075465fba4abb5321ff0d1cceecb5cfa6464c63f80e7ddb7c1f
 SHA512:
-  metadata.gz: 526d14c32a134a30ba92f58277549b3f624892a96928b4b1e9249fcfef7b703e3d05b752c62d1b123e5e578a4b25fbfb194c3c08b0de124902abc27ce48597ac
-  data.tar.gz: 230209de40658d6ec600028ed9b3ef14382b2439edd0ff86df0f9f140bd1980e0785b6c85738de7ee8dcae5048a9c27f88180b793e3e316576e93eb7fd285974
+  metadata.gz: 5ad6b06b9cc3f508f05fc09f567b32214bc1ace6e4d22531c3144c2b9f1e6b00522bdbca2d4e00ee387f730bda8044404ba31db29f887e53283090f4e8ad9566
+  data.tar.gz: 24228d4b9191e6238cdd04529c3c222b0d6561649906646e0fa6734005aecb248bb5405140d35de4c9cf7eef3fc68b286031b46dd981fcd7a7fb6b7ea78915e2

data/README.md

@@ -1,23 +1,26 @@
 # RailsRules
 
-This gem provides a set of [rules](https://docs.cursor.com/context/rules) files for working with AI tooling.
+This gem provides a set of [rules](https://docs.cursor.com/context/rules) files for use when building Rails apps with AI editor tools.
 
-At this early stage, the functionality is limited to creating `.cursor/rules` files for [Cursor](https://www.cursor.com).
+The rules are intended to be a starting point, corresponding to the Rails defaults for a new application. You should modify the rules as necessary for your application.
+
+Editors have different naming conventions and structure for rules files. Some support multiple files, but others require everything to be in a single file.
+
+Two editors are currently supported: Cursor and Zed
 
 The rules files were originally created by [Kieran Klaassen](https://github.com/kieranklaassen) and contributed to [Jumpstart Pro Rails](jumpstartrails.com), and are reproduced with permission.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add rails_rules
-```
+Add the gem to the `development` group in your Gemfile.
 
 ## Usage
 
+Run the generator corresponding to your editor:
+
 ```bash
-bin/rails generate rails_rules:default
+bin/rails generate rails_rules:cursor # generates a collection of rules in .cursor/rules
+bin/rails generate rails_rules:zed    # generates a single .rules file
 ```
 
 ## Development

data/lib/generators/rails_rules/{default_generator.rb → cursor_generator.rb}

@@ -1,5 +1,5 @@
 module RailsRules
-  class DefaultGenerator < Rails::Generators::Base
+  class CursorGenerator < Rails::Generators::Base
     TARGET_PATH = ".cursor/rules"
     source_root File.expand_path("templates", __dir__)
     def create_rules_cursor_directory
@@ -7,7 +7,7 @@ module RailsRules
     end
 
     def copy_files
-      directory_path = "lib/generators/default/templates"
+      directory_path = "lib/generators/cursor/templates"
       files = [
         "000-cursor-rules.mdc",
         "1000-rails-general.mdc",

data/lib/generators/rails_rules/zed_generator.rb

@@ -0,0 +1,31 @@
+require "front_matter_parser"
+
+module RailsRules
+  class ZedGenerator < Rails::Generators::Base
+    TARGET_PATH = ".rules"
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_files
+      result = ""
+      directory_path = "lib/generators/default/templates"
+      # NOTE: We skip "000-cursor-rules.mdc" for Zed
+      files = [
+        "1000-rails-general.mdc",
+        "1001-rails-controllers.mdc",
+        "1002-rails-models.mdc",
+        "1003-rails-views.mdc",
+        "1004-javascript-stimulus.mdc",
+        "1005-service-objects.mdc",
+        "1006-testing.mdc",
+        "1007-tailwindcss.mdc"
+      ]
+      files.each do |file|
+        templates_path = File.expand_path("templates", __dir__)
+        string = File.read(File.join(templates_path, file))
+        parser = FrontMatterParser::Parser.new(:md).call(string)
+        result += parser.content
+      end
+      create_file TARGET_PATH, result
+    end
+  end
+end

data/lib/rails_rules/version.rb

@@ -1,3 +1,3 @@
 module RailsRules
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_rules
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andy Waite
 bindir: bin
 cert_chain: []
-date: 2025-05-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: front_matter_parser
+  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'
 email:
 - andyw8@users.noreply.github.com
 executables: []
@@ -32,8 +46,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/generators/default/USAGE
-- lib/generators/rails_rules/default_generator.rb
+- lib/generators/cursor/USAGE
+- lib/generators/rails_rules/cursor_generator.rb
 - lib/generators/rails_rules/templates/000-cursor-rules.mdc
 - lib/generators/rails_rules/templates/1000-rails-general.mdc
 - lib/generators/rails_rules/templates/1001-rails-controllers.mdc
@@ -43,6 +57,7 @@ files:
 - lib/generators/rails_rules/templates/1005-service-objects.mdc
 - lib/generators/rails_rules/templates/1006-testing.mdc
 - lib/generators/rails_rules/templates/1007-tailwindcss.mdc
+- lib/generators/rails_rules/zed_generator.rb
 - lib/rails_rules.rb
 - lib/rails_rules/railtie.rb
 - lib/rails_rules/version.rb
@@ -68,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Create and manage rules files for AI tooling
 test_files: []