bridgetown-core 0.19.3 → 0.21.0.beta4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/bridgetown-core.gemspec +1 -2
  3. data/lib/bridgetown-core.rb +37 -29
  4. data/lib/bridgetown-core/cleaner.rb +9 -3
  5. data/lib/bridgetown-core/collection.rb +177 -78
  6. data/lib/bridgetown-core/commands/base.rb +9 -0
  7. data/lib/bridgetown-core/commands/build.rb +0 -11
  8. data/lib/bridgetown-core/commands/concerns/git_helpers.rb +20 -0
  9. data/lib/bridgetown-core/commands/configure.rb +8 -3
  10. data/lib/bridgetown-core/commands/console.rb +4 -0
  11. data/lib/bridgetown-core/commands/doctor.rb +1 -19
  12. data/lib/bridgetown-core/commands/new.rb +6 -6
  13. data/lib/bridgetown-core/commands/plugins.rb +14 -13
  14. data/lib/bridgetown-core/commands/serve.rb +0 -14
  15. data/lib/bridgetown-core/commands/webpack.rb +75 -0
  16. data/lib/bridgetown-core/commands/webpack/enable-postcss.rb +12 -0
  17. data/lib/bridgetown-core/commands/webpack/setup.rb +4 -0
  18. data/lib/bridgetown-core/commands/webpack/update.rb +3 -0
  19. data/lib/bridgetown-core/commands/webpack/webpack.config.js +18 -0
  20. data/lib/{site_template/webpack.config.js.erb → bridgetown-core/commands/webpack/webpack.defaults.js.erb} +32 -16
  21. data/lib/bridgetown-core/component.rb +183 -0
  22. data/lib/bridgetown-core/concerns/data_accessible.rb +1 -0
  23. data/lib/bridgetown-core/concerns/front_matter_importer.rb +52 -0
  24. data/lib/bridgetown-core/concerns/layout_placeable.rb +1 -1
  25. data/lib/bridgetown-core/concerns/site/configurable.rb +10 -10
  26. data/lib/bridgetown-core/concerns/site/content.rb +56 -15
  27. data/lib/bridgetown-core/concerns/site/localizable.rb +3 -5
  28. data/lib/bridgetown-core/concerns/site/processable.rb +6 -4
  29. data/lib/bridgetown-core/concerns/site/renderable.rb +26 -0
  30. data/lib/bridgetown-core/concerns/site/writable.rb +12 -2
  31. data/lib/bridgetown-core/concerns/validatable.rb +2 -5
  32. data/lib/bridgetown-core/configuration.rb +61 -33
  33. data/lib/bridgetown-core/configurations/bt-postcss.rb +6 -6
  34. data/lib/bridgetown-core/configurations/netlify.rb +1 -0
  35. data/lib/bridgetown-core/configurations/tailwindcss.rb +6 -6
  36. data/lib/bridgetown-core/converter.rb +23 -0
  37. data/lib/bridgetown-core/converters/erb_templates.rb +51 -35
  38. data/lib/bridgetown-core/converters/identity.rb +0 -9
  39. data/lib/bridgetown-core/converters/liquid_templates.rb +1 -1
  40. data/lib/bridgetown-core/converters/markdown.rb +14 -4
  41. data/lib/bridgetown-core/converters/markdown/kramdown_parser.rb +5 -38
  42. data/lib/bridgetown-core/converters/ruby_templates.rb +17 -0
  43. data/lib/bridgetown-core/converters/smartypants.rb +3 -1
  44. data/lib/bridgetown-core/core_ext/psych.rb +19 -0
  45. data/lib/bridgetown-core/current.rb +10 -0
  46. data/lib/bridgetown-core/document.rb +9 -16
  47. data/lib/bridgetown-core/drops/collection_drop.rb +1 -1
  48. data/lib/bridgetown-core/drops/page_drop.rb +4 -0
  49. data/lib/bridgetown-core/drops/relations_drop.rb +23 -0
  50. data/lib/bridgetown-core/drops/resource_drop.rb +83 -0
  51. data/lib/bridgetown-core/drops/site_drop.rb +33 -8
  52. data/lib/bridgetown-core/drops/unified_payload_drop.rb +5 -0
  53. data/lib/bridgetown-core/entry_filter.rb +17 -28
  54. data/lib/bridgetown-core/errors.rb +0 -2
  55. data/lib/bridgetown-core/filters.rb +3 -26
  56. data/lib/bridgetown-core/filters/from_liquid.rb +23 -0
  57. data/lib/bridgetown-core/filters/url_filters.rb +12 -0
  58. data/lib/bridgetown-core/frontmatter_defaults.rb +1 -1
  59. data/lib/bridgetown-core/generators/prototype_generator.rb +59 -20
  60. data/lib/bridgetown-core/helpers.rb +48 -9
  61. data/lib/bridgetown-core/layout.rb +53 -21
  62. data/lib/bridgetown-core/liquid_renderer/file.rb +1 -0
  63. data/lib/bridgetown-core/liquid_renderer/table.rb +1 -0
  64. data/lib/bridgetown-core/model/base.rb +138 -0
  65. data/lib/bridgetown-core/model/builder_origin.rb +40 -0
  66. data/lib/bridgetown-core/model/origin.rb +38 -0
  67. data/lib/bridgetown-core/model/repo_origin.rb +126 -0
  68. data/lib/bridgetown-core/page.rb +11 -2
  69. data/lib/bridgetown-core/plugin_manager.rb +1 -3
  70. data/lib/bridgetown-core/publisher.rb +8 -2
  71. data/lib/bridgetown-core/reader.rb +37 -22
  72. data/lib/bridgetown-core/readers/data_reader.rb +5 -5
  73. data/lib/bridgetown-core/readers/defaults_reader.rb +1 -1
  74. data/lib/bridgetown-core/readers/layout_reader.rb +1 -1
  75. data/lib/bridgetown-core/readers/page_reader.rb +1 -0
  76. data/lib/bridgetown-core/readers/post_reader.rb +5 -4
  77. data/lib/bridgetown-core/regenerator.rb +9 -2
  78. data/lib/bridgetown-core/related_posts.rb +9 -6
  79. data/lib/bridgetown-core/renderer.rb +6 -13
  80. data/lib/bridgetown-core/resource/base.rb +329 -0
  81. data/lib/bridgetown-core/resource/destination.rb +49 -0
  82. data/lib/bridgetown-core/resource/permalink_processor.rb +179 -0
  83. data/lib/bridgetown-core/resource/relations.rb +132 -0
  84. data/lib/bridgetown-core/resource/taxonomy_term.rb +34 -0
  85. data/lib/bridgetown-core/resource/taxonomy_type.rb +56 -0
  86. data/lib/bridgetown-core/resource/transformer.rb +177 -0
  87. data/lib/bridgetown-core/ruby_template_view.rb +11 -11
  88. data/lib/bridgetown-core/site.rb +13 -6
  89. data/lib/bridgetown-core/static_file.rb +33 -10
  90. data/lib/bridgetown-core/tags/highlight.rb +2 -15
  91. data/lib/bridgetown-core/tags/include.rb +1 -1
  92. data/lib/bridgetown-core/tags/post_url.rb +2 -2
  93. data/lib/bridgetown-core/url.rb +1 -0
  94. data/lib/bridgetown-core/utils.rb +49 -43
  95. data/lib/bridgetown-core/utils/require_gems.rb +60 -0
  96. data/lib/bridgetown-core/utils/ruby_exec.rb +6 -9
  97. data/lib/bridgetown-core/utils/ruby_front_matter.rb +39 -0
  98. data/lib/bridgetown-core/version.rb +2 -2
  99. data/lib/bridgetown-core/watcher.rb +2 -1
  100. data/lib/bridgetown-core/yaml_parser.rb +22 -0
  101. data/lib/site_template/config/.keep +0 -0
  102. data/lib/site_template/package.json.erb +4 -4
  103. data/lib/site_template/plugins/site_builder.rb +1 -1
  104. data/lib/site_template/src/_posts/0000-00-00-welcome-to-bridgetown.md.erb +1 -1
  105. metadata +46 -41
  106. data/lib/bridgetown-core/external.rb +0 -58
  107. data/lib/bridgetown-core/page_without_a_file.rb +0 -17
  108. data/lib/bridgetown-core/path_manager.rb +0 -31
  109. data/lib/bridgetown-core/readers/collection_reader.rb +0 -23
  110. data/lib/bridgetown-core/readers/static_file_reader.rb +0 -25
  111. data/lib/bridgetown-core/utils/exec.rb +0 -26
  112. data/lib/bridgetown-core/utils/internet.rb +0 -37
  113. data/lib/bridgetown-core/utils/platforms.rb +0 -80
  114. data/lib/bridgetown-core/utils/thread_event.rb +0 -31
  115. data/lib/bridgetown-core/utils/win_tz.rb +0 -75
