svgeez 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa1d11cc37ab394b50c0dd37232f56545a5ba9d9
-  data.tar.gz: 59f46fd6e13ee2a43e6e794cc7d24b6d5c38cd4f
+  metadata.gz: 5457b1190e893a9dfac8629a5c06463147685837
+  data.tar.gz: 6c0998ebc8e795b5b5aa2a1953b8824d18c300c0
 SHA512:
-  metadata.gz: 1cccbf1eea252f0dca0d8d3a16516f06c6214d0262fdd4cb635fa8bfde6df1a7f31c952e960cbfac11daccdcd8cb1ef40571df31c5c79a2e9ca7387d18d3e24f
-  data.tar.gz: a11b06cd02239d19adf123f8790ec18d86f62befcc0b37a4f7d076f5df14c2a6241dad35530dff5c6af46a88ecadbd716c7e0470dc9ad65c2577b4df766ddff4
+  metadata.gz: 70edd657348bc0d4b44add8f3516b20fcc715e56e9f99601f944f067adee1856a4ae2e4f4b0c16e33dcd5b9242c8449c03c7d1c7b8d0f9e141e3e53cc0facce4
+  data.tar.gz: 6472cae9a52960be99f3349db60283c42cc342b3aad1027c60b58639be049c48a8a08530b010699b991ffb02d648de1d28186c92a762a48a6faaf53595881031

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to svgeez
+
+I'd love to have your help improving svgeez! If you'd like to pitch in, you can do so in a number of ways:
+
+1. Look through open [Issues](https://github.com/jgarber623/svgeez/issues).
+1. Review any open [Pull Requests](https://github.com/jgarber623/svgeez/pulls).
+1. [Fork svgeez](#get-set-up-to-contribute) and fix an open Issue or add your own feature.
+1. File new Issues if you have a good idea or see a bug and don't know how to fix it yourself. _Only do this after you've made sure the behavior or problem you're seeing isn't already documented in an open Issue._
+
+I definitely appreciate your interest in (and help improving) svgeez. Thanks!
+
+## Installation
+
+svgeez is a written in [Ruby](https://www.ruby-lang.org/en/) (version 2.2.3) and development dependencies are managed using the [Bundler](http://bundler.io/) gem.
+
+I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby/) or [RVM](https://rvm.io/) come to mind). Once you've installed Ruby 2.2.3 using your method of choice, install the project's gems by running:
+
+```sh
+bundle install
+```
+
+…from the root of the project.
+
+## Get set up to contribute
+
+Contributing to svgeez is pretty straightforward:
+
+1. Fork the svgeez repo and clone it.
+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. 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!
+
+## Code Style
+
+Code styles are like opinions: Everyone's got one and yours is better than mine. Here's how svgeez should be written:
+
+- Use two-space indentation in Ruby.
+- No trailing whitespace and blank lines should have whitespace removed.
+- 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.
+
+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

@@ -4,8 +4,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/svgeez.svg)](https://badge.fury.io/rb/svgeez)
 [![Build Status](https://travis-ci.org/jgarber623/svgeez.svg?branch=master)](https://travis-ci.org/jgarber623/svgeez)
+[![Code Climate](https://codeclimate.com/github/jgarber623/svgeez/badges/gpa.svg)](https://codeclimate.com/github/jgarber623/svgeez)
 
-If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Simply run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a directory; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.
+If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Simply run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a folder; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.
 
 _For more on why SVG sprites are the bee's knees as far as icon systems go, give Chris Coyier's original post, [Icon System with SVG Sprites](https://css-tricks.com/svg-sprites-use-better-icon-fonts/), and his follow-up article, [SVG \`symbol\` a Good Choice for Icons](https://css-tricks.com/svg-symbol-good-choice-icons/) a read-through._
 
@@ -47,15 +48,23 @@ svgeez is a command line program with several useful subcommands. From the root
 
 ### The `build` command
 
-You can manually generate an SVG sprite from a folder of SVGs with the `build` command which takes two options, a path to your folder of individual SVGs and a path to the desired output folder. _These paths must be different!_
+You can manually generate an SVG sprite from a folder of SVGs with the `build` command which takes two options, a path to your folder of individual SVGs and a path to the desired destination folder. _These paths must be different!_
 
 A basic example:
 
 ```sh
-$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images
+$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
 ```
 
-The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/icons` into a single SVG sprite in `~/Sites/sixtwothree.org/images`. The resulting sprite file will be named `icons.svg` (this file name is derived from the name of the provided source folder).
+The above example will combine all SVG files in `~/Sites/sixtwothree.org/images/icons` into a single SVG sprite file (`icons.svg`) in `~/Sites/sixtwothree.org/images`.
+
+#### Options and Defaults
+
+|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`)|
+|`--with-svgo`|Optimize source SVGs with [SVGO](https://github.com/svg/svgo/) before sprite generation (non-destructive)|
 
 ### The `watch` command
 
@@ -64,7 +73,7 @@ The `watch` command takes the same arguments as the `build` command but uses the
 Tweaking the example from above:
 
 ```sh
-$ svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images
+$ svgeez watch --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg
 ```
 
 svgeez will remaing running, watching for new, removed, or updated SVG files in the provided source folder. As SVG files are added, deleted, or modified in the source folder, svgeez will keep pumping out updated SVG sprite files to the destination folder.
@@ -74,10 +83,10 @@ svgeez will remaing running, watching for new, removed, or updated SVG files in
 If you have the excellent [SVGO](https://github.com/svg/svgo/) utility installed on your system (and the `svgo` command is available in your PATH), you can use the `--with-svgo` option and optimize source SVGs before generating the sprite file.
 
 ```sh
-$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images --with-svgo
+$ svgeez build --source ~/Sites/sixtwothree.org/images/icons --destination ~/Sites/sixtwothree.org/images/icons.svg --with-svgo
 ```
 
-Optimizing source SVG files with SVGO is done on-the-fly and the original files are left intact. Depending on the number of individual SVG files in the source directory, using the `--with-svgo` option can add considerable time to SVG sprite generation.
+Optimizing source SVG files with SVGO is done on-the-fly and the original files are left intact. Depending on the number of individual SVG files in the source folder, using the `--with-svgo` option can add considerable time to SVG sprite generation.
 
 ## Working with SVG sprites
 

data/lib/svgeez/command.rb

@@ -11,8 +11,8 @@ module Svgeez
       end
 
       def add_build_options(c)
-        c.option 'source', '-s', '--source [DIR]', 'Source directory (defaults to ./)'
-        c.option 'destination', '-d', '--destination [DIR]', 'Destination directory (defaults to ./_svgeez)'
+        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
     end

data/lib/svgeez/sprite_builder.rb

@@ -2,17 +2,17 @@ module Svgeez
   class SpriteBuilder
     def initialize(options)
       @source = File.expand_path(options.fetch('source', './'))
-      @destination = File.expand_path(options.fetch('destination', './_svgeez'))
+      @destination = File.expand_path(options.fetch('destination', './_svgeez/svgeez.svg'))
       @with_svgo = options['svgo']
     end
 
     def build
       unless source_is_destination?
-        if input_file_paths.any?
-          Svgeez.logger.info %{Generating sprite at `#{output_file_path}` from #{input_file_paths.length} SVG#{'s' if input_file_paths.length > 1}...}
+        if 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}...}
 
-          # Make destination directory
-          FileUtils.mkdir_p(@destination)
+          # Make destination folder
+          FileUtils.mkdir_p(destination_folder_path)
 
           # Notify if SVGO requested but not found
           if @with_svgo && !svgo_installed?
@@ -20,11 +20,11 @@ module Svgeez
           end
 
           # Write the file
-          File.open(output_file_path, 'w') do |f|
-            f.write build_output_file_contents
+          File.open(destination_file_path, 'w') do |f|
+            f.write build_destination_file_contents
           end
 
-          Svgeez.logger.info %{Successfully generated sprite at `#{output_file_path}`.}
+          Svgeez.logger.info %{Successfully generated sprite at `#{destination_file_path}`.}
         else
           Svgeez.logger.warn %{No SVGs were found in `#{@source}`.}
         end
@@ -33,36 +33,52 @@ module Svgeez
       end
     end
 
-    def build_output_file_contents
-      %{<svg id="#{source_basename}" style="display: none;" version="1.1">}.tap do |output_file_contents|
-        # Loop over all input files, grabbing their content, and appending to `output_file_contents`
-        input_file_paths.each do |file_path|
+    def build_destination_file_contents
+      %{<svg id="#{destination_file_id}" style="display: none;" version="1.1">}.tap do |destination_file_contents|
+        # Loop over all source files, grabbing their content, and appending to `destination_file_contents`
+        source_file_paths.each do |file_path|
           file_contents = use_svgo? ? `svgo -i #{file_path} -o -` : IO.read(file_path)
           pattern = /^<svg.*?(?<viewbox>viewBox=".*?").*?>(?<content>.*?)<\/svg>/m
 
           file_contents.match(pattern) do |matches|
-            output_file_contents << %{<symbol id="#{source_basename}-#{File.basename(file_path, '.svg').downcase}" #{matches[:viewbox]}>#{matches[:content]}</symbol>}
+            destination_file_contents << %{<symbol id="#{destination_file_id}-#{File.basename(file_path, '.svg').downcase}" #{matches[:viewbox]}>#{matches[:content]}</symbol>}
           end
         end
 
-        output_file_contents << '</svg>'
+        destination_file_contents << '</svg>'
       end
     end
 
-    def input_file_paths
-      Dir.glob(File.join(@source, '*.svg'))
+    def destination_file_id
+      @destination_file_id ||= File.basename(destination_file_name, '.svg').gsub(' ', '-')
     end
 
-    def output_file_path
-      File.join(@destination, %{#{source_basename}.svg})
+    def destination_file_name
+      if @destination.end_with?('.svg')
+        File.split(@destination)[1]
+      else
+        'svgeez.svg'
+      end
+    end
+
+    def destination_file_path
+      @destination_file_path ||= File.join(destination_folder_path, destination_file_name)
+    end
+
+    def destination_folder_path
+      if @destination.end_with?('.svg')
+        File.split(@destination)[0]
+      else
+        @destination
+      end
     end
 
-    def source_basename
-      @source_basename ||= File.basename(@source)
+    def source_file_paths
+      @source_file_paths ||= Dir.glob(File.join(@source, '*.svg'))
     end
 
     def source_is_destination?
-      @source == @destination
+      @source == destination_folder_path
     end
 
     def svgo_installed?

data/lib/svgeez/version.rb

@@ -1,3 +1,3 @@
 module Svgeez
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: svgeez
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-19 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -94,6 +94,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md