rails-design-profiles 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/README.md +34 -44
  4. data/lib/rails_design_profiles/version.rb +1 -1
  5. metadata +10 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f94b1e0af567ce077819a716dc34eb34462542a7bf251cdbb287376fcc7ee3e6
4
- data.tar.gz: 9c96463447b584330e2e09d95da375b5c96ddc3fad795536a936feb2d584c5c0
3
+ metadata.gz: 35102d4d67c8c6e6997e184717630a47dee886c0b05ec4d5825ffde6ee8a4456
4
+ data.tar.gz: 197e7dad40346d8611e07b1ecac1c2b7a2f070753b8ebe2597462b9173020c6f
5
5
  SHA512:
6
- metadata.gz: 14674431eac89956035122bc7a4a1941258ca2248b76d2d9bc173df3592defd327c722f7ae517c101cbf5a6f954f9072f2601f9a4fffcc3c9ae97c69741a06d6
7
- data.tar.gz: ca65b17b242bc0805a8dda7f69716ecbb85d30b17e2515ade2ea9223ccc753d844552e0c64103569ee32d8b50c5ec594f83cd4429ae721cd9c729d24bc497a2c
6
+ metadata.gz: 315e1730f84b90721cdc3e93a52e4b21b76d0828061f219c07b3cf4c486e4bbfee439c73f0d4cf0f0fec5151ffeaf29ef420832b887168f4a72ac3a8eb4f04db
7
+ data.tar.gz: ffa2ba27db4345f433e5f4df44524be508e3520e78690721bca14f9f7f5378943ed0fdd9069bcdefdc9c1849f2147267d456ce0e325e55bc7fee65faad3dc078
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.2 - 2026-07-17
4
+
5
+ - Add complete RubyGems metadata for documentation, source code, changelog, and issue tracking.
6
+ - Expand the packaged README with a practical adoption guide and project boundaries.
7
+
3
8
  ## 0.1.1 - 2026-07-17
4
9
 
5
10
  - Refresh project documentation, community materials, GitHub Pages, and CI compatibility.
