deadfire 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570d2b607521baef50439b60e78f17aafcc9a6a53a258c2248967c6308964d27
-  data.tar.gz: ad3dc3a1ff0b925408cf64d73f41d659f7de3fbd2014d6d73ef55829d6246e68
+  metadata.gz: b92ff55d4eb765b9042dad38b321944bacf5334db4d2cfe17aabc8fa6c6fcbf3
+  data.tar.gz: 956b776ba58413cc70e70fe8b98a8392ea7091994127070852323c84ca7b2dcf
 SHA512:
-  metadata.gz: d23aee619e6429b4e3dc964a833f46ba8cba5275aea228d3945a6a240308366e067563a1fea45310a13e69414280f3d831a0e7f298596172f1fd5da44ad67235
-  data.tar.gz: 911f68ad428ed00b46a9062cd96af4ff50fb2459aa2fff1be796fac7651b77e88f0e405c2da8b30d38a8d21a01ae5d0c0ace7daa245deac032e6450747f08c76
+  metadata.gz: 6172c9434d1aeaafe2ff0a45e257ddc022214f5f81895cf3d763327d26e087e5ce50cd0b585a1a3c47cb193f8048c4a14c59ef4d4ca508988a62b6e229ba7409
+  data.tar.gz: eb267997efa8f7a953d9bb7fc385147aefff84684db57f7caa45c21f34cf89776af42c0ba9694e6887b30f894dc50bdb75ab8c98a61ff4343c772f170cfb995c

data/.github/workflows/ci.yml

@@ -6,7 +6,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [head, 3.2, 3.1, 3.0, 2.7]
+        experimental: [false]
+        ruby: [3.3, 3.2, 3.1, 3.0]
+        include:
+          - { ruby: head, experimental: true }
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/data/

data/Gemfile.lock

@@ -1,14 +1,61 @@
 PATH
   remote: .
   specs:
-    deadfire (0.3.0)
+    deadfire (0.5.0)
+      actionpack (>= 7.0.0)
+      activesupport (>= 7.0.0)
+      propshaft (>= 0.9.0)
+      railties (>= 7.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (7.1.3.4)
+      actionview (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3.4)
+      activesupport (= 7.1.3.4)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     ansi (1.5.0)
-    builder (3.2.4)
-    minitest (5.14.3)
+    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)
+    drb (2.2.1)
+    erubi (1.13.0)
+    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)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     minitest-reporters (1.5.0)
@@ -16,8 +63,53 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    mutex_m (0.2.0)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    propshaft (0.9.0)
+      actionpack (>= 7.0.0)
+      activesupport (>= 7.0.0)
+      rack
+      railties (>= 7.0.0)
+    psych (5.1.2)
+      stringio
+    racc (1.8.1)
+    rack (3.1.8)
+    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-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)
+    railties (7.1.3.4)
+      actionpack (= 7.1.3.4)
+      activesupport (= 7.1.3.4)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (12.3.3)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    reline (0.5.9)
+      io-console (~> 0.5)
     ruby-progressbar (1.11.0)
