deadfire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b22d5497d512927d87bb9f0d4166b055281e8c684188b14b2c03b4052256fe0
+  data.tar.gz: c50413354b6e0504777d2111bf83a9f5e39a97f64f2fa14b292fd0277128f7be
+SHA512:
+  metadata.gz: 922f9283b553c8c6f92d4e8de65362f1d75b29e028b5a18ab3444e2727cbc09295c176ec5b0359d879dd11a5f942e626ab9256d1cb2f4c0f39c9c13200aca06f
+  data.tar.gz: 1bb7bbae48bd1e170c036ad176d3f0dd22b5546b87b2ec874f1fa9d0820b1ba23c7cdd2096caac8673be42d32be4e14063ae44d79d7fc66134d670b41ccc56e7

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [head, 3, 2.7]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "minitest"
+gem "minitest-focus"
+gem "minitest-reporters"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    deadfire (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    minitest (5.14.3)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (12.3.3)
+    ruby-progressbar (1.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deadfire!
+  minitest
+  minitest-focus
+  minitest-reporters
+  rake
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Haroon Ahmed
+
+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.

data/README.md

@@ -0,0 +1,159 @@
+# Deadfire
+
+A lightweight CSS preprocessor.
+
+Use plain ol' CSS with a little bit of @import, @apply and nestings.
+
+CSS is a staple technology when building web applications. With the introduction of LESS, SASS, SCSS it made CSS easier to maintain. However, most of these tools are no longer supported, maintained or have far too many features (wait... that's a bad thing?).
+
+Deadfire sprinkles a few extra features which helps you write CSS, easier.
+
+Deadfire can be used with or without a CSS framework.
+
+## Features
+
+- [x] @import
+- [x] [@apply](https://tabatkins.github.io/specs/css-apply-rule/)
+- [x] [nesting](https://drafts.csswg.org/css-nesting-1)
+
+### @import
+
+Imports allow you to easily include a file from the file system into your current css document.
+
+```CSS
+/* shared/buttons.css */
+.button {
+  color: red;
+  text-align: center;
+}
+
+/* application.css */
+@import "shared/buttons.css";
+
+.page-title {
+  font-size: 20px;
+}
+```
+
+Output;
+
+```CSS
+/* application.css */
+.button {
+  color: red;
+  text-align: center;
+}
+
+.page-title {
+  font-size: 20px;
+}
+```
+
+### @apply
+
+@apply inlines your classes into your custom css.
+
+The CSS apply rule was [proposed to be included into CSS](https://tabatkins.github.io/specs/css-apply-rule/) however it was abandoned. Mixins simplify applying existing css to a new class.
+
+All mixins must be declared on the `:root` element or preloaded via the `Deadfire.mixins` method. Using a mixin before it's declared will raise an `EarlyApplyException`. Ideally the `:root` element should appear near the top of the document.
+
+Let's see an example of how to declare mixins and use the @apply directive.
+
+```CSS
+:root {
+  --font-bold: {
+    font-weight: bold;
+  }
+
+  --btn: {
+    padding-bottom: 10px;
+    text-align: center;
+  }
+}
+```
+
+How can we use mixins? Using @apply...
+
+```CSS
+.btn-blue {
+  @apply --btn --font-bold;
+}
+
+.homepage-hero {
+  @apply --font-bold;
+}
+```
+
+### nesting
+
+Nesting adds the ability to nest one style rule inside another.
+
+NOTE: This feature is still a work in progress.
+
+```CSS
+/* & can be used on its own */
+.btn {
+  color: blue;
+  & > .homepage { color: red; }
+}
+```
+
+This is expanded to:
+
+```CSS
+.btn { color: blue; }
+.btn > .homepage { color: red; }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deadfire'
+```
+
+And then execute:
+
+  `> bundle install`
+
+Or install it yourself as:
+
+  `> gem install deadfire`
+
+## Deadfire + Ruby on Rails
+
+After adding Deadfire gem to your rails application, open the file `config/initializers/assets.rb` to setup your Sprocket and the asset pipeline to use the new preprocessor.
+
+```ruby
+# config/initializers/assets.rb
+class DeadfireProcessor
+  def call(input)
+    return { data: Deadfire.parse(input[:data]) }
+  end
+end
+
+Deadfire.configuration.root_path = Rails.root.join('app', 'assets', 'stylesheets')
+Sprockets.register_preprocessor('text/css', DeadfireProcessor.new)
+```
+
+Your css file should now be run through Deadfire.
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To run the tests, run `bin/test`.
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hahmed/deadfire. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hahmed/deadfire/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Deadfire project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hahmed/deadfire/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/benchmarks/basic_benchmark.rb

@@ -0,0 +1,89 @@
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "sassc"
+  gem "deadfire", github: "hahmed/deadfire", branch: "main"
+  gem "syntax_tree-css"
+
+  gem "benchmark-ips"
+end
+
+css = <<~CSS
+
+body {
+  font-family: helvetica, arial, sans-serif;
+  font-size: calc(1.3em + 0.5vw);
+  line-height: 1;
+  margin: 0;
+  padding: 0;
+  color: #1d2d35;
+  background-color:#ffefef;
+}
+
+h1 {
+  font-size: 40px; 
+}
+
+a {
+  font-size: 1em;
+  vertical-align: baseline;
+  background: transparent;
+  margin: 0;
+  padding: 0;
+  color: inherit;
+  transition: all 0.2s ease;
+  transition-property: text-decoration-color, text-decoration-thickness, text-decoration-width;
+  text-decoration-thickness: 0.1em;
+  text-decoration-width: 0.1rem
+}
+
+.button--block {
+  min-width:100% !important
+}
+
+code {
+  font-family: Roboto Mono;
+  font-size: 12px;
+  color: gray;
+}
+
+.banner {
+  border: 1px solid #ccc;
+}
+CSS
+
+def dartsass
+  system "sass benchmarks/input.scss output.css", exception: true
+end
+
+Benchmark.ips do |x|
+  x.config(:time => 5, :warmup => 2)
+
+  x.report("dartsass") { dartsass }
+  x.report("deadfire")    { Deadfire.parse(css) }
+  x.report("sassc")       { SassC::Engine.new(css).render }
+  x.report("sytanx_tree") { SyntaxTree::CSS.parse(css) }
+  x.compare!
+end
+
+# FYI
+# Warming up --------------------------------------
+#             dartsass     1.000  i/100ms
+#             deadfire     1.088k i/100ms
+#                sassc    27.000  i/100ms
+#          sytanx_tree    19.000  i/100ms
+# Calculating -------------------------------------
+#             dartsass      6.605  (± 0.0%) i/s -     33.000  in   5.005992s
+#             deadfire     11.507k (± 3.6%) i/s -     57.664k in   5.017772s
+#                sassc    308.909  (± 6.2%) i/s -      1.539k in   5.002165s
+#          sytanx_tree    210.732  (± 9.0%) i/s -      1.045k in   5.005951s
+
+# Comparison:
+#             deadfire:    11507.3 i/s
+#                sassc:      308.9 i/s - 37.25x  (± 0.00) slower
+#          sytanx_tree:      210.7 i/s - 54.61x  (± 0.00) slower
+#             dartsass:        6.6 i/s - 1742.19x  (± 0.00) slower

data/benchmarks/input.scss

@@ -0,0 +1,40 @@
+body {
+  font-family: helvetica, arial, sans-serif;
+  font-size: calc(1.3em + 0.5vw);
+  line-height: 1;
+  margin: 0;
+  padding: 0;
+  color: #1d2d35;
+  background-color:#ffefef;
+}
+
+h1 {
+  font-size: 40px; 
+}
+
+a {
+  font-size: 1em;
+  vertical-align: baseline;
+  background: transparent;
+  margin: 0;
+  padding: 0;
+  color: inherit;
+  transition: all 0.2s ease;
+  transition-property: text-decoration-color, text-decoration-thickness, text-decoration-width;
+  text-decoration-thickness: 0.1em;
+  text-decoration-width: 0.1rem
+}
+
+.button--block {
+  min-width:100% !important
+}
+
+code {
+  font-family: Roboto Mono;
+  font-size: 12px;
+  color: gray;
+}
+
+.banner {
+  border: 1px solid #ccc;
+}

data/benchmarks/output.css

@@ -0,0 +1,42 @@
+body {
+  font-family: helvetica, arial, sans-serif;
+  font-size: calc(1.3em + 0.5vw);
+  line-height: 1;
+  margin: 0;
+  padding: 0;
+  color: #1d2d35;
+  background-color: #ffefef;
+}
+
+h1 {
+  font-size: 40px;
+}
+
+a {
+  font-size: 1em;
+  vertical-align: baseline;
+  background: transparent;
+  margin: 0;
+  padding: 0;
+  color: inherit;
+  transition: all 0.2s ease;
+  transition-property: text-decoration-color, text-decoration-thickness, text-decoration-width;
+  text-decoration-thickness: 0.1em;
+  text-decoration-width: 0.1rem;
+}
+
+.button--block {
+  min-width: 100% !important;
+}
+
+code {
+  font-family: Roboto Mono;
+  font-size: 12px;
+  color: gray;
+}
+
+.banner {
+  border: 1px solid #ccc;
+}
+
+/*# sourceMappingURL=output.css.map */

data/benchmarks/output.css.map

@@ -0,0 +1 @@
+{"version":3,"sourceRoot":"","sources":["input.scss"],"names":[],"mappings":"AAAA;EACE;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;;;AAGF;EACE;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;;AAGF;EACE;;;AAGF;EACE;EACA;EACA;;;AAGF;EACE","file":"output.css"}

data/benchmarks/profilng.rb

@@ -0,0 +1,25 @@
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem "sassc"
+  gem "deadfire", github: "hahmed/deadfire", branch: "main"
+  gem 'heap-profiler'
+end
+
+css = <<~OUTPUT
+h1 {
+  font-size: 40px; }
+  h1 code {
+    font-face: Roboto Mono; }
+OUTPUT
+
+require 'heap-profiler'
+
+HeapProfiler.report("benchmarks") do
+  Deadfire.parse(css)
+  # SassC::Engine.new(css).render
+end