Merge pull request #38 from gravitystorm/ivars

Support using ivars in stylesheets

Author: pnorman

.rubocop_todo.yml

@@ -14,7 +14,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 208
+  Max: 217
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.

lib/glug/layer.rb

@@ -82,7 +82,23 @@ def initialize(stylesheet, args = {})
     end
 
     def dsl_eval(&block)
+      # Copy ivars from stylesheet DSL to layer DSL (before eval)
+      style_dsl = @stylesheet.dsl
+      style_dsl.instance_variables.each do |ivar|
+        next if ivar.to_s.start_with?('@__') # skip internal ivars
+
+        @dsl.instance_variable_set(ivar, style_dsl.instance_variable_get(ivar))
+      end
+
+      # Run the layer evaluation
       @dsl.instance_eval(&block)
+
+      # Copy ivars back to stylesheet DSL (after eval)
+      @dsl.instance_variables.each do |ivar|
+        next if ivar.to_s.start_with?('@__') # skip internal ivars
+
+        style_dsl.instance_variable_set(ivar, @dsl.instance_variable_get(ivar))
+      end
     end
 
     # Handle all missing 'method' calls

lib/glug/stylesheet.rb

@@ -3,7 +3,7 @@
 module Glug
   # the main document object
   class Stylesheet
-    attr_accessor :sources, :kv, :base_dir, :params
+    attr_accessor :sources, :kv, :base_dir, :params, :dsl
 
     def initialize(base_dir: nil, params: nil, &block)
       @sources = {}

lib/glug/stylesheet_dsl.rb

@@ -26,7 +26,11 @@ def respond_to_missing?(*)
 
     # Set a property, e.g. 'bearing 29'
     def method_missing(method_sym, *args)
-      @__impl.add_property(method_sym, *args)
+      if Layer::EXPRESSIONS.include?(method_sym)
+        Condition.new.from_list(method_sym, args)
+      else
+        @__impl.add_property(method_sym, *args)
+      end
     end
   end
 end

spec/fixtures/expression_ivars.glug

@@ -0,0 +1,12 @@
+version 8
+name 'Expression ivars test'
+source :shortbread, type: 'vector', url: 'https://vector.openstreetmap.org/shortbread_v1/tilejson.json'
+
+# Expression assigned to ivar at stylesheet level
+@my_halo = rgba(255, 255, 255, 0.8)
+@my_color = rgb(100, 200, 50)
+
+layer(:labels, zoom: 5.., source: :shortbread) do
+  text_halo_color @my_halo
+  text_color @my_color
+end

spec/fixtures/expression_ivars.json

@@ -0,0 +1,23 @@
+{
+  "version":8,
+  "name":"Expression ivars test",
+  "sources":{
+    "shortbread":{
+      "type":"vector",
+      "url":"https://vector.openstreetmap.org/shortbread_v1/tilejson.json"
+    }
+  },
+  "layers":[
+    {
+      "paint":{
+        "text-halo-color":["rgba",255,255,255,0.8],
+        "text-color":["rgb",100,200,50]
+      },
+      "source":"shortbread",
+      "id":"labels",
+      "source-layer":"labels",
+      "type":"symbol",
+      "minzoom":5
+    }
+  ]
+}

spec/fixtures/ivars.glug

@@ -0,0 +1,23 @@
+version 8
+name 'My first stylesheet'
+source :shortbread, type: 'vector', url: 'https://vector.openstreetmap.org/shortbread_v1/tilejson.json'
+
+# set at stylesheet level
+@width = 6
+
+layer(:roads, zoom: 10..13, source: :shortbread) do
+  # get at layer level
+  line_width @width
+  line_color 0x888888
+end
+
+layer(:water, source: :shortbread) do
+  # set at layer level
+  @water = 'blue'
+  fill_color @water
+end
+
+layer(:water_line, source: :shortbread) do
+  # get from other layer
+  fill_color @water
+end

spec/fixtures/ivars.json

@@ -0,0 +1,35 @@
+{
+  "version":8,
+  "name":"My first stylesheet",
+  "sources":{
+    "shortbread":{
+      "type":"vector",
+      "url":"https://vector.openstreetmap.org/shortbread_v1/tilejson.json"
+    }
+  },
+  "layers":[
+    {
+      "paint":{"line-width":6,"line-color":"#888888"},
+      "source":"shortbread",
+      "id":"roads",
+      "source-layer":"roads",
+      "type":"line",
+      "minzoom":10,
+      "maxzoom":13
+    },
+    {
+      "paint":{"fill-color":"blue"},
+      "source":"shortbread",
+      "id":"water",
+      "source-layer":"water",
+      "type":"fill"
+    },
+    {
+      "paint":{"fill-color":"blue"},
+      "source":"shortbread",
+      "id":"water_line",
+      "source-layer":"water_line",
+      "type":"fill"
+    }
+  ]
+}

spec/fixtures/ivars_with_include.glug

@@ -0,0 +1,8 @@
+version 8
+name 'My first stylesheet'
+source :shortbread, type: 'vector', url: 'https://vector.openstreetmap.org/shortbread_v1/tilejson.json'
+
+# set at stylesheet level
+@width = 6
+
+include_file 'ivars_with_include_sub.glug'

spec/fixtures/ivars_with_include.json

@@ -0,0 +1,21 @@
+{
+  "version":8,
+  "name":"My first stylesheet",
+  "sources":{
+    "shortbread":{
+      "type":"vector",
+      "url":"https://vector.openstreetmap.org/shortbread_v1/tilejson.json"
+    }
+  },
+  "layers":[
+    {
+      "paint":{"line-width":6,"line-color":"#888888"},
+      "source":"shortbread",
+      "id":"roads",
+      "source-layer":"roads",
+      "type":"line",
+      "minzoom":10,
+      "maxzoom":13
+    }
+  ]
+}