glimmer-dsl-css 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96e2646830dfe42a2cfe0ea91ea369b558d0873917071e963349856b129c1278
-  data.tar.gz: 1948d00677cdf1aa4df5cbb90a4632edbd06c03c6162dce55ca2ebb94baa0dff
+  metadata.gz: 4d7025737d0f0a5d69fa10f2410f119e35037300e0b588ac71cbcc93d2bcc37e
+  data.tar.gz: 6123b4db4d7f8e575e0d3480f9709a5c4b69da3a1a5404b163577a6acb0df299
 SHA512:
-  metadata.gz: 4dac6e584522cc6d193aac0ff4cf6fac528e4fa940bf1d95de6c35e657333852627248fc783e20d9844313a43a82b05915dbd1b457304bfc15124575cf8323ed
-  data.tar.gz: 595521b5d0d22be9ff481db6bc0a7a18ad0bc4d5958d9e69a77886b03961b6ea9d1a79d74f4e783ce418cdceb2cf53fb0190656d84eabe95e5f8039908cadb59
+  metadata.gz: 1860dbc22baf525cc80be2df7ae16f9a6b1f158e42f00ead107c1440ca4d75579392f51c19371372fcb063416db62b0831e675cb54856dba2ee9a07218d5a5b0
+  data.tar.gz: 13db5825e60924567f8004d1c20a6fe5e822b1a2a739fc6791e831cc72a9c77083009312212b19393901783128928ebaadb39f39b7fcfd5aafb1e78f4a274e66

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.5.0
+
+- Support `raw` keyword to allow adding raw CSS to a `css { }` block, which gets appended to other CSS generated by the DSL.
+
 ## 1.4.1
 
 - Optimize performance (mostly in Opal) by re-ordering dsl.rb to give preference to dynamic property expressions, removing media from its chain of responsibility (it does not need to be there because it is a static expression), and re-ordering conditional checks in dynamic property expression and element rule expression.

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for CSS 1.4.1
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for CSS 1.5.0
 ## Ruby Programmable Cascading Style Sheets
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-css.svg)](http://badge.fury.io/rb/glimmer-dsl-css)
 [![Travis CI](https://travis-ci.com/AndyObtiva/glimmer-dsl-css.svg?branch=master)](https://travis-ci.com/github/AndyObtiva/glimmer-dsl-css)
@@ -64,7 +64,7 @@ Please follow these instructions to make the `glimmer` command available on your
 
 Run this command to install directly:
 ```
-gem install glimmer-dsl-css -v 1.4.1
+gem install glimmer-dsl-css -v 1.5.0
 ```
 
 Note: In case you are using JRuby, `jgem` is JRuby's version of the `gem` command. RVM allows running `gem` as an alias in JRuby. Otherwise, you may also run `jruby -S gem install ...`
@@ -79,7 +79,7 @@ That's it! Requiring the gem activates the Glimmer CSS DSL automatically.
 
 Add the following to `Gemfile` (after `glimmer-dsl-swt` and/or `glimmer-dsl-opal` if included too):
 ```
-gem 'glimmer-dsl-css', '~> 1.4.1'
+gem 'glimmer-dsl-css', '~> 1.5.0'
 ```
 
 And, then run:
@@ -201,6 +201,49 @@ Output (minified CSS):
 body{font-size:1.1em;background:white}body > h1{background-color:red;font-size:24px}
 ```
 
+### Raw CSS
+
+You can mix in raw CSS with Glimmer CSS DSL syntax by using the `raw` keyword and passing it an argument that is the raw CSS `String`. That enables adding programmability (e.g. `if/else` statements) to some parts of a CSS document while leaving the others as raw CSS.
+
+Example (you can try in IRB):
+
+```ruby
+require 'glimmer-dsl-css'
+
+include Glimmer
+
+color = 'black'
+size = 8
+
+@css = css {
+  # Programmable CSS
+  body {
+    font_size size < 10 ? "0.#{size}em" : '1.1em'
+    background color.nil? ? 'white' : color
+  }
+  
+  # Non-Programmable CSS
+  raw '
+  body > h1 {
+    background-color: red;
+    font-size: 24px;
+  }
+  
+  body > section {
+    font-size: 16px;
+  }
+  '
+}
+
+puts @css
+```
+
+Output (minified CSS):
+
+```css
+body{font-size:0.8em;background:black}body > h1 {background-color: red;font-size: 24px;}body > section {font-size: 16px;}
+```
+
 ### CSS to Glimmer Converter
 
 The Ruby gem includes a CSS to Glimmer converter (`css_to_glimmer`) to automatically convert legacy CSS code into Glimmer DSL syntax.

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.5.0

data/bin/minify_css

@@ -12,7 +12,7 @@ else
   css_file_path = ARGV.first
   puts "Minifying CSS for input file: #{css_file_path}"
   css = File.read(css_file_path)
-  converter = Glimmer::CSS::CSSMinifier.new
+  converter = Glimmer::CSS::CSSMinifier.instance
   minified_css = converter.convert(css)
   minified_css_file_path = "#{File.basename(css_file_path, '.css')}.minified.css"
   File.write(minified_css_file_path, minified_css)

data/glimmer-dsl-css.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-css 1.4.1 ruby lib
+# stub: glimmer-dsl-css 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-css".freeze
-  s.version = "1.4.1"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -30,11 +30,13 @@ Gem::Specification.new do |s|
     "bin/minify_css",
     "glimmer-dsl-css.gemspec",
     "lib/glimmer-dsl-css.rb",
+    "lib/glimmer/css/css_fragment.rb",
+    "lib/glimmer/css/css_fragment_composite.rb",
     "lib/glimmer/css/css_minifier.rb",
     "lib/glimmer/css/css_to_glimmer_converter.rb",
     "lib/glimmer/css/media_query.rb",
+    "lib/glimmer/css/raw_css.rb",
     "lib/glimmer/css/rule.rb",
-    "lib/glimmer/css/rule_composite.rb",
     "lib/glimmer/css/style_sheet.rb",
     "lib/glimmer/dsl/css/css_expression.rb",
     "lib/glimmer/dsl/css/display_expression.rb",
@@ -45,6 +47,7 @@ Gem::Specification.new do |s|
     "lib/glimmer/dsl/css/media_expression.rb",
     "lib/glimmer/dsl/css/property_expression.rb",
     "lib/glimmer/dsl/css/pv_expression.rb",
+    "lib/glimmer/dsl/css/raw_expression.rb",
     "lib/glimmer/dsl/css/ru_expression.rb",
     "lib/glimmer/dsl/css/rul_expression.rb",
     "lib/glimmer/dsl/css/rule_expression.rb",

data/lib/glimmer/css/css_fragment.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2020-2024 - Andy Maleh
+#
+# 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.
+
+module Glimmer
+  module CSS
+    module CssFragment
+      # Subclasses must override to return a CSS String
+      def to_css
+        raise 'Not implemented! Subclasses must override/implement to return a CSS String.'
+      end
+      
+      # Returns the value of to_css
+      def to_s
+        to_css
+      end
+    end
+  end
+end

data/lib/glimmer/css/{rule_composite.rb → css_fragment_composite.rb}

@@ -19,11 +19,19 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'glimmer/css/css_fragment'
+
 module Glimmer
   module CSS
-    module RuleComposite
-      def rules
-        @rules ||= []
+    module CssFragmentComposite
+      include CssFragment
+      
+      def children
+        @children ||= []
+      end
+      
+      def to_css
+        children.map(&:to_css).join
       end
     end
   end

data/lib/glimmer/css/css_minifier.rb

@@ -19,9 +19,14 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'singleton'
+
 module Glimmer
   module CSS
+    # A very rudimentary CSS minifier. It does not minify CSS completely at the moment.
     class CSSMinifier
+      include Singleton
+      
       def convert(css)
         css.lines.map(&:chomp).map(&:strip).join
       end

data/lib/glimmer/css/css_to_glimmer_converter.rb

@@ -48,7 +48,7 @@ module Glimmer
       end
       
       def minify(css)
-        CSSMinifier.new.convert(css)
+        CSSMinifier.instance.convert(css)
       end
       
       def remove_charset(css)

data/lib/glimmer/css/media_query.rb

@@ -19,18 +19,16 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'glimmer/css/rule_composite'
+require 'glimmer/css/css_fragment_composite'
 require 'glimmer/css/rule'
 
 module Glimmer
   module CSS
     class MediaQuery < Rule
-      include RuleComposite
+      include CssFragmentComposite
     
       def to_css
-        css = "@media #{selector}{"
-        css += rules.map(&:to_css).join
-        css += "}"
+        "@media #{selector}{#{super}}"
       end
     end
   end

data/lib/glimmer/css/raw_css.rb

@@ -0,0 +1,44 @@
+# Copyright (c) 2020-2024 - Andy Maleh
+#
+# 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.
+
+require 'glimmer/css/css_fragment'
+require 'glimmer/css/css_minifier'
+
+module Glimmer
+  module CSS
+    class RawCss
+      include CssFragment
+      
+      attr_reader :raw_css_string
+
+      def initialize(raw_css_string, parent:)
+        @raw_css_string = raw_css_string
+        @parent = parent
+        @minifier = CSSMinifier.instance
+        parent.children << self
+      end
+
+      def to_css
+        @minifier.convert(@raw_css_string)
+      end
+    end
+  end
+end

data/lib/glimmer/css/rule.rb

@@ -19,16 +19,20 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require 'glimmer/css/css_fragment'
+
 module Glimmer
   module CSS
     class Rule
+      include CssFragment
+      
       attr_reader :selector, :properties
 
       def initialize(selector, parent:)
         @selector = selector
         @properties = {}
         @parent = parent
-        parent.rules << self
+        parent.children << self
       end
 
       def add_property(keyword, *args)
@@ -44,8 +48,6 @@ module Glimmer
         end.join(';')
         css += "}"
       end
-
-      alias to_s to_css
     end
   end
 end

data/lib/glimmer/css/style_sheet.rb

@@ -19,19 +19,15 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'glimmer/css/rule_composite'
+require 'glimmer/css/css_fragment_composite'
 require 'glimmer/css/rule'
+require 'glimmer/css/media_query'
+require 'glimmer/css/raw_css'
 
 module Glimmer
   module CSS
     class StyleSheet
-      include RuleComposite
-
-      def to_css
-        rules.map(&:to_css).join
-      end
-
-      alias to_s to_css
+      include CssFragmentComposite
     end
   end
 end

data/lib/glimmer/dsl/css/dsl.rb

@@ -24,6 +24,7 @@ require 'glimmer/dsl/engine'
 require 'glimmer/dsl/css/element_rule_expression'
 require 'glimmer/dsl/css/dynamic_property_expression'
 require 'glimmer/dsl/css/css_expression'
+require 'glimmer/dsl/css/raw_expression'
 require 'glimmer/dsl/css/rule_expression'
 require 'glimmer/dsl/css/rul_expression'
 require 'glimmer/dsl/css/ru_expression'

data/lib/glimmer/dsl/css/raw_expression.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2020-2024 - Andy Maleh
+#
+# 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.
+
+require 'glimmer/dsl/static_expression'
+require 'glimmer/css/raw_css'
+
+module Glimmer
+  module DSL
+    module CSS
+      class RawExpression < StaticExpression
+        def can_interpret?(parent, keyword, *args, &block)
+          !block_given? and
+            !args.empty? and
+            args.size == 1 and
+            parent.is_a?(Glimmer::CSS::StyleSheet)
+        end
+
+        def interpret(parent, keyword, *args, &block)
+          raw_css_string = args.first
+          Glimmer::CSS::RawCss.new(raw_css_string, parent: parent)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-css
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - AndyMaleh
@@ -228,11 +228,13 @@ files:
 - bin/minify_css
 - glimmer-dsl-css.gemspec
 - lib/glimmer-dsl-css.rb
+- lib/glimmer/css/css_fragment.rb
+- lib/glimmer/css/css_fragment_composite.rb
 - lib/glimmer/css/css_minifier.rb
 - lib/glimmer/css/css_to_glimmer_converter.rb
 - lib/glimmer/css/media_query.rb
+- lib/glimmer/css/raw_css.rb
 - lib/glimmer/css/rule.rb
-- lib/glimmer/css/rule_composite.rb
 - lib/glimmer/css/style_sheet.rb
 - lib/glimmer/dsl/css/css_expression.rb
 - lib/glimmer/dsl/css/display_expression.rb
@@ -243,6 +245,7 @@ files:
 - lib/glimmer/dsl/css/media_expression.rb
 - lib/glimmer/dsl/css/property_expression.rb
 - lib/glimmer/dsl/css/pv_expression.rb
+- lib/glimmer/dsl/css/raw_expression.rb
 - lib/glimmer/dsl/css/ru_expression.rb
 - lib/glimmer/dsl/css/rul_expression.rb
 - lib/glimmer/dsl/css/rule_expression.rb