svgeez 0.2.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d3afb52b2f6c2e729e45e0424973b27b55915af
-  data.tar.gz: 985940a3598cc19bcc6204e67874717154179f86
+  metadata.gz: b7a16a5496376f424cb08140cb1cb571ce05712b
+  data.tar.gz: faab6c83f1ef364d46aa80d35cf42b22803ec9f6
 SHA512:
-  metadata.gz: 6500f825534a6f87d21cb1eda1f0eebe7654c1ff5c313486a7686fb6d07ba1ab86d5a24abb60bef7ace4c35ad6a1ec78d29c0471afd0ec49b5f4052b9a42d4dc
-  data.tar.gz: 382fa4b98557b1343c087b32e11e9194f9f23bca8855f34ec2b4ab75cafd604945bb3ef464e6da51c8394fd73c6211285d2eeea3029ea5400b9779d5df743f05
+  metadata.gz: 066d0cb89dab9fe20161352cd11973f87622fd0c6f02b4f9037d1a8ac335792209ebb27b643855e76221910eb5ca4834f8a0a208aa78bf0ab7098657597d3459
+  data.tar.gz: 2364c7f693d12fab3e9f2849cd0ddc9172fa6f4c74ce29479932fd51d8a90d1753cbbadad90f66d10854d574193851bb2165b4d023eeae5496b47d7114697500

data/.editorconfig

@@ -9,5 +9,9 @@ indent_size = 2
 indent_style = space
 trim_trailing_whitespace = true
 
+[*.md]
+indent_size = 4
+indent_style = tab
+
 [*.svg]
 insert_final_newline = false

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
 --color
+--format progress
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -1,24 +1,41 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
@@ -26,25 +43,32 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
 
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
+## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
 complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
+## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -29,8 +29,8 @@ Contributing to svgeez is pretty straightforward:
 1. Install development dependencies by running `bundle install` from the root of the project.
 1. Create a feature branch for the issue or new feature you're looking to tackle: `git checkout -b your-descriptive-branch-name`.
 1. _Write some code!_
-1. Build (`rake build`) and install (`rake install`) your updated code.
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `rake`.
+1. Build (`bundle exec rake build`) and install (`bundle exec rake install`) your updated code.
+1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rake`.
 1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`.
 1. Push the branch to your fork of svgeez: `git push origin your-descriptive-branch-name`.
 1. Create a new Pull Request and I'll give it a look!
@@ -44,6 +44,8 @@ Code styles are like opinions: Everyone's got one and yours is better than mine.
 - Prefer single quotes over double quotes unless interpolating.
 - Follow the conventions you see in the existing source code as best as you can.
 
