classlist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0623abc0509ba65bd66bc3147ee059f7d6424f082e21867031998fa66469b1f7
+  data.tar.gz: b9c6713cebf59a58ab5a436db88249601e04fe24b8bc553775675ffdebb44361
+SHA512:
+  metadata.gz: 4fec82f539a407cf44e97beb4b83d60caf72c48ed3818e56c3900e19d53a31497729887a1f14f62fe4ffd68a7e7bb32665893d15d2fe2d9777b7469f7f9fcbb1
+  data.tar.gz: c8bc4baae23c82f8291fb78ed0da3a251aace747016a510304021413b8e6855bcf192fe38703eb47fd213107ae6dd82b02509b3be2bf6ebf34346c963a773af7

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Everything :)

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in classlist.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+
+gem "standard", "~> 1.3"

data/README.md

@@ -0,0 +1,35 @@
+# Classlist
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/classlist`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'classlist'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install classlist
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/koppen/classlist.

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: %i[test standard]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "classlist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/classlist.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/classlist/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "classlist"
+  spec.version = Classlist::VERSION
+  spec.authors = ["Jakob Skjerning"]
+  spec.email = ["jakob@mentalized.net"]
+
+  spec.summary = "Ruby implementation of the Element.classList DOM API"
+  spec.description = "Serverside manipulation of lists of CSS classnames that play nicely with View Components."
+  spec.homepage = "https://github.com/substancelab/classlist"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/classlist/version.rb

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

data/lib/classlist.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "classlist/version"
+
+class Classlist
+  class Error < StandardError; end
+
+  attr_reader :entries
+
+  # Adds the given tokens to the list, omitting any that are already present.
+  def add(tokens)
+    entries = build_entries(tokens)
+    entries.each do |entry|
+      self.entries.push(entry) unless self.entries.include?(entry)
+    end
+  end
+
+  def initialize(entries = [])
+    @entries = build_entries(entries)
+  end
+
+  # Removes the specified tokens from the classlist, ignoring any that are not
+  # present.
+  def remove(tokens)
+    entries = build_entries(tokens)
+    entries.each do |entry|
+      self.entries.delete(entry)
+    end
+  end
+
+  # Replaces an existing token with a new token. If the first token doesn't
+  # exist, #replace returns false immediately, without adding the new token to
+  # the token list.
+  def replace(old_token, new_token)
+    return false unless entries.include?(old_token)
+
+    if entries.include?(new_token)
+      entries.delete(old_token)
+    else
+      index = entries.index(old_token)
+      entries[index] = new_token
+    end
+
+    true
+  end
+
+  def to_a
+    entries
+  end
+
+  def to_s
+    entries.join(" ")
+  end
+
+  # Removes an existing token from the list and returns false. If the token
+  # doesn't exist it's added and the function returns true.
+  #
+  # If force is included, it turns the toggle into a one way-only operation. If
+  # set to false, then token will only be removed, but not added. If set to
+  # true, then token will only be added, but not removed.
+  def toggle(token, force = nil)
+    if entries.include?(token)
+      entries.delete(token) unless force == true
+      result = false
+    else
+      entries.push(token) unless force == false
+      result = true
+    end
+
+    if force.nil?
+      result
+    else
+      force
+    end
+  end
+
+  private
+
+  attr_writer :entries
+
+  def build_entries(entries)
+    case entries
+    when Array
+      entries
+    when Classlist
+      entries.entries
+    when NilClass
+      []
+    when String
+      entries.split(" ")
+    else
+      raise Error, "Invalid entries: #{entries.inspect}"
+    end
+  end
+end

data/sig/classlist.rbs

@@ -0,0 +1,4 @@
+module Classlist
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: classlist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakob Skjerning
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-29 00:00:00.000000000 Z
+dependencies: []
+description: Serverside manipulation of lists of CSS classnames that play nicely with
+  View Components.
+email:
+- jakob@mentalized.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- classlist.gemspec
+- lib/classlist.rb
+- lib/classlist/version.rb
+- sig/classlist.rbs
+homepage: https://github.com/substancelab/classlist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/substancelab/classlist
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Ruby implementation of the Element.classList DOM API
+test_files: []