classlist 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b46ec60d2055c6c957a429f49af57adf78b063f933334cdac92d9b62a669f6f
-  data.tar.gz: b1ead5e0df053f41a9faf85d4b02345910e9efe5479ec5cb483eba116aae0975
+  metadata.gz: 13b03b38d0d38240cdabd34d10b534b811b5b292eea5c4e43eabd24f5ab199dc
+  data.tar.gz: d83e6fac0aacdb375188e2d5b633bc0a3e7f2f758ef1ff6262ac93ca544b8b5a
 SHA512:
-  metadata.gz: 2012cbfeea055153c58050c0e6061157bca4228c97372cddb5b7c0072abac3969c9fb20be3ef8e30c56d58845aa9c521e2b4f2b787d3c0a9c8d3bfc7afa28a41
-  data.tar.gz: 84a6d60146e626e2e0cef6cc6b4b31a72e459d1dcbe01848ebeb5bf4907d0eb04c78c50564c10dfdab53099aecd18a9055b447f13c88be9aaa890c1c36cfdc21
+  metadata.gz: 00bff560b1cd9064b353dd1979f0d5644bbe1e861d6ea0d646e4a25cb16c7eb3ae51b66e49bbcf13fb15531065a6b9d5d4818879088ceca8434174bffc082075
+  data.tar.gz: 418764901609311aea4f245cda2d297110a932402a61aa4999f79955e37e4221f8509b6a91a5f86e168ca7cff62c8b1455b8156be3a97b517d4c81ec3ec92311

data/CHANGELOG.md

@@ -9,7 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--
+- Support for chains of operations longer than the most simple cases.
+- Introduce Classlist::Operation as a common super class for Classlist::Add, Classlist::Remove, Classlist::Reset.
+- Classlist::Add that adds all entries when merged
 
 ## [1.0.0]
 

data/README.md

@@ -8,6 +8,8 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'classlist'
+# or if you don't want to manually require stuff:
+gem 'classlist', require: 'classlist/all'
 ```
 
 And then execute:

data/lib/classlist/add.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "classlist/operation"
+
+# Classlist::Add is an operation that adds tokens to the original
+# classlist when added to it.
+class Classlist::Add < Classlist::Operation
+  def merge(original)
+    original.entries + entries
+  end
+
+  # resolve changes the original classlist
+  def resolve(original)
+    entries.each do |entry|
+      original.add(entry)
+    end
+
+    super
+  end
+end

data/lib/classlist/all.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Require this file to load all of Classlist into your application.
+#
+# For example in a Gemfile:
+#
+#   gem "classlist", require: "classlist/all"
+#
+# Or you can just require what you need manually.
+
+require "classlist/add"
+require "classlist/remove"
+require "classlist/reset"

data/lib/classlist/operation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "classlist"
+
+# Classlist::Operations modify the original classlist
+class Classlist::Operation < Classlist
+  # resolve changes the original classlist
+  def resolve(original_classlist)
+    resolve_operations(original_classlist)
+  end
+end

data/lib/classlist/remove.rb

@@ -1,11 +1,20 @@
 # frozen_string_literal: true
 
-require "classlist"
+require "classlist/operation"
 
-# Classlist::Remove is a classlist that removes tokens from the original
+# Classlist::Remove is an operation that removes tokens from the original
 # classlist when added to it.
-class Classlist::Remove < Classlist
+class Classlist::Remove < Classlist::Operation
   def merge(original)
     original.entries - entries
   end
+
+  # #resolve changes the original classlist
+  def resolve(original)
+    entries.each do |entry|
+      original.remove(entry)
+    end
+
+    super
+  end
 end

data/lib/classlist/reset.rb

@@ -1,11 +1,18 @@
 # frozen_string_literal: true
 
-require "classlist"
+require "classlist/operation"
 
-# Classlist::Reset is a classlist that removes all tokens from the original
+# Classlist::Reset is an operation that removes all tokens from the original
 # classlist when merged.
-class Classlist::Reset < Classlist
+class Classlist::Reset < Classlist::Operation
   def merge(original)
     original.entries.replace(entries)
   end
+
+  # #resolve changes the original classlist
+  def resolve(original)
+    original.entries.replace(entries)
+
+    super
+  end
 end

data/lib/classlist/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Classlist
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/classlist.rb

@@ -12,23 +12,30 @@ class Classlist
   extend Forwardable
   def_delegators :@entries, :each
 
-  attr_reader :entries
+  attr_reader :entries, :operations
 
   # Returns the Classlist resulting from adding other to this classlist.
   def +(other)
-    result = if other.is_a?(Classlist)
-      other.merge(self)
+    case other
+    when Classlist::Operation
+      add_operation(other)
+      self
+    when Classlist
+      result = other.merge(self)
+      Classlist.new(result)
     else
-      entries + build_entries(other)
+      result = entries + build_entries(other)
+      Classlist.new(result)
     end
-
-    Classlist.new(result)
   end
 
   def ==(other)
     return false unless other.is_a?(self.class)
 
-    entries == other.entries
+    resolve_operations(self)
+    other.resolve_operations
+
+    @entries == other.entries
   end
 
   # Adds the given tokens to the list, omitting any that are already present.
@@ -39,6 +46,10 @@ class Classlist
     end
   end
 
+  def add_operation(other)
+    @operations << other
+  end
+
   def include?(token)
     entries.include?(token)
   end
@@ -46,6 +57,7 @@ class Classlist
 
   def initialize(entries = [])
     @entries = build_entries(entries)
+    @operations = []
   end
 
   # Returns the item in the list by its index, or null if the index is greater
@@ -91,12 +103,19 @@ class Classlist
     true
   end
 
+  def resolve_operations(original_classlist = self)
+    operations.each do |operation|
+      operation.resolve(original_classlist)
+    end
+  end
+
   def to_a
-    entries
+    resolve_operations(self)
+    @entries
   end
 
   def to_s
-    entries.join(" ")
+    to_a.join(" ")
   end
   alias_method :value, :to_s
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: classlist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jakob Skjerning
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Serverside manipulation of lists of CSS classnames that play nicely with
   View Components.
@@ -28,6 +28,9 @@ files:
 - bin/setup
 - classlist.gemspec
 - lib/classlist.rb
+- lib/classlist/add.rb
+- lib/classlist/all.rb
+- lib/classlist/operation.rb
 - lib/classlist/remove.rb
 - lib/classlist/reset.rb
 - lib/classlist/version.rb