@@ -25,15 +25,6 @@ module Bridgetown
25
25
  def output_ext(ext)
26
26
  ext
27
27
  end
28
-
29
- # Logic to do the content conversion.
30
- #
31
- # content - String content of file (without front matter).
32
- #
33
- # Returns a String of the converted content.
34
- def convert(content)
35
- content
36
- end
37
28
  end
38
29
  end
39
30
  end
@@ -18,7 +18,7 @@ module Bridgetown
18
18
  # Logic to do the Liquid content conversion.
19
19
  #
20
20
  # @param content [String] Content of the file (without front matter).
21
- # @params convertible [Bridgetown::Page, Bridgetown::Document, Bridgetown::Layout]
21
+ # @param convertible [Bridgetown::Page, Bridgetown::Document, Bridgetown::Layout]
22
22
  # The instantiated object which is processing the file.
23
23
  #
24
24
  # @return [String] The converted content.
@@ -22,7 +22,9 @@ module Bridgetown
22
22
  raise Errors::FatalException, "Invalid Markdown processor given: #{@config["markdown"]}"
23
23
  end
24
24
 
25
- @cache = Bridgetown::Cache.new("Bridgetown::Converters::Markdown")
25
+ unless @config.cache_markdown == false || @config.kramdown.input == "GFMExtractions"
26
+ @cache = Bridgetown::Cache.new("Bridgetown::Converters::Markdown")
27
+ end
26
28
  @setup = true