-svgeez's formatting guidelines are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org/) syntax. There are [a number of great plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. Using EditorConfig will make your time spent coding a little bit easier.
+svgeez's formatting guidelines are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org/) syntax. There are [a number of great plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. EditorConfig takes the hassle out of syntax-specific formatting.
+
+Additionally, [Rubocop](https://github.com/bbatsov/rubocop) can be used to help identify possible trouble areas in your code. Run `bundle exec rake rubocop` to generate Rubocop's static code analysis report.
 
 Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.

data/README.md

@@ -63,8 +63,8 @@ The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/
 
 |Option|Description|
 |---|---|
-|`-s`<br>`--source`|Path to the folder of source SVGs (defaults to `./`).|
-|`-d`<br>`--destination`|Path to the destination file or folder (defaults to `./_svgeez/svgeez.svg`)|
+|`-s`<br>`--source`|Path to the folder of source SVGs (defaults to `./_svgeez`).|
+|`-d`<br>`--destination`|Path to the destination file or folder (defaults to `./svgeez.svg`)|
 |`--with-svgo`|Optimize source SVGs with [SVGO](https://github.com/svg/svgo/) before sprite generation (non-destructive)|
 
 ### The `watch` command
@@ -186,9 +186,13 @@ svgeez benefited greatly from the hard work done by the folks working on the fol
 
 Additionally, Chris Coyier's [CSS Tricks](https://css-tricks.com/) posts linked above got me interested in SVG sprites.
 
-Lastly, the sample icons in `spec/fixtures/icons` are from [@jxnblk](https://github.com/jxnblk)'s [Geomicons Open](https://github.com/jxnblk/geomicons-open) icon set.
+Lastly, the sample icons in `spec/fixtures/icons` are from [Brent Jackson](https://github.com/jxnblk)'s [Geomicons Open](https://github.com/jxnblk/geomicons-open) icon set.
 
-svgeez is written and maintained by [@jgarber623](https://github.com/jgarber623).
+svgeez is written and maintained by [Jason Garber](https://github.com/jgarber623).
+
+### Additional Contributors
+
+- [Brett Wilkins](https://github.com/bwilkins)
 
 ## License
 

data/bin/svgeez

@@ -2,8 +2,8 @@
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w(.. lib))
 
-require 'svgeez'
 require 'mercenary'
+require 'svgeez'
 
 Mercenary.program(:svgeez) do |p|
   p.version Svgeez::VERSION

data/lib/svgeez/command.rb

@@ -1,20 +1,18 @@
 module Svgeez
   class Command
-    class << self
-      def subclasses
-        @subclasses ||= []
-      end
+    def self.subclasses
+      @subclasses ||= []
+    end
 
-      def inherited(base)
-        subclasses << base
-        super(base)
-      end
+    def self.inherited(base)
+      subclasses << base
+      super(base)
+    end
 
-      def add_build_options(c)
-        c.option 'source', '-s', '--source [FOLDER]', 'Source folder (defaults to ./)'
-        c.option 'destination', '-d', '--destination [OUTPUT]', 'Destination file or folder (defaults to ./_svgeez/svgeez.svg)'
-        c.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
-      end
+    def self.add_build_options(c)
+      c.option 'source', '-s', '--source [FOLDER]', 'Source folder (defaults to ./_svgeez)'
+      c.option 'destination', '-d', '--destination [OUTPUT]', 'Destination file or folder (defaults to ./svgeez.svg)'
+      c.option 'svgo', '--with-svgo', 'Optimize source SVGs with SVGO before sprite generation (non-destructive)'
     end
   end
 end

data/lib/svgeez/commands/watch.rb

@@ -1,32 +1,33 @@
 module Svgeez
   module Commands
     class Watch < Command
-      class << self
-        def init_with_program(p)
-          p.command(:watch) do |c|
-            c.description 'Watches a folder of SVG icons for changes'
-            c.syntax 'watch [options]'
+      def self.init_with_program(p)
+        p.command(:watch) do |c|
+          c.description 'Watches a folder of SVG icons for changes'
+          c.syntax 'watch [options]'
 
-            add_build_options(c)
+          add_build_options(c)
 
-            c.action do |_, options|
-              Svgeez::Commands::Build.process(options)
-              Svgeez::Commands::Watch.process(options)
-            end
+          c.action do |_, options|
+            Svgeez::Commands::Build.process(options)
+            Svgeez::Commands::Watch.process(options)
           end
         end
+      end
 
-        def process(options)
-          Svgeez.logger.info %(Watching `#{File.expand_path(options['source'])}` for changes... Press ctrl-c to stop.)
+      def self.process(options)
+        sprite_builder = Svgeez::SpriteBuilder.new(options)
 
-          listener = Listen.to(options['source'], only: /\.svg$/) do
-            Svgeez::Commands::Build.process(options)
-          end
-
-          listener.start
-          sleep
-        rescue Interrupt
+        listener = Listen.to(sprite_builder.source, only: /\.svg\z/) do
+          sprite_builder.build
         end
+
+        Svgeez.logger.info "Watching `#{sprite_builder.source}` for changes... Press ctrl-c to stop."
+
+        listener.start
+        sleep
+      rescue Interrupt
+        Svgeez.logger.info 'Quitting svgeez...'
       end
     end
   end

data/lib/svgeez/sprite_builder.rb

@@ -1,23 +1,23 @@
 module Svgeez
   class SpriteBuilder
-    def initialize(options)
-      @source = File.expand_path(options.fetch('source', './'))
-      @destination = File.expand_path(options.fetch('destination', './_svgeez/svgeez.svg'))
-      @svgo = options['svgo']
+    def initialize(options = {})
+      @options = options
     end
 
     def build
       if source_is_destination?
-        Svgeez.logger.error %(Setting `source` and `destination` to the same path isn't allowed!)
-      elsif source_file_paths.any?
-        Svgeez.logger.info %(Generating sprite at `#{destination_file_path}` from #{source_file_paths.length} SVG#{'s' if source_file_paths.length > 1}...)
+        Svgeez.logger.error "Setting `source` and `destination` to the same path isn't allowed!"
+      elsif source_file_paths.empty?
+        Svgeez.logger.warn "No SVGs were found in `#{source}`."
+      else
+        Svgeez.logger.info "Generating sprite at `#{destination_file_path}` from #{source_file_paths.length} SVG#{'s' if source_file_paths.length > 1}..."
 
         # Make destination folder
         FileUtils.mkdir_p(destination_folder_path)
 
         # Notify if SVGO requested but not found
-        if @svgo && !svgo_installed?
-          Svgeez.logger.warn %(Unable to find `svgo` in your PATH. Continuing with standard sprite generation...)
+        if svgo_use? && !svgo_installed?
+          Svgeez.logger.warn 'Unable to find `svgo` in your PATH. Continuing with standard sprite generation...'
         end
 
         # Write the file
@@ -25,39 +25,45 @@ module Svgeez
           f.write build_destination_file_contents
         end
 
-        Svgeez.logger.info %(Successfully generated sprite at `#{destination_file_path}`.)
-      else
-        Svgeez.logger.warn %(No SVGs were found in `#{@source}`.)
+        Svgeez.logger.info "Successfully generated sprite at `#{destination_file_path}`."
       end
     end
 
-    private
+    def destination
+      @destination ||= File.expand_path(@options.fetch('destination', './svgeez.svg'))
+    end
 
-    def build_destination_file_contents
-      destination_file_contents = '<svg>'
+    def source
+      @source ||= File.expand_path(@options.fetch('source', './_svgeez'))
+    end
 
-      source_file_paths.each do |file_path|
-        IO.read(file_path).match(%r{^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)</svg>}m) do |matches|
-          destination_file_contents << %(<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').gsub(/['"\s]/, '-')}" #{matches[:viewbox]}>#{matches[:content]}</symbol>)
-        end
-      end
+    private
 
-      destination_file_contents << '</svg>'
+    def build_destination_file_contents
+      destination_file_contents = "<svg>#{collect_source_files_contents.join}</svg>"
 
-      if @svgo && svgo_installed?
+      if svgo_use? && svgo_installed?
         destination_file_contents = `cat <<EOF | svgo --disable=cleanupIDs -i - -o -\n#{destination_file_contents}\nEOF`
       end
 
       destination_file_contents.insert(4, %( id="#{destination_file_id}" style="display: none;" version="1.1"))
     end
 
+    def collect_source_files_contents
+      source_file_paths.collect do |file_path|
+        IO.read(file_path).match(%r{^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)</svg>}m) do |matches|
+          %(<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').gsub(/['"\s]/, '-')}" #{matches[:viewbox]}>#{matches[:content]}</symbol>)
+        end
+      end
+    end
+
     def destination_file_id
       @destination_file_id ||= File.basename(destination_file_name, '.svg').tr(' ', '-')
     end
 
     def destination_file_name
-      if @destination.end_with?('.svg')
-        File.split(@destination)[1]
+      if destination.end_with?('.svg')
+        File.split(destination)[1]
       else
         'svgeez.svg'
       end
@@ -68,19 +74,23 @@ module Svgeez
     end
 
     def destination_folder_path
-      if @destination.end_with?('.svg')
-        File.split(@destination)[0]
+      if destination.end_with?('.svg')
+        File.split(destination)[0]
       else
-        @destination
+        destination
       end
     end
 
     def source_file_paths
-      @source_file_paths ||= Dir.glob(File.join(@source, '*.svg'))
+      @source_file_paths ||= Dir.glob(File.join(source, '*.svg'))
     end
 
     def source_is_destination?
-      /^#{@source}/ =~ destination_folder_path
+      /\A#{source}/ =~ destination_folder_path
+    end
+
+    def svgo_use?
+      @svgo_use ||= @options['svgo']
     end
 
     def svgo_installed?

data/lib/svgeez/version.rb

@@ -1,3 +1,3 @@
 module Svgeez
-  VERSION = '0.2.7'
+  VERSION = '1.0.0'.freeze
 end

data/lib/svgeez.rb

@@ -10,13 +10,9 @@ require 'svgeez/commands/watch'
 require 'svgeez/sprite_builder'
 
 module Svgeez
-  class << self
-    def logger
-      @logger ||= Logger.new(STDOUT)
-    end
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
   end
 
-  logger.formatter = proc do |_, _, _, msg|
-    "#{msg}\n"
-  end
+  logger.formatter = proc { |_, _, _, msg| "#{msg}\n" }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svgeez
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler