svgeez 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8facbc1352cb5385bccddccaebc6fc1b8957d69bc65fd1834799660969245e3c
-  data.tar.gz: 865945a5ec2c47c8f82929052ea026752bf10adc8a5bf3266a6d091fdfc9710c
+  metadata.gz: 9ec517999af227f154d38ca7c1a785fb061e292601e181213c83a108ffc1ac38
+  data.tar.gz: 389bedd716f094b97b1899afbf1c290a44393d7234ee44d328e5cfd512037cbc
 SHA512:
-  metadata.gz: 7d185bbe236c5fe4e2de87d9bbf30ad9522d5eaf790616cdc2891884d23ac353af92e8df99bebe0d79f192fa3ab8444c1cdc892cec8103ea9ab368bb14f1e581
-  data.tar.gz: 59f69679b6e4b500b2fd2d9972aac40f67ca40009fe9f6a06707ebfdeb8229a02b362ebe99a0f1b3049e816202781d84a994d0c15494fd78d4d21d087ff3c992
+  metadata.gz: bb5f93fde2f014659bf678b4da09866864e84a57d251a04464c03df739055ef09e9a0b5c24f35094a8b147f5c4ad4dbf47a6e6482d27af7e60ab2d38a6f39a6a
+  data.tar.gz: ca874151e7beb400e0819f3ea9ca74ca3489556ee29523d9eada5f3fefabd7eb8ab6374b6cc84b9ac67dd582db633a55e384fbaaa68ae1a657c484e0063d7d82

data/.rubocop.yml

@@ -2,9 +2,8 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
-Layout/HashAlignment:
-  Exclude:
-    - svgeez.gemspec
+AllCops:
+  NewCops: disable
 
 Layout/LineLength:
   Enabled: false
@@ -12,7 +11,6 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
-    - svgeez.gemspec
 
 Naming/RescuedExceptionsVariableName:
   PreferredName: exception

data/.ruby-version

@@ -1 +1 @@
-2.4.9
+2.4.10

data/.simplecov

@@ -2,9 +2,11 @@ require 'simplecov-console'
 
 formatters = [SimpleCov::Formatter::HTMLFormatter]
 
+# rubocop:disable Style/IfUnlessModifier
 if RSpec.configuration.files_to_run.length > 1
   formatters << SimpleCov::Formatter::Console
 end
+# rubocop:enable Style/IfUnlessModifier
 
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter.new(formatters)

data/CHANGELOG.md

@@ -1,31 +1,36 @@
 # Changelog
 
