Class: Klenod::Build::Plugins::CSSPlugin::Plugin

Inherits:
Klenod::Build::Plugin
  • Object
show all
Includes:
ClassNamesRuntime
Defined in:
lib/klenod/build/plugins/css_plugin.rb

Defined Under Namespace

Classes: CssDependencies, CssEdit

Constant Summary collapse

CSS_DEPENDENCY_TYPES = 
{
  ImportDependency => :css_import,
  UrlDependency => :asset_url
}.freeze
JAVASCRIPT_STYLESHEET_QUERY = 
"javascript"
VALID_SOURCE_MAP_MODES = 
[false, true, :development].freeze

Instance Method Summary collapse

Constructor Details

#initialize(source_maps: :development, minify: false, class_pattern: "[component].[local]?[hash]", tag_pattern: "[component]_[local]?[hash]", local_css_variables: false, variable_pattern: "[component]-[local]?[hash]") ⇒ Plugin

Returns a new instance of Plugin.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 35

def initialize(
  source_maps: :development,
  minify: false,
  class_pattern: "[component].[local]?[hash]",
  tag_pattern: "[component]_[local]?[hash]",
  local_css_variables: false,
  variable_pattern: "[component]-[local]?[hash]"
)
  unless VALID_SOURCE_MAP_MODES.include?(source_maps)
    raise ArgumentError, "source_maps must be false, true, or :development"
  end

  @source_maps = source_maps
  @minify = minify
  @class_pattern = class_pattern
  @tag_pattern = tag_pattern
  @local_css_variables = local_css_variables
  @variable_pattern = variable_pattern
end

Instance Method Details

#finalize(module_id, result, resolved_dependencies, dependency_records, context) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 106

def finalize(module_id, result, resolved_dependencies, dependency_records, context)
  css_result = result.metadata[:css_result]
  javascript_only = result.metadata[:css_javascript_only]
  return result unless css_result || javascript_only

  if javascript_only
    javascript_css_edit = finalized_css_edit(
      result.metadata.fetch(:css_javascript_result),
      resolved_dependencies,
      dependency_records,
      result.metadata.fetch(:external_dependencies),
      import_asset_type: :css_javascript_stylesheet
    )
    javascript_asset, javascript_source_map_asset = css_asset_pair(module_id, javascript_css_edit, :css_javascript_stylesheet, {}, context)

    return result.with(
      code: "Default = #{javascript_asset.output_path.inspect}\n",
      assets: [javascript_asset, javascript_source_map_asset, *result.assets].compact,
      metadata: result.metadata.merge(
        css_javascript_stylesheet_path: javascript_asset.output_path
      )
    )
  end

  css_edit = finalized_css_edit(css_result, resolved_dependencies, dependency_records, result.metadata.fetch(:external_dependencies))
  classes = finalized_css_selectors(css_result, resolved_dependencies, dependency_records)
  asset, source_map_asset = css_asset_pair(
    module_id,
    css_edit,
    :css,
    {classes: classes, variables: css_result.variables},
    context
  )

  result.with(
    code: ruby_module_source(classes, asset.output_path, styles_dependency: result.dependencies.fetch(0)),
    assets: [asset, source_map_asset, *result.assets].compact,
    metadata: result.metadata.merge(
      css_asset_path: asset.output_path,
      css_classes: classes
    )
  )
end

#import_value(resolved_dependency, record, context) ⇒ Object 



150
151
152
153
154
155
156
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 150

def import_value(resolved_dependency, record, context)
  styles_import = class_names_runtime_import_value(resolved_dependency, record, context)
  return styles_import if styles_import
  return nil unless record.id.extname == ".css"

  context.mods.fetch(record.id).const_get(:Exports)::Default
end

#load(module_id, _context) ⇒ Object 



59
60
61
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 59

def load(module_id, _context)
  load_class_names_runtime(module_id)
end

#resolve(dependency, context) ⇒ Object 



55
56
57
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 55

def resolve(dependency, context)
  resolve_class_names_runtime(dependency) || resolve_javascript_stylesheet_dependency(dependency, context)
end

#runtime_import_value(resolved_dependency, record, _context) ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 158

def runtime_import_value(resolved_dependency, record, _context)
  styles_import = class_names_runtime_runtime_import_value(resolved_dependency, record)
  return styles_import if styles_import
  return Runtime::DefaultImport.new(:Default) if record.id.extname == ".css"

  super
end

#transform(module_id, code, context) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/klenod/build/plugins/css_plugin.rb', line 63

def transform(module_id, code, context)
  return super unless module_id.extname == ".css"

  if javascript_stylesheet_module?(module_id)
    javascript_result = transform_css(module_id, code, transform_names: false, context: context)
    css_dependencies = build_dependencies(module_id, javascript_result.dependencies, context)

    return Klenod::Build::TransformResult.new(
      "Default = nil\n",
      css_dependencies.dependencies,
      nil,
      [],
      [],
      {
        css_javascript_result: javascript_result,
        css_javascript_only: true,
        external_dependencies: css_dependencies.external_dependencies
      }
    )
  end

  scoped_result = transform_css(module_id, code, transform_names: true, context: context)
  css_dependencies = build_dependencies(module_id, scoped_result.dependencies, context)
  compose_dependencies = build_compose_dependencies(module_id, scoped_result)
  variable_dependencies = build_variable_dependencies(module_id, scoped_result)
  styles_dependency = class_names_runtime_dependency(module_id)
  selectors = css_selectors(scoped_result)

  Klenod::Build::TransformResult.new(
    ruby_module_source(selectors, nil, styles_dependency: styles_dependency),
    [styles_dependency, *css_dependencies.dependencies, *compose_dependencies, *variable_dependencies],
    nil,
    [],
    [],
    {
      css_result: scoped_result,
      css_classes: selectors,
      css_variables: scoped_result.serialized_variables,
      external_dependencies: css_dependencies.external_dependencies
    }
  )
end