rexml-css_selector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c991ed27ec6b41e8379c850568907e58fc06408dec1e02eae211a11fec8180b0
+  data.tar.gz: 0a382373b033ca770e4a066baba811fb697444025598a63656c96dbccfac5f05
+SHA512:
+  metadata.gz: b002f7a494d55005b28d4f596074052191fd271333f09a950945b8626b7219620707db3e99fcc149452488b5476d2e3d099b2142734c391e99c659c57581fbd0
+  data.tar.gz: b7cee0862576b898a5fac77d9602dd06086a7382f5f07e576c14fa6b5be05e3a6d021ba2fdf0bd6bf6bf3b935e500e96b9e1e6ee4b0e6ac11f7530b193ac1f36

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

data/.rubocop.yml

@@ -0,0 +1,48 @@
+inherit_gem:
+  syntax_tree: config/rubocop.yml
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Lint/DuplicateBranch:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Lint/UnreachableLoop:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - lib/rexml/css_selector/queries/*.rb
+    - test/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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 make.just.on@gmail.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.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Hiroya Fujinami (a.k.a. TSUYUSATO "MakeNowJust" Kitsune)
+
+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

@@ -0,0 +1,74 @@
+# `REXML::CSSSelector`
+
+> A REXML extension for supporting CSS selector.
+
+## Installation
+
+This library has not been published on RubyGems yet.
+
+You can use this library via GitHub source.
+Please add the following line to your `Gemfile`.
+
+```ruby
+gem 'rexml-css_selector', :git => 'git://github.com/makenowjust/rexml-css_selector.git'
+```
+
+## Usage
+
+The main API of this library is `REXML::CSSSelector.each_select`.
+`REXML::CSSSelector.each_select(scope, selector)` takes two arguments: `scope` is a scope node which it starts matching from, and `selector` is a CSS selector string.
+Then, it calls the given block with a matched node.
+
+See the example.
+
+```ruby
+require "rexml/document"
+require "rexml/css_selector"
+
+# From https://www.w3schools.com/xml/note.xml.
+doc = REXML::Document.new(<<~XML)
+  <?xml version="1.0" encoding="UTF-8"?>
+  <note>
+    <script/>
+    <to>Tove</to>
+    <from>Jani</from>
+    <heading>Reminder</heading>
+    <body>Don't forget me this weekend!</body>
+  </note>
+  XML
+
+# "script ~ *" selects sibling elements after a `<script>` tag.
+REXML::CSSSelector.each_select(doc, "script ~ *") do |element|
+  p element
+end
+
+# Output:
+# <to> ... </>
+# <from> ... </>
+# <heading> ... </>
+# <body> ... </>
+```
+
+This library also provides the following APIs:
+
+- `REXML::CSSSelector.select(scope, selector)`: Returns the first matched element.
+- `REXML::CSSSelector.select_all(scope, selector)`: Returns an array of matched elements.
+- `REXML::CSSSelector.is(node, selector, scope: node.document)`: Checks whether `node` matches `selector` from `scope`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/makenowjust/rexml-css_selector>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/makenowjust/rexml-css_selector/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rexml::Css::Selector project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/makenowjust/rexml-css_selector/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "rdoc/task"
+require "rubocop/rake_task"
+require "syntax_tree/rake_tasks"
+
+Minitest::TestTask.create
+
+RDoc::Task.new do |t|
+  t.main = "README.md"
+  t.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+RuboCop::RakeTask.new { |t| t.options = %w[--fail-level W] }
+
+[SyntaxTree::Rake::WriteTask, SyntaxTree::Rake::CheckTask].each do |task|
+  task.new do |t|
+    t.source_files =
+      FileList[%w[Gemfile Rakefile *.gemspec bin/**/{console,rake} lib/**/*.rb test/**/*.rb example/**/*.rb]]
+    t.print_width = 120
+  end
+end
+
+task format: %w[rubocop:autocorrect_all stree:write]
+task lint: %w[rubocop stree:check]

data/example/prism.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "prism"
+require "rexml/css_selector"
+require "rexml/css_selector/adapters/prism_adapter"
+
+program = Prism.parse(File.read(__FILE__)).value
+doc = REXML::CSSSelector::Adapters::PrismAdapter::PrismDOM.new(program)
+adapter = REXML::CSSSelector::Adapters::PrismAdapter::INSTANCE
+
+REXML::CSSSelector.each_select(doc, 'call[name="require"] > arguments > string:first-child', adapter:) do |element|
+  p element.node.content
+end