+    stringio (3.1.1)
+    thor (1.3.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webrick (1.9.0)
+    zeitwerk (2.6.16)
 
 PLATFORMS
   ruby
@@ -30,4 +122,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.2.22
+   2.6.1

data/README.md

@@ -50,11 +50,11 @@ Output;
 
 ### @apply
 
-@apply inlines your classes into your custom css.
+The `@apply` directive inlines your classes into your custom CSS, simplifying the process of applying existing styles to a new class.
 
 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.
 
-Let's see an example of how to declare mixins and use the @apply directive.
+Let's take a look at an example of how to use the @apply directive. Note that all utility classes are automatically cached.
 
 ```CSS
 .font-bold: {
@@ -67,7 +67,7 @@ Let's see an example of how to declare mixins and use the @apply directive.
 }
 ```
 
-How can we use mixins? Using @apply...
+Re-use the styles using @apply:
 
 ```CSS
 .btn-blue {
@@ -103,39 +103,14 @@ Or install it yourself as:
 
 ## Deadfire + Ruby on Rails
 
-After adding Deadfire gem to your rails application, open the file `config/initializers/assets.rb` or create a new initializer `config/initializers/deadfire.rb`.
-
-### Propshaft
-
-To setup Propshaft to use Deadfire as a preprocessor:
+Propshaft is the new asset pipeline for Rails, to use Deadfire as a preprocessor add the deadfire gem to your Gemfile.
 
 ```ruby
-# config/initializers/assets.rb
-class DeadfireCompiler < Propshaft::Compiler
-  def compile(logical_path, input)
-    Deadfire.parse(input, root_path: Rails.root.join("app", "assets", "stylesheets"))
-  end
-end
-
-Rails.application.config.assets.compilers << ["text/css", DeadfireCompiler]
+gem "deadfire"
 ```
-### Sprockets
-
-To setup Sprocket to use Deadfire as a 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)
-```
+That's all, your css file should now be run through Deadfire.
 
-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.

data/benchmarks/basic_benchmark.rb

@@ -8,6 +8,7 @@ gemfile(true) do
   gem "sassc"
   gem "deadfire", github: "hahmed/deadfire", branch: "main"
   gem "syntax_tree-css"
+  gem "sass-embedded"
 
   gem "benchmark-ips"
 end
@@ -25,7 +26,7 @@ body {
 }
 
 h1 {
-  font-size: 40px; 
+  font-size: 40px;
 }
 /* Just
 a
@@ -59,21 +60,52 @@ code {
 }
 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("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.report("dart sass")   { Sass.compile_string(css) }
   x.compare!
 end
 
-# FYI
+# May 2024: Re-added dart sass
+# Warming up --------------------------------------
+#             deadfire   172.000 i/100ms
+#                sassc    85.000 i/100ms
+#          sytanx_tree    79.000 i/100ms
+#            dart sass   520.000 i/100ms
+# Calculating -------------------------------------
+#             deadfire      1.680k (± 0.9%) i/s -      8.428k in   5.018094s
+#                sassc    816.292 (± 0.2%) i/s -      4.165k in   5.102378s
+#          sytanx_tree    750.421 (± 1.9%) i/s -      3.792k in   5.054908s
+#            dart sass      5.225k (± 4.7%) i/s -     26.520k in   5.090927s
+
+# Comparison:
+#            dart sass:     5224.7 i/s
+#             deadfire:     1679.7 i/s - 3.11x  slower
+#                sassc:      816.3 i/s - 6.40x  slower
+#          sytanx_tree:      750.4 i/s - 6.96x  slower
+
+# Nov 2023: (Note: removed dart sass because I don't have it installed, need to re-run again)
+# Warming up --------------------------------------
+#             deadfire   116.000  i/100ms
+#                sassc    69.000  i/100ms
+#          sytanx_tree    64.000  i/100ms
+# Calculating -------------------------------------
+#             deadfire      1.164k (± 1.2%) i/s -      5.916k in   5.084777s
+#                sassc    695.721  (± 1.3%) i/s -      3.519k in   5.059025s
+#          sytanx_tree    635.684  (± 3.3%) i/s -      3.200k in   5.040489s
+
+# Comparison:
+#             deadfire:     1163.6 i/s
+#                sassc:      695.7 i/s - 1.67x  slower
+#          sytanx_tree:      635.7 i/s - 1.83x  slower
+
+
+# Sep 2022:
 # Warming up --------------------------------------
 #             dartsass     1.000  i/100ms
 #             deadfire     1.088k i/100ms

data/changelog.md

@@ -1,4 +1,29 @@
 ## Changelog
+### 0.6.0 (current)
+
+### 0.5.0 (12 Dec 2024)
+- Drop ruby 2.7
+- Add a railties to make it real simple to pre-process every file for a simple setup
+- Added the asset registry to make it easier to control how or which file is used as a mixin
+- Excluded files are no longer pro-processed
+- Make rails + propshaft dependencies
+
+### 0.4.0 (18 May 2024)
+- Fix parsing comments that have 2 stars e.g. /**
+- Adds a logger and a default setting that suppresses the logs which can be configured to report errors.
+- Fixes issue with import's not parsing correctly when there is no ending semicolon.
+- Added ci for ruby 3.3
+- Add support for importing .scss files, making it easier to migrate from other libraries.
+```
+@import "nav"
+@import "sidebar.scss"
+.image { padding: 2px; }
+```
+Deadfire will look for the file nav.css, then nav.scss in the `config.root_path` in the case when a file extension is not included.
+
+- Simplify the configuration by having one option called compressed instead of keep_newlines and keep_comments.
+- Add the ability to exclude files from being pre-processed via the `config.deadfire.excluded_files` option.
+
 ### 0.3.0 (15 November 2023)
 
 - Redo the parser by splitting up the tokenizer, parser, interpreter and generator phases which makes each step simpler. It's still faster than sassc but much slower than it was previously which is something I hope to address soon.

data/deadfire.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Deadfire - lightweight css preprocessor"
   spec.homepage      = "https://github.com/hahmed/deadfire"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/hahmed/deadfire"
@@ -23,4 +23,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack", ">= 7.0.0"
+  spec.add_dependency "activesupport", ">= 7.0.0"
+  spec.add_dependency "railties", ">= 7.0.0"
+  spec.add_dependency "propshaft", ">= 0.9.0"
 end

data/lib/deadfire/asset_loader.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Deadfire
+  # AssetLoader is responsible for loading mixin templates from the file system which can be used to mixin css into
+  # your stylesheet.
+  class AssetLoader
+    attr_reader :settings
+
+    def initialize(path)
+      @path = path
+      @cache = ActiveSupport::Cache::FileStore.new("tmp/deadfire_cache")
+    end
+
+    def cache_css(name, value)
+      cached_mixins[name] = value
+    end
+    
+    def cached_css(name)
+      cached_mixins[name]
+    end
+
+    def preload(force_reload=false)
+      if force_reload
+        @_cached_mixins = nil
+      end
+
+      cached_mixins
+    end
+    
+    private
+
+    def cached_mixins
+      @_cached_mixins ||= load_mixins
+    end
+
+    def load_mixins    
+      Array.wrap(Deadfire.configuration.asset_registry.mixins_for(@path)).each.with_object({}) do |filename, data|
+        unless File.exist?(filename)
+          Deadfire.config.logger.error("Mixin not found: #{filename}")
+          next
+        end
+
+        stat = File.stat(filename)
+        key = "#{filename}-#{stat.mtime.hash}"
+
+        content = @cache.fetch(key)
+
+        if content.nil?
+          content = load_and_parse_mixin(filename, key)
+        end
+
+        content.each do |key, value|
+          Deadfire.config.logger.warn("Mixin '#{key}' will be overrided with a new value.") if data.key?(key)
+
+          data[key] = value
+        end
+      end
+    end
+
+    def load_and_parse_mixin(filename, key)
+      content = File.read(filename)
+      mixins = ParserEngine.new(content).load_mixins
+      @cache.write(key, mixins)
+      mixins
+    end
+  end
+end

data/lib/deadfire/asset_registry.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Deadfire
+  class AssetRegistry
+    attr_reader :settings
+
+    def initialize
+      @settings = Hash.new { |h, k| h[k] = [] }
+    end
+
+    # for a given path, load all the mixins that are registered
+    # this makes it possible to load admin or other scoped mixins for a 
+    # specific path
+    def register_path(path, *mixins)
+      normalized_mixins = Array.wrap(mixins).map { |p| full_path(p) }
+      normalize_path = strip_path(path).to_s
+      @settings[normalize_path].concat(normalized_mixins)
+    end
+
+    # for a given path, load all the mixins that are registered
+    # e.g. admin/ or admin will load all mixins for admin, if admin is a scope
+    # all mixins for admin/* will be loaded
+    def mixins_for(path)
+      return [] unless path.present?
+
+      mixins = []
+
+      mixins.concat Array.wrap(@settings[path])
+
+      if settings["*"].present?
+        mixins.concat Array.wrap(settings["*"])
+      end
+
+      scope = scope_from_path(path)
+
+      if scope.present? && settings[scope].present?
+        mixins.concat Array.wrap(settings[scope])
+      end
+
+      mixins.compact.uniq
+    end
+
+    def clear
+      @settings.clear
+    end
+
+    private
+
+    def full_path(filename)
+      if File.exist?(filename)
+        filename
+      else
+        normalize_path(filename)
+      end
+    end
+
+    def normalize_path(filename)
+      path = File.join(Deadfire.config.root_path, filename)
+      path = css_extension(path)
+
+      unless File.exist?(path)
+        raise "Error finding asset path #{path}"
+      end
+
+      path
+    end
+
+    def css_extension(filename)
+      filename.end_with?(".css") ? filename : "#{filename}.css"
+    end
+
+    def scope?(path)
+      path.include?("/")
+    end
+
+    def scope_from_path(path)
+      if scope?(path)
+        path.split("/")[0...-1].join("/")
+      else
+        nil
+      end
+    end
+
+    def strip_path(path)
+      path.split("/").last
+    end
+  end
+end

data/lib/deadfire/ast_printer.rb

@@ -13,7 +13,7 @@ module Deadfire
     def visit_stylesheet_node(node)
       puts "StylesheetNode"
       node.statements.each do |statement|
-        # something
+        # todo
       end
     end
 
@@ -54,5 +54,10 @@ module Deadfire
       puts "CommentNode"
       puts "  Comment: #{node.comment.lexeme}"
     end
+
+    def visit_newline_node(node)
+      puts "NewlineNode"
+      puts "  Newline: #{node.text}"
+    end
   end
 end

data/lib/deadfire/configuration.rb

@@ -1,29 +1,47 @@
 # frozen_string_literal: true
+require "logger"
 
 module Deadfire
   class Configuration
-    attr_reader :directories, :root_path, :keep_comments, :keep_whitespace
+    attr_reader :directories, :root_path, :compressed, :logger, :supressed, :excluded_files, :asset_registry
 
     def initialize
       @directories = []
       @root_path = ""
-      @keep_comments = true
-      @keep_whitespace = true
+      @compressed = false
+      @logger = Logger.new(STDOUT, level: :warn)
+      @supressed = true
+      @excluded_files = []
+      @asset_registry = AssetRegistry.new
     end
 
     def root_path=(value)
+      return if value.nil?
+
       unless Dir.exist?(value)
         raise DirectoryNotFoundError.new("Root not found #{value}")
       end
       @root_path = value
     end
 
-    def keep_comments=(value)
-      @keep_comments = value
+    def compressed=(value)
+      @compressed = value unless value.nil?
+    end
+
+    def logger=(value)
+      @logger = value
+    end
+
+    def supressed=(value)
+      @supressed = value
+    end
+
+    def excluded_files=(value)
+      @excluded_files = value
     end
 
-    def keep_whitespace=(value)
-      @keep_whitespace = value
+    def preprocess(*mixins, path: "*")
+      @asset_registry.register_path(path, *mixins)
     end
   end
 end

data/lib/deadfire/css_generator.rb

@@ -1,4 +1,4 @@
-# Frozen_string_literal: true
+# frozen_string_literal: true
 require "stringio"
 
 module Deadfire
@@ -19,7 +19,6 @@ module Deadfire
 
     def visit_at_rule_node(node)
       @output << node.at_keyword.lexeme
-      @output << " "
       node.value.each do |value|
         @output << value.lexeme
       end
@@ -60,7 +59,7 @@ module Deadfire
     end
 
     def visit_comment_node(node)
-      @output << node.comment.lexeme if Deadfire.configuration.keep_comments
+      @output << node.comment.lexeme unless Deadfire.configuration.compressed
     end
   end
 end

data/lib/deadfire/error_reporter.rb

@@ -9,7 +9,9 @@ module Deadfire
     end
 
     def error(line, message)
-      @errors << Error.new(line, message)
+      error = Error.new(line, message)
+      Deadfire.configuration.logger.error(error.to_s) unless Deadfire.configuration.supressed
+      @errors << error
     end
 
     def errors?
@@ -19,6 +21,10 @@ module Deadfire
     private
 
     # create error struct with line and message
-    Error = Struct.new(:line, :message)
+    Error = Struct.new(:line, :message) do
+      def to_s
+        "Line #{line}: #{message}"
+      end
+    end
   end
 end

data/lib/deadfire/errors.rb

@@ -2,7 +2,6 @@
 
 module Deadfire
   class DirectoryNotFoundError < StandardError; end
-  class Error < StandardError; end
 
   class DuplicateImportException < StandardError
     def initialize(filename = "", lineno = "")
@@ -27,44 +26,4 @@ module Deadfire
       super(msg)
     end
   end
-
-  class EarlyApplyException < StandardError
-    def initialize(input = "", lineno = "")
-      msg = if input
-        "Error with input: `#{input}` line: #{lineno}"
-      else
-        "Apply called too early in css. There are no mixins defined."
-      end
-
-      super(msg)
-    end
-  end
-
-  class SyntaxError < StandardError
-    def initialize(message = "", lineno = "", original_line = "")
-      msg = if message
-        "#{original_line}\nline: #{lineno}: #{message}"
-      else
-        "Syntax "
-      end
-
-      super(msg)
-    end
-  end
-
-  class ErrorsList
-    attr_reader :errors
-
-    def initialize
-      @errors = []
-    end
-
-    def add(message:, lineno:, original_line:)
-      @errors << SyntaxError.new(message, lineno, original_line)
-    end
-
-    def empty?
-      @errors.empty?
-    end
-  end
-end
+end