railsui 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a466784ed0945d81364c3e9190820fd7ed195938a7761eaf324d7f18a65e81
+  data.tar.gz: 0e61cef3e2e0942456500150b57a243aa5e37ff986b0f993663255147ee54bd5
+SHA512:
+  metadata.gz: d8775c8dc245c22ff3fd010ec96cf66091227709442c03f0f0ee2ab97a7e19979aac699ef679bd0ca32c45d2add5552590f84de21a5edb6a517f03485f2bc740
+  data.tar.gz: 7c9c94b8ac2304e2b5babf7b663326549dcd592eb9bbfc6fa6b193a4cd051f76bb4f047de42c865ababf5f2ad970a0082e46bcb99aa546212900cfad82226b87

data/.nvmrc

@@ -0,0 +1 @@
+v18.16.0

data/.standard.yml

@@ -0,0 +1,3 @@
+ignore:
+  - "**/*":
+    - Style/HashSyntax

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [1.0.0] - 2023-03-29
+
+- Initial release
+
+## [1.0.1] - 2023-05-23
+
+Removes cssbundling-rails and jsbundling-rails gems from being gem dependencies. We bring necessary logic under the hood and reduce errors during install.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in railsui.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.3"
+gem "stimulus-rails"
+gem "cssbundling-rails"
+gem "railsui_icon"

data/Gemfile.lock

