smallvictories 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60597733d2a5b4be3a0adc354ab3b8671b93ada2
-  data.tar.gz: dd360b4e031c94dc9dd8a641ca65787e202e4d60
+  metadata.gz: baffd43b61e6a6923fa56e1568e1b3ea72319e19
+  data.tar.gz: ef3e506539b5b8cf9848c8864eabf25be7f103c2
 SHA512:
-  metadata.gz: a017cf5c6ccf0594eaff8c873e24f4defb500f34c5877ef184d319bc9a93c44643750496a7023e8e4ad27d5112ac8f253f7419b6b39dbfb0adcc6981d93c660d
-  data.tar.gz: 46319e2de1f416c496d23be41dd12800a18b42148bfbb21b7ec94169380e6e0fbc9bc5c9f62018324aee36796350c1eecfacb32bcf27541ec1d0191d5e021d0b
+  metadata.gz: 28958983d8d64b723e5bf9ce83be1dda431d3a176340b0ba33b6edb2f63400d75a9621542fa0f017930616cac696528763ec1681bfa0bf388bf7bf6c2615bc14
+  data.tar.gz: f1bddf6864e5e452eab5a24ae0603e6b2ea1f8a9a6ed9d6b29633d5e53fd6e62f8b8335001ce9fb65fb0dc23c7cf2f1e7c1a3f0041f5dcb6f9da237bb85c3588

data/README.md

@@ -19,7 +19,11 @@ includes folder.
  
 You don't have to use a layout file if you don't want to, the files will still
 be copied to the destination folder.
