breeze_icons 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a7c16ac0740573fb72dd34ad987fa23ebde4f04a4b35cb80e1f8705267fb571
+  data.tar.gz: 490d7ec4309f3853610b80cd746205832017a20001b427b5232415bc4ca1c315
+SHA512:
+  metadata.gz: '080a8cf3c544c98a61832b83744c931dfb09f5720dd34ba31ee965a40bc2247a6a275772c2381032fe3f5c6600edfd85b715bcd00e425752931c3236f4fb8eff'
+  data.tar.gz: ac8fbb06b30b95552ef810b0a9e42bdf800169399f477ce958d0b7fa01d875a5894e5465980b98eec98abca059cdea102d2e8767a365cf28ba05145bcce504fb

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-01
+
+- Initial release
+- breeze-icons built from `b090ca463d8fb3fcfd50bb325c7581a67c9528b0`

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 nilsding@nilsding.org. 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/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in breeze_icons.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "nokogiri", "~> 1.15"

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,75 @@
+# breeze-icons-ruby
+
+This gem provides a subset of the excellent
+[KDE Breeze Icons](https://invent.kde.org/frameworks/breeze-icons) as a gem.
+
+It mostly only contains the "symbolic" icons which make it perfect for using it
+on websites without resorting to an icon font.
+
+Inspired by [octicons](https://github.com/primer/octicons/tree/main/lib/octicons_gem).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```sh
+$ bundle add breeze_icons
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```sh
+$ gem install breeze_icons
+```
+
+## Usage
+
+```ruby
+require "breeze_icons"
+icon = BreezeIcons::Icon.new("media-playback-start")
+icon.to_svg
+# <svg class="breeze-icon breeze-icon-media-playback-start" version="1.1" viewBox="0 0 16 16" width="16" height="16" aria-hidden="true"><path d="m2 2v12l12-6z"></path></svg>
+```
+
+## 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).
+
+To update the `breeze_icons` data file run:
+```sh
+rake generate_data_file
+```
+
+To generate a demo page with all the icons the gem supports:
+```sh
+rake generate_demo_page
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/nilsding/breeze-icons-ruby.  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/nilsding/breeze-icons-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[LGPLv3 Licence](https://opensource.org/license/lgpl-3-0/).
+
+The icon data is licensed under the terms of LGPLv3 as per
+https://invent.kde.org/frameworks/breeze-icons/-/blob/master/COPYING-ICONS.
+
+## Code of Conduct
+
+Everyone interacting in the BreezeIcons project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/nilsding/breeze-icons-ruby/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+desc "generate data file"
+task :generate_data_file do
+  require "nokogiri"
+  require "pp"
+
+  breeze_icons_path = File.expand_path("./vendor/breeze-icons/icons", __dir__)
+
+  icons = {
+    icons:   {},
+    aliases: {},
+  }
+
+  puts "==> reading svgs ..."
+  Dir["#{breeze_icons_path}/**/*.svg"].sort.each do |file|
+    icon_name = File.basename(file, ".svg")
+    category, size, *rest = File.dirname(file.delete_prefix("#{breeze_icons_path}/")).split("/")
+
+    if File.symlink?(file)
+      alias_to = File.basename(File.readlink(file), ".svg")
+      icons[:aliases][size] ||= {}
+      icons[:aliases][size][icon_name] ||= alias_to
+      next
+    end
+
+    doc = Nokogiri::XML::Document.parse(File.read(file))
+    path_nodes = doc.css("svg path")
+    unless path_nodes.size == 1
+      # puts "ignoring #{category}/#{size}/#{icon_name} as it has #{path_nodes.size} path nodes"
+      next
+    end
+
+    path = path_nodes.first
+
+    transform = path.parent["transform"]
+    # if the parent group has a transform the path might inverse it
+    transform = nil if transform && path["transform"]
+
+    icons[:icons][size] ||= {}
+    icons[:icons][size][icon_name] = {
+      category:,
+      class:          path["class"],
+      path:           path["d"],
+      stroke_linecap: path["stroke-linecap"],
+      stroke_width:   path["stroke-width"],
+      transform:      transform,
+      view_box:       doc.first_element_child["viewBox"],
+    }.compact
+  end
+
+  puts "==> cleaning up aliases"
+  icons[:aliases].each do |size, aliases|
+    aliases.reject! do |from, to|
+      next false if icons[:icons][size]&.key?(to)
+
+      true
+    end
+  end
+
+  puts "==> generating data file"
+  File.open(File.expand_path("./lib/breeze_icons/data.rb"), "w") do |f|
+    f.puts <<~RUBY
+      # frozen_string_literal: true
+      #
+      # generated by `rake generate_data_file`
+
+      module BreezeIcons
+        module Data
+    RUBY
+    f.print "    ICONS = "
+    PP.pp icons, f
+    f.puts <<~RUBY
+        end
+      end
+    RUBY
+  end
+
+  puts "==> stats"
+  icons[:icons].each do |size, icons|
+    puts "%5s: %5s icons" % [size, icons.size]
+  end
+  icons[:aliases].each do |size, aliases|
+    puts "%5s: %5s aliases" % [size, aliases.size]
+  end
+end
+
+desc "generate a demo page"
+task :generate_demo_page do
+  require_relative "./lib/breeze_icons"
+
+  puts "==> generating demo.html"
+  File.open("./demo.html", "w") do |f|
+    f.puts <<~HTML
+      <!doctype html>
+      <html>
+      <head>
+      <meta charset="utf-8">
+      <title>breeze-icons-ruby showcase</title>
+      <style>
+      @media(prefers-color-scheme: dark) {
+        body {
+          background: #000;
+          color: #fff;
+          fill: #fff; /* this is for the SVG icons */
+        }
+        input {
+          background: #000;
+          color: #fff;
+          border: 1px solid #aaa;
+        }
+      }
+      .iconlist {
+        display: flex;
+        flex-wrap: wrap;
+      }
+      .icon {
+        width: 15em;
+        border: solid 1px;
+        margin: .25em;
+        padding: .25em;
+        text-align: center;
+        height: 15em;
+        overflow-y: scroll;
+      }
+      .icon > tt {
+        font-weight: bold;
+      }
+      .nojs {
+        display: none;
+      }
+      </style>
+      </head>
+      <body>
+      <h1>breeze-icons-ruby showcase</h1>
+      <div class="nojs">
+      filter: <input oninput="filter(this)">
+      <style id="filterstyle"></style>
+      </div>
+      <script>
+      document.querySelectorAll(".nojs").forEach(elem => elem.classList.remove("nojs"));
+      const jsstyle = document.getElementById("filterstyle");
+      function filter(elem)
+      {
+        if (elem.value == "" || elem.value.indexOf('"') > -1)
+        {
+          jsstyle.innerText = "";
+          return;
+        }
+        jsstyle.innerText = `.icon:not([class*="${elem.value}"]) { display: none; }`;
+      }
+      </script>
+    HTML
+
+    data = BreezeIcons::Data::ICONS
+    data[:icons].each do |size, icons|
+      f.puts "<h2>#{size}</h2>"
+      grouped_icons = icons.group_by { _2[:category] }.transform_values(&:to_h)
+      grouped_icons.keys.sort.each do |category|
+        f.puts "<h3>#{category}</h3>"
+        f.puts %(<div class="iconlist">)
+        grouped_icons[category].each_key do |name|
+          aliases = data[:aliases][size]&.select { _2 == name }&.map(&:first)
+          class_list = ["icon", "icon-#{name}", *aliases&.map { "icon-#{_1}" }].compact.join(" ")
+          f.print %(<div class="#{class_list}">)
+          icon = BreezeIcons::Icon.new(name, size:)
+          f.print icon.to_svg
+          f.print "<br><tt>#{name}</tt>"
+          if aliases && !aliases.empty?
+            f.print "<br><small>"
+            f.print aliases.map { "<tt>#{_1}</tt>" }.join("<br>")
+            f.print "</small>"
+          end
+          f.puts "</div>"
+        end
+        f.puts "</div>"
+      end
+    end
+
+    f.puts <<~HTML
+      </body>
+      </html>
+    HTML
+  end
+end
+
+task default: %i[generate_data_file test]