27
29
  end
28
30
 
@@ -59,10 +61,18 @@ module Bridgetown
59
61
  # content - String content of file (without front matter).
60
62
  #
61
63
  # Returns a String of the converted content.
62
- def convert(content)
64
+ def convert(content, convertible = nil)
63
65
  setup
64
- @cache.getset(content) do
65
- @parser.convert(content)
66
+ if @cache
67
+ @cache.getset(content) do
68
+ @parser.convert(content)
69
+ end
70
+ else
71
+ output = @parser.convert(content)
72
+ if convertible && @parser.respond_to?(:extractions)
73
+ convertible.data.markdown_extractions = @parser.extractions
74
+ end
75
+ output
66
76
  end
67
77
  end
68
78
 
@@ -69,22 +69,14 @@ module Bridgetown
69
69
  module Converters
70
70
  class Markdown
71
71
  class KramdownParser
72
+ attr_reader :extractions
73
+
72
74
  def initialize(config)
73
- @main_fallback_highlighter = config["highlighter"] || "rouge"
74
75
  @config = config["kramdown"] || {}
75
- @highlighter = nil
76
- setup
77
- load_dependencies
78
- end
79
-
80
- # Setup and normalize the configuration:
81
- # * Create Kramdown if it doesn't exist.
82
- # * Set syntax_highlighter
83
- # * Make sure `syntax_highlighter_opts` exists.
84
- def setup
85
- @config["syntax_highlighter"] ||= highlighter
76
+ @config["syntax_highlighter"] ||= config["highlighter"] || "rouge"
86
77
  @config["syntax_highlighter_opts"] ||= {}
87
78
  @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
79
+ require "kramdown-parser-gfm" if @config["input"] == "GFM"
88
80
  end
89
81
 
90
82
  def convert(content)
