Skip to content

Commit

Permalink
feat: create script
Browse files Browse the repository at this point in the history
  • Loading branch information
LucaPipolo committed Jun 6, 2024
0 parents commit 13441f3
Show file tree
Hide file tree
Showing 5 changed files with 379 additions and 0 deletions.
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 e-mail 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
15 changes: 15 additions & 0 deletions Formula/wp-blocks-library.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
class WpBlocksLibrary < Formula
desc "Scaffolds a WordPress project using Docker and optionally a starter theme"
homepage "https://github.com/somoscuatro/homebrew-wp-blocks-library"
url "https://github.com/somoscuatro/homebrew-wp-blocks-library/archive/refs/tags/v1.0.0.tar.gz"
sha256 ""
license "MIT"

def install
bin.install "wp-blocks-library.sh" => "wp-blocks-library"
end

test do
system "#{bin}/wp-blocks-library", "--version"
end
end
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Released under MIT License

Copyright (c) 2024 somoscuatro.

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.
84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# WordPress Blocks Library

This tool downloads ACF Gutenberg Blocks and Components from the [somoscuatro
blocks library](https://github.com/somoscuatro/wp-blocks-library).

Our library contains a collection of blocks that can be reused in your theme,
such as hero, CTA, accordions, etc. Components are reusable templates that can
be used by multiple blocks or templates (e.g., image, button, etc.).

## Prerequisites

Our blocks are designed to work with themes that follow the structure of [our
starter theme](https://github.com/somoscuatro/sc-starter-theme).

You can scaffold a new WordPress project that uses our starter theme by using
[our `wp-project-scaffold` Homebrew
command](https://github.com/somoscuatro/homebrew-wp-project-scaffold).

## Installation

To install the WordPress Blocks Library, follow these steps:

1. Add the custom Homebrew tap:

```shell
brew tap somoscuatro/homebrew-wp-blocks-library
```

2. Install the `wp-blocks-library` tool via Homebrew:

```shell
brew install wp-blocks-library
```

## Usage

Navigate to your theme folder and run the following command to install a block:

```shell
wp-blocks-library add block [block-name]
```

This will automatically install the block in your theme's `src/blocks` folder
and install all dependencies needed by the block.

You can also install components by running:

```shell
wp-blocks-library add component [component-name]
```

To remove a block, use:

```shell
wp-blocks-library remove block [block-name]
```

And to remove a component, use:

```shell
wp-blocks-library remove component [component-name]
```

Please note that when you remove a block, dependencies are not removed
automatically to avoid deleting dependencies needed by other blocks. You can
manually remove the component with the command mentioned above.

## How to Contribute

Any kind of contribution is very welcome!

Please be sure to read our [Code of
Conduct](https://raw.githubusercontent.com/somoscuatro/homebrew-wp-blocks-library/main/CODE_OF_CONDUCT.md).

If you notice something wrong please open an issue or create a Pull Request or
just send an email to [[email protected]](mailto:[email protected]). If you
want to warn us about an important security vulnerability, please read our
Security Policy.

## License

All code is released under MIT license version. For more information, please
refer to
[LICENSE.md](https://raw.githubusercontent.com/somoscuatro/homebrew-wp-blocks-library/main/LICENSE.md)
128 changes: 128 additions & 0 deletions wp-blocks-library.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
#!/bin/bash

# Check for the --version flag
if [[ "$1" == "--version" ]]; then
echo "wp-blocks-library version 1.0.0"
exit 0
fi

# Function to download a file from GitHub
download_file() {
local download_url="$1"
local target_path="$2"
local filename=$(basename "$download_url")

curl -s -o "${target_path}/${filename}" "$download_url"
}

# Function to download a component
download_component() {
local component_name="$1"
local repo="somoscuatro/wp-blocks-library"
local api_url="https://api.github.com/repos/${repo}/contents/components/${component_name}?ref=main"
local target_dir="./templates/components/${component_name}"

mkdir -p "${target_dir}"

local file_list=$(curl -s "$api_url")

if [[ -z "$file_list" || "$file_list" == "[]" || "$file_list" == "null" ]]; then
echo "☠️ Error: Component '${component_name}' not found in the repository."
exit 1
fi

echo "$file_list" | jq -r '.[] | .download_url' | while read -r download_url; do
if [[ "$download_url" != "null" ]]; then
download_file "$download_url" "$target_dir"
else
echo "⚠️ Warning: A file in the component directory does not have a download URL."
fi
done

echo "✅ Component '${component_name}' has been successfully downloaded to '${target_dir}'."
}

# Function to download a block
download_block() {
local block_name="$1"
local repo="somoscuatro/wp-blocks-library"
local api_url="https://api.github.com/repos/${repo}/contents/blocks/${block_name}?ref=main"
local target_dir="./src/blocks/${block_name}"

echo "🚧 Adding block: ${block_name}"

mkdir -p "${target_dir}"

local file_list=$(curl -s "$api_url")

if [[ -z "$file_list" || "$file_list" == "[]" || "$file_list" == "null" ]]; then
echo "☠️ Error: Block '${block_name}' not found in the repository."
exit 1
fi

echo "$file_list" | jq -r '.[] | .download_url, .name' | while read -r download_url; read -r file_name; do
if [[ "$download_url" != "null" ]]; then
download_file "$download_url" "$target_dir"

# Parse the block.json file for dependencies
if [[ "$file_name" == "block.json" ]]; then
local dependencies=$(curl -s "$download_url" | jq -r '.dependencies.components[]')
for component in $dependencies; do
echo "🚧 Adding block dependency: ${component}"
download_component "$component"
done
fi
else
echo "⚠️ Warning: A file in the block directory does not have a download URL."
fi
done

echo "✅ Block '${block_name}' has been successfully downloaded to '${target_dir}'."
}

# Function to remove a component
remove_component() {
local component_name="$1"
local target_dir="./templates/components/${component_name}"

# Check if the component directory exists
if [ -d "$target_dir" ]; then
echo "🚧 Removing component: ${component_name}"
rm -rf "${target_dir}"
echo "✅ Component '${component_name}' has been successfully removed."
else
echo "☠️ Component '${component_name}' is not installed."
fi
}

# Function to remove a block
remove_block() {
local block_name="$1"
local block_dir="./src/blocks/${block_name}"

# Check if the block directory exists
if [ -d "$block_dir" ]; then
echo "🚧 Removing block: ${block_name}"
rm -rf "${block_dir}"
echo "✅ Block '${block_name}' has been successfully removed."
else
echo "☠️ Block '${block_name}' is not installed."
fi
}

# Main script logic
if [[ "$1" == "add" && "$2" == "block" && -n "$3" ]]; then
download_block "$3"
elif [[ "$1" == "remove" && "$2" == "block" && -n "$3" ]]; then
remove_block "$3"
elif [[ "$1" == "add" && "$2" == "component" && -n "$3" ]]; then
download_component "$3"
elif [[ "$1" == "remove" && "$2" == "component" && -n "$3" ]]; then
remove_component "$3"
else
echo "Usage: $0 add block <block-name>"
echo " $0 remove block <block-name>"
echo " $0 add component <component-name>"
echo " $0 remove component <component-name>"
exit 1
fi

0 comments on commit 13441f3

Please sign in to comment.