+## 3.2.0 / 2020-08-11
+
+- Add `--prefix` option (#79 and #80)
+- Update development Ruby version to 2.4.10 (8d517c1)
+
 ## 3.1.0 / 2020-01-20
 
-- Expand supported Ruby versions to include 2.7 ([bcc23b5](https://github.com/jgarber623/svgeez/commit/bcc23b5)).
+- Expand supported Ruby versions to include 2.7 (bcc23b5)
 
 ## 3.0.0 / 2019-08-02
 
 ### Breaking Changes
 
-- Bump required minimum SVGO version to 1.3.0 ([afa24c6](https://github.com/jgarber623/svgeez/commit/afa24c6)).
+- Bump required minimum SVGO version to 1.3.0 (afa24c6)
 
 ### Additional Enhancements
 
-- Refactor command classes ([02f420c](https://github.com/jgarber623/svgeez/commit/02f420c)).
-- Refactor specs ([995f950](https://github.com/jgarber623/svgeez/commit/)).
-- Update development dependencies.
+- Refactor command classes (02f420c)
+- Refactor specs ()
+- Update development dependencies
 
 ## 2.0.1 / 2019-01-03
 
-- Expand supported Ruby versions to include 2.6 ([0facfd0](https://github.com/jgarber623/svgeez/commit/0facfd0)).
+- Expand supported Ruby versions to include 2.6 (0facfd0)
 
 ## 2.0.0 / 2018-12-04
 
-- Refactor classes to use `attr_reader`s ([c62780f](https://github.com/jgarber623/svgeez/commit/c62780f))
-- Change required Ruby versions and liberalize dependency constraints ([35fcadb](https://github.com/jgarber623/svgeez/commit/35fcadb))
-- Change project Ruby version to 2.4.9 ([301d341](https://github.com/jgarber623/svgeez/commit/301d341))
-- Bump required SVGO version to 1.1.1 ([28741fc](https://github.com/jgarber623/svgeez/commit/28741fc))
+- Refactor classes to use `attr_reader`s (c62780f)
+- Change required Ruby versions and liberalize dependency constraints (35fcadb)
+- Change project Ruby version to 2.4.9 (301d341)
+- Bump required SVGO version to 1.1.1 (28741fc)
 
 ## Previous Releases
 

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve svgeez:
 
 ## Getting Started
 
-svgeez is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
+svgeez is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
 
-Before making changes to svgeez, you'll want to install Ruby 2.4.9. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.9 using your method of choice, install the project's gems by running:
+Before making changes to svgeez, you'll want to install Ruby 2.4.10. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.10 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/Gemfile

@@ -2,3 +2,13 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in svgeez.gemspec
 gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.89.0'
+gem 'rubocop-performance', '~> 1.7'
+gem 'rubocop-rspec', '~> 1.42'
+gem 'simplecov', '~> 0.18.5'
+gem 'simplecov-console', '~> 0.7.2'

data/README.md

@@ -4,7 +4,7 @@
 
 [![Gem](https://img.shields.io/gem/v/svgeez.svg?style=for-the-badge)](https://rubygems.org/gems/svgeez)
 [![Downloads](https://img.shields.io/gem/dt/svgeez.svg?style=for-the-badge)](https://rubygems.org/gems/svgeez)
-[![Build](https://img.shields.io/travis/jgarber623/svgeez/master.svg?style=for-the-badge)](https://travis-ci.org/jgarber623/svgeez)
+[![Build](https://img.shields.io/travis/jgarber623/svgeez/main.svg?style=for-the-badge)](https://travis-ci.org/jgarber623/svgeez)
 [![Dependencies](https://img.shields.io/depfu/jgarber623/svgeez.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/svgeez)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/svgeez.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez)
 [![Coverage](https://img.shields.io/codeclimate/c/jgarber623/svgeez.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez/code)
@@ -21,7 +21,7 @@ _For more on why SVG sprites are the bee's knees as far as icon systems go, give
 
 ## Getting Started
 
-Before installing and using svgeez, you'll want to have Ruby 2.4 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). svgeez is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
+Before installing and using svgeez, you'll want to have Ruby 2.4 (or newer) installed on your computer. There are plenty of ways to go about this, but my preference is [rbenv](https://github.com/sstephenson/rbenv). svgeez is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.org/jgarber623/svgeez).
 
 ## Installation
 
@@ -67,6 +67,7 @@ The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/
 |:----------------------|:------------------------------------------------------------------|
 | `-s`, `--source`      | Path to folder of source SVGs (defaults to `./_svgeez`).          |
 | `-d`, `--destination` | Path to destination file or folder (defaults to `./svgeez.svg`)   |
+| `-p`, `--prefix`      | Optional prefix to append to generated `id` attribute values      |
 | `--with-svgo`         | Optimize SVG sprite file with [SVGO](https://github.com/svg/svgo) |
 
 ### The `watch` command
@@ -197,7 +198,7 @@ button svg {
 
 ## Improving svgeez
 
-You want to help make svgeez better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/svgeez/blob/master/CONTRIBUTING.md).
+You want to help make svgeez better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/svgeez/blob/main/CONTRIBUTING.md).
 
 ### Donations
 
@@ -223,6 +224,7 @@ svgeez is written and maintained by [Jason Garber](https://sixtwothree.org).
 
 ### Additional Contributors
 
+- [Abhinav Mishra](https://github.com/abhinavmsra)
 - [Brett Wilkins](https://github.com/bwilkins)
 - [danny](https://github.com/f96q)
 - [Denis Hovart](https://github.com/dhovart)

data/lib/svgeez/builder.rb

@@ -4,12 +4,13 @@ module Svgeez
     SOURCE_DOES_NOT_EXIST = 'Provided `source` folder does not exist.'.freeze
     NO_SVGS_IN_SOURCE_MESSAGE = 'No SVGs were found in `source` folder.'.freeze
 
-    attr_reader :source, :destination
+    attr_reader :source, :destination, :prefix
 
     def initialize(options = {})
       @source = Source.new(options)
       @destination = Destination.new(options)
       @svgo = options.fetch('svgo', false)
+      @prefix = options.fetch('prefix', @destination.file_id)
 
       raise SOURCE_IS_DESTINATION_MESSAGE if source_is_destination?
       raise SOURCE_DOES_NOT_EXIST unless source_exists?
@@ -41,7 +42,7 @@ module Svgeez
     private
 
     def destination_file_contents
-      file_contents = Elements::SvgElement.new(source, destination).build
+      file_contents = Elements::SvgElement.new(source, destination, prefix).build
       file_contents = Optimizer.new.optimize(file_contents) if @svgo
 
       file_contents.insert(4, ' style="display: none;"')

data/lib/svgeez/command.rb

@@ -31,6 +31,7 @@ module Svgeez
       def add_options(command)
         command.option 'source', '-s', '--source [FOLDER]', 'Source folder (defaults to ./_svgeez)'
         command.option 'destination', '-d', '--destination [OUTPUT]', 'Destination file or folder (defaults to ./svgeez.svg)'
+        command.option 'prefix', '-p', '--prefix [PREFIX]', 'Custom Prefix for icon id (defaults to destination filename)'
         command.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
       end
     end

data/lib/svgeez/elements/svg_element.rb

@@ -1,9 +1,10 @@
 module Svgeez
   module Elements
     class SvgElement
-      def initialize(source, destination)
+      def initialize(source, destination, prefix)
         @source = source
         @destination = destination
+        @prefix = prefix
       end
 
       def build
@@ -14,7 +15,7 @@ module Svgeez
 
       def symbol_elements
         @source.file_paths.map do |file_path|
-          SymbolElement.new(file_path, @destination.file_id).build
+          SymbolElement.new(file_path, @prefix).build
         end
       end
     end

data/lib/svgeez/elements/symbol_element.rb

@@ -16,8 +16,11 @@ module Svgeez
 
       def element_attributes(attributes)
         attrs = attributes.scan(/(?:viewBox|xmlns:.+?)=".*?"/m)
+        id_prefix = @file_id
+        id_suffix = File.basename(@file_path, '.svg').gsub(/['"\s]/, '-')
+        id_attribute = [id_prefix, id_suffix].reject(&:empty?).join('-')
 
-        attrs << %(id="#{@file_id}-#{File.basename(@file_path, '.svg').gsub(/['"\s]/, '-')}")
+        attrs << %(id="#{id_attribute}")
       end
 
       def element_contents(content)

data/lib/svgeez/version.rb

@@ -1,3 +1,3 @@
 module Svgeez
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/svgeez.gemspec

@@ -1,10 +1,7 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'svgeez/version'
+require_relative 'lib/svgeez/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ['>= 2.4', '< 2.8']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4', '< 2.8')
 
   spec.name          = 'svgeez'
   spec.version       = Svgeez::VERSION
@@ -16,25 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgarber623/svgeez'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  end
 
   spec.bindir        = 'exe'
   spec.executables   = ['svgeez']
   spec.require_paths = ['lib']
 
-  spec.metadata = {
-    'bug_tracker_uri' => "#{spec.homepage}/issues",
-    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
-  }
-
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'reek', '~> 5.6'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.6.0'
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
   spec.add_runtime_dependency 'listen', '~> 3.2'
   spec.add_runtime_dependency 'mercenary', '~> 0.4.0'

metadata

@@ -1,127 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: svgeez
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +80,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/svgeez/issues
-  changelog_uri: https://github.com/jgarber623/svgeez/blob/v3.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/svgeez/blob/v3.2.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -211,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Automatically generate an SVG sprite from a folder of SVG icons.