@@ -95,34 +87,9 @@ module Bridgetown
95
87
  Bridgetown.logger.warn "Kramdown warning:", warning
96
88
  end
97
89
  end
90
+ @extractions = document.root.options[:extractions] # could be nil
98
91
  html_output
99
92
  end
100
-
101
- private
102
-
103
- def load_dependencies
104
- require "kramdown-parser-gfm" if @config["input"] == "GFM"
105
-
106
- # `mathjax` emgine is bundled within kramdown-2.x and will be handled by
107
- # kramdown itself.
108
- if (math_engine = @config["math_engine"]) && math_engine != "mathjax"
109
- Bridgetown::External.require_with_graceful_fail("kramdown-math-#{math_engine}")
110
- end
111
- end
112
-
113
- # config[kramdown][syntax_higlighter] >
114
- # config[highlighter]
115
- def highlighter
116
- return @highlighter if @highlighter
117
-
118
- if @config["syntax_highlighter"]
119
- return @highlighter = @config[
120
- "syntax_highlighter"
121
- ]
122
- end
123
-
124
- @highlighter = @main_fallback_highlighter
125
- end
126
93
  end
127
94
  end
128
95
  end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Bridgetown
4
+ module Converters
5
+ class RubyTemplates < Converter
6
+ priority :highest
7
+ input :rb
8
+
9
+ def convert(content, convertible)
10
+ erb_view = Bridgetown::ERBView.new(convertible)
11
+ erb_view.instance_eval(
12
+ content, convertible.relative_path.to_s, line_start(convertible)
13
+ ).to_s
14
+ end
15
+ end
16
+ end
17
+ end
@@ -25,7 +25,9 @@ module Bridgetown
25
25
  priority :low
26
26
 
27
27
  def initialize(config)
28
- Bridgetown::External.require_with_graceful_fail "kramdown" unless defined?(Kramdown)
28
+ unless defined?(Kramdown)
29
+ Bridgetown::Utils::RequireGems.require_with_graceful_fail "kramdown"
30
+ end
29
31
  @config = config["kramdown"].dup || {}
30
32
  @config[:input] = :SmartyPants
31
33
  end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Bridgetown
4
+ module CoreExt
5
+ module Psych
6
+ module SafeLoadFile
7
+ def safe_load_file(filename, **kwargs)
8
+ File.open(filename, "r:bom|utf-8") do |f|
9
+ if RUBY_VERSION.start_with?("2.5")
10
+ safe_load f, kwargs[:permitted_classes], [], false, filename
11
+ else
12
+ safe_load f, filename: filename, **kwargs
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,10 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Bridgetown
4
+ class Current < ActiveSupport::CurrentAttributes
5
+ # @!method self.site
6
+ # @return [Bridgetown::Site]
7
+
8
+ attribute :site
9
+ end
10
+ end
@@ -1,6 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Bridgetown
4
+ # TODO: to be retired once the Resource engine is made official
4
5
  class Document
5
6
  extend Forwardable
6
7
  include DataAccessible
@@ -52,7 +53,7 @@ module Bridgetown
52
53
  @has_yaml_header = nil
53
54
 
54
55
  data.default_proc = proc do |_, key|
55
- site.frontmatter_defaults.find(relative_path, type, key)
56
+ site.frontmatter_defaults.find(relative_path, type, key.to_s)
56
57
  end
57
58
 
58
59
  trigger_hooks(:post_init)
@@ -81,7 +82,7 @@ module Bridgetown
81
82
  #
82
83
  # Return document date string.
83
84
  def date
84
- data["date"] ||= site.time
85
+ data["date"] ||= site.time # TODO: this doesn't reflect documented behavior
85
86
  end
86
87
 
87
88
  # Return document file modification time in the form of a Time object.
@@ -223,7 +224,7 @@ module Bridgetown
223
224
  Bridgetown.logger.debug "Reading:", relative_path
224
225
 
225
226
  if yaml_file?
226
- @data = SafeYAML.load_file(path)
227
+ @data = YAMLParser.load_file(path)
227
228
  else
228
229
  begin
229
230
  merge_defaults
