deadfire 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570d2b607521baef50439b60e78f17aafcc9a6a53a258c2248967c6308964d27
-  data.tar.gz: ad3dc3a1ff0b925408cf64d73f41d659f7de3fbd2014d6d73ef55829d6246e68
+  metadata.gz: 82f838eee7d8e2ef83b302d7de509c428af8584567892296fd3011df42cb0990
+  data.tar.gz: 1a4b828032eda5dae38d3da5f820081402f7e66f919b2720ff8f9be65d6d8bf0
 SHA512:
-  metadata.gz: d23aee619e6429b4e3dc964a833f46ba8cba5275aea228d3945a6a240308366e067563a1fea45310a13e69414280f3d831a0e7f298596172f1fd5da44ad67235
-  data.tar.gz: 911f68ad428ed00b46a9062cd96af4ff50fb2459aa2fff1be796fac7651b77e88f0e405c2da8b30d38a8d21a01ae5d0c0ace7daa245deac032e6450747f08c76
+  metadata.gz: a724bdb7b939e5b4404ee5cee4266ad6c278ac5d4e7fc74f560884f4b30fc123c3492a52abd5028adbc9f579dd690beb26d0de2460e8cb3b8e482d44ce77e733
+  data.tar.gz: e353841bfb20e25ff0ff1556d555443546783a744cf96b2a2149862cf8dbebb31bb9c48f50d68f20355ea036c36e22ca4ac9f059413df500974f4888849673bd

