classlist 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b46ec60d2055c6c957a429f49af57adf78b063f933334cdac92d9b62a669f6f
-  data.tar.gz: b1ead5e0df053f41a9faf85d4b02345910e9efe5479ec5cb483eba116aae0975
+  metadata.gz: 6dc0fe88b3aa27f1379a8bec855ba61dc1127f182024e380d2f55261519836c8
+  data.tar.gz: e039d28895c840821f6894771f5219746fd2ac82c4220154946d22d432a30fc8
 SHA512:
-  metadata.gz: 2012cbfeea055153c58050c0e6061157bca4228c97372cddb5b7c0072abac3969c9fb20be3ef8e30c56d58845aa9c521e2b4f2b787d3c0a9c8d3bfc7afa28a41
-  data.tar.gz: 84a6d60146e626e2e0cef6cc6b4b31a72e459d1dcbe01848ebeb5bf4907d0eb04c78c50564c10dfdab53099aecd18a9055b447f13c88be9aaa890c1c36cfdc21
+  metadata.gz: f789382914671c7f40face90cf54129706e0fb4b420524e8068ead6cababc36c5b5c8894fe5639339c64e34a24c39b222c1c7df6a8b02b665d3306484f949090
+  data.tar.gz: 74ec1b884e31914dccaf7f7b4a3251bbcdcdb78df12a9605467c399b255ddbac1114349b643b6baacd3bf48779cad04e93565fd0c681589d2c6a18cd86805587

data/CHANGELOG.md

@@ -9,7 +9,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--
+### Fixed
+
+
+## [1.1.1] - 2025-12-08
+
+### Added
+
+- LICENSE file.
+- Code of Conduct.
+- Add support for Ruby 3.2, 3.3, 3.4 (no changes).
+
+### Fixed
+
+- Adding a raw `Classlist` to a set of `Classlist::Operation`s would merge the `Classlist` into the last operation, instead of treating the `Classlist` as an implicit `Classlist::Add` operation (which it should be).
+
+## [1.1.0] - 2022-11-07
+
+### 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+jakob@substancelab.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Substance Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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.1"
 end

data/lib/classlist.rb

@@ -10,25 +10,38 @@ class Classlist
   class Error < StandardError; end
 
   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)
-    else
-      entries + build_entries(other)
+    # When adding a basic Classlist to an existing list, assume an Add operation
+    if other.is_a?(Classlist) && !other.is_a?(Classlist::Operation)
+      other = Classlist::Add.new(other.entries.dup)
     end
 
-    Classlist.new(result)
+    case other
+    when Classlist::Operation
+      add_operation(other)
+      self
+    when Classlist
+      result = other.merge(self)
+      Classlist.new(result)
+    else
+      result = entries + build_entries(other)
+      Classlist.new(result)
+    end
   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 +52,10 @@ class Classlist
     end
   end
 
+  def add_operation(other)
+    @operations << other
+  end
+
   def include?(token)
     entries.include?(token)
   end
@@ -46,6 +63,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 +109,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,13 @@
 --- !ruby/object:Gem::Specification
 name: classlist
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Jakob Skjerning
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Serverside manipulation of lists of CSS classnames that play nicely with
   View Components.
@@ -21,13 +20,18 @@ files:
 - ".rubocop.yml"
 - ".standard.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - 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
@@ -37,7 +41,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/substancelab/classlist
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby implementation of the Element.classList DOM API
 test_files: []