@@ -357,7 +358,7 @@ module Bridgetown
357
358
  self.content = File.read(path, **Utils.merged_file_read_opts(site, opts))
358
359
  if content =~ YAML_FRONT_MATTER_REGEXP
359
360
  self.content = $POSTMATCH
360
- data_file = SafeYAML.load(Regexp.last_match(1))
361
+ data_file = YAMLParser.load(Regexp.last_match(1))
361
362
  merge_data!(data_file, source: "YAML front matter") if data_file
362
363
  end
363
364
  end
@@ -402,21 +403,13 @@ module Bridgetown
402
403
  end
403
404
 
404
405
  def populate_categories
405
- categories = Array(data["categories"]) + Utils.pluralized_array_from_hash(
406
- data, "category", "categories"
407
- )
408
- categories.map!(&:to_s)
409
- categories.flatten!
410
- categories.uniq!
411
-
412
- merge_data!({ "categories" => categories })
406
+ data.categories = Utils.pluralized_array_from_hash(
407
+ data, :category, :categories
408
+ ).map(&:to_s)
413
409
  end
414
410
 
415
411
  def populate_tags
416
- tags = Utils.pluralized_array_from_hash(data, "tag", "tags")
417
- tags.flatten!
418
-
419
- merge_data!({ "tags" => tags })
412
+ data.tags = Utils.pluralized_array_from_hash(data, :tag, :tags)
420
413
  end
421
414
 
422
415
  def determine_locale
@@ -8,7 +8,7 @@ module Bridgetown
8
8
  mutable false
9
9
 
10
10
  def_delegator :@obj, :write?, :output
11
- def_delegators :@obj, :label, :docs, :files, :relative_path
11
+ def_delegators :@obj, :label, :docs, :files, :relative_path, :resources, :static_files
12
12
 
13
13
  private def_delegator :@obj, :metadata, :fallback_data
14
14
 
@@ -9,6 +9,10 @@ module Bridgetown
9
9
 
10
10
  def_delegators :@obj, :content, :dir, :name, :path, :url, :pager
11
11
  private def_delegator :@obj, :data, :fallback_data
12
+
13
+ def relative_url
14
+ @obj.relative_url
15
+ end
12
16
  end
13
17
  end
14
18
  end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Bridgetown
4
+ module Drops
5
+ class RelationsDrop < Drop
6
+ mutable false
7
+
8
+ def [](type)
9
+ return nil unless type.to_s.in?(@obj.relation_types)
10
+
11
+ @obj.resources_for_type(type)
12
+ end
13
+
14
+ def key?(type)
15
+ type.to_s.in?(@obj.relation_types)
16
+ end
17
+
18
+ def fallback_data
19
+ {}
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,83 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Bridgetown
4
+ module Drops
5
+ class ResourceDrop < Drop
6
+ extend Forwardable
7
+
8
+ NESTED_OBJECT_FIELD_BLACKLIST = %w(
9
+ content output excerpt next previous
10
+ ).freeze
11
+
12
+ mutable false
13
+
14
+ def_delegator :@obj, :relative_path, :path
15
+ def_delegators :@obj,
16
+ :id,
17
+ :data,
18
+ :output,
19
+ :content,
20
+ :to_s,
21
+ :absolute_url,
22
+ :relative_path,
23
+ :relative_url,
24
+ :date,
25
+ :taxonomies,
26
+ :relations
27
+
28
+ private def_delegator :@obj, :data, :fallback_data
29
+
30
+ def collection
31
+ @collection ||= @obj.collection.to_liquid
32
+ end
33
+
34
+ def excerpt
35
+ fallback_data["excerpt"].to_s
36
+ end
37
+
38
+ def <=>(other)
39
+ return nil unless other.is_a? ResourceDrop
40
+
41
+ cmp = self["date"] <=> other["date"]
42
+ cmp = self["path"] <=> other["path"] if cmp.nil? || cmp.zero?
43
+ cmp
44
+ end
45
+
46
+ def previous
47
+ @previous ||= @obj.previous_resource.to_liquid
48
+ end
49
+
50
+ def next
51
+ @next ||= @obj.previous_resource.to_liquid
52
+ end
53
+
54
+ # Generate a Hash for use in generating JSON.
55
+ # This is useful if fields need to be cleared before the JSON can generate.
56
+ #
57
+ # state - the JSON::State object which determines the state of current processing.
58
+ #
59
+ # Returns a Hash ready for JSON generation.
60
+ def hash_for_json(state = nil)
61
+ to_h.tap do |hash|
62
+ # use collection label in the hash
63
+ hash["collection"] = hash["collection"]["label"] if hash["collection"]
64
+
65
+ if state && state.depth >= 2
66
+ hash["previous"] = collapse_document(hash["previous"]) if hash["previous"]
67
+ hash["next"] = collapse_document(hash["next"]) if hash["next"]
68
+ end
69
+ end
70
+ end
71
+
72
+ # Generate a Hash which breaks the recursive chain.
73
+ # Certain fields which are normally available are omitted.
74
+ #
75
+ # Returns a Hash with only non-recursive fields present.
76
+ def collapse_document(doc)
77
+ doc.keys.each_with_object({}) do |(key, _), result|
78
+ result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
79
+ end
80
+ end
81
+ end
82
+ end
83
+ end
@@ -7,35 +7,53 @@ module Bridgetown
7
7
 