data/README.md CHANGED
@@ -4,22 +4,27 @@
4
4
  [![RubyGems](https://img.shields.io/gem/v/rails-design-profiles?logo=rubygems&label=RubyGems)](https://rubygems.org/gems/rails-design-profiles)
5
5
  [![License](https://img.shields.io/github/license/paladini/rails-design-profiles)](LICENSE.txt)
6
6
 
7
- **A design reference should influence your Rails UI without becoming an unreviewable theme generator.**
7
+ **Versioned, reviewable design-token profiles for Rails applications.**
8
8
 
9
- `rails-design-profiles` keeps the two jobs separate:
9
+ `rails-design-profiles` gives Rails teams a deliberate bridge between a visual reference and production UI code. Keep a `DESIGN.md` locally for people and AI tools to consult; turn only the choices your team approves into a small, versioned YAML token profile. The gem exposes the active profile as standard CSS custom properties.
10
10
 
11
- 1. `DESIGN.md` gives your AI agent a clear visual reference.
12
- 2. A small YAML profile exposes the tokens your Rails application actually uses.
11
+ It is not a Markdown-to-theme compiler. It does not install someone else's CSS, assets, or brand.
13
12
 
14
- The result is a deliberate CSS-variable contract you can review, version, switch, and evolve with your team.
13
+ ## Why it exists
15
14
 
16
- ## Why this exists
15
+ A design reference can make an agent or contributor more consistent, but Markdown alone cannot safely change an application. Replacing a stylesheet to trial a visual direction is equally hard to review and easy to regret.
17
16
 
18
- AI can read a `DESIGN.md`, but Markdown alone does not change an application. Conversely, replacing an entire stylesheet to try a visual direction is risky and hard to review.
17
+ This gem makes the boundary explicit:
19
18
 
20
- This gem gives Rails applications a narrow bridge between the two: references stay local and explicit; CSS variables are emitted from an active profile; your components decide which tokens to consume.
19
+ | Design reference | Production contract |
20
+ | --- | --- |
21
+ | `DESIGN.md` gives people and AI tools visual context. | `config/design_profiles.yml` contains the tokens your application actually serves. |
22
+ | Imported from a public, openly licensed catalog. | Authored, reviewed, versioned, and owned by your team. |
23
+ | Never executed by the gem. | Rendered as `--rdp-*` CSS custom properties. |
21
24
 
22
- ## Install
25
+ ## Quick start
26
+
27
+ Add the gem and run the installer:
23
28
 
24
29
  ```ruby
25
30
  # Gemfile
@@ -31,13 +36,13 @@ bundle install
31
36
  bin/rails generate rails_design_profiles:install
32
37
  ```
33
38
 
34
- The generator adds a profile file and inserts the helper into `app/views/layouts/application.html.erb`:
39
+ The generator creates `config/design_profiles.yml` and inserts this helper in the application layout's `<head>`:
35
40
 
36
41
  ```erb
37
42
  <%= rails_design_profiles_tags %>
38
43
  ```
39
44
 
40
- Use the resulting variables in your own CSS:
45
+ Use the emitted variables in whichever CSS setup your application already has:
41
46
 
42
47
  ```css
43
48
  body {
@@ -52,9 +57,9 @@ body {
52
57
  }
53
58
  ```
54
59
 
55
- ## The profile contract
60
+ ## Define a profile
56
61
 
57
- `config/design_profiles.yml` is the source of truth for production tokens. Token names become `--rdp-*` CSS variables.
62
+ `config/design_profiles.yml` is the source of truth. The active profile is global to the Rails application and is evaluated for each response.
58
63
 
59
64
  ```yaml
60
65
  active: editorial
@@ -69,61 +74,46 @@ profiles:
69
74
  space-page: "1.5rem"
70
75
  ```
71
76
 
72
- The active profile is global to the app and is resolved for every response. Version 0.1 does not include per-session or query-string overrides.
77
+ Each token becomes a CSS variable with the `rdp` prefix, for example `color-primary` becomes `--rdp-color-primary`. This keeps the contract visible in a diff and avoids silently changing component styles.
73
78
 
74
- ## Bring a public reference into your project
79
+ ## Import a design reference
75
80
 
76
- The v0.1 catalog uses only the MIT-licensed [VoltAgent/awesome-design-md](https://github.com/VoltAgent/awesome-design-md) collection.
81
+ Version 0.1 uses the MIT-licensed [VoltAgent/awesome-design-md](https://github.com/VoltAgent/awesome-design-md) catalog only.
77
82
 
78
83
  ```sh
79
84
  bin/rails design:list
80
85
  bin/rails design:install[claude]
81
86
  ```
82
87
 
83
- Installation stores the reference in `config/design_profiles/references/claude.md` and creates an empty `claude` profile. Read that reference with your agent, choose the tokens that fit your product, and add them deliberately to YAML.
88
+ Installation archives the reference at `config/design_profiles/references/claude.md` and creates an empty `claude` profile. Read the reference, decide which ideas belong in your product, then add your own tokens. Existing references and profiles are never overwritten.
84
89
 
85
- Switch profiles with:
90
+ The gem is not affiliated with getdesign.md, VoltAgent, or any referenced brand.
86
91
 
87
- ```sh
88
- bin/rails design:activate[claude]
89
- ```
92
+ ## Switch profiles
90
93
 
91
- The gem never copies third-party CSS, assets, or branding. It is not affiliated with getdesign.md, VoltAgent, or any referenced brand.
94
+ After reviewing a profile, make it active with one explicit change:
92
95
 
93
- ## How it works
94
-
95
- ```text
96
- DESIGN.md reference ──> team / AI design decisions ──> design_profiles.yml
97
- │
98
- ▼
99
- <style> --rdp-* variables
100
- │
101
- ▼
102
- your Rails components
96
+ ```sh
97
+ bin/rails design:activate[claude]
103
98
  ```
104
99
 
105
- This is intentionally not a Markdown-to-CSS compiler. It preserves human judgment at the point where visual decisions become production code.
100
+ The new application-wide profile takes effect on the next response. Per-session previews and query-string overrides are intentionally outside the first release.
106
101
 
107
102
  ## Compatibility
108
103
 
109
104
  - Ruby 3.1+
110
105
  - Rails 7.1+
111
- - Asset pipeline, Propshaft, Importmap, Tailwind, and custom CSS all work because the output is standard CSS variables.
106
+ - Standard CSS-variable consumers: the asset pipeline, Propshaft, Importmap, Tailwind, and custom CSS
112
107
 
113
- ## Community
108
+ ## Project status and roadmap
114
109
 
115
- - Ask questions and share workflows in [Discussions](https://github.com/paladini/rails-design-profiles/discussions).
116
- - Report reproducible defects or focused feature requests through the issue templates.
117
- - Read [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [SUPPORT.md](SUPPORT.md), and [SECURITY.md](SECURITY.md) before participating.
110
+ The public API is intentionally small while the contract earns real-world use. Planned work includes profile validation and diagnostics, a development preview surface, more openly licensed reference adapters, and community-maintained example Rails applications.
118
111
 
119
- ### Roadmap
112
+ ## Contributing and support
120
113
 
121
- - [ ] Profile validation and diagnostics
122
- - [ ] A profile preview surface for development
123
- - [ ] More import adapters for openly licensed design references
124
- - [ ] Community-maintained example Rails applications
114
+ Contributions are welcome. Start with [CONTRIBUTING.md](CONTRIBUTING.md), follow the [Code of Conduct](CODE_OF_CONDUCT.md), and use [GitHub Discussions](https://github.com/paladini/rails-design-profiles/discussions) for questions and early proposals. Report reproducible defects and focused feature requests through the [issue tracker](https://github.com/paladini/rails-design-profiles/issues). See [SECURITY.md](SECURITY.md) for responsible vulnerability reporting.
125
115
 
126
- ## Development
116
+ To work on the gem locally:
127
117
 
128
118
  ```sh
129
119
  bundle install
data/lib/rails_design_profiles/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RailsDesignProfiles
4
- VERSION = "0.1.1"
4
+ VERSION = "0.1.2"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rails-design-profiles
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fernando Paladini
@@ -37,8 +37,11 @@ dependencies:
37
37
  - - ">="
38
38
  - !ruby/object:Gem::Version
39
39
  version: '7.1'
40
- description: Keep DESIGN.md references alongside executable, reviewable CSS token
41
- profiles in Rails.
40
+ description: Rails Design Profiles keeps public DESIGN.md references separate from
41
+ executable design tokens. Install an openly licensed reference, review it with your
42
+ team or AI tools, and define a versioned YAML token profile. The Rails helper emits
43
+ the active profile as --rdp-* CSS custom properties, and Rails tasks switch the
44
+ application-wide profile without copying third-party CSS, assets, or branding.
42
45
  email:
43
46
  - fnpaladini@gmail.com
44
47
  executables: []
@@ -59,12 +62,14 @@ files:
59
62
  - lib/rails_design_profiles/railtie.rb
60
63
  - lib/rails_design_profiles/version.rb
61
64
  - lib/tasks/rails_design_profiles_tasks.rake
62
- homepage: https://github.com/paladini/rails-design-profiles
65
+ homepage: https://paladini.github.io/rails-design-profiles/
63
66
  licenses:
64
67
  - MIT
65
68
  metadata:
66
69
  source_code_uri: https://github.com/paladini/rails-design-profiles
67
70
  changelog_uri: https://github.com/paladini/rails-design-profiles/blob/main/CHANGELOG.md
71
+ documentation_uri: https://paladini.github.io/rails-design-profiles/
72
+ bug_tracker_uri: https://github.com/paladini/rails-design-profiles/issues
68
73
  rubygems_mfa_required: 'true'
69
74
  rdoc_options: []
70
75
  require_paths:
@@ -82,5 +87,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
87
  requirements: []
83
88
  rubygems_version: 4.0.16
84
89
  specification_version: 4
85
- summary: Versioned, CSS-variable design profiles for Rails applications.
90
+ summary: Reviewable, versioned design-token profiles for Rails applications.
86
91
  test_files: []