Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanami/assets
Assets management for Ruby web applications
https://github.com/hanami/assets
Last synced: 3 months ago
JSON representation
Assets management for Ruby web applications
- Host: GitHub
- URL: https://github.com/hanami/assets
- Owner: hanami
- License: mit
- Created: 2014-05-13T16:28:38.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T08:02:43.000Z (8 months ago)
- Last Synced: 2024-04-14T05:31:22.617Z (7 months ago)
- Language: Ruby
- Homepage: http://hanamirb.org
- Size: 1020 KB
- Stars: 47
- Watchers: 17
- Forks: 44
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Hanami::Assets
Assets management for Ruby web projects
## Status
[](https://badge.fury.io/rb/hanami-assets)
[](https://github.com/hanami/assets/actions?query=workflow%3Aci+branch%3Amain)
[](https://codecov.io/gh/hanami/assets)
[](https://depfu.com/github/hanami/assets?project=Bundler)
## Contact
* Home page: http://hanamirb.org
* Community: http://hanamirb.org/community
* Guides: https://guides.hanamirb.org
* Mailing List: http://hanamirb.org/mailing-list
* API Doc: http://rubydoc.info/gems/hanami-assets
* Forum: https://discourse.hanamirb.org
* Chat: http://chat.hanamirb.org
## Installation
__Hanami::Assets__ supports Ruby (MRI) 3.1+
Add this line to your application's Gemfile:
```ruby
gem "hanami-assets"
```
And then execute:
```shell
$ bundle
```
Or install it yourself as:
```shell
$ gem install hanami-assets
```
## Usage
### Command Line (CLI)
During development run `bundle exec hanami server`.
Your app will start the assets management.
### Helpers
Hanami Assets provides asset-specific helpers to be used in templates.
They resolve one or multiple sources into corresponding HTML tags.
Those sources can be either a name of a local asset or an absolute URL.
Given the following template:
```erb
Assets example
<%= stylesheet_tag "reset", "app" %>
<%= javascript_tag "app" %>
<%= javascript_tag "https://cdn.somethirdparty.script/foo.js", async: true %>
```
It will output this markup:
```html
Assets example
```
### Available Helpers
The `hanami` gem ships with the following helpers for assets:
* `asset_url`
* `javascript_tag`
* `stylesheet_tag`
* `favicon_tag`
* `image_tag`
* `video_tag`
* `audio_tag`
* `path_tag`
## App Structure
Hanami applications are generated via `hanami new` CLI command.
Among other directories, it generates a specific structure for assets:
```shell
$ tree app/assets
├── images
│ └── favicon.ico
├── js
│ └── app.ts
└── css
└── app.css
```
#### Entry Points
Entry Points are the JavaScript files or modules that serve as the starting points of your application.
They define the scope of your bundling process and determine which parts of your code will be included in the final output.
By understanding the dependencies of your entry points, Hanami Assets can create efficient and optimized bundles for your JavaScript or TypeScript applications.
When Hanami Assets encounters an import or require statement for an asset, it process the asset file to the output directory.
This process includes any kind of asset: other JavaScript files, stylesheets, images **referenced from the Entry Point**.
The default entry points are:
* `app/assets/js/app.ts`
* `slices/[slice-name]/assets/js/app.ts`
You can specify custom Entry Points, by adding an `app.{js,ts,mjs,mts,tsx,jsx}` file into the assets directory of the app or a slice.
An example is: `app/assets/js/login/app.ts` to define a new Entry Point for a Login page where you want to have a more lightweight bundle.
#### Static Assets
Except for `js` and `css` directories, all the other directories are considered **static**.
Their files will be copied as they are to the destination directory.
If you have a custom directory `app/assets/fonts`, all the fonts are copied to the destination direcotry.
#### Destination Directory
The destination directory is `public/assets`.
### Deployment
To process the assets during deployment run `bundle exec hanami assets compile`.
The destination directory will contain the processed assets with an hashed name.
#### Fingerprint Mode
Asset fingerprinting is a technique that involves adding a unique identifier to the filenames of static assets to ensure cache-busting.
By doing so, you can safely cache and deliver updated versions of assets to client browsers, avoiding the use of outdated cached versions and ensuring a consistent and up-to-date user experience.
During the deployment process, Hanami Assets appends to the file name a unique hash.
Example: `app/assets/js/app.ts` -> `public/assets/app-QECGTTYG.js`
It creates a `/public/assets.json` to map the original asset name to the fingerprint name.
The simple usage of the `js` helper, will be automatically mapped for you:
```erb
<%= assets.js "app" %>
```
```html
```
#### Subresource Integrity (SRI) Mode
Subresource Integrity (SRI) is a security mechanism that allows browsers to verify the integrity of external resources by comparing their content against a cryptographic hash. It helps protect against unauthorized modifications to external scripts and enhances the security and trustworthiness of web applications.
```ruby
module MyApp
class App < Hanami::App
config.assets.subresource_integrity = ["sha-384"]
end
end
```
Once turned on, it will look at `/public/assets.json`, and helpers such as `javascript` will include an `integrity` and `crossorigin` attribute.
```erb
<%= assets.js "app" %>
```
```html
```
#### Content Delivery Network (CDN) Mode
A Content Delivery Network (CDN) is a globally distributed network of servers strategically located in multiple geographical locations.
CDNs are designed to improve the performance, availability, and scalability of websites and web applications by reducing latency and efficiently delivering content to end users.
A Hanami project can serve assets via a Content Delivery Network (CDN).
```ruby
module MyApp
class App < Hanami::App
config.assets.base_url = "https://123.cloudfront.net"
end
end
```
From now on, helpers will return the absolute URL for the asset, hosted on the CDN specified.
```erb
<%= javascript 'application' %>
```
```html
```
```erb
<%= assets.js "app" %>
```
```html
```
NOTE: We suggest to use SRI mode when using CDN.
## Development
Install:
* Node
* NPM
```bash
$ npm install
$ bundle exec rake test
```
## Versioning
__Hanami::Assets__ uses [Semantic Versioning 2.0.0](http://semver.org)
## Contributing
1. Fork it (https://github.com/hanami/assets/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Copyright
Copyright © 2014–2024 Hanami Team – Released under MIT License