@@ -0,0 +1,254 @@
+PATH
+  remote: .
+  specs:
+    railsui (3.1.0)
+      meta-tags
+      psych
+      rails (>= 7.0)
+      railsui_icon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.1)
+      actionpack (= 7.2.1)
+      activejob (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
+      mail (>= 2.8.0)
+    actionmailer (7.2.1)
+      actionpack (= 7.2.1)
+      actionview (= 7.2.1)
+      activejob (= 7.2.1)
+      activesupport (= 7.2.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.1)
+      actionview (= 7.2.1)
+      activesupport (= 7.2.1)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4, < 3.2)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (7.2.1)
+      actionpack (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.2.1)
+      activesupport (= 7.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.1)
+      activesupport (= 7.2.1)
+      globalid (>= 0.3.6)
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activerecord (7.2.1)
+      activemodel (= 7.2.1)
+      activesupport (= 7.2.1)
+      timeout (>= 0.4.0)
+    activestorage (7.2.1)
+      actionpack (= 7.2.1)
+      activejob (= 7.2.1)
+      activerecord (= 7.2.1)
+      activesupport (= 7.2.1)
+      marcel (~> 1.0)
+    activesupport (7.2.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    cssbundling-rails (1.4.1)
+      railties (>= 6.0.0)
+    date (3.3.4)
+    drb (2.2.1)
+    erubi (1.13.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    logger (1.6.1)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    meta-tags (2.22.0)
+      actionpack (>= 6.0.0, < 8.1)
+    mini_mime (1.1.5)
+    minitest (5.25.1)
+    net-imap (0.4.16)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.0)
+      net-protocol
+    nio4r (2.7.3)
+    nokogiri (1.18.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.2-x86_64-linux-gnu)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.4.2)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rack (3.1.7)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.2.1)
+      actioncable (= 7.2.1)
+      actionmailbox (= 7.2.1)
+      actionmailer (= 7.2.1)
+      actionpack (= 7.2.1)
+      actiontext (= 7.2.1)
+      actionview (= 7.2.1)
+      activejob (= 7.2.1)
+      activemodel (= 7.2.1)
+      activerecord (= 7.2.1)
+      activestorage (= 7.2.1)
+      activesupport (= 7.2.1)
+      bundler (>= 1.15.0)
+      railties (= 7.2.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railsui_icon (1.1.0)
+      rails (>= 5.2)
+    railties (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.10)
+      io-console (~> 0.5)
+    rexml (3.3.5)
+      strscan
+    rubocop (1.65.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
+    standard (1.40.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.65.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    stimulus-rails (1.3.4)
+      railties (>= 6.0.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.2)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    useragent (0.16.10)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  arm64-darwin-23
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  cssbundling-rails
+  minitest (~> 5.0)
+  railsui!
+  railsui_icon
+  rake (~> 13.0)
+  standard (~> 1.3)
+  stimulus-rails
+
+BUNDLED WITH
+   2.5.11

data/LICENSE.md

@@ -0,0 +1,122 @@
+# Personal License
+
+Rails UI grants you an on-going, non-exclusive license to use the Components and Templates.
+
+The license grants permission to one individual (the Licensee) to access and use the Components and Templates.
+
+## You can:
+
+- Use the Components and Templates to create unlimited End Products.
+- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
+- Use the Components and Templates to create unlimited End Products for unlimited Clients.
+- Use the Components and Templates to create End Products where the End Product is sold to End Users.
+- Use the Components and Templates to create End Products that are open source and freely available to End Users.
+
+## You cannot:
+
+- Use the Components and Templates to create End Products that are designed to allow an End User to build their own End Products using the Components and Templates or derivatives of the Components and Templates.
+- Re-distribute the Components and Templates or derivatives of the Components and Templates separately from an End Product, neither in code or as design assets.
+- Share your access to the Components and Templates with any other individuals.
+- Use the Components and Templates to produce anything that may be deemed by Rails UI, in their sole and absolute discretion, to be competitive or in conflict with the business of Rails UI.
+
+## Example usage
+
+Examples of usage allowed by the license:
+
+- Creating a personal application by yourself.
+- Creating a website or web application for a client that will be owned by that client.
+- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application.
+- Creating a commercial self-hosted web application that is sold to end users for a one-time fee.
+- Creating a web application where the primary purpose is clearly not to simply re-distribute the components (like a conference organization app that uses the components for its UI for example) that is free and open source, where the source code is publicly available.
+
+Examples of usage not allowed by the license:
+
+- Creating a repository of your favorite Rails UI UI components or templates (or derivatives based on Rails UI UI components or templates) and publishing it publicly.
+- Creating a new version of Rails UI for other frameworks and making it available either for sale or for free.
+- Create a Figma or Sketch UI kit based on the Rails UI component designs.
+- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Rails UI.
+- Creating a theme, template, or project starter kit using the components or templates and making it available either for sale or for free.
+- Creating an admin panel tool (like Laravel Nova or ActiveAdmin) that is made available either for sale or for free.
+
+### Personal License Definitions
+
+Licensee is the individual who has purchased a Personal License.
+
+Components and Templates are the source code and design assets made available to the Licensee after purchasing a Rails UI UI license.
+
+End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.
+
+End User is a user of an End Product.
+
+Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.
+
+Team License
+Rails UI grants you an on-going, non-exclusive license to use the Components and Templates.
+
+The license grants permission for up to 25 Employees and Contractors of the Licensee to access and use the Components and Templates.
+
+## You can:
+
+- Use the Components and Templates to create unlimited End Products.
+- Modify the Components and Templates to create derivative components and templates. Those components and templates are subject to this license.
+- Use the Components and Templates to create unlimited End Products for unlimited Clients.
+- Use the Components and Templates to create End Products where the End Product is sold to End Users.
+- Use the Components and Templates to create End Products that are open source and freely available to End Users.
+
+## You cannot:
+
+- Use the Components or Templates to create End Products that are designed to allow an End User to build their own End Products using the Components or Templates or derivatives of the Components or Templates.
+- Re-distribute the Components or Templates or derivatives of the Components or Templates separately from an End Product.
+- Use the Components or Templates to create End Products that are the property of any individual or entity other than the Licensee or Clients of the Licensee.
+- Use the Components or Templates to produce anything that may be deemed by Rails UI, in their sole and absolute discretion, to be competitive or in conflict with the business of Rails UI.
+
+## Example usage
+
+Examples of usage allowed by the license:
+
+- Creating a website for your company
+- Creating a website or web application for a client that will be owned by that client
+- Creating a commercial SaaS application (like an invoicing app for example) where end users have to pay a fee to use the application
+- Creating a commercial self-hosted web application that is sold to end users for a one-time fee
+- Creating a web application where the primary purpose is clearly not to simply re-distribute the components or templates (like a conference organization app that uses the components or a template for its UI for example) that is free and open source, where the source code is publicly available
+
+Examples of use not allowed by the license:
+
+- Creating a repository of your favorite Rails UI components or template (or derivatives based on Rails UI UI components or templates) and publishing it publicly
+- Using Rails UI to create another version for another framework be it frontend or backend and making it available either for sale or for free
+- Creating a "website builder" project where end users can build their own websites using components or templates included with or derived from Rails UI UI
+- Creating a theme or template using the components or templates and making it available either for sale or for free
+- Creating an admin panel tool (like Laravel Nova or ActiveAdmin) that is made available either for sale or for free
+- Creating any End Product that is not the sole property of either your company or a client of your company. For example your employees/contractors can't use your company Rails UI license to build their own websites or side projects.
+
+### Team License Definitions
+
+Licensee is the business entity who has purchased a Team License.
+
+Components and Templates are the source code and design assets made available to the Licensee after purchasing a Rails UI UI license.
+
+End Product is any artifact produced that incorporates the Components or Templates or derivatives of the Components or Templates.
+
+End User is a user of an End Product.
+
+Employee is a full-time or part-time employee of the Licensee.
+
+Contractor is an individual or business entity contracted to perform services for the Licensee.
+
+Client is an individual or entity receiving custom professional services directly from the Licensee, produced specifically for that individual or entity. Customers of software-as-a-service products are not considered clients for the purpose of this document.
+
+### Enforcement
+
+If you are found to be in violation of the license, access to your Rails UI account will be terminated, and a refund may be issued at our discretion. When license violation is blatant and malicious (such as intentionally redistributing the Components or Templates through private channels), no refund will be issued.
+
+The copyright of the Components and Templates is owned by Rails UI. You are granted only the permissions described in this license; all other rights are reserved. Rails UI reserves the right to pursue legal remedies for any unauthorized use of the Components or Templates outside the scope of this license.
+
+## Liability
+
+Rails UI’s liability to you for costs, damages, or other losses arising from your use of the Components or Templates — including third-party claims against you — is limited to a refund of your license fee. Rails UI may not be held liable for any consequential damages related to your use of the Components or Templates.
+
+## Questions?
+
+Unsure of something?
+
+[Email us](mailto:railsui@justalever.com) with your questions.

data/Procfile.dev

@@ -0,0 +1 @@
+js: yarn build:js --watch

data/README.md

@@ -0,0 +1,165 @@
+![Rails UI Docs](https://f001.backblazeb2.com/file/railsui/docs/rui-docs-header.png)
+
+# Rails UI
+
+Professionally designed themes and components for Ruby on Rails. Leverage breath-taking UI to fast-track your next idea.
+
+### Links
+
+- [Website](https://railsui.com)
+- [Documentation](https://railsui.com/docs)
+- [FAQs](https://railsui.com/docs/faqs)
+- [Discussions](https://github.com/getrailsui/railsui/discussions)
+- [Updates](https://railsui.com/updates)
+- [Follow on X](https://x.com/railsui_)
+- [Migrating from v2](https://railsui.com/docs/updates)
+
+## Installation
+
+You must already have node and yarn installed on your system. You will also need npx version 7.1.0 or later. A solid understanding of Tailwind CSS will go far.
+
+### New applications
+
+The easiest install is on new Rails apps with options passed like so. For new apps, use the `-c tailwind` flag to install it.
+
+```bash
+rails new app_name -c tailwind -j esbuild
+```
+
+It's recommended to use the `-j` flag to one of the bundling solutions from the [`jsbundling-rails`](https://github.com/rails/jsbundling-rails) gem (bun, esbuild rollup, webpack) for max compatibility.
+
+Support for [importmaps](https://github.com/rails/importmap-rails) or [propshaft](https://github.com/rails/propshaft) is untested at this time.
+
+### Existing applications
+
+#### CSS
+
+For an existing app you need to first install Tailwind if you haven't. If you are using another CSS framework, like Bootstrap, remove that first for best results.
+
+```bash
+./bin/bundle add cssbundling-rails
+./bin/rails css:install:tailwind
+```
+
+Note: There are several ways to approach adding Tailwind CSS support. We find the easiest way is using [cssbundling-rails](https://github.com/rails/cssbundling-rails) gem for max control. If you were to scaffold a new rails application, this gem is the one used when passing `-c` or `-css`.
+
+Adding Tailwind CSS to an existing app _may_ result in CSS class name conflicts. We've done our best to make it integrate with your existing setup but there's always a chance.
+
+#### JavaScript
+
+Rails UI works best combined with the [jsbundling-rails](https://github.com/rails/jsbundling-rails) gem.
+
+When ready, install jsbundling-rails using the gem and the installer task. Choose the build tool you prefer.
+
+```bash
+./bin/bundle add jsbundling-rails
+./bin/rails javascript:install:[bun|esbuild|rollup|webpack]
+```
+
+Most of the JavaScript used in Rails UI is based on Stimulus.js. This code can likely work fine alongside something like importmaps or propshaft but we have not tested this theory just yet.
+
+## Installation
+
+Add the `railsui` gem to your Gemfile.
+
+```ruby
+# Gemfile
+gem "railsui"
+```
+
+Run the bundle install command to fetch the new gem and its assets.
+
+```bash
+bundle install
+```
+
+The gem includes several tasks and generators. Run the `install` task to kick things off.
+
+This task is responsible for setting the foundation for Rails UI, which includes assets, themes, theme-driven pages, and more.
+
+The default theme for Rails UI is [Hound](https://railsui.com/themes/hound). It will install when you install Rails UI. You can change it any time.
+
+```bash
+rails railsui:install
+```
+
+After installing Rails UI, run your server using the `bin/dev` command and proceed to the configuration screen to customize your install (i.e. `localhost:3000/railsui` for new apps).
+
+## Configuration
+
+Configuration is a simple process where you configure your app's details (app name, support email), brand colors, and theme.
+
+Each theme comes with different pages and are designed for different niches in mind. They reside in the `app/views/rui` directory once installed and should be treated as read-only.
+
+**Updating your configuration at anytime will overwrite the pages and theme assets so if you want to keep your changes, you'll need to copy the files to your application in another directory.**
+
+### Rake tasks
+
+- `railsui:install` - Install Rails UI.
+- `railsui:colors[theme]` - Pass a theme name to output default color palette or don't pass an argument to show active colors.
+- `railsui:pages` - List all pages for the active theme.
+- `railsui:pages[theme]` - List all pages for a theme name as passed.
+
+## Themes
+
+Themes are the core of Rails UI, combining UI components, pages, assets, JavaScript, and color palettes to help you create a professionally designed, niche application. The UI can adapt based on how you implement it.
+
+Themes serve as a starting point for your app, with reusable components extracted for flexibility. These components are ready for use inside your application when you install Rails UI.
+
+### Pages
+
+A page is a professionaly designed starting point. They are completely optional to use and can save a lot of time if your app uses similar layouts and patterns.
+
+Pages are located in the `app/views/rui` directory and are considered read-only. If you want to keep your changes after modifying your Rails UI configuration and saving changes, you'll need to copy the files to your application in another view directory.
+
+More pages will be added over time.
+
+### Included assets
+
+Each theme comes with a collection of assets to help you get started. Much of these are placeholders and are not meant to be used in production. We strive to still create realistic examples for you to use as a starting point.
+
+### UI components
+
+After installing Rails UI and choosing a theme you'll find a collection of components and best practices for real-world applications at your disposal.
+
+### Color
+
+Each theme comes with a custom color palette built on top of the default Tailwind CSS color palette. We've added two new colors for you to use in your app using Tailwind CSS classes called `primary` and `secondary`. You can change those colors any time in your railui.yml config file or in the configuration form.
+
+Run `rails railsui:colors` to see your active colors or `rails "railsui:colors[theme]"` to see the default colors for a given theme.
+
+### Icons
+
+Bundled with Rails UI is a gem called [railsui_icon](https://github.com/getrailsui/railsui_icon). This gem includes a collection of icons that are used in all themes. Right now it's based soley on [heroicons](https://heroicons.com) and will be expanded to include more icons in the future.
+
+### JavaScript
+
+All Rails UI components are built on top of Stimulus.js. A theme includes custom Stimulus controllers and our own JavaScript library called [railsui-stimulus](https://github.com/getrailsui/railsui-stimulus) which is just an extraction of components we find ourselves using in our own apps and between themes.
+
+## Updates
+
+Run `bundle update railsui` from within your project and it should fetch the most recent version of the gem/engine directly from GitHub.
+
+### Legacy v2
+
+Version 2 of Rails UI has since been sunset. Unfortunately, there is no upgrade path we can share.
+
+Version 3 was a rewrite of the gem and how Rails UI works to enable better flexibility. Version 3 offers the ability to swap themes, install on new and existing rails apps, and countless other smaller features. We chose this direction to enable more efficient development in the future and allow folks with existing apps the ability to use Rails UI.
+
+You can find version 2 on a dedicated branch on the Github repo. If you're an active user of this version be sure to update your Gemfile with the appropriate branch.
+
+```ruby
+gem "railsui", github: "getrailsui/railsui", branch: "v2"
+```
+
+### v3+
+
+Version 3 resides on the main branch accessbile via the main branch and/or rubygems.org.
+
+```ruby
+gem "railsui"
+```
+
+## Frequently Asked Questions
+
+[Read FAQs here](https://railsui.com/docs/faqs).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]