clairity.css 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/LICENSE.txt ADDED
@@ -0,0 +1,373 @@
1
+ Mozilla Public License Version 2.0
2
+ ==================================
3
+
4
+ 1. Definitions
5
+ --------------
6
+
7
+ 1.1. "Contributor"
8
+ means each individual or legal entity that creates, contributes to
9
+ the creation of, or owns Covered Software.
10
+
11
+ 1.2. "Contributor Version"
12
+ means the combination of the Contributions of others (if any) used
13
+ by a Contributor and that particular Contributor's Contribution.
14
+
15
+ 1.3. "Contribution"
16
+ means Covered Software of a particular Contributor.
17
+
18
+ 1.4. "Covered Software"
19
+ means Source Code Form to which the initial Contributor has attached
20
+ the notice in Exhibit A, the Executable Form of such Source Code
21
+ Form, and Modifications of such Source Code Form, in each case
22
+ including portions thereof.
23
+
24
+ 1.5. "Incompatible With Secondary Licenses"
25
+ means
26
+
27
+ (a) that the initial Contributor has attached the notice described
28
+ in Exhibit B to the Covered Software; or
29
+
30
+ (b) that the Covered Software was made available under the terms of
31
+ version 1.1 or earlier of the License, but not also under the
32
+ terms of a Secondary License.
33
+
34
+ 1.6. "Executable Form"
35
+ means any form of the work other than Source Code Form.
36
+
37
+ 1.7. "Larger Work"
38
+ means a work that combines Covered Software with other material, in
39
+ a separate file or files, that is not Covered Software.
40
+
41
+ 1.8. "License"
42
+ means this document.
43
+
44
+ 1.9. "Licensable"
45
+ means having the right to grant, to the maximum extent possible,
46
+ whether at the time of the initial grant or subsequently, any and
47
+ all of the rights conveyed by this License.
48
+
49
+ 1.10. "Modifications"
50
+ means any of the following:
51
+
52
+ (a) any file in Source Code Form that results from an addition to,
53
+ deletion from, or modification of the contents of Covered
54
+ Software; or
55
+
56
+ (b) any new file in Source Code Form that contains any Covered
57
+ Software.
58
+
59
+ 1.11. "Patent Claims" of a Contributor
60
+ means any patent claim(s), including without limitation, method,
61
+ process, and apparatus claims, in any patent Licensable by such
62
+ Contributor that would be infringed, but for the grant of the
63
+ License, by the making, using, selling, offering for sale, having
64
+ made, import, or transfer of either its Contributions or its
65
+ Contributor Version.
66
+
67
+ 1.12. "Secondary License"
68
+ means either the GNU General Public License, Version 2.0, the GNU
69
+ Lesser General Public License, Version 2.1, the GNU Affero General
70
+ Public License, Version 3.0, or any later versions of those
71
+ licenses.
72
+
73
+ 1.13. "Source Code Form"
74
+ means the form of the work preferred for making modifications.
75
+
76
+ 1.14. "You" (or "Your")
77
+ means an individual or a legal entity exercising rights under this
78
+ License. For legal entities, "You" includes any entity that
79
+ controls, is controlled by, or is under common control with You. For
80
+ purposes of this definition, "control" means (a) the power, direct
81
+ or indirect, to cause the direction or management of such entity,
82
+ whether by contract or otherwise, or (b) ownership of more than
83
+ fifty percent (50%) of the outstanding shares or beneficial
84
+ ownership of such entity.
85
+
86
+ 2. License Grants and Conditions
87
+ --------------------------------
88
+
89
+ 2.1. Grants
90
+
91
+ Each Contributor hereby grants You a world-wide, royalty-free,
92
+ non-exclusive license:
93
+
94
+ (a) under intellectual property rights (other than patent or trademark)
95
+ Licensable by such Contributor to use, reproduce, make available,
96
+ modify, display, perform, distribute, and otherwise exploit its
97
+ Contributions, either on an unmodified basis, with Modifications, or
98
+ as part of a Larger Work; and
99
+
100
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
101
+ for sale, have made, import, and otherwise transfer either its
102
+ Contributions or its Contributor Version.
103
+
104
+ 2.2. Effective Date
105
+
106
+ The licenses granted in Section 2.1 with respect to any Contribution
107
+ become effective for each Contribution on the date the Contributor first
108
+ distributes such Contribution.
109
+
110
+ 2.3. Limitations on Grant Scope
111
+
112
+ The licenses granted in this Section 2 are the only rights granted under
113
+ this License. No additional rights or licenses will be implied from the
114
+ distribution or licensing of Covered Software under this License.
115
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
116
+ Contributor:
117
+
118
+ (a) for any code that a Contributor has removed from Covered Software;
119
+ or
120
+
121
+ (b) for infringements caused by: (i) Your and any other third party's
122
+ modifications of Covered Software, or (ii) the combination of its
123
+ Contributions with other software (except as part of its Contributor
124
+ Version); or
125
+
126
+ (c) under Patent Claims infringed by Covered Software in the absence of
127
+ its Contributions.
128
+
129
+ This License does not grant any rights in the trademarks, service marks,
130
+ or logos of any Contributor (except as may be necessary to comply with
131
+ the notice requirements in Section 3.4).
132
+
133
+ 2.4. Subsequent Licenses
134
+
135
+ No Contributor makes additional grants as a result of Your choice to
136
+ distribute the Covered Software under a subsequent version of this
137
+ License (see Section 10.2) or under the terms of a Secondary License (if
138
+ permitted under the terms of Section 3.3).
139
+
140
+ 2.5. Representation
141
+
142
+ Each Contributor represents that the Contributor believes its
143
+ Contributions are its original creation(s) or it has sufficient rights
144
+ to grant the rights to its Contributions conveyed by this License.
145
+
146
+ 2.6. Fair Use
147
+
148
+ This License is not intended to limit any rights You have under
149
+ applicable copyright doctrines of fair use, fair dealing, or other
150
+ equivalents.
151
+
152
+ 2.7. Conditions
153
+
154
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
155
+ in Section 2.1.
156
+
157
+ 3. Responsibilities
158
+ -------------------
159
+
160
+ 3.1. Distribution of Source Form
161
+
162
+ All distribution of Covered Software in Source Code Form, including any
163
+ Modifications that You create or to which You contribute, must be under
164
+ the terms of this License. You must inform recipients that the Source
165
+ Code Form of the Covered Software is governed by the terms of this
166
+ License, and how they can obtain a copy of this License. You may not
167
+ attempt to alter or restrict the recipients' rights in the Source Code
168
+ Form.
169
+
170
+ 3.2. Distribution of Executable Form
171
+
172
+ If You distribute Covered Software in Executable Form then:
173
+
174
+ (a) such Covered Software must also be made available in Source Code
175
+ Form, as described in Section 3.1, and You must inform recipients of
176
+ the Executable Form how they can obtain a copy of such Source Code
177
+ Form by reasonable means in a timely manner, at a charge no more
178
+ than the cost of distribution to the recipient; and
179
+
180
+ (b) You may distribute such Executable Form under the terms of this
181
+ License, or sublicense it under different terms, provided that the
182
+ license for the Executable Form does not attempt to limit or alter
183
+ the recipients' rights in the Source Code Form under this License.
184
+
185
+ 3.3. Distribution of a Larger Work
186
+
187
+ You may create and distribute a Larger Work under terms of Your choice,
188
+ provided that You also comply with the requirements of this License for
189
+ the Covered Software. If the Larger Work is a combination of Covered
190
+ Software with a work governed by one or more Secondary Licenses, and the
191
+ Covered Software is not Incompatible With Secondary Licenses, this
192
+ License permits You to additionally distribute such Covered Software
193
+ under the terms of such Secondary License(s), so that the recipient of
194
+ the Larger Work may, at their option, further distribute the Covered
195
+ Software under the terms of either this License or such Secondary
196
+ License(s).
197
+
198
+ 3.4. Notices
199
+
200
+ You may not remove or alter the substance of any license notices
201
+ (including copyright notices, patent notices, disclaimers of warranty,
202
+ or limitations of liability) contained within the Source Code Form of
203
+ the Covered Software, except that You may alter any license notices to
204
+ the extent required to remedy known factual inaccuracies.
205
+
206
+ 3.5. Application of Additional Terms
207
+
208
+ You may choose to offer, and to charge a fee for, warranty, support,
209
+ indemnity or liability obligations to one or more recipients of Covered
210
+ Software. However, You may do so only on Your own behalf, and not on
211
+ behalf of any Contributor. You must make it absolutely clear that any
212
+ such warranty, support, indemnity, or liability obligation is offered by
213
+ You alone, and You hereby agree to indemnify every Contributor for any
214
+ liability incurred by such Contributor as a result of warranty, support,
215
+ indemnity or liability terms You offer. You may include additional
216
+ disclaimers of warranty and limitations of liability specific to any
217
+ jurisdiction.
218
+
219
+ 4. Inability to Comply Due to Statute or Regulation
220
+ ---------------------------------------------------
221
+
222
+ If it is impossible for You to comply with any of the terms of this
223
+ License with respect to some or all of the Covered Software due to
224
+ statute, judicial order, or regulation then You must: (a) comply with
225
+ the terms of this License to the maximum extent possible; and (b)
226
+ describe the limitations and the code they affect. Such description must
227
+ be placed in a text file included with all distributions of the Covered
228
+ Software under this License. Except to the extent prohibited by statute
229
+ or regulation, such description must be sufficiently detailed for a
230
+ recipient of ordinary skill to be able to understand it.
231
+
232
+ 5. Termination
233
+ --------------
234
+
235
+ 5.1. The rights granted under this License will terminate automatically
236
+ if You fail to comply with any of its terms. However, if You become
237
+ compliant, then the rights granted under this License from a particular
238
+ Contributor are reinstated (a) provisionally, unless and until such
239
+ Contributor explicitly and finally terminates Your grants, and (b) on an
240
+ ongoing basis, if such Contributor fails to notify You of the
241
+ non-compliance by some reasonable means prior to 60 days after You have
242
+ come back into compliance. Moreover, Your grants from a particular
243
+ Contributor are reinstated on an ongoing basis if such Contributor
244
+ notifies You of the non-compliance by some reasonable means, this is the
245
+ first time You have received notice of non-compliance with this License
246
+ from such Contributor, and You become compliant prior to 30 days after
247
+ Your receipt of the notice.
248
+
249
+ 5.2. If You initiate litigation against any entity by asserting a patent
250
+ infringement claim (excluding declaratory judgment actions,
251
+ counter-claims, and cross-claims) alleging that a Contributor Version
252
+ directly or indirectly infringes any patent, then the rights granted to
253
+ You by any and all Contributors for the Covered Software under Section
254
+ 2.1 of this License shall terminate.
255
+
256
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
257
+ end user license agreements (excluding distributors and resellers) which
258
+ have been validly granted by You or Your distributors under this License
259
+ prior to termination shall survive termination.
260
+
261
+ ************************************************************************
262
+ * *
263
+ * 6. Disclaimer of Warranty *
264
+ * ------------------------- *
265
+ * *
266
+ * Covered Software is provided under this License on an "as is" *
267
+ * basis, without warranty of any kind, either expressed, implied, or *
268
+ * statutory, including, without limitation, warranties that the *
269
+ * Covered Software is free of defects, merchantable, fit for a *
270
+ * particular purpose or non-infringing. The entire risk as to the *
271
+ * quality and performance of the Covered Software is with You. *
272
+ * Should any Covered Software prove defective in any respect, You *
273
+ * (not any Contributor) assume the cost of any necessary servicing, *
274
+ * repair, or correction. This disclaimer of warranty constitutes an *
275
+ * essential part of this License. No use of any Covered Software is *
276
+ * authorized under this License except under this disclaimer. *
277
+ * *
278
+ ************************************************************************
279
+
280
+ ************************************************************************
281
+ * *
282
+ * 7. Limitation of Liability *
283
+ * -------------------------- *
284
+ * *
285
+ * Under no circumstances and under no legal theory, whether tort *
286
+ * (including negligence), contract, or otherwise, shall any *
287
+ * Contributor, or anyone who distributes Covered Software as *
288
+ * permitted above, be liable to You for any direct, indirect, *
289
+ * special, incidental, or consequential damages of any character *
290
+ * including, without limitation, damages for lost profits, loss of *
291
+ * goodwill, work stoppage, computer failure or malfunction, or any *
292
+ * and all other commercial damages or losses, even if such party *
293
+ * shall have been informed of the possibility of such damages. This *
294
+ * limitation of liability shall not apply to liability for death or *
295
+ * personal injury resulting from such party's negligence to the *
296
+ * extent applicable law prohibits such limitation. Some *
297
+ * jurisdictions do not allow the exclusion or limitation of *
298
+ * incidental or consequential damages, so this exclusion and *
299
+ * limitation may not apply to You. *
300
+ * *
301
+ ************************************************************************
302
+
303
+ 8. Litigation
304
+ -------------
305
+
306
+ Any litigation relating to this License may be brought only in the
307
+ courts of a jurisdiction where the defendant maintains its principal
308
+ place of business and such litigation shall be governed by laws of that
309
+ jurisdiction, without reference to its conflict-of-law provisions.
310
+ Nothing in this Section shall prevent a party's ability to bring
311
+ cross-claims or counter-claims.
312
+
313
+ 9. Miscellaneous
314
+ ----------------
315
+
316
+ This License represents the complete agreement concerning the subject
317
+ matter hereof. If any provision of this License is held to be
318
+ unenforceable, such provision shall be reformed only to the extent
319
+ necessary to make it enforceable. Any law or regulation which provides
320
+ that the language of a contract shall be construed against the drafter
321
+ shall not be used to construe this License against a Contributor.
322
+
323
+ 10. Versions of the License
324
+ ---------------------------
325
+
326
+ 10.1. New Versions
327
+
328
+ Mozilla Foundation is the license steward. Except as provided in Section
329
+ 10.3, no one other than the license steward has the right to modify or
330
+ publish new versions of this License. Each version will be given a
331
+ distinguishing version number.
332
+
333
+ 10.2. Effect of New Versions
334
+
335
+ You may distribute the Covered Software under the terms of the version
336
+ of the License under which You originally received the Covered Software,
337
+ or under the terms of any subsequent version published by the license
338
+ steward.
339
+
340
+ 10.3. Modified Versions
341
+
342
+ If you create software not governed by this License, and you want to
343
+ create a new license for such software, you may create and use a
344
+ modified version of this License if you rename the license and remove
345
+ any references to the name of the license steward (except to note that
346
+ such modified license differs from this License).
347
+
348
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
349
+ Licenses
350
+
351
+ If You choose to distribute Source Code Form that is Incompatible With
352
+ Secondary Licenses under the terms of this version of the License, the
353
+ notice described in Exhibit B of this License must be attached.
354
+
355
+ Exhibit A - Source Code Form License Notice
356
+ -------------------------------------------
357
+
358
+ This Source Code Form is subject to the terms of the Mozilla Public
359
+ License, v. 2.0. If a copy of the MPL was not distributed with this
360
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
361
+
362
+ If it is not possible or desirable to put the notice in a particular
363
+ file, then You may include the notice in a location (such as a LICENSE
364
+ file in a relevant directory) where a recipient would be likely to look
365
+ for such a notice.
366
+
367
+ You may add additional accurate notices of copyright ownership.
368
+
369
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
370
+ ---------------------------------------------------------
371
+
372
+ This Source Code Form is "Incompatible With Secondary Licenses", as
373
+ defined by the Mozilla Public License, v. 2.0.
data/README.md ADDED
@@ -0,0 +1,170 @@
1
+ # <samp class="clairity">clairity.css</samp> - An HTML-first CSS framework
2
+
3
+ <samp class="clairity">clairity.css</samp> is a responsive, semantic, classless CSS framework, with ambitions to grow into a complete (classful) design system one day. It's inspired by almond.css, sakura.css, normalize.css, Semantic UI, and others.
4
+
5
+ The core issue <samp class="clairity">clairity.css</samp> addresses is making HTML simple *and* approachable. We've tried all the big CSS frameworks and all of them fail to present **simple HTML** as a first approach. We're not dogmatic about classless CSS or anything like that, but we'd sure as heck like to start with classless CSS first & then get fancier as needs dictate.
6
+
7
+ <samp class="clairity">clairity.css</samp> was developed as an experiment to see how far the latest css features and semantic html can take you without the excess tooling of modern front-end development (like sass, less, postcss, node, yarn, webpack, react and *all* that jazz). While the first version of <samp class="clairity">clairity.css</samp> is being released as a gem (for rails[^irony]), it's not rails-specific at all. The `lib/assets/css` directory in the gem can be taken and placed in any site's public-facing static assets directory and function *without* any installation procedure at all. Just include a css `<link>` to it in the `<head>` of any page (or page template).
8
+
9
+ [^irony]: the irony of initially releasing <samp class="clairity">clairity.css</samp> for an asset pipeline is not lost here, but to be fair, it was used on a jekyll static site first.
10
+
11
+
12
+ ## Alpha-quality gem
13
+
14
+ <samp class="clairity">clairity.css</samp> is currently a super bare-bones gem that narrowly provides framework assets to a rails app (in `lib/assets` for now, because it was created for a related rails project), with the goal to expand to at least [jekyll](https://www.sitepoint.com/jekyll-rails/) and perhaps further, like [how `bootstrap-rubygem` does](https://github.com/twbs/bootstrap-rubygem/blob/main/lib/bootstrap.rb).
15
+
16
+ The <samp class="clairity">clairity.css</samp> gem depends on rails autoloading assets and has only been tested using the Sprockets asset pipeline so far.
17
+
18
+ The **big caveat** here is that we use `css` and `js` rather than `stylesheets` and `javascript` (or `javascripts`, but we're using rails 7.0+) in our asset paths, which is a non-standard configuration for rails, but is perfectly in accordance with many static site generators. This non-standard config (for rails) is implicitly hard-coded into the <samp class="clairity">clairity.css</samp> gem, with plans to make it configurable in the future (or perhaps we can just symlink it?).
19
+
20
+
21
+ ## Installation
22
+
23
+ Install the gem and add to the application's `Gemfile` by executing:
24
+
25
+ $ bundle add clairity.css
26
+
27
+ or just add this line to your `Gemfile` manually and `bundle install` afterwards:
28
+
29
+ gem "clairity.css"
30
+
31
+ If bundler is not being used to manage dependencies, install the gem by executing:
32
+
33
+ $ gem install clairity.css
34
+
35
+
36
+ ## Usage
37
+ As noted in the intro, <samp class="clairity">clairity.css</samp> has been released as a rails gem first, but can easily be used outside of rails (for static sites, for example) by putting the css assets in a place your site can reference it publicly.
38
+
39
+
40
+ ### For rails
41
+
42
+ Once the gem is installed, require <samp class="clairity">clairity.css</samp> in your rails app's `application.css`. You can `@import` one of these three alternatives (or for firefox, set one as the primary, and the other two as [alternate stylesheets](https://developer.mozilla.org/en-US/docs/Web/CSS/Alternative_style_sheets)):
43
+
44
+ 1. `clairity.basic.css` - include only the custom properties (css variables) and element styles of `clairity/variables.css` and `clairity/base.css`
45
+ 1. `clairity.classless.css` - beyond the basics above, this alternative includes the default color palette and other classless styles (`clairity/palette.css`, `clairity/cosmetic.css`, and `clairity/states.css`)
46
+ 1. `clairity.css` - this is the full-fat version that includes everything, including helpful classes and component definitions
47
+
48
+ ```css
49
+ /*
50
+ * app/assets/css/application.css
51
+ *
52
+ * (we prefer 'css' over 'stylesheets' in our asset paths)
53
+ *
54
+ * This is a manifest file that'll be compiled into application.css, which will
55
+ * include all the files listed below.
56
+ *
57
+ * clairity.css lives in the css root of lib, `lib/assets/css`, and thus can be
58
+ * imported directly here. Put it before your `require_self` directive if you
59
+ * wish to extend those styles here
60
+ *
61
+ *# require_tree .
62
+ *= require clairity.css
63
+ *# require_self
64
+ */
65
+
66
+ @import "clairity.css";
67
+ /* to get basic plus the palette, use two @import statements:
68
+ @import "clairity.basic.css";
69
+ @import "clairity/palette.css";
70
+ */
71
+
72
+ ```
73
+
74
+ The `clairity.css` file, along with it's siblings `clairity.basic.css` and `clairity.classless.css`, are entrypoint files, designed to relieve you of having to worry about importing the individual components of the <samp class="clairity">clairity.css</samp> framework yourself. You just need to `<link>` or `@import` one of these in your app, depending on your needs and preferences. You can also write your own entrypoint file that includes the individual component files yourself, and not use one of these three predefined entrypoints.
75
+
76
+ Note that rails handles setting paths for, and autoloading, these files from our gem (because our gem is a rails engine), so we don't need to worry about prefixing any paths here.
77
+
78
+ There is one `js` file that can optionally be included (it's more of a placeholder than a necessary component):
79
+
80
+ ```js
81
+ // app/js/application.js (we prefer 'js' over 'javascript' in our asset paths)
82
+ //
83
+ //= require clairity.css.js
84
+
85
+ import "@hotwired/turbo-rails"
86
+ import "controllers"
87
+
88
+ ```
89
+
90
+ Here we use a Sprockets directive to import `clairity.css.js` directly into the app (Sprockets will package `clairity.css.js` into `application.js` at asset compile time). Note that this is the (otherwise default) rails 7.0+ version of `application.js` so yours may look a little different.
91
+
92
+
93
+ ### Non-rails usage
94
+ Outside of rails, you just need to place the `clairity.css` and the `clairity` folder in a place that publicly accessible to the site/app. For instance, for a jekyll site, this might look like:
95
+
96
+ ```html
97
+ <!-- /_includes/head.html (subsequently to be included in a layout) -->
98
+ <head>
99
+
100
+ ...
101
+
102
+ <link rel="stylesheet" href="/assets/css/clairity.css" title="clairity.css">
103
+ <link rel="alternate stylesheet" href="/assets/css/clairity.basic.css" title="basic clairity">
104
+ <link rel="alternate stylesheet" href="/assets/css/clairity.classless.css" title="classless clairity">
105
+
106
+ ...
107
+
108
+ </head>
109
+ ```
110
+
111
+ where the contents of `/lib/assets/css/` in the gem was placed in the `/assets/css/` directory of the jekyll site (a similar procedure would expose our `clairity.css.js` file to a site/app).
112
+
113
+
114
+ ## Previewing <samp class="clairity">clairity.css</samp>
115
+
116
+ (TODO: put spec sheet online and link it here)
117
+
118
+ For a quick and dirty (and totally insecure) way of previewing <samp class="clairity">clairity.css</samp>, download (or clone the gem repo locally) and unpack the gem (`gem unpack clairity.css-X.Y.Z.gem`), and from within the gem directory, run a (single-line invocation) ruby web server[^webrick]:
119
+
120
+ $ ruby -run -e httpd public -p 8000
121
+
122
+ You can then navigate to `http://localhost:8000/clairity.html` to view the spec sheet. Note that this exposes everything in the `/public` root directory, as well as the `lib/assets` directory (via a symlink), to retrieval in any browser on the local network, not just your own machine, so don't put anything sensitive in there (for instance, email addresses can be harvested, or worse, by unscrupulous actors).
123
+
124
+ [^webrick]: [WEBrick](https://github.com/ruby/webrick) is no longer included as a bundled gem [as of ruby 3.0](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/), but is a dependency for the `ruby httpd` server, so install via `gem install webrick` if need be
125
+
126
+
127
+ ## Development
128
+
129
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment (but being an asset-only gem, there's not much to experiment with in ruby!).
130
+
131
+ To install this gem onto your local machine, run `bundle exec rake install`.
132
+
133
+ To release a new version (for gem owners), follow the release checklist in the next section (i.e., don't `rake release` yet, until we have everything set up the way we like it).
134
+
135
+
136
+ ### Release Checklist
137
+
138
+ To release this gem, follow these steps:
139
+
140
+ 0. make sure the git user/email, git credentials, and rubygems `~/.gem/credentials` are all set correctly to be able to push to github and rubygems (only gem owners can push to rubygems).
141
+ 1. run the test suite via `rake test` and fix any issues
142
+ 1. update the docs (haha, are there any docs yet?)
143
+ 1. make sure the `CHANGELOG.md` is up to date with a summary of the changes since the last release
144
+ 1. choose a version number `X.Y.Z` for the new release based on the magnitude of the changes and in accordance with semantic versioning (replace `X.Y.Z` with the actual version number here, and below, obviously)
145
+ 1. update the version number `X.Y.Z` in `lib/clairity.css/version.rb`
146
+ 1. update the `s.files` array in `clairity.css.gemspec` with any new files outside the main gem directories (such as `lib`)
147
+ 1. build the gem with `gem build clairity.css.gemspec`, which will place it in the `pkg` directory (might have to manually move it to the `pkg` directory)
148
+ 1. (optional) confirm the gem contents by unpacking it with `gem unpack clairity.css-X.Y.Z.gem` in the `pkg` directory (and delete the resultant `clairity.css-X.Y.Z` folder when finished)
149
+ 1. `git commit -m "with a descriptive commit message here"`
150
+ 1. tag the newly-created commit with an annotated tag `git tag vX.Y.Z -am "summary of the tag"` (calling `git tag` without a commit hash tags the last commit)
151
+ 1. push the commit *with annotated tags* to github: `git push --follow-tags` (check that git remote points to `origin` at `clairity/clairity.css` with `git remote -v`)
152
+ 1. push the gem to rubygems: `gem push clairity.css-X.Y.Z.gem`
153
+
154
+
155
+ ### Contributing
156
+
157
+ Bug reports and pull requests are welcome [on GitHub](https://github.com/clairity/clairity.css).
158
+
159
+
160
+ ### Helpful References
161
+
162
+ Being my first gem, as simple as it is, this endeavor required a little research into how to package everything together properly. Besides the [rubygems](https://guides.rubygems.org/make-your-own-gem/) and [bundler](https://bundler.io/guides/creating_gem.html) docs on creating (and [releasing](https://guides.rubygems.org/publishing/)) gems, the two posts were helpful in getting everything working:
163
+
164
+ 1. [Develop Your Own Gem and Gemify Your Own Assets Using Rails Engine](https://geekhmer.github.io/blog/2015/01/02/develop-your-own-gem-and-gemify-your-own-assets-using-rails-engine/) by Bunlong Van (1/2/2015)
165
+ 2. [Gemify Assets for Rails](https://www.prioritized.net/blog/gemify-assets-for-rails) by Derek Prior (1/11/2012)
166
+
167
+
168
+ ## License
169
+
170
+ The gem is available as open source under the terms of the [MPL-2.0 License](https://opensource.org/license/mpl-2-0/).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rake/testtask"
5
+
6
+ Rake::TestTask.new(:test) do |t|
7
+ t.libs << "test"
8
+ t.libs << "lib"
9
+ t.test_files = FileList["test/**/test_*.rb"]
10
+ end
11
+
12
+ task default: :test
data/bin/console ADDED
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "bundler/setup"
5
+ require "clairity.css"
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ require "irb"
11
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+ require_relative "lib/clairity.css/version"
3
+
4
+ Gem::Specification.new do |s|
5
+ s.name = "clairity.css"
6
+ s.version = ClairityCss::VERSION
7
+ s.authors = ["clairity"]
8
+ s.email = ["clairity@users.noreply.github.com"]
9
+
10
+ s.summary = "clairity.css is a simple, semantic classless
11
+ CSS framework and future HTML-first design system."
12
+ s.description = "clairity.css is a responsive, semantic, classless CSS
13
+ framework, with ambitions to grow into a complete (classful)
14
+ design system one day. It's loosely inspired by almond.css,
15
+ sakura.css, Semantic UI, and others."
16
+ s.homepage = "https://css.clairity.blog/"
17
+ # MPL is a little more restrictive than APL or MIT; we can relax this later if
18
+ # it makes sense to do so
19
+ s.license = 'MPL-2.0'
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ s.files = Dir.chdir(File.expand_path(__dir__)) do
23
+ Dir["{.github,bin,lib,sig,test}/**/*"] +
24
+ [".gitignore", "clairity.css.gemspec", "Gemfile", "Rakefile"] +
25
+ ["README.md", "CHANGELOG.md", "LICENSE.txt"]
26
+ end
27
+
28
+ # our ruby dependency is very basic, so allow any still-supported ruby
29
+ s.required_ruby_version = ">= 2.7.0"
30
+
31
+ s.metadata["allowed_push_host"] = "https://rubygems.org"
32
+ s.metadata["homepage_uri"] = s.homepage
33
+ s.metadata["source_code_uri"] = "https://github.com/clairity/clairity.css"
34
+ s.metadata["changelog_uri"] = "https://github.com/clairity/clairity.css/CHANGELOG.md"
35
+
36
+ # s.require_paths = ["lib"]
37
+ # s.bindir = "exe"
38
+ # s.executables = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
39
+
40
+ # rails engines are railties; not sure exactly what we need from it other than
41
+ # perhaps initializing assets for the parent app
42
+ s.add_dependency "railties"
43
+ # s.add_dependency "rails"
44
+
45
+ # `gem install clairity.css --dev` will get these dev deps installed too
46
+ s.add_development_dependency "rake", "~> 13.0"
47
+ s.add_development_dependency "minitest", "~> 5.0"
48
+
49
+ # For more information and examples about making a new gem, check out our
50
+ # guide at: https://bundler.io/guides/creating_gem.html
51
+ end