shorui 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c941e85895f0a8379bb62aad976170ad43e5f2e95c05563c511b9fed356112
-  data.tar.gz: a49192b11854a42310fcdd2b8c4e159d092a2692c5864b0400e0a2fabd513c48
+  metadata.gz: 9f9102ca73aae7b5452034ed9d668f92c1b554185f8324a42f4674657129af7a
+  data.tar.gz: 628a0ec7d8e7c08b9d33df04ba98caefab6b4ca021da6c3a2759aacfcfcfc631
 SHA512:
-  metadata.gz: da0a23b1b5ad8ddaa4db768598cb5fb97c9b71853b4f39a6df36f74aeba9b846762482ca9aac5966ae34bd86c895cb995abd8dfe8e0364a219217390a1859053
-  data.tar.gz: 1c0a0f66a997cf2dd18f3457ef4c4ee14d1b85523042130f47cd1bb18ca116a98ad14d83bbc29154b7a57d31496d58ce1c3d43cc300f14eb74f90ed5d1dc25c4
+  metadata.gz: 6ff9d04b9906b7a439c8f631192b3a03184c00590f213e774cc52085e66798aae835a8df88f44b549751339a70ab42d9173a6998895497ae258150cc9e018d98
+  data.tar.gz: 47267c746dd62adddf119503d94d09c17deb2afe0ee3af1491469da8d39f18fca661040ae63dc2d030ad37cce224fdbbe8e380e6407e37162b69669a1343c11c

data/README.md

@@ -1,43 +1,89 @@
 # Shorui
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/shorui.svg)](https://badge.fury.io/rb/shorui)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shorui`. To experiment with that code, run `bin/console` for an interactive prompt.
+Shorui is a Ruby gem that automatically generates API documentation by analyzing your Rails routes. It creates a clean, organized README.md file with detailed endpoint information.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'shorui'
+```
 
+And then execute:
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+$ bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
+Or install it yourself as:
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+$ gem install shorui
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+Shorui provides two Rake tasks:
+
+1. Generate full documentation including Rails routes:
+```bash
+rails shorui:generate
+```
+
+2. Generate documentation excluding Rails routes:
+```bash
+rails shorui:generate:no_rails_routes
+```
+
+The gem will automatically:
+- Analyze your Rails routes
+- Extract controller and action information
+- Identify required and optional parameters
+- Generate a formatted README.md in your project root
+- Include HTTP verbs, paths, and parameter details
+
+## Output Format
+
+The generated README.md will follow this structure:
+
+```markdown
+# Your Project Name API Documentation
+
+#### [HTTP_VERB] /path/to/endpoint
+- **Controller#Action:** `controller_name#action_name`
+- **Required Params:** `param1, param2` (if any)
+- **Optional Params:** `param1, param2` (if any)
+```
+
+## Features
+
+- Automatic route analysis
+- Clean and consistent documentation format
+- Support for all HTTP verbs
+- Parameter identification (required and optional)
+- Rails route filtering option
+- Proper handling of namespaced routes
+- Automatic project name formatting
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shorui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/shorui/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/thiagochirana/shorui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Code of Conduct
 
-Everyone interacting in the Shorui project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shorui/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Shorui project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Origins
+
+"Shorui" (書類) means "document" in Japanese, reflecting the gem's purpose of automatic documentation generation.

data/lib/shorui/generator.rb

@@ -1,29 +1,59 @@
 module Shorui
   class Generator
-    def self.fetch_routes
+    def self.fetch_routes(ignore_rails_paths = false)
       Rails.application.routes.routes.map do |route|
-        {
-          path: route.path.spec.to_s,
-          verb: route.verb,
-          controller_action: route.defaults.slice(:controller, :action),
-        }
-      end.reject { |r| r[:path].include?('(.:format)') }
-    end
+        path = route.path.spec.to_s.gsub("(.:format)", "")
+        
+        if ignore_rails_paths && path.start_with?("/rails")
+          next 
+        end
+    
+        controller = route.defaults.dig(:controller)
+        action = route.defaults.dig(:action)
+    
+        if controller && action
+          {
+            path: path,
+            verb: route.verb,
+            controller_action: { controller: controller, action: action },
+            required_params: route.path.required_names,
+            optional_params: route.defaults.keys - [:controller, :action]
+          }
+        end
+      end.compact
+    end   
 
-    def self.generate_readme
-      routes = fetch_routes
-      content = "# API Documentation\n\n"
+    def self.generate_readme(ignore_rails_paths = false)
+      routes = fetch_routes(ignore_rails_paths)
+      dir_name = File.basename(Dir.pwd)
+      formatted_name = dir_name.gsub(/[-_\/|\\.]/, ' ').split.map(&:capitalize).join(' ')
+      content = "# #{formatted_name} API Documentation\n\n"
 
       routes.each do |route|
-        controller = route[:controller_action][:controller]
-        action = route[:controller_action][:action]
-        content << "## #{controller.camelize}##{action}\n"
-        content << "- **Path:** `#{route[:path]}`\n"
-        content << "- **HTTP Verb:** `#{route[:verb]}`\n\n"
-      end
+        if route.nil?
+          next
+        end
+
+        if ignore_rails_paths
+          next if route[:verb].start_with?("/rails")
+        end
 
+        controller = route.dig(:controller_action, :controller)
+        action = route.dig(:controller_action, :action)
+
+        if controller && action
+          required_params = route[:required_params].any? ? route[:required_params].join(', ') : nil
+          optional_params = route[:optional_params].any? ? route[:optional_params].join(', ') : nil
+    
+          content << "#### [#{route[:verb]}] #{route[:path]}\n"
+          content << "- **Controller#Action:** `#{controller}##{action}`\n"
+          content << "- **Required Params:** `#{required_params}`\n" if required_params
+          content << "- **Optional Params:** `#{optional_params}`\n\n" if optional_params
+        end
+      end
+    
       File.write('README.md', content)
       puts "README.md successfully generated in #{Dir.pwd}!"
-    end
+    end    
   end
 end

data/lib/shorui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shorui
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/shorui.rb

@@ -1,9 +1,13 @@
-# frozen_string_literal: true
-
 require_relative "shorui/version"
 require_relative "shorui/generator"
+require 'rails'
 
 module Shorui
   class Error < StandardError; end
-  # Your code goes here...
-end
+
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/shorui.rake', __FILE__)
+    end
+  end
+end

data/lib/tasks/shorui.rake

@@ -1,6 +1,11 @@
 namespace :shorui do
   desc "Generate README.md from routes"
-  task generate: :environment do
-    Shorui::Generator.generate_readme
+  task :generate => :environment do
+    Shorui::Generator.generate_readme(false)
   end
-end
+
+  desc "Generate README.md excluding Rails routes"
+  task :'generate:no_rails_routes' => :environment do
+    Shorui::Generator.generate_readme(true)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shorui
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - DevCurumin
@@ -9,7 +9,35 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2025-01-20 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: A gem that helps you generate README.md from routes.rb
 email:
 - thiago.chirana@gmail.com