-
+ 
+[Sprite Factory](https://github.com/jakesgordon/sprite-factory) looks for image
+files in the sprite folder and generates a single sprite png and sprite
+stylesheet.
+ 
 [Guard LiveReload](https://github.com/guard/guard-livereload) is used to notify
 the browser to automatically reload. It needs to be used with
 the [LiveReload Safari/Chrome/Firefox extension](http://livereload.com/extensions#installing-sections).
@@ -30,6 +34,14 @@ the [LiveReload Safari/Chrome/Firefox extension](http://livereload.com/extension
 gem install smallvictories
 ```
 
+To use the [Sprite Factory](https://github.com/jakesgordon/sprite-factory) to
+generate Sprite CSS you will need to install image magick which you can do with
+homebrew:
+ 
+```
+brew install imagemagick
+```
+
 ## Commands
 
 ### Bootstrap
@@ -50,7 +62,7 @@ Command: `sv bootstrap my-folder`
 
 Compile files.
  
-Renders Sass/CSS, JavaScript/CoffeeScript, HTML/Liquid in the destination
+Renders Sass/CSS, JavaScript/CoffeeScript, HTML/Liquid and Sprite in the destination
 folder.
  
 Command: `sv compile`
@@ -79,13 +91,16 @@ Dropbox
       └── _src
       │   ├── _includes
       │   │ └── _head.liquid
+      │   ├── _sprite
       │   ├── _layout.liquid
-      │   ├── application.css
+      │   ├── applscation.css
       │   ├── application.js
-      │   └── index.liquid
+      │   ├── index.liquid
+      │   └── sprite.css
       │
       ├── _sv_custom.css
       ├── _sv_custom.js
+      ├── _sv_sprite.png
       └── index.html
 ```
 
@@ -137,6 +152,7 @@ You can set the following options:
 + `javascript`: Main javascript file (JS or CoffeeScript) to be compiled into destination.
 + `layout`: Liquid layout file to render all other html and liquid files through.
 + `includes`: Directory where liquid rendered should expect to find snippets.
++ `compile_html`: Should Small Victories compile HTML? Default is true.
 
 ### Default Configuration
 
@@ -149,6 +165,7 @@ destination_stylesheet: '_sv_custom.css'
 destination_javascript: '_sv_custom.js'
 layout: '_layout.liquid'
 includes: '_includes'
+compile_html: true
 ```
 
 ## Building Locally

data/bin/sv

@@ -16,7 +16,7 @@ def help
 
   Options:
     -h, --help                      Prints this help document
-    -v, --version                   Prints the siteleaf gem version
+    -v, --version                   Prints the small victories gem version
 
   See https://github.com/xxix/smallvictories-gem for additional documentation.
   )
@@ -32,6 +32,7 @@ end
 def compile
   config = SmallVictories::Configuration.new
   compiler = SmallVictories::Compiler.new(config: config)
+  compiler.compile_sprite
   compiler.compile_css
   compiler.compile_js
   compiler.compile_html

data/lib/smallvictories/builder.rb

@@ -18,6 +18,7 @@ module SmallVictories
       setup_stylesheet
       setup_javascript
       setup_html
+      setup_sprite
     end
 
     def folder_path
@@ -81,5 +82,10 @@ module SmallVictories
       create_src_file('layout.liquid', File.join(folder_source_path, config.layout))
       create_src_file('index.liquid', File.join(folder_source_path, 'index.liquid'))
     end
+
+    def setup_sprite
+      setup_directory File.join(folder_source_path, config.source_sprite)
+      create_src_file('empty.png', File.join(folder_source_path, config.source_sprite, 'empty.png'))
+    end
   end
 end

data/lib/smallvictories/compiler.rb

@@ -2,6 +2,8 @@ require 'sprockets'
 require 'autoprefixer-rails'
 require 'liquid'
 require 'premailer'
+require 'sprite_factory'
+require 'rails-sass-images'
 
 module SmallVictories
   class Compiler
@@ -12,15 +14,19 @@ module SmallVictories
     end
 
     def compile_css
-      package  [config.stylesheets]
+      package  [config.stylesheets] if config.compile_css
     end
 
     def compile_js
-      package  [config.javascripts]
+      package  [config.javascripts] if config.compile_js
     end
 
     def compile_html
-      liquid
+      liquid if config.compile_html
+    end
+
+    def compile_sprite
+      sprite if config.compile_sprite
     end
 
     def inline_html
@@ -47,7 +53,7 @@ module SmallVictories
           folder_path = pathname.dirname.to_s.gsub(config.full_source_path, '')
           full_output_path = File.join(config.full_destination_path, folder_path)
 
-          next if file_name =~ /^_/ # do not render partials
+          next if file_name =~ /^_/ # do not render partials or layout
 
           file = File.open(path).read
           liquid = Liquid::Template.parse(file)
@@ -80,6 +86,7 @@ module SmallVictories
         environment.js_compressor  = options[:js_compressor] || :uglify
         environment.css_compressor = options[:css_compressor] || :sass
       end
+      RailsSassImages.install(sprockets)
 
       sprockets.append_path('.')
       bundles.each do |bundle|
@@ -147,5 +154,23 @@ module SmallVictories
         end
       end
     end
+
+    def sprite
+      css = "@import 'rails-sass-images';\n"
+      css += SpriteFactory.run!(File.join(config.full_source_path, config.source_sprite),
+        output_image: File.join(config.full_source_path, config.destination_sprite_file),
+        style: :scss,
+        margin: 20,
+        layout: :vertical,
+        nocss: true,
+        sanitizer: true) do |images|
+          images.map do |image_name, image_data|
+            ".sprite-#{image_name} { background-image: url('#{config.destination_sprite_file}'); background-size: (image-width('#{File.join(config.destination_sprite_file)}')/2) auto; background-repeat: no-repeat; background-position: (#{image_data[:cssx]}px/-2) (#{image_data[:cssy]}px/-2); height: (#{image_data[:cssh]}px/2) + 1px; width: (#{image_data[:cssw]}px/2) + 1px;}"
+          end.join("\n")
+        end
+      FileUtils.cp(File.join(config.full_source_path, config.destination_sprite_file), File.join(config.full_destination_path, config.destination_sprite_file))
+      File.open(File.join(config.full_source_path, config.destination_sprite_style), 'w') { |file| file.write(css) }
+      SmallVictories.logger.info "compiled #{File.join(config.destination, config.destination_sprite_style)}"
+    end
   end
 end

data/lib/smallvictories/configuration.rb

@@ -13,7 +13,7 @@ module SmallVictories
     end
 
     def config_file key
-      config[key.to_s].chomp("/").reverse.chomp("/").reverse if config.has_key?(key.to_s)
+      config[key.to_s].to_s.chomp("/").reverse.chomp("/").reverse if config.has_key?(key.to_s)
     end
 
     def source
@@ -56,6 +56,18 @@ module SmallVictories
       [source_stylesheet, destination_stylesheet]
     end
 
+    def source_sprite
+      config_file(:source_sprite) || DEFAULT_SOURCE_SPRITE
+    end
+
+    def destination_sprite_file
+      config_file(:destination_sprite_file) || DEFAULT_DESTINATION_SPRITE_FILE
+    end
+
+    def destination_sprite_style
+      config_file(:destination_sprite_style) || DEFAULT_DESTINATION_SPRITE_STYLE
+    end
+
     def layout
       config_file(:layout) || DEFAULT_LAYOUT
     end
@@ -71,5 +83,21 @@ module SmallVictories
     def full_includes_path
       File.join(full_source_path, includes)
     end
+
+    def compile_css
+      eval config_file(:compile_css) || 'true'
+    end
+
+    def compile_html
+      eval config_file(:compile_html) || 'true'
+    end
+
+    def compile_js
+      eval config_file(:compile_js) || 'true'
+    end
+
+    def compile_sprite
+      eval config_file(:compile_sprite) || 'true'
+    end
   end
 end

data/lib/smallvictories/constants.rb

@@ -1,11 +1,14 @@
 module SmallVictories
   CONFIG_FILE = '_sv_config.yml'
-  DEFAULT_SOURCE = '_src'
+  DEFAULT_SOURCE = '_sv'
   DEFAULT_DESTINATION = ''
   DEFAULT_SOURCE_STYLESHEET = 'application.css'
   DEFAULT_SOURCE_JAVASCRIPT = 'application.js'
+  DEFAULT_SOURCE_SPRITE = '_sprite'
   DEFAULT_DESTINATION_STYLESHEET = '_sv_custom.css'
   DEFAULT_DESTINATION_JAVASCRIPT = '_sv_custom.js'
+  DEFAULT_DESTINATION_SPRITE_FILE = '_sv_sprite.png'
+  DEFAULT_DESTINATION_SPRITE_STYLE = 'sprite.scss'
   DEFAULT_LAYOUT = '_layout.liquid'
   DEFAULT_INCLUDES = '_includes'
   ROOT = Dir.pwd

data/lib/smallvictories/version.rb

@@ -1,3 +1,3 @@
 module SmallVictories
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/smallvictories/watcher.rb

@@ -28,6 +28,8 @@ module SmallVictories
             compiler.compile_js
           when '.liquid', '.html'
             compiler.compile_html
+          when '.png', '.jpg', '.jpeg', '.gif'
+            compiler.compile_sprite unless paths.find { |path| path == File.join(compiler.config.full_source_path, compiler.config.destination_sprite_file) }
           else
           end
         end

data/smallvictories.gemspec

@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'closure-compiler', '~> 1.1'
   spec.add_runtime_dependency 'premailer', '~> 1.8'
   spec.add_runtime_dependency 'nokogiri', '~> 1.4'
+  spec.add_runtime_dependency 'sprite-factory', '~> 1.7'
+  spec.add_runtime_dependency 'rmagick', '~> 2.15'
+  spec.add_runtime_dependency 'rails-sass-images', '~> 1.0'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/builder_spec.rb

@@ -2,21 +2,18 @@ require 'spec_helper'
 
 describe SmallVictories do
   let(:builder) { SmallVictories::Builder.new(config: SmallVictories::Configuration.new) }
+  let(:files) { %w(fixtures/new/_sv_config.yml fixtures/new/.sv_guardfile fixtures/new/_src/index.liquid fixtures/new/_src/application.css fixtures/new/_src/application.js fixtures/new/_src/_includes/_head.liquid fixtures/new/_src/_layout.liquid fixtures/new/_src/_sprite/empty.png) }
 
   context 'with folder' do
     it 'sets up default files' do
       builder.setup 'spec/fixtures/new'
-      expect(File.exists?('fixtures/new/_sv_config.yml')).to eq true
-      expect(File.exists?('fixtures/new/.sv_guardfile')).to eq true
-      expect(File.exists?('fixtures/new/_src/_layout.liquid')).to eq true
-      expect(File.exists?('fixtures/new/_src/index.liquid')).to eq true
-      expect(File.exists?('fixtures/new/_src/_includes/_head.liquid')).to eq true
-      expect(File.exists?('fixtures/new/_src/application.js')).to eq true
-      expect(File.exists?('fixtures/new/_src/application.css')).to eq true
+      files.each do |file|
+        expect(File.exists?(file)).to eq true
+      end
     end
 
     after do
-      %w(fixtures/new/_sv_config.yml fixtures/new/.sv_guardfile fixtures/new/_src/index.liquid fixtures/new/_src/application.css fixtures/new/_src/application.js fixtures/new/_src/_includes/_head.liquid fixtures/new/_src/_layout.liquid).each { |path| clean_file(path) }
+      files.each { |path| clean_file(path) }
     end
   end
 end

data/spec/compiler_spec.rb

@@ -4,6 +4,9 @@ describe SmallVictories do
   let(:destination_css) { './fixtures/destination/_sv_custom.css' }
   let(:destination_js) { './fixtures/destination/_sv_custom.js' }
   let(:destination_html) { './fixtures/destination/index.html' }
+  let(:destination_sprite_file) { './fixtures/destination/_sv_sprite.png' }
+  let(:source_sprite_file) { './fixtures/source/_sv_sprite.png' }
+  let(:destination_sprite_style) { './fixtures/source/sprite.scss' }
   let(:compiler) { SmallVictories::Compiler.new(config: SmallVictories::Configuration.new) }
 
   before do
@@ -43,6 +46,17 @@ describe SmallVictories do
       compiler.compile_css
       expect(File.open(destination_css).read).to include '.bootstrap{color:black;box-sizing:content-box}html{background:white}body div{background:red}p{font-size:30px}'
     end
+
+    context 'with compile disabled' do
+      before do
+        allow_any_instance_of(SmallVictories::Configuration).to receive(:compile_css).and_return(false)
+      end
+
+      it 'does not compile the liquid files' do
+        compiler.compile_css
+        expect(File.exists?(destination_css)).to eq false
+      end
+    end
   end
 
   describe '#minify_css' do
@@ -57,6 +71,17 @@ describe SmallVictories do
       compiler.compile_js
       expect(File.open(destination_js).read).to include '(function(){alert("hi")}).call(this),console.log("hi");'
     end
+
+    context 'with compile disabled' do
+      before do
+        allow_any_instance_of(SmallVictories::Configuration).to receive(:compile_js).and_return(false)
+      end
+
+      it 'does not compile the liquid files' do
+        compiler.compile_js
+        expect(File.exists?(destination_js)).to eq false
+      end
+    end
   end
 
   describe '#minify_js' do
@@ -72,6 +97,17 @@ describe SmallVictories do
       expect(File.open(destination_html).read).to include "<html>\n<h1>Index</h1>\n<p>My snippet</p>\n\n\n</html>"
     end
 
+    context 'with compile disabled' do
+      before do
+        allow_any_instance_of(SmallVictories::Configuration).to receive(:compile_html).and_return(false)
+      end
+
+      it 'does not compile the liquid files' do
+        compiler.compile_html
+        expect(File.exists?(destination_html)).to eq false
+      end
+    end
+
     context 'with no layout' do
       before do
         allow_any_instance_of(SmallVictories::Configuration).to receive(:layout).and_return('no-file-here')
@@ -116,4 +152,17 @@ describe SmallVictories do
       expect(File.open(destination_html).read).to include "<html>\n<h1>Index</h1>\nLiquid error: No such template 'snippet'\n\n</html>"
     end
   end
+
+  describe '#compile_sprite' do
+    it 'compiles the image files into a sprite' do
+      compiler.compile_sprite
+      expect(File.exists?(destination_sprite_file)).to eq true
+      expect(File.exists?(source_sprite_file)).to eq true
+    end
+
+    it 'compiles the css for the image sprite' do
+      compiler.compile_sprite
+      expect(File.exists?(destination_sprite_style)).to eq true
+    end
+  end
 end

data/spec/configuration_spec.rb

@@ -28,6 +28,18 @@ describe SmallVictories do
       expect(configuration.destination_javascript).to eq '_sv_custom.js'
     end
 
+    it 'defaults source sprite folder' do
+      expect(configuration.source_sprite).to eq '_sprite'
+    end
+
+    it 'defaults destination sprite file' do
+      expect(configuration.destination_sprite_file).to eq '_sv_sprite.png'
+    end
+
+    it 'defaults destination sprite style' do
+      expect(configuration.destination_sprite_style).to eq 'sprite.scss'
+    end
+
     it 'defaults layout file' do
       expect(configuration.layout).to eq '_layout.liquid'
     end
@@ -35,6 +47,22 @@ describe SmallVictories do
     it 'defaults includes folder' do
       expect(configuration.includes).to eq '_includes'
     end
+
+    it 'defaults compile css' do
+      expect(configuration.compile_css).to eq true
+    end
+
+    it 'defaults compile js' do
+      expect(configuration.compile_js).to eq true
+    end
+
+    it 'defaults compile html' do
+      expect(configuration.compile_html).to eq true
+    end
+
+    it 'defaults compile sprite' do
+      expect(configuration.compile_sprite).to eq true
+    end
   end
 
   context 'with config file' do
@@ -58,6 +86,19 @@ describe SmallVictories do
       expect(configuration.source_javascript).to eq 'my-javascript.js'
     end
 
+    it 'reads source sprite folder' do
+      expect(configuration.source_sprite).to eq 'my-sprite'
+    end
+
+    it 'reads destination sprite file' do
+      expect(configuration.destination_sprite_file).to eq 'my-sprite.png'
+    end
+
+    it 'reads destination sprite style' do
+      expect(configuration.destination_sprite_style).to eq 'my-sprite.css'
+    end
+
+
     it 'reads layout file' do
       expect(configuration.layout).to eq '_my-template.liquid'
     end
@@ -65,5 +106,21 @@ describe SmallVictories do
     it 'reads includes folder' do
       expect(configuration.includes).to eq 'snippets'
     end
+
+    it 'reads compile css' do
+      expect(configuration.compile_css).to eq false
+    end
+
+    it 'reads compile js' do
+      expect(configuration.compile_js).to eq false
+    end
+
+    it 'reads compile html' do
+      expect(configuration.compile_html).to eq false
+    end
+
+    it 'reads compile sprite' do
+      expect(configuration.compile_sprite).to eq false
+    end
   end
 end

data/spec/fixtures/source/_sv_config.yml

@@ -2,7 +2,14 @@ source: '/my-source-folder/'
 destination: 'my-site-folder/'
 source_stylesheet: 'my-stylesheet.css'
 source_javascript: 'my-javascript.js'
+source_sprite: 'my-sprite'
 destination_stylesheet: 'stylesheet.css'
 destination_javascript: 'javascript.js'
+destination_sprite_file: 'my-sprite.png'
+destination_sprite_style: 'my-sprite.css'
 layout: '_my-template.liquid'
 includes: 'snippets'
+compile_html: false
+compile_js: false
+compile_css: false
+compile_sprite: false

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ RSpec.configure do |config|
   end
 
   config.after do
-    %w(./fixtures/destination/_sv_custom.css ./fixtures/destination/_sv_custom.js ./fixtures/destination/index.html ./_sv_config.yml).each { |path| clean_file(path) }
+    %w(./fixtures/destination/_sv_custom.css ./fixtures/destination/_sv_custom.js ./fixtures/destination/index.html ./_sv_config.yml ./fixtures/source/_sv_sprite.png ./fixtures/destination/_sv_sprite.png ./fixtures/source/sprite.scss).each { |path| clean_file(path) }
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smallvictories
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Michael Dijkstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: autoprefixer-rails
@@ -192,6 +192,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sprite-factory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: rails-sass-images
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +319,8 @@ files:
 - spec/fixtures/source/_javascripts/scripts.coffee
 - spec/fixtures/source/_javascripts/scripts.js
 - spec/fixtures/source/_layout.liquid
+- spec/fixtures/source/_sprite/.gitkeep
+- spec/fixtures/source/_sprite/blank.png
 - spec/fixtures/source/_stylesheets/bootstrap.scss
 - spec/fixtures/source/_stylesheets/extra.scss
 - spec/fixtures/source/_stylesheets/stylesheet.scss
@@ -287,6 +331,7 @@ files:
 - spec/spec_helper.rb
 - src/Guardfile
 - src/config.yml
+- src/empty.png
 - src/head.liquid
 - src/index.liquid
 - src/javascript.js
@@ -333,6 +378,8 @@ test_files:
 - spec/fixtures/source/_javascripts/scripts.coffee
 - spec/fixtures/source/_javascripts/scripts.js
 - spec/fixtures/source/_layout.liquid
+- spec/fixtures/source/_sprite/.gitkeep
+- spec/fixtures/source/_sprite/blank.png
 - spec/fixtures/source/_stylesheets/bootstrap.scss
 - spec/fixtures/source/_stylesheets/extra.scss
 - spec/fixtures/source/_stylesheets/stylesheet.scss