phlex 2.0.0.beta2 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46379514e0705957409d87f74668c2f012e03d5a48fe14f41b4100172b0672c0
-  data.tar.gz: c4ddfa6b1c8eabfc66534abb52ca6fbe543db4d41ddf529b50fc8d0cd3393f63
+  metadata.gz: 35bbefcf5b9f49f4082f7b92e949e0dd5c13bb39fb65d435563ce6d93b8b002e
+  data.tar.gz: b5455009b59c52b2dc18364adcb4907dd17295b2fac82c42ee76dbe98106889c
 SHA512:
-  metadata.gz: 9aa416b84741e68ee9429b11c2cd2fc9dc2986ae4cc15eefff126b5f53e177aad9129cdc1349e827e54aef5c5a26f08f12017e3d200b98c5930130c4c13883fc
-  data.tar.gz: fc0cd1de6ab7d6a6f1b76447fad84a263c9cda0ce7e0a9f4313b579c38b7246a4704a02fd183bc0b29bdc171f374070aed0e0c2933f6e06388e58696f58f2565
+  metadata.gz: 5f9a7b014d2821888a97afe5d822dcc04acede2623cfd2ac84d2ee9eb68aff30cf8e571b81d3c54cf3b344d06ea96de6f95b9a37213d5bb5acf805393150dccb
+  data.tar.gz: 1e940060016ea5d3ecf707bf33d0ad70ebb43e576825cb477be4a091eeec00787530cf8fb315e399196ae81c3cc88d8059e38ef6eeaeb816843f576a6124dc63

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/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,12 +1,13 @@
 # frozen_string_literal: true
 
+# @api private
 class Phlex::FIFO
 	def initialize(max_bytesize: 2_000, max_value_bytesize: 2_000)
 		@store = {}
 		@max_bytesize = max_bytesize
 		@max_value_bytesize = max_value_bytesize
 		@bytesize = 0
-		@mutex = Mutex.new
+		@mutex = Monitor.new
 	end
 
 	attr_reader :bytesize, :max_bytesize
@@ -19,7 +20,7 @@ class Phlex::FIFO
 
 	def [](key)
 		k, v = @store[key.hash]
-		v if k == key
+		v if k.eql?(key)
 	end
 
 	def []=(key, value)
@@ -31,7 +32,7 @@ class Phlex::FIFO
 			# Check the key definitely doesn't exist now we have the lock
 			return if @store[digest]
 
-			@store[digest] = [key, value]
+			@store[digest] = [key, value].freeze
 			@bytesize += value.bytesize
 
 			while @bytesize > @max_bytesize
@@ -44,4 +45,11 @@ class Phlex::FIFO
 	def size
 		@store.size
 	end
+
+	def clear
+		@mutex.synchronize do
+			@store.clear
+			@bytesize = 0
+		end
+	end
 end

data/lib/phlex/fifo_cache_store.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# An extremely fast in-memory cache store that evicts keys on a first-in-first-out basis.
+class Phlex::FIFOCacheStore
+	def initialize(max_bytesize: 2 ** 20)
+		@fifo = Phlex::FIFO.new(
+			max_bytesize:,
+			max_value_bytesize: max_bytesize
+		)
+	end
+
+	def fetch(key)
+		fifo = @fifo
+		key = map_key(key)
+
+		if (result = fifo[key])
+			JSON.parse(result)
+		else
+			result = yield
+
+			fifo[key] = JSON.fast_generate(result)
+
+			result
+		end
+	end
+
+	def clear
+		@fifo.clear
+	end
+
+	private
+
+	def map_key(value)
+		case value
+		when Array
+			value.map { |it| map_key(it) }
+		when Hash
+			value.to_h { |k, v| [map_key(k), map_key(v)].freeze }
+		when String, Symbol, Integer, Float, Time, true, false, nil
+			value
+		else
+			if value.respond_to?(:cache_key)
+				map_key(value.cache_key)
+			else
+				raise ArgumentError.new("Invalid cache key: #{value.class}")
+			end
+		end
+	end
+end

data/lib/phlex/helpers.rb

@@ -1,13 +1,13 @@
 # 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|
-				case [old, new]
+				case [old, new].freeze
 				in [Array, Array] | [Set, Set]
 					old + new
 				in [Array, Set]