data/lib/rexml/css_selector/adapters/prism_adapter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module REXML
+  module CSSSelector
+    module Adapters
+      class PrismAdapter < BaseAdapter
+        class PrismDOM
+          def initialize(node, parent: nil, document: nil, index: 0)
+            @node = node
+            @parent = parent
+            @document = document || self
+            @index = index
+          end
+
+          attr_reader :node, :parent, :document
+
+          def type
+            @node.type.to_s.gsub(/_node$/, "")
+          end
+
+          def attribute(name)
+            @node.deconstruct_keys([])[name.intern]&.to_s
+          end
+
+          def children
+            @children ||=
+              begin
+                children = []
+                @node.compact_child_nodes.each_with_index do |child, index|
+                  children << PrismDOM.new(child, parent: self, document:, index:)
+                end
+                children
+              end
+          end
+
+          def previous_sibling
+            return if index.zero?
+            parent.children[index - 1]
+          end
+        end
+
+        def element?(node)
+          node.is_a?(PrismDOM)
+        end
+
+        def get_tag_name(element)
+          element.type
+        end
+
+        def get_attribute(element, name, _namespace = nil, _attribute_name_case = :sensitive)
+          element.attribute(name)
+        end
+
+        def get_document_node(element)
+          element.document
+        end
+
+        def get_parent_node(element)
+          element.parent
+        end
+
+        def get_previous_sibling_element(element)
+          element.previous_sibling
+        end
+
+        def each_child_element(element, &)
+          element.children.each(&)
+        end
+
+        # INSTANCE is the default instance.
+        INSTANCE = new
+      end
+    end
+  end
+end

data/lib/rexml/css_selector/adapters/rexml_adapter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module REXML
+  module CSSSelector
+    module Adapters
+      # REXMLAdapter is an adapter implementation for +REXML+.
+      class REXMLAdapter < BaseAdapter
+        def element?(node)
+          node.instance_of?(::REXML::Element)
+        end
+
+        def empty?(node)
+          node.children.all? do |child|
+            case child
+            when ::REXML::Element
+              false
+            when ::REXML::Text
+              child.to_s.match?(/\A\s*\z/)
+            else
+              true
+            end
+          end
+        end
+
+        def get_tag_name(element)
+          element.name
+        end
+
+        def get_namespace(element)
+          element.prefix
+        end
+
+        def get_attribute(element, name, namespace = nil, attribute_name_case = :sensitive)
+          namespace = element.namespace(namespace) if namespace
+
+          case attribute_name_case
+          in :sensitive
+            element.attribute(name, namespace)&.value
+          in :insensitive
+            name = name.downcase(:ascii)
+            target_attr = nil
+            element.attributes.each_attribute do |attr|
+              if attr.name.downcase(:ascii) == name && (!namespace || attr.namespace == namespace)
+                target_attr = attr
+                break
+              end
+            end
+            target_attr&.value
+          end
+        end
+
+        def get_document_node(node)
+          node.root_node
+        end
+
+        def get_parent_node(element)
+          element.parent
+        end
+
+        def get_previous_sibling_element(element)
+          element.previous_element
+        end
+
+        def each_child_element(element, &)
+          element.each_child { yield _1 if element?(_1) }
+        end
+
+        def each_recursive_element(element, &)
+          element.each_recursive(&)
+        end
+
+        # INSTANCE is the default instance.
+        INSTANCE = new
+      end
+    end
+  end
+end

