markdown_tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80c589374873d6426d2de3a445ac43861cc2e6a9dc601aef2333bdad76b03569
+  data.tar.gz: 1e3ff7583d53a28c58fde933d69f3cb3062d0c3ccb203c9faddf20821e8e682b
+SHA512:
+  metadata.gz: f15388e828bdc99e83670ae660d82d66b446d34ee0b3ce2405eaa2f311abab9a0d503ece311eb7e3a3d580449a2d9cafb700c6ffc60d8f801f88aece66c3010e
+  data.tar.gz: 40bea3084e3fec4c7b1e6e474db49595dc66b1787b1d87713e96f10e76ede80609cf75cb0e63a8944de3efc6bb9691b7c2d6b9a13a0efb513769b14e4a258fda

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,84 @@
+# MarkdownTree
+
+**MarkdownTree** is a Ruby gem that generates a directory structure in Markdown format. It is highly configurable, allowing you to exclude specific folders, choose the root directory, and specify the output file name.
+
+## Installation
+
+You can install the gem and add it to your application's Gemfile by executing:
+
+```bash
+bundle add markdown_tree
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install markdown_tree
+```
+
+## Usage
+
+### Basic Example
+
+To generate the directory structure in Markdown format from the current directory, simply call the `generate_tree` method:
+
+```ruby
+require 'markdown_tree'
+
+MarkdownTree.generate_tree
+```
+
+### Excluding Specific Folders
+
+You can configure which folders to exclude from the generated structure:
+
+```ruby
+MarkdownTree.configure do |config|
+  config.exclude_list = ['node_modules', '.git', 'tmp']
+end
+
+MarkdownTree.generate_tree
+```
+
+### Selecting the Root Directory
+
+You can also specify the directory from which you want to generate the structure:
+
+```ruby
+MarkdownTree.configure do |config|
+  config.root_directory = '/path/to/your/directory'
+end
+
+MarkdownTree.generate_tree
+```
+
+### Customizing the Output File Name
+
+You can set the name of the file where the directory structure will be saved:
+
+```ruby
+MarkdownTree.configure do |config|
+  config.output_file = 'custom_directory_structure.md'
+end
+
+MarkdownTree.generate_tree
+```
+
+### Full Configuration Example in Rails
+
+If you're using Rails, you can configure all these options in an initializer:
+
+```ruby
+# config/initializers/markdown_tree.rb
+MarkdownTree.configure do |config|
+  config.exclude_list = ['node_modules', '.git', 'tmp']  # Directories to exclude
+  config.root_directory = Rails.root.join('app').to_s     # Root directory to start generating structure
+  config.output_file = 'custom_directory_structure.md'    # Output file name
+end
+```
+
+## Contributing
+Contribution directions go here. You can fork the repository, create a new branch, and submit a pull request for review. Please make sure to write tests for your contributions and follow the coding standards set in the project.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/markdown_tree/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MarkdownTree
+  VERSION = "0.1.0"
+end

data/lib/markdown_tree.rb

@@ -0,0 +1,46 @@
+require "markdown_tree/version"
+require "markdown_tree/configuration"
+require "markdown_tree/railtie" if defined?(Rails)
+
+module MarkdownTree
+  class << self
+    def generate_tree(directory = nil)
+      directory ||= configuration.root_directory || Dir.pwd
+
+      File.open(configuration.output_file, "w") do |file|
+        process_directory(directory, file)
+      end
+    end
+
+    private
+
+    def process_directory(directory, file, prefix = "")
+      items = Dir.entries(directory) - [".", ".."]
+
+      items.reject! { |item| configuration.exclude_list.include?(item) }
+
+      items.each_with_index do |item, index|
+        path = File.join(directory, item)
+        is_last = index == items.size - 1
+        connector = is_last ? "└── " : "├── "
+
+        file.puts "#{prefix}#{connector}#{item}"
+
+        if File.directory?(path)
+          new_prefix = prefix + (is_last ? "    " : "│   ")
+          process_directory(path, file, new_prefix)
+        end
+      end
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  configure do |config|
+    config.exclude_list = ["node_modules", ".git", ".DS_Store"]
+    config.root_directory = Dir.pwd
+    config.output_file = "directory_structure.md"
+  end
+end

data/sig/markdown_tree.rbs

@@ -0,0 +1,4 @@
+module MarkdownTree
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: markdown_tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aemabit
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-28 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  MarkdownTree is designed for developers and teams who need a simple and flexible way to document the structure of their projects. Whether you are preparing a README, documenting a codebase, or generating a project overview, MarkdownTree allows you to create a clear and organized representation of your directory structure in Markdown format.
+
+    With MarkdownTree, you can:
+    - Exclude specific folders or files from the generated structure.
+    - Define the root directory from which to start generating the structure.
+    - Customize the output file name to fit your documentation standards.
+
+    MarkdownTree integrates seamlessly with Rails and other Ruby applications, offering an initializer for easy configuration. It is a valuable tool for maintaining clear and up-to-date project documentation.
+email:
+- am@connectnodes.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/markdown_tree.rb
+- lib/markdown_tree/version.rb
+- sig/markdown_tree.rbs
+homepage: https://github.com/aemabit/markdown_tree
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/aemabit/markdown_tree
+  source_code_uri: https://github.com/aemabit/markdown_tree
+  changelog_uri: https://github.com/aemabit/markdown_tree/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Generates a directory structure in Markdown format.
+test_files: []