YARD
Rails Erd
YARD | Rails Erd | |
---|---|---|
18 | 10 | |
1,905 | 3,945 | |
- | 0.2% | |
6.5 | 0.0 | |
about 1 month ago | 7 months ago | |
Ruby | Ruby | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
YARD
-
What is JSDoc and why you may not need typescript for your next project?
JSDOC is a predefined method of documenting code for javascript ecosystem created in 1999 that works similar to libraries for other languages such as: Javadoc for java, YARD for ruby, etc..
-
Xeme: I'd value your opinion on my new Ruby gem
In addition to project documentation, you've included a lot of code comments. You could adopt a standardized format and use it to generate API documentation. RDoc and YARD are two options. If I were reviewing this code at work, I would probably ask you to remove comments that explain what, not why.
-
Programming types and mindsets
I still just document everything using YARD and focus on designing really obvious Object Models and of course write tests. I have tried using sord to convert my YARD type annotations to RBS or RBI, but you still have to fill in missing bits, then use steep and somehow load in RBS/RBI files for other gems and stdlib, and it's just an uphill battle since Ruby is dynamically typed by default. Obviously Dynamic Typing lends itself more to Dynamic Languages, where you can call an arbitrary method and let the language VM figure it out at runtime. Static or Strong Typing lends itself better to compiled languages where everything needs to be resolved at compile time and converted into object code. If I need to work in a compiled language, then I'll use Crystal, which also supports type inference. TypeScript's type syntax is quite nice, but I tend to avoid writing massive JavaScript code bases where a Type Checker helps catch subtle bugs, and instead prefer sticking to minimal amounts of vanilla JavaScriot in order to keep complexity low and not overwhelm the browser.
-
kwargs and YARD: @param or @option?
I had a dig into the file history, and it looks like we have to go back to 0.7 to find the old tag list. Here we find the info we need to understand the intent of the @option tag:
-
Comparing RDoc, YARD, and SDoc: Choosing the Right Documentation Generator for Your Ruby on Rails 5 Project
YARD: http://yardoc.org/
-
How do you document your code?
I tend to follow along using the YardDoc comment style. It has many small things I love about it; an example is when yardoc is followed it can be used to generate RBS/Sorbet type files with the sord gem, you can also generate application documents similar to rdoc/sdoc.
-
The right is on the left
That turns out to be a pretty common use case for markdown. Github, for example, renders your README.md is part of a git repo's "home" page. It's also common to have tooling that parses specially formatted comments in your source code and produce a documentation bundle, usually as a web page (ex. RDoc, YARD, JSDoc, etc.).
-
#buildinpublic, issue 1: building API documentation browser for command line
My first assumption was, that I should be able to generate markdown from the source. Same ruby and rails does now, but only tweaking a couple of parameters to generate .md files instead. YARD is being used for that and it supports any markup rdoc or yard.
-
The Why and How of Yardoc
I’ve long used the YARD format and chose to use that as my documentation syntax. I suppose I didn’t check with anyone on this decision and slowly started adding documentation. I want to use this post to synthesize my implicit decision and the benefits of using Yard as the documentation format.
-
Graphic representation of class / module inheritance in Rails?
That said, YARD is a ruby documentation tool that has a yard graph command you can use to dump a UML graph for your app into a .dot file, which can be used with lots of different graphing tools (usually graphviz but there are a bunch of online tools and open source projects that can visualize them for you).
Rails Erd
-
Accelerate Domain Learning: Explore Application Dependencies with RailsGraph
I've been using a simpler version of this https://github.com/voormedia/rails-erd but it seems neat that this comes with a web app and a query language.
- Tools for designing DB, table relationships?
-
My project: railstart app
Graphviz
-
Graphic representation of class / module inheritance in Rails?
Use the rails-erd gem to generate an ERD: http://voormedia.github.io/rails-erd/
-
Relations and Entity Relationship Diagrams
Entity Relationship Diagrams (ERDs) are super useful for visualizing databases. For an ERD example, or to see how to make one, see this gem. Though note that gem is only for rails 3-5.
-
Anyone know of a site that takes all your Rails models and their respective associations, and converts them into a visual model relationships diagram?
You should take a look at rails-erd, it is really easy to set up and works quite well
-
Embed a gem in a Rails project and enable autoreload - Format Express Blog
At my work we've got a 10-year-old Rails app (originally started as Rails 3), rake stats says we're now over 100kloc (non-test). We've got a huge amount of complexity and cross-dependencies (not to mention, probably-dead code), and the majority of our test suite runtime (about 40h non-parallelized) is in cucumber because developers can't get a clear view of the level of the app they're dealing with, and I suppose don't feel they can trust the lower layers of the application. Running rails-erd on it generates the very definition of spaghetti, it's gross.
-
Does anyone have a good ERD generation gem?
This PR fix the build
- Rails Model Visualizer
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
RailRoady - Ruby on Rails 3/4/5 model and controller UML class diagram generator. (`brew/port/apt-get install graphviz` before use!)
Apipie - Ruby on Rails API documentation tool
Ruby/GraphViz - [MIRROR] Ruby interface to the GraphViz graphing tool
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Chartkick - Create beautiful JavaScript charts with one line of Ruby
Asciidoctor - :gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
LazyHighCharts - Make highcharts a la ruby , works in rails 5.X / 4.X / 3.X, and other ruby web frameworks
Annotate - Annotate Rails classes with schema and routes info
Gruff Graphs - Gruff graphing library for Ruby
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
GeoPattern - Create beautiful generative geometric background images from a string.