data/lib/rexml/css_selector/ast.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module REXML
+  module CSSSelector
+    # Complex/compound/relative selectors:
+
+    # SelectorList is a list of selectors.
+    #
+    # This is corresponding to a comma operator (<tt>..., ...</tt>) in CSS selector.
+    SelectorList = Data.define(:selectors)
+
+    # ComplexSelector is a pair of selectors with a combinator.
+    #
+    # This is corresponding to descendant/adjacent/sibling operators in CSS selector.
+    ComplexSelector = Data.define(:left, :combinator, :right)
+
+    # CompoundSelector is a compound selector.
+    CompoundSelector = Data.define(:type, :subclasses, :pseudo_elements)
+
+    # RelativeSelector is a pair of a combinator and a selector.
+    RelativeSelector = Data.define(:combinator, :right)
+
+    # Type selectors:
+
+    # TagNameType is a type selector of a tag name.
+    TagNameType = Data.define(:namespace, :tag_name)
+
+    # UniversalType is the universal type selector (<tt>*</tt>).
+    UniversalType = Data.define(:namespace)
+
+    # Subclass selectors:
+
+    # Id is an ID selector (e.g. <tt>#name</tt>).
+    Id = Data.define(:name)
+
+    # ClassName is a class name selector (e.g. <tt>.name</tt>).
+    ClassName = Data.define(:name)
+
+    # Attribute is an attribute selector (e.g. <tt>[name]</tt>, <tt>[name=value]</tt>).
+    #
+    # If +matcher+, +value+, and +modifier+ is +nil+, it means an attribute presence selector (e.g. <tt>[name]</tt>).
+    #
+    # +matcher+ takes one of the following values:
+    #
+    # - <tt>:"="</tt>
+    # - <tt>:"~="</tt>
+    # - <tt>:"|="</tt>
+    # - <tt>:"^="</tt>
+    # - <tt>:"$="</tt>
+    # - <tt>:"*="</tt>
+    #
+    # +modifier+ takes one of the following values:
+    #
+    # - <tt>:i</tt>
+    # - <tt>:s</tt>
+    # - <tt>nil</tt>
+    Attribute = Data.define(:namespace, :name, :matcher, :value, :modifier)
+
+    # PseudoClass ia a pseudo class selector (e.g. <tt>:first-child</tt>).
+    PseudoClass = Data.define(:name, :argument)
+
+    # Namespace is a namespace in CSS selector.
+    Namespace = Data.define(:name)
+
+    # UniversalNamespace is the universal namespace in CSS selector.
+    UniversalNamespace = Data.define
+
+    # Pseudo element:
+
+    # PseudoElement is a pseudo element.
+    PseudoElement = Data.define(:name, :argument, :pseudo_classes)
+
+    # Arguments:
+
+    # RelativeSelectorList is a list of relative selectors.
+    RelativeSelectorList = Data.define(:selectors)
+
+    # Odd is +odd+ in a <tt>:nth-child</tt> argument.
+    Odd = Data.define
+
+    # Even is +even+ in a <tt>:nth-child</tt> argument.
+    Even = Data.define
+
+    # Nth is <tt>An+B</tt> in a <tt>:nth-child</tt> argument.
+    Nth = Data.define(:a, :b)
+
+    # NthOfSelectorList is <tt>An+B of S</tt> in a <tt>:nth-child</tt> argument.
+    NthOfSelectorList = Data.define(:nth, :selector_list)
+
+    # ValueList is a list of values.
+    ValueList = Data.define(:values)
+
+    # Value:
+
+    # Substitution is a placeholder value which is replaced by +substitutions[name]+ on run-time.
+    Substitution = Data.define(:name)
+
+    # Ident is a ident value.
+    Ident = Data.define(:value)
+
+    # String is a string value.
+    String = Data.define(:value)
+
+    # Bare is a bare value.
+    Bare = Data.define(:value)
+  end
+end

data/lib/rexml/css_selector/base_adapter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module REXML
+  module CSSSelector
+    # BaseAdapter is a base class of adapters.
+    #
+    # An adapter is an abstraction of tree traversal operations for CSS selectors.
+    # We need to implement the following methods minimally:
+    #
+    # - <tt>element?(node)</tt>
+    # - <tt>get_tag_name(element)</tt>
+    # - <tt>get_attribute(element, name, namespace = nil, attribute_name_case = :sensitive)</tt>
+    # - <tt>get_document_node(element)</tt>
+    # - <tt>get_parent_node(element)</tt>
+    # - <tt>get_previous_sibling_node(element)</tt>
+    # - <tt>each_child_element(element, &)</tt>
+    class BaseAdapter
+      # Checks whether +element+ is the root element.
+      #
+      # This method is used for <tt>:root</tt>.
+      def root?(element)
+        get_parent_node(element) == get_document_node(element)
+      end
+
+      # Checks whether +element+ is empty.
+      #
+      # This method is used for <tt>:empty</tt>.
+      def empty?(element)
+        each_child_element(element) { return false }
+        true
+      end
+
+      # Checks whether +element+ is checked.
+      #
+      # This method is used for <tt>:checked</tt>.
+      def checked?(element)
+        !!get_attribute(element, "checked")
+      end
+
+      # Checks whether +element+ is disabled.
+      #
+      # This method is used for <tt>:disabled</tt>.
+      def disabled?(element)
+        !!get_attribute(element, "disabled")
+      end
+
+      # Returns a namespace of +element+.
+      def get_namespace(_element)
+        nil
+      end
+
+      # Returns an array of children elements of +element+.
+      def get_children_elements(element)
+        elements = []
+        each_child_element(element) { elements << _1 }
+        elements
+      end
+
+      # Returns the index of +element+ in the children of +parent+.
+      def get_element_index(parent, element)
+        i = 0
+        each_child_element(parent) do |child|
+          return i if element == child
+          i += 1
+        end
+        nil
+      end
+
+      # Returns class names of +element+.
+      def get_class_names(element)
+        get_attribute(element, "class")&.split(/\s+/) || []
+      end
+
+      # Returns the ID name of +element+.
+      def get_id(element)
+        get_attribute(element, "id")
+      end
+
+      # Enumerates the elements in +element+
+      def each_recursive_element(element, &)
+        each_child_element(element) do |child|
+          yield child
+          each_recursive_element(child, &)
+        end
+      end
+    end
+  end
+end