phlex 2.0.0.beta2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46379514e0705957409d87f74668c2f012e03d5a48fe14f41b4100172b0672c0
-  data.tar.gz: c4ddfa6b1c8eabfc66534abb52ca6fbe543db4d41ddf529b50fc8d0cd3393f63
+  metadata.gz: 4a6338c8f3742ef6e6bc493e259ba3681d9a651e79c067e030e4aaba8b889396
+  data.tar.gz: b0f21d0994c3ec89bb16f4037997e1327e068e7dce4b9b9bad2355df95f40de8
 SHA512:
-  metadata.gz: 9aa416b84741e68ee9429b11c2cd2fc9dc2986ae4cc15eefff126b5f53e177aad9129cdc1349e827e54aef5c5a26f08f12017e3d200b98c5930130c4c13883fc
-  data.tar.gz: fc0cd1de6ab7d6a6f1b76447fad84a263c9cda0ce7e0a9f4313b579c38b7246a4704a02fd183bc0b29bdc171f374070aed0e0c2933f6e06388e58696f58f2565
+  metadata.gz: ff0f545fe87d54db6170264df314eaf9190a1ac5718fc66e905b295c66771b61bcf76a302c94df85d1242ba804790707bb387867e25685c112e402516fb2a58e
+  data.tar.gz: 9b4b4615a772814e0b2bb9774802832bd007dd61a08ef5145e750fd43a5984327664050462e6f2cb82f57c9dc46d0d3858d29aa09404c62c9aa1d381c9b32b94

data/README.md

@@ -2,21 +2,18 @@
 
 Phlex lets you compose web views in pure Ruby.
 
-- [1.0 Stable Docs](https://www.phlex.fun)
-- [2.0 Beta Docs](https://beta.phlex.fun)
+- [v1 Stable Docs](https://www.phlex.fun)
+- [v2 Beta Docs](https://beta.phlex.fun)
 
-## Maintenance schedule
+## Versioning and Maintenance
 
-### Bug fixes
+Phlex does not follow semantic versioning (SemVer). Instead, we follow [BreakVer](https://www.taoensso.com/break-versioning).
 
-- Only the latest minor version of each major version will receive bug fixes
-- We may choose to fix bugs by releasing a new minor version rather than patching the existing minor version
-- Major versions will stop receiving bug fixes one year after the next major version is released
+When a security issue is brought to our attention, we aim to release patches as soon as possible. We aim to patch with a new `non-breaking` version:
 
-### Security patches
-
-- When a security issue is brought to our attention, we aim to release patches for any minor version that was released in the last year.
-- Additionally, the latest minor version of the latest major version will receive security patches, even if that version is over a year old.
+- every `minor` version that was released in the last year;
+- the latest `minor` version of the latest two `major` versions, even if over a year old; and
+- the `main` branch in GitHub.
 
 ## Prior Art 🎨
 

data/lib/phlex/context.rb

@@ -2,18 +2,19 @@
 
 # @api private
 class Phlex::Context
-	def initialize(user_context = {})
+	def initialize(user_context: {}, view_context: nil)
 		@buffer = +""
 		@capturing = false
 		@user_context = user_context
 		@fragments = nil
 		@in_target_fragment = false
 		@halt_signal = nil
+		@view_context = view_context
 	end
 
 	attr_accessor :buffer, :capturing, :user_context, :in_target_fragment
 
-	attr_reader :fragments
+	attr_reader :fragments, :view_context
 
 	def target_fragments(fragments)
 		@fragments = fragments.to_h { |it| [it, true] }

data/lib/phlex/csv.rb

@@ -9,13 +9,12 @@ class Phlex::CSV
 		@_headers = []
 		@_current_row = []
 		@_current_column_index = 0
-		@_view_context = nil
 		@_first = true
 	end
 
 	attr_reader :collection
 
-	def call(buffer = +"", view_context: nil)
+	def call(buffer = +"", context: nil)
 		unless escape_csv_injection? == true || escape_csv_injection? == false
 			raise <<~MESSAGE
 				You need to define escape_csv_injection? in #{self.class.name}, returning either `true` or `false`.
@@ -40,8 +39,6 @@ class Phlex::CSV
 			MESSAGE
 		end
 
-		@_view_context = view_context
-
 		each_item do |record|
 			yielder(record) do |*args, **kwargs|
 				view_template(*args, **kwargs)
@@ -73,12 +70,12 @@ class Phlex::CSV
 
 	def column(header = nil, value)
 		if @_first
-			@_headers << escape(header)
+			@_headers << __escape__(header)
 		elsif header != @_headers[@_current_column_index]
 			raise "Inconsistent header."
 		end
 
-		@_current_row << escape(value)
+		@_current_row << __escape__(value)
 		@_current_column_index += 1
 	end
 
@@ -105,11 +102,7 @@ class Phlex::CSV
 		nil
 	end
 
-	def helpers
-		@_view_context
-	end
-
-	def escape(value)
+	def __escape__(value)
 		value = trim_whitespace? ? value.to_s.strip : value.to_s
 		first_char = value[0]
 		last_char = value[-1]

data/lib/phlex/error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+# @api private
 module Phlex::Error
 end

data/lib/phlex/fifo.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# @api private
 class Phlex::FIFO
 	def initialize(max_bytesize: 2_000, max_value_bytesize: 2_000)
 		@store = {}

data/lib/phlex/helpers.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+# @api private
 module Phlex::Helpers
 	private
 
-	# @return [Hash]
 	def mix(*args)
 		args.each_with_object({}) do |object, result|
 			result.merge!(object) do |_key, old, new|