data/.github/workflows/ci.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deadfire (0.3.0)
+    deadfire (0.4.0)
 
 GEM
   remote: https://rubygems.org/

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 {
@@ -79,6 +79,31 @@ How can we use mixins? Using @apply...
 }
 ```
 
+### Nesting
+
+The CSS nesting feature, as described in the CSS Nesting specification (https://drafts.csswg.org/css-nesting/), allows for more intuitive and concise styling by enabling the nesting of CSS rules within one another. This feature simplifies the structure of stylesheets and improves readability.
+
+Now that nesting has been upstreamed to CSS, meaning it is now a part of the official CSS specification. As a result, Deafire will leverage the native CSS nesting feature instead of implementing this feature (which was the original goal of this project).
+
+Example:
+
+```css
+.foo {
+  color: green;
+}
+.foo .bar {
+  font-size: 1.4rem;
+}
+
+/* can be simplified to  */
+.foo {
+  color: green;
+  .bar {
+    font-size: 1.4rem;
+  }
+}
+```
+
 ### Fault tolerant
 
 When Deadfire encounters an error, such as a missing mixin or other issues, it does not immediately raise an error that would halt the execution. Instead, it continues processing the CSS code and collects the encountered errors. These errors are then reported through the ErrorReporter class, allowing you to handle or display them as needed.

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,21 @@
 ## Changelog
+### 0.5.0 (current)
+
+### 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.
+
 ### 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/lib/deadfire/configuration.rb

@@ -1,29 +1,37 @@
 # 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
 
     def initialize
       @directories = []
       @root_path = ""
-      @keep_comments = true
-      @keep_whitespace = true
+      @compressed = false
+      @logger = Logger.new(STDOUT, level: :warn)
+      @supressed = true
     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 keep_whitespace=(value)
-      @keep_whitespace = value
+    def supressed=(value)
+      @supressed = value
     end
   end
 end

data/lib/deadfire/css_generator.rb

@@ -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

data/lib/deadfire/filename_helper.rb

@@ -5,18 +5,16 @@ module Deadfire
     class << self
       def resolve_import_path(line, lineno = 0)
         path = normalize_path(line)
-        unless path.end_with?(Parser::CSS_FILE_EXTENSION)
-          path += Parser::CSS_FILE_EXTENSION
-        end
-        import_path = File.join(Deadfire.configuration.root_path, path)
-  
-        unless File.exist?(import_path)
-          raise Deadfire::ImportException.new(import_path, lineno)
+        potential = potential_path(path)
+        ext = File.extname(path)
+
+        if ext && valid_file?(potential)
+          potential
+        else
+          possible_paths(path)
         end
-  
-        import_path
       end
-      
+
       def normalize_path(line)
         path = line.split.last
         path.gsub!("\"", "")
@@ -24,6 +22,28 @@ module Deadfire
         path.gsub!(";", "")
         path
       end
+
+      private
+
+      def valid_file_extension?(ext)
+        Deadfire::PERMISSIBLE_FILE_EXTENSIONS.include?(ext)
+      end
+
+      def valid_file?(path)
+        File.exist?(path)
+      end
+
+      def possible_paths(path)
+        Deadfire::PERMISSIBLE_FILE_EXTENSIONS.each do |ext|
+          option = File.join(Deadfire.configuration.root_path, path + ext)
+          return option if valid_file?(option)
+        end
+        nil
+      end
+
+      def potential_path(path)
+        File.join(Deadfire.configuration.root_path, path)
+      end
     end
   end
 end

data/lib/deadfire/front_end/apply_node.rb

@@ -5,7 +5,6 @@ module Deadfire
     attr_reader :node, :mixin_names
 
     def initialize(node, mixin_names)
-      # TODO: mixin name can be single or multiple names, separated by a comma
       @node = node
       @mixin_names = fetch_mixin_name_from(mixin_names)
     end

data/lib/deadfire/front_end/parser.rb

@@ -13,19 +13,13 @@ module Deadfire
       end
 
       def parse
-        # top level it's a list of statements
-        # statements are either rules or at-rules
-        # rules are selectors + declarations
-        # at-rules are at-keyword + block
-        # block is a list of declarations?
-        # declarations are property + value
         while !is_at_end?
           if check(:comment)
             comment = add_comment
-            @stylesheet << comment if Deadfire.configuration.keep_comments
+            @stylesheet << comment unless Deadfire.configuration.compressed
           elsif check(:newline)
             newline = add_newline
-            @stylesheet << newline if Deadfire.configuration.keep_whitespace
+            @stylesheet << newline unless Deadfire.configuration.compressed
           elsif matches_at_rule?
             @stylesheet << at_rule_declaration
           else
@@ -111,7 +105,11 @@ module Deadfire
       def ruleset_declaration
         values = []
         while !match?(:left_brace)
-          values << advance
+          unless match?(:comment)
+            values << advance
+          else
+            values << advance unless Deadfire.configuration.compressed
+          end
         end
 
         selector = SelectorNode.new(values[0..-1])
@@ -142,14 +140,16 @@ module Deadfire
 
         if previous.type == :semicolon
           if keyword.lexeme == "@apply"
-            return ApplyNode.new(keyword, values)
+            ApplyNode.new(keyword, values)
           else
             values << previous # add the semicolon to the values
-            return AtRuleNode.new(keyword, values, nil)
+            AtRuleNode.new(keyword, values, nil)
           end
+        elsif is_at_end?
+          AtRuleNode.new(keyword, values, nil)
+        else
+          AtRuleNode.new(keyword, values[0..-1], parse_block) # remove the left brace, because it's not a value, but part of the block
         end
-
-        AtRuleNode.new(keyword, values[0..-1], parse_block) # remove the left brace, because it's not a value, but part of the block
       end
     end
   end

data/lib/deadfire/front_end/scanner.rb

@@ -75,26 +75,15 @@ module Deadfire
       end
 
       def add_at_rule(literal = nil)
-        selector = [current_char]
-
-        while Spec::CSS_AT_RULES.none? { |kwrd| kwrd == selector.join + peek } && !at_end?
-          break if peek == NEWLINE
-          selector << advance
-        end
-
-        # final char in at-rule
-        selector << advance
-
-        current_at_rule = selector.join
-        at_rule = Spec::CSS_AT_RULES.find { |kwrd| kwrd == current_at_rule }
+        at_rule = determine_at_rule
 
         if peek == NEWLINE
           @line += 1
           @error_reporter.error(@line, "at-rule cannot be on multiple lines.")
-          add_token(:at_rule, current_at_rule)
+          add_token(:at_rule, at_rule)
         elsif at_rule
           token = add_token(:at_rule, "at_#{at_rule[1..-1]}")
-          if at_rule == "@import"
+          if at_rule == Spec::IMPORT
             prescan_import_rule(token.last)
           else
             token
@@ -172,32 +161,38 @@ module Deadfire
       end
 
       def add_forward_slash_or_comment
-        if peek == "*"
-          advance # consume the *
-          while peek != "*" && peek_next != "/" && !at_end?
-            @line += 1 if peek == NEWLINE
-            advance
-          end
+        return add_token(:forward_slash) unless peek == "*"
 
-          if at_end? && peek != "*"
+        advance # consume the *
+        while true
+          if at_end?
             @error_reporter.error(@line, "Unterminated comment on line #{@line}.")
-          else
-            advance # consume the *
-            advance # consume the /
+            break
           end
-          add_token(:comment) # Add the comment anyway, but report an error.
-        else
-          add_token(:forward_slash)
+
+          case peek
+          when NEWLINE
+            @line += 1
+          when "*"
+            if peek_next == "/"
+              advance # consume the *
+              advance # consume the /
+              break
+            end
+          end
+
+          advance
         end
+        add_token(:comment) # Add the comment anyway, but report an error.
       end
 
       def add_whitespace_token
-        add_token(:whitespace) if Deadfire.configuration.keep_whitespace
+        add_token(:whitespace) unless Deadfire.configuration.compressed
       end
 
       def add_newline_token
         @line += 1
-        add_token(:newline) if Deadfire.configuration.keep_whitespace
+        add_token(:newline) unless Deadfire.configuration.compressed
       end
 
       def current_char_position
@@ -229,6 +224,21 @@ module Deadfire
         (char >= "a" && char <= "z") || (char >= "A" && char <= "Z")
       end
 
+      def determine_at_rule
+        selector = [current_char]
+
+        while Spec::CSS_AT_RULES.none? { |kwrd| kwrd == selector.join + peek } && !at_end?
+          break if peek == NEWLINE
+          selector << advance
+        end
+
+        # final char in at-rule
+        selector << advance
+
+        current_at_rule = selector.join
+        Spec::CSS_AT_RULES.find { |kwrd| kwrd == current_at_rule }
+      end
+
       def prescan_import_rule(token)
         # we want to get all the text between the @import and the semicolon
         # so we can parse the file and add it to the ast
@@ -237,29 +247,33 @@ module Deadfire
         while peek != ";" && !at_end?
           advance
         end
+        
+        add_token(:text)
 
         if at_end?
-          @error_reporter.error(@line, "Unterminated import rule.")
+          @error_reporter.error(@line, "Imports must be terminated correctly with a ';'.")
           return
         end
 
-        add_token(:text)
-        advance # remove the semicolon
-
         text_token = @tokens.last
 
         text = text_token.lexeme.gsub(/\\|"/, '')
         file = FilenameHelper.resolve_import_path(text, @line)
 
-        # file is ready for scanning
-        content = File.read(file)
-        scanner = Scanner.new(content, @error_reporter)
+        if file
+          # file is ready for scanning
+          content = File.read(file)
+          scanner = Scanner.new(content, @error_reporter)
 
-        @tokens.pop # remove the text token
-        @tokens.pop # remove the at_rule token
+          advance # remove the semicolon
+          @tokens.pop # remove the text token
+          @tokens.pop # remove the at_rule token
 
-        imported_tokens = scanner.tokenize[0..-2]
-        @tokens.concat imported_tokens
+          imported_tokens = scanner.tokenize[0..-2]
+          @tokens.concat imported_tokens
+        else
+          @error_reporter.error(@line, "File not found '#{text}'")
+        end
       end
     end
   end

data/lib/deadfire/interpreter.rb

@@ -44,10 +44,6 @@ module Deadfire
       end
     end
 
-    def visit_declaration_node(node)
-      node.accept(self)
-    end
-
     def visit_comment_node(node)
       # node.accept(self)
     end

data/lib/deadfire/spec.rb

@@ -17,35 +17,34 @@ module Deadfire
     # value              = any-value [ ',' S* any-value ]*;
     # any-value          = IDENT | STRING | NUMBER | PERCENTAGE | DIMENSION | COLOR | URI | FUNCTION any-value* ')' | '(' any-value* ')' | '[' any-value* ']' | '{' any-value* '}' | ';';
 
-    # -- SASS features
-
-    # Example: @apply button;
-    # apply-rule = "@apply" S* mixin-name S* ";" S*
-    # mixin-name = IDENT
-
-    # Example: button { color: red; &.active { color: blue } }
-    # nested-selector = selector S* "{" S* declaration-list S* "}"
-    # selector = simple-selector [ "&" simple-selector ]
-    # simple-selector = element-name [ "#" id ] [ "." class ]*
-    # element-name = IDENT
-    # id = IDENT
-    # class = "." IDENT
-    # declaration-list = declaration [ ";" S* declaration ]*
+    CHARSET = "@charset"
+    IMPORT = "@import"
+    MEDIA = "@media"
+    PAGE = "@page"
+    FONT_FACE = "@font-face"
+    KEYFRAMES = "@keyframes"
+    SUPPORTS = "@supports"
+    NAMESPACE = "@namespace"
+    COUNTER_STYLE = "@counter-style"
+    VIEWPORT = "@viewport"
+    DOCUMENT = "@document"
+    APPLY = "@apply"
+    LAYER = "@layer"
 
     CSS_AT_RULES = [
-      "@charset",
-      "@import",
-      "@media",
-      "@page",
-      "@font-face",
-      "@keyframes",
-      "@supports",
-      "@namespace",
-      "@counter-style",
-      "@viewport",
-      "@document",
-      "@apply",
-      "@layer"
+      CHARSET,
+      IMPORT,
+      MEDIA,
+      PAGE,
+      FONT_FACE,
+      KEYFRAMES,
+      SUPPORTS,
+      NAMESPACE,
+      COUNTER_STYLE,
+      VIEWPORT,
+      DOCUMENT,
+      APPLY,
+      LAYER
     ]
 
     CSS_SELECTORS = [

data/lib/deadfire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deadfire
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/deadfire.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "deadfire/ast_printer"
-require_relative "deadfire/css_buffer"
 require_relative "deadfire/css_generator"
 require_relative "deadfire/configuration"
 require_relative "deadfire/errors"
 require_relative "deadfire/error_reporter"
 require_relative "deadfire/interpreter"
-require_relative "deadfire/parser"
 require_relative "deadfire/parser_engine"
 require_relative "deadfire/spec"
 require_relative "deadfire/filename_helper"
@@ -26,6 +24,8 @@ require_relative "deadfire/front_end/selector_node"
 require_relative "deadfire/front_end/stylesheet_node"
 
 module Deadfire
+  PERMISSIBLE_FILE_EXTENSIONS = [".css", ".scss"].freeze
+
   class << self
     attr_reader :config
 
@@ -42,6 +42,11 @@ module Deadfire
     end
 
     def parse(content, options = {})
+      configure do |config|
+        config.root_path = options[:root_path]
+        config.compressed = options[:compressed]
+      end
+
       parser = ParserEngine.new(content)
       # TODO: hook into a logger and report the errors
       parser.parse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deadfire
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Haroon Ahmed
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-05-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -40,7 +40,6 @@ files:
 - lib/deadfire.rb
 - lib/deadfire/ast_printer.rb
 - lib/deadfire/configuration.rb
-- lib/deadfire/css_buffer.rb
 - lib/deadfire/css_generator.rb
 - lib/deadfire/error_reporter.rb
 - lib/deadfire/errors.rb
@@ -58,7 +57,6 @@ files:
 - lib/deadfire/front_end/stylesheet_node.rb
 - lib/deadfire/front_end/token.rb
 - lib/deadfire/interpreter.rb
-- lib/deadfire/parser.rb
 - lib/deadfire/parser_engine.rb
 - lib/deadfire/spec.rb
 - lib/deadfire/version.rb
@@ -84,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Deadfire - lightweight css preprocessor

data/lib/deadfire/css_buffer.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-require "stringio"
-
-module Deadfire
-  class CssBuffer
-    attr_reader :lineno, :buffer
-
-    def initialize(content)
-      @content = StringIO.new(content)
-      @buffer = []
-      @lineno = 0
-    end
-
-    def gets(skip_buffer: false)
-      output = content.gets
-      if output && !skip_buffer
-        buffer << output
-      end
-      @lineno += 1
-      output
-    end
-
-    def peek
-      output = content.gets
-      content.ungetc(output)
-      output
-    end
-
-    def eof?
-      content.eof?
-    end
-
-    private
-
-    attr_reader :content
-  end
-end

data/lib/deadfire/parser.rb

@@ -1,258 +0,0 @@
-# frozen_string_literal: true
-module Deadfire
-  # NOTE: Legacy parser, will be replaced by ParserEngine
-  class Parser
-    singleton_class.attr_accessor :cached_mixins
-    self.cached_mixins = Hash.new { |h, k| h[k] = {} }
-
-    singleton_class.attr_accessor :import_path_cache
-    self.import_path_cache = []
-
-    ROOT_SELECTOR = ":root {"
-    OPENING_SELECTOR_PATTERN = /\s*\{/
-    CLOSING_SELECTOR_PATTERN  = /\s*\}/
-    NEST_SELECTOR = "&"
-    START_BLOCK_CHAR = "{"
-    END_BLOCK_CHAR = "}"
-    IMPORT_SELECTOR = "@import"
-    CSS_FILE_EXTENSION = ".css"
-    APPLY_SELECTOR = "@apply"
-    NEWLINE = "\n"
-    OPEN_COMMENT_SELECTOR = "/*"
-    CLOSE_COMMENT_SELECTOR = "*/"
-
-    def self.parse(content, options = {})
-      new(content, options).parse
-    end
-
-    attr_reader :output, :errors_list
-
-    def initialize(content, options = {})
-      @content  = content
-      @errors_list   = ErrorsList.new
-      @filename = options[:filename]
-      @output   = []
-      @imports  = []
-    end
-
-    def buffer
-      @content = preprocess
-      @buffer ||= CssBuffer.new(@content)
-    end
-
-    def parse
-      while ! buffer.eof?
-        process_line(buffer.gets)
-      end
-
-      @output << NEWLINE
-
-      @output.join
-    end
-
-    def errors?
-      @errors_list.errors.any?
-    end
-
-    private
-
-    def preprocess
-      @content.gsub(/\r\n?|\f/, "\n").gsub("\u{0000}", "\u{FFFD}")
-    end
-
-    # this method returns void, and modifies the output array directly
-    def process_line(line)
-      if line.strip.start_with?(OPEN_COMMENT_SELECTOR)
-        handle_comment(line)
-      elsif line.strip.start_with?(IMPORT_SELECTOR)
-        handle_import(line)
-      elsif line.strip.start_with?(ROOT_SELECTOR)
-        handle_mixins(line)
-      elsif line.strip.start_with?(APPLY_SELECTOR)
-        handle_apply(line)
-      else
-        @output << line
-      end
-    end
-
-    def keep_comments?
-      Deadfire.configuration.keep_comments
-    end
-
-    def handle_comment(line)
-      @output << Line.new(line, buffer.lineno) if keep_comments?
-
-      while ! line.include?(CLOSE_COMMENT_SELECTOR) && ! buffer.eof?
-        line = buffer.gets
-        @output << Line.new(line, buffer.lineno) if keep_comments?
-      end
-
-      if buffer.eof?
-        @errors_list.add(message: "Unclosed comment error", lineno: buffer.lineno, original_line: line)
-      end
-    end
-
-    def handle_import(line)
-      import = Import.new(line, buffer.lineno)
-
-      # TODO:
-      # - decide on how many levels of imports we want to allow
-      # - make async??
-      @output << import.parse
-    end
-
-    def handle_apply(line)
-      @apply = Apply.new(line, buffer.lineno)
-      @output << @apply.parse.join(NEWLINE)
-    end
-
-    def handle_mixins(line)
-      @root = Root.new(line, buffer.lineno, buffer)
-      @output << @root.parse
-    end
-  end
-
-  class Line
-    attr_accessor :content, :line_number
-
-    def initialize(content, line_number)
-      @content = content
-      @line_number = line_number
-    end
-
-    def to_s
-      content
-    end
-  end
-
-  class Root < Line
-    def initialize(content, lineno, buffer)
-      super(content, lineno)
-      @end_tag = false
-      @output_current_line = true
-      @output = []
-      @buffer = buffer
-    end
-
-    def parse
-      line = @content
-      if line.include? Parser::ROOT_SELECTOR
-        @output << Line.new(line, @line_number)
-      end
-
-      while !@end_tag && line = @buffer.gets
-        if line =~ Parser::OPENING_SELECTOR_PATTERN
-          @output_current_line = false
-          name = extract_mixin_name(line)
-          properties = extract_properties_from_mixin(@buffer, line)
-          Parser.cached_mixins[name] = properties
-        elsif line =~ Parser::CLOSING_SELECTOR_PATTERN
-          @end_tag = true
-        end
-
-        @output << Line.new(line, @buffer.lineno) if @output_current_line
-        @output_current_line = true
-      end
-
-      to_s
-    end
-
-    def to_s
-      return "" if @output.size <= 1
-
-      @output.map(&:to_s)
-    end
-
-    private
-
-    def extract_mixin_name(line)
-      line.tr("{", "").tr(".", "").tr(":", "").strip
-    end
-
-    def extract_properties_from_mixin(buffer, line)
-      properties = {}
-      line = buffer.gets # skip opening {
-      while line !~ Parser::CLOSING_SELECTOR_PATTERN && !buffer.eof?
-        name, value = extract_name_and_values(line)
-        properties[name] = value
-        line = buffer.gets
-      end
-      properties
-    end
-
-    def extract_name_and_values(line)
-      name, value = line.split(":")
-      value = value.gsub(";", "")
-      [name, value].map(&:strip)
-    end
-  end
-
-  class Import < Line
-    def initialize(...)
-      super(...)
-    end
-
-    def parse
-      import_path = FilenameHelper.resolve_import_path(content, @lineno)
-
-      if Parser.import_path_cache.include?(import_path)
-        raise DuplicateImportException.new(import_path, @lineno)
-      end
-
-      Parser.import_path_cache << import_path
-
-      Parser.new(File.read(import_path), filename: import_path).parse
-    end
-  end
-
-  class Apply < Line
-    def initialize(...)
-      super
-      @current_line = @content.dup
-      @space  = " "
-      @apply_start_char = "@"
-      @output = []
-    end
-
-    def parse
-      raise Deadfire::EarlyApplyException.new(@content, @lineno) if Parser.cached_mixins.empty?
-
-      space_counter = calculate_number_of_spaces
-      ends_with_end_block_char = false
-
-      @current_line.split(" ").each do |css|
-        next if css.include?(Parser::APPLY_SELECTOR)
-
-        css.gsub!(";", "")
-        if css.end_with?(Parser::END_BLOCK_CHAR)
-          ends_with_end_block_char = true
-          css.gsub!(Parser::END_BLOCK_CHAR, "")
-        end
-
-        fetch_cached_mixin(css).each_pair do |key, value|
-          @output << "#{@space * space_counter}#{key}: #{value};"
-        end
-      end
-      @output << "#{Parser::END_BLOCK_CHAR}" if ends_with_end_block_char
-      @output
-    end
-
-    private
-
-    def calculate_number_of_spaces
-      space_counter = 0
-      @current_line.each_char do |char|
-        break if char == @apply_start_char
-        space_counter += 1
-      end
-      space_counter
-    end
-
-    # find css class key/val from hash, otherwise throw because the mixin is not defined
-    def fetch_cached_mixin(key)
-      raise Deadfire::EarlyApplyException.new(key, @lineno) unless Parser.cached_mixins.include?(key)
-
-      Parser.cached_mixins[key]
-    end
-  end
-end