8
8
  mutable false
9
9
 
10
- def_delegator :@obj, :data
11
- def_delegators :@obj, :locale, :time, :pages, :static_files, :tags, :categories
10
+ def_delegators :@obj,
11
+ :data,
12
+ :locale,
13
+ :time,
14
+ :pages,
15
+ :generated_pages,
16
+ :static_files,
17
+ :tags,
18
+ :categories,
19
+ :taxonomies,
20
+ :taxonomy_types
12
21
 
13
22
  private def_delegator :@obj, :config, :fallback_data
14
23
 
15
24
  attr_writer :current_document
16
25
 
17
26
  def [](key)
18
- if key != "posts" && @obj.collections.key?(key)
19
- @obj.collections[key].docs
20
- else
21
- super(key)
27
+ if !@obj.uses_resource? && !%w(posts data).freeze.include?(key) &&
28
+ @obj.collections.key?(key)
29
+ return @obj.collections[key].docs
22
30
  end
31
+
32
+ super(key)
23
33
  end
24
34
 
25
35
  def key?(key)
26
- (key != "posts" && @obj.collections.key?(key)) || super
36
+ (!@obj.uses_resource? && key != "posts" && @obj.collections.key?(key)) || super
37
+ end
38
+
39
+ def uses_resource
40
+ @obj.uses_resource?
27
41
  end
28
42
 
29
43
  def posts
30
- @site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
44
+ unless @obj.uses_resource?
45
+ @site_posts ||= @obj.collections.posts.docs.sort { |a, b| b <=> a }
46
+ end
31
47
  end
32
48
 
49
+ # TODO: deprecate before v1.0
33
50
  def html_pages
34
51
  @site_html_pages ||= @obj.pages.select do |page|
35
52
  page.html? || page.url.end_with?("/")
36
53
  end
37
54
  end
38
55
 
56
+ # TODO: deprecate before v1.0
39
57
  def collections
40
58
  @site_collections ||= @obj.collections.values.sort_by(&:label).map(&:to_liquid)
41
59
  end
@@ -50,6 +68,10 @@ module Bridgetown
50
68
  @documents ||= @obj.documents
51
69
  end
52
70
 
71
+ def resources
72
+ @resources ||= @obj.resources
73
+ end
74
+
53
75
  def contents
54
76
  @contents ||= @obj.contents
55
77
  end
@@ -58,6 +80,9 @@ module Bridgetown
58
80
  @site_metadata ||= @obj.data["site_metadata"]
59
81
  end
60
82
 
83
+ # TODO: change this so you *do* use site.config...aka site.config.timezone,
84
+ # not site.timezone
85
+ #
61
86
  # return nil for `{{ site.config }}` even if --config was passed via CLI
62
87
  def config; end
63
88
  end